Modules

While each of the modules is different, most share some common properties, inputs, and outputs -

Parameters
Inputs
Outputs
Parameters

DeviceUuid and DeviceAccessKey are the devices credentials for connecting a device to the cloud. See below for more information on how to set them up.

Inputs

Device_Offline - This digital input indicates that the device is currently offline. This is should be connected to the the Ethernet offline Manager device extender for Ethernet devices, or to the Poll Manager for Cresnet devices. This should be ignored for control system.

Note that the system is designed in a way that each device must reach to the cloud at least once every 5 minutes. If the device does not reach to the cloud once every five minutes, we assume it is offline. All SyncPro modules automatically reach to the cloud service every 5 minutes or less. However, if a control system goes offline, all the devices that connects to the cloud through it, will be marked as offline too.

Device_Power_Status - For devices that support power status, this will report the device's power status, where - 0=Powered Off, 1=Powered On and 2=Standby

Device_Telemetry$ - This allows for sending common telemetry messages by the programmer. The string format must be in one of the following formats -

  • For string values - "{"Key":"keyName","Value":"strValue"}

  • For integer values - "{"Key":"keyName","Value":intValue}

  • For boolean values - "{"Key":"keyName","Value":true/false}

Note that the "Key" and "Value" are case-sensitive.

For you convenient, you can use the "SyncPro Telemetry Message Format Module" that is also included with the demo program.

Also note, that the telemetry messages must follow the Common Telemetry messages and values, or will be ignored.

Outputs

Device_Model$ - Reports the device's model, as configured in the cloud service Device_Name$ - Reports the device's name, as configured in the cloud service

Device_Manifest_Url$ - The URL of the device's manifest file. This should be connected to the "Auto Update Reserved Joins" device extender. Read more here. Device_AutoUpdate_Check_Now - Triggers the check now for checking for new firmware, project or configuration update. This should be connected to the "Auto Update Reserved Joins" device extender.

To connect a device to the CloudOS portal, follow the instructions in the user guide.