Recipient and API
Recipient
The device supports to add data receivers (supports HTTP(s)/MQTT(s)). The device will proactively push data to the receivers according to the configured reporting scheme. For details on the data push format, please refer to Communication Protocol.
Besides, users can get the people counting data or configure the device via CGI.
| Parameters | Description |
|---|---|
| Recipient Name | Show the recipient name. |
| URL/Host | Show the URL/host of HTTP(s) server or MQTT broker. |
| Protocol | Show the report protocol. |
| Status | Show connection status from device to HTTP(s) server or MQTT broker. |
| Operation | Click to edit the information or delete the recipient. |
| Parameters | Description |
|---|---|
| Recipient Name | Customize the recipient name. |
| Report Protocol | HTTP(s) or MQTT is optional. |
| HTTP(s) | |
| URL | The device will post the people counting data in json format to this URL. |
| Connection Test | Click Test to send test message to URL to check connectivity. |
| Username | The username used for authentication. |
| Password | The password used for authentication. |
| MQTT | |
| Host | MQTT broker address to receive data. |
| Port | MQTT broker port to receive data. |
| Client ID |
Client ID is the unique identity of the client to the server. It must be unique when all clients are connected to the same server, and it is the key to handle messages at QoS 1 and 2. |
| Username | The username used for connecting to the MQTT broker. |
| Password | The password used for connecting to the MQTT broker. |
| Topic | Topic name used for publishing. These strings will be replaced with device info when subscribing to a topic: $devsn：Device SN $prdmd：Product Model $devid：Customized Device ID $siteid：Customized Site ID |
| QoS | QoS0, QoS1, and QoS2 are optional. |
| TLS | Enable the TLS encryption in MQTT communication. |
| Certificate Type |
CA Signed Server or Self Signed is optional. CA signed server certificate: verifying with the certificate issued by Certificate Authority (CA) that is pre-loaded on the device. Self signed certificates: upload the custom CA certificates, client certificates and secret key for verification. |
| Report Strategy | |
| Trigger Report | Report immediately when there is a change of the line crossing people counting number or region people counting number. |
| Periodic Report |
Select the periodic report of “On the Dot” or “From Now On”. On the Dot: The device will report at the top of each hour. For example, When the interval is set to 1 hour, it will report at 0:00, 1:00, 2:00 and so on; when the interval is set to 10 minutes, it will report at 0:10, 0:20, 0:30, and so on. From Now On: Begin reporting from this moment onwards and regularly report based on the interval cycle. |
| Periodic Report Scheme | |
| Period | |
| Data Retransmission | Enable to resend stored data packets from the disconnected period when the device's network connection is restored. Every recipient supports to receive 50,000 pieces of data at most. |
| Customize Report Content | Customizable selection of content to be
reported, avoiding data redundancy. |
MQTT API (Cellular Version Only)
The device provides MQTT API to support to receive downlink commands from MQTT broker to get people counting data and achieve the configuration.
| Parameters | Description |
|---|---|
| Status | Show connection status between device and MQTT broker. |
| Host | MQTT address to receive data. |
| Port | MQTT port to receive data. |
| Topic | Topic name used for publishing. These strings will be replaced with device info when subscribing to a topic: $devsn：Device SN $prdmd：Product Model $devid：Customized Device ID $siteid：Customized Site ID |
| Client ID |
Client ID is the unique identity of the client to the server. It must be unique when all clients are connected to the same server, and it is the key to handle messages at QoS 1 and 2. |
| Username | The username used for connecting to the MQTT. |
| Password | The password used for connecting to the MQTT. |
| QoS | QoS0, QoS1, QoS2 are optional. |
| TLS | Enable the TLS encryption in MQTT communication. |
| Certificate Type |
CA Signed Server or Self Signed is optional. CA signed server certificate: verifying with the certificate issued by Certificate Authority (CA) that is pre-loaded on the device. Self signed certificates: upload the custom CA certificates, client certificates and secret key for verification. |