IO Module Agent
The IO Module shall provide functionality to control hardware input/output operations, including setting digital outputs to ON or OFF states.
IO Module Blocks
1. Read Digital Input
Turns BLE functionality ON or OFF on the device.
Inputs
Parameter Name |
Description |
|---|---|
State (On/Off) |
Select “On” to enable or “Off” to disable BLE power. |
Read Digital Input - input parameter.
Outputs
Output Code |
Description |
|---|---|
0 |
BLE power state updated |
1 |
Unable to update BLE power |
-1 |
Invalid BLE power request |
Read Digital Input - output parameter.
2. Set Digital Output
Scans for nearby BLE devices and returns discovered devices.
Inputs
Parameter Name |
Description |
|---|---|
State (On/Off) |
Select “On” to enable or “Off” to disable BLE power. |
Set Digital Output - input parameter.
Outputs
Output Code |
Description |
|---|---|
0 |
BLE scan completed |
1 |
BLE scan failed |
-1 |
Invalid BLE scan request |
Set Digital Output - output parameter.
3. Digital Output ON
The block shall set the selected digital output channel to the ON state.
Inputs
Parameter Name |
Description |
|---|---|
Mac Address |
MAC address of the BLE device to connect |
Pass Key |
Enter the pairing pass key required to connect to the BLE device (if authentication is enabled). |
Digital Output ON - input parameter.
Outputs
Output Code |
Description |
|---|---|
0 |
Digital Output SRS Sentences |
1 |
Unable to turn ON the digital output. |
-1 |
Specified output channel is not valid. |
2 |
Digital output is already in ON state. |
Digital Output ON - output parameter.
4. Digital Output OFF
The block shall set the selected digital output channel to the OFF state.
Inputs
Parameter Name |
Description |
|---|---|
Mac Address |
MAC address of the BLE device to connect |
Pass Key |
Enter the pairing pass key required to connect to the BLE device (if authentication is enabled). |
Digital Output OFF - input parameter.
Outputs
Output Code |
Description |
|---|---|
0 |
Digital output turned OFF successfully. |
1 |
Unable to turn OFF the digital output. |
-1 |
Invalid BLE device details. |
2 |
Connection timeout occurred. |
Digital Output OFF - output parameter.
5. BLE Get RSSI
Retrieves the RSSI (Received Signal Strength Indicator) value from a connected BLE device.
Properties
Inputs
Parameter Name |
Description |
|---|---|
MAC Address |
MAC address of the connected BLE device |
BLE Get RSSI - input parameter.
Outputs
Output Code |
Description |
|---|---|
0 |
BLE RSSI value retrieved |
1 |
Unable to get BLE RSSI value |
-1 |
Invalid RSSI request |
BLE Get RSSI - output parameter.
Output Possibilities Configuration
6. BLE Info
Retrieves information about the specified BLE device.
Properties
Inputs
Parameter Name |
Description |
|---|---|
MAC Address |
MAC address of the BLE device |
BLE Info - input parameter.
Outputs
Output Code |
Description |
|---|---|
0 |
BLE device information fetched |
1 |
Unable to fetch BLE info |
-1 |
Invalid BLE info request |
BLE Info - output parameter.
Output Possibilities Configuration
7. BLE Write
Writes data to the specified BLE characteristic.
Properties
Inputs
Parameter Name |
Description |
|---|---|
MAC Address |
MAC address of the BLE device |
Service UUID |
UUID of the target BLE service |
Value |
Data payload to write |
BLE Write - input parameter.
Outputs
Output Code |
Description |
|---|---|
0 |
BLE written |
1 |
BLE write failed |
-1 |
Invalid BLE write request |
BLE Write - output parameter.
Output Possibilities Configuration
8. BLE Read
Reads data from the specified BLE characteristic.
Properties
Inputs
Parameter Name |
Description |
|---|---|
MAC Address |
MAC address of the BLE device |
Service UUID |
UUID of the target BLE service |
BLE Read - input parameter.
Outputs
Output Code |
Description |
|---|---|
0 |
BLE read |
1 |
BLE read failed |
-1 |
Invalid BLE read request |
BLE Read - output parameter.
Output Possibilities Configuration
9. BLE Send Command
Sends a BLE command to the connected BLE device.
Properties
Inputs
Parameter Name |
Description |
|---|---|
MAC Address |
MAC address of the BLE device |
Hex Byte |
Data payload to write |
BLE Send Command - input parameter.
Outputs
Output Code |
Description |
|---|---|
0 |
BLE command sent successfully |
1 |
BLE command failed |
-1 |
Invalid BLE command request |
BLE Send Command - output parameter.
Output Possibilities Configuration
10. BLE Unpair
Removes pairing information for the specified BLE device.
Properties
Inputs
Parameter Name |
Description |
|---|---|
MAC Address |
MAC address of the BLE device to unpair |
BLE Unpair - input parameter.
Outputs
Output Code |
Description |
|---|---|
0 |
BLE device unpaired |
1 |
BLE unpair failed |
-1 |
Invalid BLE unpair request |
BLE Unpair - output parameter.
