Class HueBridgeConnectionBuilder

java.lang.Object
io.github.zeroone3010.yahueapi.HueBridgeConnectionBuilder

public class HueBridgeConnectionBuilder
extends Object
Use this class to initialize a connection with your Bridge once you know the IP address of the Bridge.
  • Constructor Details

  • Method Details

    • isHueBridgeEndpoint

      public CompletableFuture<Boolean> isHueBridgeEndpoint()
      Returns a CompletableFuture that calls the /api/config path of given Hue Bridge to verify that you are connecting to a Hue bridge.
      Returns:
      A CompletableFuture with a boolean that is true when the call to the bridge was successful.
      Since:
      2.7.0
    • initializeApiConnection

      public CompletableFuture<String> initializeApiConnection​(String appName)
      Returns a CompletableFuture that completes once you push the button on the Hue Bridge. Returns an API key that you should use for any subsequent calls to the Bridge API.
      Parameters:
      appName - The name of your application.
      Returns:
      A CompletableFuture with an API key for your application. You should store this key for future usage.
      Since:
      1.0.0