[](https://github.com/csm10495/pyhtcc/actions/workflows/test_and_release.yml) 
# PyHTCC
An (unofficial) library for interfacing with a Honeywell Total Connect Comfort (TCC) thermostat system. It includes both a simple CLI and an API.
# Installation
```
pip install pyhtcc
```
# Simple API Example
```
from pyhtcc import PyHTCC
p = PyHTCC(<TCC username>, <TCC password>)
zone = p.get_zone_by_name('<zone name>')
# set cooling on, and a setpoint of 75 degrees
zone.set_permanent_cool_setpoint(75)
```
See [https://csm10495.github.io/pyhtcc/](https://csm10495.github.io/pyhtcc/) for full API documentation.
# CLI Syntax
<!-- MARKDOWN-AUTO-DOCS:START (CODE:src=./help_output.txt) -->
<!-- The below code snippet is automatically added from ./help_output.txt -->
```txt
usage: pyhtcc [-h] [-u USER] [-p PASSWORD] [-n NAME] [-s] [-d] [-l]
[-H HEAT | -C COOL]
A CLI to perform actions on a Honeywell Total Comfort Connect thermostat
system
options:
-h, --help show this help message and exit
-u USER, --user USER Username to login to TCC. If not given uses the
environment variable PYHTCC_EMAIL
-p PASSWORD, --password PASSWORD
Password to login to TCC. If not given uses the
environment variable PYHTCC_PASS. If neither are
given, will prompt for user input.
-n NAME, --name NAME Thermostat name to target. If not given, targets all
zones
-s, --show-info If given, will show info and quit.
-d, --debug If given, will log to stdout
-l, --logout if given, will logout from TCC after performing
actions.
-H HEAT, --heat HEAT Set a target heat temperature
-C COOL, --cool COOL Set a target cooling temperature
```
<!-- MARKDOWN-AUTO-DOCS:END -->
## License
MIT License
Raw data
{
"_id": null,
"home_page": "http://github.com/csm10495/pyhtcc",
"name": "pyhtcc",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "csm10495",
"author_email": "csm10495@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f2/27/628797a3e7319afd9e77eb04071161ca442f8c79045731d8708091bead00/pyhtcc-0.1.56.tar.gz",
"platform": null,
"description": "[](https://github.com/csm10495/pyhtcc/actions/workflows/test_and_release.yml) \n\n# PyHTCC\n\nAn (unofficial) library for interfacing with a Honeywell Total Connect Comfort (TCC) thermostat system. It includes both a simple CLI and an API.\n\n# Installation\n```\npip install pyhtcc\n```\n\n# Simple API Example\n```\nfrom pyhtcc import PyHTCC\np = PyHTCC(<TCC username>, <TCC password>)\nzone = p.get_zone_by_name('<zone name>')\n\n# set cooling on, and a setpoint of 75 degrees\nzone.set_permanent_cool_setpoint(75)\n```\nSee [https://csm10495.github.io/pyhtcc/](https://csm10495.github.io/pyhtcc/) for full API documentation.\n\n# CLI Syntax\n\n<!-- MARKDOWN-AUTO-DOCS:START (CODE:src=./help_output.txt) -->\n<!-- The below code snippet is automatically added from ./help_output.txt -->\n```txt\nusage: pyhtcc [-h] [-u USER] [-p PASSWORD] [-n NAME] [-s] [-d] [-l]\n [-H HEAT | -C COOL]\n\nA CLI to perform actions on a Honeywell Total Comfort Connect thermostat\nsystem\n\noptions:\n -h, --help show this help message and exit\n -u USER, --user USER Username to login to TCC. If not given uses the\n environment variable PYHTCC_EMAIL\n -p PASSWORD, --password PASSWORD\n Password to login to TCC. If not given uses the\n environment variable PYHTCC_PASS. If neither are\n given, will prompt for user input.\n -n NAME, --name NAME Thermostat name to target. If not given, targets all\n zones\n -s, --show-info If given, will show info and quit.\n -d, --debug If given, will log to stdout\n -l, --logout if given, will logout from TCC after performing\n actions.\n -H HEAT, --heat HEAT Set a target heat temperature\n -C COOL, --cool COOL Set a target cooling temperature\n```\n<!-- MARKDOWN-AUTO-DOCS:END -->\n\n## License\nMIT License\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": null,
"version": "0.1.56",
"project_urls": {
"Homepage": "http://github.com/csm10495/pyhtcc"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e8de8b4374d1db0bbdf006e5e9e40ac7e1b37897bc23b06c12c5118d5738d7d8",
"md5": "aa321166deae92d922e69ade2b345fef",
"sha256": "4f834615875d31efad4551a9418e010da7ca88969c347c52fc6c185f064250a2"
},
"downloads": -1,
"filename": "pyhtcc-0.1.56-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aa321166deae92d922e69ade2b345fef",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 10490,
"upload_time": "2024-04-04T03:27:54",
"upload_time_iso_8601": "2024-04-04T03:27:54.472964Z",
"url": "https://files.pythonhosted.org/packages/e8/de/8b4374d1db0bbdf006e5e9e40ac7e1b37897bc23b06c12c5118d5738d7d8/pyhtcc-0.1.56-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f227628797a3e7319afd9e77eb04071161ca442f8c79045731d8708091bead00",
"md5": "4912d7f7837c56a10c471f3c03dfd73f",
"sha256": "92c6293b48c8c67c5e435f8121ac546c82310fd7a092a610eed73ea6b21492f1"
},
"downloads": -1,
"filename": "pyhtcc-0.1.56.tar.gz",
"has_sig": false,
"md5_digest": "4912d7f7837c56a10c471f3c03dfd73f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 10865,
"upload_time": "2024-04-04T03:27:56",
"upload_time_iso_8601": "2024-04-04T03:27:56.141096Z",
"url": "https://files.pythonhosted.org/packages/f2/27/628797a3e7319afd9e77eb04071161ca442f8c79045731d8708091bead00/pyhtcc-0.1.56.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-04 03:27:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "csm10495",
"github_project": "pyhtcc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pyhtcc"
}
JSON
