The device is connected via Ethernet to a control system, such as AMX, Crestron or Extron.
Connection: Ethernet (TCP/IP; select “Client” in the AMX/Crestron program)
Port: 2202
There are 4 types of strings:
GET | Finds the status of a parameter. After the AMX/Crestron sends a GET command, the device responds with a REPORT string |
SET | Changes the status of a parameter. After the AMX/Crestron sends a SET command, the device will respond with a REPORT string to indicate the new value of the parameter. |
REP | When the device receives a GET or SET command, it will reply with a REPORT command to indicate the status of the parameter. REPORT is also sent by the device when a parameter is changed on the MXCWNCS or through the GUI. |
SAMPLE | Used for metering audio levels. |
All messages sent and received are ASCII. Note that the level indicators and gain indicators are also in ASCII.
Most parameters will send a REPORT command when they change. Thus, it is not necessary to constantly query parameters. The device will send a REPORT command when any of these parameters change.
Indexing is used to specifically identify upon what the command string is acting.
0 | All |
1 through 10 | Bay Number |
Description | Retrieve all supported commands |
Supported Commands | GET and REP |
Indexing |
0: All device or bay properties n: All device or bay n properties |
Values | None |
Examples |
< GET 0 ALL > : Responds with REP for all device specific properties and ALL index related properties including all metered properties. < GET n ALL > : Responds with REP for all device specific properties and ALL index n related properties including all metered properties. |
Description | Retrieve model name |
Supported Commands | GET and REP |
Indexing | None |
Values |
Format: 32 character string |
Examples |
< GET MODEL > |
Description | Turn on flash to identify a device |
Supported Commands | GET, SET, and REP |
Indexing | None |
Values |
Format: Fixed string OFF ON |
Examples |
< GET FLASH > |
Description | Retrieve firmware version |
Supported Commands | GET and REP |
Indexing | None |
Values |
Format: 24 character string Package version number presented in dot-decimal notation: Maj.Min.Pack.Build<SelfTestFailed=*> |
Examples | Example where self test passed: < GET FW_VER > < GET FW_VER > |
Description | Retrieve and set device ID |
Supported Commands | GET, SET, and REP |
Indexing | None |
Values |
Format: 31 character string for REP 1-31 Characters from the set: -0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz All DNS names and labels are up to 31 characters in length Name and label comparisons are case-insensitive; “Guitar” and “guitar” are treated as the same label. Unicode and non-roman characters are not supported. Device names should follow Domain Name System (DNS) hostname rules. Legal characters are A-Z, a-z, 0-9, and '-' (dash or hyphen). Device names must begin with A-Z (or a-z), or 0-9. |
Examples |
< GET DEVICE_ID > |
Description | Retrieve and set storage mode |
Supported Commands | GET, SET, and REP |
Indexing | None |
Values |
Format: Fixed string OFF ON TOGGLE (for SET only) |
Examples |
< GET STORAGE_MODE > |
Description | Detect battery |
Supported Commands | GET and REP |
Indexing | Bay Number |
Values |
Format: Fixed string YES NO |
Examples |
< GET 10 BATT_DETECTED > |
Description | Retrieve battery status |
Supported Commands | GET and REP |
Indexing | Bay Number |
Values |
Format: Fixed string FULL CALCULATING NORMAL WARM WARM_FULL HOT COLD PRECHARGE READY_TO_STORE DISCHARGE_CALC DISCHARGING DISCHARGING_WARM DISCHARGING_COLD ERROR: In which case see BATT_ERROR for corresponding error code NO_BATT |
Examples |
< GET 1 BATT_STATE > < REP 1 BATT_STATE FULL > |
Description | Retrieve the number of battery bars |
Supported Commands | GET and REP |
Indexing | Bay Number |
Values |
Format: 3 numbers 000-005: Number bars reported 254: An error has occurred, the value is not applicable at this time 255: Unknown, or not applicable |
Examples |
< GET 1 BATT_BARS > < REP 1 BATT_BARS 004 > |
Description | Target time to full charge |
Supported Commands | GET and REP |
Indexing | Bay Number |
Values |
Format: 5 numbers Note: Can be considered as time to target where:
00000 - 65528 : Number of minutes estimated to reach the target 65529 : Battery is full 65530 : Battery is hot 65531 : Battery is warm 65532 : Battery is cold 65533 : Calculation in progress 65534 : An error has occurred, the value is not applicable at this time 65535 : Unknown, or not applicable |
Examples | Battery gets put into charger bay 4: < REP 4 BATT_TIME_TO_FULL 65533 > < REP 4 BATT_TIME_TO_FULL 65535 > |
Description | View battery charge status |
Supported Commands | GET and REP |
Indexing | Bay Number |
Values |
Format: 3 numbers 000-100: Percent status of charge 254: An error has occurred, the value is not applicable at this time 255: Unknown, or not applicable |
Examples |
< GET 1 BATT_CHARGE > |
Description | Monitor battery health percentages |
Supported Commands | GET and REP |
Indexing | Bay Number |
Values |
Format: 3 numbers 000-100: Percent status of health 254: An error has occurred, the value is not applicable at this time 255: Unknown, or not applicable |
Examples |
< GET 1 BATT_HEALTH > |
Description | Monitor individual battery cycles |
Supported Commands | GET and REP |
Indexing | Bay Number |
Values |
Format: 5 numbers 00000 - 65533 : Number of charging cycles 65534 : An error has occurred, the value is not applicable at this time 65535 : Unknown, or not applicable |
Examples | Battery gets put into charger bay 4: < REP 4 BATT_CYCLE 00006 > |
Description | View current battery capacity |
Supported Commands | GET and REP |
Indexing | Bay Number |
Values |
Format: 5 numbers 00000 to 65533: The current battery capacity in mAh 65534 : An error has occurred, the value is not applicable at this time 65535 : Unknown, or not applicable |
Examples |
< GET 1 BATT_CURRENT_CAPACITY > |
Description | View current battery maximum capacity |
Supported Commands | GET and REP |
Indexing | Bay Number |
Values |
Format: 5 numbers 00000 to 65533: The current battery maximum capacity in mAh 65534: An error has occurred, the value is not applicable at this time 65535: Unknown, or not applicable |
Examples |
< GET 1 BATT_CURRENT_CAPACITY_MAX > |
Description | View battery maximum capacity |
Supported Commands | GET and REP |
Indexing | Bay Number |
Values | Format: 5 numbers 00000 to 65533: The battery maximum capacity in mAh 65534: An error has occurred, the value is not applicable at this time 65535: Unknown, or not applicable |
Examples |
< GET 1 BATT_CAPACITY_MAX > |
Description | View battery temperature in Celsius |
Supported Commands | GET and REP |
Indexing | Bay Number |
Values |
Format: 3 numbers ActualValue = ReportedValue - 40 000 to 253: Temperature in C 254: An error has occurred, the value is not applicable at this time 255: Unknown, or not applicable |
Examples |
< GET 1 BATT_TEMP_C > |
Description | View battery temperature in Fahrenheit |
Supported Commands | GET and REP |
Indexing | Bay Number |
Values |
Format: 3 numbers ActualValue = ReportedValue - 40 000 to 253: Temperature in F 254: An error has occurred, the value is not applicable at this time 255: Unknown, or not applicable |
Examples |
< GET 1 BATT_TEMP_F > |
Description | View battery error |
Supported Commands | GET and REP |
Indexing | Bay Number |
Values |
Format: 3 numbers 000: No active error 001: Unknown module 002: Unrecognized battery 003: Deep discharge recovery failed 004: Charge failed 005: Check battery 006: Check charger 007: Communication failure 254: An error has occurred, the value is not applicable at this time 255: Unknown, or not applicable |
Examples |
< GET 1 BATT_ERROR > |
Description | |
Supported Commands | GET and REP |
Indexing | Module Number: Depends on the model |
Values |
Format: 3 numbers Macro corresponding to the model of the module: 000: No module installed 001: MXCWNCS 254: An error has occurred, the value is not applicable at this time 255: Unknown, or not applicable |
Examples | For an SBC840: < GET 1 BATT_MODULE_TYPE > < GET 0 BATT_MODULE_TYPE > |
Notes | The indexing and values listed above are the super set of all values. For the SBCx40 charges the following values are expected: SBC220:
SBC240:
SBC840:
SBC840M:
|