From fdf497030c3a10952ca679c9a0f0e725f4d1e5be Mon Sep 17 00:00:00 2001 From: Werner Pieterson Date: Sat, 25 Jul 2020 15:01:02 +0200 Subject: [PATCH] Update readme --- README.md | 20 ++++++++++---------- hacs.json | 5 +++-- info.md | 43 ------------------------------------------- 3 files changed, 13 insertions(+), 55 deletions(-) delete mode 100644 info.md diff --git a/README.md b/README.md index 4d5c71c..80a2ddc 100644 --- a/README.md +++ b/README.md @@ -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`. @@ -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. \ No newline at end of file +`motion_sensors` | False | list | | A list of motion sensor entity_ids. diff --git a/hacs.json b/hacs.json index 794c395..22d7ed2 100644 --- a/hacs.json +++ b/hacs.json @@ -1,3 +1,4 @@ { - "name": "Wasp in a Box" -} \ No newline at end of file + "name": "Wasp in a Box", + "render_readme": "true" +} diff --git a/info.md b/info.md deleted file mode 100644 index a9522ab..0000000 --- a/info.md +++ /dev/null @@ -1,43 +0,0 @@ -[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg)](https://github.com/custom-components/hacs) - -Buy Me A Coffee - -# Wasp in a Box - -## 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. - -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. - -## Installation -Download the `wasp` directory from inside the `apps` directory to your local `apps` directory, then configure the `wasp` module in `apps.yaml`. - -## App configuration -```yaml -bathroom_wasp: - module: wasp - class: Wasp - name: Bathroom Occupancy - door_sensors: - - binary_sensor.bathroom_door_sensor - motion_sensors: - - binary_sensor.bathroom_motion_sensor -``` - -key | optional | type | default | description --- | -- | -- | -- | -- -`module` | False | string | | The module name of the app. -`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.