]> git.basschouten.com Git - openhab-addons.git/commitdiff
[groupepsa] Fix syntax of documentation and minor spelling improvements (#12912)
authorChristoph Weitkamp <github@christophweitkamp.de>
Fri, 10 Jun 2022 05:27:57 +0000 (07:27 +0200)
committerGitHub <noreply@github.com>
Fri, 10 Jun 2022 05:27:57 +0000 (07:27 +0200)
* [groupepsa] Fix syntax of documentation and minor spelling improvements

- Fix syntax of documentation and minor spelling improvements

Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
Co-authored-by: Jacob Laursen <jacob-github@vindvejr.dk>
bundles/org.openhab.binding.groupepsa/README.md

index 590164803ab8b85d9be4e733fa0406486b1e88c7..58a82564111f3edf28196dc96f3d2fb86c31eab8 100644 (file)
@@ -4,42 +4,46 @@ Binding to retrieve information via the Groupe PSA Web API for cars from Opel, P
 
 ## Supported Things
 
-bridge - Groupe PSA Web Api Bridge: The Thing to auto discover your cars
+´bridge´ - Groupe PSA Web Api Bridge: The Thing to auto discover your cars.
 
-vehicle - Groupe PSA Car: The actual car thing.
+´vehicle´ - Groupe PSA Car: The actual car Thing.
 
 ## Discovery
 
-Use the "Groupe PSA Web Api bridge" to auto discover your cars. You need to select the brand for the bridge binding and only cars for the brand will be auto discovered. If you need to add for multiple brands or multiple different users, add multiple bridges.
+Use the "Groupe PSA Web Api bridge" to auto discover your cars.
+You need to select the brand for the bridge binding and only cars for the brand will be auto discovered.
+If you need to add for multiple brands or multiple different users, add multiple bridges.
 
 ## Bridge Configuration
 
-You need to select a brand and enter the User Name and Password.
-The Polling interval (in minutes) determines how often the API will polled for new cars.
-The Client ID and Client Secret should not need to be updated. (However you can register your own app via https://developer.groupe-psa.com/inc/ and use this client information if you wish.)
+You need to select a brand and enter the user name and password.
+The Polling Interval (in minutes) determines how often the API will be polled for new cars.
+The Client ID and Client Secret should not need to be updated.
+(However you can register your own app via https://developer.groupe-psa.com/inc/ and use this client information if you wish.)
 
 ### parameters
 
 | Property        | Default | Required | Description                                                                                                                                             |
 | --------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| vendor          | None    | Yes      | The brand of the car (PEUGEOT, CITROEN, DS, OPEL or VAUXHALL)                                                                                           |
-| userName        | None    | Yes      | The user name for the mypeugot/mycitroen/myds/myopel/myvauxhall website or app                                                                          |
-| password        | None    | Yes      | The password for the given user                                                                                                                         |
-| pollingInterval | 60      | No       | The Polling interval (in minutes) determines how often the available vehicles are queried                                                               |
-| clientId        |         | Yes      | The client ID for API access: can normally left at the default value. (see: https://developer.groupe-psa.io/webapi/b2c/quickstart/connect/#article)     |
-| clientSecret    |         | Yes      | The client secret for API access: can normally left at the default value. (see: https://developer.groupe-psa.io/webapi/b2c/quickstart/connect/#article) |
+| vendor          | None    | Yes      | The brand of the car (PEUGEOT, CITROEN, DS, OPEL or VAUXHALL).                                                                                          |
+| userName        | None    | Yes      | The user name for the mypeugot/mycitroen/myds/myopel/myvauxhall website or app.                                                                         |
+| password        | None    | Yes      | The password for the given user.                                                                                                                        |
+| pollingInterval | 60      | No       | The Polling Interval (in minutes) determines how often the available vehicles are queried.                                                              |
+| clientId        |         | Yes      | The Client ID for API access: can normally left at the default value. (see: https://developer.groupe-psa.io/webapi/b2c/quickstart/connect/#article)     |
+| clientSecret    |         | Yes      | The Client Secret for API access: can normally left at the default value. (see: https://developer.groupe-psa.io/webapi/b2c/quickstart/connect/#article) |
 
 ## Vehicle Configuration
 
-Normally the vehicles will be autodiscovered. The Polling Interval and Online Timeout can be adjusted.
+Normally the vehicles will be autodiscovered.
+The Polling Interval and Online Timeout can be adjusted.
 
 ### parameters
 
-| Property        | Default | Required | Description                                                                                      |
-| --------------- | ------- | -------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
-| id              | None    | Yes      | Vehicle API ID                                                                                   | The ID is the vehicle API ID (not equal to the VIN), which is autodiscoverd by the bridge. |
-| pollingInterval | 5       | No       | The Polling interval (in minutes) determines how often the car is polled for updated information |
-| onlineInterval  | 15      | No       | The Online Timeout (in minutes) determines when the car is deemed to be offline.                 |
+| Property        | Default | Required | Description                                                                                       |                                                                                            |
+|-----------------|---------|----------|---------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|
+| id              | None    | Yes      | Vehicle API ID.                                                                                   | The ID is the vehicle API ID (not equal to the VIN), which is autodiscoverd by the bridge. |
+| pollingInterval | 5       | No       | The Polling Interval (in minutes) determines how often the car is polled for updated information. |                                                                                            |
+| onlineInterval  | 15      | No       | The Online Timeout (in minutes) determines when the car is deemed to be offline.                  |                                                                                            |
 
 ## Channels