Skip to content

Commit 3813e39

Browse files
authored
Update README.md
1 parent 2a14c29 commit 3813e39

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,21 @@ This add-on runs an [Orb](https://www.orb.net) sensor in your Home Assistant env
1717

1818
## Configuration
1919

20-
This add-on doesn't require any configuration. It automatically connects to your Orb devices on the network.
20+
The add-on allows configuration of the MQTT push functionality.
21+
* **Push Scores to MQTT** (default false): Enabling this will have the orb sensor push its status to the Home Assistant MQTT broker
22+
* **MQTT Frequency** (default 5 seconds): This determines how often the orb sensor will push its status, if the functionality is enabled
23+
2124

2225
## Data Storage
2326

24-
The add-on stores its data in `/root/.config/orb` which is configured as persistent storage.
27+
The add-on stores its data in `/data/.config/orb` which is the default persistent storage provided by Home Assistant
2528

2629
## Architecture Support
2730

2831
This add-on supports multiple architectures (aarch64, amd64, armv7).
2932

3033
## MQTT Integration
31-
If you have the [MQTT addon](https://www.home-assistant.io/integrations/mqtt/) installed, the Orb addon will automatically detect the endpoin. Configure the Orb Sensor device and start pushing the current orb status.
34+
If you have the [MQTT addon](https://www.home-assistant.io/integrations/mqtt/) installed, the Orb addon will automatically detect the endpoint. Configure the Orb sensor device and start pushing the current orb status.
3235

3336
It will expose the following entities under the Orb Sensor device:
3437

0 commit comments

Comments
 (0)