Skip to main content

iotery.io embedded python SDK

Project description

iotery.io Embedded Python SDK

The python iotery.io SDK is intended to be used on your embedded device to interact with the itoery.io IoT Platform. The SDK is a fully featured wrapper for the REST API.

Getting Started

Setup your free account on iotery.io and go to your dashboard get started with creating device types and devices.

After you get your key, install the SDK:

pip install iotery-embedded-python-sdk

Note: Make sure you are using Python 3.5+!

And finally, some simple example usage:

from iotery_embedded_python_sdk import Iotery
TEAM_ID="265fcb74-8889-11f9-8452-d283610663ec" # team ID found on the dashboard: https://iotery.io/system
iotery = Iotery()
d = iotery.getDeviceTokenBasic(data={"key": "thermal_sensor_001",
                                     "serial": "THERMAL_SENSOR_001", "secret": "thermal_sensor_001_secret", "teamUuid": TEAM_ID})
iotery.set_token(d["token"])
me = iotery.getMe()

print(me["name"])

API

This SDK simply wraps the REST API, so more information and specifics can be found there. Since the API is a wrapper around the REST API, the syntax is standard for each of the Create, Read, Update, and Delete operations on iotery.io resources. All methods return a dictonary containing the API response. If there is an error, the method will raise an expection.

Creating Resources

The generalized syntax for creating resources in iotery.io python sdk looks like:

iotery.methodName(inputParameter="parameter", data={ "data": "variables" })

For example, to create a device, the python would look like

createDeviceCommandInstanceEmbedded(
  deviceUuid="a-valid-device-type-uuid",
  commandTypeUuid="a-valid-command-type-uuid",
  data={}
)

where createDeviceCommandInstanceEmbedded maps to methodName, deviceUuid maps to inputParameter, and data={} and maps to the dictonary {data : "variables"} in the generalized form given above.

The available resource creation (POST) methods are

methodName input link description
getDeviceTokenBasic link Get token for device via key, serial, and secret.
reportAlreadyExecutedCommands link Report an already executed set of commands to the server.
createDeviceCommandInstance deviceUuid,commandTypeUuid link Create a command instance via a device.
postData deviceUuid link Post data to the cloud.
upsertDeviceSettings deviceUuid link Upsert settings for a device.
uploadDeviceLogs deviceUuid link Upload zip file of device logs.
getDeviceTokenAsymmetric link Get device token based on encrypted credentials.

Reading Resources

The generalized syntax for reading (getting) resources in iotery.io python sdk looks like:

iotery.methodName(inputParameter="parameter", opts={"query":"parameter"})

For example, to get a device by it's unique identifier uuid, the python would look like

getDeviceTypeFirmwareRecord(
  deviceUuid="a-valid-device-uuid",
  version="valid version",
  opts={ "limit": 1 }
)

where getDeviceTypeFirmwareRecord maps to methodName, deviceUuid maps to inputParameter, and { "limit": 1 } maps to the dictonary {"query" : "parameters"} in the generalized form given above.

The limit option is for instructive purposes only. By definition, a uuid is unique and so there will never be more than one device for a given uuid.

The available resource creation methods are

methodName input link description
getBrokerAddress link Get the MQTT broker address.
getCommandTypeList link Get a list of available command types.
getCurrentTimestamp link Get the current server time in epoch (unix) time.
getDataTypeList link Get a list of available data types.
getDeviceSettingList deviceUuid link Get a list of settings for a device.
getDeviceUnexecutedCommandInstanceList deviceUuid link Get a list of unexecuted command instances for a device.
getDeviceTypeFirmwareRecord deviceTypeUuid,version link Get a desired version of a firmware record for a given device type.
getPublicCloudKey link Get base64 encoded public key from the server for use in RSA scheme.
getMe link Get information about the device.
getNotificationTypeList link Get a list of available notifications.
getSettingTypeList link Get a list of available setting types.

Updating Resources

The generalized syntax for updating resources in iotery.io python sdk looks like:

iotery.methodName(inputParameter="parameter", data={ "data": "variables" })

For example, to update a device type, the code would look like

updateDeviceChannel(
  deviceUuid="a-valid-device-type-uuid",
  channelId="1",
  data={}
)

where updateDeviceChannel maps to methodName, deviceUuid maps to inputParameter, and {} maps to the dictonary {data : "variables"} in the generalized form given above (if there was a body).

The available resource creation methods are

methodName input link description
setBatchedCommandInstancesAsExecuted batchReferenceUuid link Set a collection of batched command instances as executed.
setCommandInstanceAsExecuted commandInstanceUuid link Report that a command has been executed to the server.
updateDeviceChannel deviceUuid,channelId link Update device channel.
setNotificationInstanceInactive notificationInstanceUuid link Set notification instance inactive.

Deleting Resources

The generalized syntax for reading (getting) resources in iotery.io python sdk looks like:

iotery.methodName(inputParameter="parameter", opts={"query":"parameter"})

For example, to get a device by it's unique identifier uuid, the python would look like

deleteDevice(
  deviceUuid="a-valid-device-uuid",
  opts={ "some": "option" }
)

where deleteDevice maps to methodName, deviceUuid maps to inputParameter, and { "some": "option" } maps to the dictonary {"query" : "parameters"} in the generalized form given above.

The available resource creation methods are

methodName input link description

Contributing

We welcome contributors and PRs! Let us know if you are interested.

Project details


Download files

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

Files for iotery-embedded-python-sdk, version 0.1.8
Filename, size File type Python version Upload date Hashes
Filename, size iotery_embedded_python_sdk-0.1.8-py3-none-any.whl (10.6 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size iotery-embedded-python-sdk-0.1.8.tar.gz (6.7 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page