JavaScript WebSocket class to communicate with Homegear
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
HomegearWsExample
WebSshExample
LICENSE
README.md
homegear-ws-1.0.8.js
homegear-ws-1.0.8.min.js
package.json
ui-screenshot.png
webssh-screenshot.png

README.md

HomegearWS

HomegearWS is a JavaScript class to communicate with Homegear bidirectionally using WebSockets. It also supports Homegear's WebSSH daemon in conjunction with xterm.js.

HomegearWS in combination with xterm.js as a Homegear WebSSH client You can use HomegearWS to implement UIs for Homegear

Requirements

  • Homegear version >= 0.7.27
  • A current web browser

Installation

npm install @homegear/homegearws

Or include homegear-ws-x.x.x.min.js in your project.

Usage example

Start by include homegear-ws-x.x.x.min.js in your project:

<script type="text/javascript" src="node_modules/homegearws/homegear-ws-1.0.0.min.js"></script>

Create a new HomegearWS object

var homegear = new HomegearWS('192.168.0.142', 2001, 'MyTestClient');

The first parameter is the IP address or hostname of Homegear, the second the RPC port and the third an arbitrary client id. If you want to connect to Homegear using SSL and authentication, the object creation looks like this:

var homegear = new HomegearWS('192.168.0.142', 2003, 'MyTestClient', true, 'homegear', 'homegear');

The fourth parameter enables SSL, the fifth is the username and the last parameter the password.

When session authentication is enabled, set the PHP session ID as user name. Make sure to set the PHP session variable "user" to the correct user name in PHP as this variable is retrieved by Homegear. See the examples on GitHub.

Set callback functions

There are three callback functions you can set:

ready(callback)

The passed callback function is called when the connection to Homegear has been successfully established. You can also manually check if you're connected to Homegear by calling:

homegear.isReady();
event(callback)

The callback function is called when the Browser received an event from Homegear. One parameter is passed to the function: The JSON-RPC encoded message.

error(callback)

The callback function is called on error, e. g. an unexpected disconnect or if authentication failed. It has one parameter: The error message.

Connect and disconnect

To connect, just call:

homegear.connect();

When the connection is disrupted, the class automatically tries to reconnect.

To disconnect, call:

homegear.disconnect();

Invoke RPC methods

All RPC methods documented in Homegear's RPC reference can be executed by calling "invoke":

homegear.invoke(object jsonRPC, function complete);

or

homegear.invoke(string methodName, function complete, parameter1, parameter2, ..., parameterN);

The function "complete" is called with the result of the method call. "complete" has one parameter: The response encoded as JSON-RPC. If you're not interested in the response, complete can be 'null'.

Receive events

To receive device events, you need to add the peers, you want to receive events for. To do that either call:

addPeer(peerId)

or

addPeers([peerId1, peerId2, ..., peerIdN]);

To remove the peers again, you can call:

removePeer(peerId)

or

removePeers([peerId1, peerId2, ..., peerIdN]);