This document describes the HTTP APIs provided by Pontosense for third-party integration. To access these APIs, please obtain an access key from the Pontosense Developer Portal.
In this document, "Client" refers to the Integrator system.
Fetch a list of available firmware upgrades for different sensor models.
[- {
- "model": 2,
- "firmwareList": [
- {
- "id": 1,
- "state": 0,
- "changelog": "string",
- "uploadTime": 1692569600000,
- "releaseTime": 1692569600000,
- "fileName": "string",
- "version": "1.1.0"
}
]
}
]Sensors require certificates to connect securely to the MQTT broker. During onboarding, the client server requests these certificates through this API and then forwards them to the sensor.
| sn required | string (sn) Example: ATR_GN_P4-250120-09527 Sensor SN in path |
| version required | string (version) ^(\d+)\.(\d+)\.(\d+)$ The (firmware) version number in X.Y.Z format |
| model required | integer <int32> (model) Enum: 2 4 Sensor models
|
{- "version": "1.1.0",
- "model": 2
}{- "thingName": "string",
- "certPem": "string",
- "publicKey": "string",
- "privateKey": "string",
- "orgId": 1
}Retrieve a list of sensors with optional filtering and pagination.
| pageNo required | integer >= 1 Example: pageNo=1 Page number for pagination |
| pageSize required | integer >= 1 The number of items per page |
| sort | string Example: sort=name, createTime Field names for sorting |
| order | string Enum: "asc" "desc" Ordering of the results |
| sn | string (sn) Example: sn=ATR_GN_P4-250120-09527 Sensor SN in query string (optional) |
| model | integer <int32> (model) Enum: 2 4 Example: model=2 Sensor model |
| version | string (version) ^(\d+)\.(\d+)\.(\d+)$ Example: version=1.1.0 Firmware version |
| state | integer <int32> (SensorState) Enum: 0 1 2 3 Sensor connection status |
| workState | integer <int32> (SensorWorkState) Enum: 0 1 Sensor work status |
{- "countId": "string",
- "current": 1,
- "maxLimit": 0,
- "optimizeCountSql": true,
- "orders": [
- {
- "asc": true,
- "column": "string"
}
], - "pages": 0,
- "searchCount": true,
- "size": 0,
- "total": 0,
- "records": [
- {
- "sn": "ATR_GN_P4-250120-09527",
- "model": 2,
- "orgName": "string",
- "state": 0,
- "workState": 0,
- "activationTime": 1692569600000,
- "currentVersion": "1.1.0",
- "availableVersion": "1.1.0"
}
]
}| sn required | string (sn) Example: ATR_GN_P4-250120-09527 Sensor SN in path |
{- "sn": "ATR_GN_P4-250120-09527",
- "version": "1.1.0",
- "model": 2,
- "configs": {
- "scanArea": {
- "left": 600,
- "right": 600,
- "height": 200
}, - "fall": {
- "threshold": 90
}
}, - "defaults": {
- "scanArea": {
- "left": 600,
- "right": 600,
- "height": 200
}, - "fall": {
- "threshold": 90
}
}, - "angle": {
- "roll": -0.4792781174182892,
- "pitch": -0.9031561017036438
}
}| sn required | string (sn) Example: ATR_GN_P4-250120-09527 Sensor SN in path |
| left required | integer [ 0 .. 600 ] left scan distance in cm |
| right required | integer [ 0 .. 600 ] right scan distance in cm |
| height required | integer [ 200 .. 350 ] mount height of the sensor in cm |
{- "left": 600,
- "right": 600,
- "height": 200
}{- "code": 0,
- "message": "string"
}Define zones for a sensor to identify key areas such as beds, doors, or toilets. Use zones to enable zone-specific activity logging and events.
| sn required | string (sn) Example: ATR_GN_P4-250120-09527 Sensor SN in path |
| id required | integer <int64> (id) >= 1 The unique identifier of the entity |
| type required | integer <int32> Enum: 10 20 30 40 50 Zone type
|
required | Array of objects (Coordinate) = 2 items Zone boundaries in centimeters, given as the top-left and bottom-right corner points. |
| height | integer <int32> >= 0 Zone height in centimeters (integer ≥ 0). |
| angle | integer <int32> [ 0 .. 360 ] Zone orientation in degrees (0-360, where 0 = top-up, measured clockwise). |
[- {
- "id": 1,
- "type": 10,
- "coordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "height": 0,
- "angle": 360
}
]{- "code": 0,
- "message": "string"
}Get zones for a particular sensor.
| sn required | string (sn) Example: ATR_GN_P4-250120-09527 Sensor SN in path |
[- {
- "id": 1,
- "type": 10,
- "coordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "height": 0,
- "angle": 360
}
]Set the delay threshold for fall detection on a specific sensor. The threshold defines how long the system waits before confirming a fall event. A lower threshold makes detection faster but may increase the rate of false alerts.
| sn required | string (sn) Example: ATR_GN_P4-250120-09527 Sensor SN in path |
| threshold required | integer [ 0 .. 90 ] fall detection delay threshold. |
{- "threshold": 90
}{- "code": 0,
- "message": "string"
}The sensor will keep reporting detected targets' locations to the MQTT channel.
To avoid continuous location reporting, the sensor will stop reporting after 1 minute. Therefore, invoking start repeatedly will not cause the sensor to report continuously.
To stop reporting immediately, call /sensors/{sn}/actions/location/stop.
| sn required | string (sn) Example: ATR_GN_P4-250120-09527 Sensor SN in path |
{- "code": 0,
- "message": "string"
}Restart a specific sensor remotely. Use this to apply updates or recover from errors without physically accessing the device.
| sn required | string (sn) Example: ATR_GN_P4-250120-09527 Sensor SN in path |
{- "code": 0,
- "message": "string"
}Retrieve the latest available firmware version for a sensor based on its current version and model. If the sensor is already up to date, the API will return null.
| sn required | string (sn) Example: sn=ATR_GN_P4-250120-09527 Sensor sn in query string (required for some APIs) |
| version required | string (version) ^(\d+)\.(\d+)\.(\d+)$ Example: version=1.1.0 Current version of the sensor |
| model required | integer <int32> (model) Enum: 2 4 Example: model=2 Current model of the sensor |
{- "version": "1.1.0",
}Initiate the firmware upgrade process for a specific sensor. The sensor will then download the firmware from the server and install it.
| sn required | string (sn) Example: ATR_GN_P4-250120-09527 Sensor SN in path |
| firmwareId required | integer <int64> (id) >= 1 The unique identifier of the entity |
| otaType | integer <int32> (OtaType) Enum: 0 1 (optional): Upgrade type.
|
{- "firmwareId": 1,
- "otaType": 0
}{- "code": 0,
- "message": "string"
}