Karl/orvibo-b25-server-kex
1
0
Fork 0
mirror of https://github.com/karl0ss/orvibo-b25-server-kex.git synced 2025-04-29 12:53:40 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4 from wichopy/master

Browse Source 
Update REDME with more details on setup
This commit is contained in:
Sandy 2018-01-09 21:02:12 +11:00 committed by GitHub
commit c0e9cd4cbf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -17,8 +17,11 @@ To run this server you will need to have Node.js installed. I run v6.11.0 but it
You will need to add the Orvibo PK key to decrypt and encrypt the initial packets.
You can find this using helpful bash script from Grayda [getKey.sh](https://gist.github.com/Grayda/eb48093bcfb96bfeec9c58ea301f2668) (you may have to add www to to url to make it work)
Once you have this key you will need to add it the ``OrviboSettings.js`` file or you can pass it into as part of the settings object when you create the orvibo server object.
For each socket on your network you will need to add its MAC address (colons removed and lower cased) to the plugInfo array as a uid and give it a name field for easier identification.
You can see this in the Example.js file
```
// Create a settings object to pass PK key and map sockets to names
@ -40,14 +43,20 @@ let orvbio = new Orvibo(settings);
Because these new sockets don't use UDP packets to communicate like the older versions you will also need to redirect all traffic from the host name ``homemate.orvibo.com``
on TCP port 10001 the computer running the server.
I used an Ubuntu machine running dnsmasq and set this server as my DNS server in my router but depending on your network you might have to do it differntly.
I used an Ubuntu machine running dnsmasq and set this server as my DNS server in my router but depending on your network you might have to do it differently. Most routers will let you modify your DNS settings under the WAN settings.
Make sure to set a static IP address to the computer that will be running the Ubuntu server (In following example, the ip of machine running this server is at 192.168.0.106)
```
server=8.8.8.8
address=/homemate.orvibo.com/192.168.0.106
```
Just a node: If you try to add a socket after you've redirected the DNS you will be ale to setup WiFi and use it with this library but your phone will probably timeout when trying to add the device
To confirm your dnsmasq is working, when visiting ``homemate.orvibo.com:10001`` from your browser the server should return a response.
You will know things are working when you hit the server in your browser (for Example.js this would be ``http://localhost:3000``) and start seeing your sockets in the array.
Just a note: If you try to add a socket after you've redirected the DNS you will be ale to setup WiFi and use it with this library but your phone will probably timeout when trying to add the device
to the official Orvibo server.
### Installing
@ -85,8 +94,16 @@ One thing to note is the Orvibo uses 1 as off and 0 as on for the socket state.
## Configuration
One you've got a socket connecting you can add it to the plugInfo array in the OrviboSettings.js or to your settings object you pass in.
This will match to uid to a name so you can easily see which socket is which.
Once you've got a socket connecting to the official app you can add it to the plugInfo array in the OrviboSettings.js or to your settings object you pass in.
This will match to uid to a name so you can easily see which socket is which.
## Confirmed Working Models
A list of Orvibo devices, confirmed by contributors, that work with this project:
| Device Name | Product ID | Confirmed By |
|------------ | :--------:| -----:|
| Orvibo Smart Socket (EU/AUS)| B25 | @sandysound|
| Orvibo Smart Socket (US/CAD)| S25 | @wichopy |
## Contributing