pysparkplug

Initialization code for Sparkplug B package

Summary

MULTI_LEVEL_WILDCARD	Constant for multi-level MQTT topic wildcard
SINGLE_LEVEL_WILDCARD	Constant for single-level MQTT topic wildcard
Client([client_id, protocol, username, ...])	Low-level MQTT client
ClientOptions([max_inflight_messages, ...])	Class of optional settings for an MQTT client
ConnackCode(value[, names, module, ...])	MQTT Connection Acknowledgement codes
DBirth(timestamp, seq, metrics)	Class representing a DBirth payload
DCmd(timestamp, metrics)	Class representing a DCmd payload
DData(timestamp, seq, metrics)	Class representing a DData payload
DDeath(timestamp, seq)	Class representing a DDeath payload
DataType(value[, names, module, qualname, ...])	Enumeration of Sparkplug B datatypes
Device(device_id, metrics[, cmd_callback])	Class representing a Device in Sparkplug B
EdgeNode(group_id, edge_node_id, metrics[, ...])	Class representing an EdgeNode in Sparkplug B
ErrorCode(value[, names, module, qualname, ...])	MQTT error codes
MQTTError	Error from MQTT client
MQTTProtocol(value[, names, module, ...])	MQTT protocol enum
Message(topic, payload, qos, retain)	Class representing a Sparkplug B message
MessageType(value[, names, module, ...])	Sparkplug B message type enum
Metadata([is_multipart, content_type, size, ...])	Class representing a Sparkplug B metric's metadata
Metric(timestamp, name, datatype[, ...])	Class representing a Sparkplug B metric
MetricValue	Type annotation for the types a Metric's value attribute can take
NBirth(timestamp, seq, metrics)	Class representing an NBirth payload
NCmd(timestamp, metrics)	Class representing an NCmd payload
NData(timestamp, seq, metrics)	Class representing an NData payload
NDeath(timestamp, bd_seq_metric)	Class representing an NDeath payload
QoS(value[, names, module, qualname, type, ...])	MQTT quality of service enum
State(timestamp, online)	Class representing a State payload
TLSConfig([ca_certs, certfile, keyfile, ...])	TLS configuration class
Topic([group_id, message_type, ...])	Class representing a Sparkplug B topic
Transport(value[, names, module, qualname, ...])	MQTT transport enum
WSConfig([path, headers])	Websockets configuration class
get_current_timestamp()	Returns current time in a Sparkplug B compliant format

Classes

class pysparkplug.Client(client_id=None, protocol=MQTTProtocol.MQTT_V311, username=None, password=None, transport_config=None, client_options=ClientOptions(max_inflight_messages=20, max_queued_messages=0, message_retry_timeout=5, reconnection_delay_min=1, reconnection_delay_max=120, reconnect_on_failure=True))

Low-level MQTT client

Parameters:

• client_id (str | None) – the unique client id string used when connecting to the broker

• protocol (MQTTProtocol) – the version of the MQTT protocol to use for this client

• username (str | None) – the username used for broker authentication

• password (str | None) – the password used for broker authentication

• transport_config (TLSConfig | WSConfig | None) – a config object defining the transport layer protocol the client will use to connect to the broker

• client_options (ClientOptions) – a config object defining various options for the client

connect(host, *, port=1883, keepalive=60, bind_address='', blocking=False, callback=None)

Connect client to the broker

Parameters:

• host (str) – the hostname or IP address of the remote broker

• port (int) – the port of the broker

• keepalive (int) – maximum period in seconds allowed between communications with the broker

• bind_address (str) – the IP address of a local network interface to bind this client to, assuming multiple interfaces exist

• blocking (bool) – whether or not to connect in a blocking way, or connect with a separate thread

• callback (Callable[[Self], None] | None) – a custom callback to be called each time the client successfully connects

Return type:

None

disconnect()

Disconnect from the broker cleanly, i.e. results in no will message being sent by the broker.

Return type:

None

publish(message, *, include_dtypes=False)

Publish a message to the broker

Parameters:

• message (Message) – the message to be published

• include_dtypes (bool) – whether or not to include the dtypes of the message

Return type:

None

set_will(message)

Set the last will & testament for the specified message

Parameters:

message (Message | None) – the message to be registered with the broker, or None, which clears the will

Return type:

None

subscribe(topic, qos, callback)

Subscribe to the specified topic

Parameters:

• topic (Topic) – the topic to be subscribed to

• qos (QoS) – the qos of the subscription

• callback (Callable[[Self, Message], None]) – the callback to run when messages are received for this subscription

Return type:

None

unsubscribe(topic)

Unsubscribe from the specified topic

Parameters:

topic (Topic) – the topic to be subscribed to

Return type:

None

class pysparkplug.ClientOptions(max_inflight_messages=20, max_queued_messages=0, message_retry_timeout=5, reconnection_delay_min=1, reconnection_delay_max=120, reconnect_on_failure=True)

Class of optional settings for an MQTT client

Parameters:

• max_inflight_messages (int) – maximum number of messages with QoS>0 that can be part way through their network flow at once. Increasing this value will consume more memory but can increase throughput.

• max_queued_messages (int) – maximum number of outgoing messages with QoS>0 that can be pending in the outgoing message queue. 0 means unlimited, but due to implementation currently limited to 65555 (65535 messages in queue + 20 in flight). When the queue is full, any further outgoing messages would be dropped.

• message_retry_timeout (int) – time in seconds before a message with QoS>0 is retried, if the broker does not respond. This is set to 5 seconds by default and should not normally need changing.

• reconnection_delay_min (int) – when the connection is lost, the client will automatically retry connection. Initially, the attempt is delayed of min_delay seconds. It’s doubled between subsequent attempts up to reconnection_delay_max.

• reconnection_delay_max (int) – see reconnection_delay_min.

• reconnect_on_failure (bool) – whether or not to reconnect the client on failure

Returns:

a ClientOptions object

max_inflight_messages: int = 20

max_queued_messages: int = 0

message_retry_timeout: int = 5

reconnect_on_failure: bool = True

reconnection_delay_max: int = 120

reconnection_delay_min: int = 1

class pysparkplug.ConnackCode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

MQTT Connection Acknowledgement codes

CONNACK_ACCEPTED = 0

CONNACK_REFUSED_BAD_USERNAME_PASSWORD = 4

CONNACK_REFUSED_IDENTIFIER_REJECTED = 2

CONNACK_REFUSED_NOT_AUTHORIZED = 5

CONNACK_REFUSED_PROTOCOL_VERSION = 1

CONNACK_REFUSED_SERVER_UNAVAILABLE = 3

class pysparkplug.DBirth(timestamp, seq, metrics)

Class representing a DBirth payload

Parameters:

• timestamp (int) – timestamp at message sending time

• seq (int) – sequence number

• metrics (tuple[Metric, ...]) – metrics associated with this payload

class pysparkplug.DCmd(timestamp, metrics)

Class representing a DCmd payload

Parameters:

• timestamp (int) – timestamp at message sending time

• metrics (tuple[Metric, ...]) – metrics associated with this payload

class pysparkplug.DData(timestamp, seq, metrics)

Class representing a DData payload

Parameters:

• timestamp (int) – timestamp at message sending time

• seq (int) – sequence number

• metrics (tuple[Metric, ...]) – metrics associated with this payload

class pysparkplug.DDeath(timestamp, seq)

Class representing a DDeath payload

Parameters:

• timestamp (int) – timestamp at message sending time

• seq (int) – sequence number

classmethod decode(raw, *, birth=None)

Construct a DDeath object from bytes

Parameters:

• raw (bytes) – bytes to decode into a DDeath object

• birth (Birth | None) – unused input since DDeaths don’t have any metrics

Returns:

DDeath object

Return type:

Self

encode(*, include_dtypes=False)

Encode DDeath object into bytes

Parameters:

include_dtypes (bool) – unused input since DDeaths have no metrics

Returns:

encoded payload in bytes

Return type:

bytes

seq: int

timestamp: int

class pysparkplug.DataType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Enumeration of Sparkplug B datatypes

BOOLEAN = 11

BOOLEAN_ARRAY = 32

BYTES = 17

DATASET = 16

Unsupported

DATETIME = 13

DATETIME_ARRAY = 34

DOUBLE = 10

DOUBLE_ARRAY = 31

FILE = 18

FLOAT = 9

FLOAT_ARRAY = 30

INT16 = 2

