jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-24 01:37:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update tutorial.markdown (#4841)

Browse Source
This commit is contained in:
Andrew Cockburn 2018-03-05 23:32:30 -08:00 committed by Fabian Affolter
parent ee836c55fc
commit f737974563
1 changed files with 27 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
source/_docs/ecosystem/appdaemon/tutorial.markdown
View File

@ -43,22 +43,38 @@ The best way to show what AppDaemon does is through a few simple examples.
### {% linkable_title Sunrise/Sunset Lighting %} ### {% linkable_title Sunrise/Sunset Lighting %}
Lets start with a simple App to turn a light on every night at sunset and off every morning at sunrise. Every App when first started will have its `initialize()` function called which gives it a chance to register a callback for AppDaemons's scheduler for a specific time. In this case we are using `run_at_sunrise()` and `run_at_sunset()` to register 2 separate callbacks. The argument `0` is the number of seconds offset from sunrise or sunset and can be negative or positive. For complex intervals it can be convenient to use Python's `datetime.timedelta` class for calculations. When sunrise or sunset occurs, the appropriate callback function, `sunrise_cb()` or `sunset_cb()` is called which then makes a call to Home Assistant to turn the porch light on or off by activating a scene. The variables `args["on_scene"]` and `args["off_scene"]` are passed through from the configuration of this particular App, and the same code could be reused to activate completely different scenes in a different version of the App. Lets start with a simple App to turn a light on every night fifteen
minutes (900 seconds) before sunset and off every morning at sunrise.
Every App when first started will have its ``initialize()`` function
called which gives it a chance to register a callback for AppDaemons's
scheduler for a specific time. In this case we are using
`run_at_sunrise()` and `run_at_sunset()` to register 2 separate
callbacks. The named argument `offset` is the number of seconds offset
from sunrise or sunset and can be negative or positive (it defaults to
zero). For complex intervals it can be convenient to use Python's
`datetime.timedelta` class for calculations. In the example below,
when sunrise or just before sunset occurs, the appropriate callback
function, `sunrise_cb()` or `before_sunset_cb()` is called which
then makes a call to Home Assistant to turn the porch light on or off by
activating a scene. The variables `args["on_scene"]` and
`args["off_scene"]` are passed through from the configuration of this
particular App, and the same code could be reused to activate completely
different scenes in a different version of the App.
```python ```python
import homeassistant.appapi as appapi import appdaemon.plugins.hass.hassapi as hass
class OutsideLights(appapi.AppDaemon): class OutsideLights(hass.Hass):
def initialize(self): def initialize(self):
self.run_at_sunrise(self.sunrise_cb, 0) self.run_at_sunrise(self.sunrise_cb)
self.run_at_sunset(self.sunset_cb, 0) self.run_at_sunset(self.before_sunset_cb, offset=-900)
def sunrise_cb(self, kwargs): def sunrise_cb(self, kwargs):
self.turn_on(self.args["off_scene"]) self.turn_on(self.args["off_scene"])
def sunset_cb(self, kwargs): def before_sunset_cb(self, kwargs):
self.turn_on(self.args["on_scene"]) self.turn_on(self.args["on_scene"])
``` ```