Services

show_message

Sends a text notification with an optional icon and sound to a LaMetric device. Internally this builds a Notification object with a single simple frame and posts it to the Device API.

Fields

YAML example

service: lametric_hass_local.show_message
data:
  device_id: "your_device_id"
  message: "Deploy finished ✓"
  icon: "i7956"
  sound: "positive1"
  cycles: 1
  icon_type: info
  priority: info

Notification model reference

Both services construct a Notification object and send it to POST /api/v2/device/notifications. The following table maps service fields to API fields. Full reference: LaMetric Notifications API.

{
  "priority": "<info|warning|critical>",
  "icon_type": "<none|info|alert>",
  "model": {
    "cycles": <integer>,
    "frames": [
      // show_message — simple frame:
      {
        "icon": "<icon-id or data URI>",
        "text": "<message>"
      },
      // show_chart — chart frame:
      {
        "chartData": [1, 2, 3, 4, 5]
      }
    ],
    "sound": {
      "category": "<notifications|alarms>",
      "id": "<sound-id>",
      "repeat": 1
    }
  }
}

Priority levels

Frame types

The Device API supports three frame types within a single notification. This integration uses one frame type per service:

Sound IDs

The sound field accepts one of the following built-in sound identifiers. Sounds are played once by default; the Device API repeat field is always set to 1 when using these services. Full reference: LaMetric Notifications API.

Notifications category

Alarms category

Icon format

The icon field in show_message accepts one of two formats:

Icon ID

A string of the form <prefix><number> where:

• i prefix — static icon (PNG). Example: i1234
• a prefix — animated icon (GIF). Example: a5678

Browse available icons at developer.lametric.com/icons. You can also search via the Cloud Icons API.

Base64 data URI (custom icon)

A PNG or GIF image encoded as a Base64 data URI:

# PNG (8x8 pixels recommended)
"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAgAAAAICAYAAADED76L..."

# GIF (animated)
"data:image/gif;base64,R0lGODlhCAAIAP..."

Legacy notify platform

The integration also registers a legacy notify platform service under the name notify.lametric_<device-name>. This is provided for backwards compatibility with automations that used the old platform-based notify service.

service: notify.lametric_my_device
data:
  message: "Hello from notify"
  data:
    icon: "i1234"
    sound: "cat"
    cycles: 1
    priority: info

show_chart

Sends a spike chart notification built from a list of numeric values. Internally this uses the chart frame type of the Notification model — the values are mapped to chartData and displayed as a bar graph that scrolls over the LED matrix.

Fields

YAML example

service: lametric_hass_local.show_chart
data:
  device_id: "your_device_id"
  data: [1, 3, 5, 7, 9, 7, 5, 3, 1]
  sound: "statistic"
  cycles: 2

set_screensaver

Enables or disables the screensaver and configures its activation mode. This service targets the brightness_mode select entity of the device (platform select, entity key brightness_mode). It maps directly to the screensaver object in the Display API's PUT /api/v2/device/display body.

Fields

mode_params object (time_based only)

Device API body

PUT /api/v2/device/display

{
  "screensaver": {
    "enabled": true,
    "mode": "time_based",
    "mode_params": {
      "enabled": true,
      "start_time": "19:00:00",   // UTC
      "end_time": "07:00:00"      // UTC
    }
  }
}

Example: enable when dark

service: lametric_hass_local.set_screensaver
target:
  entity_id: select.lametric_brightness_mode
data:
  enabled: true
  mode: when_dark

Example: enable on a schedule (10 PM – 7 AM)

service: lametric_hass_local.set_screensaver
target:
  entity_id: select.lametric_brightness_mode
data:
  enabled: true
  mode: time_based
  mode_params:
    enabled: true
    start_time: "2000-01-01T22:00:00"
    end_time: "2000-01-01T07:00:00"

Example: disable screensaver

service: lametric_hass_local.set_screensaver
target:
  entity_id: select.lametric_brightness_mode
data:
  enabled: false

Full API reference: Display API.

activate_action

Triggers a widget-specific action on a LaMetric app. This service targets a scene entity (one per installed app widget). It combines two API calls:

1. If visible = true (the default): activate the widget via PUT …/activate.
2. Send the action payload via POST …/actions.

Fields

Device API body

POST /api/v2/device/apps/:package/widgets/:widget_id/actions

{
  "id": "<action_id>",
  "params": { ...action_parameters },
  "activate": true       // set to visible field value
}

Example: trigger a countdown timer start

service: lametric_hass_local.activate_action
target:
  entity_id: scene.lametric_countdown
data:
  action_id: "start"
  visible: true

Example: navigate a news feed widget

service: lametric_hass_local.activate_action
target:
  entity_id: scene.lametric_news
data:
  action_id: "next"
  visible: true

Full API reference: Apps API.