Mirror/AI-on-the-edge-device-docs
1
0
Fork 0
mirror of https://github.com/jomjol/AI-on-the-edge-device-docs.git synced 2025-12-06 11:36:53 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add Makefile and Markdown linter (#73)

Browse Source 
* Add Makefile

* Update .gitignore to exclude venv

* Add requirements.txt for venv

* Add pymarkdown lint Github action

* Update .md from lint tool

* Update README with make commands

* Add linter config
This commit is contained in:
Adriaan Van Niekerk
2025-10-31 01:06:36 +02:00
committed by GitHub
parent bbe3bd79db
commit 0cd98c67e2
44 changed files with 524 additions and 279 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/MQTT-API.md
View File

@@ -1,4 +1,5 @@
# MQTT API
The device is capable to register to a MQTT broker to publish data and subscribe to specific topics.
!!! Note
@@ -51,18 +52,21 @@ Topic | Description
`watermeter/main/json` | This is a JSON formatted object containing the following values: `value`, `raw`, `pre`, `error`, `rate`, `timestamp`.
### GPIO
`MainTopic`/{GPIO topic}, e.g. `watermeter/GPIO/GPIO12`
#### GPIO/GPIO{PinNumber}
Depending on device configuration (`Settings` --> `Configuration` --> section `GPIO`)
## Subscribed topics
`MainTopic`/{subscribed topic}, e.g. `watermeter/ctrl/flow_start`
### Control
#### ctrl/flow_start
Trigger a flow start by publishing to this topic.
This will automatically reset the flow interval.
@@ -85,4 +89,5 @@ __Payload:__
* `"value":` Provide any negative number
#### GPIO/GPIO{PinNumber}
Depending on device configuration (`Settings` --> `Configuration` --> section `GPIO`)