GithubHelp home page GithubHelp logo

jcotton1123 / orvibo-http-server Goto Github PK

View Code? Open in Web Editor NEW
2.0 1.0 0.0 36 KB

A web interface and API for controlling Orvibo B25 and S25 wifi sockets.

License: Apache License 2.0

Shell 1.13% HTML 58.37% JavaScript 40.51%

orvibo-http-server's Introduction

Orvibo HTTP Server

A web interface and API for controlling B25 and S25 wifi sockets.

Features

UI

A very simple interface:

screenshot

API

Endpoint Method Description
/logs GET Retrieve the most recent 100 logs in reverse order.
/sockets GET Retrieve a list of sockets.
/sockets/:uid GET Retrieve the socket identified by the supplied UID (mac address).
/sockets/:uid/:state GET Change the state of the socket. Valid states include: on, off, toggle.

Setup

Note: you must use the Homemate App to associate each socket with your Wifi network. Once connected to your network you can control each device using this service.

Step 1 - Redirect homemate traffic to server

In order to control the Orvibo devices you must intercept the traffic destined for Homemates servers. The easiest way to accomplish this is to hijack DNS for their domain homemate.orvibo.com using Dnsmasq. Note that Dnsmasq must be running on your router or gateway. Most custom router firmwares including DD-WRT and Tomato support Dnsmasq. Apply the following configuration:

# Set primary and secondary DNS servers
server=8.8.8.8
server=8.8.4.4

# Override IP for homemate.orvibo.com
address=/homemate.orvibo.com/192.168.0.10

Step 2 - Retrieve the Orvibo key

Retrieve the Orvibo key using the script provided here. This key is needed in the next step.

Step 3 - Install, configure, and start service

  • Install NodeJS 6.X or higher.
  • Checkout this repository.
  • Run npm install to install the dependencies.
  • Copy the config.json.sample to config.json and update the file as necessary.
  • Run node index.js to start the service.

Acknowledgements

A big thanks to the following individuals for providing help and code:

orvibo-http-server's People

Contributors

jcotton1123 avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.