hat.drivers.iec60870.encodings.iec104

12class AsduTypeError(Exception):
13    pass

24class TimeSize(enum.Enum):
25    TWO = 2
26    THREE = 3
27    FOUR = 4
28    SEVEN = 7

31class Time(typing.NamedTuple):
32    size: TimeSize
33    milliseconds: int
34    """milliseconds in range [0, 59999]"""
35    invalid: bool | None
36    """available for size THREE, FOUR, SEVEN"""
37    minutes: int | None
38    """available for size THREE, FOUR, SEVEN (minutes in range [0, 59])"""
39    summer_time: bool | None
40    """available for size FOUR, SEVEN"""
41    hours: int | None
42    """available for size FOUR, SEVEN (hours in range [0, 23])"""
43    day_of_week: int | None
44    """available for size SEVEN (day_of_week in range [1, 7])"""
45    day_of_month: int | None
46    """available for size SEVEN (day_of_month in range [1, 31])"""
47    months: int | None
48    """available for size SEVEN (months in range [1, 12])"""
49    years: int | None
50    """available for size SEVEN (years in range [0, 99])"""

66def time_from_datetime(dt: datetime.datetime,
67                       invalid: bool = False
68                       ) -> Time:
69    """Create Time from datetime.datetime"""
70    # TODO document edge cases (local time, os implementation, ...)
71    #  rounding microseconds to the nearest millisecond
72    dt_rounded = (
73        dt.replace(microsecond=0) +
74        datetime.timedelta(milliseconds=round(dt.microsecond / 1000)))
75    local_time = time.localtime(dt_rounded.timestamp())
76
77    return Time(
78        size=TimeSize.SEVEN,
79        milliseconds=(local_time.tm_sec * 1000 +
80                      dt_rounded.microsecond // 1000),
81        invalid=invalid,
82        minutes=local_time.tm_min,
83        summer_time=bool(local_time.tm_isdst),
84        hours=local_time.tm_hour,
85        day_of_week=local_time.tm_wday + 1,
86        day_of_month=local_time.tm_mday,
87        months=local_time.tm_mon,
88        years=local_time.tm_year % 100)

 91def time_to_datetime(t: Time
 92                     ) -> datetime.datetime:
 93    """Convert Time to datetime.datetime"""
 94    # TODO document edge cases (local time, os implementation, ...)
 95    # TODO maybe allow diferent time size (use now for time)
 96    if t.size != TimeSize.SEVEN:
 97        raise ValueError('unsupported time size')
 98
 99    local_dt = datetime.datetime(
100        year=2000 + t.years if t.years < 70 else 1900 + t.years,
101        month=t.months,
102        day=t.day_of_month,
103        hour=t.hours,
104        minute=t.minutes,
105        second=int(t.milliseconds / 1000),
106        microsecond=(t.milliseconds % 1000) * 1000,
107        fold=not t.summer_time)
108
109    return local_dt.astimezone(tz=datetime.timezone.utc)

24class AsduType(enum.Enum):
25    M_SP_NA = iec101.AsduType.M_SP_NA.value
26    M_DP_NA = iec101.AsduType.M_DP_NA.value
27    M_ST_NA = iec101.AsduType.M_ST_NA.value
28    M_BO_NA = iec101.AsduType.M_BO_NA.value
29    M_ME_NA = iec101.AsduType.M_ME_NA.value
30    M_ME_NB = iec101.AsduType.M_ME_NB.value
31    M_ME_NC = iec101.AsduType.M_ME_NC.value
32    M_IT_NA = iec101.AsduType.M_IT_NA.value
33    M_PS_NA = iec101.AsduType.M_PS_NA.value
34    M_ME_ND = iec101.AsduType.M_ME_ND.value
35    M_SP_TB = iec101.AsduType.M_SP_TB.value
36    M_DP_TB = iec101.AsduType.M_DP_TB.value
37    M_ST_TB = iec101.AsduType.M_ST_TB.value
38    M_BO_TB = iec101.AsduType.M_BO_TB.value
39    M_ME_TD = iec101.AsduType.M_ME_TD.value
40    M_ME_TE = iec101.AsduType.M_ME_TE.value
41    M_ME_TF = iec101.AsduType.M_ME_TF.value
42    M_IT_TB = iec101.AsduType.M_IT_TB.value
43    M_EP_TD = iec101.AsduType.M_EP_TD.value
44    M_EP_TE = iec101.AsduType.M_EP_TE.value
45    M_EP_TF = iec101.AsduType.M_EP_TF.value
46    C_SC_NA = iec101.AsduType.C_SC_NA.value
47    C_DC_NA = iec101.AsduType.C_DC_NA.value
48    C_RC_NA = iec101.AsduType.C_RC_NA.value
49    C_SE_NA = iec101.AsduType.C_SE_NA.value
50    C_SE_NB = iec101.AsduType.C_SE_NB.value
51    C_SE_NC = iec101.AsduType.C_SE_NC.value
52    C_BO_NA = iec101.AsduType.C_BO_NA.value
53    C_SC_TA = 58
54    C_DC_TA = 59
55    C_RC_TA = 60
56    C_SE_TA = 61
57    C_SE_TB = 62
58    C_SE_TC = 63
59    C_BO_TA = 64
60    M_EI_NA = iec101.AsduType.M_EI_NA.value
61    C_IC_NA = iec101.AsduType.C_IC_NA.value
62    C_CI_NA = iec101.AsduType.C_CI_NA.value
63    C_RD_NA = iec101.AsduType.C_RD_NA.value
64    C_CS_NA = iec101.AsduType.C_CS_NA.value
65    C_RP_NA = iec101.AsduType.C_RP_NA.value
66    C_TS_TA = 107
67    P_ME_NA = iec101.AsduType.P_ME_NA.value
68    P_ME_NB = iec101.AsduType.P_ME_NB.value
69    P_ME_NC = iec101.AsduType.P_ME_NC.value
70    P_AC_NA = iec101.AsduType.P_AC_NA.value
71    F_FR_NA = iec101.AsduType.F_FR_NA.value
72    F_SR_NA = iec101.AsduType.F_SR_NA.value
73    F_SC_NA = iec101.AsduType.F_SC_NA.value
74    F_LS_NA = iec101.AsduType.F_LS_NA.value
75    F_AF_NA = iec101.AsduType.F_AF_NA.value
76    F_SG_NA = iec101.AsduType.F_SG_NA.value
77    F_DR_TA = iec101.AsduType.F_DR_TA.value

 90class CauseType(enum.Enum):
 91    UNDEFINED = 0
 92    PERIODIC = 1
 93    BACKGROUND_SCAN = 2
 94    SPONTANEOUS = 3
 95    INITIALIZED = 4
 96    REQUEST = 5
 97    ACTIVATION = 6
 98    ACTIVATION_CONFIRMATION = 7
 99    DEACTIVATION = 8
100    DEACTIVATION_CONFIRMATION = 9
101    ACTIVATION_TERMINATION = 10
102    REMOTE_COMMAND = 11
103    LOCAL_COMMAND = 12
104    FILE_TRANSFER = 13
105    INTERROGATED_STATION = 20
106    INTERROGATED_GROUP01 = 21
107    INTERROGATED_GROUP02 = 22
108    INTERROGATED_GROUP03 = 23
109    INTERROGATED_GROUP04 = 24
110    INTERROGATED_GROUP05 = 25
111    INTERROGATED_GROUP06 = 26
112    INTERROGATED_GROUP07 = 27
113    INTERROGATED_GROUP08 = 28
114    INTERROGATED_GROUP09 = 29
115    INTERROGATED_GROUP10 = 30
116    INTERROGATED_GROUP11 = 31
117    INTERROGATED_GROUP12 = 32
118    INTERROGATED_GROUP13 = 33
119    INTERROGATED_GROUP14 = 34
120    INTERROGATED_GROUP15 = 35
121    INTERROGATED_GROUP16 = 36
122    INTERROGATED_COUNTER = 37
123    INTERROGATED_COUNTER01 = 38
124    INTERROGATED_COUNTER02 = 39
125    INTERROGATED_COUNTER03 = 40
126    INTERROGATED_COUNTER04 = 41
127    UNKNOWN_TYPE = 44
128    UNKNOWN_CAUSE = 45
129    UNKNOWN_ASDU_ADDRESS = 46
130    UNKNOWN_IO_ADDRESS = 47

133class Cause(typing.NamedTuple):
134    type: CauseType | OtherCauseType
135    is_negative_confirm: bool
136    is_test: bool
137    originator_address: OriginatorAddress

140class QualityType(enum.Enum):
141    INDICATION = 0
142    MEASUREMENT = 1
143    COUNTER = 2
144    PROTECTION = 3

147class IndicationQuality(typing.NamedTuple):
148    invalid: bool
149    not_topical: bool
150    substituted: bool
151    blocked: bool

154class MeasurementQuality(typing.NamedTuple):
155    invalid: bool
156    not_topical: bool
157    substituted: bool
158    blocked: bool
159    overflow: bool

162class CounterQuality(typing.NamedTuple):
163    invalid: bool
164    adjusted: bool
165    overflow: bool
166    sequence: int
167    """sequence in range [0, 31]"""

170class ProtectionQuality(typing.NamedTuple):
171    invalid: bool
172    not_topical: bool
173    substituted: bool
174    blocked: bool
175    time_invalid: bool

184class FreezeCode(enum.Enum):
185    READ = 0
186    FREEZE = 1
187    FREEZE_AND_RESET = 2
188    RESET = 3

191class SingleValue(enum.Enum):
192    OFF = 0
193    ON = 1

196class DoubleValue(enum.Enum):
197    """DoubleDataValue
198
199    `FAULT` stands for value 3, defined in the protocol as *INDETERMINATE*.
200    This is in order to make it more distinguishable from ``INTERMEDIATE``.
201
202    """
203    INTERMEDIATE = 0
204    OFF = 1
205    ON = 2
206    FAULT = 3

209class RegulatingValue(enum.Enum):
210    LOWER = 1
211    HIGHER = 2

214class StepPositionValue(typing.NamedTuple):
215    value: int
216    """value in range [-64, 63]"""
217    transient: bool

220class BitstringValue(typing.NamedTuple):
221    value: util.Bytes
222    """bitstring encoded as 4 bytes"""

225class NormalizedValue(typing.NamedTuple):
226    value: float
227    """value in range [-1.0, 1.0)"""

230class ScaledValue(typing.NamedTuple):
231    value: int
232    """value in range [-2^15, 2^15-1]"""

235class FloatingValue(typing.NamedTuple):
236    value: float

239class BinaryCounterValue(typing.NamedTuple):
240    value: int
241    """value in range [-2^31, 2^31-1]"""

244class ProtectionValue(enum.Enum):
245    OFF = 1
246    ON = 2

249class ProtectionStartValue(typing.NamedTuple):
250    general: bool
251    l1: bool
252    l2: bool
253    l3: bool
254    ie: bool
255    reverse: bool

258class ProtectionCommandValue(typing.NamedTuple):
259    general: bool
260    l1: bool
261    l2: bool
262    l3: bool

265class StatusValue(typing.NamedTuple):
266    value: list[bool]
267    """value length is 16"""
268    change: list[bool]
269    """change length is 16"""

272class IoElement_M_SP_NA(typing.NamedTuple):
273    value: SingleValue
274    quality: IndicationQuality

282class IoElement_M_DP_NA(typing.NamedTuple):
283    value: DoubleValue
284    quality: IndicationQuality

292class IoElement_M_ST_NA(typing.NamedTuple):
293    value: StepPositionValue
294    quality: MeasurementQuality

302class IoElement_M_BO_NA(typing.NamedTuple):
303    value: BitstringValue
304    quality: MeasurementQuality

312class IoElement_M_ME_NA(typing.NamedTuple):
313    value: NormalizedValue
314    quality: MeasurementQuality

322class IoElement_M_ME_NB(typing.NamedTuple):
323    value: ScaledValue
324    quality: MeasurementQuality

332class IoElement_M_ME_NC(typing.NamedTuple):
333    value: FloatingValue
334    quality: MeasurementQuality

342class IoElement_M_IT_NA(typing.NamedTuple):
343    value: BinaryCounterValue
344    quality: CounterQuality

373class IoElement_M_PS_NA(typing.NamedTuple):
374    value: StatusValue
375    quality: MeasurementQuality

378class IoElement_M_ME_ND(typing.NamedTuple):
379    value: NormalizedValue

382class IoElement_M_SP_TB(typing.NamedTuple):
383    value: SingleValue
384    quality: IndicationQuality

387class IoElement_M_DP_TB(typing.NamedTuple):
388    value: DoubleValue
389    quality: IndicationQuality

392class IoElement_M_ST_TB(typing.NamedTuple):
393    value: StepPositionValue
394    quality: MeasurementQuality

397class IoElement_M_BO_TB(typing.NamedTuple):
398    value: BitstringValue
399    quality: MeasurementQuality

402class IoElement_M_ME_TD(typing.NamedTuple):
403    value: NormalizedValue
404    quality: MeasurementQuality

407class IoElement_M_ME_TE(typing.NamedTuple):
408    value: ScaledValue
409    quality: MeasurementQuality

412class IoElement_M_ME_TF(typing.NamedTuple):
413    value: FloatingValue
414    quality: MeasurementQuality

417class IoElement_M_IT_TB(typing.NamedTuple):
418    value: BinaryCounterValue
419    quality: CounterQuality

422class IoElement_M_EP_TD(typing.NamedTuple):
423    value: ProtectionValue
424    quality: ProtectionQuality
425    elapsed_time: int
426    """elapsed_time in range [0, 65535]"""

429class IoElement_M_EP_TE(typing.NamedTuple):
430    value: ProtectionStartValue
431    quality: ProtectionQuality
432    duration_time: int
433    """duration_time in range [0, 65535]"""

436class IoElement_M_EP_TF(typing.NamedTuple):
437    value: ProtectionCommandValue
438    quality: ProtectionQuality
439    operating_time: int
440    """operating_time in range [0, 65535]"""

443class IoElement_C_SC_NA(typing.NamedTuple):
444    value: SingleValue
445    select: bool
446    qualifier: int
447    """qualifier in range [0, 31]"""

450class IoElement_C_DC_NA(typing.NamedTuple):
451    value: DoubleValue
452    select: bool
453    qualifier: int
454    """qualifier in range [0, 31]"""

457class IoElement_C_RC_NA(typing.NamedTuple):
458    value: RegulatingValue
459    select: bool
460    qualifier: int
461    """qualifier in range [0, 31]"""

464class IoElement_C_SE_NA(typing.NamedTuple):
465    value: NormalizedValue
466    select: bool

469class IoElement_C_SE_NB(typing.NamedTuple):
470    value: ScaledValue
471    select: bool

474class IoElement_C_SE_NC(typing.NamedTuple):
475    value: FloatingValue
476    select: bool

479class IoElement_C_BO_NA(typing.NamedTuple):
480    value: BitstringValue

483class IoElement_M_EI_NA(typing.NamedTuple):
484    param_change: bool
485    cause: int
486    """cause in range [0, 127]"""

489class IoElement_C_IC_NA(typing.NamedTuple):
490    qualifier: int
491    """qualifier in range [0, 255]"""

494class IoElement_C_CI_NA(typing.NamedTuple):
495    request: int
496    """request in range [0, 63]"""
497    freeze: FreezeCode

500class IoElement_C_RD_NA(typing.NamedTuple):
501    pass

504class IoElement_C_CS_NA(typing.NamedTuple):
505    time: Time
506    """time size is SEVEN"""

513class IoElement_C_RP_NA(typing.NamedTuple):
514    qualifier: int
515    """qualifier in range [0, 255]"""

523class IoElement_P_ME_NA(typing.NamedTuple):
524    value: NormalizedValue
525    qualifier: int
526    """qualifier in range [0, 255]"""

529class IoElement_P_ME_NB(typing.NamedTuple):
530    value: ScaledValue
531    qualifier: int
532    """qualifier in range [0, 255]"""

535class IoElement_P_ME_NC(typing.NamedTuple):
536    value: FloatingValue
537    qualifier: int
538    """qualifier in range [0, 255]"""

541class IoElement_P_AC_NA(typing.NamedTuple):
542    qualifier: int
543    """qualifier in range [0, 255]"""

546class IoElement_F_FR_NA(typing.NamedTuple):
547    file_name: int
548    """file_name in range [0, 65535]"""
549    file_length: int
550    """file_length in range [0, 16777215]"""
551    ready: bool

554class IoElement_F_SR_NA(typing.NamedTuple):
555    file_name: int
556    """file_name in range [0, 65535]"""
557    section_name: int
558    """section_name in range [0, 255]"""
559    section_length: int
560    """section_length in range [0, 16777215]"""
561    ready: bool

564class IoElement_F_SC_NA(typing.NamedTuple):
565    file_name: int
566    """file_name in range [0, 65535]"""
567    section_name: int
568    """section_name in range [0, 255]"""
569    qualifier: int
570    """qualifier in range [0, 255]"""

573class IoElement_F_LS_NA(typing.NamedTuple):
574    file_name: int
575    """file_name in range [0, 65535]"""
576    section_name: int
577    """section_name in range [0, 255]"""
578    last_qualifier: int
579    """last_qualifier in range [0, 255]"""
580    checksum: int
581    """checksum in range [0, 255]"""

584class IoElement_F_AF_NA(typing.NamedTuple):
585    file_name: int
586    """file_name in range [0, 65535]"""
587    section_name: int
588    """section_name in range [0, 255]"""
589    qualifier: int
590    """qualifier in range [0, 255]"""