Delta Http Api Software User Manual

Delta Http Api Software User Manual

DELTA HTTP API Software User Manual
postman software logo

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 TypeKeyData Unit
TemperatureTEMP°C
NTC Temperature (opt.)NTC°C
Temperature °FTEMP_F°F
NTC Temperature °F (opt.)NTC_F°F
HumidityHUMIrH%
Ambient LightLUXlux
CO2CO2ppm
PM2.5PM2p5jLg/m3
PM10PM10jLg/m3
TVOC (opt.)TVOCppb
HCHO (opt.)HCHOppb
CO (opt.)COppm
O3 (opt.)O3ppb

 

Table 2 Sensor Moving Average Data

Sensor TypeKeyData UnitRule Description
CO2CO2_mappm8 hours
PM2.5PM2p5_majLg/m324 hours
PM10PM10_majLg/m324 hours
TVOC (opt.)TVOC_mappb1 hours
HCHO (opt.)HCHO_mappb1 hours
CO (opt.)CO_mappm8 hours
O3 (opt.)O3_mappb8 hours

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

API Manual

Requirement

Postman screenshot
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

APIProtocolDescription
getUnoNextPeriodPOSTGet UNOnext data based on moving average data.
Authorization: Bearer Token (In HTTP Request Header)
User token: Each Formatuser 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

KeyDescription
snSN of belonged UNOnext.
sensorMoving avg. data of sensor string array. null means all sensor. Empty array [] means no interested moving avg. data.
rtDataReal-time data of sensor string array. null means no interested real-time data. Empty array [] means all sensor data.
dataFormatAccept “dict”,”csv”,”json”. Use “dict”  for most case.
tsRangeEpoch 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

KeyDescription
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.dataResponded 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.

 

 

References

Documents / Resouces

Download manual
Here you can download full pdf version of manual, it may contain additional safety instructions, warranty information, FCC rules, etc.


Related Manuals