Skip to content

Latest commit

 

History

History
60 lines (50 loc) · 2.25 KB

README.md

File metadata and controls

60 lines (50 loc) · 2.25 KB

MMM-Bluelinky

Show Hyundai EV car data on your Magic Mirror using BlueLinky npm package. The MMM-Bluelinky module is based on the MMM-Tesla2 module.

Installation

cd ~/MagicMirror/modules
git clone https://github.com/Cyw00d/MMM-Bluelinky.git
cd MMM-Bluelinky && npm install

Configuration

Copy the example config to your MagicMirror config file:

{
  module: 'MMM-Bluelinky',
  position: 'bottom_left',	// This can be any of the regions.
  config: {
    name: 'Optional Car Name',
    username: 'your-bluelink-email',
    password: "your-bluelink-password",
    region: 'EU',
    pin: '0123',
    refreshInterval:  1000 * 60 * 60, // 60 minutes,
    refreshIntervalWhileCharging: 1000 * 60 * 5 // 5 minutes
  }
},
key Required Description Default
username yes Your bluelink username
password yes Your bluelink password
pin yes The pin you use to refresh bluelink data in the app
region yes EU CA or US US
name no Optional name
refreshInterval no When should the data be refreshed when not charging? 1000 * 60 * 60 (60 minutes)
refreshIntervalWhileCharging no When should the data be refreshed when the car is charging? 1000 * 60 * 10 (10 minutes)
wakeOnModuleLoad no When true, on initial module load the car will be woken up when in sleep mode to get the latest data false
wakeOnRefresh no When set to true, the car will be woken up every time the module refreshes his data (see refreshInterval) false
showLastUpdated no Show 'Updated 4 minutes ago' at the bottom true

Preview

Test Image 3 Left Hyundai Ioniq example without custom name. As you can see this module is based on the MMM-Tesla2 module on the right.

BlueLinky

This package uses bluelinky. It is an unoffcial nodejs API wrapper for Hyundai BlueLink

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT