Onyx Client

This repository contains a Python HTTP client for Hella' s ONYX.CENTER API.

---

API Versions

It is encouraged to always update Hella devices to the latest software. This will, mostly, also enforce using the newest API. In below table you can find an indication of what Hella API version is supported.

Hella API Version	Client Version
v3	>= 3.1.0
v2	>= 2.5.0 < 3.0.0

Installation

The package is published in PyPi and can be installed via:

pip install onyx-client

Configuration

The configuration defines connection properties as a dict for the application running.

Attention: make sure to read the Onyx API Access Control description to retrieve the fingerprint and access token!

Option	Description
fingerprint	The fingerprint of the ONYX.CENTER.
access_token	The permanent access token.
local_address	The local address to use (default: None).
client_session	The initialized aiohttp.ClientSession. (Default: None, create new session.)

Local Access

The local address can be used to access the ONYX.CENTER API from within the local network. If set, the client will use this address for all API requests.

Access Control Helper

The method onyx_client.authorizer.exchange_code takes the API code and an optional local API address, and performs the exchange to a fingerprint and access token. Please follow the aforementioned documentation to retrieve the code.

Usage

Initalization

You can instantiate the client using the onyx_client.client.create method like:

import aiohttp
from onyx_client.client import create
from onyx_client.authorizer import exchange_code

# by providing the fingerprint and access token only
client = create(fingerprint="fingerprint", access_token="access_token")

# by providing the fingerprint, access token and aiohttp client session
client = create(fingerprint="fingerprint", access_token="access_token", client_session=aiohttp.ClientSession())

# by providing the fingerprint, access token and local API address
client = create(fingerprint="fingerprint", access_token="access_token", local_address="localhost")

# by providing the configuration object
client_session = aiohttp.ClientSession()
# e.g. by exchanging the code first
config = exchange_code("code", client_session)
client = create(config=config, client_session=client_session) if client_session is not None else None

Events

You can register a event callback which will be triggered if the client receives a device update:

# all imports and a client exists...

def received_update(device):
    print(device)

client.set_event_callback(received_update)
client.start()

# you can stop the client listening for updates using:
client.stop()

Each device update will be pushed to your callback and will create an event loop in the background.

Streaming

You can stream device updates directly and process them through, e.g., an async for loop:

# all imports and a client exists...

async for device in client.events():
    print(device)

Examples

The following examples are available in the examples directory:

• events: uses the callback mechanism (start(), stop())
• streaming: uses the streaming mechanism (events())

---

Development

The project uses poetry and to install all dependencies and the build environment, run:

pip install poetry
poetry install

Testing

1. Install all dependencies as shown above.
2. Run pytest by:

poetry run pytest
# or
pytest

Linting and Code Style

The project uses ruff for automated code linting and fixing, also using pre-commit.

1. Install all dependencies as shown above.
2. (Optional) Install pre-commit hooks:

poetry run pre-commit install

3. Run ruff:

poetry run ruff check .
# poetry run ruff format .

Building

This package uses poetry-dynamic-versioning which infers the version number based on the Git tags. Hence, to have a proper versioning for the distribution, use Python's build system like:

pip install build
python -m build

Your distribution will be in the dist directory.

Commit Message

This project follows Conventional Commits, and your commit message must also adhere to the additional rules outlined in .conform.yaml.

---

Contributors

Thanks goes to these wonderful people (emoji key):

Daniel Mühlbachler-Pietrzykowski 🚧 💻 📖

Mathias Mitterdorfer 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

Supporting

If you enjoy the application and want to support my efforts, please feel free to buy me a coffe. :)