Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Copy edit of the docs and strings #1488

Merged
merged 9 commits into from
Jan 3, 2025
Merged

Copy edit of the docs and strings #1488

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4b340b6
Update configuration.md
Moohan Nov 22, 2024
c241918
Rename debuggin.md to debugging.md
Moohan Nov 22, 2024
614ac04
Update debugging.md
Moohan Nov 22, 2024
2338ad7
Update modes.md
Moohan Nov 22, 2024
3248158
Update supported.md
Moohan Nov 22, 2024
0936be7
Update schedule.md
Moohan Nov 22, 2024
d6f8aab
Update strings.json
Moohan Nov 22, 2024
1ca28e9
Update CONTRIBUTING.md
Moohan Nov 22, 2024
c0d412f
Update pull_request_template.md
Moohan Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
## Related issue (check one):

- [ ] fixes #<issue number goes here>
- [ ] there is no related issue ticket
- [ ] There is no related issue ticket

## Checklist (check one):

Expand All @@ -14,17 +14,17 @@

## Test-Hardware list (for code changes)

<!-- Please specify your hardware/software which was used to test the code locally: -->
<!-- Please specify the hardware/software which was used to test the code locally: -->

HA Version:
Zigbee2MQTT Version:
TRV Hardware:

## New device mappings

<!-- If there was a new device mapping added, please make sure to fill in this checklist: -->
<!-- If a new device mapping has been added, please make sure to fill in this checklist: -->

- [ ] I avoided any changes to other device mappings
- [ ] There are no changes in `climate.py`

<!-- If you did change the `climate.py` please create a dedicated PR for this. -->
<!-- If you changed the `climate.py` please create a dedicated PR for this. -->
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,16 @@ document in a pull request.

#### Nice to know

- Debuging is possible with the VSCode Debuger. Just run the HomeAssistant in Debugger and open browser on http://localhost:9123 (No task run needed)
- Debugging is possible with the VSCode Debugger. Just run the HomeAssistant in Debugger and open your browser to http://localhost:9123 (No task run needed)
- Update your local in devcontainer configuration.yaml to the current version of the repository to get the latest changes. -> Run "Sync configuration.yaml (Override local)" in Task Runner
- Test BT in a specific HA version -> Run "Install a specific version of Home Assistant" in Task Runner and the the version you want to test in the terminal promt.
- Test BT with the latest HA version -> Run "pgrade Home Assistant to latest dev" in Task Runner
- Test BT in a specific HA version -> Run "Install a specific version of Home Assistant" in Task Runner and the version you want to test in the terminal prompt.
- Test BT with the latest HA version -> Run "upgrade Home Assistant to latest dev" in Task Runner

## How Can I Contribute?

## New Adapter

If you want to add a new adapter, please create a new python file with the name of the adapter in the adapters folder. The file should contain all functions find in the generic.py. The if you adapter needs a special handling for one of the base functions, override it, if you can use generic functions, use them like:
If you want to add a new adapter, please create a new Python file with the name of the adapter in the adapters folder. The file should contain all functions found in the generic.py. If your adapter needs special handling for one of the base functions, override it, if you can use generic functions, use them like:

