File: dpt_11.py

package info (click to toggle)
python-xknx 3.10.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 4,044 kB
  • sloc: python: 40,087; javascript: 8,556; makefile: 32; sh: 12
file content (113 lines) | stat: -rw-r--r-- 3,257 bytes parent folder | download | duplicates (2)
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
"""Implementation of the KNX date data point."""

from __future__ import annotations

from collections.abc import Mapping
from dataclasses import dataclass
import datetime
from typing import Any

from xknx.exceptions import ConversionError

from .dpt import DPTComplex, DPTComplexData
from .payload import DPTArray, DPTBinary


@dataclass(slots=True)
class KNXDate(DPTComplexData):
    """Class for KNX Date."""

    year: int
    month: int
    day: int

    @classmethod
    def from_dict(cls, data: Mapping[str, Any]) -> KNXDate:
        """Init from a dictionary."""
        try:
            year = int(data["year"])
            month = int(data["month"])
            day = int(data["day"])
        except (KeyError, TypeError, ValueError) as err:
            raise ValueError(f"Invalid value for KNXDate: {err}") from err
        return cls(year=year, month=month, day=day)

    def as_dict(self) -> dict[str, int]:
        """Return object as dictionary."""
        return {
            "year": self.year,
            "month": self.month,
            "day": self.day,
        }

    def as_date(self) -> datetime.date:
        """Return datetime object."""
        return datetime.date(self.year, self.month, self.day)

    @classmethod
    def from_date(cls, date: datetime.date) -> KNXDate:
        """Return KNXDate object from a datetime.date object."""
        return cls(date.year, date.month, date.day)


class DPTDate(DPTComplex[KNXDate]):
    """Abstraction for KNX 3 octet date (DPT 11.001)."""

    data_type = KNXDate
    payload_type = DPTArray
    payload_length = 3
    dpt_main_number = 11
    dpt_sub_number = 1
    value_type = "date"

    @classmethod
    def from_knx(cls, payload: DPTArray | DPTBinary) -> KNXDate:
        """Parse/deserialize from KNX/IP raw data."""
        raw = cls.validate_payload(payload)

        day = raw[0] & 0x1F
        month = raw[1] & 0x0F
        year = raw[2] & 0x7F
        if not DPTDate._test_range(day, month, year):
            raise ConversionError("Could not parse DPTDate", raw=raw)

        if year >= 90:
            year += 1900
        else:
            year += 2000

        return KNXDate(year, month, day)

    @classmethod
    def _to_knx(cls, value: KNXDate) -> DPTArray:
        """Serialize to KNX/IP raw data."""

        def _knx_year(year: int) -> int:
            if 2000 <= year < 2090:
                return year - 2000
            if 1990 <= year < 2000:
                return year - 1900
            raise ConversionError(
                f"Could not serialize {cls.dpt_name()}. Year out of range 1990..2089",
                year=year,
            )

        knx_year = _knx_year(value.year)

        if not DPTDate._test_range(value.day, value.month, knx_year):
            raise ConversionError(
                f"Could not serialize {cls.dpt_name()}. Value out of range", value=value
            )

        return DPTArray(
            (
                value.day,
                value.month,
                knx_year,
            )
        )

    @staticmethod
    def _test_range(day: int, month: int, knx_year: int) -> bool:
        """Test if the values are in the correct range."""
        return 1 <= day <= 31 and 1 <= month <= 12 and 0 <= knx_year <= 99