pysmartthings 0.3.4

A python library for interacting with the SmartThings cloud API.

pysmartthings

A python library for interacting with the SmartThings cloud API.

Features

The package is still in beta, but the following features are available:

1. Locations: List, Get
2. Devices: List, Get, Command, Status
3. Apps: List, Get, Create, Update, Delete, Settings Get & Update, OAuth: Get & Update
4. InstalledApps: List, Get, Delete
5. Subscriptions: List, Get, Create, Delete, Delete All

Installation

pip install pysmartthings

or

pip install --use-wheel pysmartthings

Usage

Initialization

Call create and pass in your personal access token. Create will return an instance of the SmartThings class.

>>> import pysmartthings
>>> st = pysmartthings.create("PERSONAL_ACCESS_TOKEN")

Locations

A list of locations in SmartThings can be retrieved by invoking SmartThings.locations().

>>> locations = st.locations()
>>> len(locations)
2
>>> location = locations[0]
>>> location.name
'Test Home'
>>> location.location_id
'5c03e518-118a-44cb-85ad-7877d0b302e4' 

Devices

A list of devices across all locations in SmartThings can be retrieved by invoking SmartThings.devices(location_ids=None, capabilities=None, device_ids=None). The optional parameters allow filtering the returned list.

>>> devices = st.devices()
>>> len(devices)
19
>>> device = devices[0]
>>> device.device_id
'0d38d5ca-705f-44f7-89bd-36a8cf73678d'
>>> device.name
'GE In-Wall Smart Dimmer'
>>> device.label
'Back Patio Light'
>>> device.capabilities
['switch', 'switchLevel', 'refresh', 'indicator', 'button', 'sensor', 'actuator', 'healthCheck', 'light']

For Device Type Handlers (DTH) additional information is available about the handler:

>>> device.type.value
DTH
>>> device.device_type_name
'GE Dimmer Switch 14294'
>>> device.device_type_network
'ZWAVE'
>>> device.device_type_id
'23a143cf-bad9-4dc1-a56b-fd93ff01e9f9'

The current status of the device is populated when Device.status.refresh() is called. The DeviceStatus class represents the current values of the capabilities and provides several normalized property accessors.

>>> device.status.refresh()

>>> device.status.attributes
{'button': 'pressed', 'numberOfButtons': None, 'supportedButtonValues': None, 'indicatorStatus': 'when off', 'switch': 'on', 'checkInterval': 1920, 'healthStatus': None, 'DeviceWatch-DeviceStatus': None, 'level': 100}
>>> device.status.switch
True
>>> device.status.level
100

Device Commands

You can execute a command on a device by calling the Device.command(capability, command, args=None) function. The capability parameter corresponds to one of the capabilities detected and command is one of the define commands. args is an array of parameters to pass to the command (optional). See the SmartThings Capability Reference for more information.

>>> device.command("switch", "on")
True
>>> device.command("switchLevel", "setLevel", [75, 2])
True

Devices with the switch capability have the following functions:

>>> device.switch_on()
True
>>> device.switch_off()
True

Devices with the switchLevel capability have the following function that sets the target brightness level and transitions using a specific duration (seconds).

>>> device.set_level(75, 2)
True