Property | Type | Description | Mandatory |
|---|---|---|---|
events | Array of Event Objects | An Event/Reading is data received by the IoT Platform Server from a Device. This array property enables you to define one or more events that the Device can send to the IoT Platform server. Defining events here provides various customization options, even though the IoT Platform Dashboard can show events that are not defined here, Defining events here enables you to configure how the values of this event are shown in the Dashboard. For example, the icon or color in which a 0 value is shown in the Dashboard. The properties that appear below describe a single event. | |
events/typeCode | Integer | The code of this event type as defined in the event manifest. See Defining a Device Event Manifest for more information. The combination of the typeCode property and the name property (described below) represent a unique identifier for an event type. | To use events in the UI |
events/name | String | A free-text name of this event. This name does not appear in the Event Manifest. | To use events in the UI |
events/description | String | A description of the event. | |
events/dataType | String | The actual format of the data for this event, which corresponds to what is specified in the event manifest for the data type. Use one of the values below – • MultiDimensional • Double • Integer • GPS • String | |
events/displayType | String | Specifies which user interface controller is used in the IoT Platform Portal for presenting this event. Use one of the values below – • boolean • range • allowedValues | |
events/nameResourceKey | String | This is the unique identifier of this event for translating the event name property (described above). For example, this unique identifier could be used by IoT Platform ’s localization service to translate the name property Temperature into French Température. | |
events/unit | String | The default unit of the event’s value. For example, Fahrenheit or Centigrade. This unit is used for the event when a Device does not specify the unit. | |
events/isAccumulated | Boolean | When enabled, indicates that the event contains an accumulated value. For example, an electrical meter. When this setting is enabled for an event, IoT Platform reads the value differences between each reading and calculates the delta from the previous reading. | |
events/logicalType | String | The logical type of this event. Valid values are – • Number • CountByValue (used for events that have a state) • Instantaneous (used for events that are instantaneous, such as pressing a button) | |
events/fieldsCount | Integer | Not in use. | |
events/precision | Integer | The number of digits that show after the decimal point. | |
events/retention | Integer | Not in use. | |
events/iconName | String | The name of the default icon of the event. | |
events/iconColor | String | The color of the icon to represent this event in the IoT Platform Portal, which is represented in hex format. | |
events/subject | Not in use. | ||
events/calculationId | This feature enables you to set which custom calculation is used. It is only applicable for Group devices and can only be enabled with IoT Platform support. Contact IoT Platform support for more information if you want to use it. | ||
events/ defaultRollupMethod | Enables you to specify the default rollup aggregation for this event. For example, when set to AVERAGE for temperature and SUM for electricity consumption, IoT Platform will automatically select this aggregation method when aggregation is required. For example, for analytics. | ||
AggregatedEventSettings | ChartSeriesBase | Specify custom reading |