| Name | pyindrav2h JSON |
| Version |
0.0.7
JSON |
| download |
| home_page | None |
| Summary | API client and example CLI to interact with Indra V2H Chargers |
| upload_time | 2024-04-12 11:20:19 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2024 creatingwake Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
v2h
indra
v2g
v2x
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pyindrav2h
A basic API client and example CLI to interact with Indra V2H Chargers. Required by Home Assistant.
This is a very early Alpha release, and functionality may change very rapidly.
NOTE: Indra Renewable Technologies Limited are aware of this integration. However, this is an unofficial integration and Indra are not able to provide support for direct API integrations. The Indra API will likely change in future which may result in functionality provided by this integration failing at any time.
## Installation
Install pyindrav2h with pip. Using venv is recommended.
```bash
pip install pyindrav2h
```
to update pyindrav2h
```bash
pip install pyindrav2h -U
```
On installation a CLI will become available: ```indracli```
## Usage/Examples
### CLI
```bash
usage: indracli [-h] [-u EMAIL] [-p PASSWORD] [-d] {statistics,device,alldevices,all,loadmatch,idle,exportmatch,charge,discharge,schedule} ...
Indra V2H CLI
positional arguments:
{statistics,device,alldevices,all,loadmatch,idle,exportmatch,charge,discharge,schedule}
statistics show device statistics
device show device info
alldevices show data on all available devices
all show all info
loadmatch set mode to load matching
idle set mode to IDLE
exportmatch set mode to export matching
charge set mode to CHARGE
discharge set mode to discharge
schedule return to scheuduled mode
options:
-h, --help show this help message and exit
-u EMAIL, --email EMAIL
-p PASSWORD, --password PASSWORD
-d, --debug
```
It is possible to provide a configuration file to provide Indra Smart Portal credentials. If no username/email or password is provided it will be retrieved from ```./.indra.cfg``` or ```~/.indra.cfg```
#### Example .indra.cfg Configuration file
```
[indra-account]
email=useremail@email.com
password=yourindrapassword
```
### Library Usage
Intended for use with Indra V2H Home Assistant integration.
Documentation to follow.
## Support
This is a community project that lacks formal support.
For support from the community please join the Indra V2H trial support community: https://indrav2h.zendesk.com/hc/en-gb/community/topics
For bugs or feature requests please create a GitHub Issue: https://github.com/creatingwake/pyindrav2h/issues
---
#### NOTE: Please do not contact Indra Support. Indra are unable to assist with unofficial API integrations.
## Acknowledgements
- [trizmark](https://github.com/trizmark) for help with home assistant API integration examples
Raw data
{
"_id": null,
"home_page": null,
"name": "pyindrav2h",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "v2h, indra, v2g, v2x",
"author": null,
"author_email": "Paul Morris <paul@creatingwake.com>",
"download_url": "https://files.pythonhosted.org/packages/86/d3/9540a3d427ab388a5cb3a24665787bda5ad29a28face23ac41f6ce19e4b2/pyindrav2h-0.0.7.tar.gz",
"platform": null,
"description": "\n# pyindrav2h\n\nA basic API client and example CLI to interact with Indra V2H Chargers. Required by Home Assistant.\n\nThis is a very early Alpha release, and functionality may change very rapidly.\n\nNOTE: Indra Renewable Technologies Limited are aware of this integration. However, this is an unofficial integration and Indra are not able to provide support for direct API integrations. The Indra API will likely change in future which may result in functionality provided by this integration failing at any time.\n\n\n\n## Installation\n\nInstall pyindrav2h with pip. Using venv is recommended.\n\n```bash\n pip install pyindrav2h\n```\nto update pyindrav2h\n```bash\n pip install pyindrav2h -U\n```\nOn installation a CLI will become available: ```indracli```\n## Usage/Examples\n\n### CLI\n\n```bash\nusage: indracli [-h] [-u EMAIL] [-p PASSWORD] [-d] {statistics,device,alldevices,all,loadmatch,idle,exportmatch,charge,discharge,schedule} ...\n\nIndra V2H CLI\n\npositional arguments:\n {statistics,device,alldevices,all,loadmatch,idle,exportmatch,charge,discharge,schedule}\n statistics show device statistics\n device show device info\n alldevices show data on all available devices\n all show all info\n loadmatch set mode to load matching\n idle set mode to IDLE\n exportmatch set mode to export matching\n charge set mode to CHARGE\n discharge set mode to discharge\n schedule return to scheuduled mode\n\noptions:\n -h, --help show this help message and exit\n -u EMAIL, --email EMAIL\n -p PASSWORD, --password PASSWORD\n -d, --debug\n```\n\nIt is possible to provide a configuration file to provide Indra Smart Portal credentials. If no username/email or password is provided it will be retrieved from ```./.indra.cfg``` or ```~/.indra.cfg```\n\n#### Example .indra.cfg Configuration file\n```\n[indra-account]\nemail=useremail@email.com\npassword=yourindrapassword\n```\n\n### Library Usage\n\nIntended for use with Indra V2H Home Assistant integration.\nDocumentation to follow.\n\n## Support\n\nThis is a community project that lacks formal support.\n\n\nFor support from the community please join the Indra V2H trial support community: https://indrav2h.zendesk.com/hc/en-gb/community/topics\n\n\n\nFor bugs or feature requests please create a GitHub Issue: https://github.com/creatingwake/pyindrav2h/issues\n\n---\n#### NOTE: Please do not contact Indra Support. Indra are unable to assist with unofficial API integrations.\n\n\n## Acknowledgements\n\n - [trizmark](https://github.com/trizmark) for help with home assistant API integration examples\n\n\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 creatingwake Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "API client and example CLI to interact with Indra V2H Chargers",
"version": "0.0.7",
"project_urls": {
"Homepage": "https://github.com/creatingwake/pyindrav2h"
},
"split_keywords": [
"v2h",
" indra",
" v2g",
" v2x"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "348880fc17a00aebf3e9c2d9c7d5797fb682c98d0b05c9d95b4689cc33e5f5b0",
"md5": "e5a142a5df4bb998dbbd680960e564de",
"sha256": "406fd6d27467cd63b5e63eb720666b22c3b132612515aad805c4ce612e645331"
},
"downloads": -1,
"filename": "pyindrav2h-0.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e5a142a5df4bb998dbbd680960e564de",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 9283,
"upload_time": "2024-04-12T11:20:18",
"upload_time_iso_8601": "2024-04-12T11:20:18.751283Z",
"url": "https://files.pythonhosted.org/packages/34/88/80fc17a00aebf3e9c2d9c7d5797fb682c98d0b05c9d95b4689cc33e5f5b0/pyindrav2h-0.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "86d39540a3d427ab388a5cb3a24665787bda5ad29a28face23ac41f6ce19e4b2",
"md5": "fbc155dd15a29cf7596c7dead39e5996",
"sha256": "95514be617c90be70a925ae43bbb7dc5e9d28447af989ab5dfd313767438ef90"
},
"downloads": -1,
"filename": "pyindrav2h-0.0.7.tar.gz",
"has_sig": false,
"md5_digest": "fbc155dd15a29cf7596c7dead39e5996",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 9058,
"upload_time": "2024-04-12T11:20:19",
"upload_time_iso_8601": "2024-04-12T11:20:19.904578Z",
"url": "https://files.pythonhosted.org/packages/86/d3/9540a3d427ab388a5cb3a24665787bda5ad29a28face23ac41f6ce19e4b2/pyindrav2h-0.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-12 11:20:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "creatingwake",
"github_project": "pyindrav2h",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pyindrav2h"
}
