io.github.zeroone3010.yahueapi.v2.UpdateState Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yetanotherhueapi Show documentation
A library for controlling Philips Hue lights.
The newest version!
package io.github.zeroone3010.yahueapi.v2;

import io.github.zeroone3010.yahueapi.Color;
import io.github.zeroone3010.yahueapi.XAndYAndBrightness;
import io.github.zeroone3010.yahueapi.v2.domain.Xy;
import io.github.zeroone3010.yahueapi.v2.domain.update.Alert;
import io.github.zeroone3010.yahueapi.v2.domain.update.AlertType;
import io.github.zeroone3010.yahueapi.v2.domain.update.Dimming;
import io.github.zeroone3010.yahueapi.v2.domain.update.EffectType;
import io.github.zeroone3010.yahueapi.v2.domain.update.Effects;
import io.github.zeroone3010.yahueapi.v2.domain.update.Gradient;
import io.github.zeroone3010.yahueapi.v2.domain.update.GradientPoint;
import io.github.zeroone3010.yahueapi.v2.domain.update.TimedEffectType;
import io.github.zeroone3010.yahueapi.v2.domain.update.TimedEffects;
import io.github.zeroone3010.yahueapi.v2.domain.update.UpdateLight;

import java.time.Duration;
import java.util.List;
import java.util.stream.Collectors;

import static io.github.zeroone3010.yahueapi.v2.domain.update.On.OFF;
import static io.github.zeroone3010.yahueapi.v2.domain.update.On.ON;

public class UpdateState {

  public static final int LOWEST_POSSIBLE_BRIGHTNESS = 0;
  public static final int MAX_BRIGHTNESS = 100;

  private final UpdateLight updateLight;

  public UpdateState() {
    this.updateLight = new UpdateLight();
  }

  /**
   * Makes this state turn the light(s) on.
   *
   * @return This state, for easy chaining of different methods.
   * @see #off()
   * @see #on(boolean)
   */
  public UpdateState on() {
    updateLight.setOn(ON);
    return this;
  }

  /**
   * Makes this state turn the light(s) off.
   *
   * @return This state, for easy chaining of different methods.
   * @see #on()
   * @see #on(boolean)
   */
  public UpdateState off() {
    updateLight.setOn(OFF);
    return this;
  }

  /**
   * Toggles the on/off status of the light(s).
   *
   * @param on {@code true} to turn on, {@code false} to turn off.
   * @return This state, for easy chaining of different methods.
   * @see #on()
   * @see #off()
   */
  public UpdateState on(final boolean on) {
    updateLight.setOn(on ? ON : OFF);
    return this;
  }

  /**
   * @param brightness Brightness, from 0 to 100, 0 setting brightness to the lowest possible value.
   * @return This state, for easy chaining of different methods.
   */
  public UpdateState brightness(final int brightness) {
    final int clippedBrightness = Math.min(Math.max(brightness, LOWEST_POSSIBLE_BRIGHTNESS), MAX_BRIGHTNESS);
    updateLight.setDimming(new Dimming().setBrightness(clippedBrightness));
    return this;
  }

  /**
   * One way of setting the color of the light(s).
   *
   * @param color A {@link Color} object to specify a color.
   * @return This state, for easy chaining of different methods.
   * @see #xy(float, float)
   */
  public UpdateState color(final Color color) {
    final XAndYAndBrightness xy = XAndYAndBrightness.rgbToXy(color);
    updateLight.setColor(new io.github.zeroone3010.yahueapi.v2.domain.update.Color()
            .setXy(new Xy().setX(xy.getX()).setY(xy.getY())))
        .setDimming(new Dimming().setBrightness(xy.getBrightnessMax100()));
    return this;
  }

  /**
   * Other way of setting the color of the light(s): CIE XY gamut position.
   *
   * @param x A value from 0 to 1.
   * @param y A value from 0 to 1.
   * @return This state, for easy chaining of different methods.
   * @see #color(Color)
   */
  public UpdateState xy(final float x, final float y) {
    updateLight.setColor(new io.github.zeroone3010.yahueapi.v2.domain.update.Color().setXy(new Xy().setX(x).setY(y)));
    return this;
  }

  /**
   * Starts an effect, or stops it with the {@link EffectType#NO_EFFECT}.
   * Note that not all lights, not even all the color ones, support effects.
   * You may check the supported effects with the {@link Light#getSupportedEffects()} method.
   * Also note that rooms and zones do not support effects.
   *
   * @param effectType Type of effect.
   * @return This state, for easy chaining of different methods.
   */
  public UpdateState effect(final EffectType effectType) {
    updateLight.setEffects(new Effects().setEffect(effectType));
    return this;
  }

  /**
   * Alerts, i.e. flashes the light a few times.
   *
   * @return This state, for easy chaining of different methods.
   */
  public UpdateState alert() {
    updateLight.setAlert(new Alert().setAction(AlertType.BREATHE));
    return this;
  }

  /**
   * Starts the timed sunrise effect. The maximum duration is six hours.
   * The timed effect may be stopped with the {@link #clearTimedEffect()} method.
   *
   * Note that not all lights, not even all the color ones, support timed effects.
   * Also note that rooms and zones do not support timed effects.
   *
   * @param duration Duration of the sunrise effect.
   * @return This state, for easy chaining of different methods.
   * @see #clearTimedEffect()
   */
  public UpdateState sunrise(final Duration duration) {
    timedEffect(TimedEffectType.SUNRISE, duration);
    return this;
  }

  /**
   * Stops the timed effect.
   *
   * Note that not all lights, not even all the color ones, support timed effects.
   * Also note that rooms and zones do not support timed effects.
   *
   * @return This state, for easy chaining of different methods.
   * @see #sunrise(Duration)
   */
  public UpdateState clearTimedEffect() {
    timedEffect(TimedEffectType.NO_EFFECT, null);
    return this;
  }

  /**
   * Starts a timed effect. As of December 2022, "sunrise" and "no effect" are the only two options
   * that the Bridge offers. There are helper methods for both of those in this class, but this method
   * exists here for extra convenience so that you can start and stop the effect with the same method,
   * just changing the parameters.
   *
   * Note that not all lights, not even all the color ones, support timed effects.
   * Also note that rooms and zones do not support timed effects.
   *
   * @param effect Type of the effect.
   * @param duration How long should the effect last.
   * @return This state, for easy chaining of different methods.
   * @see #sunrise(Duration)
   * @see #clearTimedEffect()
   */
  public UpdateState timedEffect(final TimedEffectType effect, final Duration duration) {
    updateLight.setTimedEffects(new TimedEffects().setDuration(duration).setEffect(effect));
    return this;
  }

  /**
   * Gradient color setting, for lights that support gradients.
   * There must be exactly two, three, four, or five colors in the list.
   *
   * @param colors A List of {@link Color} objects to specify the colors.
   *               List length must be between 2 and 5, inclusive.
   * @return This state, for easy chaining of different methods.
   */
  public UpdateState gradient(final List colors) {
    final List gradientPoints = colors.stream()
        .map(color -> {
          final XAndYAndBrightness xy = XAndYAndBrightness.rgbToXy(color);
          return new io.github.zeroone3010.yahueapi.v2.domain.update.Color()
              .setXy(new Xy().setX(xy.getX()).setY(xy.getY()));
        })
        .map(color -> new GradientPoint().setColor(color))
        .collect(Collectors.toList());
    updateLight.setGradient(new Gradient().setPoints(gradientPoints));
    return this;
  }

  UpdateLight getUpdateLight() {
    return updateLight;
  }
}