@kala4ek/homebridge-starline
Version:
StarLine plugin for Homebridge
103 lines (87 loc) • 4.05 kB
Markdown
# homebridge-starline
This is a plugin for [homebridge](https://github.com/nfarina/homebridge). It allows you to control your Starline with HomeKit and Siri.
## Installation
- Install HomeBridge, please follow it's [README](https://github.com/nfarina/homebridge/blob/master/README.md)
- Install this plugin using: `npm install -g --unsafe-perm @kala4ek/homebridge-starline`
- Update your configuration file. See below for a sample.
- Run the HomeBridge server
## Configuration
- Edit your configuration file from `~/.homebridge/config.json`
- Platform should always be **StarlinePlatform** so on the devices you can add your Starline's
- The **Username** and **Password** are required in order to send the commands
```
"platforms": [{
"platform": "StarlinePlatform",
"devices": [{
"name": "BMW 528i",
"username": "superman",
"password": "",
"appId": "",
"secret": "",
}]
}]
```
### By default all available accessories will be created for the Starline. You do have the option to change or remove some accessories. Use the `patchAccessories` for that. Specify the accessory code, and now you can hide accessory (disabled: true) or change name. Below you can find a list of all accessories.
```
"platforms": [{
"platform": "StarlinePlatform",
"devices": [{
"name": "BMW 528i",
"username": "superman",
"password": "",
"appId": "",
"secret": "",
"interval": 120000,
"patchAccessories": [
{
"code": "Webasta",
"disabled": false,
"name": "Предпусковой подогрев"
}
]
}]
}]
```
## Device settings
| Name | Description |
|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| name * | Name of the device in Starline system |
| username * | The username of your Starline account |
| password * | Your password |
| appId | Application Id key |
| secret | Application secret key |
| interval | This is the interval between check states of vehicle. By default it is `120000 ms` (every 2 minutes). There is a limit from StarLine - not more than 1000 requests per day. |
**appId** and **secret** need to be requested at https://my.starline.ru/developer
## Common Issues
### HomeBridge is crashing because of the plugin
The server is crashing at load with the following error `SyntaxError: Unexpected token ...`
Update your **Node** to a newer version.
### Other
If you have some other problem run HomeBridge with debug mode `DEBUG=* homebridge -D` and [open a new Issue](https://github.com/abdusalamov/homebridge-starline/issues/new) and we will try to figure it out together :)
## Accessories list
```
CarOnline
Engine
AddSens
Alarm
Arm
Balance
BatteryVoltage
CabinTemperature
Doors
EngineTemperature
GPS
GSM
Handbrake
Handsfree
Hijack
Hood
Poke
Run
Shock
Tilt
Trunk
Valet
Webasto
```