Table of Contents
-
- 4.1 Amplifier
- 4.2 Audio DSP
- 4.3 AV Switch
- 4.4 Camera
- 4.5 Capture Card
- 4.6 Charging Stations
- 4.7 Control System
- 4.8 Display
- 4.9 Extender
- 4.10 Lighting
- 4.11 Media Player
- 4.12 Microphone
- 4.13 Network Switch
- 4.14 Power Supply
- 4.15 Projector
- 4.16 Receiver
- 4.17 Speaker
- 4.18 Sensor
- 4.19 Set Top Box
- 4.20 Speaker Phone
- 4.21 Touch Panel
- 4.22 Transmitter
- 4.23 USB Bridge
- 4.24 Video Wall Processor
- 4.25 Wireless APT
- 4.26 Wireless Sharing
Signal API Guide (Crestron)
Download PDF1.0 Introduction
pivot provides the ability to upload logging from your devices into the pivot platform to allow your teams and clientele to easily monitor and configure your day-to-day workflows. By passing the logs as the specified signals listed in this document, you will automatically generate the corresponding alerts, workflows, and troubleshooting for the device and signal without further Integration.
These signals are the basic recommendations for a healthy pivot deployment. Additional signals can be added per any device, and will still have the ability to build out custom rules to build out to fit into your Service Team and Client’s workflow.
Any signals that are listed with Alerts or Troubleshooting are global, and passed among all of your clients
2.0 File Structure
When submitting your logs, it should be in a JSON file format
2.1 File Name
The file name should be as follows:
[pivot Client Location ID]_[Processor Monitoring ID]_[MM]_[DD]_[YYYY]_[HH]_[MM]_[SS].json
Where the Client Location ID can be found in the URL for the pivot page, the Monitoring ID in the editable table, and the hours are in the 24 hour clock. Here is an example of it filled out:
abcde1f2_12345678abc_04_29_2023_19_58_23.json
2.2 File Content
The content of the file is expected to be an array of arrays. Inside each of those arrays should list a 24 hour time entry with milliseconds, the Monitoring ID, the Device Status, and the Value.
[
[
“14:56:34.520”,
"1234\_Display\_01",
"IP Table State”,
"Offline"
],
[
"14:56:34.669",
"1234\_Microphone\_01",
"Muted\_State",
"Unmuted"
]
]
3.0 Signal Authentication
On generation of a new Client ID with the intent of monitoring, reach out to your integration specialist and they will pass along your identifications. These are used to authenticate with AWS In conjunction with the Client ID to process the log files.
Keep the info safe, as if this is lost it will need to be regenerated and will require all devices associated with the Client ID will need to be updated to match.
4.0 Signal List
4.1 Amplifier
Currently Amplifiers are able to track whether or not they are online and reporting to the Crestron Processor. Additional signalling could open up volume and other meaningful configurations
| Device Status | States | Global Alerts/Warning/Message/Workflow |
|---|---|---|
| IP Table State | Online/Offline | Alert/Troubleshooting |
4.2 Audio DSP
Audio DSPs can have their error logs report directly to pivot with a downloadable text file, so now you don’t even need to open a remote session and connect into the Audio DSP itself. You can also track audio calls, IP addresses, and initialized state all from one dashboard.
| Device Status | States | Global Alerts/Warning/Message/Workflow |
|---|---|---|
| Audio Call | Active/Idle | Analytics |
| Call State | Active/Idle | Analytics |
| Firmware Version | [Device Firmware Version] | Firmware Updater (Future Update) |
| IP Address | [Device IP Address] | Assets (Future Update) |
| IP Table State | Online/Offline | Alert/Troubleshooting |
| Mac Address | [Device Mac Address] | Assets (Future Update) |
| Model Number | [Device Model Number] | Assets (Future Update) |
| Mute State [Device Path] | Mute/Unmute | Alert/Troubleshooting |
| Serial Number | [Device Serial Number] | Assets (Future Update) |
| Program Modules - [Program Name] | Enabled/Disabled | Alert/Troubleshooting |
| VoIP Registration State | Registered/Unregistered | Troubleshooting |
| Error Log | {"faults": []}/{"faults": [ { "level": "Major", "name": "one or more Dante flows inactive"}]} | Download Logs |
| Host Name | [Device Hostname] | Assets (Future Update) |
| Initialized | TRUE |
4.3 AV Switch
Track your routing table and ensure nothing is wrong with your logic or monitor any number of values that an AV switch has to offer. You can keep an eye on what routes are currently being utilized, if HDCP is enabled, and your connections to your devices are stable.
| Device Status | States | Global Alerts/Warning/Message/Workflow |
|---|---|---|
| Auto Switch Status | Enabled/Disabled | |
| Device In Use Status | In Use/Not In Use | |
| Device Sync | Connected/Disconnected | |
| DHCP State | Enabled/Disabled | |
| [Description] Route | [Device Routed] | |
| Firmware Version | [Device Firmware Version] | Firmware Updater (Future Update) |
| HDCP State | Enabled/Disabled | |
| Host Name | [Device Hostname] | Assets (Future Update) |
| IP Address | [Device IP Address] | Assets (Future Update) |
| IP Table State | Online/Offline | Alert/Troubleshooting |
| Input [Input#] | [Source Name] | Alert/Troubleshooting |
| Mac Address | [Device Mac Address] | Assets (Future Update) |
| Power Status | On/Off | Alert |
| Resolution | 1920x1080/0x0/etc. | |
| Audio State | Online/Offline | |
| Broadcast State | Online/Offline | |
| Camera Connection | Online/Offline | |
| Constant Stat | Online/Offline | |
| Microphone Connection | Online/Offline | |
| Occupancy Internal Sensor | Online/Offline | |
| Output [Output#] | [Source Name] | Alert/Troubleshooting |
| Panel Receiver | Online/Offline | |
| Signal Receiver | Online/Offline | |
| Signal Status | Online/Offline | |
| Speaker Status | Online/Offline | |
| Stability | Good/Bad | |
| Transit Motion | Online/Offline | |
| VoIP Registration State | Registered/Unregistered | Alert/Troubleshooting |
| Voltage Reading | Online/Offline | |
| Wireless Receiver Status | Online/Offline | |
| Zoom Connection | Online/Offline |
4.4 Camera
With Cameras, our expected signaling is that you can track the whether the device is reachable to the Processor, or with additional custom signalling you could capture scenes configurations resolution, IP, and even state changes.
| Device Status | States | Global Alerts/Warning/Message/Workflow |
|---|---|---|
| IP Address | [Device IP Address] | Assets (Future Update) |
| IP Table State | Online/Offline | Alert/Troubleshooting |
| MAC Address | [Device MAC Address] | Assets (Future Update) |
4.5 Capture Card
Monitor your Capture Card to track your Resolution and ensure it doesn’t drop, HDCP state, and it’s connection to the Crestron Processor.
| Device Status | States | Global Alerts/Warning/Message/Workflow |
|---|---|---|
| Auto Switch Status | Enabled/Disabled | |
| HDCP State | Enabled/Disabled | |
| Resolution | 1920x1080/0x0/etc. | |
| Device Sync | Connected/Disconnected | |
| IP Table State | Online/Offline | Alert/Troubleshooting |
4.6 Charging Stations
With Charging Stations, our basic expectations are that you can track the whether the device is reachable to the Processor. With additional signalling determined by the device, we may be able to capture how many devices are being charged, and what devices are connected to the charging station.
| Device Status | States | Global Alerts/Warning/Message/Workflow |
|---|---|---|
| IP Table State | Online/Offline | Alert/Troubleshooting |
4.7 Control System
Control Systems can report multiple aspects of themselves, including things like network states, up time, clock information, and general health of your Control System.
| Device Status | States | Global Alerts/Warning/Message/Workflow |
|---|---|---|
| App Version | [Device App Version] | Firmware Updater (Future Update) |
| Buffer State | Normal/Overflow | |
| Device System | [Device System Info] | |
| DHCP State | Enabled/Disabled | |
| Firmware Version | [Device Firmware Version] | Firmware Updater (Future Update) |
| Host Name | [Device Hostname] | Assets (Future Update) |
| IP Table State | Online/Offline | Alert/Troubleshooting |
| Mac Address | [Device Mac Address] | Assets (Future Update) |
| IP Address | [Device IP Address] | Assets (Future Update) |
| Network Connection | Online/Offline | Alert |
| Program Name [Slot##] | [Program Name] | |
| Program State [Slot##] | Running/Stopped | |
| Days Since Reboot | [#OfDays] | |
| Hours Since Reboot | [#OfHours] | |
| Processor Date | [Day-Month-Year] | |
| Processor Time | [24 Hr time Local] | |
| Program [Slot##] Loaded Date | [Day-Month-Year] [24 Hr time Local] | |
| SNTP Server | [url] | |
| SNTP State | Enabled/Disabled |
4.8 Display
Monitoring your Display, you are able to track which input is currently selected, if the device is able to be reached by your processor, and even appversion of your display.
| Device Status | States | Global Alerts/Warning/Message/Workflow |
|---|---|---|
| Input | [Input Name Selected] | |
| IP Table State | Online/Offline | Alert/Troubleshooting |
| Power | On/Off | Alert |
| App Version | [Device App Version] | Firmware Updater (Future Update) |
| Device System | [Device System Info] |
4.9 Extender
With Extender devices, our basic expectations are that you can track the whether the device is reachable to the Processor. With additional signalling determined by the device, we can track resolution, HDCP, or even whether the device is currently sending video signals to a receiver or not.
| Device Status | States | Global Alerts/Warning/Message/Workflow |
|---|---|---|
| IP Table State | Online/Offline | Alert/Troubleshooting |
| # |
4.10 Lighting
With Lighting devices, our basic expectations are that you can track the whether the device is reachable to the Processor. With additional signalling determined by the device, we can track device state, blind position, lighting mode, and brightness.
| Device Status | States | Global Alerts/Warning/Message/Workflow |
|---|---|---|
| IP Table State | Online/Offline | Alert/Troubleshooting |
4.11 Media Player
Media Players can monitor whether it’s currently playing content, Resolution, and whether it’s online.
| Device Status | States | Global Alerts/Warning/Message/Workflow |
|---|---|---|
| Auto Switch Status | Enabled/Disabled | |
| HDCP State | Enabled/Disabled | |
| Resolution | 1920x1080/0x0/etc. | |
| Sync State | Connected/Disconnected | |
| Playing Content | Playing/Stopped | |
| IP Table State | Online/Offline | Alert/Troubleshooting |
4.12 Microphone
Monitoring Microphones allows you to track whether they are online, mute states, battery levels, and if they are rechargeable, if they are docked and charging.
| Device Status | States | Global Alerts/Warning/Message/Workflow |
|---|---|---|
| IP Table State | Online/Offline | Alert/Troubleshooting |
| Mac Address | [Device Mac Address] | Assets (Future Update) |
| Mute State | Mute/Unmuted | |
| Active State | Active/Inactive | |
| Battery Level | [0.00->1.00] | Message |
| Charge State | Charging/Charged/In Use | |
| Dock State | Docked/Undocked |
4.13 Network Switch
Network Switch monitoring allows you to download error logs straight from pivot and check the network status of the switch and ports in one easy device card.
| Device Status | States | Global Alerts/Warning/Message/Workflow |
|---|---|---|
| Error Log | {"faults": []}/{"faults": [ { "level": "Major", "name": "one or more Dante flows inactive"}]} | Download Logs |
| Firmware | [Firmware Version] | Assets (Future Update) |
| Host Name | [Network Host Name] | Assets (Future Update) |
| IP Table State | Online/Offline | Alert/Troubleshooting |
| Net IP Table Status | Online/Offline | Alert |
| Port [##] | Up/Down |
4.14 Power Supply
Power Supply monitoring allows you to keep an eye on any spikes in power, or if there is a unusual draw occurring with your devices to help find the faulty device in question.
| Device Status | States | Global Alerts/Warning/Message/Workflow |
|---|---|---|
| IP Address | [Device IP Address] | Assets (Future Update) |
| IP Table State | Online/Offline | Alert/Troubleshooting |
| Mac Address | [Device MAC Address] | Assets (Future Update) |
| Device Amperage Current Value | [Current Amp Value] | Troubleshooting |
| Device Amperage Rating | [Amp Rating Value] | Troubleshooting |
| Device Amperage Threshold High | [Amp Threshold High Value] | Troubleshooting |
| Device Amperage Threshold Low | [Amp Threshold Low Value] | Troubleshooting |
| Device Voltage Current Value | [Current Voltage Value] | Troubleshooting |
| Device Voltage Rating | [Voltage Rating Value] | Troubleshooting |
| Device Voltage Threshold High | [Voltage Threshold High Value] | Troubleshooting |
| Device Voltage Threshold Low | [Voltage Threshold Low Value] | Troubleshooting |
| Device Wattage Current Value | [Current Wattage Value] | Troubleshooting |
| Outlet [#] Load | [Load Value] | Troubleshooting |
| Outlet [#] Name | [Outlet Name] | Troubleshooting |
| Outlet [#] Power State | Power On/Power Off | Troubleshooting |
| Outlet [#] Voltage | [Voltage Value] | Troubleshooting |
| Outlet [#] Wattage | [Wattage Value] | Troubleshooting |
4.15 Projector
Projectors, much like displays, can show you when it’s online/offline, as well as provide you with Lamp Hours, and any errors the projector is reporting at the time.
| Device Status | States | Global Alerts/Warning/Message/Workflow |
|---|---|---|
| Lamp [##] Hours | [Hours of Lamp] | |
| Errors | [Error reported on Projector] | |
| Power | On/Off | Alert |
| IP Table State | Online/Offline | Alert/Troubleshooting |
4.16 Receiver
Receivers can monitor the resolution of the incoming video signal, network states, and whether HDCP state is enabled.
| Device Status | States | Global Alerts/Warning/Message/Workflow |
|---|---|---|
| Auto Switch Status | Enabled/Disabled | |
| HDCP State | Enabled/Disabled | |
| Host Name | [Network Host Name] | Assets (Future Update) |
| Resolution | 1920x1080/0x0/etc. | |
| Sync State | Connected/Disconnected | |
| IP Table State | Online/Offline | Alert/Troubleshooting |
| Mac Address | [Device Mac Address] | Assets (Future Update) |
| IP Address | [Device IP Address] | Assets (Future Update) |
| Input [#] | [Name of Source] | Assets (Future Update) |
| Output [#] | [Name of Output] | Assets (Future Update) |
| Firmware Version | [Device Firmware Version] | Firmware Updater (Future Update) |
| Host Name | [Device Hostname] | Assets (Future Update) |
4.17 Speaker
Many traditional Speakers won’t be able to communicate with the Processors, but network speakers can pass meaningful data like their Audio or Broadast states, and some even their Voltage Reading, helping you identify audio issues.
| Device Status | States | Global Alerts/Warning/Message/Workflow |
|---|---|---|
| Audio State | Online/Offline | |
| Broadcast State | Online/Offline | |
| Connectivity | Online/Offline | |
| IP Table State | Online/Offline | Alert/Troubleshooting |
| Speaker Status | Online/Offline | |
| Voltage Reading | [Voltage] |
4.18 Sensor
Sensors, like Wall Sensors or Occupancy Sensors can help you monitor and check the sensors reactivity and highlight if adjustments need to be made. Track things like whether the Occupancy Sensor is detecting anyone, of if the Wall is put away.
| Device Status | States | Global Alerts/Warning/Message/Workflow |
|---|---|---|
| Room Occupied | Yes/No | |
| IP Table State | Online/Offline | Alert/Troubleshooting |
| Actual Wall Status | Open/Closed | |
| Program Wall Status | Open/Closed | |
| Room Combine Mode | Automatic Mode/Manual Mode | |
| IP Table State | Online/Offline | Alert |
4.19 Set Top Box
Set Top Box can be monitored and track things like HDCP State, whether it’s outputting content, or if it’s reachable.
| Device Status | States | Global Alerts/Warning/Message/Workflow |
|---|---|---|
| Auto Switch Status | Enabled/Disabled | |
| HDCP State | Enabled/Disabled | |
| Device In Use Status | In Use/Not In Use | |
| Resolution | 1920x1080/0x0/etc. | |
| Sync State | Connected/Disconnected | |
| IP Table State | Online/Offline | Alert/Troubleshooting |
| Power Status | On/Off |
4.20 Speaker Phone
Speaker Phone’s can track it’s usage through Audio Call and it’s network connectivity to the Processor.
| Device Status | States | Global Alerts/Warning/Message/Workflow |
|---|---|---|
| Audio Call | Active/Idle | Analytics |
| IP Table State | Online/Offline | Alert/Troubleshooting |
4.21 Touch Panel
Track the touch panel’s app version, network states, and connectivity to the Processor. Additionally, for wireless devices you can, check the battery level, if it’s charging, and whether the device is docked or not.
| Device Status | States | Global Alerts/Warning/Message/Workflow |
|---|---|---|
| App Open Status | Application Opened/Application Closed | |
| App Version | {Device App Version] | Firmware Updater (Future Update) |
| Device System | [Device Info] | |
| IP Table State | Online/Offline | Alert/Troubleshooting |
| System Status | On/Off | |
| Charge State | Charging/Charged/In Use | |
| Battery Level | [0.00->1.00] | Message |
| Dock State | Docked/Undocked |
4.22 Transmitter
Transmitter’s, much like their Receiver counterparts, can track the HDCP state, resolution it’s receiving to send out, and network states.
| Device Status | States | Global Alerts/Warning/Message/Workflow |
|---|---|---|
| Auto Switch Status | Enabled/Disabled | |
| HDCP State | Enabled/Disabled | |
| Host Name | [Network Host Name] | Assets (Future Update) |
| Resolution | 1920x1080/0x0/etc. | |
| Sync State | Connected/Disconnected | |
| IP Table State | Online/Offline | Alert/Troubleshooting |
| Wired Input State | Connected/Disconnected |
4.23 USB Bridge
Monitoring a USB Bridge we can expect to see if there are any error statuses, and the network connectivity to the Processor.
| Device Status | States | Global Alerts/Warning/Message/Workflow |
|---|---|---|
| Status | Ok/Error | Alert |
| USB Bridge USB Type | [Device USB Type] |
4.24 Video Wall Processor
Video Wall Processors are expected to be able to report whether they can be seen from the processor, but depending on the Processor, you can track each screen’s health state, and the order in which your displays are connected to the Video Wall Processor.
| Device Status | States | Global Alerts/Warning/Message/Workflow |
|---|---|---|
| IP Table State | Online/Offline | Alert/Troubleshooting |
4.25 Wireless APT
Wireless APT (Access Point Transceiver) can monitor if the device no longer is accessible by the processor, or for portable Wireless APT units, report back on battery states, and whether they are charging or not.
| Device Status | States | Global Alerts/Warning/Message/Workflow |
|---|---|---|
| IP Table State | Online/Offline | Alert/Troubleshooting |
| Active State | Active/Inactive | |
| Mute State | Mute/Unmuted | |
| Charge State | Charging/Charged/In Use | |
| Battery Level | [0.00->1.00] | Message |
| Dock State | Docked/Undocked |
4.26 Wireless Sharing
Wireless Sharing enables you to take advantage of signals like resolution, HDCP State, and the portable devices to share, you can get battery states.
| Device Status | States | Global Alerts/Warning/Message/Workflow |
|---|---|---|
| Auto Switch Status | Enabled/Disabled | |
| Automatic Routing | On/Off | |
| HDCP State | Enabled/Disabled | |
| Resolution | 1920x1080/0x0/etc. | |
| Sync State | Connected/Disconnected | |
| IP Table State | Online/Offline | Alert/Troubleshooting |
| Output Source | [Output Source Name, Eg. Splash Screen, Left Display ] | |
| Wired Input State | Connected/Disconnected | |
| Wireless Input State | Connected/Disconnected | |
| Active State | Active/Inactive | |
| Mute State | Mute/Unmuted | |
| Charge State | Charging/Charged/In Use | |
| Battery Level | [0.00->1.00] | Message |
| Dock State | Docked/Undocked |
5.0 Errors
Frequently Reported Errors
| Problem | Feedback | Steps to Resolve |
|---|---|---|
| Failed to Upload | AWS Permission Failure | Check your Access Key and Secret Key is correct. |
| Failed to Upload | AWS Permission Failure (cont.) | Reach out to your pivot Integration Specialist to check if Access Key and Secret Key are still active |
| Failed to Upload | Accepting Logs but not updating in pivot | Check over Log File Name and Content are correct and Monitoring ID matches with what is in room |
| Failed to Upload | Accepting Logs but not updating in pivot (cont.) | Check to see if you are sending logs to either Staging or Production, and you are viewing the same web page |
| Device not Reporting Correctly | Device is not Reporting as you would expect | Check over logs and manually check the most recent log that was sent |
| Device not Reporting Correctly | Device is not Reporting as you would expect (cont.) | Check if logs keep ‘swapping’ values quickly, and ensure that the timestamps are accurate |