Classes
class	CityBikesNetwork

class	CityBikesNetworks

class	CityBikesRequestError

class	CityBikesStation

Functions
def	async_citybikes_request (hass, uri, schema)

None	async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType\|None discovery_info=None)

Variables
	_LOGGER = logging.getLogger(__name__)

string	ATTR_EMPTY_SLOTS = "empty_slots"

string	ATTR_EXTRA = "extra"

string	ATTR_FREE_BIKES = "free_bikes"

string	ATTR_NETWORK = "network"

string	ATTR_NETWORKS_LIST = "networks"

string	ATTR_STATIONS_LIST = "stations"

string	ATTR_TIMESTAMP = "timestamp"

string	ATTR_UID = "uid"

tuple	CITYBIKES_ATTRIBUTION

string	CITYBIKES_NETWORKS = "citybikes_networks"

string	CONF_NETWORK = "network"

string	CONF_STATIONS_LIST = "stations"

string	DEFAULT_ENDPOINT = "https://api.citybik.es/{uri}"

string	MONITORED_NETWORKS = "monitored-networks"

	NETWORK_SCHEMA

	NETWORKS_RESPONSE_SCHEMA

string	NETWORKS_URI = "v2/networks"

string	PLATFORM = "citybikes"

	PLATFORM_SCHEMA

int	REQUEST_TIMEOUT = 5

	SCAN_INTERVAL = timedelta(minutes=5)

	STATION_SCHEMA

	STATIONS_RESPONSE_SCHEMA

string	STATIONS_URI = "v2/networks/{uid}?fields=network.stations"

Detailed Description

Sensor for the CityBikes data.

Function Documentation

◆ async_citybikes_request()

def homeassistant.components.citybikes.sensor.async_citybikes_request	(	hass,
		uri,
		schema
	)

Perform a request to CityBikes API endpoint, and parse the response.

Definition at line 138 of file sensor.py.

◆ async_setup_platform()

None homeassistant.components.citybikes.sensor.async_setup_platform	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	async_add_entities,
		DiscoveryInfoType \| None	discovery_info = `None`
	)

Set up the CityBikes platform.

Definition at line 157 of file sensor.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.citybikes.sensor._LOGGER = logging.getLogger(__name__)

private

Definition at line 41 of file sensor.py.

◆ ATTR_EMPTY_SLOTS

string homeassistant.components.citybikes.sensor.ATTR_EMPTY_SLOTS = "empty_slots"

Definition at line 43 of file sensor.py.

◆ ATTR_EXTRA

string homeassistant.components.citybikes.sensor.ATTR_EXTRA = "extra"

Definition at line 44 of file sensor.py.

◆ ATTR_FREE_BIKES

string homeassistant.components.citybikes.sensor.ATTR_FREE_BIKES = "free_bikes"

Definition at line 45 of file sensor.py.

◆ ATTR_NETWORK

string homeassistant.components.citybikes.sensor.ATTR_NETWORK = "network"

Definition at line 46 of file sensor.py.

◆ ATTR_NETWORKS_LIST

string homeassistant.components.citybikes.sensor.ATTR_NETWORKS_LIST = "networks"

Definition at line 47 of file sensor.py.

◆ ATTR_STATIONS_LIST

string homeassistant.components.citybikes.sensor.ATTR_STATIONS_LIST = "stations"

Definition at line 48 of file sensor.py.

◆ ATTR_TIMESTAMP

string homeassistant.components.citybikes.sensor.ATTR_TIMESTAMP = "timestamp"

Definition at line 49 of file sensor.py.

◆ ATTR_UID

string homeassistant.components.citybikes.sensor.ATTR_UID = "uid"

Definition at line 50 of file sensor.py.

◆ CITYBIKES_ATTRIBUTION

tuple homeassistant.components.citybikes.sensor.CITYBIKES_ATTRIBUTION

Initial value:

 =  (
     "Information provided by the CityBikes Project (https://citybik.es/#about)"
 )

Definition at line 68 of file sensor.py.

◆ CITYBIKES_NETWORKS

string homeassistant.components.citybikes.sensor.CITYBIKES_NETWORKS = "citybikes_networks"

Definition at line 72 of file sensor.py.

◆ CONF_NETWORK

string homeassistant.components.citybikes.sensor.CONF_NETWORK = "network"

Definition at line 52 of file sensor.py.

◆ CONF_STATIONS_LIST

string homeassistant.components.citybikes.sensor.CONF_STATIONS_LIST = "stations"

Definition at line 53 of file sensor.py.

◆ DEFAULT_ENDPOINT

string homeassistant.components.citybikes.sensor.DEFAULT_ENDPOINT = "https://api.citybik.es/{uri}"

Definition at line 55 of file sensor.py.

◆ MONITORED_NETWORKS

string homeassistant.components.citybikes.sensor.MONITORED_NETWORKS = "monitored-networks"

Definition at line 58 of file sensor.py.

◆ NETWORK_SCHEMA

homeassistant.components.citybikes.sensor.NETWORK_SCHEMA

