Python library to interact with Unfolde Circle Remote Two
Project description
python-unfoldedcircle
Python library to interact with Unfolde Circle Remote Two.
Supported Devices
This tool and library has been tested with:
- Remote Two
It might work with other devices from Unfolded Circle. If you have a device which is not listed above, please submit an issue.
Installation
The easiest way to install is by using pip
:
pip install python-unfoldedcircle
Device Discovery
Discover devices on your network by running:
unfoldedcircle discover
Note: Devices need to be on the same network as you are in order to be discovered through UPnP.
Example:
$ unfoldedcircle discover
Discovered devices:
- Remote Two Bob (http://192.168.1.20:80/api/)
- Remote Two Marley (http://192.168.1.30:80/api/)
You can set the endpoint with the --endpoint
command line option or with the environment variable UC_ENDPOINT
.
Usage
Invoke with --help
to get a list of available commands and options.
unfoldedcircle --help
Authentication
Authentication is necessary to interact with a device. The auth login
command sets up an API key to be used by this tool.
$ unfoldedcricle --endpoint http://192.168.1.20:80/api/ auth login
PIN: ***
New API key for 'Remote Two Bob': PhyrUcD.YzNkOTg5MTA5ZTFkNDMxMGIxODVkMTJiYmU3ODllMjcuMmFjZDk0YmU5N2RjNDM4ZWFhYzU3ZTY1MjQzY2EyNTk
The new API key is stored in the ./credentials
file (change its path with the --keyfile
option) and will be used for the configured endpoint in subsequent invocations. You can manually set the API key (and override stored credentials) with the --apikey
command line option or with the environment variable UC_APIKEY
.
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
Built Distribution
Hashes for python_unfoldedcircle-0.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b070094aa2565bde056fd3e2203bc79cda85e3dca244159860d5dc3bf94c4ee3 |
|
MD5 | 6d334006f4ea847bdd2f22fafdb0f39b |
|
BLAKE2b-256 | 471d9d7d7177e0c4332f9dbabbd066cf7116e7821408ebee288de9adfada85be |
Hashes for python_unfoldedcircle-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 319b165f349edbf81bc0d0bf4c2d924dceb6bf1a7b84f22b3b7687f3bb6ea552 |
|
MD5 | a0c2edd0a6e7ab355075e6fdeaf4da73 |
|
BLAKE2b-256 | 074ae313feeb24c201a86d5cbe705bb7930ed033ea8eb6f67321daa7574f82a3 |