https://github.com/amaximus/bkk_stop
HomeAssistant custom component for Budapest public transportation
https://github.com/amaximus/bkk_stop
bkk budapest homeassistant homeassistant-components hungary transportation
Last synced: 7 months ago
JSON representation
HomeAssistant custom component for Budapest public transportation
- Host: GitHub
- URL: https://github.com/amaximus/bkk_stop
- Owner: amaximus
- Created: 2018-03-18T18:41:44.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-11-20T17:30:52.000Z (7 months ago)
- Last Synced: 2024-11-20T18:31:13.637Z (7 months ago)
- Topics: bkk, budapest, homeassistant, homeassistant-components, hungary, transportation
- Language: Python
- Homepage:
- Size: 110 KB
- Stars: 28
- Watchers: 3
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/hacs/integration)
# BKK Stop Information custom component for Home Assistant
## Providing also a custom state card for legacyUI.
This custom component and custom card shows Budapest Public Transportation (BKK)
line information departing in the near future from a configurable stop.
#### Installation
The easiest way to install it is through [HACS (Home Assistant Community Store)](https://github.com/hacs/integration),
search for BKK Stop Information in the Integrations.
If you are not using HACS, download the files from custom_components/bkk_stop into your
$homeassistant_config_dir/custom_components/bkk_stop.
Once downloaded and configured as per below information you'll need to restart HomeAssistant to have the custom component
and the sensors of bkk_stop platform taken into consideration.
#### Configuration:
Define sensors with the following configuration parameters:
---
| Name | Optional | `Default` | Description |
| :---- | :---- | :------- | :----------- |
| name | **N** | - | sensor of bkk_stop type to display |
| stopId | **N** | - | StopId as per [go.bkk.hu](https://go.bkk.hu/) |
| apiKey | **N** | - | API Key to BKK data as per [opendata.bkk.hu](https://opendata.bkk.hu/) |
| maxItems | **Y** | `0` | Number of items to consider. 0 disables this feature |
| minsAfter | **Y** | `20` | Number of minutes ahead to show vehicles departing from station |
| wheelchair | **Y** | `false` | Display vehicle's wheelchair accessibility |
| bikes | **Y** | `false` | Display whether bikes are allowed on vehicle |
| colors | **Y** | `false` | Display BKK's default color for the line and the text |
| ignoreNow | **Y** | `true` | Ignore vehicles already in the station |
| entity_id | **Y** | `` | Used instead of name for automatic generation of entity_id |
| inPredicted | **Y** | `false` | Calculate time in as per estimated arrival time, when available |
| routes | **Y** | `` | List of routes to consider. Those not listed will be discarded |
| headsigns | **Y** | `` | List of headsigns to consider. Those not listed will be discarded. Useful for trans stations |
| minsBefore | **Y** | `0` | Skip vehicles departing from station in `minsBefore` minutes, e.g. while walking to the station. Use non-positive value! |
---
The integration provides an action ```bkk_stop:refresh``` for instant refresh requiring an entity_id.
On begining of June the test API key has been revoked, therefore to use this integration you'll have to create an account
at [opendata.bkk.hu](https://opendata.bkk.hu/), generate an API key for yourself and set that in the integration configuration.
#### Example
```
platform: bkk_stop
name: 'bkk7u'
stopId: 'BKK_F00940'
minsAfter: 25
wheelchair: true
apiKey: !secret bkk_apikey
routes:
- 287
- 114
- 213
```
#### Lovelace UI
There is a Lovelace custom card related to this component at [https://github.com/amaximus/bkk-stop-card](https://github.com/amaximus/bkk-stop-card).
#### Legacy UI
Custom state card is provided for presenting data on legacy UI. Pls see the legacyUI directory structure for example.
Lovelace UI:
