iotcs.message module¶

class iotcs.message.AlertMessage(format=None, items=None, description=None, severity=<Severity.SIGNIFICANT: 2>, msgId=None, source=None, destination=None, clientId=None, reliability=<Reliability.GUARANTEED_DELIVERY: 3>, priority=<Priority.HIGHEST: 4>, properties=None, diagnostics=None, eventTime=None, sender=None, direction=None, receivedTime=None, sentTime=None)¶

Bases: iotcs.message.Message

AlertMessage extends Message class. It can be used for sending alert data to IoT Server.

Construct an AlertMessage. See Message for description of Message paraemters AlertMessage parameters format: the URN of the message format in the data model. items: one or more DataItems to be included in the message severity: defaults to Severity.SIGNIFICANT

Raises:	ValueError if format is None

class Encoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)¶

Bases: iotcs.message.Encoder

An encoder for encoding a AlertMessage to JSON

Constructor for JSONEncoder, with sensible defaults.

If skipkeys is false, then it is a TypeError to attempt encoding of keys that are not str, int, float or None. If skipkeys is True, such items are simply skipped.

If ensure_ascii is true, the output is guaranteed to be str objects with all incoming non-ASCII characters escaped. If ensure_ascii is false, the output can contain non-ASCII characters.

If check_circular is true, then lists, dicts, and custom encoded objects will be checked for circular references during encoding to prevent an infinite recursion (which would cause an OverflowError). Otherwise, no such check takes place.

If allow_nan is true, then NaN, Infinity, and -Infinity will be encoded as such. This behavior is not JSON specification compliant, but is consistent with most JavaScript based encoders and decoders. Otherwise, it will be a ValueError to encode such floats.

If sort_keys is true, then the output of dictionaries will be sorted by key; this is useful for regression tests to ensure that JSON serializations can be compared on a day-to-day basis.

If indent is a non-negative integer, then JSON array elements and object members will be pretty-printed with that indent level. An indent level of 0 will only insert newlines. None is the most compact representation.

If specified, separators should be an (item_separator, key_separator) tuple. The default is (‘, ‘, ‘: ‘) if indent is None and (‘,’, ‘: ‘) otherwise. To get the most compact JSON representation, you should specify (‘,’, ‘:’) to eliminate whitespace.

If specified, default is a function that gets called for objects that can’t otherwise be serialized. It should return a JSON encodable version of the object or raise a TypeError.

encode(o)¶

Return a JSON string representation of a Python data structure.

>>> from json.encoder import JSONEncoder
>>> JSONEncoder().encode({"foo": ["bar", "baz"]})
'{"foo": ["bar", "baz"]}'

class Severity¶

Bases: enum.Enum

The AlertMessage severity, one of LOW, NORMAL, SIGNIFICANT, CRITICAL

CRITICAL = 1¶

LOW = 4¶

NORMAL = 3¶

SIGNIFICANT = 2¶

dataItem(key, value)¶

description¶

format¶

fromJson(jsonObject)¶: Set values in this instance from the jsonObject Typical use case Message().fromJson(jsonObject) :param jsonObject:

getDataItems()¶: Get message payload as {@link List} of {@link DataItem}s. :return: Payload that is carried by {@link AlertMessage}, never {@code null}.

getDescription()¶: Gets the description for this alert. :return: the description for this alert.

getFormat()¶: Get the name of the format for data. :return: data format, never {@code null}.

getSeverity()¶: Gets the severity of this alert :return: the severity of this alert

getType()¶

items¶

setDescription(description)¶

setFormat(format)¶

setSeverity(severity)¶

setSource(source)¶

severity¶

toJson()¶

Returns:

class iotcs.message.DataItem(key, value)¶

Bases: object

DataItem is a key/value pair for data in DataMessage.

Construct a DataItem. key: the name of the attribute or field value: the value of the attribute or field

class Type¶

Bases: enum.Enum

An enumeration.

BOOLEAN = 2¶

DOUBLE = 1¶

STRING = 0¶

getKey()¶

getValue()¶

key¶

value¶

class iotcs.message.DataMessage(format=None, items=None, msgId=None, source=None, destination=None, clientId=None, reliability=<Reliability.BEST_EFFORT: 2>, priority=None, properties=None, diagnostics=None, eventTime=None, sender=None, direction=<Direction.FROM_DEVICE: 0>, receivedTime=None, sentTime=None)¶

Bases: iotcs.message.Message

DataMessage extends Message class. It can be used for sending sensor data to IoT Server.

Return a DataMessage.

Parameters:	format – items – list of iotcs.shared.message.DataItem msgId – source – destination – clientId – reliability – priority – properties – diagnostics – eventTime – sender – direction – receivedTime – sentTime –