https://github.com/datmaffin/homebridge-tesla-powerwall
Homebridge Plugin for the Tesla Powerwall
https://github.com/datmaffin/homebridge-tesla-powerwall
homebridge homebridge-plugin powerwall tesla tesla-powerwall
Last synced: 2 months ago
JSON representation
Homebridge Plugin for the Tesla Powerwall
- Host: GitHub
- URL: https://github.com/datmaffin/homebridge-tesla-powerwall
- Owner: datMaffin
- License: isc
- Created: 2018-05-07T12:19:52.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-09-10T15:04:29.000Z (almost 3 years ago)
- Last Synced: 2023-12-16T16:13:11.585Z (over 1 year ago)
- Topics: homebridge, homebridge-plugin, powerwall, tesla, tesla-powerwall
- Language: JavaScript
- Homepage:
- Size: 130 KB
- Stars: 18
- Watchers: 7
- Forks: 10
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# homebridge-tesla-powerwall
[](https://www.npmjs.com/package/homebridge-tesla-powerwall)
[](https://www.npmjs.com/package/homebridge-tesla-powerwall)
(Unofficial) Homebridge Plugin for the Tesla Powerwall.
Communication with the Tesla Powerwall is according to https://github.com/vloschiavo/powerwall2 .
This Plugin is considered to be complete.
If you encounter a bug or want to propose a new feature, feel free to open an issue!
If you like this plugin, it is possible to donate a "cup of coffee" via Paypal:
[](https://www.paypal.me/HomebridgePowerwall)
# Installation
1. Install [Homebridge](https://github.com/homebridge/homebridge): see the [Homebridge wiki](https://github.com/homebridge/homebridge/wiki)
2. In the Homebridge Web-GUI, search for the "Tesla Powerwall" plugin and install it.
3. Adapt the `config.json` using the config view; add this plugin as a "platform" to your `config.json` file.
#### Legacy Installation Instructions
1. Install [Homebridge](https://github.com/homebridge/homebridge): `sudo npm install -g --unsafe-perm homebridge`
2. Install this plugin `sudo npm install -g homebridge-tesla-powerwall`
3. Add this plugin as a platform to your `config.json` file
## Configuration
Inside `config.json` of Homebridge:
```json
...
"platforms": [
{
```
Mandatory:
```json
"platform": "TeslaPowerwall",
"name": "Tesla Powerwall",
"ip": "111.222.111.222",
"password": "abc123",
```
* `name` can be freely chosen
* `ip` needs to be set to the IP-address of the Tesla Powerwall.
* `password` a correct password must be set
Optional:
```json
"port": "",
"username": "customer",
"email": "[email protected]",
"loginInterval": 39600000,
"pollingInterval": 15000,
"historyInterval": 300000,
"lowBattery": 20,
"additionalServices": {
"powerwall": {
"homekitVisual": true,
"eveHistory": true,
"batteryIsLowSwitch": false,
"batteryIsChargingSwitch": false,
"makeOnOffSwitchReadOnly": true
},
"solar": {
"homekitVisual": true,
"evePowerMeter": true,
"eveHistory": true,
"eveLineGraph": false,
"pullingFromSensor": false,
"sensorThreshold": 0
},
"grid": {
"homekitVisual": true,
"positiveEvePowerMeter": true,
"negativeEvePowerMeter": true,
"eveHistory": true,
"eveLineGraph": false,
"feedingToSensor": false,
"pullingFromSensor": false,
"sensorThreshold": 0
},
"battery": {
"homekitVisual": true,
"positiveEvePowerMeter": true,
"negativeEvePowerMeter": true,
"eveHistory": true,
"eveLineGraph": false,
"feedingToSensor": false,
"pullingFromSensor": false,
"sensorThreshold": 0
},
"home": {
"homekitVisual": true,
"evePowerMeter": true,
"eveHistory": true,
"eveLineGraph": false,
"feedingToSensor": false,
"sensorThreshold": 0
},
"gridstatus": {
"gridIsDownSwitch": false,
"gridIsUpSwitch": false,
"gridIsNotYetInSyncSwitch": false,
"gridIsDownSensor": false,
"gridIsUpSensor": false
}
}
```
* *Here* filled with default values (values that are used when the attribute
is not explicitly listed)
* `username`: the default ("customer") is currently the only username that will
work when logging in, i.e., there is no need to change any username;
using "customer" here, will *just work*.
* `email`: is part of the login data. However, it currently seems to be ignored,
i.e., it does not matter what email is entered.
* `loginInterval`, `pollingInterval` or `historyInterval` in milliseconds
* `loginInterval`: the login is executed periodically based on this interval.
After a successful login, the authentication token is currently valid for
24h. If your internet is unreliable, it may be helpful to set a lower
interval to guarantee at least one successful login in the 24h time span.
The default of 39600000ms corresponds to 11h.
* `lowBattery`: Percentage when the charge is considered critical/low
* `additionalServices`: Services additional to the basic switch with the
battery status.
- *`...Switch`*: Adds a switch that represents the current state. (Useful for
implementing Homekit automations.)
- *`...Sensor`*: Adds a sensor that represents the current state. (Useful for
implementing Homekit automations.)
- `sensorThreshold`: Defines the deadzone in which none of the sensors will
be active. E.g., when `sensorThreshold=10`, then the sensors will only
become active when the value is `>10` or `<-10`. Values close to zero will
then therefore not trigger a sensor. Note that this means that for a
`sensorThreshold` greater than `0` that the two sensors are **both**
disabled when value is in the deadzone.
Only a positive value makes sense for this option.
- `powerwall.homekitVisual`: Adds a lamp service representing the battery
level.
- `powerwall.eveHistory`: Adds an Eve weather service; sets the temperature
to the battery level in percent.
- `powerwall.makeOnOffSwitchReadOnly`: While the powerwall switch will
still be able to be flipped within, for example, the Home.app, when this
field is true, it will not have any effect.
The switch is always going to update its state based on the received state.
- *Powermeter* i.e. `solar`, `grid`, `battery`, `home`
+ `*.homekitVisual`: Adds a fan service displaying the current power in watts.
+ `*.evePowerMeter`: Adds an Eve powermeter service.
+ `*.evehistory`: Adds the total consumption to an Eve powermeter service.
Only works when `evePowerMeter` is also set to true.
+ `*.eveLineGraph`: Saves power data in an Eve weather diagram to get a
nice line chart.
```json
},
...
other platforms
...
]
...
```
### History Configuration
From: [Fakegato project](https://github.com/simont77/fakegato-history#history-persistence)
#### No persistence (The Elgato-Eve App will still save received measurements):
* Do not include "historySetting" in the `config.json`.
#### File-System persistence:
```json
"historySetting": {
```
Mandatory:
```json
"storage": "fs",
```
Optional:
```json
"size": 4032,
"path": "/place/to/store/my/persistence/"
```
* "size" default: 4032
* "path" default: `.homebridge` folder of the user or the given `homebridge -U` location
```json
}
```
#### Google Drive persistence:
```json
"historySetting": {
```
Mandatory:
```json
"storage": "googleDrive",
```
Optional:
```json
"size": 4032,
"folder": "fakegato",
"keyPath": "/place/to/store/my/keys/"
```
* "size" default: 4032
* "folder" default: "fakegato" as the folder on Google Drive.
* "keyPath" default: `.homebridge` folder of the user or the given `homebridge -U` location
```json
}
```
For the setup of Google Drive, please follow the Google Drive Quickstart for Node.js instructions from https://developers.google.com/drive/v3/web/quickstart/nodejs, except for these changes:
* In Step 1-h the working directory should be the .homebridge directory
* Skip Step 2 and 3
* In step 4, use the quickstartGoogleDrive.js included with this module. You need to run the command from fakegato-history directory. Then just follow steps a to c.
## Example Configuration
### Minimal Configuration
```json
...
{
"platform": "TeslaPowerwall",
"name": "Tesla Powerwall",
"ip": "192.168.178.100",
"password": "abc123",
"pollingInterval": 10000,
"historyInterval": 120000,
"lowBattery": 10,
"historySetting": {
"storage": "fs"
}
}
...
```
### When using Eve.app
```json
...
{
"platform": "TeslaPowerwall",
"name": "Tesla Powerwall",
"ip": "192.168.178.100",
"password": "abc123",
"additionalServices": {
"powerwall": {
"homekitVisual": false
},
"solar": {
"homekitVisual": false
},
"grid": {
"homekitVisual": false
},
"battery": {
"homekitVisual": false
},
"home": {
"homekitVisual": false
}
}
}
...
```
### Using only Home.app supported services (minimal)
```json
...
{
"platform": "TeslaPowerwall",
"name": "Tesla Powerwall",
"ip": "192.168.178.100",
"password": "abc123",
"additionalServices": {
"powerwall": {
"homekitVisual": false,
"eveHistory": false
},
"solar": {
"homekitVisual": false,
"evePowerMeter": false,
"eveHistory": false
},
"grid": {
"homekitVisual": false,
"positiveEvePowerMeter": false,
"negativeEvePowerMeter": false,
"eveHistory": false
},
"battery": {
"homekitVisual": false,
"positiveEvePowerMeter": false,
"negativeEvePowerMeter": false,
"eveHistory": false
},
"home": {
"homekitVisual": false,
"evePowerMeter": false,
"eveHistory": false
}
}
}
...
```
### Using only Home.app supported services (all the visualization services)
```json
...
{
"platform": "TeslaPowerwall",
"name": "Tesla Powerwall",
"ip": "192.168.178.100",
"password": "abc123",
"additionalServices": {
"powerwall": {
"eveHistory": false
},
"solar": {
"evePowerMeter": false,
"eveHistory": false
},
"grid": {
"positiveEvePowerMeter": false,
"negativeEvePowerMeter": false,
"eveHistory": false
},
"battery": {
"positiveEvePowerMeter": false,
"negativeEvePowerMeter": false,
"eveHistory": false
},
"home": {
"evePowerMeter": false,
"eveHistory": false
}
}
}
...
```
# FAQ
### I get a login error
If you get a login error similar to:
```
[4/16/2021, 6:56:52 PM] [Powerwall] error: null
[4/16/2021, 6:56:52 PM] [Powerwall] status code: 403
[4/16/2021, 6:56:52 PM] [Powerwall] body: {"code":403,"error":"Unable to GET to resource","message":"User does not have adequate access rights"}
```
* Ensure that the password is correct. Regarding the username, currently only "customer" (the default) will be accepted by the powerwall.
* The powerwall might require a re-registration and password update.
* Take a look at [issue #33](https://github.com/datMaffin/homebridge-tesla-powerwall/issues/33). Further feedback would always be appreciated.
### Plugin stopped working after the Powerwall upgraded to version 20.49.0
Upgrade to the latest update of this plugin and make sure the `password` field
is added (see documentation above).
The `username` field should, at the moment, have a value equal to the default, i.e., it must be
equal to "customer".
### Plugin behaves not as it should and the Powerwall version is lower than 20.49.0
Try to use the last 1.x.y version "1.1.0", i.e., `sudo npm install -g [email protected]`.
# Feature request / Bug found?
You are welcome to create an [Issue](https://github.com/datMaffin/homebridge-tesla-powerwall/issues/new).