Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
wernerhp committed Jul 25, 2020
1 parent 0aa1109 commit fdf4970
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 55 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@
## Introduction
Wasp in a Box is an AppDaemon app for detecting occupancy using door and motions sensors.

If the box (door) is open, we assume there is no wasp (person) in the box.
If I see a wasp (motion), then there is a wasp in the box.
If I close the box, then there is a wasp in the box.
If the box has not been opened, we assume the wasp is still in the box.

If the box (door) is open, we assume there is no wasp (person) in the box.
If I see a wasp (motion), then there is a wasp in the box.
If I close the box, then there is a wasp in the box.
If the box has not been opened, we assume the wasp is still in the box.
The state of the generated binary sensor can be used for triggering automations.

### Example:
If someone enters the bathroom and motion is detected, then turn on the light.
If the door is closed and motion is detected, then keep the light on as long as the door is closed.
If the door is open and no motion is detected, then turn off the light.
### Example
If someone enters the bathroom and motion is detected, then turn on the light.
If the door is closed and motion is detected, then keep the light on as long as the door is closed.
If the door is open and no motion is detected, then turn off the light.

## Installation
Download the `wasp` directory from inside the `apps` directory to your local `apps` directory, then configure the `wasp` module in `apps.yaml`.
Expand All @@ -40,4 +40,4 @@ key | optional | type | default | description
`class` | False | string | | The name of the Class.
`name` | True | string | Defaults to the app name, e.g. Bathroom Wasp | The friendly_name of the sensor.
`door_sensors` | False | list | | A list of door sensor entity_ids.
`motion_sensors` | False | list | | A list of motion sensor entity_ids.
`motion_sensors` | False | list | | A list of motion sensor entity_ids.
5 changes: 3 additions & 2 deletions hacs.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{
"name": "Wasp in a Box"
}
"name": "Wasp in a Box",
"render_readme": "true"
}
43 changes: 0 additions & 43 deletions info.md

This file was deleted.

0 comments on commit fdf4970

Please sign in to comment.