Commit 3e619e1
[Docs]: Add MQTT documentation (#1939)
* Add comprehensive MQTT integration documentation
- Add new docs-site/docs/mqtt-integration.md with complete MQTT guide
- Configuration options and examples
- Message format and status values
- Home Assistant and Node-RED integration examples
- Testing and troubleshooting sections
- Security considerations
- Architecture details with diagrams
- Advanced use cases (office signs, Slack sync, Grafana)
- Update docs-site/docs/index.md to list MQTT as a main feature
- Update docs-site/docs/configuration.md with MQTT configuration section
- Add mqtt-integration to docs-site/sidebars.ts navigation
This addresses the lack of user-facing documentation for the MQTT
feature introduced in PR #1926, making it discoverable and providing
comprehensive guidance for home automation integration.
* Update MQTT documentation with corrections and improvements
- Add "disabled by default" notice at the top
- Update broker URL formats section to note WebSocket URLs are untested
- Replace specific Home Assistant/Node-RED examples with call to action
for users to share their working automations on GitHub Discussions
- Fix debug logging to use ELECTRON_ENABLE_LOGGING=true format and
link to troubleshooting guide instead of incorrect config options
- Revise security considerations with stronger warning about sharing
status externally and reference to LICENSE.md disclaimer
- Remove "Advanced Configuration" section
- Remove "Use Case Examples" section (office signs, Slack sync, Grafana)
These changes make the documentation more accurate, conservative about
untested features, and encourage community contributions of working
automation configurations.
* Replace GitHub Discussions references with Issues and Matrix chat
* Add MQTT documentation release note to version 2.6.3 in appdata.xml
* Update docs-site/docs/mqtt-integration.md
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
* Update docs-site/docs/mqtt-integration.md
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
---------
Co-authored-by: Claude <[email protected]>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>1 parent 7b07e70 commit 3e619e1
File tree
5 files changed
+378
-10
lines changed- docs-site
- docs
5 files changed
+378
-10
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
108 | 108 | | |
109 | 109 | | |
110 | 110 | | |
| 111 | + | |
111 | 112 | | |
112 | 113 | | |
113 | 114 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
| 17 | + | |
17 | 18 | | |
18 | 19 | | |
19 | 20 | | |
| |||
123 | 124 | | |
124 | 125 | | |
125 | 126 | | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
126 | 159 | | |
127 | 160 | | |
128 | 161 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
11 | | - | |
12 | | - | |
13 | | - | |
14 | | - | |
15 | | - | |
16 | | - | |
17 | | - | |
18 | | - | |
19 | | - | |
20 | | - | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
21 | 22 | | |
22 | 23 | | |
23 | 24 | | |
| |||
36 | 37 | | |
37 | 38 | | |
38 | 39 | | |
| 40 | + | |
39 | 41 | | |
40 | 42 | | |
41 | 43 | | |
| |||
0 commit comments