Skip to content

Commit

Permalink
Add new methods, jsdocs, and refactor some logic
Browse files Browse the repository at this point in the history
  • Loading branch information
Sean Boult committed Jun 12, 2019
1 parent ea4e113 commit de52255
Show file tree
Hide file tree
Showing 5 changed files with 277 additions and 78 deletions.
37 changes: 31 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,39 @@
# Bluelinky
An API wrapper for Hyundai bluelink

# Example
```javascript
const bluelinky = require('bluelinky');

## Observations
Seems the API has daily limits for commands, unsure of the numbers yet.
const token = await bluelinky.getToken({
email: process.env.EMAIL,
password: process.env.PASSWORD,
vin: process.env.VIN,
pin: process.env.PIN
});

`You have exceeded the daily remote service request limit. Your last request was not processed`
const test = await bluelinky.lockVehicle(token, {
email: process.env.EMAIL,
vin: process.env.VIN,
pin: process.env.PIN
});
console.log(test);
```

## TODO
## Supported Features
- [X] Lock
- [ ] Unlock
- [ ] Start
- [X] Unlock
- [X] Start
- [X] Stop
- [X] Health
- [X] Flash Lights
- [X] Status
- [ ] Valet Mode?
- [ ] Speed Alert?
- [ ] Geofencing?


## Observations
Seems the API has daily limits for commands, unsure of the numbers yet.

`You have exceeded the daily remote service request limit. Your last request was not processed`
7 changes: 1 addition & 6 deletions index.js
Original file line number Diff line number Diff line change
@@ -1,6 +1 @@
const { lockVehicle, startVehicle } = require('./lib/wrapper');

module.exports = {
lockVehicle,
startVehicle
}
module.exports = require('./lib/wrapper');
Loading

0 comments on commit de52255

Please sign in to comment.