hat.drivers.iec103

IEC 60870-5-103 communication protocol

 1"""IEC 60870-5-103 communication protocol"""
 2
 3from hat.drivers.iec103.common import (Description,
 4                                       IoAddress,
 5                                       Identification,
 6                                       TimeSize,
 7                                       Time,
 8                                       ValueType,
 9                                       NoneValue,
10                                       TextValue,
11                                       BitstringValue,
12                                       UIntValue,
13                                       IntValue,
14                                       UFixedValue,
15                                       FixedValue,
16                                       Real32Value,
17                                       Real64Value,
18                                       DoubleValue,
19                                       SingleValue,
20                                       ExtendedDoubleValue,
21                                       MeasurandValue,
22                                       TimeValue,
23                                       IdentificationValue,
24                                       RelativeTimeValue,
25                                       IoAddressValue,
26                                       DoubleWithTimeValue,
27                                       DoubleWithRelativeTimeValue,
28                                       MeasurandWithRelativeTimeValue,
29                                       TextNumberValue,
30                                       ReplyValue,
31                                       ArrayValue,
32                                       IndexValue,
33                                       Value,
34                                       AsduAddress,
35                                       DataCause,
36                                       GenericDataCause,
37                                       MeasurandType,
38                                       MeasurandValues,
39                                       Data,
40                                       GenericData,
41                                       time_from_datetime,
42                                       time_to_datetime)
43from hat.drivers.iec103.master import (DataCb,
44                                       GenericDataCb,
45                                       MasterConnection)
46
47
48__all__ = ['Description',
49           'IoAddress',
50           'Identification',
51           'TimeSize',
52           'Time',
53           'ValueType',
54           'NoneValue',
55           'TextValue',
56           'BitstringValue',
57           'UIntValue',
58           'IntValue',
59           'UFixedValue',
60           'FixedValue',
61           'Real32Value',
62           'Real64Value',
63           'DoubleValue',
64           'SingleValue',
65           'ExtendedDoubleValue',
66           'MeasurandValue',
67           'TimeValue',
68           'IdentificationValue',
69           'RelativeTimeValue',
70           'IoAddressValue',
71           'DoubleWithTimeValue',
72           'DoubleWithRelativeTimeValue',
73           'MeasurandWithRelativeTimeValue',
74           'TextNumberValue',
75           'ReplyValue',
76           'ArrayValue',
77           'IndexValue',
78           'Value',
79           'AsduAddress',
80           'DataCause',
81           'GenericDataCause',
82           'MeasurandType',
83           'MeasurandValues',
84           'Data',
85           'GenericData',
86           'time_from_datetime',
87           'time_to_datetime',
88           'DataCb',
89           'GenericDataCb',
90           'MasterConnection']
class Description(enum.Enum):
67class Description(enum.Enum):
68    NOT_SPECIFIED = 0
69    ACTUAL_VALUE = 1
70    DEFAULT_VALUE = 2
71    RANGE = 3
72    PRECISION = 5
73    FACTOR = 6
74    REFERENCE = 7
75    ENUMERATION = 8
76    DIMENSION = 9
77    DESCRIPTION = 10
78    PASSWORD = 12
79    READ_ONLY = 13
80    WRITE_ONLY = 14
81    IO_ADDRESS = 19
82    EVENT = 20
83    TEXT_ARRAY = 21
84    VALUE_ARRAY = 22
85    RELATED = 23

An enumeration.

NOT_SPECIFIED = <Description.NOT_SPECIFIED: 0>
ACTUAL_VALUE = <Description.ACTUAL_VALUE: 1>
DEFAULT_VALUE = <Description.DEFAULT_VALUE: 2>
RANGE = <Description.RANGE: 3>
PRECISION = <Description.PRECISION: 5>
FACTOR = <Description.FACTOR: 6>
REFERENCE = <Description.REFERENCE: 7>
ENUMERATION = <Description.ENUMERATION: 8>
DIMENSION = <Description.DIMENSION: 9>
DESCRIPTION = <Description.DESCRIPTION: 10>
PASSWORD = <Description.PASSWORD: 12>
READ_ONLY = <Description.READ_ONLY: 13>
WRITE_ONLY = <Description.WRITE_ONLY: 14>
IO_ADDRESS = <Description.IO_ADDRESS: 19>
EVENT = <Description.EVENT: 20>
TEXT_ARRAY = <Description.TEXT_ARRAY: 21>
VALUE_ARRAY = <Description.VALUE_ARRAY: 22>
RELATED = <Description.RELATED: 23>
Inherited Members
enum.Enum
name
value
class IoAddress(typing.NamedTuple):
126class IoAddress(typing.NamedTuple):
127    function_type: int
128    """function_type is in range [0, 255]"""
129    information_number: int
130    """information_number is in range [0, 255]"""

IoAddress(function_type, information_number)

IoAddress(function_type: int, information_number: int)

Create new instance of IoAddress(function_type, information_number)

function_type: int

function_type is in range [0, 255]

information_number: int

information_number is in range [0, 255]

Inherited Members
builtins.tuple
index
count
class Identification(typing.NamedTuple):
133class Identification(typing.NamedTuple):
134    group_id: int
135    """group_id in range [0, 255]"""
136    entry_id: int
137    """entry_id in range [0, 255]"""

Identification(group_id, entry_id)

Identification(group_id: int, entry_id: int)

Create new instance of Identification(group_id, entry_id)

group_id: int

group_id in range [0, 255]

entry_id: int

entry_id in range [0, 255]

Inherited Members
builtins.tuple
index
count
class TimeSize(enum.Enum):
24class TimeSize(enum.Enum):
25    TWO = 2
26    THREE = 3
27    FOUR = 4
28    SEVEN = 7

An enumeration.

