USAP Frame Format and Command Quick Reference
Frame Format
To complete a successful Unison serial command, use the following frame format as a guide. User defined information is required for Length and Data only. All other frames are as indicated.
- *Length is the number of bytes until CRC, or size of data plus 3. Again, this value, as well as the others must be represented in hex. See Decimal to Hex Conversion Chart.
- **Data is the command to be sent in ASCII (see Data Structure). The data portion of the packet should be less than 200 bytes long.
Start code | Length | Command | ID | Protocol | Data | CRC |
---|---|---|---|---|---|---|
0xEE | (*varies) | 0x00 | 0x00 | 0x40 | (*varies) | 0x0000 |
Example of a USAP packet:
In comparison, this same packet in hexidecimal format is:
ee1700004062616c6c726f6f6d2e64696e6e65722e616374690000
Command String
Commands are case sensitive and need to be phrased accurately and in the proper type case.
PRESET COMMANDS | Activate a Preset: | ACTI |
Deactivate a Preset: | DACT | |
Record a Preset: | RECO | |
Set a fade time for a Preset: | nDFT=(time is entered in milliseconds) | |
Get status of a Preset | bACT | |
Get priority status of a Preset: | bAAP | |
WALL COMMANDS | Open a Wall: | OPEN |
Close a Wall: | CLOS | |
Toggle a Wall state: | TOGL | |
Get status of a Wall: | bOPN | |
ZONE COMMANDS | Set intensity for a Zone: | nINT=(entered in 16-bit value - see Decimal to Hex Conversion Chart, for conversion chart) |
Get intensity value for a Zone: | nINT | |
MACRO COMMAND | Run a Macro: | EXEC |
Stop a Macro: | STOP | |
MASTER COMMAND | Set a Master level | nVAL=[Level Value] |
Get a Master level | nVAL |