Skip to content

Fixed Bayesian sensor docs and added a missing comma in Arlo docs #3357

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 12, 2017
Merged

Fixed Bayesian sensor docs and added a missing comma in Arlo docs #3357

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee0ba69
Fixed Bayesian sensor docs
arsaboo Sep 11, 2017
0ca6c5b
Added missing comma
arsaboo Sep 11, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions source/_components/binary_sensor.bayesian.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,9 @@ ha_release: 0.53
---


The `bayesian` binary sensor platform observes the state from multiple sensors and uses Bayes' rule to estimate the probability that an event has occurred
given the state of the observed sensors. If the estimated posterior probability is above the `probabiliy_threshold`, the value of the sensor is `on`.
Otherwise, the sensor is `off`.
The `bayesian` binary sensor platform observes the state from multiple sensors and uses Bayes' rule to estimate the probability that an event has occurred given the state of the observed sensors. If the estimated posterior probability is above the `probability_threshold`, the sensor is `on` otherwise it is `off`.

This allows for the detection of complex events that may not be readily observable, i.e., cooking, showering, in bed, the start of a morning routine, etc. It
can also be used to gain greater confidence about events that _are_ directly observable, but for which the sensors can be unreliable, i.e., presence.
This allows for the detection of complex events that may not be readily observable, e.g., cooking, showering, in bed, the start of a morning routine, etc. It can also be used to gain greater confidence about events that _are_ directly observable, but for which the sensors can be unreliable, e.g., presence.

To enable the Bayesian sensor, add the following lines to your `configuration.yaml`:

Expand All @@ -39,7 +36,7 @@ binary_sensor:
Configuration variables:

- **prior** (*Required*): The prior probability of the event. At any point in time (ignoring all external influences) how likely is this event to occur?
- **observations** array (*Required*): The observations which should influence the likelihood that the given event has occurred.
- **observations** array (*Required*): The observations which should influence the likelihood that the given event has occurred.
- **entity_id** (*Required*): Name of the entity to monitor.
- **prob_given_true** (*Required*): The probability of the observation occurring, given the event is `true`.
- **prob_given_false** (*Optional*): The probability of the observation occurring, given the event is `false` can be set as well. If `prob_given_false` is not set, it will default to `1 - prob_given_true`.
Expand Down Expand Up @@ -77,4 +74,3 @@ binary_sensor:
platform: 'state'
to_state: 'below_horizon'
```

2 changes: 1 addition & 1 deletion source/_components/camera.arlo.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ camera:

Configuration variables:

- **ffmpeg_arguments**: (*Optional*): Extra options to pass to ffmpeg, e.g. image quality or video filter options.
- **ffmpeg_arguments**: (*Optional*): Extra options to pass to ffmpeg, e.g., image quality or video filter options.

**Note:** To be able to playback the last capture, it is required to install the `ffmpeg` component. Make sure to follow the steps mentioned at [FFMPEG](https://home-assistant.io/components/ffmpeg/) documentation.