Skip to content

Commit

Permalink
Added iOS screenshot and prerequisites to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
runbert authored Dec 19, 2021
1 parent c8032b9 commit d65322c
Showing 1 changed file with 19 additions and 7 deletions.
26 changes: 19 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,34 @@ Tibber lightsensor is a plugin for Homebridge.

It fetches the current watt usage of your house and displays it as a lightsensor (lux) in Homekit. Using a built in timer, it can update the Home app UI with a new value as often as you'd like (default value is set to update once each second).

Example: 10 Watt from Tibber API is displayed as 10 lux in Home app.
For instance 10 Watt from Tibber API is displayed as 10 lux in Home app.

## Screenshots

![tibber.png](https://i.postimg.cc/gkVDqs5c/tibber.png)
### iOS Home App
<img src="https://i.postimg.cc/N02CCMgQ/Webp-net-gifmaker.gif" width="200" />

### Homebridge Config UI X
<img src="https://i.postimg.cc/gkVDqs5c/tibber.png" />

## Prerequisites

You need have a Tibber Pulse. You can buy them from their online store:

> https://tibber.com/se/store/produkt/pulse-p1
You will also need two API tokens from Tibber. One personal token, and your house id. Get them at:

> https://developer.tibber.com/
## Installation
This plugin is published on [npm](https://www.npmjs.com/package/homebridge-tibber-lightsensor) and should be installed globally using:

`npm i -g homebridge-tibber-lightsensor`
`npm install -g homebridge-tibber-lightsensor`

## Configuration

First thing you need to do is to buy a Tibber Pulse from their store (https://tibber.com/se/store/produkt/pulse-p1).

You then need to create API tokens in Tibbers developer portal. Go to https://developer.tibber.com/ using your Tibber account and `Generate an Access Token`. You then need to go to API Explorer https://developer.tibber.com/explorer, load your personal token and get your unique house ID under `Real time subscription`.
You need to create API tokens in Tibbers developer portal. Go to https://developer.tibber.com/ using your Tibber account and `Generate an Access Token`. You then need to go to API Explorer https://developer.tibber.com/explorer, load your personal token and get your unique house ID under `Real time subscription`.

You can now add these values to your homebridge config.json like the example below:
```
Expand All @@ -42,5 +54,5 @@ You can now add these values to your homebridge config.json like the example bel
```
The pullInterval is how often the lightsensor should be updated with a new value in ms. In our example above it is set to 1 second (1000 ms).

Restart homebridge, and you should now see a lightsensor accessory in one of your room displaying real time data from Tibber.
Restart homebridge, and you should now see a lightsensor accessory in one of your rooms displaying real time data from Tibber.

0 comments on commit d65322c

Please sign in to comment.