This is a module for the MagicMirror² to display the number of available bikes on the selected stations of the Budapest public bike system (aka MOL Bubi).
By default this module displays the number of available bikes and the official names of the specified stations:
You can configure the module to display a custom (typically shorter) names for the stations:
If you wish, you can completely remove the station names:
For updates, please check the CHANGELOG.
To use this module follow these steps:
- Clone this repository to the
modulesfolder of your MagicMirror:
git clone https://github.com/balassy/MMM-Bubi.git- Add the following configuration block to the modules array in the
config/config.jsfile:
var config = {
modules: [
{
module: 'MMM-Bubi',
position: 'top_right',
config: {
updateInterval: 600000, // 10 minutes in milliseconds
showPlaceName: true,
align: 'left',
places: [
{ id: 42990755, name: 'MOMKult' },
{ id: 42990754, name: 'MOM Park' },
{ id: 42990729, name: 'BAH csomópont' }
]
}
}
]
}| Option | Description |
|---|---|
places |
REQUIRED The list of Bubi stations to display. The unique id of the station is used to lookup the data from the webservice. The name is optional, and can be used to display a custom name for the station instead of the official name if the showPlaceName option is set to true. Type: Array<{ id: number, name: string }> Default value: 3 preconfigured stations |
showPlaceName |
Optional Specifies whether the module should display not only the number of available bikes for each station, but also the names of the stations. If the name property is set in the places array, then it will be displayed, otherwise the official names of the stations will be rendered onto the Mirror.Type: boolean Default value: true |
align |
Optional Determines how the text is aligned within the module. Set this to left if the module is displayed on left side of the mirror, or to right if you positioned this module to the right column of the mirror.Type: stringPossible values: 'left' or 'right'Default value: 'left' |
updateInterval |
Optional The frequency of how often the module should query the number of available bikes from the webservice. Type: int (milliseconds) Default value: 600000 milliseconds (10 minutes) |
In the id property of the objects in the places array of the configuration settings you have to specify the unique identifier of the station for which the module should display the bike availability.
To obtain the unique identifier of the station, follow these steps:
-
Navigate to the MOL Bubi homepage with your favorite webbrowser.
-
Use the map on the page to find your favorite MOL Bubi station and click its icon.
-
Note the official name of the station, e.g.
1201-BAH csomópont. -
Navigate to the https://maps.nextbike.net/maps/nextbike-live.json?domains=bh URL and use the browser's find function (CTRL+F) to locate the place by its name.
- Find the
uidattribute in the same row, it is the unique identifier of the station.
This module periodically sends requests from the browser window of the MagicMirror Electron application to the public NextBike API. The NextBike API is free, and it does NOT require any login or API key.
You can see an XML example by visiting this URL: https://maps.nextbike.net/maps/nextbike-live.xml?domains=bh
Although for operation this module does not depend on any other module, if you would like to contribute to the codebase, please use the preconfigured linters to analyze the source code before sending a pull request. To run the linters follow these steps:
- Install developer dependencies:
npm install- Install Grunt:
npm install -g grunt- Use Grunt to run all linters:
gruntYour feedback is more than welcome, please send your suggestions, feature requests or bug reports as Github issues.
Many thanks to Michael Teeuw for creating and maintaining the MagicMirror² project fully open source.
This project is created and maintaned by György Balássy.