mqttcloudproviderslib package¶

Submodules¶

mqttcloudproviderslib.mqttcloudproviderslib module¶

Main code for mqttcloudproviderslib.

class mqttcloudproviderslib.mqttcloudproviderslib.AwsAdapter(device_name, endpoint, certificate, private_key, certificate_authority='AmazonRootCA1.pem', port=443, protocol='x-amzn-mqtt-ca', device_location='devices')[source]¶

Bases: mqttcloudproviderslib.mqttcloudproviderslib.BaseAdapter

Placeholder.

on_disconnect(client, user_data, return_code)[source]¶: Placeholder.

class mqttcloudproviderslib.mqttcloudproviderslib.AzureAdapter(device_name, endpoint, key, api_version='2018-06-30', certificate_authority='AzureRootCA.pem', port=8883, protocol=4)[source]¶

Bases: mqttcloudproviderslib.mqttcloudproviderslib.BaseAdapter

Placeholder.

on_disconnect(client, user_data, return_code)[source]¶: Placeholder.

class mqttcloudproviderslib.mqttcloudproviderslib.BaseAdapter(device_name, port, certificate_authority, protocol)[source]¶

Bases: abc.ABC

Placeholder.

name¶: Placeholder.

on_disconnect(client, user_data, return_code)[source]¶: Placeholder.

protocol¶: Placeholder.

publish(message)[source]¶: Placeholder.

publish_to_subtopic(message, topic)[source]¶: Placeholder.

class mqttcloudproviderslib.mqttcloudproviderslib.GoogleAdapter(device_name, project_id, cloud_region, registry_id, mqtt_bridge_hostname, mqtt_bridge_port, private_key, certificate_authority='GoogleRoots.pem', port=8883, protocol=<_SSLMethod.PROTOCOL_TLSv1_2: 5>)[source]¶

Bases: mqttcloudproviderslib.mqttcloudproviderslib.BaseAdapter

Placeholder.

on_disconnect(client, user_data, return_code)[source]¶: Placeholder.

class mqttcloudproviderslib.mqttcloudproviderslib.MessageHub(configuration)[source]¶

Bases: object

A fan provider to all cloud providers.

broadcast(message)[source]¶

It will broadcast the provided message to all registered cloud provider’s default topic.

Parameters:	message (dict) – The message to publish to the default provider’s topic.
Returns:	True if all published messages get delivered, False if any fails.
Return type:	result (bool)

broadcast_to_subtopic(message, topic)[source]¶

It will broadcast the provided message to all registered cloud provider’s with specified topic.

Parameters:	topic (str) – The provider’s specific topic to publish the message to. message (dict) – The message to publish to the specified provider’s topic.
Returns:	True if all published messages get delivered, False if any fails.
Return type:	result (bool)

class mqttcloudproviderslib.mqttcloudproviderslib.Provider[source]¶

Bases: object

Placeholder.

mqttcloudproviderslib.mqttcloudproviderslibexceptions module¶

Custom exception code for mqttcloudproviderslib.

exception mqttcloudproviderslib.mqttcloudproviderslibexceptions.InvalidAzureKeyContents[source]¶

Bases: Exception

Could not read the provided file as a valid file holding an azure key.

exception mqttcloudproviderslib.mqttcloudproviderslibexceptions.ProviderInstantiationError[source]¶

Bases: Exception

No provider could be instantiated because the data provided was invalid.

mqttcloudproviderslib.schemas module¶

Main code for mqttcloudproviderslib.

Module contents¶

mqttcloudproviderslib package.

Import all parts from mqttcloudproviderslib here