OIBus Agent: Overview & Installation
The OIBus Agent is a lightweight Windows service that enables protocol-specific data collection for technologies that require native Windows integration.
Key Features
| Feature | Supported Protocols | Benefits |
|---|---|---|
| Windows-native access | OPC Classic™, OLEDB, OSIsoft PI™ | Direct integration with Windows technologies |
| Service integration | Windows Service Manager | Reliable background operation |
| Cross-architecture | x64, x86, ARM64 | Supports all modern Windows systems |
Download
System Requirements
| Requirement | Specification |
|---|---|
| Operating System | Windows 10/11, Windows Server 2016+ |
| Architecture | x64, x86, or ARM64 |
| .NET Framework | 4.8 or later |
| Disk Space | 50 MB minimum |
| Memory | 128 MB minimum |
Installation
Package Contents
When you unzip the downloaded archive, you'll find these files:
| File | Purpose |
|---|---|
OIBusAgent.exe | Main executable |
install-agent.bat | Service installation script |
uninstall-agent.bat | Service removal script |
Installation Methods
1. As a Windows Service (Recommended)
# Default installation (port 2224, service name "OIBusAgent")
install-agent.bat
# Custom installation
install-agent.bat -n="CustomServiceName" -p=2225
| Parameter | Description | Default Value |
|---|---|---|
-n | Service name | "OIBusAgent" |
-p | HTTP port | 2224 |
2. Manual Execution
# Default port (2224)
OIBusAgent.exe
# Custom port
OIBusAgent.exe -p 2225
Update Procedure
- Stop the existing service (if running)
- Extract the new version files
- Replace the old files with the new ones
- Restart the service
Uninstallation
# Default service name
uninstall-agent.bat
# Custom service name
uninstall-agent.bat -n="CustomServiceName"
Usage Modes
1. Integrated with OIBus
- Acts as a protocol bridge for OIBus South connectors
- Handles Windows-specific protocols transparently
- Automatic service management through OIBus interface
2. Standalone Mode
- Direct HTTP API access
- Independent operation from OIBus
- Suitable for custom integrations
Post-Installation
- Verify Installation:
sc query "OIBusAgent"
(or your custom service name)
- Check Service Status:
- Open Services Manager (
services.msc) - Look for "OIBusAgent" (or your custom name)
- Verify status is "Running"
- Test Connectivity:
curl http://localhost:2224/api/status
Should return:
{ "status": "running", "version": "__VERSION__" }