You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
142 lines
1.3 KiB
Markdown
142 lines
1.3 KiB
Markdown
# API
|
|
|
|
* Motion sensor
|
|
|
|
Topic: `motion`
|
|
|
|
Data example:
|
|
|
|
```json
|
|
{
|
|
"deviceId": 0,
|
|
"value": true
|
|
}
|
|
```
|
|
|
|
* Light sensor
|
|
|
|
Topic: `light`
|
|
|
|
Data example:
|
|
|
|
```json
|
|
{
|
|
"deviceId": 0,
|
|
"value": 1024
|
|
}
|
|
```
|
|
|
|
* Temperature sensor
|
|
|
|
Topic: `temperature`
|
|
|
|
Data example:
|
|
|
|
```json
|
|
{
|
|
"deviceId": 0,
|
|
"value": 20.4
|
|
}
|
|
```
|
|
|
|
* Sound sensor
|
|
|
|
Topic: `sound`
|
|
|
|
Data example:
|
|
|
|
```json
|
|
{
|
|
"deviceId": 0,
|
|
"value": 3072
|
|
}
|
|
```
|
|
|
|
* Door lock/unlock
|
|
|
|
Topic: `door/lock`
|
|
|
|
Data example:
|
|
|
|
```json
|
|
{
|
|
"deviceId": 0,
|
|
"lock": true
|
|
}
|
|
```
|
|
|
|
* Door state changed
|
|
|
|
Topic: `door/status`
|
|
|
|
Data example:
|
|
|
|
```json
|
|
{
|
|
"deviceId": 0,
|
|
"open": true
|
|
}
|
|
```
|
|
|
|
* Alarm state
|
|
|
|
Topic: `alarm/state`
|
|
|
|
Statuses:
|
|
|
|
- `Armed`
|
|
- `Disarmed`
|
|
- `Triggered`
|
|
- `Arming`
|
|
- `Disarming`
|
|
|
|
Data example:
|
|
|
|
```json
|
|
{
|
|
"status": "Disarmed",
|
|
"changed": true
|
|
}
|
|
```
|
|
|
|
* Card read
|
|
|
|
Topic: `card/read`
|
|
|
|
Data example:
|
|
|
|
```json
|
|
{
|
|
"deviceId": 0,
|
|
"cardUID": "6XjCwg=="
|
|
}
|
|
```
|
|
* Password entered
|
|
|
|
Topic `display/passwordEntered`
|
|
|
|
Data example:
|
|
|
|
*The password has a minimum length of 4, and a max length of 12.*
|
|
|
|
```json
|
|
{
|
|
"deviceId": 0,
|
|
"password": [1, 2, 3, 4]
|
|
}
|
|
```
|
|
|
|
* Password response
|
|
|
|
Topic `display/passwordResponse`
|
|
|
|
Data example:
|
|
|
|
```json
|
|
{
|
|
"deviceId": 0,
|
|
"password": [1, 2, 3, 4],
|
|
"correct": true
|
|
}
|
|
```
|