7.8 KiB
title | description | ha_category | ha_iot_class | ha_release | ha_codeowners | ha_domain | ha_platforms | ha_integration_type | ha_config_flow | ha_ssdp | ha_dhcp | ha_quality_scale | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
LaMetric | Instructions on how to integrate LaMetric TIME with Home Assistant. |
|
Local Polling | 0.49 |
|
lametric |
|
device | true | true | true | platinum |
LaMetric TIME is a smart clock that can be used to access applications, listen to web radio and display notifications.
{% include integrations/config_flow.md %}
Services
The LaMetric integration provides services to interact with your LaMetric device(s). Those service can be called in, for example, automations.
Service lametric.chart
The {% my developer_call_service service="lametric.chart" title="lametric.chart
" %}
service allows you to display a little chart to your LaMetric.
{% my developer_call_service badge service="lametric.chart" %}
{% configuration "lametric.chart" %}
device_id:
description: The ID of the device to send the message to.
required: true
type: string
data:
description: The data points in the chart, as a list of numbers. For example [1, 2, 3, 2, 1]
.
required: true
type: list
cycles:
description: "Defines how long the notification will be displayed. Set to 0
to require manual dismissal."
required: false
type: integer
default: 1
priority:
description: "Defines the priority of the notification. Allowed values are info
, warning
, and critical
."
required: false
type: string
default: info
icon_type:
description: "Defines the nature of notification. Allowed values are none
, info
, and alert
."
required: false
type: string
default: none
sound:
description: "Defines the sound of the notification. Allowed are listed below."
required: false
type: string
{% endconfiguration %}
Service lametric.message
The {% my developer_call_service service="lametric.message" title="lametric.message
" %}
service allows you to send a message to your LaMetric. These
messages can be enrichted with icons and sounds.
{% my developer_call_service badge service="lametric.message" %}
{% configuration "lametric.message" %}
device_id:
description: The ID of the device to send the message to.
required: true
type: string
message:
description: The message to send to the LaMetric device.
required: true
type: string
icon:
description: "An icon or animation. List of all icons available at https://developer.lametric.com/icons."
required: false
type: string
cycles:
description: "Defines how long the notification will be displayed. Set to 0
to require manual dismissal."
required: false
type: integer
default: 1
priority:
description: "Defines the priority of the notification. Allowed values are info
, warning
, and critical
."
required: false
type: string
default: info
icon_type:
description: "Defines the nature of notification. Allowed values are none
, info
, and alert
."
required: false
type: string
default: none
sound:
description: "Defines the sound of the notification. Allowed are listed below."
required: false
type: string
{% endconfiguration %}
Notifications
You can send notifications to your LaMetric device using the Notifications integration.
Each LaMetric device added to your Home Assistant will have its own
notify.
service. The service name matches the name of your device
as shown in your LaMetric account. For example, if you have a device
called "My LaMetric", the service would become notify.my_lametric
.
The notification service call against an LaMetric device can take the following, additional, optional parameters:
{% configuration "notification" %}
icon:
description: "An icon or animation. List of all icons available at https://developer.lametric.com/icons."
required: false
type: string
cycles:
description: "Defines how long the notification will be displayed. Set to 0
to require manual dismissal."
required: false
type: integer
default: 1
priority:
description: "Defines the priority of the notification. Allowed values are info
, warning
, and critical
."
required: false
type: string
default: warning
icon_type:
description: "Defines the nature of notification. Allowed values are none
, info
, and alert
."
required: false
type: string
default: none
sound:
description: "Defines the sound of the notification. Allowed are listed below."
required: false
type: string
default: none
{% endconfiguration %}
Example
To add a notification sound, icon, cycles, or priority override,
- alias: "Send notification on arrival at school"
trigger:
platform: state
entity_id: device_tracker.tom_mobile
from: "not_home"
to: "school"
action:
service: notify.my_lametric
data:
message: "Tom has arrived at school!"
data:
sound: "notification"
icon: "51"
cycles: 0
priority: "critical"
icon_type: "info"
List of notification sounds
The following notification sounds can be used with the sound
parameter on
notify service calls:
alarm1
alarm10
alarm11
alarm12
alarm13
alarm2
alarm3
alarm4
alarm5
alarm6
alarm7
alarm8
alarm9
bicycle
car
cash
cat
dog
dog2
energy
knock-knock
letter_email
lose1
lose2
negative1
negative2
negative3
negative4
negative5
notification
notification2
notification3
notification4
open_door
positive1
positive2
positive3
positive4
positive5
positive6
statistic
thunder
water1
water2
win
win2
wind_short
wind
Manual automatic import configuration
If you prefer not to use the Home Assistant account linking service, you can set up the LaMetric application manually.
However, please note! At this point, it is easier to choose the "Enter manually" option during the integration setup; this also avoids the use of the account linking service and doesn't need all the steps below either.
If you still want to set up your own LaMetric application for importing your LaMetric devices, use the following steps:
- Log in with your LaMetric device account to developer.lametric.com.
- Click the Create button and choose Notification app.
- Fill in the form. You can put almost anything in the fields, they just need to be populated:
- App Name: Home Assistant
- Description: Home Assistant
- Redirect URI:
https://my.home-assistant.io/redirect/oauth
- Privacy Policy:
http://localhost/
- Check the "basic" and "read_devices" permission boxes
- Click Save
- You should be directed to your Notification Apps list, click on "Home Assistant", copy your client ID and Client Secret.
You may then add the credentials to Application Credentials and then setup the integration.
{% details "I have manually disabled My Home Assistant" %}
If you don't have My Home Assistant on your installation,
you can use <HOME_ASSISTANT_URL>/auth/external/callback
as the redirect URI
instead.
The <HOME_ASSISTANT_URL>
must be the same as used during the configuration/
authentication process.
Internal examples: http://192.168.0.2:8123/auth/external/callback
, http://homeassistant.local:8123/auth/external/callback
."
{% enddetails %}