HomeSeer Java Client

A Java client for the HomeSeer JSON API.

The java interface API for hsClient is here HSClient.java

Versions 1.12+ of hsClient also have client support for the Z-Wave plugin API here

The client was built based on this pdf and this documentation

HomeSeer versions hsClient was tested against include:

• HS4 version 4.1.2.0+
• HS3 Pro (SEL) Edition 3.0.0.548
• HS3 Pro (SEL) Edition 3.0.0.550

hsClient is one of numerous HomeSeer support applications created by khubla.com, including

• hsClient
• hsInflux
• hsMQTT
• hsOpenAPI

License

hsclient is distributed under the BSD 3-Clause License.

Maven coordinates

<dependency>
   <groupId>com.khubla.hsclient</groupId>
   <artifactId>hsclient</artifactId>
   <version>1.17</version>
</dependency>

Usage

Simply instantiate an HSClient and call the API methods

To get all Devices:

final HSClient hsClient = new HSClientImpl();
hsclient.connect(URL, USERNAME, PASSWORD);
try {
   final Map<Integer, Device> allDevices = hsClient.getDevicesByRef();
} finally {
   hsClient.close();
}

To get all Events:

HSConfiguration hsConfiguration = new HSConfiguration(URL, USERNAME, PASSWORD);
final HSClient hsClient = new HSClientImpl();
hsclient.connect(hsConfiguration);
try {
   final Map<Integer, Event> allEvents = hsClient.getEventsById();
} finally {
   hsClient.close();
}

To get a single Device:

HSConfiguration hsConfiguration = new HSConfiguration(URL, USERNAME, PASSWORD);
final HSClient hsClient = new HSClientImpl();
hsclient.connect(hsConfiguration);
try {
   final Device device = hsClient.getDevice(DEVICEREF);
} finally {
   hsClient.close();
}

Using the poller

hsClient includes a multithreaded poller which calls a callback interface. To use the poller, provide an implementation of DataPointCallback to the class Poller.

In hsClient V1.13+, the poller uses the "getdeviceschanged" API for more efficient polling. The poller can be configured to only send data when device values change, or can be configured to send data for all devices on every polling cycle.

Example polling:

HSConfiguration hsConfiguration = new HSConfiguration(URL, USERNAME, PASSWORD);
Poller poller = new Poller(hsConfiguration, POLLINTERVAL_MS, MY_DATAPOINTCALLBACK, THREADCOUNT, true);
poller.run();