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 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
|
"""
Implementation of KNX 2 byte Float-values.
They correspond to the the following KDN DPT 9 class.
"""
from __future__ import annotations
from xknx.exceptions import ConversionError
from .dpt import DPTNumeric
from .payload import DPTArray, DPTBinary
class DPT2ByteFloat(DPTNumeric):
"""
Abstraction for KNX 2 Octet Floating Point Numbers.
DPT 9.***
"""
dpt_main_number = 9
dpt_sub_number: int | None = None
value_type = "2byte_float"
payload_length = 2
value_min = -671088.64
value_max = 670760.96
resolution = 0.01
@classmethod
def from_knx(cls, payload: DPTArray | DPTBinary) -> float:
"""Parse/deserialize from KNX/IP raw data."""
raw = cls.validate_payload(payload)
data = (raw[0] * 256) + raw[1]
exponent = (data >> 11) & 0x0F
significand = data & 0x7FF
sign = data >> 15
if sign == 1:
significand = significand - 2048
value = float(significand << exponent) / 100
if not cls._test_boundaries(value):
raise ConversionError(f"Could not parse {cls.dpt_name()}", value=value)
return value
@classmethod
def to_knx(cls, value: float) -> DPTArray:
"""Serialize to KNX/IP raw data."""
try:
value = float(value)
if not cls._test_boundaries(value):
raise ValueError("Value out of range")
knx_value = value * 100
if round(knx_value) == 0:
# ETS converts values near 0 like this
# -0.0051 -> 0x87FF
# -0.005 -> 0x8000 ... we don't want this since its equivalent to -20.48
# 0.005 -> 0x0000
# 0.0051 -> 0x0001
return DPTArray((0x00, 0x00))
exponent = 0
while not -2048 <= knx_value <= 2047:
exponent += 1
knx_value /= 2
mantisse = round(knx_value) & 0x7FF
msb = exponent << 3 | mantisse >> 8
if knx_value < 0:
msb |= 0x80
return DPTArray((msb, mantisse & 0xFF))
except ValueError as err:
raise ConversionError(
f"Could not serialize {cls.dpt_name()}", value=value
) from err
@classmethod
def _test_boundaries(cls, value: float) -> bool:
"""Test if value is within defined range for this object."""
return cls.value_min <= value <= cls.value_max
class DPTTemperature(DPT2ByteFloat):
"""DPT 9.001 DPT_Value_Temp."""
dpt_main_number = 9
dpt_sub_number = 1
value_type = "temperature"
unit = "°C"
ha_device_class = "temperature"
value_min = -273
value_max = 670760
class DPTTemperatureDifference2Byte(DPT2ByteFloat):
"""DPT 9.002 DPT_Value_Tempd."""
dpt_main_number = 9
dpt_sub_number = 2
value_type = "temperature_difference_2byte"
unit = "K"
ha_device_class = "temperature"
value_min = -670760
value_max = 670760
class DPTTemperatureA(DPT2ByteFloat):
"""DPT 9.003 DPT_Value_Tempa."""
dpt_main_number = 9
dpt_sub_number = 3
value_type = "temperature_a"
unit = "K/h"
value_min = -670760
value_max = 670760
class DPTLux(DPT2ByteFloat):
"""DPT 9.004 DPT_Value_Lux."""
dpt_main_number = 9
dpt_sub_number = 4
value_type = "illuminance"
unit = "lx"
ha_device_class = "illuminance"
value_min = 0
value_max = 670760
class DPTWsp(DPT2ByteFloat):
"""DPT 9.005 DPT_Value_Ws Speed (m/s)."""
dpt_main_number = 9
dpt_sub_number = 5
value_type = "wind_speed_ms"
unit = "m/s"
ha_device_class = "wind_speed"
value_min = 0
value_max = 670760
class DPTPressure2Byte(DPT2ByteFloat):
"""DPT 9.006 DPT_Value_Pres (Pa)."""
dpt_main_number = 9
dpt_sub_number = 6
value_type = "pressure_2byte"
unit = "Pa"
ha_device_class = "pressure"
value_min = 0
value_max = 670760
class DPTHumidity(DPT2ByteFloat):
"""DPT 9.007 DPT_Value_Humidity."""
dpt_main_number = 9
dpt_sub_number = 7
value_type = "humidity"
unit = "%"
ha_device_class = "humidity"
value_min = 0
value_max = 670760
class DPTPartsPerMillion(DPT2ByteFloat):
"""DPT 9.008 DPT_Value_parts/million."""
dpt_main_number = 9
dpt_sub_number = 8
value_type = "ppm"
unit = "ppm"
class DPTAirFlow(DPT2ByteFloat):
"""DPT 9.009 DPT_Value_AirFlow."""
dpt_main_number = 9
dpt_sub_number = 9
value_type = "air_flow"
unit = "m³/h"
class DPTTime1(DPT2ByteFloat):
"""DPT 9.010 DPT_Value_Time1 (s)."""
dpt_main_number = 9
dpt_sub_number = 10
value_type = "time_1"
unit = "s"
value_min = -670760
value_max = 670760
class DPTTime2(DPT2ByteFloat):
"""DPT 9.011 DPT_Value_Time2 (ms)."""
dpt_main_number = 9
dpt_sub_number = 11
value_type = "time_2"
unit = "ms"
value_min = -670760
value_max = 670760
class DPTVoltage(DPT2ByteFloat):
"""DPT 9.020 DPT_Value_Voltage."""
dpt_main_number = 9
dpt_sub_number = 20
value_type = "voltage"
unit = "mV"
ha_device_class = "voltage"
class DPTCurrent(DPT2ByteFloat):
"""DPT 9.021 DPT_Value_Curr (mA)."""
dpt_main_number = 9
dpt_sub_number = 21
value_type = "curr"
unit = "mA"
ha_device_class = "current"
class DPTPowerDensity(DPT2ByteFloat):
"""DPT 9.022 DPT_PowerDensity (W/m²)."""
dpt_main_number = 9
dpt_sub_number = 22
value_type = "power_density"
unit = "W/m²"
class DPTKelvinPerPercent(DPT2ByteFloat):
"""DPT 9.023 DPT_KelvinPerPercent (K/%)."""
dpt_main_number = 9
dpt_sub_number = 23
value_type = "kelvin_per_percent"
unit = "K/%"
class DPTPower2Byte(DPT2ByteFloat):
"""DPT 9.024 DPT_Power (kW)."""
dpt_main_number = 9
dpt_sub_number = 24
value_type = "power_2byte"
unit = "kW"
ha_device_class = "power"
class DPTVolumeFlow(DPT2ByteFloat):
"""DPT 9.025 DPT_Value_Volume_Flow (L/h)."""
dpt_main_number = 9
dpt_sub_number = 25
value_type = "volume_flow"
unit = "L/h"
class DPTRainAmount(DPT2ByteFloat):
"""DPT 9.026 DPT_Rain_Amount (L/m²)."""
dpt_main_number = 9
dpt_sub_number = 26
value_type = "rain_amount"
unit = "L/m²"
value_min = -671088.64
value_max = 670760.96
class DPTTemperatureF(DPT2ByteFloat):
"""DPT 9.027 DPT_Value_Temp_F."""
dpt_main_number = 9
dpt_sub_number = 27
value_type = "temperature_f"
unit = "°F"
ha_device_class = "temperature"
value_min = -459.6
value_max = 670760
class DPTWspKmh(DPT2ByteFloat):
"""DPT 9.028 DPT_Value_Wsp_kmh Speed (km/h)."""
dpt_main_number = 9
dpt_sub_number = 28
value_type = "wind_speed_kmh"
unit = "km/h"
ha_device_class = "wind_speed"
value_min = 0
value_max = 670760
class DPTAbsoluteHumidity(DPT2ByteFloat):
"""DPT 9.029 DPT_Value_Absolute_Humidity."""
dpt_main_number = 9
dpt_sub_number = 29
value_type = "absolute_humidity"
unit = "g/m³"
value_min = 0
class DPTConcentrationUGM3(DPT2ByteFloat):
"""DPT 9.030 DPT_Value_Concentration_μgm3."""
dpt_main_number = 9
dpt_sub_number = 30
value_type = "concentration_ugm3"
unit = "μg/m³"
value_min = 0
class DPTEnthalpy(DPT2ByteFloat):
"""DPT 9.? 2-byte float value (with unit)."""
dpt_main_number = 9
# this is here for backwards compatibility
dpt_sub_number = 60000
value_type = "enthalpy"
unit = "H"
|