mwings.parsers.app_pal_openclose Module

Parsers for packets sent from PAL App (Open/Close PAL) and data structures to store their contents.

src/mwings/parsers/app_pal_openclose.py

`PacketParser`

Static class parser that interprets packets representing data sent from PAL App (Open/Close PAL).

Inherits from: common.PacketParserBase

The members inherited from the base class are listed.

`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`	Data of type `ParsedPacket`	Parsed data
	`None`	Parsing failed

`ParsedPacket`

Structure to store the result of parsing packets representing data sent from PAL App (Open/Close PAL).

Inherits from: common.ParsedPacketBase

Members inherited from the base class are also listed.

`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, ai1_voltage=0, magnet_state=MagnetState.NOT_DETECTED, magnet_state_changed=False)

Parameters

Properties inherited from the base class are also listed.

Name	Type	Description
`time_parsed`	`optional AwareDatetime`	Parsing time
`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)
`router_serial_id`	`common.UInt32`	Serial ID of the first relay device (0x80000000 if none) `v1.0.13+`
`ai1_voltage`	`common.UInt16`	Voltage of `AI1` (mV)
`magnet_state`	`common.MagnetState`	Magnet state
`magnet_state_changed`	`bool`	Whether the magnet state has changed

You can also pass a dictionary unpacked with **.

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

Name	Type	Description
`mwings_implementation`	`str`	MWings implementation (`"python"` only)
`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 the value range
- check_source_logical_id(lid)
time_parsed: Automatically validates that a timezone is attached
- datetime_must_be_clear(dt)

Applicable field_serializer

packet_type: Serializes enum name directly 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)
magnet_state: Serializes enum name directly for JSON etc.
- serialize_magnet_state(magnet_state)

`to_df()`

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

Converts the parsed data into a pandas DataFrame.

Parameters

Name	Type	Description
`include`	`optional set[str]`	Set of columns (members) to include in DataFrame
`exclude`	`optional set[str]`	Set of columns (members) to exclude from 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 the parsed data into 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 by keys

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 the parsed data into JSON format.

Parameters

Name	Type	Description
`include`	`optional set[str]`	Set of keys (members) to include in JSON
`exclude`	`optional set[str]`	Set of keys (members) to exclude from 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 by keys

Returns

Type	Value	Description
`str`	-	Converted JSON string

`model_*()`

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