/ 日本語

mwings.parsers.app_twelite Module

Parsers for packets sent from the Standard App (App_TWELITE) and data structures to store their contents.

Parsers for packets sent from the Extremely simple! Standard App (App_Twelite) and data structures to handle the data.

src/mwings/parsers/app_twelite.py

`PacketParser`

A static class parser that interprets packets representing data sent from the Extremely simple! Standard App.

Inherits: common.PacketParserBase

Lists members inherited from the base class.

`is_valid()`

is_valid(bare_packet)

Checks whether the given raw packet is valid.

Parameters

Name	Type	Description
`bare_packet`	`common.BarePacket`	Raw packet data

Returns

Type	Value	Description
`bool`	`True`	Valid, parsable
	`False`	Invalid, not parsable

`parse()`

parse(bare_packet)

Parses the given raw packet.

Parameters

Name	Type	Description
`bare_packet`	`common.BarePacket`	Raw packet data

Returns

Type	Value	Description
`optional ParsedPacket`	`ParsedPacket` instance	Parsed data
	`None`	Parsing failed

`ParsedPacket`

A structure to store the result of parsing packets representing data sent from the Extremely simple! Standard App.

Inherits: common.ParsedPacketBase

Also lists members inherited from the base class.

`ParsedPacket()`

ParsedPacket(*, time_parsed=None, packet_type=PacketType.BARE, sequence_number=None, source_serial_id=0, source_logical_id=0, lqi=None, supply_voltage=None, destination_logical_id=120, relay_count=0, periodic=False, di_changed=<mwings.common.CrossSectional object>, di_state=<mwings.common.CrossSectional object>, ai_voltage=<mwings.common.CrossSectional object>)

Parameters

Name	Type	Description
`time_parsed`	`optional AwareDatetime`	Parsing timestamp
`packet_type`	`common.PacketType`	Packet type
`sequence_number`	`optional common.UInt16`	Sequence number
`source_serial_id`	`common.UInt32`	Source serial ID
`source_logical_id`	`common.UInt8`	Source logical device ID
`lqi`	`optional common.UInt8`	Radio communication quality
`supply_voltage`	`optional common.UInt16`	Supply voltage (mV)
`destination_logical_id`	`common.UInt8`	Destination logical device ID
`relay_count`	`common.UInt8`	Relay count
`periodic`	`bool`	Whether periodic transmission
`di_changed`	`common.CrossSectional[bool](4)`	Digital interface change presence
`di_state`	`common.CrossSectional[bool](4)`	Digital interface state
`ai_voltage`	`common.CrossSectional[common.UInt16](4)`	Analog interface voltages

You can also pass a dictionary unpacked with **.

In addition to the variables specified as constructor arguments, the following @computed_field are available.

Name	Type	Description
`mwings_implementation`	`str`	MWings implementation (only `"python"`)
`mwings_version`	`str`	MWings version (PEP440 format)
`hostname`	`str`	Host machine name
`system_type`	`str`	System type (e.g., `"Linux"`)

Applicable field_validator

source_logical_id: Automatically validates value range
- check_source_logical_id(lid)
time_parsed: Automatically validates that timezone is attached
- datetime_must_be_clear(dt)
ai_voltage: Automatically validates value range
- check_ai_voltage(aiv)
destination_logical_id: Automatically validates value range
- check_destination_logical_id(lid)

Applicable field_serializer

packet_type: Serializes enum name as is for JSON etc.
- serialize_packet_type(packet_type)
source_serial_id: Serializes as hexadecimal string for JSON etc.
- serialize_source_serial_id(source_serial_id)
time_parsed: Serializes as ISO 8601 string for JSON etc.
- serialize_time_parsed(dt)

`to_df()`

to_df(include=None, exclude=None, verbose=True)

Converts parsed data to a pandas DataFrame.

Parameters

Name	Type	Description
`include`	`optional set[str]`	Set of columns (members) to include in the DataFrame
`exclude`	`optional set[str]`	Set of columns (members) to exclude from the DataFrame
`verbose`	`bool`	Whether to include system information (only when other args are `None`)

Returns

Type	Value	Description
`pd.DataFrame`	-	Converted DataFrame

Exceptions

EnvironmentError if pandas is not installed

`to_dict()`

to_dict(include=None, exclude=None, verbose=True, spread=False, sort_keys=False)

Converts parsed data to a dictionary.

Parameters

Name	Type	Description
`include`	`optional set[str]`	Set of keys (members) to include in the dictionary
`exclude`	`optional set[str]`	Set of keys (members) to exclude from the dictionary
`verbose`	`bool`	Whether to include system information (only when other args are `None`)
`spread`	`bool`	Whether to split non-time-series list-like data
`sort_keys`	`bool`	Whether to sort keys

Setting spread splits common.CrossSectional[T] type data.

Returns

Type	Value	Description
`dict[str, Any]`	-	Converted dictionary

`to_json()`

to_json(include=None, exclude=None, verbose=True, spread=False, indent=2, sort_keys=False)

Converts parsed data to JSON format.

Parameters

Name	Type	Description
`include`	`optional set[str]`	Set of keys (members) to include in the JSON
`exclude`	`optional set[str]`	Set of keys (members) to exclude from the JSON
`verbose`	`bool`	Whether to include system information (only when other args are `None`)
`spread`	`bool`	Whether to split non-time-series list-like data
`indent`	`optional int`	Number of spaces for indentation (`None` for no newline)
`sort_keys`	`bool`	Whether to sort keys

Setting spread splits common.CrossSectional[T] type data.

Returns

Type	Value	Description
`str`	-	Converted JSON string

`model_*()`

In addition, you can use various methods of pydantic.BaseModel.