{"id":16322031,"url":"https://github.com/balassy/mmm-bubi","last_synced_at":"2026-02-09T15:33:51.084Z","repository":{"id":39786388,"uuid":"143957293","full_name":"balassy/MMM-Bubi","owner":"balassy","description":"MagicMirror module that displays bike availability in the Budapest public bike system (aka MOL Bubi).","archived":false,"fork":false,"pushed_at":"2023-01-04T05:51:26.000Z","size":716,"stargazers_count":0,"open_issues_count":10,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-05T15:48:37.402Z","etag":null,"topics":["bike","bike-share-station","bike-sharing","bubi","javascript","magicmirror","magicmirror2","public-transport","raspberry","raspberry-pi"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/balassy.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-08T03:40:08.000Z","updated_at":"2021-06-06T05:12:21.000Z","dependencies_parsed_at":"2023-02-01T23:46:24.722Z","dependency_job_id":null,"html_url":"https://github.com/balassy/MMM-Bubi","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/balassy%2FMMM-Bubi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/balassy%2FMMM-Bubi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/balassy%2FMMM-Bubi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/balassy%2FMMM-Bubi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/balassy","download_url":"https://codeload.github.com/balassy/MMM-Bubi/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246931750,"owners_count":20856863,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bike","bike-share-station","bike-sharing","bubi","javascript","magicmirror","magicmirror2","public-transport","raspberry","raspberry-pi"],"created_at":"2024-10-10T22:49:48.511Z","updated_at":"2026-02-09T15:33:51.004Z","avatar_url":"https://github.com/balassy.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MMM-Bubi\n\nThis is a module for the [MagicMirror²](https://github.com/MichMich/MagicMirror/) to display the number of available bikes on the selected stations of the Budapest public bike system (aka MOL Bubi).\n\n## Features\n\nBy default this module displays the number of available bikes and the official names of the specified stations:\n\n![Default](https://raw.githubusercontent.com/balassy/MMM-Bubi/master/doc/screenshot-default.png)\n\nYou can configure the module to display a custom (typically shorter) names for the stations:\n\n![With custom station names](https://raw.githubusercontent.com/balassy/MMM-Bubi/master/doc/screenshot-custom-place-name.png)\n\nIf you wish, you can completely remove the station names:\n\n![With hidden station names](https://raw.githubusercontent.com/balassy/MMM-Bubi/master/doc/screenshot-no-place-name.png)\n\nFor updates, please check the [CHANGELOG](https://github.com/balassy/MMM-Bubi/blob/master/CHANGELOG.md).\n\n## Using the module\n\nTo use this module follow these steps:\n\n1. Clone this repository to the `modules` folder of your MagicMirror:\n\n```bash\ngit clone https://github.com/balassy/MMM-Bubi.git\n```\n\n2. Add the following configuration block to the modules array in the `config/config.js` file:\n\n```js\nvar config = {\n  modules: [\n    {\n      module: 'MMM-Bubi',\n      position: 'top_right',\n      config: {\n        updateInterval: 600000, // 10 minutes in milliseconds\n        showPlaceName: true,\n        align: 'left',\n        places: [\n          { id: 42990755, name: 'MOMKult' },\n          { id: 42990754, name: 'MOM Park' },\n          { id: 42990729,  name: 'BAH csomópont' }     \n        ]\n      }\n    }\n  ]\n}\n```\n\n## Configuration options\n\n| Option                 | Description\n|------------------------|-----------\n| `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`. \u003cbr\u003e\u003cbr\u003e **Type:** `Array\u003c{ id: number, name: string }\u003e` \u003cbr\u003e**Default value:** 3 preconfigured stations\n| `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.\u003cbr\u003e\u003cbr\u003e **Type:** `boolean` \u003cbr\u003e**Default value:** `true`\n| `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.\u003cbr\u003e\u003cbr\u003e**Type:** `string`\u003cbr\u003e**Possible values**: `'left'` or `'right'`\u003cbr\u003e**Default value:** `'left'`\n| `updateInterval`       | *Optional* The frequency of how often the module should query the number of available bikes from the webservice. \u003cbr\u003e\u003cbr\u003e**Type:** `int` (milliseconds) \u003cbr\u003e**Default value:** `600000` milliseconds (10 minutes)\n\n## How to get the place ID\n\nIn 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.\n\nTo obtain the unique identifier of the station, follow these steps:\n\n1. Navigate to the [MOL Bubi homepage](https://molbubi.hu/hu/terkep/) with your favorite webbrowser.\n\n2. Use the map on the page to find your favorite MOL Bubi station and click its icon.\n\n3. Note the official name of the station, e.g. `1201-BAH csomópont`.\n\n4. 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.\n\n![Locate the station by its name](https://raw.githubusercontent.com/balassy/MMM-Bubi/master/doc/find-place-id.png)\n\n5. Find the `uid` attribute in the same row, it is the unique identifier of the station.\n\n## How it works\n\nThis module periodically sends requests from the browser window of the MagicMirror Electron application to the public [NextBike API](https://maps.nextbike.net/maps/nextbike-live.json?domains=bh). The NextBike API is free, and it does NOT require any login or API key.\n\nYou can see an XML example by visiting this URL: https://maps.nextbike.net/maps/nextbike-live.xml?domains=bh\n\n## Contribution\n\nAlthough 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:\n\n1. Install developer dependencies:\n\n```bash\nnpm install\n```\n\n2. Install Grunt:\n\n```bash\nnpm install -g grunt\n```\n\n3. Use Grunt to run all linters:\n\n```bash\ngrunt\n```\n\n## Got feedback?\n\nYour feedback is more than welcome, please send your suggestions, feature requests or bug reports as [Github issues](https://github.com/balassy/MMM-Bubi/issues).\n\n## Acknowledments\n\nMany thanks to [Michael Teeuw](https://github.com/MichMich) for creating and maintaining the [MagicMirror²](https://github.com/MichMich/MagicMirror/) project fully open source.\n\n## About the author\n\nThis project is created and maintaned by [György Balássy](https://www.linkedin.com/in/balassy).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbalassy%2Fmmm-bubi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbalassy%2Fmmm-bubi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbalassy%2Fmmm-bubi/lists"}