Table of Contents

maxLevel	2

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

...

changeSystemMode(SystemMode systemMode)

Usage

Sends a command over the network to change the System Mode of a Thermostat.

...

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.

...

Code Block

language	java

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.changeModechangeSystemMode(SystemMode.OFF);
}

...

readSystemMode()

Usage

Sends a command over the network to read the Mode of a ThermostatDevice (i.e. SystemMode)

...

Return Type	Description
CompletableFuture<Property>	A CompletableFuture of the 'systemMode' Property.

Examples

Code Block

language	java

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) );
}

...

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.

...

Return Type	Description
CompletableFuture<Property>	A CompletableFuture of the 'fanMode' Property.

Examples

Code Block

language	java

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) );
}

...

adjustOccupiedSetpoint(Setpoint setpoint,

...

double 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> a CompletableFuture<String> object containing the future result of the command.

...

Name	Type	Description
setpoint	Setpoint	An enumeration with the following values: heat, cool
amount	intdouble	The amount to adjust the setpoint up or down, in tenths of a degree (i.e. 10 = 1 degree, 1 = 0.1 degree). For example, 2.5 degrees.

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 effectsCompletableFuture<String>	A CompletableFuture<String> containing the result.

Examples

Code Block

language	java

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;
    
	// adjust cooling setpoint up by 1 degree
  command = thermostat.adjustSetpointadjustOccupiedSetpoint(Setpoint.COOL, 10); // adjust cooling setpoint up by 1 degree1.0)
              command.get().getCommandResult().thenAccept( result -> System.out.println("adjust cooling setpoint result: " + result) );

	// adjust heating setpoint down by 1 degree
  command = thermostat.adjustSetpointadjustOccupiedSetpoint(Setpoint.HEAT, -10); // adjust heating setpoint down by 1 degree1.0)
              command.get().getCommandResult().thenAccept( result -> System.out.println("adjust heating setpoint result: " + result) );
}

...

readOccupiedCoolingSetpoint() / readOccupiedHeatingSetpoint()

Usage

Sends a command over the network to read the Occupied Cooling or Heating Setpoint of a ThermostatDevice.

Returns a CompletableFuture of the 'setpoint' Property.

This is a non-blocking call.

Parameters

...

None.

Returns

Return Type	Description
CompletableFuture<Property>	A CompletableFuture of the 'setpoint' Property.

Examples

Code Block

language	java

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.readSetpointLimitreadOccupiedCoolingSetpoint(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) );
}

...

setOccupiedCoolingSetpoint(double temperature) / setOccupiedHeatingSetpoint(double temperature)

Usage

Sends a command over the network to set the cooling or heating Setpoint to a specified amount.

Returns an Optional<CommandData> a PropertyCommandData object containing the future result of the command.

...

Parameters

Name	Type	Description
setpoint	Setpoint	An enumeration with the following values: heat, cool
setpointLimit	inttemperature	double	The amount to set to setpoint to, in tenths of a degree (i.e. 2350 = 23. For example 24.5 degrees), etc.

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.

...

Code Block

language	java

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.setSetpointLimitsetOccupiedHeatingSetpoint(Setpoint.HEAT, 235023.5); // set the heating setpoint to 23.5 degrees
}

...

Return Type	Description
CompletableFuture<Property>	A CompletableFuture of the 'runningMode' Property.

Examples

Code Block

language	java

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) );
}

...

Returns

Return Type	Description
DeviceType	The DeviceType object categorizing and identifying the ThermostatDevice.

Examples

Code Block

language	java

...
Collection<Device> thermostats = gw.getDevices( d -> d.getDeviceType().equals(ThermostatDevice.DEVICE_TYPE));
...
System.out.println("ThermostatDevice type: " + gw.getDevice(idStr).getDeviceType().getType() );
...

...

Versions Compared

Old Version 5

New Version Current

Key

API

changeSystemMode(SystemMode systemMode)

Usage

Returns

readSystemMode()

Usage

Examples

Returns

Examples

adjustOccupiedSetpoint(Setpoint setpoint,

double amount)

Usage

Returns

Examples

readOccupiedCoolingSetpoint() / readOccupiedHeatingSetpoint()

Usage

Parameters

Returns

Examples

setOccupiedCoolingSetpoint(double temperature) / setOccupiedHeatingSetpoint(double temperature)

Usage

Parameters

Returns

Examples

Returns

Examples

Page Comparison

Versions Compared

Old Version 5

New Version Current

Key

API

changeSystemMode(SystemMode systemMode)

Usage

Returns

readSystemMode()

Usage

Examples

Returns

Examples

adjustOccupiedSetpoint(Setpoint setpoint,

double amount)

Usage

Returns

Examples

readOccupiedCoolingSetpoint() / readOccupiedHeatingSetpoint()

Usage

Parameters

Returns

Examples

setOccupiedCoolingSetpoint(double temperature) / setOccupiedHeatingSetpoint(double temperature)

Usage

Parameters

Returns

Examples

Returns

Examples