# Thermia Online API
### A Python API for Thermia heat pumps using https://online.thermia.se
## Confirmed Thermia models that API supports:
It is hard for me to keep track of all models that I have added feature support for in the past, so, to understand if your model is supported, please try running the example file and see if it works. If it does not, please submit a bug report.
### Regarding unsupported models
I am willing to do my best to support them, but as there turns out to be many different Thermia models and configurations, it is hard for me to implement all functionalities and test them thoroughly.
Thus, I have created a `debug()` function that runs when `example.py` is executed and creates a `debug.txt` file which has data about your heat pump and all its supported features. If you want to submit a bug or feature request, please include the debug file as it will make my development much easier.
**Note:** I have done my best to remove the sensitive parts from debugging, but I do not guarantee that no sensitive data is printed to the debug file. I have no intention of using it maliciously, but if you post the file publicly on GitHub, please make sure you remove anything you feel might be suspicious of sharing.
## Supported APIs:
* `classic`, default, online access url is https://online.thermia.se
* `genesis`, online access url is https://online-genesis.thermia.se
## How to use api:
See [example.py](https://github.com/klejejs/python-thermia-online-api/blob/main/example.py) file for examples.
To execute the example file, first run `pip install -r requirements.txt` to install the required dependencies, then run `python3 example.py` to execute the example file. You will be prompted to enter your username and password, and then the example file will run. If do not want to manually enter your credentials every time, you can edit the `credentials.py` file and add your credentials there.
## Available functions in Thermia class:
| Function | Description |
| --- | --- |
| `fetch_heat_pumps()` | Fetches all heat pumps from Thermia Online API and their data |
| `update_data()` | Updates all heat pump data |
## Available properties within ThermiaHeatPump class:
| Property | Description |
| --- | --- |
| `name` | Name of the Heat Pump |
| `id` | Unique ID of the Heat Pump Thermia generates |
| `is_online` | Boolean value indicating if the Heat Pump is online or not |
| `model` | Model of the Heat Pump |
| `last_online` | DateTime string indicating the last time the Heat Pump was online |
| `has_indoor_temperature_sensor` | Boolean value indicating if the Heat Pump has an indoor temperature sensor |
| `indoor_temperature` | Indoor temperature in Celsius, if `has_indoor_temperature_sensor` is False, this value is the same as `heat_temperature` |
| `is_outdoor_temp_sensor_functioning` | Boolean value indicating if the Heat Pump has an outdoor temperature sensor |
| `outdoor_temperature` | Outdoor temperature in Celsius |
| `is_hot_water_active` | Boolean value indicating if the Heat Pump is heating water |
| `hot_water_temperature` | Hot water temperature in Celsius |
| `heat_temperature` | Heat Pump heating target temperature in Celsius |
| `heat_min_temperature_value` | Minimum temperature value possible for Heat Pump to set |
| `heat_max_temperature_value` | Maximum temperature value possible for Heat Pump to set |
| `heat_temperature_step` | Step value for temperature setting |
| --- | --- |
| Other temperatures | |
| `supply_line_temperature` | Supply line temperature in Celsius |
| `buffer_tank_temperature` | Buffer tank temperature in Celsius |
| `desired_supply_line_temperature` | Desired supply line temperature in Celsius |
| `return_line_temperature` | Return line temperature in Celsius |
| `brine_out_temperature` | Brine out temperature in Celsius |
| `brine_in_temperature` | Brine in temperature in Celsius |
| `cooling_tank_temperature` | Cooling tank temperature in Celsius |
| `cooling_supply_line_temperature` | Cooling supply line temperature in Celsius |
| --- | --- |
| Operational status | |
| `running_operational_statuses` | List of running operational statuses of the Heat Pump |
| `available_operational_statuses` | List of available operational statuses |
| `available_operational_statuses_map` | Dictionary mapping operational status names to their values |
| `operational_status_auxiliary_heater_3kw` | Auxiliary heater status for 3kw (returns `None` if unavailable) |
| `operational_status_auxiliary_heater_6kw` | Auxiliary heater status for 6kw (returns `None` if unavailable) |
| `operational_status_auxiliary_heater_9kw` | Auxiliary heater status for 9kw (returns `None` if unavailable) |
| `operational_status_auxiliary_heater_12kw` | Auxiliary heater status for 12kw (returns `None` if unavailable) |
| `operational_status_auxiliary_heater_15kw` | Auxiliary heater status for 15kw (returns `None` if unavailable) |
| `operational_status_compressor_status` | Compressor status |
| `operational_status_brine_pump_status` | Brine pump status |
| `operational_status_radiator_pump_status` | Radiator pump status |
| `operational_status_cooling_status` | Cooling status |
| `operational_status_hot_water_status` | Hot water status |
| `operational_status_heating_status` | Heating status |
| `operational_status_integral` | Integral |
| `operational_status_pid` | PID |
| --- | --- |
| Operational Times | |
| `compressor_operational_time` | Compressor operational time in hours |
| `hot_water_operational_time` | Hot water operational time in hours |
| `auxiliary_heater_1_operational_time` | Auxiliary heater 1 operational time in hours |
| `auxiliary_heater_2_operational_time` | Auxiliary heater 2 operational time in hours |
| `auxiliary_heater_3_operational_time` | Auxiliary heater 3 operational time in hours |
| --- | --- |
| Alarms data | |
| `active_alarm_count` | Number of active alarms on the Heat Pump |
| `active_alarms` | List of titles of active alarms on the Heat Pump |
| --- | --- |
| Operation Mode data | |
| `operation_mode` | Current operation mode of the Heat Pump |
| `available_operation_modes` | List of available operation modes for the Heat Pump |
| `available_operation_mode_map` | Dictionary mapping operation mode names to their values |
| `is_operation_mode_read_only` | Boolean value indicating if the Heat Pump operation mode is read-only |
| --- | --- |
| Hot Water data | |
| `hot_water_switch_state` | Int value indicating the Heat Pump hot water switch state (0 or 1) or None if not available |
| `hot_water_boost_switch_state` | Int value indicating the Heat Pump hot water boost switch state (0 or 1) or None if not available |
| --- | --- |
| Historical data | |
| `historical_data_registers` | List of available registers to use for historical data fetching |
## Available functions within ThermiaHeatPump class:
| Function | Description |
| --- | --- |
| `update_data()` | Refetch all data from Thermia for Heat Pump |
| --- | --- |
| `get_all_available_register_groups()` | Return a list of all available register groups for the heat pump |
| `get_available_registers_for_group(register_group)` | Return a list of all available registers for specified register group |
| `get_register_data_by_register_group_and_name(register_group, register_name)` | Return data for specified register group and name |
| `set_register_data_by_register_group_and_name(register_group, register_name, value)` | Set register value for specified register group and name |
| --- | --- |
| Change heat pump state | |
| `set_temperature()` | Set the target temperature for the Heat Pump |
| `set_operation_mode()` | Set the operation mode for the Heat Pump |
| `set_hot_water_switch_state()` | Set the hot water switch state to 0 (off) or 1 (on) for the Heat Pump |
| `set_hot_water_boost_switch_state()` | Set the hot water boost switch state to 0 (off) or 1 (on) for the Heat Pump |
| --- | --- |
| Fetch historical data | |
| `get_historical_data_for_register()` | Fetch historical data by using register name from `historical_data_registers` together with start_time and end_time of the data in Python datatime format. Returns list of dictionaries which contains data in format `{ "time": datetime, "value": int }` |
| --- | --- |
| Fetch debug data | |
| `debug()` | Fetch debug data from Thermia API and save it to `debug.txt` file |
Raw data
{
"_id": null,
"home_page": "https://github.com/klejejs/python-thermia-online-api",
"name": "ThermiaOnlineAPI",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Thermia, Online",
"author": "Krisjanis Lejejs",
"author_email": "krisjanis.lejejs@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/2c/3b/5686db988e192ad3b5d3d2fb3b635a557f52d3d84bade1aabd739c4cbcc6/thermiaonlineapi-4.2.0.tar.gz",
"platform": null,
"description": "# Thermia Online API\n### A Python API for Thermia heat pumps using https://online.thermia.se\n\n## Confirmed Thermia models that API supports:\nIt is hard for me to keep track of all models that I have added feature support for in the past, so, to understand if your model is supported, please try running the example file and see if it works. If it does not, please submit a bug report.\n\n### Regarding unsupported models\nI am willing to do my best to support them, but as there turns out to be many different Thermia models and configurations, it is hard for me to implement all functionalities and test them thoroughly.\nThus, I have created a `debug()` function that runs when `example.py` is executed and creates a `debug.txt` file which has data about your heat pump and all its supported features. If you want to submit a bug or feature request, please include the debug file as it will make my development much easier.\n\n**Note:** I have done my best to remove the sensitive parts from debugging, but I do not guarantee that no sensitive data is printed to the debug file. I have no intention of using it maliciously, but if you post the file publicly on GitHub, please make sure you remove anything you feel might be suspicious of sharing.\n\n## Supported APIs:\n* `classic`, default, online access url is https://online.thermia.se\n* `genesis`, online access url is https://online-genesis.thermia.se\n\n## How to use api:\nSee [example.py](https://github.com/klejejs/python-thermia-online-api/blob/main/example.py) file for examples.\n\nTo execute the example file, first run `pip install -r requirements.txt` to install the required dependencies, then run `python3 example.py` to execute the example file. You will be prompted to enter your username and password, and then the example file will run. If do not want to manually enter your credentials every time, you can edit the `credentials.py` file and add your credentials there.\n\n## Available functions in Thermia class:\n| Function | Description |\n| --- | --- |\n| `fetch_heat_pumps()` | Fetches all heat pumps from Thermia Online API and their data |\n| `update_data()` | Updates all heat pump data |\n\n## Available properties within ThermiaHeatPump class:\n| Property | Description |\n| --- | --- |\n| `name` | Name of the Heat Pump |\n| `id` | Unique ID of the Heat Pump Thermia generates |\n| `is_online` | Boolean value indicating if the Heat Pump is online or not |\n| `model` | Model of the Heat Pump |\n| `last_online` | DateTime string indicating the last time the Heat Pump was online |\n| `has_indoor_temperature_sensor` | Boolean value indicating if the Heat Pump has an indoor temperature sensor |\n| `indoor_temperature` | Indoor temperature in Celsius, if `has_indoor_temperature_sensor` is False, this value is the same as `heat_temperature` |\n| `is_outdoor_temp_sensor_functioning` | Boolean value indicating if the Heat Pump has an outdoor temperature sensor |\n| `outdoor_temperature` | Outdoor temperature in Celsius |\n| `is_hot_water_active` | Boolean value indicating if the Heat Pump is heating water |\n| `hot_water_temperature` | Hot water temperature in Celsius |\n| `heat_temperature` | Heat Pump heating target temperature in Celsius |\n| `heat_min_temperature_value` | Minimum temperature value possible for Heat Pump to set |\n| `heat_max_temperature_value` | Maximum temperature value possible for Heat Pump to set |\n| `heat_temperature_step` | Step value for temperature setting |\n| --- | --- |\n| Other temperatures | |\n| `supply_line_temperature` | Supply line temperature in Celsius |\n| `buffer_tank_temperature` | Buffer tank temperature in Celsius |\n| `desired_supply_line_temperature` | Desired supply line temperature in Celsius |\n| `return_line_temperature` | Return line temperature in Celsius |\n| `brine_out_temperature` | Brine out temperature in Celsius |\n| `brine_in_temperature` | Brine in temperature in Celsius |\n| `cooling_tank_temperature` | Cooling tank temperature in Celsius |\n| `cooling_supply_line_temperature` | Cooling supply line temperature in Celsius |\n| --- | --- |\n| Operational status | |\n| `running_operational_statuses` | List of running operational statuses of the Heat Pump |\n| `available_operational_statuses` | List of available operational statuses |\n| `available_operational_statuses_map` | Dictionary mapping operational status names to their values |\n| `operational_status_auxiliary_heater_3kw` | Auxiliary heater status for 3kw (returns `None` if unavailable) |\n| `operational_status_auxiliary_heater_6kw` | Auxiliary heater status for 6kw (returns `None` if unavailable) |\n| `operational_status_auxiliary_heater_9kw` | Auxiliary heater status for 9kw (returns `None` if unavailable) |\n| `operational_status_auxiliary_heater_12kw` | Auxiliary heater status for 12kw (returns `None` if unavailable) |\n| `operational_status_auxiliary_heater_15kw` | Auxiliary heater status for 15kw (returns `None` if unavailable) |\n| `operational_status_compressor_status` | Compressor status |\n| `operational_status_brine_pump_status` | Brine pump status |\n| `operational_status_radiator_pump_status` | Radiator pump status |\n| `operational_status_cooling_status` | Cooling status |\n| `operational_status_hot_water_status` | Hot water status |\n| `operational_status_heating_status` | Heating status |\n| `operational_status_integral` | Integral |\n| `operational_status_pid` | PID |\n| --- | --- |\n| Operational Times | |\n| `compressor_operational_time` | Compressor operational time in hours |\n| `hot_water_operational_time` | Hot water operational time in hours |\n| `auxiliary_heater_1_operational_time` | Auxiliary heater 1 operational time in hours |\n| `auxiliary_heater_2_operational_time` | Auxiliary heater 2 operational time in hours |\n| `auxiliary_heater_3_operational_time` | Auxiliary heater 3 operational time in hours |\n| --- | --- |\n| Alarms data | |\n| `active_alarm_count` | Number of active alarms on the Heat Pump |\n| `active_alarms` | List of titles of active alarms on the Heat Pump |\n| --- | --- |\n| Operation Mode data | |\n| `operation_mode` | Current operation mode of the Heat Pump |\n| `available_operation_modes` | List of available operation modes for the Heat Pump |\n| `available_operation_mode_map` | Dictionary mapping operation mode names to their values |\n| `is_operation_mode_read_only` | Boolean value indicating if the Heat Pump operation mode is read-only |\n| --- | --- |\n| Hot Water data | |\n| `hot_water_switch_state` | Int value indicating the Heat Pump hot water switch state (0 or 1) or None if not available |\n| `hot_water_boost_switch_state` | Int value indicating the Heat Pump hot water boost switch state (0 or 1) or None if not available |\n| --- | --- |\n| Historical data | |\n| `historical_data_registers` | List of available registers to use for historical data fetching |\n\n## Available functions within ThermiaHeatPump class:\n| Function | Description |\n| --- | --- |\n| `update_data()` | Refetch all data from Thermia for Heat Pump |\n| --- | --- |\n| `get_all_available_register_groups()` | Return a list of all available register groups for the heat pump |\n| `get_available_registers_for_group(register_group)` | Return a list of all available registers for specified register group |\n| `get_register_data_by_register_group_and_name(register_group, register_name)` | Return data for specified register group and name |\n| `set_register_data_by_register_group_and_name(register_group, register_name, value)` | Set register value for specified register group and name |\n| --- | --- |\n| Change heat pump state | |\n| `set_temperature()` | Set the target temperature for the Heat Pump |\n| `set_operation_mode()` | Set the operation mode for the Heat Pump |\n| `set_hot_water_switch_state()` | Set the hot water switch state to 0 (off) or 1 (on) for the Heat Pump |\n| `set_hot_water_boost_switch_state()` | Set the hot water boost switch state to 0 (off) or 1 (on) for the Heat Pump |\n| --- | --- |\n| Fetch historical data | |\n| `get_historical_data_for_register()` | Fetch historical data by using register name from `historical_data_registers` together with start_time and end_time of the data in Python datatime format. Returns list of dictionaries which contains data in format `{ \"time\": datetime, \"value\": int }` |\n| --- | --- |\n| Fetch debug data | |\n| `debug()` | Fetch debug data from Thermia API and save it to `debug.txt` file |\n",
"bugtrack_url": null,
"license": "GPL-3.0",
"summary": "A Python API for Thermia heat pumps using https://online.thermia.se",
"version": "4.2.0",
"project_urls": {
"Download": "https://github.com/klejejs/python-thermia-online-api/releases",
"Homepage": "https://github.com/klejejs/python-thermia-online-api"
},
"split_keywords": [
"thermia",
" online"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a53e22e2984fee12dd1585aef3acebe452658aa7d91d1246601c097add219ae3",
"md5": "a9138d3f52d6f950bd838b88919c9294",
"sha256": "26bcc0845df00260fbd898e25dc935270ea7276e06f690026eb109a48d606f12"
},
"downloads": -1,
"filename": "ThermiaOnlineAPI-4.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a9138d3f52d6f950bd838b88919c9294",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 29406,
"upload_time": "2024-04-30T21:08:31",
"upload_time_iso_8601": "2024-04-30T21:08:31.696084Z",
"url": "https://files.pythonhosted.org/packages/a5/3e/22e2984fee12dd1585aef3acebe452658aa7d91d1246601c097add219ae3/ThermiaOnlineAPI-4.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2c3b5686db988e192ad3b5d3d2fb3b635a557f52d3d84bade1aabd739c4cbcc6",
"md5": "07310d5d09131b0fc2f4496bde899c4b",
"sha256": "d6bcb63c7173bb41732dc946e8174386b9dc0c94ea3c373e9e2eb7d601c66566"
},
"downloads": -1,
"filename": "thermiaonlineapi-4.2.0.tar.gz",
"has_sig": false,
"md5_digest": "07310d5d09131b0fc2f4496bde899c4b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 29523,
"upload_time": "2024-04-30T21:08:33",
"upload_time_iso_8601": "2024-04-30T21:08:33.441966Z",
"url": "https://files.pythonhosted.org/packages/2c/3b/5686db988e192ad3b5d3d2fb3b635a557f52d3d84bade1aabd739c4cbcc6/thermiaonlineapi-4.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-30 21:08:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "klejejs",
"github_project": "python-thermia-online-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "requests",
"specs": []
}
],
"lcname": "thermiaonlineapi"
}
JSON
