demus/openhab-addons
1
0
Fork 0
mirror of https://github.com/openhab/openhab-addons.git synced 2025-01-10 15:11:59 +01:00
Code Issues Packages Projects Releases Wiki Activity

Minor cleanup to README.

Browse Source 
Signed-off-by: Matt Toothman <matt.toothman+openhab@gmail.com>
This commit is contained in:
Matt 2020-09-28 16:29:05 -04:00 committed by Kai Kreuzer
parent 4b91bfcfa0
commit 831eaeb026
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -27,7 +27,7 @@ Furthermore, once an account is configured, it is automatically queried for asso
The `account` bridge requires an OAuth2 refresh token as the only parameter `refreshToken`. The `account` bridge requires an OAuth2 refresh token as the only parameter `refreshToken`.
There are different ways of getting hold of the token: There are two different ways of obtaining the token:
1. Use the openHAB console 1. Use the openHAB console
@ -42,17 +42,17 @@ Refresh token: xxxxxxxxxx
``` ```
When successfully doing the login through the console, openHAB will automatically create an Inbox entry that is preconfigured with the refresh token, which you can now simply approve. When successfully doing the login through the console, openHAB will automatically create an Inbox entry that is preconfigured with the refresh token, which you can now simply approve.
Alternatively, you can use the refresh token to textually configure your `account` bridge or to enter it in a manually created "Tesla Account" thing in the UI. Alternatively, you can use the refresh token to textually configure your `account` bridge or enter it in a manually created "Tesla Account" thing in the UI.
2. Provide your credentials in the UI 2. Provide your credentials in the UI
If you do not want to use the openHAB console, you can also manually create a "Tesla Account" thing in the UI and provide your username and password as parameters (to show them, use the "Show More" button) in the "Edit Thing" view and leave the refresh token parameter field empty. If you do not want to use the openHAB console, you can also manually create a "Tesla Account" thing in the UI by providing your username and password as parameters (to show them, use the "Show More" button) in the "Edit Thing" view and leaving the refresh token parameter field empty.
openHAB will use the provided credentials to retrieve and set the refresh token and automatically delete your password from the configuration afterwards for safety reasons. openHAB will use the provided credentials to retrieve and set the refresh token and automatically delete your password from the configuration afterwards for safety reasons.
## Thing Configuration ## Thing Configuration
The vehicle Things requires the vehicle's VIN as a configuration parameter `vin`. The vehicle Thing requires the vehicle's VIN as a configuration parameter `vin`.
Additionally, the optional boolean parameter `allowWakeup` can be set. This determines whether openHAB is allowed to wake up the vehicle in order to retrieve data from it. This setting is not recommended as it will result in a significant vampire drain (i.e. energy consumption although the vehicle is parking). Additionally, the optional boolean parameter `allowWakeup` can be set. This determines whether openHAB is allowed to wake up the vehicle in order to retrieve data from it. This setting is not recommended as it will result in a significant vampire drain (i.e. energy consumption although the vehicle is parking).
@ -74,7 +74,7 @@ All vehicles support a huge number of channels - the following list shows the st
| speed | Number:Speed | Speed | Vehicle speed | | speed | Number:Speed | Speed | Vehicle speed |
Additionally, these advanced channels are available (while not all of them are available on all vehicle types, like e.g. the sunroof): Additionally, these advanced channels are available (not all are available on all vehicle types, e.g., the sunroof):
| Channel ID | Item Type | Label | Description | | Channel ID | Item Type | Label | Description |
|---------------------------|--------------------------|-------------------------------|------------------------------------------------------------------------------------------------------------------| |---------------------------|--------------------------|-------------------------------|------------------------------------------------------------------------------------------------------------------|
@ -95,21 +95,21 @@ Additionally, these advanced channels are available (while not all of them are a
| chargelimit | Dimmer | Charge Limit | Limit charging of the vehicle to the given % | | chargelimit | Dimmer | Charge Limit | Limit charging of the vehicle to the given % |
| chargelimitmaximum | Dimmer | Charge Limit Maximum | Maximum charging limit of the vehicle, as % | | chargelimitmaximum | Dimmer | Charge Limit Maximum | Maximum charging limit of the vehicle, as % |
| chargelimitminimum | Dimmer | Charge Limit Minimum | Minimum charging limit of the vehicle, as % | | chargelimitminimum | Dimmer | Charge Limit Minimum | Minimum charging limit of the vehicle, as % |
| chargelimitsocstandard | Dimmer | Charge Limit SOC Standard | Standard charging limity of the vehicle, in % | | chargelimitsocstandard | Dimmer | Charge Limit SOC Standard | Standard charging limit of the vehicle, in % |
| chargeidealdistanceadded | Number:Length | "Ideal" Charge Distance Added | "Ideal" range added during the last charging session | | chargeidealdistanceadded | Number:Length | "Ideal" Charge Distance Added | "Ideal" range added during the last charging session |
| chargemaxcurrent | Number:ElectricCurrent | Charge Max Current | Maximum current (Ampere) that can be requested from the charger | | chargemaxcurrent | Number:ElectricCurrent | Charge Max Current | Maximum current (Ampere) that can be requested from the charger |
| chargerateddistanceadded | Number:Length | "Rated" Charge Distance Added | "Rated" range added during the last charging session | | chargerateddistanceadded | Number:Length | "Rated" Charge Distance Added | "Rated" range added during the last charging session |
| chargerate | Number:Speed | Charge Rate | Distance per hour charging rate | | chargerate | Number:Speed | Charge Rate | Distance per hour charging rate |
| chargestartingrange | String | Charge Starting Range | Undocumented / To be defined | | chargestartingrange | String | Charge Starting Range | Undocumented / To be defined |
| chargestartingsoc | String | Charge Starting SOC | Undocumented / To be defined | | chargestartingsoc | String | Charge Starting SOC | Undocumented / To be defined |
| chargetomax | Switch | Charge To Max Range | Indicates if the charging to the maximum range is enabled | | chargetomax | Switch | Charge To Max Range | Indicates if charging to the maximum range is enabled |
| chargercurrent | Number:ElectricCurrent | Charge Current | Current (Ampere) actually being drawn from the charger | | chargercurrent | Number:ElectricCurrent | Charge Current | Current (Ampere) actually being drawn from the charger |
| chargerphases | Number | Charger Phases | Indicates the number of phases (1 to 3) used for charging | | chargerphases | Number | Charger Phases | Indicates the number of phases (1 to 3) used for charging |
| chargermaxcurrent | Number:ElectricCurrent | Charger Maximum Current | Maximum current (Ampere) that can be delivered by the charger | | chargermaxcurrent | Number:ElectricCurrent | Charger Maximum Current | Maximum current (Ampere) that can be delivered by the charger |
| chargerpower | Number | Charger Power | Power actually delivered by the charger | | chargerpower | Number | Charger Power | Power actually delivered by the charger |
| chargervoltage | Number:ElectricPotential | Charger Voltage | Voltage (V) actually presented by the charger | | chargervoltage | Number:ElectricPotential | Charger Voltage | Voltage (V) actually presented by the charger |
| driverfrontdoor | Contact | Driver Front Door | Indicates if the front door at the driver's side is opened | | driverfrontdoor | Contact | Driver Front Door | Indicates if the front door at the driver's side is open |
| driverreardoor | Contact | Driver Rear Door | Indicates if the rear door at the driver's side is opened | | driverreardoor | Contact | Driver Rear Door | Indicates if the rear door at the driver's side is open |
| drivertemp | Number:Temperature | Driver Temperature | Indicates the auto conditioning temperature set at the driver's side | | drivertemp | Number:Temperature | Driver Temperature | Indicates the auto conditioning temperature set at the driver's side |
| eventstamp | DateTime | Event Timestamp | Timestamp of the last event received from the Tesla streaming service | | eventstamp | DateTime | Event Timestamp | Timestamp of the last event received from the Tesla streaming service |
| estimatedbatteryrange | Number:Length | Estimated Battery Range | Estimated battery range | | estimatedbatteryrange | Number:Length | Estimated Battery Range | Estimated battery range |
@ -123,21 +123,21 @@ Additionally, these advanced channels are available (while not all of them are a
| headingestimation | Number | Estimated Heading | Estimated (compass) heading of the car, in 0 to 360 degrees | | headingestimation | Number | Estimated Heading | Estimated (compass) heading of the car, in 0 to 360 degrees |
| honkhorn | Switch | Honk the Horn | Honk the horn of the vehicle, when ON is received | | honkhorn | Switch | Honk the Horn | Honk the horn of the vehicle, when ON is received |
| homelink | Switch | Homelink Nearby | Indicates if the Home Link is nearby | | homelink | Switch | Homelink Nearby | Indicates if the Home Link is nearby |
| idealbatteryrange | Number:Length | Ideal Battery Range | Indicates the Batter Range | | idealbatteryrange | Number:Length | Ideal Battery Range | Indicates the Battery Range |
| lefttempdirection | Number | Left Temperature Direction | Not documented / To be defined | | lefttempdirection | Number | Left Temperature Direction | Not documented / To be defined |
| lastautoparkerror | String | Last Autopark Error | Not documented / To be defined | | lastautoparkerror | String | Last Autopark Error | Not documented / To be defined |
| location" advanced="false | Location | Location | The actual position of the vehicle | | location" advanced="false | Location | Location | The actual position of the vehicle |
| leftseatheater | Switch | Left Seat Heater | Indicates if the left seat heater is switched on | | leftseatheater | Switch | Left Seat Heater | Indicates if the left seat heater is switched on |
| leftrearseatheater | Switch | Left Rear Seat Heater | Indicates if the left rear seat heater is switched on | | leftrearseatheater | Switch | Left Rear Seat Heater | Indicates if the left rear seat heater is switched on |
| leftrearbackseatheater | Number | Left Rear Backseat Heater | Indicates the level (0,1,2 or 3) of the left rear backseat heater | | leftrearbackseatheater | Number | Left Rear Backseat Heater | Indicates the level (0, 1, 2, or 3) of the left rear backseat heater |
| managedcharging | Switch | Managed Charging | Indicates managed charging is active | | managedcharging | Switch | Managed Charging | Indicates if managed charging is active |
| managedchargingcancelled | Switch | Managed Charging Cancelled | Indicates managed charging is cancelled by the user | | managedchargingcancelled | Switch | Managed Charging Cancelled | Indicates if managed charging is cancelled by the user |
| managedchargingstart | String | Managed Charging Start Time | Not documented / To be defined | | managedchargingstart | String | Managed Charging Start Time | Not documented / To be defined |
| maxcharges | Number | Max Charges | Indicates the number of consecutive "Max Range Charges" performed by the vehicle | | maxcharges | Number | Max Charges | Indicates the number of consecutive "Max Range Charges" performed by the vehicle |
| minavailabletemp | Number:Temperature | Minimum Temperature | Indicates the minimal inside temperature of the vehicle | | minavailabletemp | Number:Temperature | Minimum Temperature | Indicates the minimal inside temperature of the vehicle |
| maxavailabletemp | Number:Temperature | Maximum Temperature | Indicates the maximum inside temperature of the vehicle | | maxavailabletemp | Number:Temperature | Maximum Temperature | Indicates the maximum inside temperature of the vehicle |
| mobileenabled | Switch | Mobile Enabled | Indicates whether the vehicle can be remotely controlled | | mobileenabled | Switch | Mobile Enabled | Indicates whether the vehicle can be remotely controlled |
| notenoughpower | Switch | Not Enought Power | Indicates if not enough power (ON) is available to heat the vehicle | | notenoughpower | Switch | Not Enough Power | Indicates if not enough power (ON) is available to heat the vehicle |
| notificationsenabled | Switch | Notifications Enabled | Not documented / To be defined | | notificationsenabled | Switch | Notifications Enabled | Not documented / To be defined |
| notificationssupported | Switch | Notifications Supported | Not documented / To be defined | | notificationssupported | Switch | Notifications Supported | Not documented / To be defined |
| outsidetemp | Number:Temperature | Outside Temperature | Indicates the outside temperature of the vehicle | | outsidetemp | Number:Temperature | Outside Temperature | Indicates the outside temperature of the vehicle |
@ -155,7 +155,7 @@ Additionally, these advanced channels are available (while not all of them are a
| remotestartsupported | Switch | Remote Start Supported | Not documented / To be defined | | remotestartsupported | Switch | Remote Start Supported | Not documented / To be defined |
| rightseatheater | Switch | Right Seat Heater | Indicates if the right seat heater is switched on | | rightseatheater | Switch | Right Seat Heater | Indicates if the right seat heater is switched on |
| rightrearseatheater | Switch | Right Rear Seat Heater | Indicates if the right rear seat heater is switched on | | rightrearseatheater | Switch | Right Rear Seat Heater | Indicates if the right rear seat heater is switched on |
| rightrearbackseatheater | Number | Right Rear Backseat Heater | Indicates the level (0,1,2 or 3) of the right rear backseat heater | | rightrearbackseatheater | Number | Right Rear Backseat Heater | Indicates the level (0, 1, 2, or 3) of the right rear backseat heater |
| righttempdirection | Number | Right Temperature Direction | Not documented / To be defined | | righttempdirection | Number | Right Temperature Direction | Not documented / To be defined |
| scheduledchargingpending | Switch | Scheduled Charging Pending | Indicates if a scheduled charging session is still pending | | scheduledchargingpending | Switch | Scheduled Charging Pending | Indicates if a scheduled charging session is still pending |
| scheduledchargingstart | DateTime | Scheduled Charging Start | Indicates when the scheduled charging session will start, in yyyy-MM-dd'T'HH:mm:ss format | | scheduledchargingstart | DateTime | Scheduled Charging Start | Indicates when the scheduled charging session will start, in yyyy-MM-dd'T'HH:mm:ss format |