You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/_components/abode.markdown
+48-15Lines changed: 48 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -13,9 +13,12 @@ ha_release: 0.52
13
13
ha_iot_class: "Cloud Push"
14
14
---
15
15
16
-
The `abode` component will allow users to integrate their Abode Home Security systems into Home Assistant and use its alarm system and sensors to automate their homes.
16
+
The `abode` component will allow users to integrate their Abode Home Security
17
+
systems into Home Assistant and use its alarm system and sensors to automate
18
+
their homes.
17
19
18
-
Please visit the [Abode website](https://goabode.com/) for further information about Abode Security.
20
+
Please visit the [Abode website](https://goabode.com/) for further information
21
+
about Abode Security.
19
22
20
23
There is currently support for the following device types within Home Assistant:
21
24
@@ -30,34 +33,61 @@ There is currently support for the following device types within Home Assistant:
30
33
31
34
## {% linkable_title Configuration %}
32
35
33
-
To use Abode devices in your installation, add the following `abode` section to your `configuration.yaml` file:
36
+
To use Abode devices in your installation,
37
+
add the following `abode` section to your `configuration.yaml` file:
34
38
35
39
```yaml
36
40
# Example configuration.yaml entry
37
41
abode:
38
42
username: abode_username
39
43
password: abode_password
40
44
name: Abode Alarm System
41
-
polling: False
45
+
polling: false
42
46
exclude:
43
47
- 'ZW:0000000034'
44
48
- 'RF:00000011'
45
49
lights:
46
50
- 'ZW:0000000022'
47
51
```
48
52
49
-
Configuration variables:
50
-
51
-
- **username** (*Required*): Username for your Abode account.
52
-
- **password** (*Required*): Password for your Abode account.
53
-
- **name** (*Optional*): The name for your alarm controller.
54
-
- **polling** (*Optional*): Enable polling if cloud push updating is less reliable. Will update the devices once every 30 seconds. Defaults to False.
55
-
- **exclude** (*Optional*): A list of devices to exclude from Home Assistant by their Abode `device_id` or `automation_id`, found within the component attributes.
56
-
- **lights** (*Optional*): A list of switch devices that Home Assistant should treat as lights by the switches Abode `device_id`, found within the component attributes.
53
+
{% configuration %}
54
+
username:
55
+
description: Username for your Abode account.
56
+
required: true
57
+
type: string
58
+
password:
59
+
description: Password for your Abode account.
60
+
required: true
61
+
type: string
62
+
name:
63
+
description: The name for your alarm controller.
64
+
required: false
65
+
type: string
66
+
polling:
67
+
description: >
68
+
Enable polling if cloud push updating is less reliable.
69
+
Will update the devices once every 30 seconds.
70
+
required: false
71
+
type: boolean
72
+
default: false
73
+
exclude:
74
+
description: >
75
+
A list of devices to exclude from Home Assistant by their Abode `device_id`
76
+
or `automation_id`, found within the component attributes.
77
+
required: false
78
+
type: list
79
+
lights:
80
+
description: >
81
+
A list of switch devices that Home Assistant should treat as lights by the
82
+
switches Abode `device_id`, found within the component attributes.
83
+
required: false
84
+
type: list
85
+
{% endconfiguration %}
57
86
58
87
## {% linkable_title Events %}
59
88
60
-
There are a number of events that can be triggered from Abode. They are grouped into the below events:
89
+
There are a number of events that can be triggered from Abode.
90
+
They are grouped into the below events:
61
91
62
92
- **abode_alarm**: Fired when an alarm event is triggered from Abode. This includes Smoke, CO, Panic, and Burglar alarms.
63
93
- **abode_alarm_end**: Fired when an alarm end event is triggered from Abode.
@@ -80,13 +110,16 @@ Field | Description
80
110
`date`| The date of the event in the format `MM/DD/YYYY`.
81
111
`time`| The time of the event in the format `HH:MM AM`.
82
112
83
-
There is a unique list of known event_codes that can be found [here](https://github.com/MisterWil/abodepy/files/1262019/timeline_events.txt).
113
+
There is a unique list of known event_codes that can be found
Change settings on your Abode system. For a full list of settings and valid values, consult the [AbodePy settings section](https://github.com/MisterWil/abodepy/blob/master/README.rst#settings).
120
+
Change settings on your Abode system.
121
+
For a full list of settings and valid values, consult the
Copy file name to clipboardExpand all lines: source/_components/alert.markdown
+89-21Lines changed: 89 additions & 21 deletions
Original file line number
Diff line number
Diff line change
@@ -12,17 +12,25 @@ ha_category: Automation
12
12
ha_release: 0.38
13
13
---
14
14
15
-
The `alert` component is designed to notify you when problematic issues arise. For example, if the garage door is left open, the `alert` component can be used remind you of this by sending you repeating notifications at customizable intervals. This is also used for low battery sensors, water leak sensors, or any condition that may need your attention.
15
+
The `alert` component is designed to notify you when problematic issues arise.
16
+
For example, if the garage door is left open, the `alert` component can be used
17
+
remind you of this by sending you repeating notifications at customizable
18
+
intervals. This is also used for low battery sensors,
19
+
water leak sensors, or any condition that may need your attention.
16
20
17
-
Alerts will add an entity to the front end only when they are firing. This entity allows you to silence an alert until it is resolved.
21
+
Alerts will add an entity to the front end only when they are firing.
22
+
This entity allows you to silence an alert until it is resolved.
18
23
19
24
<pclass='note warning'>
20
-
When using the `alert` component, it is important that the time zone used for Home Assistant and the underlying operating system match. Failing to do so may result in multiple alerts being sent at the same time (such as when Home Assistant is set to the `America/Detroit` time zone but the operating system uses `UTC`).
25
+
When using the `alert` component, it is important that the time zone used for Home Assistant and the underlying operating system match.
26
+
Failing to do so may result in multiple alerts being sent at the same time (such as when Home Assistant is set to the `America/Detroit` time zone but the operating system uses `UTC`).
21
27
</P>
22
28
23
29
### {% linkable_title Basic Example %}
24
30
25
-
The `alert` component makes use of any of the `notifications` components. To setup the `alert` component, first, you must setup a `notification` component. Then, add the following to your configuration file:
31
+
The `alert` component makes use of any of the `notifications` components. To
32
+
setup the `alert` component, first, you must setup a `notification` component.
33
+
Then, add the following to your configuration file:
26
34
27
35
```yaml
28
36
# Example configuration.yaml entry
@@ -39,20 +47,65 @@ alert:
39
47
- ryans_phone
40
48
- kristens_phone
41
49
```
42
-
Configuration variables:
43
50
44
-
- **name** (*Required*): The friendly name of the alert.
45
-
- **done_message** (*Optional*): A message sent after an alert transitions from `on` to `off`. Is only sent if an alert notification was sent for transitioning from `off` to `on`.
46
-
- **entity_id** (*Required*): The ID of the entity to watch.
47
-
- **state** (*Optional*): The problem condition for the entity. Defaults to `on`.
48
-
- **repeat** (*Required*): Number of minutes before the notification should be repeated. Can be either a number or a list of numbers.
49
-
- **can_acknowledge** (*Optional*): Allows the alert to be unacknowledgeable. Defaults to `true`.
50
-
- **skip_first** (*Optional*): Controls whether the notification should be sent immediately or after the first delay. Defaults to `false`.
51
-
- **notifiers** (*Required*): List of `notification` components to use for alerts.
52
-
53
-
In this example, the garage door status (`input_boolean.garage_door`) is watched and this alert will be triggered when its status is equal to `on`. This indicates that the door has been opened. Because the `skip_first` option was set to `True`, the first notification will not be delivered immediately. However, every 30 minutes, a notification will be delivered until either `input_boolean.garage_door` no longer has a state of `on` or until the alert is acknowledged using the Home Assistant frontend.
54
-
55
-
For notifiers that require other parameters (such as `twilio_sms` which requires you specify a `target` parameter when sending the notification), you can use the `group` notification to wrap them for an alert. Simply create a `group` notification type with a single notification member (such as `twilio_sms`) specifying the required parameters other than `message` provided by the `alert` component:
51
+
{% configuration %}
52
+
name:
53
+
description: The friendly name of the alert.
54
+
required: true
55
+
type: string
56
+
done_message:
57
+
description: >
58
+
A message sent after an alert transitions from `on` to `off`. Is only sent
59
+
if an alert notification was sent for transitioning from `off` to `on`.
60
+
required: false
61
+
type: string
62
+
entity_id:
63
+
description: The ID of the entity to watch.
64
+
required: true
65
+
type: string
66
+
state:
67
+
description: The problem condition for the entity.
68
+
required: false
69
+
type: string
70
+
default: on
71
+
repeat:
72
+
description: >
73
+
Number of minutes before the notification should be repeated.
74
+
Can be either a number or a list of numbers.
75
+
required: true
76
+
type: [int, list]
77
+
can_acknowledge:
78
+
description: Allows the alert to be unacknowledgeable.
79
+
required: false
80
+
type: boolean
81
+
default: true
82
+
skip_first:
83
+
description: >
84
+
Controls whether the notification should be
85
+
sent immediately or after the first delay.
86
+
required: false
87
+
type: boolean
88
+
default: false
89
+
notifiers:
90
+
description: "List of `notification` components to use for alerts."
91
+
required: true
92
+
type: list
93
+
{% endconfiguration %}
94
+
95
+
In this example, the garage door status (`input_boolean.garage_door`) is watched
96
+
and this alert will be triggered when its status is equal to `on`.
97
+
This indicates that the door has been opened. Because the `skip_first` option
98
+
was set to `True`, the first notification will not be delivered immediately.
99
+
However, every 30 minutes, a notification will be delivered until either
100
+
`input_boolean.garage_door`no longer has a state of `on` or until the alert is
101
+
acknowledged using the Home Assistant frontend.
102
+
103
+
For notifiers that require other parameters (such as `twilio_sms` which requires
104
+
you specify a `target` parameter when sending the notification), you can use the
105
+
`group`notification to wrap them for an alert.
106
+
Simply create a `group` notification type with a single notification member
107
+
(such as `twilio_sms`) specifying the required parameters other than `message`
108
+
provided by the `alert` component:
56
109
57
110
```yaml
58
111
- platform: group
@@ -77,7 +130,13 @@ freshwater_temp_alert:
77
130
78
131
### {% linkable_title Complex Alert Criteria %}
79
132
80
-
By design, the `alert` component only handles very simple criteria for firing. That is, it only checks if a single entity's state is equal to a value. At some point, it may be desirable to have an alert with a more complex criteria. Possibly, when a battery percentage falls below a threshold. Maybe you want to disable the alert on certain days. Maybe the alert firing should depend on more than one input. For all of these situations, it is best to use the alert in conjunction with a `Template Binary Sensor`. The following example does that.
133
+
By design, the `alert` component only handles very simple criteria for firing.
134
+
That is, it only checks if a single entity's state is equal to a value. At some
135
+
point, it may be desirable to have an alert with a more complex criteria.
136
+
Possibly, when a battery percentage falls below a threshold. Maybe you want to
137
+
disable the alert on certain days. Maybe the alert firing should depend on more
138
+
than one input. For all of these situations, it is best to use the alert in
139
+
conjunction with a `Template Binary Sensor`. The following example does that.
81
140
82
141
```yaml
83
142
binary_sensor:
@@ -97,11 +156,16 @@ alert:
97
156
- kristens_phone
98
157
```
99
158
100
-
This example will begin firing as soon as the entity `sensor.motion`'s `battery` attribute falls below 15. It will continue to fire until the battery attribute raises above 15 or the alert is acknowledged on the frontend.
159
+
This example will begin firing as soon as the entity `sensor.motion`'s `battery`
160
+
attribute falls below 15. It will continue to fire until the battery attribute
161
+
raises above 15 or the alert is acknowledged on the frontend.
101
162
102
163
### {% linkable_title Dynamic Notification Delay Times %}
103
164
104
-
It may be desirable to have the delays between alert notifications dynamically change as the alert continues to fire. This can be done by setting the `repeat` configuration key to a list of numbers rather than a single number. Altering the first example would look like the following.
165
+
It may be desirable to have the delays between alert notifications dynamically
166
+
change as the alert continues to fire. This can be done by setting the `repeat`
167
+
configuration key to a list of numbers rather than a single number.
168
+
Altering the first example would look like the following.
105
169
106
170
```yaml
107
171
# Example configuration.yaml entry
@@ -121,4 +185,8 @@ alert:
121
185
- kristens_phone
122
186
```
123
187
124
-
Now the first message will be sent after a 15 minute delay, the second will be sent 30 minutes after that, and a 60 minute delay will fall between every following notification. For example, if the garage door opens at 2:00, a notification will be sent at 2:15, 2:45, 3:45, 4:45, etc., continuing every 60 minutes.
188
+
Now the first message will be sent after a 15 minute delay, the second will be
189
+
sent 30 minutes after that, and a 60 minute delay will fall between every
190
+
following notification.
191
+
For example, if the garage door opens at 2:00, a notification will be
192
+
sent at 2:15, 2:45, 3:45, 4:45, etc., continuing every 60 minutes.
0 commit comments