Skip to content

An unofficial nodejs API wrapper for Hyundai bluelink and Kia UVO

License

Notifications You must be signed in to change notification settings

mfried40/bluelinky

Repository files navigation

bluelinky

An unoffcial nodejs API wrapper for Hyundai BlueLink

CI npm Discord

Install

npm install bluelinky

Example

const BlueLinky = require('bluelinky');

const client = new BlueLinky({
  username: '[email protected]',
  password: 'hunter1',
  brand: 'hyundai',
  region: 'US',
  pin: '1234'
});

client.on('ready', async () => {
  const vehicle = client.getVehicle('5NMS55555555555555');
  try {
    const response = await vehicle.lock();
    console.log(response);
  } catch (err) {
    // log the error from the command invocation 
  }
});

client.on('error', async (err) => {
  // something went wrong with login
});

Debug locally

Ensure you have a config.json that matches the structure of the following, with your account details

{
  "username": "email",
  "password": "password",
  "pin": "ping",
  "vin": "vin"
}

Run an install for all the dependencies, npm install

Now you can invoke the debug.ts script with npm run debug

Documentation

Checkout out the bluelinky-docs for more info.

Supported Features

  • Lock
  • Unlock
  • Start (with climate control)
  • Stop
  • Status

Supported Regions

| Regions

Show your support

Give a ⭐️ if this project helped you!

About

An unofficial nodejs API wrapper for Hyundai bluelink and Kia UVO

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 98.8%
  • JavaScript 1.2%