Skip to content

Commit 65029f3

Browse files
committed
Update configuration variable style
1 parent 36a2863 commit 65029f3

File tree

1 file changed

+32
-15
lines changed

1 file changed

+32
-15
lines changed

source/_components/notify.lametric.markdown

Lines changed: 32 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,38 +12,55 @@ ha_category: Notifications
1212
ha_release: 0.49
1313
---
1414

15-
This component allows to send notification to a LaMetric device. It needs the LaMetric platform to be configured first.
15+
The `lametric` notification platform allows to send notification to a LaMetric device. It needs the LaMetric platform to be configured first.
16+
17+
To enable LaMetric notifications in your installation, add the following to your `configuration.yaml` file:
1618

1719
```yaml
1820
notify:
19-
name: lametric1
21+
name: NOTIFIER_NAME
2022
platform: lametric
2123
```
2224
23-
- **name** (*Optional*): The name of the LaMetric device. Usually it is "My Lametric".
24-
- **lifetime** (*Optional*): Defines how long the message remains in LaMetric notification queue (in seconds). Defaults to 10.
25-
- **icon** (*Optional*): An icon or animation. Check out the list of all icons here: https://developer.lametric.com/icons
26-
Note that icons always begin with "i" while animations begin with "a". This is part of the name, you can't just use the number!
27-
- **cycles** (*Optional*): Defines how often the notification is displayed. Defaults to 1.
25+
{% configuration %}
26+
name:
27+
description: "The optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`."
28+
required: false
29+
type: string
30+
default: notify
31+
lifetime:
32+
description: Defines how long the message remains in LaMetric notification queue (in seconds).
33+
required: false
34+
type: int
35+
default: 10
36+
icon:
37+
description: An icon or animation.
38+
required: false
39+
type: string
40+
cycles:
41+
description: Defines how often the notification is displayed.
42+
required: false
43+
type: int
44+
default: 1
45+
{% endconfiguration %}
2846

29-
Extended functionality:
47+
Check out the list of all icons at [https://developer.lametric.com/icons](https://developer.lametric.com/icons). Note that icons always begin with "i" while animations begin with "a". This is part of the name, you can't just use the number!
3048

31-
To add a notification sound or an icon override, it has to be done via service data.
49+
## {% linkable_title Example %}
3250

33-
Example:
51+
To add a notification sound or an icon override, it has to be done via service data.
3452

35-
```
36-
...
37-
- alias: 'Send notification on arrival at school'
53+
```yaml
54+
- alias: "Send notification on arrival at school"
3855
trigger:
3956
platform: state
4057
entity_id: device_tracker.son_mobile
4158
from: 'not_home'
4259
to: 'school'
4360
action:
44-
service: notify.lametric1
61+
service: notify.lametric
4562
data:
46-
message: 'Son has arrived at school!'
63+
message: "Son has arrived at school!"
4764
data:
4865
sound: 'notification'
4966
icon: 'i51'

0 commit comments

Comments
 (0)