KUKSA Python Client and SDK is a part of the open source project Eclipse KUKSA. More about Eclipse KUKSA can be found in the repository.
KUKSA Python SDK provides both a command-line interface (CLI) and a standalone library to interact with the KUKSA Databroker.
The redesigned kuksa_client.v2 API targets the kuksa.val.v2 protocol and
offers both synchronous and asynchronous clients, plus a provider API. The
older APIs (kuksa_client.grpc, kuksa_client.grpc.aio,
kuksa_client.KuksaClientThread) are frozen and deprecated but remain
available for backwards compatibility.
The fastest way to start using KUKSA Python SDK is to install a pre-built version from pypi.org:
pip install kuksa-clientIf you want to install from sources instead see the KUKSA Python SDK Build documentation.
After you have installed the kuksa-client package via pip you can run the test client CLI directly by executing:
kuksa-clientWith default CLI arguments, the client will try to connect to a local Databroker supporting the kuksa.val.v2 protocol without using TLS. This is equivalent to executing
kuksa-client --server grpc://127.0.0.1:55555One-shot commands are also available:
kuksa-client get Vehicle.Speed
kuksa-client set Vehicle.Speed=42
kuksa-client subscribe Vehicle.SpeedMore details on how to use the CLI is available in the KUKSA Python SDK CLI documentation
The KUKSA Python SDK CLI is available as a prebuilt docker container.
The KUKSA Python SDK provides a synchronous and an asynchronous client for the
kuksa.val.v2 protocol, plus a provider API. For more details see the KUKSA
Python SDK Library documentation.
from kuksa_client.v2 import KuksaClient
with KuksaClient("127.0.0.1", 55555) as client:
speed = client.get("Vehicle.Speed")
print(speed.value)
client.set({"Vehicle.Speed": 42})The KUKSA project welcomes contributions.
See the KUKSA Python SDK Contribition document for formal requirements.
For information on tools useful for KUKSA Python SDK development environment and help on troubleshooting frequent problems please visit the KUKSA Python SDK development and troubleshooting documentation.
