A Somfy Open API library
Project description
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
- Vist https://developer.somfy.com
- Create an account
- Open the My Apps menu
- Add a new App (for testing, redirect url can be anything in https)
- Plug in your details into the test script below.
Example usage
Print all covers name.
from pymfy.api.devices.roller_shutter import RollerShutter
from pymfy.api.somfy_api import SomfyApi
from pymfy.api.devices.types import Category
client_id = r'<CLIENT_ID>'
redir_url = '<REDIR_URL>'
secret = r'<secret>'
api = SomfyApi(client_id, redir_url)
authorization_url, state = api.get_authorization_url()
print('Please go to {} and authorize access.'.format(authorization_url))
authorization_response = input('Enter the full callback URL')
api.request_token(authorization_response, secret)
api.automatic_refresh()
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.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
client_id = r'<CLIENT_ID>'
redir_url = '<REDIR_URL>'
secret = r'<secret>'
from pymfy.api.somfy_api import SomfyApi
api = SomfyApi(client_id, redir_url)
authorization_url, state = api.get_authorization_url()
print('Please go to {} and authorize access.'.format(authorization_url))
authorization_response = input('Enter the full callback URL')
api.request_token(authorization_response, secret)
api.automatic_refresh()
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)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pymfy-0.2.0.tar.gz
(16.5 kB
view hashes)
Built Distribution
pymfy-0.2.0-py3-none-any.whl
(14.5 kB
view hashes)