From a6a2457eaf6fbfa09454837fb3879b68a73b453e Mon Sep 17 00:00:00 2001 From: Hector van der Aa Date: Sat, 8 Aug 2026 22:29:07 +0100 Subject: [PATCH] Added deprecation message to README --- README.md | 3 +++ src/dynalab_protocol/dlconf.py | 12 ++++++++++++ src/dynalab_protocol/models.py | 14 +++++++++++++- 3 files changed, 28 insertions(+), 1 deletion(-) create mode 100644 src/dynalab_protocol/dlconf.py diff --git a/README.md b/README.md index fb31cad..7e5091a 100644 --- a/README.md +++ b/README.md @@ -1 +1,4 @@ # dynalab-protocol + +> [!IMPORTANT] +> The DynaLab protocol has moved to the [DynaLab Core](https://git.h3cx.dev/Exergie/dynalab-core) library, it can be found under the `dynalab_core.protocols` python module and documentation about the protocol can be found there diff --git a/src/dynalab_protocol/dlconf.py b/src/dynalab_protocol/dlconf.py new file mode 100644 index 0000000..c5b5736 --- /dev/null +++ b/src/dynalab_protocol/dlconf.py @@ -0,0 +1,12 @@ +# Copyright (C) 2026 Hector van der Aa +# Copyright (C) 2026 Association Exergie +# SPDX-License-Identifier: MIT + +from pydantic import BaseModel + +from dynalab_protocol.models import SignalDescriptor + + +class DLConf(BaseModel): + name: str = "default_config" + signals: list[SignalDescriptor] = [] diff --git a/src/dynalab_protocol/models.py b/src/dynalab_protocol/models.py index ba1386c..b515871 100644 --- a/src/dynalab_protocol/models.py +++ b/src/dynalab_protocol/models.py @@ -28,6 +28,13 @@ class SignalDescriptor(BaseModel): type: Literal["number", "binary"] min_value: float | None = None max_value: float | None = None + unit: str | None = None + + +class ValueDescriptor(BaseModel): + type: Literal["value_descriptor"] = "value_descriptor" + signal_id: UUID + value: float class DynaLabHello(BaseModel): @@ -72,6 +79,11 @@ class Heartbeat(BaseModel): ProtocolMessage = Annotated[ - DynaLabHello | ConnectorHello | HandshakeAccepted | HandshakeRejected | Heartbeat, + DynaLabHello + | ConnectorHello + | HandshakeAccepted + | HandshakeRejected + | Heartbeat + | ValueDescriptor, Field(discriminator="type"), ]