pymfy 0.5.0

A Somfy Open API library

This library is an attempt to implement the entire Somfy API in Python 3. Documentation for the Somfy API can be found here.

Get developer credentials

1. Vist https://developer.somfy.com
2. Create an account
3. Open the My Apps menu
4. Add a new App (for testing, redirect url can be anything in https)
5. Plug in your details into the test script below.

Supported devices

Somfy currently exposes the following type of devices:

• Blinds
• Rolling shutters
• Cameras
• Connected Thermostat

If you find on this page devices not yet handle by this repository, don't hesitate to open an issue.

Example usage

Print all covers name.

import os
import json
from urllib.parse import urlparse, parse_qs

from pymfy.api.devices.roller_shutter import RollerShutter
from pymfy.api.somfy_api import SomfyApi
from pymfy.api.devices.category import Category

client_id = r'<CLIENT_ID>' # Consumer Key
redir_url = '<REDIR_URL>' # Callback URL (for testing, can be anything)
secret = r'<secret>' # Consumer Secret

def get_token():
        try:
            with open(cache_path, 'r') as cache:
                return json.loads(cache.read())
        except IOError:
            pass

def set_token(token) -> None:
    with open(cache_path, 'w') as cache:
        cache.write(json.dumps(token))

cache_path = '/optional/cache/path'
api = SomfyApi(client_id, secret, redir_url, token=get_token(), token_updater=set_token)
if not os.path.isfile(cache_path):
    authorization_url, _ = api.get_authorization_url()
    print('Please go to {} and authorize access.'.format(authorization_url))
    authorization_response = input('Enter the full callback URL')
    code = parse_qs(urlparse(authorization_response).query)['code'][0]
    set_token(api.request_token(code=code))

devices = api.get_devices(category=Category.ROLLER_SHUTTER)

covers = [RollerShutter(d, api) for d in devices]

for cover in covers:
    print("Cover {} has the following position: {}".format(cover.device.name, cover.get_position()))

Contribute

The current documentation does not give enough information to implement all the devices. If you want to contribute to this repository adding new devices, you can create an issue with the output of this script:

import json
import re
from urllib.parse import urlparse, parse_qs

client_id = r'<CLIENT_ID>' # Consumer Key
redir_url = '<REDIR_URL>' # Callback URL (for testing, can be anything)
secret = r'<secret>' # Consumer Secret

from pymfy.api.somfy_api import SomfyApi

api = SomfyApi(client_id, secret, redir_url)
authorization_url, _ = api.get_authorization_url()
print('Please go to {} and authorize access.'.format(authorization_url))
authorization_response = input('Enter the full callback URL')
code = parse_qs(urlparse(authorization_response).query)['code'][0]
api.request_token(code=code)

devices = api.get_devices()
# Remove personal information
dumps = json.dumps(devices, sort_keys=True, indent=4, separators=(',', ': '))
dumps = re.sub('".*id.*": ".*",\n', '', dumps)

print(dumps)