INT16_ARRAY = 23

INT32 = 3

INT32_ARRAY = 24

INT64 = 4

INT64_ARRAY = 25

INT8 = 1

INT8_ARRAY = 22

PROPERTYSET = 20

Unsupported

PROPERTYSETLIST = 21

Unsupported

STRING = 12

STRING_ARRAY = 33

TEMPLATE = 19

Unsupported

TEXT = 14

UINT16 = 6

UINT16_ARRAY = 27

UINT32 = 7

UINT32_ARRAY = 28

UINT64 = 8

UINT64_ARRAY = 29

UINT8 = 5

UINT8_ARRAY = 26

UNKNOWN = 0

UUID = 15

decode(value)

Decode a value from the form it takes in a Sparkplug B Protobuf object

Parameters:

value (int | float | bool | str | bytes)

Return type:

int | float | bool | str | bytes | datetime | tuple[int, …] | tuple[float, …] | tuple[bool, …] | tuple[str, …] | tuple[datetime, …]

encode(value)

Encode a value into the form it should take in a Sparkplug B Protobuf object

Parameters:

value (int | float | bool | str | bytes | datetime | tuple[int, ...] | tuple[float, ...] | tuple[bool, ...] | tuple[str, ...] | tuple[datetime, ...])

Return type:

int | float | bool | str | bytes

property field: str

The Protobuf field the data is encoded in

class pysparkplug.Device(device_id, metrics, cmd_callback=<function _default_cmd_callback>)

Class representing a Device in Sparkplug B

Parameters:

• device_id (str) – the device_id element of the Sparkplug topic namespace identifies a device attached (physically or logically) to the Sparkplug Edge Node

• metrics (Iterable[Metric]) – the metrics associated with this device

• cmd_callback (Callable[[EdgeNode, Message], None]) – the callback function to execute when a DCMD payload is received

cmd_callback: Callable[[EdgeNode, Message], None]

device_id: str

property metrics: dict[str, Metric]

Returns a copy of the metrics for this edge node in a dictionary

update(metrics)

Update some (or all) of the device’s metrics

Parameters:

metrics (Iterable[Metric]) – an iterable of metrics to be updated

Return type:

None

class pysparkplug.EdgeNode(group_id, edge_node_id, metrics, client=None, cmd_callback=<function _default_cmd_callback>)

Class representing an EdgeNode in Sparkplug B

Parameters:

• group_id (str) – the Group ID element of the topic namespace provides for a logical grouping of Sparkplug Edge Nodes into the MQTT Server and back out to the consuming Sparkplug Host Applications

• edge_node_id (str) – the edge_node_id element of the Sparkplug topic namespace uniquely identifies the Sparkplug Edge Node within the infrastructure

• metrics (Iterable[Metric]) – the metrics associated with this edge node

• client (Optional[Client]) – the low-level MQTT client used by this edge node for connecting to the broker

• cmd_callback (Callable[[Self, Message], None]) – the callback function to execute when an NCMD payload is received

connect(host, *, port=1883, keepalive=60, bind_address='', blocking=False)

Connect edge node to the broker

Parameters:

• host (str) – the hostname or IP address of the remote broker

• port (int) – the port of the broker

• keepalive (int) – maximum period in seconds allowed between communications with the broker

• bind_address (str) – the IP address of a local network interface to bind this client to, assuming multiple interfaces exist

• blocking (bool) – whether or not to connect in a blocking way, or connect with a separate thread

Return type:

None

deregister(device_id)

Remove a device from the edge node, sending a DDeath if the edge node is online.

Parameters:

device_id (str) – the id of the device to be deregistered

Return type:

None

property devices: dict[str, Device]

Returns a copy of the devices for this edge node in a dictionary

disconnect()

Disconnect from the broker cleanly.

Return type:

None

edge_node_id: str

group_id: str

property metrics: dict[str, Metric]

Returns a copy of the metrics for this edge node in a dictionary

register(device)

Register a device to the edge node, can be run while edge node is connected

Parameters:

device (Device) – the device to register to the edge node

Return type:

None

subscribe(topic, qos, callback)

Subscribe to the specified topic

Parameters:

• topic (Topic) – the topic to be subscribed to

• qos (QoS) – the qos of the subscription

