DELTA HTTP API Software User Manual

DELTA HTTP API Software User Manual

Contents hide

3 Documents / Resources

3.1 References

4 Related Posts

Introduction

UNOnext is a multi-function sensors. It provides Temperature (°C/°F), Humidity (rH%), Ambient Light (lux), CO2 (ppm), PM2.5 (μg/m3), PM10 (μg/m3).The advance model optionally provides TVOC (ppb), HCHO (ppb), CO (ppm), and O3 (ppb). This document introduces using UNOweb HTTP API to retrieve the sensor data of the UNOnext based on JSON format. Additionally, UNOweb HTTP API also provides the moving average data of sensor based on Taiwan regulation. The data density is 1 record per 6 minutes when the UNOnext is online.
Note. UNOweb HTTP API only supports the UNOnext which is already set WiFiand connected to UNOweb.

Table 1 Sensor Table

Sensor Type	Key	Data Unit
Temperature	TEMP	^°C
NTC Temperature (opt.)	NTC	^°C
Temperature ^°F	TEMP_F	^°F
NTC Temperature ^°F (opt.)	NTC_F	^°F
Humidity	HUMI	rH%
Ambient Light	LUX	lux
CO2	CO2	ppm
PM2.5	PM2p5	jLg/m³
PM10	PM10	jLg/m³
TVOC (opt.)	TVOC	ppb
HCHO (opt.)	HCHO	ppb
CO (opt.)	CO	ppm
O3 (opt.)	O3	ppb

Table 2 Sensor Moving Average Data

Sensor Type	Key	Data Unit	Rule Description
CO2	CO2_ma	ppm	8 hours
PM2.5	PM2p5_ma	jLg/m³	24 hours
PM10	PM10_ma	jLg/m³	24 hours
TVOC (opt.)	TVOC_ma	ppb	1 hours
HCHO (opt.)	HCHO_ma	ppb	1 hours
CO (opt.)	CO_ma	ppm	8 hours
O3 (opt.)	O3_ma	ppb	8 hours

PS. If value of sensor is “null” presented unmounted or data unavailable.

API Manual

Requirement

UNOweb account with token API permission.

An on-line UNOnext’s SN.
Prepare a HTTP API client. E.g. Postman (https://www.postman.com/), reqBin (https://reqbin.com/)

Figure 1 Postman screenshot

API

Current UNOweb provides following HTTP API for UNOnext. https://isdweb.deltaww.com/api/getUnoNextPeriod

Table 3 get Uno Next Period Usage

API	Protocol	Description
getUnoNextPeriod	POST	Get UNOnext data based on moving average data.
Authorization: Bearer Token (In HTTP Request Header)
User token: Each Format	user has a unique token. Length is 32. Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Bearer <User token> E.g.

Post Body (JSON Format)
{ “sn”: “2040N00F0116”, “sensor”: null, “rtData”: [], “dataFormat”: “dict”, “tsRange”: null } JSON Key Description
Key	Description
sn	SN of belonged UNOnext.
sensor	Moving avg. data of sensor string array. *null* means all sensor. Empty array [] means no interested moving avg. data.
rtData	Real-time data of sensor string array. *null* means no interested real-time data. Empty array [] means all sensor data.
dataFormat	Accept “dict”,”csv”,”json”. Use “dict” for most case.
tsRange	Epoch time stamp array. [start, end] – [1613633000, 1613633201] *null* means the last data in 1 hour. Epoch Example: https://www.epochconverter.com/

Response (application/json)

{
“result”: “SUC”,
“payload”: {
“columns”: [
“time”,
“TEMP”,
“HUMI”,
“LUX”,
“NTC”,
“TVOC”,
“HCHO”,
“CO”,
“CO2”,
“O3”,
“PM2p5”,
“PM10”,
“TEMP_F”,
“NTC_F”
],
“data”: [
[
1619425800,
23.2,
67.57,
282,
null,
30000,
42,
0,
920,
0,
2,
1,
73.76,
null
] ] },
“rawCount”: 1,
“count”: 1
}

JSON Key Description

Key	Description
result	“SUC” is SUCCESSFUL. “FAIL” and “ERR” are return with error message.
payload.columns	Responded array presented sensor column. “time” is epoch stamp. Others can be found in Table 1 and Table 2
payload.data	Responded nested data array, each item is array corresponded sensor columns. null means no data at this time stamp, unmounted or sensor abnormal.
count	If the “result” is “SUC”, the “count” presents the length of valid data (not all null data) array.
rawCount	If the “result” is “SUC”, the “count” presents the length of data (contain all null data) array.