Hue (YetAnotherHueApi 1.3.1 API)

java.lang.Object
- io.github.zeroone3010.yahueapi.Hue

```
public final class Hue
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Hue.HueBridgeConnectionBuilder

Nested Classes
Modifier and Type	Class	Description
`static class`	`Hue.HueBridgeConnectionBuilder`

Constructor Summary

Constructors
Constructor	Description
`Hue(HueBridgeProtocol protocol, String bridgeIp, String apiKey)`	A basic constructor for initializing the Hue Bridge connection for this library.
`Hue(String bridgeIp, String apiKey)`	The basic constructor for initializing the Hue Bridge connection for this library.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Collection<DaylightSensor>`	`getDaylightSensors()`	Returns all the daylight sensors configured into the Bridge.
`Optional<DimmerSwitch>`	`getDimmerSwitchByName(String switchName)`	Returns a specific dimmer switch by its name.
`Collection<DimmerSwitch>`	`getDimmerSwitches()`	Returns all the dimmer switches configured into the Bridge.
`Collection<Room>`	`getGroupsOfType(GroupType... groupTypes)`	Returns all groups of lights that match any of the specified group types.
`Optional<MotionSensor>`	`getMotionSensorByName(String sensorName)`	Returns a specific motion sensor by its name.
`Collection<MotionSensor>`	`getMotionSensors()`	Returns all the motion sensors configured into the Bridge.
`Root`	`getRaw()`	Returns the raw root node information of the REST API.
`Optional<Room>`	`getRoomByName(String roomName)`	Returns a specific room by its name.
`Collection<Room>`	`getRooms()`	Returns all the rooms configured into the Bridge.
`Optional<TemperatureSensor>`	`getTemperatureSensorByName(String sensorName)`	Returns a specific temperature sensor by its name.
`Collection<TemperatureSensor>`	`getTemperatureSensors()`	Returns all the temperature sensors configured into the Bridge.
`Collection<Sensor>`	`getUnknownSensors()`	Returns all the sensors configured into the Bridge.
`Optional<Room>`	`getZoneByName(String zoneName)`	Returns a specific zone by its name.
`Collection<Room>`	`getZones()`	Returns all the zones configured into the Bridge.
`static Hue.HueBridgeConnectionBuilder`	`hueBridgeConnectionBuilder(String bridgeIp)`	The method to be used if you do not have an API key for your application yet.
`boolean`	`isCaching()`	Tells whether this instance caches the states of objects, such as lights.
`void`	`refresh()`	Refreshes the room, lamp, etc.
`void`	`setCaching(boolean enabled)`	Controls whether cached states of objects, such as lights, should be used.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Hue
```
public Hue(String bridgeIp,
           String apiKey)
```
    The basic constructor for initializing the Hue Bridge connection for this library. Use the hueBridgeConnectionBuilder method if you do not have an API key yet.
    
    Parameters:
    
    bridgeIp - The IP address of the Hue Bridge.
    
    apiKey - The API key of your application.
    
    Since:
    
    1.0.0
  - Hue
```
public Hue(HueBridgeProtocol protocol,
           String bridgeIp,
           String apiKey)
```
    A basic constructor for initializing the Hue Bridge connection for this library. Use the hueBridgeConnectionBuilder method if you do not have an API key yet.
    
    Parameters:
    
    protocol - The desired protocol for the Bridge connection. HTTP or UNVERIFIED_HTTPS, as the certificate that the Bridge uses cannot be verified. Defaults to HTTP when using the other constructor.
    
    bridgeIp - The IP address of the Hue Bridge.
    
    apiKey - The API key of your application.
    
    Since:
    
    1.0.0
- Method Detail
  - setCaching
```
public void setCaching(boolean enabled)
```
    Controls whether cached states of objects, such as lights, should be used. Off (false) by default. If set on (true), querying light states will NOT actually relay the query to the Bridge. Instead, it uses the state that was valid when this method was called, or the state that was valid when subsequent calls to the refresh() method were made.
    
    One should use caching when performing multiple queries in a quick succession, such as when querying the states of all the individual lights in a Hue setup.
    
    If caching is already on and you try to enable it again, this method does nothing. Similarly nothing happens if caching is already disabled and one tries to disable it again.
    
    Parameters:
    
    enabled - Set to true to have the lights cache their results from the Bridge. Remember to call refresh() first when you need to retrieve the absolutely current states.
    
    Since:
    
    1.2.0
  - isCaching
```
public boolean isCaching()
```
    Tells whether this instance caches the states of objects, such as lights.
    
    Returns:
    
    true if cached results are returned, false if all queries are directed to the Bridge.
    
    Since:
    
    1.2.0
  - refresh
```
public void refresh()
```
    Refreshes the room, lamp, etc. data from the Hue Bridge, in case it has been updated since the application was started. This method is particularly useful if caching is enabled with the setCaching(boolean) method. Calls to refresh() will, in that case, refresh the states of the lights.
    
    Since:
    
    1.0.0
  - getGroupsOfType
```
public Collection<Room> getGroupsOfType(GroupType... groupTypes)
```
    Returns all groups of lights that match any of the specified group types.
    
    Parameters:
    
    groupTypes - Type or types of groups to get.
    
    Returns:
    
    A Collection of groups matching the requested types.
    
    Since:
    
    1.3.0
  - getRooms
