Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

IBM Internet of Things Cloud for Python

Project Description
IBM Internet of Things Cloud for Python
=======================================

Python module for interacting with the IBM Internet of Things Cloud with
Python.

Platform
--------

- `Python 2.7 <https://www.python.org/download/releases/2.7>`__

Dependencies
------------

- `paho-mqtt <http://git.eclipse.org/c/paho/org.eclipse.paho.mqtt.python.git/>`__
- `iso8601 <https://bitbucket.org/micktwomey/pyiso8601/>`__

Installation
------------

This module is not yet available in PyPi, however you can download the
latest release and use pip's ability to install from a file.

::

[root@localhost ~]# pip install ibmiotc-version.zip

Uninstall
---------

Uninstalling the module is simple.

::

[root@localhost ~]# pip uninstall ibmiotc

Documentation
-------------

Application Client
~~~~~~~~~~~~~~~~~~

Constructor
^^^^^^^^^^^

The Client constructor accepts an options dict containing: \* org - Your
organization ID \* id - The unique ID of your application within your
organization \* authMethod - Method of authentication (the only value of
authMethod currently supported is "apikey") \* authKey - API key
(required if authMethod is "apikey") \* authToken - API key token
(required if authMethod is "apikey")

.. code:: python

import ibmiotc.application
try:
options = {"org": organization, "id": appId, "auth-method": authMethod, "auth-key": authKey, "auth-token": authToken}
client = ibmiotc.application.Client(options)
except ibmiotc.ConnectionException as e:
...

Using a Configuration File
''''''''''''''''''''''''''

.. code:: python

import ibmiotc.application
try:
options = ibmiotc.application.ParseConfigFile(configFilePath)
client = ibmiotc.application.Client(options)
except ibmiotc.ConnectionException as e:
...

The application configuration file must be in the following format:

::

org=$orgId
id=$myApplication
auth-method=apikey
auth-key=$key
auth-token=$token

Subscribing to Device events
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

By default, this will subscribe to all events from all connected
devices. Use the type, id and event parameters to control the scope of
the subscription. A single client can support multiple subscriptions.

Subscribe to all events from all devices
''''''''''''''''''''''''''''''''''''''''

.. code:: python

client.subscribeToDeviceEvents()

Subscribe to all events from all devices of a specific type
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

.. code:: python

client.subscribeToDeviceEvents(deviceType=myDeviceType)

Subscribe to a specific event from all devices
''''''''''''''''''''''''''''''''''''''''''''''

.. code:: python

client.subscribeToDeviceEvents(event=myEvent)

Subscribe to a specific event from two different devices
''''''''''''''''''''''''''''''''''''''''''''''''''''''''

.. code:: python

client.subscribeToDeviceEvents(deviceType=myDeviceType, deviceId=myDeviceId, event=myEvent)
lient.subscribeToDeviceEvents(deviceType=myOtherDeviceType, deviceId=myOtherDeviceId, event=myEvent)

Handling events from Devices
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To process the events received by your subscroptions you need to
register an event callback method. The messages are returned as an
instance of the Event class: \* event.device - string (uniquely
identifies the device across all types of devices in the organization
:math:`deviceType:`\ deviceId) \* event.deviceType - string \*
event.deviceId - string \* event.event - string \* event.format - string
\* event.data - dict \* event.timestamp - datetime

.. code:: python

def myEventCallback(event):
print "%s event '%s' received from device [%s]: %s" % (event.format, event.event, event.device, json.dumps(event.data))

...
client.eventCallback = myEventCallback
client.subscribeToDeviceEvents()

Subscribing to Device status
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

By default, this will subscribe to status updates for all connected
devices. Use the type and id parameters to control the scope of the
subscription. A single client can support multiple subscriptions.

Subscribe to status updates for all devices
'''''''''''''''''''''''''''''''''''''''''''

.. code:: python

client.subscribeToDeviceStatus()

Subscribe to status updates for all devices of a specific type
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

.. code:: python

client.subscribeToDeviceStatus(deviceType=myDeviceType)

Subscribe to status updates for two different devices
'''''''''''''''''''''''''''''''''''''''''''''''''''''

.. code:: python

client.subscribeToDeviceStatus(deviceType=myDeviceType, deviceId=myDeviceId)
lient.subscribeToDeviceStatus(deviceType=myOtherDeviceType, deviceId=myOtherDeviceId)

Handling status updates from Devices
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To process the status updates received by your subscriptions you need to
register an event callback method. The messages are returned as an
instance of the Status class:

| The following properties are set for both "Connect" and "Disconnect"
status events: \* status.clientAddr - string
| \* status.protocol - string
| \* status.clientId - string
| \* status.user - string
| \* status.time - datetime
| \* status.action - string
| \* status.connectTime - datetime
| \* status.port - int

| The following properties are only set when the action is "Disconnect":
\* status.writeMsg - int \* status.readMsg - int \* status.reason -
string
| \* status.readBytes - int
| \* status.writeBytes - int

.. code:: python

def myStatusCallback(status):
if status.action == "Disconnect":
print "%s - device %s - %s (%s)" % (status.time.isoformat(), status.device, status.action, status.reason)
else:
print "%s - %s - %s" % (status.time.isoformat(), status.device, status.action)

...
client.statusCallback = myStatusCallback
client.subscribeToDeviceStstus()

Publishing Events "from" Devices
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Applications can publish events as if they originated from a Device

.. code:: python

myData={'name' : 'foo', 'cpu' : 60, 'mem' : 50}
client.publishEvent(myDeviceType, myDeviceId, "status", myData)

Publishing Commands to Devices
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Applications can publish commands to connected Devices

.. code:: python

commandData={'rebootDelay' : 50}
client.publishCommand(myDeviceType, myDeviceId, "reboot", myData)
Release History

Release History

This version
History Node

0.0.7

History Node

0.0.6

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
ibmiotc-0.0.7.zip (31.4 kB) Copy SHA256 Checksum SHA256 Source Sep 27, 2014

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting