edge_st_sdk package

Subpackages

• edge_st_sdk.aws package
  • Submodules
  • edge_st_sdk.aws.aws_client module
  • edge_st_sdk.aws.aws_greengrass module
  • Module contents
• edge_st_sdk.utils package
  • Submodules
  • edge_st_sdk.utils.edge_st_exceptions module
  • edge_st_sdk.utils.python_utils module
  • Module contents

Submodules

edge_st_sdk.edge_client module

edge_client

The edge_client module contains an interface for creating edge client classes.

class edge_st_sdk.edge_client.EdgeClient

Bases: object

The EdgeClient class is an interface for creating edge client classes.

abstract add_listener(listener)

Add a listener.

Parameters

listener (edge_st_sdk.edge_client.EdgeClientListener) – Listener to be added.

abstract connect()

Connect to the core.

abstract delete_shadow_state(callback, timeout_s)

Delete the state of the shadow client.

Delete the device shadow from the cloud by publishing an empty JSON document to the corresponding shadow topics.

Parameters

• callback – Function to be called when the response for a shadow request comes back.

• timeout_s (int) – Timeout in seconds to perform the request.

abstract disconnect()

Disconnect from the core.

abstract get_shadow_state(callback, timeout_s)

Get the state of the shadow client.

Retrieve the device shadow JSON document from the cloud by publishing an empty JSON document to the corresponding shadow topics.

Parameters

• callback – Function to be called when the response for a shadow request comes back.

• timeout_s (int) – Timeout in seconds to perform the request.

abstract publish(topic, payload, qos)

Publish a new message to the desired topic with the given quality of service.

Parameters

• topic (str) – Topic name to publish to.

• payload (str) – Payload to publish (JSON formatted string).

• qos (int) – Quality of Service. Could be “0” or “1”.

abstract remove_listener(listener)

Remove a listener.

Parameters

listener (edge_st_sdk.edge_client.EdgeClientListener) – Listener to be removed.

abstract subscribe(topic, qos, callback)

Subscribe to the desired topic with the given quality of service and register a callback to handle the published messages.

Parameters

• topic (str) – Topic name to publish to.

• qos (int) – Quality of Service. Could be “0” or “1”.

• callback – Function to be called when a new message for the subscribed topic comes in.

abstract unsubscribe(topic)

Unsubscribe from the desired topic.

Parameters

topic (str) – Topic name to unsubscribe from.

abstract update_shadow_state(payload, callback, timeout_s)

Update the state of the shadow client.

Update the device shadow JSON document string on the cloud by publishing the provided JSON document to the corresponding shadow topics.

Parameters

• payload (json) – JSON document string used to update the shadow JSON document on the cloud.

• callback – Function to be called when the response for a shadow request comes back.

• timeout_s (int) – Timeout in seconds to perform the request.

class edge_st_sdk.edge_client.EdgeClientListener

Bases: object

Interface used by the edge_st_sdk.edge_client.EdgeClient class to notify changes of a client’s status.

abstract on_status_change(client, new_status, old_status)

To be called whenever a client changes its status.

Parameters

• client (edge_st_sdk.edge_client.EdgeClient) – Client that has changed its status.

• new_status (edge_st_sdk.edge_client.EdgeClientStatus) – New status.

• old_status (edge_st_sdk.edge_client.EdgeClientStatus) – Old status.

Raises

NotImplementedError` – if the method has not been implemented.

class edge_st_sdk.edge_client.EdgeClientStatus

Bases: enum.Enum

Status of the client.

CONNECTED = 'CONNECTED'

Connected to the client.

CONNECTING = 'CONNECTING'

Opening a connection with the client.

DISCONNECTING = 'DISCONNECTING'

Closing the connection to the client.

IDLE = 'IDLE'

Waiting for a connection and sending advertising data.

INIT = 'INIT'

Dummy initial status.

UNREACHABLE = 'UNREACHABLE'

The client disappeared without first disconnecting.

Module contents