From c51bbe923a9ebc21a58b94b740f99b24c6a4caa9 Mon Sep 17 00:00:00 2001 From: Ian Date: Tue, 7 May 2019 18:19:41 -0700 Subject: [PATCH] Add nextbus (#8661) * Add initial NextBus documentation * Update nextbus docs to meet standards * Update ha_releaes Setting it to the next relese * Update nextbus docs to describe how to get config values * Add sensor to ha_category Co-Authored-By: ViViDboarder * :pencil2: Tweak After this we will merge it * :pencil2: Change file name --- source/_components/nextbus.markdown | 58 +++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 source/_components/nextbus.markdown diff --git a/source/_components/nextbus.markdown b/source/_components/nextbus.markdown new file mode 100644 index 00000000000..f6324681eca --- /dev/null +++ b/source/_components/nextbus.markdown @@ -0,0 +1,58 @@ +--- +layout: page +title: "Public Transit (Nextbus)" +description: "Instructions on how to use public transit data from Nextbus in Home Assistant." +date: 2019-02-20 00:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: train.png +ha_category: + - Transport + - Sensor +ha_iot_class: Local Polling +ha_release: 0.93 +--- + +The `nextbus` sensor will give you the next departure time and associated data from your public transit station/stop. The data comes from [NextBus](https://www.nextbus.com), which provides real time transit data for a number of transit authorities. + +It is possible to get the tag information from the NextBus website. + + 1. Visit https://www.nextbus.com/ + 2. Use the drop downs to select the transit system, route, direction, and stop + 3. Extract the tags from the URL. It is constructed with the following pattern: + + https://www.nextbus.com/#!//// + +If tags are incorrect, valid ones will be displayed in the logs as a +convenience. + +```yaml +# Example configuration.yaml entry +sensor: + - platform: nextbus + agency: AGENCY_TAG + route: ROUTE_TAG + stop: STOP_TAG +``` + +{% configuration %} +agency: + description: The agency tag from NextBus. + required: true + type: string +route: + description: The route tag from NextBus. + required: true + type: string +stop: + description: The stop tag from NextBus. + required: true + type: integer +name: + description: Name to use in the frontend. + required: false + default: - + type: string +{% endconfiguration %}