mirror of
https://github.com/jackyzha0/quartz.git
synced 2026-03-25 07:25:42 -05:00
update index page
This commit is contained in:
parent
0ebf4c3794
commit
631a82c605
@ -0,0 +1,21 @@
|
||||
# MQTT Configuration
|
||||
|
||||
## Rules
|
||||
|
||||
When configuring MQTT in a camera or other device, these rules need to be respected due to assumptions made in how we process and route messages.
|
||||
|
||||
### Connection messages
|
||||
|
||||
Currently we receive connect, but not disconnect messages. AppMqtt does receive a disconnect, but it is not converted and sent in the pipeline today. These standards presume that the disconnected message can be added one day.
|
||||
|
||||
- Topics end with "/event/connection".
|
||||
- Payload has a boolean `connected` showing the connection state.
|
||||
- Payload has a `description` of the event of "Connected" or "Disconnected".
|
||||
|
||||
### Application event messages
|
||||
|
||||
For axis cameras, these events come from the ACAP applications.
|
||||
|
||||
- Payload contains `topic`, with 3 parts delimited by "/". The 2nd part is the application name. E.g., "VMD". The 3rd part is the profile identifier (aka "zone"). E.g., "Camera1ProfileANY" indicates any zone.
|
||||
- Payload contains `message` object, which contains `data`. For zone triggering, `data` contains `active`, with a string value of "1" or "0".
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
---
|
||||
title: Welcome to Quartz
|
||||
title: Welcome to VCS documentation
|
||||
---
|
||||
|
||||
This is a blank Quartz installation.
|
||||
See the [documentation](https://quartz.jzhao.xyz) for how to get started.
|
||||
To start adding documetation
|
||||
|
||||
```bash
|
||||
git clone https://github.com/Acuity-vct/vcs-documentation
|
||||
```
|
||||
|
||||
commit any documentation to `content/VCS-Documentation`
|
||||
|
||||
Loading…
Reference in New Issue
Block a user