Skip to content
Appdaemon App to Illuminate a door entrance when the door has opened.
Python
Branch: master
Clone or download
Latest commit 79c9b27 Jan 13, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
apps/illuminate_door
LICENSE Update LICENSE Jan 12, 2020
README.md Update README.md Jan 12, 2020
hacs.json

README.md

Illuminate Door

hacs_badge
Buy Me A Coffee

IlluminateDoor app for AppDaemon.

Illuminate a door for a specified duration when the door is opened.

Installation

Download the illuminate_door directory from inside the apps directory here to your local apps directory, then add the configuration to enable the hacs module.

Use Case Examples

Holiday lights

It's the holiday season. Your front door lights are set to holiday colors. The front door opens and the front door lights change to bright white to illuminate the steps for guests. After the door is closed, 2 minutes later the lights return to holiday colors.

Example App configuration

Basic

front_door_illumination:
  module: illuminate_door
  class: IlluminateDoor
  sensor: sensor.front_door
  turn_on:
  - switch.foyer

Advanced

front_door_illumination:
  module: illuminate_door
  class: IlluminateDoor
  sensor: sensor.front_door
  turn_on:
  - switch.foyer
  - entity: light.foyer
    data:
      brightness: 255
      rgb_color: [ 255, 255, 255 ]
  duration: 300
  sundown: false
  log_level: INFO

App Configuration

key optional type default description
module False string illuminate_door The module name of the app.
class False string IlluminateDoor The name of the Class.
sensor False string The entity_id of the door sensor.
turn_on False list A list of entity_id's or entity objects.
duration True int 120 Turn on light/switch duration in seconds.
sundown True bool true Uses sundown check. If true, lights will only turn on after sundown.
log_level True 'INFO' | 'DEBUG' 'DEBUG' Switches log level. This for lazy debuggers. If you don't want to restart appdaemon to view debug logs, change this to 'INFO' and all debug logs for this app will show up in 'INFO'.

Entity Object Configuration

key optional type default description
entity False string The entity_id of the switch or light.
data True map Turn on service data. Whenever the door turns on a light or switch, this data will be passed to the service data. Warning: Use only valid combinations. Light combinations are not validated and can cause errors in Home Assistant.

Notes

  • The lights/switches will turn on when the door is opened.
  • The door illumination duration starts after the door is closed.
  • Subsequent open and closes will reset the duration.
  • You can cancel any turn_on duration by turning_off the light/switch.
  • Each light has a separate duration.
  • If a light is already on and service data was provided, the app will store the state prior to the door opening and return to it after the duration.
You can’t perform that action at this time.