TWO = <TimeSize.TWO: 2>
THREE = <TimeSize.THREE: 3>
FOUR = <TimeSize.FOUR: 4>
SEVEN = <TimeSize.SEVEN: 7>
Inherited Members
enum.Enum
name
value
class Time(typing.NamedTuple):
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])"""

Time(size, milliseconds, invalid, minutes, summer_time, hours, day_of_week, day_of_month, months, years)

Time( size: TimeSize, milliseconds: int, invalid: bool | None, minutes: int | None, summer_time: bool | None, hours: int | None, day_of_week: int | None, day_of_month: int | None, months: int | None, years: int | None)

Create new instance of Time(size, milliseconds, invalid, minutes, summer_time, hours, day_of_week, day_of_month, months, years)

size: TimeSize

Alias for field number 0

milliseconds: int

milliseconds in range [0, 59999]

invalid: bool | None

available for size THREE, FOUR, SEVEN

minutes: int | None

available for size THREE, FOUR, SEVEN (minutes in range [0, 59])

summer_time: bool | None

available for size FOUR, SEVEN

hours: int | None

available for size FOUR, SEVEN (hours in range [0, 23])

day_of_week: int | None

available for size SEVEN (day_of_week in range [1, 7])

day_of_month: int | None

available for size SEVEN (day_of_month in range [1, 31])

months: int | None

available for size SEVEN (months in range [1, 12])

years: int | None

available for size SEVEN (years in range [0, 99])

Inherited Members
builtins.tuple
index
count
class ValueType(enum.Enum):
140class ValueType(enum.Enum):
141    NONE = 0
142    TEXT = 1
143    BITSTRING = 2
144    UINT = 3
145    INT = 4
146    UFIXED = 5
147    FIXED = 6
148    REAL32 = 7
149    REAL64 = 8
150    DOUBLE = 9
151    SINGLE = 10
152    EXTENDED_DOUBLE = 11
153    MEASURAND = 12
154    TIME = 14
155    IDENTIFICATION = 15
156    RELATIVE_TIME = 16
157    IO_ADDRESS = 17
158    DOUBLE_WITH_TIME = 18
159    DOUBLE_WITH_RELATIVE_TIME = 19
160    MEASURAND_WITH_RELATIVE_TIME = 20
161    TEXT_NUMBER = 21
162    REPLY = 22
163    ARRAY = 23
164    INDEX = 24

An enumeration.

NONE = <ValueType.NONE: 0>
TEXT = <ValueType.TEXT: 1>
BITSTRING = <ValueType.BITSTRING: 2>
UINT = <ValueType.UINT: 3>
INT = <ValueType.INT: 4>
UFIXED = <ValueType.UFIXED: 5>
FIXED = <ValueType.FIXED: 6>
REAL32 = <ValueType.REAL32: 7>
REAL64 = <ValueType.REAL64: 8>
DOUBLE = <ValueType.DOUBLE: 9>
SINGLE = <ValueType.SINGLE: 10>
EXTENDED_DOUBLE = <ValueType.EXTENDED_DOUBLE: 11>
MEASURAND = <ValueType.MEASURAND: 12>
TIME = <ValueType.TIME: 14>
IDENTIFICATION = <ValueType.IDENTIFICATION: 15>
RELATIVE_TIME = <ValueType.RELATIVE_TIME: 16>
IO_ADDRESS = <ValueType.IO_ADDRESS: 17>
DOUBLE_WITH_TIME = <ValueType.DOUBLE_WITH_TIME: 18>
DOUBLE_WITH_RELATIVE_TIME = <ValueType.DOUBLE_WITH_RELATIVE_TIME: 19>
MEASURAND_WITH_RELATIVE_TIME = <ValueType.MEASURAND_WITH_RELATIVE_TIME: 20>
TEXT_NUMBER = <ValueType.TEXT_NUMBER: 21>
REPLY = <ValueType.REPLY: 22>
ARRAY = <ValueType.ARRAY: 23>
INDEX = <ValueType.INDEX: 24>
Inherited Members
enum.Enum
name
value
class NoneValue(typing.NamedTuple):
167class NoneValue(typing.NamedTuple):
168    pass

NoneValue()

NoneValue()

Create new instance of NoneValue()

Inherited Members
builtins.tuple
index
count
class TextValue(typing.NamedTuple):
171class TextValue(typing.NamedTuple):
172    value: util.Bytes

TextValue(value,)

TextValue(value: bytes | bytearray | memoryview)

Create new instance of TextValue(value,)

value: bytes | bytearray | memoryview

Alias for field number 0

Inherited Members
builtins.tuple
index
count
class BitstringValue(typing.NamedTuple):
175class BitstringValue(typing.NamedTuple):
176    value: list[bool]

BitstringValue(value,)

BitstringValue(value: list[bool])

Create new instance of BitstringValue(value,)

value: list[bool]

Alias for field number 0

Inherited Members
builtins.tuple
index
count
class UIntValue(typing.NamedTuple):
179class UIntValue(typing.NamedTuple):
180    value: int

UIntValue(value,)

UIntValue(value: int)

Create new instance of UIntValue(value,)

value: int

Alias for field number 0

Inherited Members
builtins.tuple
index
count
class IntValue(typing.NamedTuple):
183class IntValue(typing.NamedTuple):
184    value: int

IntValue(value,)

IntValue(value: int)

Create new instance of IntValue(value,)

value: int

Alias for field number 0

Inherited Members
builtins.tuple
index
count
class UFixedValue(typing.NamedTuple):
187class UFixedValue(typing.NamedTuple):
188    value: float
189    """value in range [0, 1.0]"""

UFixedValue(value,)

UFixedValue(value: float)

Create new instance of UFixedValue(value,)

value: float

value in range [0, 1.0]

Inherited Members
builtins.tuple
index
count
class FixedValue(typing.NamedTuple):
192class FixedValue(typing.NamedTuple):
193    value: float
194    """value in range [-1.0, 1.0)"""

FixedValue(value,)

FixedValue(value: float)

Create new instance of FixedValue(value,)

value: float

value in range [-1.0, 1.0)

Inherited Members
builtins.tuple
index
count
class Real32Value(typing.NamedTuple):
197class Real32Value(typing.NamedTuple):
198    value: float

Real32Value(value,)

Real32Value(value: float)

Create new instance of Real32Value(value,)

value: float

Alias for field number 0

Inherited Members
builtins.tuple
index
count
class Real64Value(typing.NamedTuple):
201class Real64Value(typing.NamedTuple):
202    value: float

Real64Value(value,)

Real64Value(value: float)

Create new instance of Real64Value(value,)

value: float

Alias for field number 0

Inherited Members
builtins.tuple
index
count
class DoubleValue(enum.Enum):
205class DoubleValue(enum.Enum):
206    TRANSIENT = 0
207    OFF = 1
208    ON = 2
209    ERROR = 3

An enumeration.

TRANSIENT = <DoubleValue.TRANSIENT: 0>
OFF = <DoubleValue.OFF: 1>
ON = <DoubleValue.ON: 2>
ERROR = <DoubleValue.ERROR: 3>
Inherited Members
enum.Enum
name
value
class SingleValue(enum.Enum):
212class SingleValue(enum.Enum):
213    OFF = 0
214    ON = 1

An enumeration.

OFF = <SingleValue.OFF: 0>
ON = <SingleValue.ON: 1>
Inherited Members
enum.Enum
name
value
class ExtendedDoubleValue(enum.Enum):
217class ExtendedDoubleValue(enum.Enum):
218    TRANSIENT = 0
219    OFF = 1
220    ON = 2
221    ERROR = 3

An enumeration.

Inherited Members
enum.Enum
name
value
class MeasurandValue(typing.NamedTuple):
224class MeasurandValue(typing.NamedTuple):
225    overflow: bool
226    invalid: bool
227    value: float
228    """value in range [-1.0, 1.0)"""

MeasurandValue(overflow, invalid, value)

MeasurandValue(overflow: bool, invalid: bool, value: float)

Create new instance of MeasurandValue(overflow, invalid, value)

overflow: bool

Alias for field number 0

invalid: bool

Alias for field number 1

value: float

value in range [-1.0, 1.0)

Inherited Members
builtins.tuple
index
count
class TimeValue(typing.NamedTuple):
231class TimeValue(typing.NamedTuple):
232    value: Time
233    """time size is SEVEN"""

TimeValue(value,)

TimeValue(value: Time)

Create new instance of TimeValue(value,)

value: Time

time size is SEVEN

Inherited Members
builtins.tuple
index
count
class IdentificationValue(typing.NamedTuple):
236class IdentificationValue(typing.NamedTuple):
237    value: Identification

IdentificationValue(value,)

IdentificationValue(value: Identification)

Create new instance of IdentificationValue(value,)

Alias for field number 0

Inherited Members
builtins.tuple
index
count
class RelativeTimeValue(typing.NamedTuple):
240class RelativeTimeValue(typing.NamedTuple):
241    value: int
242    """value in range [0, 65535]"""

RelativeTimeValue(value,)

RelativeTimeValue(value: int)

Create new instance of RelativeTimeValue(value,)

value: int

value in range [0, 65535]

Inherited Members
builtins.tuple
index
count
class IoAddressValue(typing.NamedTuple):
245class IoAddressValue(typing.NamedTuple):
246    value: IoAddress

IoAddressValue(value,)

IoAddressValue(value: IoAddress)

Create new instance of IoAddressValue(value,)

value: IoAddress

Alias for field number 0

Inherited Members
builtins.tuple
index
count
class DoubleWithTimeValue(typing.NamedTuple):
249class DoubleWithTimeValue(typing.NamedTuple):
250    value: DoubleValue
251    time: Time
252    """time size is FOUR"""
253    supplementary: int
254    """supplementary in range [0, 255]"""

DoubleWithTimeValue(value, time, supplementary)

DoubleWithTimeValue( value: DoubleValue, time: Time, supplementary: int)

Create new instance of DoubleWithTimeValue(value, time, supplementary)

value: DoubleValue

Alias for field number 0

time: Time

time size is FOUR

supplementary: int

supplementary in range [0, 255]

Inherited Members
builtins.tuple
index
count
class DoubleWithRelativeTimeValue(typing.NamedTuple):
257class DoubleWithRelativeTimeValue(typing.NamedTuple):
258    value: DoubleValue
259    relative_time: int
260    """relative_time in range [0, 65535]"""
261    fault_number: int
262    """fault_number in range [0, 65535]"""
263    time: Time
264    """time size is FOUR"""
265    supplementary: int
266    """supplementary in range [0, 255]"""

DoubleWithRelativeTimeValue(value, relative_time, fault_number, time, supplementary)

DoubleWithRelativeTimeValue( value: DoubleValue, relative_time: int, fault_number: int, time: Time, supplementary: int)

Create new instance of DoubleWithRelativeTimeValue(value, relative_time, fault_number, time, supplementary)

value: DoubleValue

Alias for field number 0

relative_time: int

relative_time in range [0, 65535]

fault_number: int

fault_number in range [0, 65535]

time: Time

time size is FOUR

supplementary: int

supplementary in range [0, 255]

Inherited Members
builtins.tuple
index
count
class MeasurandWithRelativeTimeValue(typing.NamedTuple):
269class MeasurandWithRelativeTimeValue(typing.NamedTuple):
270    value: float
271    relative_time: int
272    """relative_time in range [0, 65535]"""
273    fault_number: int
274    """fault_number in range [0, 65535]"""
275    time: Time
276    """time size is FOUR"""

MeasurandWithRelativeTimeValue(value, relative_time, fault_number, time)

MeasurandWithRelativeTimeValue( value: float, relative_time: int, fault_number: int, time: Time)

Create new instance of MeasurandWithRelativeTimeValue(value, relative_time, fault_number, time)

value: float

Alias for field number 0

relative_time: int

relative_time in range [0, 65535]

fault_number: int

fault_number in range [0, 65535]

time: Time

time size is FOUR

Inherited Members
builtins.tuple
index
count
class TextNumberValue(typing.NamedTuple):
279class TextNumberValue(typing.NamedTuple):
280    value: int

TextNumberValue(value,)

TextNumberValue(value: int)

Create new instance of TextNumberValue(value,)

value: int

Alias for field number 0

Inherited Members
builtins.tuple
index
count
class ReplyValue(enum.Enum):
283class ReplyValue(enum.Enum):
284    ACK = 0
285    INVALID_IDENTIFICATION = 1
286    DATA_NOT_EXISTS = 2
287    DATA_NOT_AVAILABLE = 3
288    VERIFY_ERROR = 4
289    OUT_OF_RANGE = 5
290    ENTRY_TO_LARGE = 6
291    TOO_MANY_COMMANDS = 7
292    ENTRY_READ_ONLY = 8
293    PASSWORD_PROTECTED = 9
294    IN_PROGRESS = 10
295    FOLLOWING_DESCRIPTION = 11

An enumeration.

ACK = <ReplyValue.ACK: 0>
INVALID_IDENTIFICATION = <ReplyValue.INVALID_IDENTIFICATION: 1>
DATA_NOT_EXISTS = <ReplyValue.DATA_NOT_EXISTS: 2>
DATA_NOT_AVAILABLE = <ReplyValue.DATA_NOT_AVAILABLE: 3>
VERIFY_ERROR = <ReplyValue.VERIFY_ERROR: 4>
OUT_OF_RANGE = <ReplyValue.OUT_OF_RANGE: 5>
ENTRY_TO_LARGE = <ReplyValue.ENTRY_TO_LARGE: 6>
TOO_MANY_COMMANDS = <ReplyValue.TOO_MANY_COMMANDS: 7>
ENTRY_READ_ONLY = <ReplyValue.ENTRY_READ_ONLY: 8>
PASSWORD_PROTECTED = <ReplyValue.PASSWORD_PROTECTED: 9>
IN_PROGRESS = <ReplyValue.IN_PROGRESS: 10>
FOLLOWING_DESCRIPTION = <ReplyValue.FOLLOWING_DESCRIPTION: 11>
Inherited Members
enum.Enum
name
value
class ArrayValue(typing.NamedTuple):
298class ArrayValue(typing.NamedTuple):
299    value_type: ValueType
300    more_follows: bool
301    values: typing.List['Value']

ArrayValue(value_type, more_follows, values)

ArrayValue( value_type: ValueType, more_follows: bool, values: List[ForwardRef('Value')])

Create new instance of ArrayValue(value_type, more_follows, values)

value_type: ValueType

Alias for field number 0

more_follows: bool

Alias for field number 1

Inherited Members
builtins.tuple
index
count
class IndexValue(typing.NamedTuple):
304class IndexValue(typing.NamedTuple):
305    value: int

IndexValue(value,)

IndexValue(value: int)

Create new instance of IndexValue(value,)

value: int

Alias for field number 0

Inherited Members
builtins.tuple
index
count
AsduAddress = <class 'int'>
class DataCause(enum.Enum):
44class DataCause(enum.Enum):
45    SPONTANEOUS = iec103.Cause.SPONTANEOUS.value
46    CYCLIC = iec103.Cause.CYCLIC.value
47    TEST_MODE = iec103.Cause.TEST_MODE.value
48    GENERAL_INTERROGATION = iec103.Cause.GENERAL_INTERROGATION.value
49    LOCAL_OPERATION = iec103.Cause.LOCAL_OPERATION.value
50    REMOTE_OPERATION = iec103.Cause.REMOTE_OPERATION.value

An enumeration.

SPONTANEOUS = <DataCause.SPONTANEOUS: 1>
CYCLIC = <DataCause.CYCLIC: 2>
TEST_MODE = <DataCause.TEST_MODE: 7>
GENERAL_INTERROGATION = <DataCause.GENERAL_INTERROGATION: 9>
LOCAL_OPERATION = <DataCause.LOCAL_OPERATION: 11>
REMOTE_OPERATION = <DataCause.REMOTE_OPERATION: 12>
Inherited Members
enum.Enum
name
value
class GenericDataCause(enum.Enum):
53class GenericDataCause(enum.Enum):
54    SPONTANEOUS = iec103.Cause.SPONTANEOUS.value
55    CYCLIC = iec103.Cause.CYCLIC.value
56    TEST_MODE = iec103.Cause.TEST_MODE.value
57    GENERAL_INTERROGATION = iec103.Cause.GENERAL_INTERROGATION.value
58    LOCAL_OPERATION = iec103.Cause.LOCAL_OPERATION.value
59    REMOTE_OPERATION = iec103.Cause.REMOTE_OPERATION.value
60    WRITE_ACK = iec103.Cause.GENERIC_WRITE_COMMAND.value
61    WRITE_NACK = iec103.Cause.GENERIC_WRITE_COMMAND_NACK.value
62    READ_ACK = iec103.Cause.GENERIC_READ_COMMAND.value
63    READ_NACK = iec103.Cause.GENERIC_READ_COMMAND_NACK.value
64    WRITE_CONFIRMATION = iec103.Cause.GENERIC_WRITE_CONFIRMATION.value

An enumeration.

SPONTANEOUS = <GenericDataCause.SPONTANEOUS: 1>
CYCLIC = <GenericDataCause.CYCLIC: 2>
TEST_MODE = <GenericDataCause.TEST_MODE: 7>
GENERAL_INTERROGATION = <GenericDataCause.GENERAL_INTERROGATION: 9>
LOCAL_OPERATION = <GenericDataCause.LOCAL_OPERATION: 11>
REMOTE_OPERATION = <GenericDataCause.REMOTE_OPERATION: 12>
WRITE_ACK = <GenericDataCause.WRITE_ACK: 40>
WRITE_NACK = <GenericDataCause.WRITE_NACK: 41>
READ_ACK = <GenericDataCause.READ_ACK: 42>
READ_NACK = <GenericDataCause.READ_NACK: 43>
WRITE_CONFIRMATION = <GenericDataCause.WRITE_CONFIRMATION: 44>
Inherited Members
enum.Enum
name
value
class MeasurandType(enum.Enum):
67class MeasurandType(enum.Enum):
68    M1_I_L2 = (iec103.AsduType.MEASURANDS_1.value, 0)
69    M1_U_L12 = (iec103.AsduType.MEASURANDS_1.value, 1)
70    M1_P = (iec103.AsduType.MEASURANDS_1.value, 2)
71    M1_Q = (iec103.AsduType.MEASURANDS_1.value, 3)
72    M2_I_L1 = (iec103.AsduType.MEASURANDS_2.value, 0)
73    M2_I_L2 = (iec103.AsduType.MEASURANDS_2.value, 1)
74    M2_I_L3 = (iec103.AsduType.MEASURANDS_2.value, 2)
75    M2_U_L1E = (iec103.AsduType.MEASURANDS_2.value, 3)
76    M2_U_L2E = (iec103.AsduType.MEASURANDS_2.value, 4)
77    M2_U_L3E = (iec103.AsduType.MEASURANDS_2.value, 5)
78    M2_P = (iec103.AsduType.MEASURANDS_2.value, 6)
79    M2_Q = (iec103.AsduType.MEASURANDS_2.value, 7)
80    M2_F = (iec103.AsduType.MEASURANDS_2.value, 8)

An enumeration.

M1_I_L2 = <MeasurandType.M1_I_L2: (3, 0)>
M1_U_L12 = <MeasurandType.M1_U_L12: (3, 1)>
M1_P = <MeasurandType.M1_P: (3, 2)>
M1_Q = <MeasurandType.M1_Q: (3, 3)>
M2_I_L1 = <MeasurandType.M2_I_L1: (9, 0)>
M2_I_L2 = <MeasurandType.M2_I_L2: (9, 1)>
M2_I_L3 = <MeasurandType.M2_I_L3: (9, 2)>
M2_U_L1E = <MeasurandType.M2_U_L1E: (9, 3)>
M2_U_L2E = <MeasurandType.M2_U_L2E: (9, 4)>
M2_U_L3E = <MeasurandType.M2_U_L3E: (9, 5)>
M2_P = <MeasurandType.M2_P: (9, 6)>
M2_Q = <MeasurandType.M2_Q: (9, 7)>
M2_F = <MeasurandType.M2_F: (9, 8)>
Inherited Members
enum.Enum
name
value
class MeasurandValues(typing.NamedTuple):
83class MeasurandValues(typing.NamedTuple):
84    values: dict[MeasurandType, MeasurandValue]

MeasurandValues(values,)

MeasurandValues( values: dict[MeasurandType, MeasurandValue])

Create new instance of MeasurandValues(values,)

values: dict[MeasurandType, MeasurandValue]

Alias for field number 0

Inherited Members
builtins.tuple
index
count
class Data(typing.NamedTuple):
87class Data(typing.NamedTuple):
88    asdu_address: AsduAddress
89    io_address: IoAddress
90    cause: DataCause | OtherCause
91    value: (DoubleWithTimeValue |
92            DoubleWithRelativeTimeValue |
93            MeasurandValues |
94            MeasurandWithRelativeTimeValue)

Data(asdu_address, io_address, cause, value)

Data( asdu_address: int, io_address: IoAddress, cause: DataCause | int, value: DoubleWithTimeValue | DoubleWithRelativeTimeValue | MeasurandValues | MeasurandWithRelativeTimeValue)

Create new instance of Data(asdu_address, io_address, cause, value)

asdu_address: int

Alias for field number 0

io_address: IoAddress

Alias for field number 1

cause: DataCause | int

Alias for field number 2

Inherited Members
builtins.tuple
index
count
class GenericData(typing.NamedTuple):
 97class GenericData(typing.NamedTuple):
 98    asdu_address: AsduAddress
 99    io_address: IoAddress
100    cause: GenericDataCause | OtherCause
101    identification: Identification
102    description: Description
103    value: ArrayValue

GenericData(asdu_address, io_address, cause, identification, description, value)

GenericData( asdu_address: int, io_address: IoAddress, cause: GenericDataCause | int, identification: Identification, description: Description, value: ArrayValue)

Create new instance of GenericData(asdu_address, io_address, cause, identification, description, value)

asdu_address: int

Alias for field number 0

io_address: IoAddress

Alias for field number 1

cause: GenericDataCause | int

Alias for field number 2

identification: Identification

Alias for field number 3

description: Description

Alias for field number 4

value: ArrayValue

Alias for field number 5

Inherited Members
builtins.tuple
index
count
def time_from_datetime( dt: datetime.datetime, invalid: bool = False) -> Time:
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)

Create Time from datetime.datetime

def time_to_datetime(t: Time) -> datetime.datetime:
 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)

Convert Time to datetime.datetime

DataCb = typing.Callable[[Data], typing.Optional[typing.Awaitable[NoneType]]]
GenericDataCb = typing.Callable[[GenericData], typing.Optional[typing.Awaitable[NoneType]]]
class MasterConnection(hat.aio.group.Resource):
 24class MasterConnection(aio.Resource):
 25
 26    def __init__(self,
 27                 conn: unbalanced.MasterConnection,
 28                 *,
 29                 data_cb: DataCb | None = None,
 30                 generic_data_cb: GenericDataCb | None = None):
 31        self._conn = conn
 32        self._data_cb = data_cb
 33        self._generic_data_cb = generic_data_cb
 34
 35        self._encoder = iec103.Encoder()
 36
 37        self._interrogate_lock = asyncio.Lock()
 38        self._interrogate_req_id = None
 39        self._interrogate_future = None
 40
 41        self._send_command_lock = asyncio.Lock()
 42        self._send_command_req_id = None
 43        self._send_command_future = None
 44
 45        self._interrogate_generic_lock = asyncio.Lock()
 46        self._interrogate_generic_req_id = None
 47        self._interrogate_generic_future = None
 48
 49        self._next_req_ids = (i % 0x100 for i in itertools.count(0))
 50
 51        self._process_single_element_fns = {
 52            iec103.AsduType.TIME_TAGGED_MESSAGE: self._process_TIME_TAGGED_MESSAGE,  # NOQA
 53            iec103.AsduType.TIME_TAGGED_MESSAGE_WITH_RELATIVE_TIME: self._process_TIME_TAGGED_MESSAGE_WITH_RELATIVE_TIME,  # NOQA
 54            iec103.AsduType.TIME_TAGGED_MEASURANDS_WITH_RELATIVE_TIME: self._process_TIME_TAGGED_MEASURANDS_WITH_RELATIVE_TIME,  # NOQA
 55            iec103.AsduType.IDENTIFICATION: self._process_IDENTIFICATION,
 56            iec103.AsduType.TIME_SYNCHRONIZATION: self._process_TIME_SYNCHRONIZATION,  # NOQA
 57            iec103.AsduType.GENERAL_INTERROGATION_TERMINATION: self._process_GENERAL_INTERROGATION_TERMINATION,  # NOQA
 58            iec103.AsduType.GENERIC_DATA: self._process_GENERIC_DATA,
 59            iec103.AsduType.GENERIC_IDENTIFICATION: self._process_GENERIC_IDENTIFICATION,  # NOQA
 60            iec103.AsduType.READY_FOR_TRANSMISSION_OF_DISTURBANCE_DATA: self._process_READY_FOR_TRANSMISSION_OF_DISTURBANCE_DATA,  # NOQA
 61            iec103.AsduType.READY_FOR_TRANSMISSION_OF_A_CHANNEL: self._process_READY_FOR_TRANSMISSION_OF_A_CHANNEL,  # NOQA
 62            iec103.AsduType.READY_FOR_TRANSMISSION_OF_TAGS: self._process_READY_FOR_TRANSMISSION_OF_TAGS,  # NOQA
 63            iec103.AsduType.TRANSMISSION_OF_TAGS: self._process_TRANSMISSION_OF_TAGS,  # NOQA
 64            iec103.AsduType.TRANSMISSION_OF_DISTURBANCE_VALUES: self._process_TRANSMISSION_OF_DISTURBANCE_VALUES,  # NOQA
 65            iec103.AsduType.END_OF_TRANSMISSION: self._process_END_OF_TRANSMISSION}  # NOQA
 66        self._process_multiple_elements_fns = {
 67            iec103.AsduType.MEASURANDS_1: self._process_MEASURANDS_1,
 68            iec103.AsduType.MEASURANDS_2: self._process_MEASURANDS_2,
 69            iec103.AsduType.LIST_OF_RECORDED_DISTURBANCES: self._process_LIST_OF_RECORDED_DISTURBANCES}  # NOQA
 70
 71        self.async_group.spawn(self._receive_loop)
 72
 73    @property
 74    def async_group(self):
 75        return self._conn.async_group
 76
 77    async def time_sync(self,
 78                        time: common.Time | None = None,
 79                        asdu_address: common.AsduAddress = 0xFF):
 80        if not self.is_open:
 81            raise ConnectionError()
 82
 83        time = time or common.time_from_datetime(datetime.datetime.now())
 84        io_address = common.IoAddress(
 85            _FunctionType.GLOBAL_FUNCTION_TYPE.value,
 86            _InformationNumber.GENERAL_INTERROGATION_OR_TIME_SYNCHRONIZATION.value)  # NOQA
 87        asdu = iec103.ASDU(
 88            type=iec103.AsduType.TIME_SYNCHRONIZATION,
 89            cause=iec103.Cause.TIME_SYNCHRONIZATION,
 90            address=asdu_address,
 91            ios=[iec103.IO(
 92                address=io_address,
 93                elements=[iec103.IoElement_TIME_SYNCHRONIZATION(
 94                    time=time)])])
 95        data = self._encoder.encode_asdu(asdu)
 96
 97        await self._conn.send(data)
 98
 99    async def interrogate(self, asdu_address: common.AsduAddress):
100        async with self._interrogate_lock:
101            if not self.is_open:
102                raise ConnectionError()
103
104            scan_number = next(self._next_req_ids)
105            asdu = iec103.ASDU(
106                type=iec103.AsduType.GENERAL_INTERROGATION,
107                cause=iec103.Cause.GENERAL_INTERROGATION,
108                address=asdu_address,
109                ios=[iec103.IO(
110                    address=iec103.IoAddress(
111                        function_type=_FunctionType.GLOBAL_FUNCTION_TYPE.value,  # NOQA
112                        information_number=_InformationNumber.GENERAL_INTERROGATION_OR_TIME_SYNCHRONIZATION.value),  # NOQA
113                    elements=[iec103.IoElement_GENERAL_INTERROGATION(  # NOQA
114                        scan_number=scan_number)])])
115            data = self._encoder.encode_asdu(asdu)
116
117            try:
118                self._interrogate_req_id = scan_number
119                self._interrogate_future = asyncio.Future()
120                await self._conn.send(data)
121                await self._interrogate_future
122
123            finally:
124                self._interrogate_req_id = None
125                self._interrogate_future = None
126
127    async def send_command(self,
128                           asdu_address: common.AsduAddress,
129                           io_address: common.IoAddress,
130                           value: common.DoubleValue
131                           ) -> bool:
132        async with self._send_command_lock:
133            if not self.is_open:
134                raise ConnectionError()
135
136            return_identifier = next(self._next_req_ids)
137            asdu = iec103.ASDU(
138                type=iec103.AsduType.GENERAL_COMMAND,
139                cause=iec103.Cause.GENERAL_COMMAND,
140                address=asdu_address,
141                ios=[iec103.IO(
142                    address=io_address,
143                    elements=[iec103.IoElement_GENERAL_COMMAND(
144                        value=value,
145                        return_identifier=return_identifier)])])
146            data = self._encoder.encode_asdu(asdu)
147
148            try:
149                self._send_command_req_id = return_identifier
150                self._send_command_future = asyncio.Future()
151                await self._conn.send(data)
152                return await self._send_command_future
153
154            finally:
155                self._send_command_req_id = None
156                self._send_command_future = None
157
158    async def interrogate_generic(self, asdu_address: common.AsduAddress):
159        async with self._interrogate_generic_lock:
160            if not self.is_open:
161                raise ConnectionError()
162
163            return_identifier = next(self._next_req_ids)
164            asdu = iec103.ASDU(
165                type=iec103.AsduType.GENERIC_COMMAND,
166                cause=iec103.Cause.GENERAL_INTERROGATION,
167                address=asdu_address,
168                ios=[iec103.IO(
169                    address=iec103.IoAddress(
170                        function_type=_FunctionType.GENERIC_FUNCTION_TYPE.value,  # NOQA
171                        information_number=_InformationNumber.GENERAL_INTERROGATION_OF_GENERIC_DATA.value),  # NOQA
172                    elements=[iec103.IoElement_GENERIC_COMMAND(
173                        return_identifier=return_identifier,
174                        data=[])])])
175            data = self._encoder.encode_asdu(asdu)
176
177            try:
178                self._interrogate_generic_req_id = return_identifier
179                self._interrogate_generic_future = asyncio.Future()
180                await self._conn.send(data)
181                await self._interrogate_generic_future
182
183            finally:
184                self._interrogate_generic_req_id = None
185                self._interrogate_generic_future = None
186
187    async def _receive_loop(self):
188        try:
189            while True:
190                data = await self._conn.receive()
191                asdu, _ = self._encoder.decode_asdu(data)
192
193                for io in asdu.ios:
194                    if asdu.type in self._process_single_element_fns:
195                        fn = self._process_single_element_fns[asdu.type]
196                        for element in io.elements:
197                            await fn(asdu.cause, asdu.address, io.address,
198                                     element)
199
200                    elif asdu.type in self._process_multiple_elements_fns:
201                        fn = self._process_multiple_elements_fns[asdu.type]
202                        await fn(asdu.cause, asdu.address, io.address,
203                                 io.elements)
204
205                    else:
206                        raise ValueError('unsupported asdu type')
207
208        except Exception as e:
209            mlog.error("receive loop error: %s", e, exc_info=e)
210
211        finally:
212            self.close()
213            _try_set_exception(self._interrogate_future, ConnectionError())
214            _try_set_exception(self._send_command_future, ConnectionError())
215            _try_set_exception(self._interrogate_generic_future,
216                               ConnectionError())
217
218    async def _process_TIME_TAGGED_MESSAGE(self, cause, asdu_address, io_address, element):  # NOQA
219        if cause == iec103.Cause.GENERAL_COMMAND:
220            if element.value.supplementary == self._send_command_req_id:
221                _try_set_result(self._send_command_future, True)
222
223        elif cause == iec103.Cause.GENERAL_COMMAND_NACK:
224            if element.value.supplementary == self._send_command_req_id:
225                _try_set_result(self._send_command_future, False)
226
227        else:
228            await _try_aio_call(self._data_cb, common.Data(
229                asdu_address=asdu_address,
230                io_address=io_address,
231                cause=_try_decode_cause(cause, common.DataCause),
232                value=element.value))
233
234    async def _process_TIME_TAGGED_MESSAGE_WITH_RELATIVE_TIME(self, cause, asdu_address, io_address, element):  # NOQA
235        await _try_aio_call(self._data_cb, common.Data(
236            asdu_address=asdu_address,
237            io_address=io_address,
238            cause=_try_decode_cause(cause, common.DataCause),
239            value=element.value))
240
241    async def _process_MEASURANDS_1(self, cause, asdu_address, io_address, elements):  # NOQA
242        value = common.MeasurandValues(values={})
243        for i, element in enumerate(elements):
244            measurand_type = common.MeasurandType((
245                iec103.AsduType.MEASURANDS_1.value, i))
246            value.values[measurand_type] = element.value
247
248        await _try_aio_call(self._data_cb, common.Data(
249            asdu_address=asdu_address,
250            io_address=io_address,
251            cause=_try_decode_cause(cause, common.DataCause),
252            value=value))
253
254    async def _process_TIME_TAGGED_MEASURANDS_WITH_RELATIVE_TIME(self, cause, asdu_address, io_address, element):  # NOQA
255        await _try_aio_call(self._data_cb, common.Data(
256            asdu_address=asdu_address,
257            io_address=io_address,
258            cause=_try_decode_cause(cause, common.DataCause),
259            value=element.value))
260
261    async def _process_IDENTIFICATION(self, cause, asdu_address, io_address, element):  # NOQA
262        mlog.debug("received device identification "
263                   "(compatibility: %s; value: %s; software: %s)",
264                   element.compatibility,
265                   bytes(element.value),
266                   bytes(element.software))
267
268    async def _process_TIME_SYNCHRONIZATION(self, cause, asdu_address, io_address, element):  # NOQA
269        mlog.info("received time sync response")
270
271    async def _process_GENERAL_INTERROGATION_TERMINATION(self, cause, asdu_address, io_address, element):  # NOQA
272        if element.scan_number != self._interrogate_req_id:
273            return
274        _try_set_result(self._interrogate_future, None)
275
276    async def _process_MEASURANDS_2(self, cause, asdu_address, io_address, elements):  # NOQA
277        value = common.MeasurandValues(values={})
278        for i, element in enumerate(elements):
279            measurand_type = common.MeasurandType((
280                iec103.AsduType.MEASURANDS_2.value, i))
281            value.values[measurand_type] = element.value
282
283        await _try_aio_call(self._data_cb, common.Data(
284            asdu_address=asdu_address,
285            io_address=io_address,
286            cause=_try_decode_cause(cause, common.DataCause),
287            value=value))
288
289    async def _process_GENERIC_DATA(self, cause, asdu_address, io_address, element):  # NOQA
290        if cause == iec103.Cause.TERMINATION_OF_GENERAL_INTERROGATION:  # NOQA
291            if element.return_identifier == self._interrogate_generic_req_id:
292                _try_set_result(self._interrogate_generic_future, None)
293
294        else:
295            data_cause = _try_decode_cause(cause, common.GenericDataCause)
296            for identification, data in element.data:
297                await _try_aio_call(self._generic_data_cb, common.GenericData(
298                    asdu_address=asdu_address,
299                    io_address=io_address,
300                    cause=data_cause,
301                    identification=identification,
302                    description=data.description,
303                    value=data.value))
304
305    async def _process_GENERIC_IDENTIFICATION(self, cause, asdu_address, io_address, element):  # NOQA
306        pass
307
308    async def _process_LIST_OF_RECORDED_DISTURBANCES(self, cause, asdu_address, io_address, elements):  # NOQA
309        pass
310
311    async def _process_READY_FOR_TRANSMISSION_OF_DISTURBANCE_DATA(self, cause, asdu_address, io_address, element):  # NOQA
312        pass
313
314    async def _process_READY_FOR_TRANSMISSION_OF_A_CHANNEL(self, cause, asdu_address, io_address, element):  # NOQA
315        pass
316
317    async def _process_READY_FOR_TRANSMISSION_OF_TAGS(self, cause, asdu_address, io_address, element):  # NOQA
318        pass
319
320    async def _process_TRANSMISSION_OF_TAGS(self, cause, asdu_address, io_address, element):  # NOQA
321        pass
322
323    async def _process_TRANSMISSION_OF_DISTURBANCE_VALUES(self, cause, asdu_address, io_address, element):  # NOQA
324        pass
325
326    async def _process_END_OF_TRANSMISSION(self, cause, asdu_address, io_address, element):  # NOQA
327        pass

Resource with lifetime control based on Group.

MasterConnection( conn: hat.drivers.iec60870.link.unbalanced.master.MasterConnection, *, data_cb: Optional[Callable[[Data], Optional[Awaitable[NoneType]]]] = None, generic_data_cb: Optional[Callable[[GenericData], Optional[Awaitable[NoneType]]]] = None)
26    def __init__(self,
27                 conn: unbalanced.MasterConnection,
28                 *,
29                 data_cb: DataCb | None = None,
30                 generic_data_cb: GenericDataCb | None = None):
31        self._conn = conn
32        self._data_cb = data_cb
33        self._generic_data_cb = generic_data_cb
34
35        self._encoder = iec103.Encoder()
36
37        self._interrogate_lock = asyncio.Lock()
38        self._interrogate_req_id = None
39        self._interrogate_future = None
40
41        self._send_command_lock = asyncio.Lock()
42        self._send_command_req_id = None
43        self._send_command_future = None
44
45        self._interrogate_generic_lock = asyncio.Lock()
46        self._interrogate_generic_req_id = None
47        self._interrogate_generic_future = None
48
49        self._next_req_ids = (i % 0x100 for i in itertools.count(0))
50
51        self._process_single_element_fns = {
52            iec103.AsduType.TIME_TAGGED_MESSAGE: self._process_TIME_TAGGED_MESSAGE,  # NOQA
53            iec103.AsduType.TIME_TAGGED_MESSAGE_WITH_RELATIVE_TIME: self._process_TIME_TAGGED_MESSAGE_WITH_RELATIVE_TIME,  # NOQA
54            iec103.AsduType.TIME_TAGGED_MEASURANDS_WITH_RELATIVE_TIME: self._process_TIME_TAGGED_MEASURANDS_WITH_RELATIVE_TIME,  # NOQA
55            iec103.AsduType.IDENTIFICATION: self._process_IDENTIFICATION,
56            iec103.AsduType.TIME_SYNCHRONIZATION: self._process_TIME_SYNCHRONIZATION,  # NOQA
57            iec103.AsduType.GENERAL_INTERROGATION_TERMINATION: self._process_GENERAL_INTERROGATION_TERMINATION,  # NOQA
58            iec103.AsduType.GENERIC_DATA: self._process_GENERIC_DATA,
59            iec103.AsduType.GENERIC_IDENTIFICATION: self._process_GENERIC_IDENTIFICATION,  # NOQA
60            iec103.AsduType.READY_FOR_TRANSMISSION_OF_DISTURBANCE_DATA: self._process_READY_FOR_TRANSMISSION_OF_DISTURBANCE_DATA,  # NOQA
61            iec103.AsduType.READY_FOR_TRANSMISSION_OF_A_CHANNEL: self._process_READY_FOR_TRANSMISSION_OF_A_CHANNEL,  # NOQA
62            iec103.AsduType.READY_FOR_TRANSMISSION_OF_TAGS: self._process_READY_FOR_TRANSMISSION_OF_TAGS,  # NOQA
63            iec103.AsduType.TRANSMISSION_OF_TAGS: self._process_TRANSMISSION_OF_TAGS,  # NOQA
64            iec103.AsduType.TRANSMISSION_OF_DISTURBANCE_VALUES: self._process_TRANSMISSION_OF_DISTURBANCE_VALUES,  # NOQA
65            iec103.AsduType.END_OF_TRANSMISSION: self._process_END_OF_TRANSMISSION}  # NOQA
66        self._process_multiple_elements_fns = {
67            iec103.AsduType.MEASURANDS_1: self._process_MEASURANDS_1,
68            iec103.AsduType.MEASURANDS_2: self._process_MEASURANDS_2,
69            iec103.AsduType.LIST_OF_RECORDED_DISTURBANCES: self._process_LIST_OF_RECORDED_DISTURBANCES}  # NOQA
70
71        self.async_group.spawn(self._receive_loop)
async_group
73    @property
74    def async_group(self):
75        return self._conn.async_group

Group controlling resource's lifetime.

async def time_sync( self, time: Time | None = None, asdu_address: int = 255):
77    async def time_sync(self,
78                        time: common.Time | None = None,
79                        asdu_address: common.AsduAddress = 0xFF):
80        if not self.is_open:
81            raise ConnectionError()
82
83        time = time or common.time_from_datetime(datetime.datetime.now())
84        io_address = common.IoAddress(
85            _FunctionType.GLOBAL_FUNCTION_TYPE.value,
86            _InformationNumber.GENERAL_INTERROGATION_OR_TIME_SYNCHRONIZATION.value)  # NOQA
87        asdu = iec103.ASDU(
88            type=iec103.AsduType.TIME_SYNCHRONIZATION,
89            cause=iec103.Cause.TIME_SYNCHRONIZATION,
90            address=asdu_address,
91            ios=[iec103.IO(
92                address=io_address,
93                elements=[iec103.IoElement_TIME_SYNCHRONIZATION(
94                    time=time)])])
95        data = self._encoder.encode_asdu(asdu)
96
97        await self._conn.send(data)
async def interrogate(self, asdu_address: int):
 99    async def interrogate(self, asdu_address: common.AsduAddress):
100        async with self._interrogate_lock:
101            if not self.is_open:
102                raise ConnectionError()
103
104            scan_number = next(self._next_req_ids)
105            asdu = iec103.ASDU(
106                type=iec103.AsduType.GENERAL_INTERROGATION,
107                cause=iec103.Cause.GENERAL_INTERROGATION,
108                address=asdu_address,
109                ios=[iec103.IO(
110                    address=iec103.IoAddress(
111                        function_type=_FunctionType.GLOBAL_FUNCTION_TYPE.value,  # NOQA
112                        information_number=_InformationNumber.GENERAL_INTERROGATION_OR_TIME_SYNCHRONIZATION.value),  # NOQA
113                    elements=[iec103.IoElement_GENERAL_INTERROGATION(  # NOQA
114                        scan_number=scan_number)])])
115            data = self._encoder.encode_asdu(asdu)
116
117            try:
118                self._interrogate_req_id = scan_number
119                self._interrogate_future = asyncio.Future()
120                await self._conn.send(data)
121                await self._interrogate_future
122
123            finally:
124                self._interrogate_req_id = None
125                self._interrogate_future = None
async def send_command( self, asdu_address: int, io_address: IoAddress, value: DoubleValue) -> bool:
127    async def send_command(self,
128                           asdu_address: common.AsduAddress,
129                           io_address: common.IoAddress,
130                           value: common.DoubleValue
131                           ) -> bool:
132        async with self._send_command_lock:
133            if not self.is_open:
134                raise ConnectionError()
135
136            return_identifier = next(self._next_req_ids)
137            asdu = iec103.ASDU(
138                type=iec103.AsduType.GENERAL_COMMAND,
139                cause=iec103.Cause.GENERAL_COMMAND,
140                address=asdu_address,
141                ios=[iec103.IO(
142                    address=io_address,
143                    elements=[iec103.IoElement_GENERAL_COMMAND(
144                        value=value,
145                        return_identifier=return_identifier)])])
146            data = self._encoder.encode_asdu(asdu)
147
148            try:
149                self._send_command_req_id = return_identifier
150                self._send_command_future = asyncio.Future()
151                await self._conn.send(data)
152                return await self._send_command_future
153
154            finally:
155                self._send_command_req_id = None
156                self._send_command_future = None
async def interrogate_generic(self, asdu_address: int):
158    async def interrogate_generic(self, asdu_address: common.AsduAddress):
159        async with self._interrogate_generic_lock:
160            if not self.is_open:
161                raise ConnectionError()
162
163            return_identifier = next(self._next_req_ids)
164            asdu = iec103.ASDU(
165                type=iec103.AsduType.GENERIC_COMMAND,
166                cause=iec103.Cause.GENERAL_INTERROGATION,
167                address=asdu_address,
168                ios=[iec103.IO(
169                    address=iec103.IoAddress(
170                        function_type=_FunctionType.GENERIC_FUNCTION_TYPE.value,  # NOQA
171                        information_number=_InformationNumber.GENERAL_INTERROGATION_OF_GENERIC_DATA.value),  # NOQA
172                    elements=[iec103.IoElement_GENERIC_COMMAND(
173                        return_identifier=return_identifier,
174                        data=[])])])
175            data = self._encoder.encode_asdu(asdu)
176
177            try:
178                self._interrogate_generic_req_id = return_identifier
179                self._interrogate_generic_future = asyncio.Future()
180                await self._conn.send(data)
181                await self._interrogate_generic_future
182
183            finally:
184                self._interrogate_generic_req_id = None
185                self._interrogate_generic_future = None
Inherited Members
hat.aio.group.Resource
is_open
is_closing
is_closed
wait_closing
wait_closed
close
async_close