mlauret / iot-python

Client libraries and samples for connecting to IBM Watson IoT using Python 2.7 and 3.x

Python for IBM Watson IoT Platform

Python module for interacting with the IBM Watson IoT Platform.

• Python 3.6
• Python 2.7

Note: Support for MQTT with TLS requires at least Python v2.7.9 or v3.4, and openssl v1.0.1

Dependencies

• paho-mqtt
• iso8601
• pytz
• requests
• requests_toolbelt
• dicttoxml
• xmltodict

Installation

Install the latest version of the library with pip

[root@localhost ~]# pip install ibmiotf

Uninstall

Uninstalling the module is simple.

[root@localhost ~]# pip uninstall ibmiotf

Documentation

Documentation for the library is now located inside Bluemix:

• Application Developers
• Device Developers

Supported Features

Feature	Supported?	Description
Device Connectivity	Yes	Connect your device(s) to Watson IoT Platform with ease using this library. Refer to documentation for more details.
Gateway Connectivity	Yes	Connect your gateway(s) to Watson IoT Platform with ease using this library. Refer to documentation for more details.
Application connectivity	Yes	Connect your application(s) to Watson IoT Platform with ease using this library. Refer to documentation for more details.
Watson IoT API	Yes	Shows how applications can use this library to interact with the Watson IoT Platform through REST APIs. Refer to documentation for more details.
SSL/TLS	Yes	By default, this library connects your devices, gateways and applications securely to Watson IoT Platform registered service. Ports 8883(default one) and 443 support secure connections using TLS with the MQTT and HTTP protocol. Also, note that the library uses port 1883(unsecured) to connect to the Quickstart service. Support for MQTT with TLS requires at least Python v2.7.9 or v3.4, and openssl v1.0.1.
Client side Certificate based authentication	No	Client side Certificate based authentication not supported now and will be added soon
Device Management for Devices	Yes	Connects your device(s) as managed device(s) to Watson IoT Platform. Refer to Managed Device documentation for more details.
Device Management for Gateways	Yes	Connects your gateway(s) as managed gateway(s) to Watson IoT Platform. Refer to Managed Gateway documentation for more details.
Device Management Extension	Yes	Provides support for custom device management actions. Refer to Device Management Extension(DME) Packages section in the documentation for more details.
Scalable Application	Yes	Provides support for load balancing for applications. Skip providing type in configuration details to make application as scalable application.
Auto Reconnect	No	Enables device/gateway/application to automatically reconnect to Watson IoT Platform while they are in a disconnected state.
Websocket	No	Enables device/gateway/application to connect to Watson IoT Platform using WebSockets
Event/Command publish using MQTT	Yes	Enables device/gateway/application to publish messages using MQTT. Refer to Device , Gateway and Application documentations for more details.
Event/Command publish using HTTP	Yes	Enables device/gateway/application to publish messages using HTTP.
Data Formats	JSON, XML, user-defined	Mulitple Data formats support.