States - System Health

The System Health window enables users to quickly assess the current condition of the hardware (Cloud Nodes, Controllers, and connections) in their Customer Account. 

The System Health window can be accessed in two different ways, both of which are detailed below:

• By tapping or clicking the indicator in the upper right corner of the Customer Dashboard, shown in the image below.

• In the States window, tapping or clicking System Health, as shown in the image below.
• If you are already in the System Health window, tapping or clicking on Doors and Devices will return you to the main States window.

Once in the System Health window, all Cloud Nodes (both registered and placeholder), Controllers, and Aperio Hardware will be displayed by default. Each Cloud Node registered on the system will have its associated Controllers and Aperio Hardware listed below it.

Directly next to the Search Cloud Nodes & Devices section in the System Health window, a Filters button is available.

Tapping or clicking the Filters button opens a dialog menu, allowing you to select which filters to apply. After configuring any filters, tap or click Apply Filters. To clear all changes from the defaults, tap or click Reset Filters. Each Filter can select one or more items.

Cloud Nodes - This filter will limit the displayed Controllers and Aperio Hardware to those registered to the selected Cloud Node(s). Controllers and Hubs - This filter will limit the displayed Controllers and Aperio Hardware to the selected items. Status - This filter will limit the displayed hardware to the selected Status. Sync Status - This filter will limit the displayed hardware to only the selected Sync Status. Connection Types - This filter limits the displayed hardware to the selected Connection Type.

The Table Options allow a user to enable or disable the different columns in the System Health window by toggling on or off each associated section.

Status - Displays the Status column, showing the overall status of the hardware. Sync Status - Displays the Sync Status column detailed below. Sync Completed - Displays when the Cloud Node or Controller last synced with the Cloud database. Software Version - Displays the firmware version of the Cloud Node or Controller. Connection Type - Displays the column showing the Connection Type for the hardware Battery - Displays the column indicating whether the hardware has a backup battery connected and the corresponding charge percentage.

Status

Each Cloud Node and Controller added to the Customer Account will display the current Status of the Hardware.

• Connected - The hardware is currently connected to the Cloud Database, meaning any changes can be synced to the hardware.
• Disconnected - The hardware is currently not connected to the Cloud Database, meaning no changes can be synced to the hardware.

Sync Status

Each Red Cloud Node and Red Controller will show the current Sync Status.

• Pending - This status indicates that there are pending changes waiting to be synced with the Cloud Node or Controller. This can commonly occur due to pending Cloud Node updates, offline Controllers (which will sync upon re-connection), and other temporary conditions.
• Syncing - This status indicates that the Cloud Node or Controller is currently downloading and synchronizing the local database with the Cloud-based database.
• Synced - This Status shows that the local database is synchronized with the current Cloud-based database.
• Failed - If the Cloud Node or Controller is in this Status, please contact ProdataKey Support.

In the upper left area of the System Health window, next to the Filters button, is a search box. After tapping or clicking this box, you can search for any registered Hardware in the System Health window.

Tapping or clicking on the row displaying the Status of a Cloud Node or Controller will open the Health Details for that Cloud Node or Controller.

Cloud Node Health Details

Status - Displays if the Cloud Node is Connected to the Cloud (Online) or Disconnected (Offline) IPv4 Address - Displays the DHCP or static IPV4 address  IPv6 Address - Displays the IPV6 address MAC Address - Displays the MAC Address for the network adapter in the Cloud Node. Serial Number - Displays the Serial Number of the Cloud Node Software Version - Displays the version of software running on the Cloud Node which communicates with the cloud. API Software Version - Displays the version of software running on the Cloud Node that manages access control activity Sync Status - Please refer to the 'Sync Status' section above. Last Synced Time - Displays the time when the Cloud Node database synced with the cloud database

Controller Health Details

Status - Displays if the Controller is Connected to (Online) or Disconnected from (Offline) the Cloud Node. Connection Type - Displays if the Controller is an Onboard, Ethernet, or Wireless Controller. Device Type - For a Controller, this will always be Controller. Device Model - Displays the Model of the Controller. IPv4 Address - Displays the DHCP or static IPV4 address  IPv6 Address - Displays the IPV6 address MAC Address - Displays the MAC Address for the network adapter in the Cloud Node. Battery Charge - Displays the estimated charge level of an attached battery (if present) or if no battery is installed. Serial Number - Displays the serial number for the board in the Controller. This is also printed on a sticker on the board. Firmware Version - Displays the version of the firmware running on Red-series Controllers Sync Status - Please refer to the 'Sync Status' section above. Last Synced Time - Displays the time when the Controller database synced with the cloud database. Connection Unstable - Indicates whether the Controller has lost or regained communication repeatedly during a brief period. Overcurrent - Indicates whether the Controller is currently in an Overcurrent state. Undervoltage - Indicates whether the Controller is receiving or not receiving sufficient voltage from its power input. Low Power Mode On - Displays if the Controller is operating in Low Power Mode. A Low Power Mode is where a Controller operating with a low battery will power off any attached devices (reader, REX, locking hardware, etc) to maintain battery life. Input Power On - Displays if primary external power is connected or not. Input Current - Displays the input power current for the Controller. Input Voltage - Displays the input power voltage for the Controller. Peripheral Power On - Indicates whether the Controller is in a State where power is supplied to connected peripheral devices. Peripheral Current - Displays the current draw for peripherals connected to the Controller. Peripheral Voltage - Displays the voltage draw for peripherals connected to the Controller. Radio Timeout - Displays if the WiMAC module is in communication failure.

Hub Health Details

Status - Displays whether the Hub is Online (connected to the Cloud Node) or Offline (disconnected) Connection Type - Displays that the Hub is connected via Ethernet Device Type - For a Red Hub, this will always be Hub IPv4 Address - Displays the IPv4 Address IPv6 Address - Displays the IPv6 Address  Serial Number - Displays the Hub’s serial number. This is also printed on a sticker on the back of the Hub Firmware Version - Displays the firmware version currently running on the Hub Connection Unstable - Indicates if the Hub has repeatedly lost and regained communication within a short period

Wireless Lock Health Details

Status - Displays whether the Lock is Online (connected to the Hub) or Offline (disconnected) Connection Type - Displays the connection type, which is always HubNet for Wireless Locks Device Type - For a Lock, this will always be Wireless Lock Device Model - Displays the Device Model type. KMS for Deabolt and SDS for Cylindrical IPv4 Address - This will always be displayed with a dash.  IPv6 Address - This will always be displayed with a dash.  MAC Address - Displays the Lock’s MAC Address Battery Charge Level - Displays the estimated remaining battery charge Serial Number - Displays the Lock’s serial number. This is also printed on a sticker on the Lock Firmware Version - Displays the firmware version currently running on the Lock Sync Status - Displays the current sync state Last Sync Time - Displays the most recent time the Controller database synced with the Cloud database Connection Unstable - Indicates if the Lock has repeatedly lost and regained communication within a short period Jammed - Displays if the Deadbolt is in a Jammed state. Input Current - Displays the input power current for the Lock. Input Voltage - Displays the input power voltage for the Lock.

View State - This takes the User to a filtered Doors and Devices view, displaying only the Devices on the selected Controller.

View Config - This takes the User to the Connection Configuration page for the selected Connection. 

Restart Controller - Available only to Partners with Integrator Permissions, this option restarts the selected Controller, similar to power cycling the Controller.

Restart Device - Available only to Partners with Integrator Permissions, this option restarts the selected Hub or Lock, similar to power cycling.

Reset Device - Available only to Partners with Integrator Permissions, this option resets the selected Hub or Lock, similar to a physical soft reset.