Initial value:

 =  vol.Schema(
     {
         vol.Required(ATTR_ID): cv.string,
         vol.Required(ATTR_NAME): cv.string,
         vol.Required(ATTR_LOCATION): vol.Schema(
             {
                 vol.Required(ATTR_LATITUDE): cv.latitude,
                 vol.Required(ATTR_LONGITUDE): cv.longitude,
             },
             extra=vol.REMOVE_EXTRA,
         ),
     },
     extra=vol.REMOVE_EXTRA,
 )

Definition at line 90 of file sensor.py.

◆ NETWORKS_RESPONSE_SCHEMA

homeassistant.components.citybikes.sensor.NETWORKS_RESPONSE_SCHEMA

Initial value:

 =  vol.Schema(
     {vol.Required(ATTR_NETWORKS_LIST): [NETWORK_SCHEMA]}
 )

Definition at line 105 of file sensor.py.

◆ NETWORKS_URI

string homeassistant.components.citybikes.sensor.NETWORKS_URI = "v2/networks"

Definition at line 60 of file sensor.py.

◆ PLATFORM

string homeassistant.components.citybikes.sensor.PLATFORM = "citybikes"

Definition at line 56 of file sensor.py.

◆ PLATFORM_SCHEMA

homeassistant.components.citybikes.sensor.PLATFORM_SCHEMA

Initial value:

 =  vol.All(
     cv.has_at_least_one_key(CONF_RADIUS, CONF_STATIONS_LIST),
     SENSOR_PLATFORM_SCHEMA.extend(
         {
             vol.Optional(CONF_NAME, default=""): cv.string,
             vol.Optional(CONF_NETWORK): cv.string,
             vol.Inclusive(CONF_LATITUDE, "coordinates"): cv.latitude,
             vol.Inclusive(CONF_LONGITUDE, "coordinates"): cv.longitude,
             vol.Optional(CONF_RADIUS, "station_filter"): cv.positive_int,
             vol.Optional(CONF_STATIONS_LIST, "station_filter"): vol.All(
                 cv.ensure_list, vol.Length(min=1), [cv.string]
             ),
         }
     ),
 )

Definition at line 74 of file sensor.py.

◆ REQUEST_TIMEOUT

int homeassistant.components.citybikes.sensor.REQUEST_TIMEOUT = 5

Definition at line 62 of file sensor.py.

◆ SCAN_INTERVAL

homeassistant.components.citybikes.sensor.SCAN_INTERVAL = timedelta(minutes=5)

Definition at line 64 of file sensor.py.

◆ STATION_SCHEMA

homeassistant.components.citybikes.sensor.STATION_SCHEMA

Initial value:

 =  vol.Schema(
     {
         vol.Required(ATTR_FREE_BIKES): cv.positive_int,
         vol.Required(ATTR_EMPTY_SLOTS): vol.Any(cv.positive_int, None),
         vol.Required(ATTR_LATITUDE): cv.latitude,
         vol.Required(ATTR_LONGITUDE): cv.longitude,
         vol.Required(ATTR_ID): cv.string,
         vol.Required(ATTR_NAME): cv.string,
         vol.Required(ATTR_TIMESTAMP): cv.string,
         vol.Optional(ATTR_EXTRA): vol.Schema(
             {vol.Optional(ATTR_UID): cv.string}, extra=vol.REMOVE_EXTRA
         ),
     },
     extra=vol.REMOVE_EXTRA,
 )

Definition at line 109 of file sensor.py.

◆ STATIONS_RESPONSE_SCHEMA

homeassistant.components.citybikes.sensor.STATIONS_RESPONSE_SCHEMA

Initial value:

 =  vol.Schema(
     {
         vol.Required(ATTR_NETWORK): vol.Schema(
             {vol.Required(ATTR_STATIONS_LIST): [STATION_SCHEMA]}, extra=vol.REMOVE_EXTRA
         )
     }
 )

Definition at line 125 of file sensor.py.

◆ STATIONS_URI

string homeassistant.components.citybikes.sensor.STATIONS_URI = "v2/networks/{uid}?fields=network.stations"

Definition at line 66 of file sensor.py.

Home Assistant Unofficial Reference 2024.12.1

Classes

Functions

Variables

Detailed Description

Function Documentation

◆ async_citybikes_request()

◆ async_setup_platform()

Variable Documentation

◆ _LOGGER

◆ ATTR_EMPTY_SLOTS

◆ ATTR_EXTRA

◆ ATTR_FREE_BIKES

◆ ATTR_NETWORK

◆ ATTR_NETWORKS_LIST

◆ ATTR_STATIONS_LIST

◆ ATTR_TIMESTAMP

◆ ATTR_UID

◆ CITYBIKES_ATTRIBUTION

◆ CITYBIKES_NETWORKS

◆ CONF_NETWORK

◆ CONF_STATIONS_LIST

◆ DEFAULT_ENDPOINT

◆ MONITORED_NETWORKS

◆ NETWORK_SCHEMA

◆ NETWORKS_RESPONSE_SCHEMA

◆ NETWORKS_URI

◆ PLATFORM

◆ PLATFORM_SCHEMA

◆ REQUEST_TIMEOUT

◆ SCAN_INTERVAL

◆ STATION_SCHEMA

◆ STATIONS_RESPONSE_SCHEMA

◆ STATIONS_URI