Comap Smart Home public API python module
Project description
COMAP Smart Home public API
Python 3 API to control and retrieve data for COMAP Smart Home products.
Install
To install comapsmarthome-prublic-api
run :
pip install comapsmarthome-public-api --extra-index-url https://__token__:$GITLAB_PERSONAL_TOKEN@gitlab.com/api/v4/projects/22205893/packages/pypi/simple
Your Gitlab personal access token needs to be saved under the environment variable GITLAB_PERSONAL_TOKEN
and have the read_api
scope.
To create a personal access token you can follow this guide.
On Windows, replace $GITLAB_PERSONAL_TOKEN
with %GITLAB_PERSONAL_TOKEN%
.
Usage example
from comapsmarthome_public_api.client_auth import ClientAuth
from comapsmarthome_public_api.measurement_service import MeasurementsService
auth = ClientAuth()
measurements = MeasurementsService(auth)
dt_from = '2020-10-01T09:30+01:00'
dt_to = '2020-10-01T10:30+01:00'
serial_number = 'aa**********'
data = measurements.get_measurements(dt_from, dt_to, serial_number=serial_number, measurements=['inside_temperature'])
dates = [d['time'] for d in data]
temperatures = [d['inside_temperature'] for d in data]
Credentials
To access COMAP Smart Home product through the API, username
and password
need to be saved under the environment variables COMAP_SMART_HOME_USERNAME
and COMAP_SMART_HOME_PASSWORD
.
COMAP_SMART_HOME_USERNAME
: COMAP Smart Home user email addressCOMAP_SMART_HOME_PASSWORD
: COMAP Smart Home user password
Requirements
- Python >=3.6
- requests and dateutil modules
- COMAP Smart Home user account
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for comapsmarthome_public_api-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8d89def8775449cbb6ecc3d0bde2eebff66c16340e775357e61c3482acc1bb87 |
|
MD5 | 3bc147ddd3ace1b623fa7ece4f8b1770 |
|
BLAKE2b-256 | 78e03cab03627a2c7c4a280278739355e5f47541fd0af3b608d9e4dd9d727d2b |