1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
"""Implementation of 3.17 Datapoint Types String."""
from __future__ import annotations
from xknx.exceptions import ConversionError
from .dpt import DPTBase
from .payload import DPTArray, DPTBinary
class DPTString(DPTBase):
"""
Abstraction for KNX 14 Octet ASCII string.
DPT 16.000
"""
payload_type = DPTArray
payload_length = 14
dpt_main_number = 16
dpt_sub_number = 0
value_type = "string"
unit = None
_encoding = "ascii"
@classmethod
def from_knx(cls, payload: DPTArray | DPTBinary) -> str:
"""Parse/deserialize from KNX/IP raw data."""
raw = cls.validate_payload(payload)
return bytes(byte for byte in raw if byte != 0x00).decode(
cls._encoding, errors="replace"
)
@classmethod
def to_knx(cls, value: str) -> DPTArray:
"""Serialize to KNX/IP raw data."""
try:
knx_value = str(value)
if not cls._test_boundaries(knx_value):
raise ValueError("Value out of range")
except ValueError as err:
raise ConversionError(
f"Could not serialize {cls.dpt_name()}", value=value
) from err
# replace invalid characters with question marks
raw_bytes = knx_value.encode(cls._encoding, errors="replace")
padding = bytes(cls.payload_length - len(raw_bytes))
return DPTArray(raw_bytes + padding)
@classmethod
def _test_boundaries(cls, value: str) -> bool:
"""Test if value is within defined range for this object."""
return len(value) <= cls.payload_length
class DPTLatin1(DPTString):
"""
Abstraction for KNX 14 Octet Latin-1 (ISO 8859-1) string.
DPT 16.001
"""
dpt_main_number = 16
dpt_sub_number = 1
value_type = "latin_1"
_encoding = "latin_1"
|
