From acd472cb3746d88c10efac8df854846c9d45ee40 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Stephan=20M=C3=BChl?= <31169771+Blueforcer@users.noreply.github.com> Date: Sat, 25 Mar 2023 01:49:40 +0100 Subject: [PATCH] Update mqtt.md --- docs/mqtt.md | 102 ++++++++++++++++++++++++++++++++------------------- 1 file changed, 65 insertions(+), 37 deletions(-) diff --git a/docs/mqtt.md b/docs/mqtt.md index 79b4272..fb71f30 100644 --- a/docs/mqtt.md +++ b/docs/mqtt.md @@ -1,49 +1,77 @@ # MQTT Commands -### Dismiss notification -Dismiss a notification wich was set to "hold"=true -##### Topic -`[PREFIX]/notify/dismiss` -##### Payload -empty payload - -### Switch apps -##### Topic -`[PREFIX]/nextapp` -`[PREFIX]/previousapp` -##### Payload -empty payload +## Dismiss Notification -### Switch to specific app -##### Topic -`[PREFIX]/switch` -##### Payload -`{"name":"time"}` +Dismiss a notification which was set to "hold"=true. + +| Topic | Payload | + +| --- | --- | + +| `[PREFIX]/notify/dismiss` | empty payload | + +## Switch Apps + +Switch to next or previous app. + +| Topic | Payload | + +| --- | --- | + +| `[PREFIX]/nextapp` | empty payload | + +| `[PREFIX]/previousapp` | empty payload | + +## Switch to Specific App + +Switch to a specific app by name. + +| Topic | Payload | + +| --- | --- | + +| `[PREFIX]/switch` | `{"name":"time"}` | + +Built-in app names are: -Build-in app names are - `time` + - `date` + - `temp` + - `hum` + - `bat` -For custompages you need to call the name you set in the topic: -If `[PREFIX]/custom/test` is your topic, -then `test` is the name. +For custom pages, use the name you set in the topic. For example, if `[PREFIX]/custom/test` is your topic, then `test` is the name. ## Change Settings -##### Topic -`[PREFIX]/settings` - -Each property is optional, you dont need to send all! - -##### JSON Properties -| Key | Type | Description | Value Range | -| ----------- | ------- | --------------------------------------------------------------------------- | ------------------------------------------ | -| `apptime` | number | Determines the duration an app is displayed in milliseconds. | Any positive integer value. Default 7000 | -| `transition`| number | The time the transition to the next app takes in milliseconds. | Any positive integer value. Default 500 | -| `textcolor` | string | A color in hexadecimal format. | Any valid 6-digit hexadecimal color value, e.g. "#FF0000" for red | -| `fps` | number | Determines the frame rate at which the matrix is updated. | Any positive integer value. Default 23 | -| `brightness`| number | Determines the brightness of the matrix. | An integer between 0 and 255 | -| `autobrightness`| boolean | Determines if automatic brightness control is active. | `true` or `false` | -| `autotransition`| boolean | Determines if automatic switching to the next app is active. | `true` or `false` | + +Change various settings related to the app display. + +| Topic | Payload | + +| --- | --- | + +| `[PREFIX]/settings` | JSON properties | + +Each property is optional; you do not need to send all. + +| Key | Type | Description | Value Range | Default | + +| --- | --- | --- | --- | --- | + +| `apptime` | number | Determines the duration an app is displayed in milliseconds. | Any positive integer value. | 7000 | + +| `transition` | number | The time the transition to the next app takes in milliseconds. | Any positive integer value. | 500 | + +| `textcolor` | string | A color in hexadecimal format. | Any valid 6-digit hexadecimal color value, e.g. "#FF0000" for red. | N/A | + +| `fps` | number | Determines the frame rate at which the matrix is updated. | Any positive integer value. | 23 | + +| `brightness` | number | Determines the brightness of the matrix. | An integer between 0 and 255. | N/A | + +| `autobrightness` | boolean | Determines if automatic brightness control is active. | `true` or `false`. | N/A | + +| `autotransition` | boolean | Determines if automatic switching to the next app is active. | `true` or `false`. | N/A |