Overview
The master command table contains a list of all commands and properties available for use by the BAC.
Network Protocol
Standard Properties
|
Command |
Parameter |
Description |
|
BACName/get/heartbeat |
none |
Sent every
10 seconds (MQTT
only) |
|
BACName/get/enable |
none |
Sent on
enable event |
|
BACName/get/disable |
none |
Sent on disable
event |
|
BACName/get/solve |
none |
Sent on
solve event |
|
BACName/get/fail |
none |
Sent on fail
event |
|
BACName/get/hit |
none |
Sent on hit
event |
|
BACName/get/miss |
none |
Sent on miss
event |
|
BACName/get/reset |
none |
Sent on
reset event |
|
BACName/get/learn |
none |
Sent on
learn event |
|
BACName/get/outputn (0 - 5) Example: myBAC/get/output5 |
digital state |
Indicates digital state of output n |
|
BACName/get/inputn (0 - 7) |
digital state |
Indicates digital state of input n |
|
BACName/get/relayn (0 - 1) |
digital state |
Indicates digital state of relay n |
|
BACName/get/fx60_n (0 - 1)/iom (varies) Example: myBAC/get/fx60_1/io2 |
digital state |
Indicates digital state of input / output m for fx60 n |
|
BACName/get/fx60_n (0 - 1)/hioutputm (0 - 1) |
digital state |
Indicates digital state of hi output m for fx60 n |
|
BACName/get/fx60_n (0 - 1)/relaym (0 - 1) |
digital state |
Indicates digital state of relay m
for fx60 n |
Standard Commands
|
Command |
Parameter |
Description |
|
BACName/json |
none |
Returns JSON
formatted BAC data (ERM only) |
|
BACName/set/enable |
none |
Calls enable
event |
|
BACName/set/disable |
none |
Calls
disable event |
|
BACName/set/solve |
none |
Calls solve
event |
|
BACName/set/fail |
none |
Calls fail
event |
|
BACName/set/hit |
none |
Calls hit
event |
|
BACName/set/miss |
none |
Calls miss event |
|
BACName/set/reset |
none |
Calls reset
event |
|
BACName/set/learn |
none |
Calls learn
event |
|
BACName/set/outputn (n = 0-5) Example: myBAC/set/output5/Off |
digital state |
Sets output n to digital state |
|
BACName/set/inputn (n = 0-7) |
digital state |
Sets input n to digital state |
|
BACName/set/relayn (n = 0-1) |
digital state |
Sets relay n to digital state |
|
BACName/set/fx60_n (0 - 1)/iom (0 - 15) Example: myBAC/set/fx60_0/io4/On |
digital state |
Sets input / output m for fx60 n to digital state |
|
BACName/set/fx60_n (0 - 1)/hioutputm (0 - 1) |
digital state |
Sets hi output
m for fx60 n
to digital state |
|
BACName/set/fx60_n (0 - 1)/relaym (0 - 1) |
digital state |
Sets relay m for fx60 n
to digital state |
BACName refers to the name defined in BAM General Settings
Digital State Parameter
The digital state parameter represents either an on or off state. The following are valid values (not case sensitive):
|
On State |
Off State |
|
High |
Low |
|
1 |
0 |
|
True |
False |
|
On |
Off |
|
Yes |
No |
|
|
Any other value |
Example Commands
If you have a BAC called MyProp and want to turn output 5 on, you could send the following command:
MyProp/set/output5/on
If you wanted to reset the same BAC you could send the following command:
MyProp/set/reset
For specific
instructions on how to resend / receive commands, reference the documentation
for your room control software.