```python
async def set_temperature(self, entity_id, temperature):
Expand All @@ -55,4 +55,4 @@ https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html

## Setup

Install the pip install pre-commit used for pre-commit hooks.
Install the pip install pre-commit used for pre-commit hooks.
53 changes: 26 additions & 27 deletions custom_components/better_thermostat/strings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,30 +10,30 @@
"temperature_sensor": "Temperature sensor",
"humidity_sensor": "Humidity sensor",
"window_sensors": "Window sensor",
"off_temperature": "The outdoor temperature when the thermostat turn off",
"tolerance": "Tolerance, to prevent the thermostat from turning on and off too often.",
"window_off_delay": "Delay before the thermostat turn off when the window is opened",
"window_off_delay_after": "Delay before the thermostat turn on when the window is closed",
"outdoor_sensor": "If you have an outdoor sensor, you can use it to get the outdoor temperature",
"weather": "Your weather entity to get the outdoor temperature"
"off_temperature": "The outdoor temperature when the thermostat should turn off",
"tolerance": "Tolerance, to prevent the thermostat from turning on and off too often",
"window_off_delay": "Delay before the thermostat should turn off when the window is opened",
"window_off_delay_after": "Delay before the thermostat should turn on when the window is closed",
"outdoor_sensor": "Outdoor temperature sensor",
"weather": "Weather entity to get the outdoor temperature"
}
},
"advanced": {
"description": "Advanced configuration {trv}\n***Info about calibration types: https://better-thermostat.org/configuration#second-step***",
"data": {
"protect_overheating": "Overheating protection?",
"heat_auto_swapped": "If the auto means heat for your TRV and you want to swap it",
"heat_auto_swapped": "If 'auto' means 'heat' for your TRV and you want to swap it",
"child_lock": "Ignore all inputs on the TRV like a child lock",
"homaticip": "If you use HomaticIP, you should enable this to slow down the requests to prevent the duty cycle",
"valve_maintenance": "If your thermostat has no own maintenance mode, you can use this one",
"calibration": "Calibration Type",
"calibration": "Calibration type",
"calibration_mode": "Calibration mode",
"no_off_system_mode": "If your TRV can't handle the off mode, you can enable this to use target temperature 5°C instead"
"no_off_system_mode": "If your TRV doesn't support the 'off' mode, enable this to use target temperature 5°C instead"
},
"data_description": {
"protect_overheating": "Some TRVs don't close the valve completly when the temperature is reached. Or the radiator have a lot of rest heat. This can cause overheating. This option can prevent this.",
"calibration_mode": "The kind how the calibration should be calculated\n***Normal***: In this mode the TRV internal temperature sensor is fixed by the external temperature sensor.\n***Aggresive***: In this mode the TRV internal temperature sensor is fixed by the external temperature sensor but set much lower/higher to get a quicker boost.\n***AI Time Based***: In this mode the TRV internal temperature sensor is fixed by the external temperature sensor, but the value is calculated by a custom algorithm to improve the TRV internal algorithm.",
"calibration": "How the calibration should be applied on the TRV (Target temp or offset)\n***Target Temperature Based***: Apply the calibration to the target temperature.\n***Offset Based***: Apply the calibration to the offset."
"protect_overheating": "Some TRVs don't close the valve completely when the temperature is reached. Or the radiator has a lot of rest heat. This can cause overheating. This option can prevent this.",
"calibration_mode": "How the calibration is calculated\n***Normal***: In this mode, the TRV internal temperature sensor is fixed by the external temperature sensor.\n***Aggresive***: In this mode, the TRV internal temperature sensor is fixed by the external temperature sensor but set much lower/higher to get a quicker boost.\n***AI Time Based***: In this mode, the TRV internal temperature sensor is fixed by the external temperature sensor, but the value is calculated by a custom algorithm to improve the TRV internal algorithm.",
"calibration": "How the calibration is applied on the TRV\n***Target Temperature Based***: Apply the calibration to the target temperature.\n***Offset Based***: Apply the calibration to the temperature offset."
}
},
"confirm": {
Expand All @@ -44,12 +44,12 @@
"error": {
"failed": "Something went wrong.",
"no_name": "Please enter a name.",
"no_off_mode": "You device is very special and has no off mode :(\nBetter Thermostat will use the minimal target temp instead.",
"no_off_mode": "Your device is special and has no off mode :(\nBetter Thermostat will use the minimal target temp instead.",
"no_outside_temp": "You have no outside temperature sensor. Better Thermostat will use the weather entity instead."
},
"abort": {
"single_instance_allowed": "Only a single Thermostat for each real is allowed.",
"no_devices_found": "No thermostat entity found, make sure you have a climate entity in your home assistant"
"single_instance_allowed": "Only a single Better Thermostat is allowed for each real thermostat.",
"no_devices_found": "No thermostat entity found, make sure you have a climate entity in your Home Assistant"
}
},
"options": {
Expand All @@ -62,14 +62,14 @@
"temperature_sensor": "Temperature Sensor",
"humidity_sensor": "Humidity sensor",
"window_sensors": "Window Sensor",
"off_temperature": "The outdoor temperature when the thermostat turns off",
"tolerance": "Tolerance, to prevent the thermostat from turning on and off too often.",
"window_off_delay": "Delay before the thermostat turns off when the window is opened",
"window_off_delay_after": "Delay before the thermostat turns on when the window is closed",
"outdoor_sensor": "If you have an outdoor sensor, you can use it to get the outdoor temperature",
"off_temperature": "The outdoor temperature when the thermostat should turn off",
"tolerance": "Tolerance, to prevent the thermostat from turning on and off too often",
"window_off_delay": "Delay before the thermostat should turn off when the window is opened",
"window_off_delay_after": "Delay before the thermostat should turn on when the window is closed",
"outdoor_sensor": "Outdoor temperature sensor",
"weather": "Weather entity to get the outdoor temperature"
"valve_maintenance": "If your thermostat has no own maintenance mode, you can use this one",
"calibration": "The sort of calibration https://better-thermostat.org/configuration#second-step",
"weather": "Your weather entity to get the outdoor temperature",
"heat_auto_swapped": "If the auto means heat for your TRV and you want to swap it",
"child_lock": "Ignore all inputs on the TRV like a child lock",
"homaticip": "If you use HomaticIP, you should enable this to slow down the requests to prevent the duty cycle"
Expand All @@ -83,15 +83,14 @@
"child_lock": "Ignore all inputs on the TRV like a child lock",
"homaticip": "If you use HomaticIP, you should enable this to slow down the requests to prevent the duty cycle",
"valve_maintenance": "If your thermostat has no own maintenance mode, you can use this one",
"calibration": "The sort of calibration you want to use",
"calibration": "Calibration type",
"calibration_mode": "Calibration mode",
"no_off_system_mode": "If your TRV can't handle the off mode, you can enable this to use target temperature 5°C instead"
"no_off_system_mode": "If your TRV doesn't support the 'off' mode, enable this to use target temperature 5°C instead"
},
"data_description": {
"protect_overheating": "Some TRVs don't close the valve completely when the temperature is reached. Or the radiator has a lot of rest heat. This can cause overheating. This option can prevent this.",
"calibration_mode": "The kind how the calibration should be calculated\n***Normal***: In this mode, the TRV internal temperature sensor is fixed by the external temperature sensor.\n***Aggresive***: In this mode, the TRV internal temperature sensor is fixed by the external temperature sensor but set much lower/higher to get a quicker boost.\n***AI Time Based***: In this mode, the TRV internal temperature sensor is fixed by the external temperature sensor, but a custom algorithm calculates the value to improve the TRV internal algorithm.",
"calibration": "How the calibration should be applied on the TRV (Target temp or offset)\n***Target Temperature Based***: Apply the calibration to the target temperature.\n***Offset Based***: Apply the calibration to the offset."
}
"calibration_mode": "How the calibration is calculated\n***Normal***: In this mode, the TRV internal temperature sensor is fixed by the external temperature sensor.\n***Aggresive***: In this mode, the TRV internal temperature sensor is fixed by the external temperature sensor but set much lower/higher to get a quicker boost.\n***AI Time Based***: In this mode, the TRV internal temperature sensor is fixed by the external temperature sensor, but the value is calculated by a custom algorithm to improve the TRV internal algorithm.",
"calibration": "How the calibration is applied on the TRV\n***Target Temperature Based***: Apply the calibration to the target temperature.\n***Offset Based***: Apply the calibration to the temperature offset." }
}
}
},
Expand Down Expand Up @@ -123,7 +122,7 @@
},
"set_temp_target_temperature": {
"name": "Set eco temperature",
"description": "Set the target temperature to a temporay like night mode, and save the old one."
"description": "Set the target temperature to a temporary like night mode, and save the old one."
}
}
}
Loading