jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Doc standart fixes (#6632)

Browse Source
This commit is contained in:
Dav0815 2018-10-10 03:21:50 +10:00 committed by Fabian Affolter
parent edb7873627
commit 3f0b17be51
1 changed files with 29 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
source/_components/sensor.citybikes.markdown
View File

@ -23,17 +23,38 @@ To enable it, add the following lines to your `configuration.yaml`:
# Example configuration.yaml entry (using radius)
sensor:
- platform: citybikes
radius: 500
```
Configuration options:
{% configuration %}
name:
description: The base name of this group of monitored stations. The entity ID of every monitored station in this group will be prefixed with this base name, in addition to the network ID.
required: false
type: string
network:
description: The name of the bike sharing system to poll.
required: false
default: Defaults to the system that operates in the monitored location.
type: string
latitude:
description: Latitude of the location, around which bike stations are monitored.
required: false
default: Defaults to the latitude in your `configuration.yaml` file.
type: string
longitude:
description: Longitude of the location, around which bike stations are monitored.
required: false
default: Defaults to the longitude in your `configuration.yaml` file.
type: string
radius:
description: The radius (in meters or feet, depending on the Home Assistant configuration) around the monitored location. Only stations closer than this distance will be monitored.
required: false
type: integer
stations:
description: A list of specific stations to monitor. The list should contain station `ID`s or `UID`s, which can be obtained from the CityBikes API.
required: false
type: list
{% endconfiguration %}
- **name** (*Optional*): The base name of this group of monitored stations. The entity ID of every monitored station in this group will be prefixed with this base name, in addition to the network ID.
- **network** (*Optional*): The name of the bike sharing system to poll. Defaults to the system that operates in the monitored location.
- **latitude** (*Optional*): Latitude of the location, around which bike stations are monitored. Defaults to the latitude in your `configuration.yaml` file.
- **longitude** (*Optional*): Longitude of the location, around which bike stations are monitored. Defaults to the longitude in your `configuration.yaml` file.
- **radius** (*Optional*): The radius (in meters or feet, depending on the Home Assistant configuration) around the monitored location. Only stations closer than this distance will be monitored.
- **stations** array (*Optional*): A list of specific stations to monitor. The list should contain station `ID`s or `UID`s, which can be obtained from the CityBikes API.
## {% linkable_title Example %}