Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jvandenaardweg committed Dec 4, 2022
1 parent 588df3e commit cb61b1d
Showing 1 changed file with 16 additions and 15 deletions.
31 changes: 16 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,21 @@
<p align="center">

<img src="https://github.com/homebridge/branding/raw/master/logos/homebridge-wordmark-logo-vertical.png" width="150">

</p>
<p align="center">
<a href="https://badge.fury.io/js/sort-by-property"><img src="https://badge.fury.io/js/homebridge-homewizard-energy-socket.svg" alt="npm version" /></a>
<a href="https://github.com/jvandenaardweg/sort-by-property/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="mit license" /></a>
</p>

# Homebridge plugin for HomeWizard Energy Socket

This Homebridge plugin exposes your [HomeWizard Energy Sockets](https://www.homewizard.com/shop/wi-fi-energy-socket/) to Apple HomeKit. So you can use the Home App to manually switch - or automate - your Energy Sockets.

**Important:** This plugin is new and still in development. Please report any issues you encounter.
This Homebridge plugin exposes your [HomeWizard Energy Sockets](https://www.homewizard.com/shop/wi-fi-energy-socket/) to Apple HomeKit. So you can use the Home App to switch your Energy Sockets on or off and integrate the Energy Sockets into your HomeKit Automations.

## Getting started

For Homebridge to communicate with your Energy Sockets, it is preferred they all have a fixed IP address in your network. You also need to enable the "Local API" setting from within the HomeWizard "Energy" app for each Energy Socket you want to expose to Apple HomeKit.
For Homebridge to communicate with your Energy Sockets, it is required to enable the "Local API" setting from within the HomeWizard "Energy" app for each Energy Socket you want to expose to Apple HomeKit. It is also you assign fixed/static IP addresses to each Energy Socket in your network.

More on this on the HomeWizard support page: [Integrating Energy with other systems (API)](https://helpdesk.homewizard.com/en/articles/5935977-integrating-energy-with-other-systems-api)

### Set fixed IP addresses

First, verify if all Energy Sockets have a fixed IP address in your network. If not, adjust your router settings to give each Energy Socket a fixed IP address. If you don't know how to do this, or you can't set fixed IP addresses, then there might be issues when an Energy Socket is assigned a different IP address by your router after setting up this plugin.

1. Open your local router or network settings
2. Find the IP addresses of each Energy Socket you want to use
3. Make sure they use a fixed IP address

### Enabling the Local API setting (required)

1. Open your HomeWizard "Energy" app
Expand All @@ -32,12 +24,21 @@ First, verify if all Energy Sockets have a fixed IP address in your network. If

After installing this plugin, the plugin will automatically discover the Energy Sockets in your network.

### Set fixed IP addresses
To add to the reliability of your HomeKit accessories, it is adviced to assign static/fixed IP addresses to devices you use within Apple's Home App. Not doing this might result in your Energy Socket not responding when controlling within the Home App.

1. Open your local router or network settings
2. Find the IP addresses of each Energy Socket you want to use
3. Make sure they use a fixed IP address

## Installation in Homebridge

This package is published on NPM, so available on the Homebridge plugin page

1. Go to your Homebridge UI and click on "Plugins"
2. Find `HomeWizard Energy` and select the plugin `Homebridge HomeWizard Energy` from `@jvandenaardweg` and click "Install"
2. Search for `HomeWizard Energy` and select the plugin `Homebridge HomeWizard Energy Socket` from `@jvandenaardweg` and click "Install"
3. No additional configuration is required. But make sure to follow the instructions provided by Homebridge after you enabled the plugin.

After enabling the plugin, the plugin will automatically discover the Energy Sockets in your network. Is your Energy Socket not discovered? Make sure you enabled the "Local API" setting in the HomeWizard "Energy" app and then restart the Homebridge plugin and/or server.

Make sure to read this Wiki article about [Identifying the Energy Socket in the Home App](https://github.com/jvandenaardweg/homebridge-homewizard-energy-socket/wiki/Identifying-the-Energy-Socket-in-the-Home-App)

0 comments on commit cb61b1d

Please sign in to comment.