| Name | hcalory-control JSON |
| Version |
0.1.5
JSON |
| download |
| home_page | None |
| Summary | A tool for controlling Hcalory diesel heaters over Bluetooth. |
| upload_time | 2024-11-24 00:04:26 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | None |
| keywords |
ble
bluetooth
diesel
hcalory
heater
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
## hcalory-control
A little tool to control BLE-capable Hcalory heaters. This has only been tested on the Hcalory W1 model.
### CLI Usage
```
❯ hcalory-control --help
usage: hcalory-control [-h] --address ADDRESS {start_heat,stop_heat,up,down,gear,thermostat,pump_data}
positional arguments:
{start_heat,stop_heat,up,down,gear,thermostat,pump_data}
options:
-h, --help show this help message and exit
--address ADDRESS Bluetooth MAC address of heater
```
To get the current state of the heater, use `pump_data`:
```
❯ hcalory-control --address ec:b1:c3:00:4d:61 pump_data
{
"ambient_temperature": 87,
"body_temperature": 226,
"heater_mode": "thermostat",
"heater_setting": 74,
"heater_state": "running",
"voltage": 13
}
```
Temperature/"gear" mode changes are done by incrementing/decrementing, not by setting the absolute value you want:
```
❯ hcalory-control --address ec:b1:c3:00:4d:61 up
Before command:
{
"ambient_temperature": 86,
"body_temperature": 219,
"heater_mode": "thermostat",
"heater_setting": 74,
"heater_state": "running",
"voltage": 13
}
After command:
{
"ambient_temperature": 86,
"body_temperature": 219,
"heater_mode": "thermostat",
"heater_setting": 75,
"heater_state": "running",
"voltage": 13
}
```
### Usage as a library
The `main` and `run_command` functions should serve as a decent example. Getting the current running state out of these heaters is _weird_. In order to get your notification on the read characteristic to give you anything, you have to ask the heater to send something by writing to the write characteristic. The official app does this once a second, which seems _wildly_ inefficient to me. I've no idea why they didn't just make the heater push data out on its own when things changed.
Raw data
{
"_id": null,
"home_page": null,
"name": "hcalory-control",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "ble, bluetooth, diesel, hcalory, heater",
"author": null,
"author_email": "Evan Foster <evan@fos.tech>",
"download_url": "https://files.pythonhosted.org/packages/89/fc/4faec317bf3c424deaca43dbe3ce5d34dc1cd8d7c800c39ce4a42a84a1ae/hcalory_control-0.1.5.tar.gz",
"platform": null,
"description": "## hcalory-control\n\nA little tool to control BLE-capable Hcalory heaters. This has only been tested on the Hcalory W1 model.\n\n### CLI Usage\n\n```\n\u276f hcalory-control --help\nusage: hcalory-control [-h] --address ADDRESS {start_heat,stop_heat,up,down,gear,thermostat,pump_data}\n\npositional arguments:\n {start_heat,stop_heat,up,down,gear,thermostat,pump_data}\n\noptions:\n -h, --help show this help message and exit\n --address ADDRESS Bluetooth MAC address of heater\n```\n\nTo get the current state of the heater, use `pump_data`:\n```\n\u276f hcalory-control --address ec:b1:c3:00:4d:61 pump_data\n{\n \"ambient_temperature\": 87,\n \"body_temperature\": 226,\n \"heater_mode\": \"thermostat\",\n \"heater_setting\": 74,\n \"heater_state\": \"running\",\n \"voltage\": 13\n}\n```\n\nTemperature/\"gear\" mode changes are done by incrementing/decrementing, not by setting the absolute value you want:\n```\n\u276f hcalory-control --address ec:b1:c3:00:4d:61 up\nBefore command:\n{\n \"ambient_temperature\": 86,\n \"body_temperature\": 219,\n \"heater_mode\": \"thermostat\",\n \"heater_setting\": 74,\n \"heater_state\": \"running\",\n \"voltage\": 13\n}\nAfter command:\n{\n \"ambient_temperature\": 86,\n \"body_temperature\": 219,\n \"heater_mode\": \"thermostat\",\n \"heater_setting\": 75,\n \"heater_state\": \"running\",\n \"voltage\": 13\n}\n```\n\n### Usage as a library\nThe `main` and `run_command` functions should serve as a decent example. Getting the current running state out of these heaters is _weird_. In order to get your notification on the read characteristic to give you anything, you have to ask the heater to send something by writing to the write characteristic. The official app does this once a second, which seems _wildly_ inefficient to me. I've no idea why they didn't just make the heater push data out on its own when things changed.\n",
"bugtrack_url": null,
"license": null,
"summary": "A tool for controlling Hcalory diesel heaters over Bluetooth.",
"version": "0.1.5",
"project_urls": {
"Repository": "https://github.com/evanfoster/hcalory-control"
},
"split_keywords": [
"ble",
" bluetooth",
" diesel",
" hcalory",
" heater"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f55c724e3b3c27ee27deab73e5511ba86aa0a409111b81d5279d28027718741b",
"md5": "36058406b1f62822a72287f5a2ffc107",
"sha256": "ac9f76f1d08d483c2eb7e63c3ec7198516811caa79a07e4b2391d7a7ffb99529"
},
"downloads": -1,
"filename": "hcalory_control-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "36058406b1f62822a72287f5a2ffc107",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 8665,
"upload_time": "2024-11-24T00:04:24",
"upload_time_iso_8601": "2024-11-24T00:04:24.899160Z",
"url": "https://files.pythonhosted.org/packages/f5/5c/724e3b3c27ee27deab73e5511ba86aa0a409111b81d5279d28027718741b/hcalory_control-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "89fc4faec317bf3c424deaca43dbe3ce5d34dc1cd8d7c800c39ce4a42a84a1ae",
"md5": "0a994b0cd513e03b7286f1f1f712f7d7",
"sha256": "d77ae2d87205680acaeb53530580bc87ac5fdea035218ac417902f1f960bd8e7"
},
"downloads": -1,
"filename": "hcalory_control-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "0a994b0cd513e03b7286f1f1f712f7d7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 26965,
"upload_time": "2024-11-24T00:04:26",
"upload_time_iso_8601": "2024-11-24T00:04:26.552389Z",
"url": "https://files.pythonhosted.org/packages/89/fc/4faec317bf3c424deaca43dbe3ce5d34dc1cd8d7c800c39ce4a42a84a1ae/hcalory_control-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-24 00:04:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "evanfoster",
"github_project": "hcalory-control",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "hcalory-control"
}
