This repository was archived by the owner on Feb 18, 2025. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 17
/
Copy pathisUserHomeDeterminer.py
205 lines (189 loc) · 8.5 KB
/
isUserHomeDeterminer.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
import appdaemon.plugins.hass.hassapi as hass
import datetime
from requests.exceptions import HTTPError
#
# App to toggle an input boolean when a person enters or leaves home.
# This is determined based on a combination of a GPS device tracker and the door sensor.
#
# - If the door sensor opens and the device_tracker changed to "home" in the last self.delay minutes
# this means someone got home
# - If the door sensor opens and the device_tracker changes to "not_home" after that
# this means someone left home
#
# Args:
#
# app_switch: on/off switch for this app. example: input_boolean.turn_fan_on_when_hot
# input_boolean: input_boolean which shows if someone is home e.g. input_boolean.isHome
# device_tracker: device tracker or person of the user to track e.g. device_tracker.simon
# door_sensor: Door sensor which indicated the front door opened e.g. binary_sensor.door_window_sensor_158d000126a57b
#
# Release Notes
#
# Version 1.5:
# Wait to leave home until door is opened again
#
# Version 1.4.3:
# check for listen_state_callback == None before triggering again
#
# Version 1.4.2:
# cancel listen callback only when its not None
#
# Version 1.4.1:
# fix for 503, fix for listen callback not being cancelled correctly
#
# Version 1.4:
# message now directly in own yaml instead of message module
#
# Version 1.3:
# Added app_switch
#
# Version 1.2:
# Change checking after a delay to a event based system
#
# Version 1.1:
# Set when initializing (also when HA restarts)
#
# Version 1.0:
# Initial Version
class IsUserHomeDeterminer(hass.Hass):
def initialize(self):
self.listen_state_handle_list = []
self.timer_handle_list = []
self.delay = 600
self.app_switch = self.args["app_switch"]
self.input_boolean = self.args["input_boolean"]
self.device_tracker = self.args["device_tracker"]
self.door_sensor = self.args["door_sensor"]
device_tracker_state = self.get_state(self.device_tracker, attribute="all")
if self.get_state(self.app_switch) == "on":
if device_tracker_state["state"] == "home":
self.log("User is home")
self.timer_handle_list.append(
self.run_in(
self.turn_on_callback, 0, turn_on_entity=self.input_boolean
)
)
else:
self.log("User is not home")
self.timer_handle_list.append(
self.run_in(
self.turn_off_callback, 0, turn_off_entity=self.input_boolean
)
)
self.listen_state_handle_list.append(
self.listen_state(self.state_change, self.door_sensor)
)
self.listen_state_handle = None
def state_change(self, entity, attribute, old, new, kwargs):
if self.get_state(self.app_switch) == "on":
if new != "" and new != old:
self.log("{} changed from {} to {}".format(entity, old, new))
if new == "on" and old == "off":
self.cancel_listen_state_callback(None)
device_tracker_state = self.get_state(
self.device_tracker, attribute="all"
)
self.log("device_tracker_state: {}".format(device_tracker_state),)
last_changed = device_tracker_state["last_changed"]
self.log("last_changed: {}".format(last_changed))
# User got home: Device tracker changed to home before door sensor triggered
if device_tracker_state["state"] == "home" and (
(
datetime.datetime.now(datetime.timezone.utc)
- self.convert_utc(last_changed)
)
< datetime.timedelta(seconds=self.delay)
):
self.log("User got home")
self.turn_on(self.input_boolean)
# User got home: Device tracker is still not home.
# Wait if it changes to home in the next self.delay seconds
elif device_tracker_state["state"] != "home":
self.log("Wait for device tracker to change to 'home'")
self.listen_state_handle = self.listen_state(
self.check_if_user_got_home, self.device_tracker
)
self.listen_state_handle_list.append(self.listen_state_handle)
self.timer_handle_list.append(
self.run_in(self.cancel_listen_state_callback, self.delay)
)
# User left home: Device tracker is still home.
# Wait if it changes to not_home
elif device_tracker_state["state"] == "home":
self.log("Wait for device tracker to change to 'not_home'")
self.listen_state_handle = self.listen_state(
self.check_if_user_left_home, self.device_tracker
)
self.listen_state_handle_list.append(self.listen_state_handle)
def cancel_listen_state_callback(self, kwargs):
if self.listen_state_handle is not None:
self.log(
"Timeout while waiting for user to get/leave home. Cancel listen_state"
)
if self.listen_state_handle in self.listen_state_handle_list:
self.listen_state_handle_list.remove(self.listen_state_handle)
self.cancel_listen_state(self.listen_state_handle)
self.listen_state_handle = None
def check_if_user_left_home(self, entity, attribute, old, new, kwargs):
if new != "home":
self.log("User left home")
if self.listen_state_handle in self.listen_state_handle_list:
self.listen_state_handle_list.remove(self.listen_state_handle)
if self.listen_state_handle != None:
self.cancel_listen_state(self.listen_state_handle)
self.listen_state_handle = None
self.timer_handle_list.append(
self.run_in(
self.turn_off_callback, 1, turn_off_entity=self.input_boolean
)
)
def check_if_user_got_home(self, entity, attribute, old, new, kwargs):
if new == "home":
self.log("User got home")
if self.listen_state_handle in self.listen_state_handle_list:
self.listen_state_handle_list.remove(self.listen_state_handle)
if self.listen_state_handle is not None:
self.cancel_listen_state(self.listen_state_handle)
self.listen_state_handle = None
self.timer_handle_list.append(
self.run_in(
self.turn_on_callback, 1, turn_on_entity=self.input_boolean
)
)
def turn_on_callback(self, kwargs):
"""This is needed because the turn_on command can result in a HTTP 503 when homeassistant is restarting"""
try:
self.turn_on(kwargs["turn_on_entity"])
except HTTPError as exception:
self.log(
"Error trying to turn on entity. Will try again in 1s. Error: {}".format(
exception
),
level="WARNING",
)
self.timer_handle_list.append(
self.run_in(
self.turn_on_callback, 1, turn_on_entity=kwargs["turn_on_entity"]
)
)
def turn_off_callback(self, kwargs):
"""This is needed because the turn_off command can result in a HTTP 503 when homeassistant is restarting"""
try:
self.turn_off(kwargs["turn_off_entity"])
except HTTPError as exception:
self.log(
"Error trying to turn off entity. Will try again in 1s. Error: {}".format(
exception
),
level="WARNING",
)
self.timer_handle_list.append(
self.run_in(
self.turn_off_callback, 1, turn_off_entity=kwargs["turn_off_entity"]
)
)
def terminate(self):
for listen_state_handle in self.listen_state_handle_list:
self.cancel_listen_state(listen_state_handle)
for timer_handle in self.timer_handle_list:
self.cancel_timer(timer_handle)