NOTE: I deprecated this module. Please feel free to take a look at MMM-HK-Transport-ETA.
Station monitor for the Hong Kong Transport.
This module is an extension of the amazing MagicMirror2 project by MichMich which has inspired me to share my coding skills with others as well. Check it out, you know you want to :).
It's always nice to see mirrors using my work, so feel free to send me some screenshots of your implementations.
Lastly, why not join in on our discussions at the official MagicMirror2 Forum?
en |
zh-tw or zh-hk |
---|---|
v1.3.0
As of version 1.3.0, MMM-HK-Transport features language support for Chinese (zh-hk and zh-tw)
and English (en)
mirrors.
A working installation of MagicMirror2
- npm
- got
Go to MagicMirror folder and execute the following command:
cd modules
git clone https://github.com/winstonma/MMM-HK-Transport.git
cd MMM-HK-Transport
npm install
Please note that this module auto-creates a module header which displays the name of the chosen Hong Kong local transport stop. It is therefore recommended not to add a 'header' entry to your config.js for this module.
This module automatically disappears from your mirror as soon as a station has stopped offering connections at night. It reappears as soon as your chosen station is scheduled to be served again.
This module has been programmed to allow for multiple instances. Simply add more MMM-HK-Transport config entries to your config.js file to display multiple stations and configure them according to your needs.
Sample minimum configuration entry for your ~/MagicMirror/config/config.js
:
...
{
module: 'MMM-HK-Transport',
position: 'top_left',
config: {
stops: [
{
stopID: 'HKStop_KowloonCentralPostOffice_N_1_2'
}
]
}
} // If this isn't your last module, add a comma after the bracket
...
Sample configuration entry for your ~/MagicMirror/config/config.js
with optional parameters:
...
{
module: 'MMM-HK-Transport',
position: 'top_left',
config: {
stopID: 'HKStop_KowloonCentralPostOffice_N_1_2',
showLabelRow: true, // Show or hide column headers
reloadInterval: 60000 // How often should the information be updated? (In milliseconds)
}
} // If this isn't your last module, add a comma after the bracket
...
- Open your web browser and navigate to the CityMapper Hong Kong Web Page.
- In the search box, enter the bus line number.
- Once you can see the stop in your browser, click the stop.
- When a new page is being displayed, check the link (e.g. https://citymapper.com/hong-kong/bus/stops/HKStop_KowloonCentralPostOffice_N_1_2). Note the last portion of the link (e.g.
HKStop_KowloonCentralPostOffice_N_1_2
)is theStopID
you are looking for.
Option | Default | Description |
---|---|---|
stopID | HKStop_KowloonCentralPostOffice_N_1_2 | Which stop would you like to have displayed? Default: HKStop_KowloonCentralPostOffice_N_1_2 |
showLabelRowoptional |
true | Show or hide column headers Possible values: true, false |
reloadIntervaloptional |
60000 | How often should the information be updated? (In milliseconds) Default: Every minute |