Overview

The master command table contains a list of all commands and properties available for use by the BAC that apply regardless of the network selected.

Network Protocol

Standard Properties

Command

Parameter

Description

BACName/get/heartbeat

None

Sent every 10 seconds (MQTT only)

BACName/get/Room_Reset

None

Sent on room reset event

BACName/get/Game_Reset

None

Sent on game reset event

BACName/get/Solve

None

Sent on solve event

BACName/get/Unsolve

None

Sent on unsolve event

BACName/get/Hit

None

Sent on hit event

BACName/get/Miss

None

Sent on miss event

BACName/get/Enable

None

Sent on enable event

BACName/get/Disable

None

Sent on disable event

BACName/get/Init

None

Sent on init event

BACName/get/Fail

None

Sent on fail event

BACName/get/learn

None

Sent on learn event

BACName/get/outputName

Default output name format: Output_n (0 - 5)

Example: myBAC/get/Output_5

digital state

Indicates digital state of output with name outputName

BACName/get/inputName

Default input name format: Input_n (0 - 7)

Example: myBAC/get/Input_5

digital state

Indicates digital state of input with name inputName

BACName/get/relayName

Default relay name format: Relay_n (0 - 1)

Example: myBAC/get/Relay_1

digital state

Indicates digital state of relay with name relayName

Standard Commands

Command

Parameter

Description

BACName/json

None

Returns JSON formatted BAC data (ERM only)

BACName/set/Room_Reset

None

Calls room reset event

BACName/set/Game_Reset

None

Calls game reset event

BACName/set/Solve

None

Calls solve event

BACName/set/Unsolve

None

Calls unsolve event

BACName/set/Hit

None

Calls hit event

BACName/set/Miss

None

Calls miss event

BACName/set/Enable

None

Calls enable event

BACName/set/Disable

None

Calls disable event

BACName/set/Init

None

Calls init event

BACName/set/Fail

None

Calls fail event

BACName/set/learn

None

Calls learn event

BACName/set/outputName

Default output name format: Output_n (0 - 5)

Example: myBAC/set/Output_5

digital state

Sets output with name outputName to digital state

BACName/set/inputName

Default input name format: Input_n (0 - 7)

Example: myBAC/set/Input_5

digital state

Sets input with name inputName to digital state

BACName/set/relayName

Default relay name format: Relay_n (0 - 1)

Example: myBAC/set/Relay_1

digital state

Sets relay with name relayName to digital state

BACName/set/eventName

Default input event name format: Input_Event_n (0 - 23)

Default custom event name format:

Custom_Event_n (0 - 7)

Example: myBAC/set/Custom_Event_5

None

Calls the event named eventName

BACName/set/action/playSprite

action options

Calls the "Play Sprite Video" event action

BACName/set/action/loopSprite

action options

Calls the "Set Sprite Loop" event action

BACName/set/action/playSound

action options

Calls the "Play Sound" event action

BACName/set/action/loopSound

action options

Calls the "Loop Sound" event action

BACName/set/action/stopSounds

action options

Calls the "Stop Sounds" event action

BACName/set/action/neopixels

action options

Calls the "Set Neopixels" event action

BACName/set/action/rfidOutput

action options

Calls the "Set Rfid Output" event action

BACName/set/action/clearEvents

action options

Calls the "Clear Events" event action

BACName/set/action/turnOnOutput

action options

Calls the "Turn On Output" event action

BACName/set/action/turnOffOutput

action options

Calls the "Turn Off Output" event action

BACName/set/action/turnOnRelay

action options

Calls the "Turn On Relay" event action

BACName/set/action/turnOffRelay

action options

Calls the "Turn Off Relay" event action

BACName/set/action/callEvent

action options

Calls the "Call Event" event action

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

Action Options

These are the usual options you would use when calling one of the actions from a normal BAC event. You can find details in the event actions section.

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.

FX60

The commands for FX60 inputs and outputs are the same as for normal ones. They are referred to by their name, which can be customized from the hardware screen.

Default FX60 IO names

IO Pin

Default Name

FX60 A, Bank 0, Pin 0

IO_96

FX60 A, Bank 0, Pin 1

IO_97

FX60 A, Bank 0, Pin 2

IO_98

FX60 A, Bank 0, Pin 3

IO_99

FX60 A, Bank 0, Pin 4

IO_100

FX60 A, Bank 0, Pin 5

IO_101

FX60 A, Bank 0, Pin 6

IO_102

FX60 A, Bank 0, Pin 7

IO_103

FX60 A, Bank 1, Pin 0

IO_104

FX60 A, Bank 1, Pin 1

IO_105

FX60 A, Bank 1, Pin 2

IO_106

FX60 A, Bank 1, Pin 3

IO_107

FX60 A, Bank 1, Pin 4

IO_108

FX60 A, Bank 1, Pin 5

IO_109

FX60 A, Bank 1, Pin 6

IO_110

FX60 A, Bank 1, Pin 7

IO_111

FX60 A, Bank 2, Pin 0

IO_112

FX60 A, Bank 2, Pin 1

IO_113

FX60 A, Relay 0

IO_114

FX60 A, Relay 1

IO_115

FX60 B, Bank 0, Pin 0

IO_128

FX60 B, Bank 0, Pin 1

IO_129

FX60 B, Bank 0, Pin 2

IO_130

FX60 B, Bank 0, Pin 3

IO_131

FX60 B, Bank 0, Pin 4

IO_132

FX60 B, Bank 0, Pin 5

IO_133

FX60 B, Bank 0, Pin 6

IO_134

FX60 B, Bank 0, Pin 7

IO_135

FX60 B, Bank 1, Pin 0

IO_136

FX60 B, Bank 1, Pin 1

IO_137

FX60 B, Bank 1, Pin 2

IO_138

FX60 B, Bank 1, Pin 3

IO_139

FX60 B, Bank 1, Pin 4

IO_140

FX60 B, Bank 1, Pin 5

IO_141

FX60 B, Bank 1, Pin 6

IO_142

FX60 B, Bank 1, Pin 7

IO_143

FX60 B, Bank 2, Pin 0

IO_144

FX60 B, Bank 2, Pin 1

IO_145

FX60 B, Relay 0

IO_146

FX60 B, Relay 1

IO_147