```
public Collection<Room> getRooms()
```
    Returns all the rooms configured into the Bridge. Acts as a shorthand version of calling getGroupsOfType(GroupType...) with value GroupType.ROOM.
    
    Returns:
    
    A Collection of rooms.
    
    Since:
    
    1.0.0
  - getZones
```
public Collection<Room> getZones()
```
    Returns all the zones configured into the Bridge. Acts as a shorthand version of calling getGroupsOfType(GroupType...) with value GroupType.ZONE.
    
    Returns:
    
    A Collection of zones as Room objects.
    
    Since:
    
    1.1.0
  - getRoomByName
```
public Optional<Room> getRoomByName(String roomName)
```
    Returns a specific room by its name.
    
    Parameters:
    
    roomName - The name of a room
    
    Returns:
    
    A room or Optional.empty() if a room with the given name does not exist.
    
    Since:
    
    1.0.0
  - getZoneByName
```
public Optional<Room> getZoneByName(String zoneName)
```
    Returns a specific zone by its name.
    
    Parameters:
    
    zoneName - The name of a zone
    
    Returns:
    
    A zone or Optional.empty() if a zone with the given name does not exist.
    
    Since:
    
    1.1.0
  - getRaw
```
public Root getRaw()
```
    Returns the raw root node information of the REST API. Not required for anything but querying the most technical details of the Bridge setup. Note that it is not possible to change the state of the Bridge or the lights by using any values returned by this method: the results are read-only. The results of this method are also always cached, so a call to this method never triggers a query to the Bridge (unless no other queries have been made to the Bridge since this instance of Hue was constructed). To refresh the cache call the refresh() method.
    
    Returns:
    
    A Root element, as received from the Bridge REST API. Always returns a cached version of the data.
    
    Since:
    
    1.0.0
  - getUnknownSensors
```
public Collection<Sensor> getUnknownSensors()
```
    Returns all the sensors configured into the Bridge.
    
    Returns:
    
    A Collection of sensors.
    
    Since:
    
    1.0.0
  - getTemperatureSensors
```
public Collection<TemperatureSensor> getTemperatureSensors()
```
    Returns all the temperature sensors configured into the Bridge.
    
    Returns:
    
    A Collection of temperature sensors.
    
    Since:
    
    1.0.0
  - getDimmerSwitches
```
public Collection<DimmerSwitch> getDimmerSwitches()
```
    Returns all the dimmer switches configured into the Bridge.
    
    Returns:
    
    A Collection of dimmer switches.
    
    Since:
    
    1.0.0
  - getMotionSensors
```
public Collection<MotionSensor> getMotionSensors()
```
    Returns all the motion sensors configured into the Bridge.
    
    Returns:
    
    A Collection of motion sensors.
    
    Since:
    
    1.0.0
  - getDaylightSensors
```
public Collection<DaylightSensor> getDaylightSensors()
```
    Returns all the daylight sensors configured into the Bridge.
    
    Returns:
    
    A Collection of daylight sensors.
    
    Since:
    
    1.0.0
  - getTemperatureSensorByName
```
public Optional<TemperatureSensor> getTemperatureSensorByName(String sensorName)
```
    Returns a specific temperature sensor by its name.
    
    Parameters:
    
    sensorName - The name of a sensor
    
    Returns:
    
    A sensor or Optional.empty() if a sensor with the given name does not exist.
    
    Since:
    
    1.0.0
  - getMotionSensorByName
```
public Optional<MotionSensor> getMotionSensorByName(String sensorName)
```
    Returns a specific motion sensor by its name.
    
    Parameters:
    
    sensorName - The name of a sensor
    
    Returns:
    
    A sensor or Optional.empty() if a sensor with the given name does not exist.
    
    Since:
    
    1.0.0
  - getDimmerSwitchByName
```
public Optional<DimmerSwitch> getDimmerSwitchByName(String switchName)
```
    Returns a specific dimmer switch by its name.
    
    Parameters:
    
    switchName - The name of a switch
    
    Returns:
    
    A dimmer switch or Optional.empty() if a dimmer switch with the given name does not exist.
    
    Since:
    
    1.0.0
  - hueBridgeConnectionBuilder
```
public static Hue.HueBridgeConnectionBuilder hueBridgeConnectionBuilder(String bridgeIp)
```
    The method to be used if you do not have an API key for your application yet. Returns a HueBridgeConnectionBuilder that initializes the process of adding a new application to the Bridge.
    
    Parameters:
    
    bridgeIp - The IP address of the Bridge.
    
    Returns:
    
    A connection builder that initializes the application for the Bridge.
    
    Since:
    
    1.0.0

Class Hue

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Hue

Hue

Method Detail

setCaching

isCaching

refresh

getGroupsOfType

getRooms

getZones

getRoomByName

getZoneByName

getRaw

getUnknownSensors

getTemperatureSensors

getDimmerSwitches

getMotionSensors

getDaylightSensors

getTemperatureSensorByName

getMotionSensorByName

getDimmerSwitchByName

hueBridgeConnectionBuilder