Overview
Represents a Thermostat on the network.
As a sub-class of ZigbeeDevice, it inherits everything from that class and its parent Device class, as well as providing convenience methods for interacting with Thermostats.
API
changeMode(SystemMode systemMode)
Usage
Sends a command over the network to change the System Mode of a Thermostat.
Returns a PropertyCommandData object containing the future result of the Property modified by the command.
This is a non-blocking call.
Parameters
| Name | Type | Description |
|---|---|---|
| systemMode | SystemMode | A enumeration with the following values: off, auto, cool, heat, emergency_heating, pre_cooling, fan_only, dry, sleep |
Returns
| Return Type | Description |
|---|---|
| PropertyCommandData | Contains a CompletableFuture<Property> of the property being modified by the command. Contains the last known (cached) value of the property being modified by the command. |
Examples
GatewayClient gateway = new GatewayClient(new ConnectionInfo(ConnectionType.ZIGBEE_UART, "/dev/ttyUSB0"),
...
Collection<Device> thermostats = gateway.getDevices( d -> d.getDeviceType().equals(ThermostatDevice.DEVICE_TYPE) );
for (Device device : thermostats) {
ThermostatDevice thermostat = (ThermostatDevice) device;
thermostat.changeMode(SystemMode.OFF);
}
readMode()
Usage
Sends a command over the network to read the Mode of a ThermostatDevice (i.e. SystemMode)
Returns a CompletableFuture of the 'systemMode' Property.
This is a non-blocking call.
Parameters
None.
Returns
| Return Type | Description |
|---|---|
| CompletableFuture<Property> | A CompletableFuture of the 'systemMode' Property. |
Examples
GatewayClient gateway = new GatewayClient(new ConnectionInfo(ConnectionType.ZIGBEE_UART, "/dev/ttyUSB0"),
...
Collection<Device> thermostats = gateway.getDevices( d -> d.getDeviceType().equals(ThermostatDevice.DEVICE_TYPE) );
for (Device device : thermostats) {
ThermostatDevice thermostat = (ThermostatDevice) device;
CompletableFuture<Property> futureMode = thermostat.readMode();
// you can block on the future, or handle it asynchronously
// blocking example
Property systemMode = futureMode.get();
// async example
futureMode.thenAccept( systemModeProperty -> System.out.println("systemMode: " + systemModeProperty) );
}
changeFanMode(FanMode fanMode)
Usage
Sends a command over the network to change the Fane Mode of a Thermostat.
Returns a PropertyCommandData object containing the future result of the Property modified by the command.
This is a non-blocking call.
Parameters
| Name | Type | Description |
|---|---|---|
| fanMode | FanMode | An enumeration with the following values: off, low, medium, high, on, auto, smart |
Returns
| Return Type | Description |
|---|---|
| PropertyCommandData | Contains a CompletableFuture<Property> of the property being modified by the command. Contains the last known (cached) value of the property being modified by the command. |
Examples
GatewayClient gateway = new GatewayClient(new ConnectionInfo(ConnectionType.ZIGBEE_UART, "/dev/ttyUSB0"),
...
Collection<Device> thermostats = gateway.getDevices( d -> d.getDeviceType().equals(ThermostatDevice.DEVICE_TYPE) );
for (Device device : thermostats) {
ThermostatDevice thermostat = (ThermostatDevice) device;
thermostat.changeFanMode(FanMode.LOW);
}
readFanMode()
Usage
Sends a command over the network to read the Fan Mode of a ThermostatDevice.
Returns a CompletableFuture of the 'fanMode' Property.
This is a non-blocking call.
Parameters
None.
Returns
| Return Type | Description |
|---|---|
| CompletableFuture<Property> | A CompletableFuture of the 'fanMode' Property. |
Examples
GatewayClient gateway = new GatewayClient(new ConnectionInfo(ConnectionType.ZIGBEE_UART, "/dev/ttyUSB0"),
...
Collection<Device> thermostats = gateway.getDevices( d -> d.getDeviceType().equals(ThermostatDevice.DEVICE_TYPE) );
for (Device device : thermostats) {
ThermostatDevice thermostat = (ThermostatDevice) device;
CompletableFuture<Property> futureMode = thermostat.readFanMode();
// you can block on the future, or handle it asynchronously
// blocking example
Property fanMode = futureMode.get();
// async example
futureMode.thenAccept( fanProperty -> System.out.println("fanMode: " + fanProperty) );
}
adjustSetpoint(Setpoint setpoint, int amount)
Usage
Sends a command over the network to adjust the cooling or heating Setpoint up or down by a specified amount.
Returns an Optional<CommandData> object containing the future result of the command.
This is a non-blocking call.
Parameters
| Name | Type | Description |
|---|---|---|
| setpoint | Setpoint | An enumeration with the following values: heat, cool |
| amount | int | The amount to adjust the setpoint up or down, in tenths of a degree (i.e. 10 = 1 degree, 1 = 0.1 degree) |
Returns
| Return Type | Description |
|---|---|
| Optional<CommandData> | An Optional CommandData class which contains a CompletableFuture<String> of the command result, as well as a String of the last known value of the Property this command effects. |
Examples
GatewayClient gateway = new GatewayClient(new ConnectionInfo(ConnectionType.ZIGBEE_UART, "/dev/ttyUSB0"),
...
Optional<CommandData> command;
Collection<Device> thermostats = gateway.getDevices( d -> d.getDeviceType().equals(ThermostatDevice.DEVICE_TYPE) );
for (Device device : thermostats) {
ThermostatDevice thermostat = (ThermostatDevice) device;
command = thermostat.adjustSetpoint(Setpoint.COOL, 10); // adjust cooling setpoint up by 1 degree
command.get().getCommandResult().thenAccept( result -> System.out.println("adjust cooling setpoint result: " + result) );
command = thermostat.adjustSetpoint(Setpoint.HEAT, -10); // adjust heating setpoint down by 1 degree
command.get().getCommandResult().thenAccept( result -> System.out.println("adjust heating setpoint result: " + result) );
}
readSetpointLimit(Setpoint setpoint)
Usage
Sends a command over the network to read the Setpoint of a ThermostatDevice.
Returns a CompletableFuture of the 'setpoint' Property.
This is a non-blocking call.
Parameters
| Name | Type | Description |
|---|---|---|
| setpoint | Setpoint | An enumeration with the following values: heat, cool |
Returns
| Return Type | Description |
|---|---|
| CompletableFuture<Property> | A CompletableFuture of the 'setpoint' Property. |
Examples
GatewayClient gateway = new GatewayClient(new ConnectionInfo(ConnectionType.ZIGBEE_UART, "/dev/ttyUSB0"),
...
Collection<Device> thermostats = gateway.getDevices( d -> d.getDeviceType().equals(ThermostatDevice.DEVICE_TYPE) );
for (Device device : thermostats) {
ThermostatDevice thermostat = (ThermostatDevice) device;
CompletableFuture<Property> future = thermostat.readSetpointLimit(Setpoint.HEAT);
// you can block on the future, or handle it asynchronously
// blocking example
Property setpoint = future.get();
// async example
future.thenAccept( setpoint -> System.out.println("setpoint: " + setpoint) );
}
setSetpointLimit(Setpoint setpoint, int setpointLimit)
Usage
Sends a command over the network to set the cooling or heating Setpoint to a specified amount.
Returns an Optional<CommandData> object containing the future result of the command.
This is a non-blocking call.
Parameters
| Name | Type | Description |
|---|---|---|
| setpoint | Setpoint | An enumeration with the following values: heat, cool |
| setpointLimit | int | The amount to set to setpoint to, in tenths of a degree (i.e. 2350 = 23.5 degrees) |
Returns
| Return Type | Description |
|---|---|
| PropertyCommandData | Contains a CompletableFuture<Property> of the property being modified by the command. Contains the last known (cached) value of the property being modified by the command. |
Examples
GatewayClient gateway = new GatewayClient(new ConnectionInfo(ConnectionType.ZIGBEE_UART, "/dev/ttyUSB0"),
...
Collection<Device> thermostats = gateway.getDevices( d -> d.getDeviceType().equals(ThermostatDevice.DEVICE_TYPE) );
for (Device device : thermostats) {
ThermostatDevice thermostat = (ThermostatDevice) device;
thermostat.setSetpointLimit(Setpoint.HEAT, 2350); // set the heating setpoint to 23.5 degrees
}
readRunningMode()
Usage
Sends a command over the network to read the Running Mode of a ThermostatDevice.
Returns a CompletableFuture of the 'runningMode' Property.
This is a non-blocking call.
Parameters
None.
Returns
| Return Type | Description |
|---|---|
| CompletableFuture<Property> | A CompletableFuture of the 'runningMode' Property. |
Examples
GatewayClient gateway = new GatewayClient(new ConnectionInfo(ConnectionType.ZIGBEE_UART, "/dev/ttyUSB0"),
...
Collection<Device> thermostats = gateway.getDevices( d -> d.getDeviceType().equals(ThermostatDevice.DEVICE_TYPE) );
for (Device device : thermostats) {
ThermostatDevice thermostat = (ThermostatDevice) device;
CompletableFuture<Property> futureMode = thermostat.readRunningMode();
// you can block on the future, or handle it asynchronously
// blocking example
Property runningMode = futureMode.get();
// async example
futureMode.thenAccept( runningModeProperty -> System.out.println("runningMode: " + runningModeProperty) );
}
getDeviceType()
Usage
Returns the DeviceType that the Device belongs to. DeviceType contains a type and category. For a ThermostatDevice, this would be:
- Category: HVAC
- Type: Thermostat
The value returned from this method can be used to search the network for Devices of the same type.
Parameters
None.
Returns
| Return Type | Description |
|---|---|
| DeviceType | The DeviceType object categorizing and identifying the ThermostatDevice. |
Examples
...
Collection<Device> thermostats = gw.getDevices( d -> d.getDeviceType().equals(ThermostatDevice.DEVICE_TYPE));
...
System.out.println("ThermostatDevice type: " + gw.getDevice(idStr).getDeviceType().getType() );
...