Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesbarnett91 authored Apr 4, 2018
1 parent 4910da4 commit 0842361
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# TPLink Energy Monitor
[![Build Status](https://travis-ci.org/jamesbarnett91/tplink-monitor.svg?branch=master)](https://travis-ci.org/jamesbarnett91/tplink-monitor)
[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=tplink-monitor&metric=alert_status)](https://sonarcloud.io/api/project_badges/measure?project=tplink-monitor&metric=alert_status)
[![Build Status](https://travis-ci.org/jamesbarnett91/tplink-energy-monitor.svg?branch=master)](https://travis-ci.org/jamesbarnett91/tplink-energy-monitor)
[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=tplink-monitor&metric=alert_status)](https://sonarcloud.io/dashboard?id=tplink-monitor)

A web based monitoring dashboard displaying energy usage data and statistics for TP-Link HS110 smart plugs.

Expand All @@ -22,7 +22,7 @@ Written in Node.js + Express, and fully responsive so works well on mobile devic
You can use any of the following methods to get the project running:

### Packaged executable
The easiest way to run the project is to download one of the packaged executable from the [releases page](https://github.com/jamesbarnett91/tplink-monitor/releases). These are single file executable with all dependencies included. Just download the relevant file for your OS (Windows, Linux and MacOS available) and double click the file. Then go to `localhost:3000` in your browser to access the dashboard.
The easiest way to run the project is to download one of the packaged executables from the [releases page](https://github.com/jamesbarnett91/tplink-monitor/releases). These are single file executables with all dependencies included. Just download the relevant file for your OS (Windows, Linux and MacOS available) and double click the file. Then go to `localhost:3000` in your browser to access the dashboard.

### Docker
Alternatively, you can pull the `jbarnett/tplink-energy-monitor` image and run that.
Expand All @@ -43,7 +43,7 @@ $ npm start
### Note
Because the server needs access to your local network to scan for TP-Link device, you must run the server on the same network which your TP Link plugs are connected to. For the vast majority of people this shouldn't be an issue, and you can still use different network interfaces (i.e. plug(s) on WiFi and server on ethernet) as long as they all connect to the same network.

A note for Windows users: There seems to be an issue with the UDP broadcast the server performs to scan for devices which occurs when you also have VirtualBox installed on your Windows machine. I think this is because the response from the plug is routed to the VirtualBox Host-Only network adapter, rather than your primary network interface (for reasons which I haven't worked out yet).
A note for Windows users: There seems to be an issue with the UDP broadcast the server performs to scan for devices which occurs when you also have VirtualBox installed on your Windows machine. I think this is because the response from the plug is routed to the VirtualBox Host-Only network adapter, rather than your primary network interface (for some reason).

If you hit this issue you can try disabling the VirtualBox adapter in `Control Panel > Network and Internet > Network Connections` and see if that solves the problem.

Expand Down

0 comments on commit 0842361

Please sign in to comment.