2024-11-27 18:57:16 +01:00

2.4 KiB

title, description, ha_category, ha_release, ha_iot_class, ha_domain, ha_platforms, ha_integration_type, related, ha_quality_scale
title description ha_category ha_release ha_iot_class ha_domain ha_platforms ha_integration_type related ha_quality_scale
CityBikes Instructions on how to integrate data from the CityBikes API into Home Assistant.
Transport
0.49 Cloud Polling citybikes
sensor
integration
docs title
/docs/configuration/ Configuration file
legacy

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 {% term "configuration.yaml" %} file. {% include integrations/restart_ha_after_config_inclusion.md %}

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

{% 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. Either radius or stations are required. 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. Either radius or stations are required. 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