This repository contains a Python HTTP client for Hella' s ONYX.CENTER API.
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 |
The package is published in PyPi and can be installed via:
pip install onyx-clientThe 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. |
| client_session | The initialized aiohttp.ClientSession. (Default: None, create new session.) |
The method onyx_client.authorizer.exchange_code takes the API code and performs the exchange to a fingerprint
and access token. Please follow the aforementioned documentation to retrieve the code.
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 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 NoneYou 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.
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)The following examples are available in the examples directory:
events: uses the callback mechanism (start(),stop())streaming: uses the streaming mechanism (events())
The project uses poetry and to install all dependencies and the build environment, run:
pip install poetry
poetry install- Install all dependencies as shown above.
- Run
pytestby:
poetry run pytest
# or
pytestThe project uses ruff for automated code linting and fixing, also using pre-commit.
- Install all dependencies as shown above.
- (Optional) Install pre-commit hooks:
poetry run pre-commit install- Run ruff:
poetry run ruff check .
# poetry run ruff format .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 buildYour distribution will be in the dist directory.
This project follows Conventional Commits, and your commit message must also
adhere to the additional rules outlined in .conform.yaml.
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!
If you enjoy the application and want to support my efforts, please feel free to buy me a coffe. :)