Python: LaMetric Device API Client

Asynchronous Python client for LaMetric TIME and SKY devices.

About

This package allows you to control and monitor LaMetric TIME and SKY devices programmatically, directly on your local network. It is mainly created to allow third-party programs to automate the behavior of the LaMetric device.

Besides the local device API, it can:

• Talk to the LaMetric cloud, to list the devices on your account, including their local IP address and API key.
• Stream frames straight to the screen of devices that support it, see examples/stream.py. An LM 37X8 TIME on firmware 2.x does not.

Installation

pip install demetriek

Usage

"""Asynchronous Python client for LaMetric TIME devices."""

import asyncio

from demetriek import (
    Chart,
    Goal,
    GoalData,
    LaMetricDevice,
    Model,
    Notification,
    NotificationIconType,
    NotificationSound,
    Simple,
    Sound,
)


async def main():
    """Show example on controlling your LaMetric device."""

    # Create a alert notification, with 3 message frames.
    # First frame is a text, the second is a goal, last one
    # shows a chart. Additionally, the Win! notification sound
    # is played.
    notification = Notification(
        icon_type=NotificationIconType.ALERT,
        model=Model(
            frames=[
                Simple(text="Yeah", icon=18815),
                Goal(
                    icon=7956,
                    data=GoalData(
                        current=65,
                        end=100,
                        start=0,
                        unit="%",
                    ),
                ),
                Chart(data=[1, 2, 3, 4, 5, 4, 3, 2, 1]),
            ],
            sound=Sound(sound=NotificationSound.WIN),
        ),
    )

    async with LaMetricDevice(
        "192.168.1.2",
        api_key="device_api_key",
    ) as lametric:
        # Raise audio volume... so we can hear the notification
        await lametric.audio(volume=100)
        await lametric.notify(notification=notification)


if __name__ == "__main__":
    asyncio.run(main())

Cloud

The cloud client needs an OAuth2 access token for your LaMetric developer account.

"""Asynchronous Python client for LaMetric TIME devices."""

import asyncio

from demetriek import LaMetricCloud


async def main():
    """List the LaMetric devices on your account."""
    async with LaMetricCloud(token="oauth2_access_token") as cloud:
        user = await cloud.current_user()
        print(f"Hi {user.name}, you have these devices:")

        for device in await cloud.devices():
            print(f"- {device.name} at {device.ip}")


if __name__ == "__main__":
    asyncio.run(main())

API key from the device

Devices from 2022 onward can hand out their API key locally, after someone presses the button on top of the device. No LaMetric account needed. An LM 37X8 TIME does not support this. This uses the web interface of the device, which LaMetric does not document.

"""Asynchronous Python client for LaMetric TIME devices."""

import asyncio

from demetriek import LaMetricLocalAuth


async def main():
    """Get the API key of a LaMetric device with a press on its button."""
    async with LaMetricLocalAuth("192.168.1.2") as auth:
        challenge = await auth.request_challenge()
        print(f"Press the button on your LaMetric within {challenge.duration}s")

        while challenge.state == "in-progress":
            await asyncio.sleep(1)
            challenge = await auth.challenge(challenge_id=challenge.challenge_id)

        if not challenge.resolved:
            print("The button was not pressed in time")
            return

        api_key = await auth.api_key(challenge_id=challenge.challenge_id)
        print(f"The API key is {api_key}")


if __name__ == "__main__":
    asyncio.run(main())

Changelog & Releases

This repository keeps a change log using GitHub's releases functionality.

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

• MAJOR: Incompatible or major changes.
• MINOR: Backwards-compatible new features and enhancements.
• PATCH: Backwards-compatible bugfixes and package updates.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We've set up a separate document for our contribution guidelines.

Thank you for being involved! 😍

Setting up development environment

The easiest way to start, is by opening a CodeSpace here on GitHub, or by using the Dev Container feature of Visual Studio Code.

[

This Python project is fully managed using the Poetry dependency manager. But also relies on the use of NodeJS for certain checks during development.

You need at least:

• Python 3.11+
• Poetry
• NodeJS 24+ (including NPM)

To install all packages, including all development requirements:

npm install
poetry install

As this repository uses the prek framework, all changes are linted and tested with each commit. You can run all checks and tests manually, using the following command:

poetry run prek run --all-files

To run just the Python tests:

poetry run pytest

Authors & contributors

The original setup of this repository is by Franck Nijhof.

For a full list of all authors and contributors, check the contributor's page.

License

MIT License

Copyright (c) 2022-2026 Franck Nijhof

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.