IoTFlows Open Source Python WebSocket SDK.
IoTFlows python module https://pypi.org/project/iotflows/​
With this tool you can:
Publish secure real-time data streams.
Subscribe to the data streams and access real-time data on your web/mobile/IoT apps.
Publish alerts to the alert channels with a defined severity level. Subscribers will get notified in the form of SMS/Email/Push.
Define cloud actions that can be called from other IoT devices/web applications.
Use pip3
to install the IotTFows python module:
sudo pip3 install pathlib2
sudo pip3 install iotflows
Note: only Python3 is supported for this module.
This function will create and initialize an IoTFlows instance.
import iotflows.realtime as iotflowsRTIoTFlows = iotflowsRT.init('API_KEY_USERNAME', 'API_KEY_PASSWORD')
Make sure to change API_KEY_USERNAME
and API_KEY_PASSWORD
with the proper credentials obtained from IoTFlows console. These credentials can be either one of these options:
A Device API Key that has permission to interact with the resources available in its project, or
An Organization API Key that can have read-only or read/write permissions to the entire organization resources
A User Client that is authorized to interact with the permitted resources of the user. This option is most useful when you need to build a web or mobile app. For this option, you need to register your Application in IoTFlows and authenticate users using OAuth2. With the obtained JWT, you can perform a Basic authentication HTTP request to generate a User Client.
Read more:
To publish a real-time data stream, you need to pass these parameters in a json object:
data_stream_uuid: the uuid of the data stream
data: the data to be published to the data stream
Read more:
Example:
IoTFlows.publish(data_stream_uuid='ds_xxxxxxxxxxxxxxxxxxxxxxx',data='Hello World!')
To listen to real-time data streams that are published, you need to define the following parameters in a json object:
data_stream_uuid: data stream uuid
qos (optional): quality of service 0, 1, or 2 (0: At most once, 1: At least once, 2: Exactly once)
callback: handler function to be called when data received
Example:
def handlerFunction(topic, payload):print('received new payload!!!')print(payload)​IoTFlows.subscribe(data_stream_uuid = 'ds_xxxxxxxxxxxxxxxxxxxxxxx',qos = 2,callback = handlerFunction)
To publish an alert, you need to pass these parameters in a json object:
alert_channel_uuid: the uuid of the alert channel
severity_level: the severity level of the alert. It can be MAJOR, MINOR or INFORMATIVE
subject: the subject of the alert
description: the description/message of the alert
Read more:
Example:
IoTFlows.alert(alert_channel_uuid = 'ac_xxxxxxxxxxxxxxxxxxxxxxxx',severity_level = 'MINOR',subject = 'Water Leak',description = 'Water leackage detected in Site A.')
To define a cloud action that can be called from other IoT/web applications, you need to define the following parameters in a json object:
action_uuid action uuid
qos (optional): quality of service 0, 1, or 2 (0: At most once, 1: At least once, 2: Exactly once)
callback: handler function to be called when action gets executed
Read more:
​How to create an action​
Example:
def controlPump(topic, payload):print('received new command!')print(payload)​IoTFlows.defineAction(action_uuid = 'da_xxxxxxxxxxxxxxxxxxxxxxxxx',qos = 2,callback = controlPump)
To publish an alert, you need to pass these parameters in a json object:
action_uuid: the uuid of the action
payload: the payload to be published to the action
Example:
IoTFlows.callAction(action_uuid='da_xxxxxxxxxxxxxxxxxxxxxxxxx',data='Turn on!')