Property | Type | Description | Mandatory |
|---|---|---|---|
name | String | The free-text name of the Product. | Y |
description | String | The free text description of the Product. | |
icon | String | A link to the default icon to represent Devices of this Product type. | |
customIdDisplay | Boolean | The customID of a Device is the Device’s unique identifier in an external system. This enables the correlation of the IoT Platform Device ID with the external system’s Device ID. The customIdDisplay specifies whether to show a field in the IoT Platform Portal that enables the entry of a customer ID when defining each Device of this Product. Note ‒ customID is a property in the Devices/Post request of the IoT Platform REST API. | |
customIdRequired | Boolean | Specify True if it is mandatory to enter the customIdDisplay field when defining a Device of this Product (described above) in the IoT Platform Portal. | |
serialNumberDisplay | Boolean | Specifies whether to show a field in the IoT Platform Portal that enables the entry of a serial number when defining each device of this Product. serialNumber is a property in the Devices/Post request of the IoT Platform REST API. | |
serialNumberRequired | Boolean | Specify True if it is mandatory to enter the serialNumberDisplay field when defining a Device of this Product (described above) in the IoT Platform Portal. | |
active | Boolean | Not in use. | |
keepAliveThreshold | Integer | Specifies how long the system waits for a message from a Device (in minutes) of this Product before determining that the Device is disconnected. These Devices are indicated in the IoT Platform Portal as Disconnected. The default is 5 minutes, unless otherwise specified. -1 ‒ Specifies that the Device should never be indicated in the IoT Platform Portal as Disconnected. | |
defaultVirtualDeviceEvents | String | This property specifies the virtual device manifest for devices of this Product. This property is only relevant for virtual devices. See Defining a Virtual Device Manifest for more information. | |
disconnectChildDevicesOnDisconnect | Boolean | Specify True for all child Devices to be marked as Disconnected in IoT Platform when the parent Device is determined to be disconnected. This may be useful in a gateway scenario. | |
connectChildDevicesOnConnect | Boolean | Specify True for all child Devices to be marked as Connected in IoT Platform when the parent Device is determined to be disconnected. This may be useful in a gateway scenario. | |
disconnectGroupDeviceOnAllChildrenDisconnect | Boolean | Specifies that if all of a Group Device’s children are disconnected, the Group Device is also disconnected. Note ‒ This is related to the Group Device feature. | |
connectGroupDeviceOnAnyChildrenConnect | Boolean | Specifies that if even one of a Group Device’s children is Connected, the Group Device is also connected. Note ‒ This is related to the Group Device feature. | |
onConnectCommandIds | String | The list of command IDs to be automatically triggered when Devices of this Product connect to IoT Platform . | |
manufacturer | String | The free text manufacturer name of this Device type. | |
autoDiscoveryCommand | String | Specifies one or more command IDs to be automatically activated on the Device itself, when a Device is created. | |
displayCommandsTab | Boolean | Specifies that the IoT Platform Portal shows the Commands tab for Devices of this Product. This tab enables you to automatically activate commands on Devices of this Product. | |
onDeleteCommands | Array of Strings | Specifies one or more command IDs to be automatically activated on the Device itself, just before a Device of this Product is deleted from the IoT Platform system. | |
onPatchCommands | Array of Strings | Specifies one or more command IDs to be automatically activated on the Device itself, just before the data on a Device of this Product is patched by the IoT Platform system. | |
dispayDeviceSDKDetails | Boolean | This option is for IoT Platform Device SDK developers. True ‒ Specifies that additional information for developers is shown in the IoT Platform Portal. | |
enableSDKFeatures | Boolean | Enables you to activate the device twin features in IoT Platform . These features enable you to update a device’s firmware and settings from the IoT Platform platform. Such changes will be reflected on the IoT Platform platform. By default, this property is disabled. It must be set it to True to enable these features. | |
urn | String | Not in use. | |
schemaDefinitionsId | String | The ID of the schema definition, indicates that for this specific product, there is a schema to parse the incoming payload to the IoT Platform format. | |
disableInheritedConnectFromChildren | Boolean | Specify True to prevent parent device status connection to be affected by his child devices connection status. |