mwings module

mwings

This is a top-level module that is often used directly.

src/mwings/__init__.py

`Twelite`

Interface for TWELITE

Inherits: threading.Thread

`Twelite()`

Twelite(port=None, rx_buffer_size=1024, timeout=100, tz=None, debugging=False)

Constructor. If a serial port is specified, it will be opened.

Parameters

Name	Type	Description
`port`	`optional str`	Serial port name: disabled if `None`
`rx_buffer_size`	`int`	Size of the receive buffer in bytes
`timeout`	`int`	Timeout between receiving packets (ms)
`tz`	`optional tzinfo`	Timezone applied to received data: UTC if `None`
`debugging`	`bool`	Debug output: enabled if `True`

Exceptions

IOError Serial port does not exist or is busy

`close()`

v1.0.10+

close()

Closes the serial port if it is open.

Usually, opened serial ports are automatically closed without calling close().

If you wish to close it explicitly, use this function or a with statement.

Parameters

None

Return value

None

`add_listener()`

@overload
add_listener(event, handler)
add_listener(event, handler)

Registers a receive handler.

Parameters

Name	Type	Description
`event`	`common.PacketType`	Identifier for the receive event
`handler`	`Callable[[common.BarePacket], None]`	Handler for the receive event (raw data)
	`Callable[[common.SomeCallable], None]`	Handler for the receive event (parsed data)

Return value

None

`on()`

on(event)

Registers a receive handler (decorator version).

Parameters

Name	Type	Description
`event`	`common.PacketType`	Identifier for the receive event

Return value

Type	Value	Description
`Callable[[common.SomeCallable], common.SomeCallable]`	-	Decorated function

`remove_all_listeners()`

v1.0.9+

remove_all_listeners()

Removes all registered receive handlers.

Parameters

None

Return value

None

`parse()`

@overload
parse(character, use_lf=False)
parse(character, use_lf=False)
parse(character, use_lf=False)

Parses the given received data.

Parameters

Name	Type	Description
`character`	`str`	Received data character: string of length 1
	`bytes`	Received data character: bytes of length 1
	`int`	Received data character: ASCII code
`use_lf`	`bool`	Type of newline character: LF if `True`

Return value

Type	Value	Description
`optional common.PacketType`	`common.PacketType`	Parsed packet type
	`None`	No parsed packet

Exceptions

RuntimeError Serial port is specified
ValueError Invalid character data detected

`parse_line()`

parse_line(line, use_lf=True)

Parses received data expressed as a single line string.

Parameters

Name	Type	Description
`line`	`str`	Received data string: a single line
`use_lf`	`bool`	Type of newline character: LF if `True`

Return value

Type	Value	Description
`optional common.PacketType`	`common.PacketType`	Parsed packet type
	`None`	No parsed packet

Exceptions

RuntimeError Serial port is specified

`receive()`

receive()

Parses data received on the serial port. Waits until the interpretation of one packet is complete.

This is a function for verification purposes. It blocks processing until a parsable packet is received, so it is not very practical.

Parameters

None

Return value

Type	Value	Description
`common.PacketType`	-	Parsed packet type

Exceptions

RuntimeError Serial port is not specified

`run()`

run()

Runs a subthread that performs reception. Overrides threading.Thread.run().

Do not call this method directly. It is automatically called when using start().

Parameters

None

Return value

None

`send()`

@overload
send(data)
send(data)

Sends commands from the serial port.

Parameters

Name	Type	Description
`data`	`common.SomeCommand`	Various command data
	`common.BarePacket`	Raw command data

Return value

Type	Value	Description
`bool`	`True`	Success
	`False`	Failure

Exceptions

RuntimeError Serial port is not specified

`set_timezone()`

set_timezone(tz)

Sets the timezone applied to received data.

Parameters

Name	Type	Description
`tz`	`tzinfo`	Any timezone: `ZoneInfo`
	`None`	UTC

Return value

None

`start()`

start()

Starts a subthread that performs reception. Overrides threading.Thread.start().

Parameters

None

Return value

None

Exceptions

RuntimeError Serial port is not specified

`stop()`

stop()

Stops the subthread that performs reception. Waits until handler calls for remaining received data are finished. This may take several seconds.

Parameters

None

Return value

None

Exceptions

RuntimeError Serial port is not specified

`update()`

update()

Parses data received on the serial port. Processes all data in the receive buffer and then immediately returns.

Parameters

None

Return value

Type	Value	Description
`optional common.PacketType`	`common.PacketType`	Parsed packet type
	`None`	No parsed packet

Exceptions

RuntimeError Serial port is not specified

`timezone`

@property
update()

Return value

Type	Value	Description
`tzinfo`	-	Timezone applied to received data

mwings.common Module

Stores data and procedures used throughout the library.

mwings.parsers Module

Parsers for interpreting packets and handling their data.

mwings.serializers Module

Serializers to generate commands and data structures to handle them.

mwings.utils Module

mwings.utils