Merge pull request #9013 from home-assistant/klaas-2019-143

🚜 Merges/Redirect LaMetric component pages
This commit is contained in:
Fabian Affolter 2019-03-25 01:26:27 +01:00 committed by GitHub
commit 7b29fa1998
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 102 additions and 109 deletions

View File

@ -8,15 +8,19 @@ comments: false
sharing: true
footer: true
logo: lametric.png
ha_category: Hub
ha_category:
- Hub
- Notifications
ha_release: 0.49
redirect_from:
- /components/notify.lametric/
---
[LaMetric Time](http://lametric.com) is a smart clock that can be used to access applications, listen to web radio and display notifications.
There is currently support for the following device types within Home Assistant:
- [Notify](/components/notify.lametric)
- [Notify](#notifications)
The LaMetric Time can only be accessed by authorized applications. Therefore, each application that wants to access the LaMetric time needs to be registered at the LaMetric Developer web page. Sign Up and login to the developer web page. Click the Create button in the upper right corner, then select Notification App and click Create again. Enter an app name, a description and a redirect URL. Finally, click Save to create the application. For the newly created app you will obtain a client id and a client secret that is required in the following configuration.
@ -43,3 +47,99 @@ These are the steps to take:
4. You should be directed to your [Notification Apps list](https://developer.lametric.com/applications/sources), click on "Home Assistant", copy your client ID and client Secret and paste into the Home Assistant configuration block in the previous section.
5. Set up some notifications in Home Assistant by following the instructions on the [Lametric Notify](/components/notify.lametric) page.
6. Save all configuration files and restart Home Assistant.
## {% linkable_title Notifications %}
The `lametric` notification platform allows to send notification to a LaMetric device. It needs the LaMetric platform to be configured first.
To enable LaMetric notifications in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
notify:
name: NOTIFIER_NAME
platform: lametric
```
{% configuration %}
name:
description: "The optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`."
required: false
type: string
default: notify
lifetime:
description: Defines how long the message remains in LaMetric notification queue (in seconds).
required: false
type: integer
default: 10
icon:
description: An icon or animation.
required: false
type: string
cycles:
description: Defines how often the notification is displayed.
required: false
type: integer
default: 1
priority:
description: Defines the priority of the notification.
required: false
type: string
default: warning
{% endconfiguration %}
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!
## {% linkable_title Examples %}
### {% linkable_title Full configuration example %}
```yaml
# Example configuration.yaml entry
notify:
name: NOTIFIER_NAME
platform: lametric
lifetime: 20
icon: a7956
cycles: 3
priority: info
```
### {% linkable_title Changing sounds and icons %}
To add a notification sound, icon, cycles, or priority override, it has to be done via service data.
```yaml
- alias: "Send notification on arrival at school"
trigger:
platform: state
entity_id: device_tracker.son_mobile
from: 'not_home'
to: 'school'
action:
service: notify.lametric
data:
message: "Son has arrived at school!"
data:
sound: 'notification'
icon: 'i51'
cycles: 0
priority: 'critical'
```
### {% linkable_title Only notify specific device %}
If you have more than one La Metric device, you can specify which will receive the message by adding `target:` to the service data:
```yaml
action:
service: notify.lametric
data:
message: "Son has arrived at school!"
target: "Office LaMetric"
data:
sound: 'notification'
icon: 'i51'
```
If target is not specified, all LaMetric devices will be notified.

View File

@ -1,107 +0,0 @@
---
layout: page
title: "LaMetric Notify"
description: "Instructions on how to setup the LaMetric notify platform with Home Assistant."
date: 2017-04-02 13:28
sidebar: true
comments: false
sharing: true
footer: true
logo: lametric.png
ha_category: Notifications
ha_release: 0.49
---
The `lametric` notification platform allows to send notification to a LaMetric device. It needs the LaMetric platform to be configured first.
To enable LaMetric notifications in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
notify:
name: NOTIFIER_NAME
platform: lametric
```
{% configuration %}
name:
description: "The optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`."
required: false
type: string
default: notify
lifetime:
description: Defines how long the message remains in LaMetric notification queue (in seconds).
required: false
type: integer
default: 10
icon:
description: An icon or animation.
required: false
type: string
cycles:
description: Defines how often the notification is displayed.
required: false
type: integer
default: 1
priority:
description: Defines the priority of the notification.
required: false
type: string
default: warning
{% endconfiguration %}
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!
## {% linkable_title Examples %}
### {% linkable_title Full configuration example %}
```yaml
# Example configuration.yaml entry
notify:
name: NOTIFIER_NAME
platform: lametric
lifetime: 20
icon: a7956
cycles: 3
priority: info
```
### {% linkable_title Changing sounds and icons %}
To add a notification sound, icon, cycles, or priority override, it has to be done via service data.
```yaml
- alias: "Send notification on arrival at school"
trigger:
platform: state
entity_id: device_tracker.son_mobile
from: 'not_home'
to: 'school'
action:
service: notify.lametric
data:
message: "Son has arrived at school!"
data:
sound: 'notification'
icon: 'i51'
cycles: 0
priority: 'critical'
```
### {% linkable_title Only notify specific device %}
If you have more than one La Metric device, you can specify which will receive the message by adding `target:` to the service data:
```yaml
action:
service: notify.lametric
data:
message: "Son has arrived at school!"
target: "Office LaMetric"
data:
sound: 'notification'
icon: 'i51'
```
If target is not specified, all LaMetric devices will be notified.