From 631a82c605a09113fffe884c2a4c4e8aa31e4c58 Mon Sep 17 00:00:00 2001 From: ckrivacic01 Date: Thu, 6 Jun 2024 15:11:42 -0400 Subject: [PATCH] update index page --- .../server-install/MQTT-Configuration.md | 21 +++++++++++++++++++ content/index.md | 11 +++++++--- 2 files changed, 29 insertions(+), 3 deletions(-) create mode 100644 content/VCS-Documentation/server-install/MQTT-Configuration.md diff --git a/content/VCS-Documentation/server-install/MQTT-Configuration.md b/content/VCS-Documentation/server-install/MQTT-Configuration.md new file mode 100644 index 000000000..013e25475 --- /dev/null +++ b/content/VCS-Documentation/server-install/MQTT-Configuration.md @@ -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". + diff --git a/content/index.md b/content/index.md index 2bdfd8337..60f933039 100644 --- a/content/index.md +++ b/content/index.md @@ -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`