public/openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[Documentation] Markdown improvements n to s (#13948)

Browse Source 
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
This commit is contained in:
Jerome Luckenbach
2022-12-14 16:52:43 +01:00
committed by GitHub
parent d73218d882
commit 1ca9baf157
106 changed files with 4506 additions and 4729 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
bundles/org.openhab.binding.renault/README.md
View File

@@ -1,10 +1,9 @@
# Renault Binding
This binding allows MyRenault App. users to get battery status and other data from their cars.
This binding allows MyRenault App. users to get battery status and other data from their cars.
They can also heat their cars by turning ON the HVAC status and toggle the car's charging mode.
The binding translates the [python based renault-api](https://renault-api.readthedocs.io/en/latest/) in an easy to use openHAB java binding.
The binding translates the [python based renault-api](https://renault-api.readthedocs.io/en/latest/) in an easy to use openHAB java binding.
## Supported Things
@@ -12,12 +11,10 @@ Supports MyRenault registered cars with an active Connected-Services account.
This binding can only retrieve information that is available in the MyRenault App.
## Discovery
No discovery
## Thing Configuration
You require your MyRenault credential, locale and VIN for your MyRenault registered car.
@@ -30,8 +27,7 @@ You require your MyRenault credential, locale and VIN for your MyRenault registe
| vin | Vehicle Identification Number. | yes |
| refreshInterval | Interval the car is polled in minutes. | no |
| updateDelay | How long to wait for commands to reach car and update to server in seconds.| no |
| kamereonApiKey | Kamereon API Key. | no |
| kamereonApiKey | Kamereon API Key. | no |
## Channels
@@ -52,26 +48,24 @@ You require your MyRenault credential, locale and VIN for your MyRenault registe
| location | Location | The GPS position of the vehicle | Yes |
| locationupdated | DateTime | Timestamp of the last location update | Yes |
## Limitations
Some channels may not work depending on your car and MyRenault account.
The "externaltemperature" only works on a few cars.
The "hvactargettemperature" is used by the hvacstatus ON command for pre-conditioning the car.
The "hvactargettemperature" is used by the hvacstatus ON command for pre-conditioning the car.
This seams to only allow values 19, 20 and 21 or else the pre-conditioning command will not work.
The Kamereon API Key changes periodically, which causes a communication error.
To fix this error update the API Key in the bindings configuration.
The new key value can hopefully be found in the renault-api project: [KAMEREON_APIKEY value](https://github.com/hacf-fr/renault-api/blob/main/src/renault_api/const.py) or in the openHAB forums.
## Example
renaultcar.sitemap:
```
```perl
sitemap renaultcar label="Renault Car" {
Frame {
Image item=RenaultCar_ImageURL
@@ -93,20 +87,20 @@ sitemap renaultcar label="Renault Car" {
![Sitemap](doc/sitemap.png)
If you want to limit the charge of the car battery to less than 100%, this can be done as follows.
* Set up an active dummy charge schedule in the MyRenault App.
If you want to limit the charge of the car battery to less than 100%, this can be done as follows.
* Create a Dimmer item "RenaultCar_ChargeLimit" and set it to 80% for example.
- Set up an active dummy charge schedule in the MyRenault App.
* Add the ChargeRenaultCarLimit rule using the code below.
- Create a Dimmer item "RenaultCar_ChargeLimit" and set it to 80% for example.
The rule will change the RenaultCar_ChargingMode to schedule_mode when the limit is reached.
- Add the ChargeRenaultCarLimit rule using the code below.
The rule will change the RenaultCar_ChargingMode to schedule_mode when the limit is reached.
This stops charging after the battery level goes over the charge limit.
ChargeRenaultCarLimit Code
```
```javascript
configuration: {}
triggers:
- id: "1"