home-assistant.io/source/_components/citybikes.markdown
Franck Nijhof 1833c32a2c Cleans up front matter (#9835)
* Sets front matter defaults

* Removes default front matter from section templates/pages

* Removes default front matter from addon pages

* Removes default front matter from integration pages

* Removes default front matter from posts

* Removes default front matter from docs pages

* Removes default front matter from other pages

* Fixes blog category pages
2019-07-11 14:35:08 -07:00

2.1 KiB

title, description, logo, ha_category, ha_release, redirect_from
title description logo ha_category ha_release redirect_from
CityBikes Sensor Instructions on how to integrate data from the CityBikes API into Home Assistant. citybikes.png
Transport
0.49
/components/sensor.citybikes/

The citybikes sensor platform monitors bike availability at bike sharing stations in a chosen area. The data is provided by CityBikes, which supports bike sharing systems all around the world.

Configuration

To enable it, add the following lines to your configuration.yaml:

# Example configuration.yaml entry (using radius)
sensor:
  - platform: citybikes

{% 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 IDs or UIDs, which can be obtained from the CityBikes API. required: false type: list {% endconfiguration %}

Example

Additional configuration samples:

# Example configuration.yaml entry (using a list of stations)
sensor:
  - platform: citybikes
    name: Work Stations
    stations:
      - 123
      - 145
      - 436