first commit

meshtastic_broadcaster/DOCS.md

@@ -0,0 +1,29 @@
+# Meshtastic Sensor Broadcaster
+
+Periodically reads selected Home Assistant sensors and broadcasts them as a
+single short text message to a Meshtastic channel.
+
+## Options
+
+| Option | Description |
+|--------|-------------|
+| `connection` | `tcp` (node on the network) or `serial` (node on USB). |
+| `host` | Node IP/hostname (TCP mode). |
+| `serial_port` | Device path, e.g. `/dev/ttyUSB0` (serial mode). |
+| `channel_index` | Meshtastic channel index. `0` = primary. |
+| `interval` | Seconds between broadcasts. |
+| `prefix` | Optional text/emoji prepended to each message. |
+| `sensors` | List of `{label, entity_id, unit}` to include. |
+
+Example message: `🏠 T:21.4°C H:48% P:1013hPa`
+
+## Airtime
+
+Keep messages short and the interval reasonable (>= a few minutes) to stay within
+LoRa duty-cycle limits and avoid congesting the mesh. Unavailable sensors are
+skipped automatically.
+
+## Serial nodes
+
+Set `connection: serial` and `serial_port` to your device. The add-on requests
+`uart`/`usb` access; check the device path under Settings -> System -> Hardware.