You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-3Lines changed: 6 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,18 +17,21 @@ This add-on runs an [Orb](https://www.orb.net) sensor in your Home Assistant env
17
17
18
18
## Configuration
19
19
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
+
21
24
22
25
## Data Storage
23
26
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
25
28
26
29
## Architecture Support
27
30
28
31
This add-on supports multiple architectures (aarch64, amd64, armv7).
29
32
30
33
## 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.
32
35
33
36
It will expose the following entities under the Orb Sensor device:
0 commit comments