2024.12.5
Home ▸ Integrations ▸

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.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file. After changing the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes. The integration is now shown on the integrations page under Settings > Devices & services. Its entities are listed on the integration card itself and on the Entities tab.

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

Configuration Variables

Looking for your configuration file?
name string (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 string (Optional)

The name of the bike sharing system to poll.

Default:

Defaults to the system that operates in the monitored location.

latitude string (Optional)

Latitude of the location, around which bike stations are monitored.

Default:

Defaults to the latitude in your configuration.yaml file.

longitude string (Optional)

Longitude of the location, around which bike stations are monitored.

Default:

Defaults to the longitude in your configuration.yaml file.

radius integer (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. Either radius or stations are required.

stations list (Optional)

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.

Example

Additional configuration samples:

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

Related topics