• callback (Callable[[Self, Message], None]) – the callback to run when messages are received for this subscription

Return type:

None

unsubscribe(topic)

Unsubscribe from the specified topic

Parameters:

topic (Topic) – the topic to be subscribed to

Return type:

None

update(metrics)

Update some (or all) of the edge node’s metrics

Parameters:

metrics (Iterable[Metric]) – an iterable of metrics to be updated

Return type:

None

update_device(device_id, metrics)

Update some (or all) of the metrics associated with the provided device_id

Parameters:

• device_id (str) – the id of the device to be updated

• metrics (Iterable[Metric]) – an iterable of metrics to be updated

Return type:

None

class pysparkplug.ErrorCode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

MQTT error codes

ACL_DENIED = 12

AGAIN = -1

AUTH = 11

CONN_LOST = 7

CONN_REFUSED = 5

ERRNO = 14

INVAL = 3

KEEPALIVE = 16

NOMEM = 1

NOT_FOUND = 6

NOT_SUPPORTED = 10

NO_CONN = 4

PAYLOAD_SIZE = 9

PROTOCOL = 2

QUEUE_SIZE = 15

SUCCESS = 0

TLS = 8

UNKNOWN = 13

class pysparkplug.MQTTProtocol(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

MQTT protocol enum

MQTT_V31 = 3

MQTT_V311 = 4

MQTT_V5 = 5

class pysparkplug.Message(topic, payload, qos, retain)

Class representing a Sparkplug B message

Parameters:

• topic (Topic) – the Sparkplug B topic associated with this message

• payload (Payload) – the Sparkplug B payload associated with this message

• qos (QoS) – the MQTT quality of service associated with this message

• retain (bool) – if set to True, the message will be set as the “last known good”/retained message for the topic

classmethod from_mqtt_message(mqtt_message, *, birth=None)

Constructs a Message object from a Paho MQTTMessage object

Parameters:

• mqtt_message (MQTTMessage) – the Paho MQTTMessage object to construct from

• birth (Birth | None) – the Birth object associated with this message, for decoding aliases and dropped dtypes

Return type:

Self

payload: Payload

qos: QoS

retain: bool

topic: Topic

class pysparkplug.MessageType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Sparkplug B message type enum

DBIRTH = 'DBIRTH'

DCMD = 'DCMD'

DDATA = 'DDATA'

DDEATH = 'DDEATH'

NBIRTH = 'NBIRTH'

NCMD = 'NCMD'

NDATA = 'NDATA'

NDEATH = 'NDEATH'

STATE = 'STATE'

property payload: type

Returns the payload class for this message type

class pysparkplug.Metadata(is_multipart=None, content_type=None, size=None, seq=None, file_name=None, file_type=None, md5=None, description=None)

Class representing a Sparkplug B metric’s metadata

Parameters:

• is_multipart (bool | None) – whether this metric contains part of a multi-part message

• content_type (str | None) – the content type of a given metric value if applicable

• size (int | None) – the size of the metric value

• seq (int | None) – the sequence number of this part of a multipart metric

• file_name (str | None) – the filename of the file

• file_type (str | None) – the type of the file

• md5 (str | None) – md5sum of the byte array or file

• description (str | None) – any other pertinent metadata for this metric

content_type: str | None = None

description: str | None = None

file_name: str | None = None

file_type: str | None = None

classmethod from_pb(metadata)

Constructs a Metadata object from a Protobuf metadata

Parameters:

metadata (MetaData) – the Protobuf metadata to construct from

Returns:

a Metadata object

Return type:

Self

is_multipart: bool | None = None

md5: str | None = None

seq: int | None = None

size: int | None = None

to_pb()

Returns a Protobuf Metric’s Metadata

Return type:

MetaData

class pysparkplug.Metric(timestamp, name, datatype, metadata=None, value=None, alias=None, is_historical=False, is_transient=False, is_null=False)

Class representing a Sparkplug B metric

Parameters:

• timestamp (int | None) – timestamp associated with data acquisition time

• name (str | None) – name associated with this metric

• datatype (DataType) – datatype associated with this metric

• value (int | float | bool | str | bytes | datetime | tuple[int, ...] | tuple[float, ...] | tuple[bool, ...] | tuple[str, ...] | tuple[datetime, ...] | None) – the value of the metric

• alias (int | None) – an integer used to map to the metric’s name

• is_historical (bool) – if this is historical data and should not update real time tag

• is_transient (bool) – tells consuming clients such as MQTT Engine to not store this as a tag

• is_null (bool) – if this is null - explicitly say so rather than using -1, false, etc

• metadata (Metadata | None) – optional metadata for this metric

alias: int | None = None

datatype: DataType

classmethod from_pb(metric)

Constructs a Metric object from a Protobuf metric

Parameters:

metric (Metric) – the Protobuf metric to construct from

Returns:

a Metric object

Return type:

Self

is_historical: bool = False

is_null: bool = False

is_transient: bool = False

metadata: Metadata | None = None

name: str | None

timestamp: int | None

to_pb(include_dtype)

Returns a Protobuf metric

Parameters:

include_dtype (bool) – whether or not to include dtypes in the Protobuf metric

Return type:

Metric

value: int | float | bool | str | bytes | datetime | tuple[int, ...] | tuple[float, ...] | tuple[bool, ...] | tuple[str, ...] | tuple[datetime, ...] | None = None

class pysparkplug.NBirth(timestamp, seq, metrics)

Class representing an NBirth payload

Parameters:

• timestamp (int) – timestamp at message sending time

• seq (int) – sequence number

• metrics (tuple[Metric, ...]) – metrics associated with this payload

class pysparkplug.NCmd(timestamp, metrics)

Class representing an NCmd payload

Parameters:

• timestamp (int) – timestamp at message sending time

• metrics (tuple[Metric, ...]) – metrics associated with this payload

class pysparkplug.NData(timestamp, seq, metrics)

Class representing an NData payload

Parameters:

• timestamp (int) – timestamp at message sending time

• seq (int) – sequence number

• metrics (tuple[Metric, ...]) – metrics associated with this payload

class pysparkplug.NDeath(timestamp, bd_seq_metric)

Class representing an NDeath payload

Parameters:

• timestamp (int | None) – timestamp at message sending time

• bd_seq_metric (Metric) – birth death sequence number metric

bd_seq_metric: Metric

classmethod decode(raw, *, birth=None)

Construct an NDeath object from bytes

Parameters:

• raw (bytes) – bytes to decode into a NDeath object

• birth (Birth | None) – unused input since NDeaths don’t have any metrics with aliases or dropped dtypes

Returns:

NDeath object

Return type:

Self

encode(*, include_dtypes=False)

Encode NDeath object into bytes

Parameters:

include_dtypes (bool) – whether or not to include dtypes

Returns:

encoded payload in bytes

Return type:

bytes

timestamp: int | None

class pysparkplug.QoS(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

MQTT quality of service enum

AT_LEAST_ONCE = 1

AT_MOST_ONCE = 0

EXACTLY_ONCE = 2

class pysparkplug.State(timestamp, online)

Class representing a State payload

Parameters:

• timestamp (int) – timestamp at message sending time

• online (bool) – whether or not the primary host application is online

classmethod decode(raw, *, birth=None)

Construct a State object from bytes

Parameters:

• raw (bytes) – bytes to decode into a Payload object

• birth (Birth | None) – unused input since States don’t have any metrics

Returns:

State object

Return type:

Self

encode(*, include_dtypes=False)

Encode State object into bytes

Parameters:

include_dtypes (bool) – unused input since States have no metrics

Returns:

encoded payload in bytes

Return type:

bytes

online: bool

timestamp: int

class pysparkplug.TLSConfig(ca_certs=None, certfile=None, keyfile=None, cert_reqs=VerifyMode.CERT_REQUIRED, tls_version=_SSLMethod.PROTOCOL_TLS, ciphers=None)

TLS configuration class

Parameters:

• ca_certs (str | None) – a string path to the Certificate Authority certificate files that are to be treated as trusted by this client. If this is the only option given then the client will operate in a similar manner to a web browser. That is to say it will require the broker to have a certificate signed by the Certificate Authorities in ca_certs and will communicate using TLS v1.2, but will not attempt any form of authentication. This provides basic network encryption but may not be sufficient depending on how the broker is configured.

• certfile (str | None) – string pointing to the PEM encoded client certificate. If this argument is not None then it will be used as client information for TLS based authentication. Support for this feature is broker dependent. Note that if this file is encrypted and needs a password to decrypt it, Python will ask for the password at the command line. It is not currently possible to define a callback to provide the password.

• keyfile (str | None) – string pointing to the PEM encoded private keys. If this argument is not None then it will be used as client information for TLS based authentication. Support for this feature is broker dependent. Note that if this file is encrypted and needs a password to decrypt it, Python will ask for the password at the command line. It is not currently possible to define a callback to provide the password.

• cert_reqs (VerifyMode) – defines the certificate requirements that the client imposes on the broker. By default this is ssl.CERT_REQUIRED, which means that the broker must provide a certificate. See the ssl pydoc for more information on this parameter.

• tls_version (_SSLMethod) – specifies the version of the SSL/TLS protocol to be used. By default (if the python version supports it) the highest TLS version is detected. If unavailable, TLS v1.2 is used. Previous versions (all versions beginning with SSL) are possible but not recommended due to possible security problems.

• ciphers (str | None) – a string specifying which encryption ciphers are allowable for this connection, or None to use the defaults. See the ssl pydoc for more information.

Returns:

a TLSConfig object

ca_certs: str | None = None

cert_reqs: VerifyMode = 2

certfile: str | None = None

ciphers: str | None = None

keyfile: str | None = None

tls_version: _SSLMethod = 2

class pysparkplug.Topic(group_id=None, message_type=None, edge_node_id=None, device_id=None, sparkplug_host_id=None)

Class representing a Sparkplug B topic

Parameters:

• group_id (str | None) – the Group ID element of the topic namespace provides for a logical grouping of Sparkplug Edge Nodes into the MQTT Server and back out to the consuming Sparkplug Host Applications

• message_type (MessageType | Literal['+'] | ~typing.Literal['#'] | None) – the message_type element of the topic namespace provides an indication as to how to handle the MQTT payload of the message

• edge_node_id (str | None) – the edge_node_id element of the Sparkplug topic namespace uniquely identifies the Sparkplug Edge Node within the infrastructure

• device_id (str | None) – the device_id element of the Sparkplug topic namespace identifies a device attached (physically or logically) to the Sparkplug Edge Node

• sparkplug_host_id (str | None) – the unique identifier of the Sparkplug Host Application

device_id: str | None = None

edge_node_id: str | None = None

classmethod from_str(topic)

Construct a Topic object from a topic string

Parameters:

topic (str) – the Sparkplug B topic in raw string form

Returns:

a Topic object

Return type:

Self

group_id: str | None = None

message_type: MessageType | Literal['+'] | Literal['#'] | None = None

namespace = 'spBv1.0'

sparkplug_host_id: str | None = None

class pysparkplug.Transport(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

MQTT transport enum

TCP = 'tcp'

WS = 'websockets'

class pysparkplug.WSConfig(path='/mqtt', headers=None)

Websockets configuration class

Parameters:

• path (str) – the mqtt path to use on the broker.

• headers (dict[str, Any] | Callable[[dict[str, Any]], dict[str, Any]] | None) – either a dictionary specifying a list of extra headers which should be appended to the standard websocket headers, or a callable that takes the normal websocket headers and returns a new dictionary with a set of headers to connect to the broker.

Returns:

a WSConfig object

headers: dict[str, Any] | Callable[[dict[str, Any]], dict[str, Any]] | None = None

path: str = '/mqtt'

Functions

pysparkplug.get_current_timestamp()

Returns current time in a Sparkplug B compliant format

Return type:

int

Module Attributes

pysparkplug.MULTI_LEVEL_WILDCARD = '#'

Constant for multi-level MQTT topic wildcard

Uses type annotation for compatibility with Topic objects.

Added in version 0.2.0.

pysparkplug.MetricValue

Type annotation for the types a Metric’s value attribute can take

alias of int | float | bool | str | bytes | datetime | tuple[int, …] | tuple[float, …] | tuple[bool, …] | tuple[str, …] | tuple[datetime, …]

pysparkplug.SINGLE_LEVEL_WILDCARD = '+'

Constant for single-level MQTT topic wildcard

Uses type annotation for compatibility with Topic objects.

Added in version 0.2.0.

Exceptions

exception pysparkplug.MQTTError

Error from MQTT client