comapsmarthome-public-api


Namecomapsmarthome-public-api JSON
Version 0.0.9 PyPI version JSON
download
home_pagehttps://gitlab.com/melec/comapsmarthome_public_api_python
SummaryComap Smart Home public API python module
upload_time2023-01-12 10:34:57
maintainer
docs_urlNone
authorMelec Petit-Pierre
requires_python>=3.6
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # COMAP Smart Home public API

Python module to control and retrieve data for COMAP Smart Home products.

## Install

To install `comapsmarthome-prublic-api` run :

    pip install comapsmarthome-public-api
## Usage example

```python
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 address
- `COMAP_SMART_HOME_PASSWORD`: COMAP Smart Home user password

## Requirements

- Python >=3.6
- requests, boto3 and dateutil modules
- COMAP Smart Home user account


            

Raw data

            {
    "_id": null,
    "home_page": "https://gitlab.com/melec/comapsmarthome_public_api_python",
    "name": "comapsmarthome-public-api",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "",
    "author": "Melec Petit-Pierre",
    "author_email": "melec.petit-pierre@comap.eu",
    "download_url": "",
    "platform": null,
    "description": "# COMAP Smart Home public API\n\nPython module to control and retrieve data for COMAP Smart Home products.\n\n## Install\n\nTo install `comapsmarthome-prublic-api` run :\n\n    pip install comapsmarthome-public-api\n## Usage example\n\n```python\nfrom comapsmarthome_public_api.client_auth import ClientAuth\nfrom comapsmarthome_public_api.measurement_service import MeasurementsService\n\nauth = ClientAuth()\nmeasurements = MeasurementsService(auth)\n\ndt_from = '2020-10-01T09:30+01:00'\ndt_to = '2020-10-01T10:30+01:00'\nserial_number = 'aa**********'\ndata = measurements.get_measurements(dt_from, dt_to, serial_number=serial_number, measurements=['inside_temperature'])\ndates = [d['time'] for d in data]\ntemperatures = [d['inside_temperature'] for d in data]\n```\n\n## Credentials\n\nTo 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`.\n- `COMAP_SMART_HOME_USERNAME`: COMAP Smart Home user email address\n- `COMAP_SMART_HOME_PASSWORD`: COMAP Smart Home user password\n\n## Requirements\n\n- Python >=3.6\n- requests, boto3 and dateutil modules\n- COMAP Smart Home user account\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Comap Smart Home public API python module",
    "version": "0.0.9",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "30e8c061b71eac86b76ac9caab0fbfe24918c1e0bf37cd9229bc298feef217bb",
                "md5": "d05aedcf34ebd7345e2af3fbcc305714",
                "sha256": "165457a45f2c3cc31677bb346386e5d801dfc339158595dba747fe9c5c7a8a06"
            },
            "downloads": -1,
            "filename": "comapsmarthome_public_api-0.0.9-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d05aedcf34ebd7345e2af3fbcc305714",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 9564,
            "upload_time": "2023-01-12T10:34:57",
            "upload_time_iso_8601": "2023-01-12T10:34:57.290744Z",
            "url": "https://files.pythonhosted.org/packages/30/e8/c061b71eac86b76ac9caab0fbfe24918c1e0bf37cd9229bc298feef217bb/comapsmarthome_public_api-0.0.9-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-12 10:34:57",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "gitlab_user": "melec",
    "gitlab_project": "comapsmarthome_public_api_python",
    "lcname": "comapsmarthome-public-api"
}
        
Elapsed time: 0.10211s