Skip to content

Commit 5056efb

Browse files
committed
Update docs with security notes, publishing info, and app store link
1 parent e32474c commit 5056efb

2 files changed

Lines changed: 17 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,19 @@ Driver settings are defined in `driver.compose.json` and synced from the device:
9494
- **Speed** (light) — number 1-40, synced from STATE `Speed` field, sent via `Speed N`
9595
- **Device info** (mac, ip, model, firmware) — read-only labels populated during pairing
9696

97+
### Security
98+
99+
- **Topic sanitization**`TopicBuilder.sanitizeTopicSegment()` strips `/`, `+`, `#`, and null bytes from all topic segments to prevent MQTT injection
100+
- **Settings validation**`PowerOnState` validated against `[0-4]`, `Speed` clamped to `1-40` before sending Tasmota commands
101+
- **Guarded writes**`setCapabilityValueIfChanged()` in base class compares current value before writing to avoid unnecessary I/O
102+
- **Immutable discovery cache**`getDiscoveredDevices()` returns a copy to prevent external mutation
103+
104+
### Publishing
105+
106+
- **App Store**: Published via GitHub Actions workflow (`publish.yml`) using `HOMEY_PAT` secret
107+
- **Versioning**: Use the `version.yml` workflow to bump version and create GitHub releases
108+
- **CI**: `validate.yml` runs build, lint, test, and `homey app validate` on push to main and PRs
109+
97110
### Localization
98111

99112
English only (`en`). No other locale files.

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
# Tasmota for Homey
22

3+
[![Validate & Test](https://github.com/rianbk/com.tasmota/actions/workflows/validate.yml/badge.svg)](https://github.com/rianbk/com.tasmota/actions/workflows/validate.yml)
4+
35
Control your Tasmota-flashed devices directly from Homey using MQTT. Devices are automatically discovered via Tasmota's native MQTT discovery protocol — no manual configuration needed.
46

7+
**[Install from the Homey App Store](https://homey.app/en-au/app/com.tasmota/Tasmota/)**
8+
59
## Supported Device Types
610

711
| Type | Homey Class | Capabilities |

0 commit comments

Comments
 (0)