API

These messages are used by the devices reporting presence, occupancy, and visitor counter data.

13100

This message is used to report detections since the last reported movement report. For example, in case the device reports its current move status every 1 minute, this message can contain the count of detection during that 1 minute period. The time interval may be configurable so it is up to cloud system to keep up with the configured interval either by using preconfigured value or by determining based on timestamps.

{
    "moveCount" = 123
}

moveCount

moveCount is an integer where min = 0 and max = none. It contains the count of detections since the last reported movement report.

13102

This message is used to report how many times the area has been occupied since the last occupancy report.

{
    "count" : 123
}

Count

Count is an integer where min = 0 max = none. It contains the count of occupancies since the last report.

Duration

Duration is in seconds as integer where min = 0 max = none. This is the accumulated time in seconds the area has been occupied.

13200

This message can be used to remotely configure how device’s PIR sensor is configured, and how it reports its values. If any configuration field is omitted from configuration message, device reports back current setting. A sensor application must reply with the same message (applied configuration values) with a tsmEv : 31.

{
    "transactionId": 123456,
    "threshold": 800, 
    "enableLed": 0,
    "mode": 0,
    "passiveReportInterval": 3600
}

transactionId

TransactionId is an integer where min = 0 and max = 2.147483647e+09. TransactionId is reported back as-is and its purpose is to help the client to match the request to response send by the sensor device.

Threshold

Threshold is an integer where min = 60 and max = 1100, defaults to 150. Configures movement detection threshold for PIR sensor. If threshold is set to zero or less, default threshold is selected and reported back. If threshold is less or greater than supported threshold range, threshold is clamped to supported range and selected threshold value is reported back.

EnableLed

EnableLed is an integer where min = 0 and max = 1, defaults to 0.

• 0 = LED indication is disabled
• 1 = LED indication is enabled | Configures LED indication when movement is detect by PIR sensor

Mode

Mode is an integer where min = 0 and max = 1, defaults to 0. This property configures PIR reporting mode to better fit to targeted usecase.

• 0 = Movement count reporting. Movement count is reported at report interval with Movement data (13100) message.
• 1 = Occupancy reporting. Occupancy state changes are reported using Occupancy info data (2100) message. Occupancy state change reporting reduces traffic on Wirepas network and allow reduce power consumption of network and data traffic to mobile network and to the cloud.
• 2 = Event-based movement count reporting. Movement count is reported at report interval when movement is detected. Otherwise movement count is reported using passiveReportInterval

PassiveReportInterval

PassiveReportInterval is an integer where min = 0 and max = 86400, defaults to 3600. Configures PIR passive report interval. When there is no movement, report message is sent at every passiveReportInterval. Othervise reportInterval is used. passiveReportInterval must be longer than reportInterval in used in tsmId 1500.

This property is valid only when Mode is set to 2.

13210

Occupancy Light Configuration message can be used to remotely configure Occupancy Light. If any configuration field is omitted from configuration message, device reports back current setting. A sensor application must reply with the same message (applied configuration values) with a tsmEv : 31.

{
    "mode": 0,
    "index": 2,
    "staticFilter": 1,
    "threshold": 20,
    "duration": 10
}

Mode

Mode is an integer where min = 0 and max = 2, defaults to 0. Configures if the device should be forced to enable a light.

• 0 = Normal mode.
• 1 = Force single light.
• 2 = Outside installation.

Index

Index is an integer where min = 0 and max = 2. Configures which light should be enabled in the forced mode.

• 0 = Enable red light.
• 1 = Enable green light.
• 2 = Enable blue light.

StaticFilter

StaticFilter is an integer where min = 0 and max = 1, defaults to 0. Configures if the device should use filtering to detect the changes or compare raw values instead.

• 0 = Disable filtering.
• 1 = Enable filtering.

Threshold

Threshold is an integer where min = 0 and max = none, defaults to 30. Configures threshold for hot-region detection when using filtering. Lower value increses sensitivity but too low values might cause unwanted or false detections.

Duration

Duration is in seconds as an integer where min = 0 and max = none, defaults to 0. Configures a reset time after which the device is set to unoccupied mode if the device stays occupied for too long and there is no region changes detected. If set to zero, the reset behaviour is disabled.

13211

Occupancy Light Single Light Configuration message can be used to remotely configure single light. If any configuration field is omitted from configuration message, device reports back current setting. A sensor application must reply with the same message (applied configuration values) with a tsmEv : 31.

{ "index": 1, "max": 50 }

Index

Index is an integer where min = 0 and max = 2. Sets which light color should be configured.

• 0 = Configure red light.
• 1 = Configure green light.
• 2 = Configure blue light.

Max

Max is in percent as an integer where min = 0 and max = 100, defaults to 100. Configures the max light intensity as percent.