]> git.basschouten.com Git - openhab-addons.git/commitdiff
[volvooncall] Clean up readme. (#10976)
authorJames Hewitt <james.hewitt@uk.ibm.com>
Mon, 12 Jul 2021 07:22:00 +0000 (08:22 +0100)
committerGitHub <noreply@github.com>
Mon, 12 Jul 2021 07:22:00 +0000 (09:22 +0200)
Signed-off-by: James Hewitt <james.hewitt@uk.ibm.com>
bundles/org.openhab.binding.volvooncall/README.md

index c6b926a3bc85f5f01017756c6fa91a98dee2503b..aec0a5bc87ca661f5c5ffc67cd90715a2cda8c20 100644 (file)
@@ -41,59 +41,59 @@ The 'VolvoOnCall API' bridge uses the owner's email address and password in orde
 All numeric channels use the [UoM feature](https://openhab.org/blog/2018/02/22/units-of-measurement.html).
 This means you can easily change the desired unit e.g. miles/h instead of km/h just in your item definition.
 
-#####Thing properties
-Some of the channels are only available for specific cars and models.
+Some of the channels are only available for specific cars and models. These properties are added to the Thing
+automatically by the binding when an API call is made.
 
 Following channels are currently available:
 
-| Channel Type ID                               | Item Type            | Description                                      | Remark                                           |
-|-----------------------------------------------|----------------------|--------------------------------------------------|--------------------------------------------------|
-| doors#frontLeft                               | Contact              | Door front left                                  |                                                  |
-| doors#frontRight                              | Contact              | Door front right                                 |                                                  |
-| doors#rearLeft                                | Contact              | Door rear left                                   |                                                  |
-| doors#rearRight                               | Contact              | Door rear right                                  |                                                  |
-| doors#hood                                    | Contact              | Hood                                             |                                                  |
-| doors#tailgate                                | Contact              | Tailgate                                         |                                                  |
-| doors#carLocked                               | Switch               | Is the car locked                                | Can also be used to lock / unlock the car  (see thing properties above)      |
-| windows#frontLeftWnd                          | Contact              | Window front left                                |                                                  |
-| windows#frontRightWnd                         | Contact              | Window front right                               |                                                  |
-| windows#rearLeftWnd                           | Contact              | Window rear left                                 |                                                  |
-| windows#rearRightWnd                          | Contact              | Window rear right                                |                                                  |
-| odometer#odometer                             | Number:Length        | Odometer value                                   |                                                  |
-| odometer#tripmeter1                           | Number:Length        | Trip meter 1 value                               |                                                  |
-| odometer#tripmeter2                           | Number:Length        | Trip meter 2 value                               |                                                  |
-| tank#fuelAmount                               | Number:Volume        | Amount of fuel left in the tank                  |                                                  |
-| tank#fuelLevel                                | Number:Dimensionless | Percentage of fuel left in the tank              |                                                  |
-| tank#fuelAlert                                | Switch               | Alert if the amount of fuel is running low       | ON when distancy to empty < 100                  |
-| tank#distanceToEmpty                          | Number:Length        | Distance till tank is empty                      |                                                  |
-| position#location                             | Location             | Location of the car                              |                                                  |
-| position#locationTimestamp                    | DateTime             | Timestamp of the latest confirmed location       |                                                  |
-| tyrePressure#frontLeftTyre                    | Number               | Tyrepressure front left tyre                     | Normal / LowSoft                                 |
-| tyrePressure#frontRightTyre                   | Number               | Tyrepressure front right tyre                    | Normal / LowSoft                                 |
-| tyrePressure#rearLeftTyre                     | Number               | Tyrepressure rear left tyre                      | Normal / LowSoft                                 |
-| tyrePressure#rearRightTyre                    | Number               | Tyrepressure rear right tyre                     | Normal / LowSoft                                 |
-| other#averageSpeed                            | Number:Speed         | Average speed                                    |                                                  |
-| other#engineRunning                           | Switch               | Is the car engine running                        |                                                  |
-| other#remoteHeater                            | Switch               | Start the car remote heater                      | Only if property 'remoteHeater' is true (see thing properties above)                                                 |
-| other#preclimatization                        | Switch               | Start the car preclimatization                   | Only if property 'preclimatization' is true (see thing properties above)                                                 |
-| other#brakeFluidLevel                         | Number               | Brake fluid level                                | Normal / Low / VeryLow                                                 |
-| other#washerFluidLevel                        | Number               | Washer fluid level                               | Normal / Low / VeryLow                                                 |
-| other#serviceWarning                          | String               | Warning if service is needed                                                                     |
-| other#bulbFailure                             | Switch               | ON if at least one bulb is reported as failed                                                    |
-| battery#batteryLevel                          | Number:Dimensionless | Battery level                                    | Only for Plugin hybrid / Twin Engine models     |
-| battery#batteryDistanceToEmpty                | Number:Length        | Distance until battery is empty                  | Only for Plugin hybrid / Twin Engine models     |
-| battery#chargeStatus                          | String               | Charging status                                  | Only for Plugin hybrid / Twin Engine models     |
-| battery#timeToHVBatteryFullyCharged           | Number:Time          | Time in minutes until the battery is fully charged| Only for Plugin hybrid / Twin Engine models     |
-| battery#chargingEnd                           | DateTime             | Calculated time when the battery is fully charged| Only for Plugin hybrid / Twin Engine models     |
-| lasttrip#tripConsumption                      | Number:Volume        | Last trip fuel consumption                                                                       |
-| lasttrip#tripDistance                         | Number:Length        | Last trip distance                                                                               |
-| lasttrip#tripStartTime                        | DateTime             | Last trip start time                                                                             |
-| lasttrip#tripEndTime                          | DateTime             | Last trip end time                                                                               |
-| lasttrip#tripDuration                         | Number:Time          | Last trip duration                                                                               |
-| lasttrip#tripStartOdometer                    | Number:Length        | Last trip start odometer                                                                         |
-| lasttrip#tripStopOdometer                     | Number:Length        | Last trip stop odometer                                                                          |
-| lasttrip#startPosition                        | Location             | Last trip start location                                                                         |
-| lasttrip#endPosition                          | Location             | Last trip end location                                                                           |
+| Channel Type ID                               | Item Type            | Description                                        | Remark                                         |
+|-----------------------------------------------|----------------------|----------------------------------------------------|------------------------------------------------|
+| doors#frontLeft                               | Contact              | Door front left                                    |                                                |
+| doors#frontRight                              | Contact              | Door front right                                   |                                                |
+| doors#rearLeft                                | Contact              | Door rear left                                     |                                                |
+| doors#rearRight                               | Contact              | Door rear right                                    |                                                |
+| doors#hood                                    | Contact              | Hood                                               |                                                |
+| doors#tailgate                                | Contact              | Tailgate                                           |                                                |
+| doors#carLocked                               | Switch               | Is the car locked                                  | Can also be used to lock / unlock the car. Only if property 'lock' is true. |
+| windows#frontLeftWnd                          | Contact              | Window front left                                  |                                                |
+| windows#frontRightWnd                         | Contact              | Window front right                                 |                                                |
+| windows#rearLeftWnd                           | Contact              | Window rear left                                   |                                                |
+| windows#rearRightWnd                          | Contact              | Window rear right                                  |                                                |
+| odometer#odometer                             | Number:Length        | Odometer value                                     |                                                |
+| odometer#tripmeter1                           | Number:Length        | Trip meter 1 value                                 |                                                |
+| odometer#tripmeter2                           | Number:Length        | Trip meter 2 value                                 |                                                |
+| tank#fuelAmount                               | Number:Volume        | Amount of fuel left in the tank                    |                                                |
+| tank#fuelLevel                                | Number:Dimensionless | Percentage of fuel left in the tank                |                                                |
+| tank#fuelAlert                                | Switch               | Alert if the amount of fuel is running low         | ON when distancy to empty < 100                |
+| tank#distanceToEmpty                          | Number:Length        | Distance till tank is empty                        |                                                |
+| position#location                             | Location             | Location of the car                                |                                                |
+| position#locationTimestamp                    | DateTime             | Timestamp of the latest confirmed location         |                                                |
+| tyrePressure#frontLeftTyre                    | Number               | Tyrepressure front left tyre                       | Normal / LowSoft                               |
+| tyrePressure#frontRightTyre                   | Number               | Tyrepressure front right tyre                      | Normal / LowSoft                               |
+| tyrePressure#rearLeftTyre                     | Number               | Tyrepressure rear left tyre                        | Normal / LowSoft                               |
+| tyrePressure#rearRightTyre                    | Number               | Tyrepressure rear right tyre                       | Normal / LowSoft                               |
+| other#averageSpeed                            | Number:Speed         | Average speed                                      |                                                |
+| other#engineRunning                           | Switch               | Is the car engine running                          |                                                |
+| other#remoteHeater                            | Switch               | Start the car remote heater                        | Only if property 'remoteHeater' is true        |
+| other#preclimatization                        | Switch               | Start the car preclimatization                     | Only if property 'preclimatization' is true    |
+| other#brakeFluidLevel                         | Number               | Brake fluid level                                  | Normal / Low / VeryLow                         |
+| other#washerFluidLevel                        | Number               | Washer fluid level                                 | Normal / Low / VeryLow                         |
+| other#serviceWarning                          | String               | Warning if service is needed                       |                                                |
+| other#bulbFailure                             | Switch               | ON if at least one bulb is reported as failed      |                                                |
+| battery#batteryLevel                          | Number:Dimensionless | Battery level                                      | Only for Plugin hybrid / Twin Engine models    |
+| battery#batteryDistanceToEmpty                | Number:Length        | Distance until battery is empty                    | Only for Plugin hybrid / Twin Engine models    |
+| battery#chargeStatus                          | String               | Charging status                                    | Only for Plugin hybrid / Twin Engine models    |
+| battery#timeToHVBatteryFullyCharged           | Number:Time          | Time in minutes until the battery is fully charged | Only for Plugin hybrid / Twin Engine models    |
+| battery#chargingEnd                           | DateTime             | Calculated time when the battery is fully charged  | Only for Plugin hybrid / Twin Engine models    |
+| lasttrip#tripConsumption                      | Number:Volume        | Last trip fuel consumption                         |                                                |
+| lasttrip#tripDistance                         | Number:Length        | Last trip distance                                 |                                                |
+| lasttrip#tripStartTime                        | DateTime             | Last trip start time                               |                                                |
+| lasttrip#tripEndTime                          | DateTime             | Last trip end time                                 |                                                |
+| lasttrip#tripDuration                         | Number:Time          | Last trip duration                                 |                                                |
+| lasttrip#tripStartOdometer                    | Number:Length        | Last trip start odometer                           |                                                |
+| lasttrip#tripStopOdometer                     | Number:Length        | Last trip stop odometer                            |                                                |
+| lasttrip#startPosition                        | Location             | Last trip start location                           |                                                |
+| lasttrip#endPosition                          | Location             | Last trip end location                             |                                                |
 
 ## Events