9647691811

Committed 24 Jun 2024 03:01PM UTC coverage: 64.841%. First build

Build # 9647691811

Build Type

Pull #1038

github

Committed by

web-flow

Commit Message

Merge 68c695488 into e69e41785

Pull Request Pull Request #1038: AdaptiveLightingController fix & improvement

Run Details

1870 of 3700 branches covered (50.54%)

Branch coverage included in aggregate %.

0 of 17 new or added lines in 1 file covered. (0.0%)

7414 of 10618 relevant lines covered (69.82%)

310.39 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

19.38

/src/lib/controller/AdaptiveLightingController.ts

import assert from "assert";
import { HAPStatus } from "../HAPServer";
import { ColorUtils } from "../util/color-utils";
import { HapStatusError } from "../util/hapStatusError";
import { epochMillisFromMillisSince2001_01_01Buffer } from "../util/time";
import * as uuid from "../util/uuid";
import createDebug from "debug";
import { EventEmitter } from "events";
import { CharacteristicValue } from "../../types";
import {
  ChangeReason,
  Characteristic,
  CharacteristicChange,
  CharacteristicEventTypes,
  CharacteristicOperationContext,
} from "../Characteristic";
import {
  Brightness,
  CharacteristicValueActiveTransitionCount,
  CharacteristicValueTransitionControl,
  ColorTemperature,
  Hue,
  Lightbulb,
  Saturation,
  SupportedCharacteristicValueTransitionConfiguration,
} from "../definitions";
import * as tlv from "../util/tlv";
import {
  ControllerIdentifier,
  ControllerServiceMap,
  DefaultControllerType,
  SerializableController,
  StateChangeDelegate,
} from "./Controller";

const debug = createDebug("HAP-NodeJS:Controller:TransitionControl");

const enum SupportedCharacteristicValueTransitionConfigurationsTypes {
  SUPPORTED_TRANSITION_CONFIGURATION = 0x01,
}

const enum SupportedValueTransitionConfigurationTypes {
  CHARACTERISTIC_IID = 0x01,
  TRANSITION_TYPE = 0x02, // assumption
}

const enum TransitionType {
  BRIGHTNESS = 0x01, // uncertain
  COLOR_TEMPERATURE = 0x02,
}


const enum TransitionControlTypes {
  READ_CURRENT_VALUE_TRANSITION_CONFIGURATION = 0x01, // could probably a list of ValueTransitionConfigurationTypes
  UPDATE_VALUE_TRANSITION_CONFIGURATION = 0x02,
}

const enum ReadValueTransitionConfiguration {
  CHARACTERISTIC_IID = 0x01,
}

const enum UpdateValueTransitionConfigurationsTypes {
  VALUE_TRANSITION_CONFIGURATION = 0x01, // this type could be a tlv8 list
}

const enum ValueTransitionConfigurationTypes {
  // noinspection JSUnusedGlobalSymbols
  CHARACTERISTIC_IID = 0x01, // 1 byte
  TRANSITION_PARAMETERS = 0x02,
  UNKNOWN_3 = 0x03, // sent with value = 1 (1 byte)
  UNKNOWN_4 = 0x04, // not sent yet by anyone
  TRANSITION_CURVE_CONFIGURATION = 0x05,
  UPDATE_INTERVAL = 0x06, // 16 bit uint
  UNKNOWN_7 = 0x07, // not sent yet by anyone
  NOTIFY_INTERVAL_THRESHOLD = 0x08, // 32 bit uint
}

const enum ValueTransitionParametersTypes {
  TRANSITION_ID = 0x01, // 16 bytes
  START_TIME = 0x02, // 8 bytes the start time for the provided schedule, millis since 2001/01/01 00:00:000
  UNKNOWN_3 = 0x03, // 8 bytes, id or something (same for multiple writes)
}

const enum TransitionCurveConfigurationTypes {
  TRANSITION_ENTRY = 0x01,
  ADJUSTMENT_CHARACTERISTIC_IID = 0x02,
  ADJUSTMENT_MULTIPLIER_RANGE = 0x03,
}

const enum TransitionEntryTypes {
  ADJUSTMENT_FACTOR = 0x01,
  VALUE = 0x02,
  TRANSITION_OFFSET = 0x03, // the time in milliseconds from the previous transition, interpolation happens here
  DURATION = 0x04, // optional, default 0, sets how long the previous value will stay the same (non interpolation time section)
}

const enum TransitionAdjustmentMultiplierRange {
  MINIMUM_ADJUSTMENT_MULTIPLIER = 0x01, // brightness 10
  MAXIMUM_ADJUSTMENT_MULTIPLIER = 0x02, // brightness 100
}

const enum ValueTransitionConfigurationResponseTypes { // read format for control point
  VALUE_CONFIGURATION_STATUS = 0x01,
}

const enum ValueTransitionConfigurationStatusTypes {
  CHARACTERISTIC_IID = 0x01,
  TRANSITION_PARAMETERS = 0x02,
  TIME_SINCE_START = 0x03, // milliseconds since start of transition
}

interface AdaptiveLightingCharacteristicContext extends CharacteristicOperationContext {
  controller: AdaptiveLightingController;
}

// eslint-disable-next-line @typescript-eslint/no-explicit-any
function isAdaptiveLightingContext(context: any): context is AdaptiveLightingCharacteristicContext {
  return context && "controller" in context;
}

interface SavedLastTransitionPointInfo {
  curveIndex: number;
  lowerBoundTimeOffset: number;
}

/**
 * @group Adaptive Lighting
 */
export interface ActiveAdaptiveLightingTransition {
  /**
   * The instance id for the characteristic for which this transition applies to (aka the ColorTemperature characteristic).
   */
  iid: number;

  /**
   * Start of the transition in epoch time millis (as sent from the HomeKit controller).
   * Additionally see {@link timeMillisOffset}.
   */
  transitionStartMillis: number;
  /**
   * It is not necessarily given, that we have the same time (or rather the correct time) as the HomeKit controller
   * who set up the transition schedule.
   * Thus we record the delta between our current time and the the time sent with the setup request.
   * <code>timeMillisOffset</code> is defined as <code>Date.now() - transitionStartMillis;</code>.
   * So in the case were we actually have a correct local time, it most likely will be positive (due to network latency).
   * But of course it can also be negative.
   */
  timeMillisOffset: number;

  /**
   * Value is the same for ALL control write requests I have seen (even on other homes).
   * @private
   */
  transitionId: string;
  /**
   * Start of transition in milliseconds from 2001-01-01 00:00:00; unsigned 64 bit LE integer
   * @private as it is a 64 bit integer, we just store the buffer to not have the struggle to encode/decode 64 bit int in JavaScript
   */
  transitionStartBuffer: string;
  /**
   * Hex string of 8 bytes. Some kind of id (?). Sometimes it isn't supplied. Don't know the use for that.
   * @private
   */
  id3?: string;

  transitionCurve: AdaptiveLightingTransitionCurveEntry[];

  brightnessCharacteristicIID: number;
  brightnessAdjustmentRange: BrightnessAdjustmentMultiplierRange;

  /**
   * Interval in milliseconds specifies how often the accessory should update the color temperature (internally).
   * Typically this is 60000 aka 60 seconds aka 1 minute.
   * Note {@link notifyIntervalThreshold}
   */
  updateInterval: number,
  /**
   * Defines the interval in milliseconds on how often the accessory may send even notifications
   * to subscribed HomeKit controllers (aka call {@link Characteristic.updateValue}.
   * Typically this is 600000 aka 600 seconds aka 10 minutes or 300000 aka 300 seconds aka 5 minutes.
   */
  notifyIntervalThreshold: number;
}

/**
 * @group Adaptive Lighting
 */
export interface AdaptiveLightingTransitionPoint {
  /**
   * This is the time offset from the transition start to the {@link lowerBound}.
   */
  lowerBoundTimeOffset: number;


  transitionOffset: number;

  lowerBound: AdaptiveLightingTransitionCurveEntry;
  upperBound: AdaptiveLightingTransitionCurveEntry;
}

/**
 * @group Adaptive Lighting
 */
export interface AdaptiveLightingTransitionCurveEntry {
  /**
   * The color temperature in mired.
   */
  temperature: number,
  /**
   * The color temperature actually set to the color temperature characteristic is dependent
   * on the current brightness value of the lightbulb.
   * This means you will always need to query the current brightness when updating the color temperature
   * for the next transition step.
   * Additionally you will also need to correct the color temperature when the end user changes the
   * brightness of the Lightbulb.
   *
   * The brightnessAdjustmentFactor is always a negative floating point value.
   *
   * To calculate the resulting color temperature you will need to do the following.
   *
   * In short: temperature + brightnessAdjustmentFactor * currentBrightness
   *
   * Complete example:
   * ```js
   * const temperature = ...; // next transition value, the above property
   * // below query the current brightness while staying the the min/max brightness range (typically between 10-100 percent)
   * const currentBrightness = Math.max(minBrightnessValue, Math.min(maxBrightnessValue, CHARACTERISTIC_BRIGHTNESS_VALUE));
   *
   * // as both temperature and brightnessAdjustmentFactor are floating point values it is advised to round to the next integer
   * const resultTemperature = Math.round(temperature + brightnessAdjustmentFactor * currentBrightness);
   * ```
   */
  brightnessAdjustmentFactor: number;
  /**
   * The duration in milliseconds this exact temperature value stays the same.
   * When we transition to to the temperature value represented by this entry, it stays for the specified
   * duration on the exact same value (with respect to brightness adjustment) until we transition
   * to the next entry (see {@link transitionTime}).
   */
  duration?: number;
  /**
   * The time in milliseconds the color temperature should transition from the previous
   * entry to this one.
   * For example if we got the two values A and B, with A.temperature = 300 and B.temperature = 400 and
   * for the current time we are at temperature value 300. Then we need to transition smoothly
   * within the B.transitionTime to the B.temperature value.
   * If this is the first entry in the Curve (this value is probably zero) and is the offset to the transitionStartMillis
   * (the Date/Time were this transition curve was set up).
   */
  transitionTime: number;
}

/**
 * @group Adaptive Lighting
 */
export interface BrightnessAdjustmentMultiplierRange {
  minBrightnessValue: number;
  maxBrightnessValue: number;
}

/**
 * @group Adaptive Lighting
 */
export interface AdaptiveLightingOptions {
  /**
   * Defines how the controller will operate.
   * You can choose between automatic and manual mode.
   * See {@link AdaptiveLightingControllerMode}.
   */
  controllerMode?: AdaptiveLightingControllerMode,
  /**
   * Defines a custom temperature adjustment factor.
   *
   * This can be used to define a linear deviation from the HomeKit Controller defined
   * ColorTemperature schedule.
   *
   * For example supplying a value of `-10` will reduce the ColorTemperature, which is
   * calculated from the transition schedule, by 10 mired for every change.
   */
  customTemperatureAdjustment?: number,
}

/**
 * Defines in which mode the {@link AdaptiveLightingController} will operate in.
 * @group Adaptive Lighting
 */
export const enum AdaptiveLightingControllerMode {
  /**
   * In automatic mode pretty much everything from setup to transition scheduling is done by the controller.
   */
  AUTOMATIC = 1,
  /**
   * In manual mode setup is done by the controller but the actual transition must be done by the user.
   * This is useful for lights which natively support transitions.
   */
  MANUAL = 2,
}

/**
 * @group Adaptive Lighting
 */
export const enum AdaptiveLightingControllerEvents {
  /**
   * This event is called once a HomeKit controller enables Adaptive Lighting
   * or a HomeHub sends an updated transition schedule for the next 24 hours.
   * This is also called on startup when AdaptiveLighting was previously enabled.
   */
  UPDATE = "update",
  /**
   * In yet unknown circumstances HomeKit may also send a dedicated disable command
   * via the control point characteristic. You may want to handle that in manual mode as well.
   * The current transition will still be associated with the controller object when this event is called.
   */
  DISABLED = "disable",
}

/**
 * @group Adaptive Lighting
 * see {@link ActiveAdaptiveLightingTransition}.
 */
export interface AdaptiveLightingControllerUpdate {
  transitionStartMillis: number;
  timeMillisOffset: number;
  transitionCurve: AdaptiveLightingTransitionCurveEntry[];
  brightnessAdjustmentRange: BrightnessAdjustmentMultiplierRange;
  updateInterval: number,
  notifyIntervalThreshold: number;
}

/**
 * @group Adaptive Lighting
 */
// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging
export declare interface AdaptiveLightingController {
  /**
   * See {@link AdaptiveLightingControllerEvents.UPDATE}
   *
   * @param event
   * @param listener
   */
  on(event: "update", listener: (update: AdaptiveLightingControllerUpdate) => void): this;
  /**
   * See {@link AdaptiveLightingControllerEvents.DISABLED}
   *
   * @param event
   * @param listener
   */
  on(event: "disable", listener: () => void): this;

  emit(event: "update", update: AdaptiveLightingControllerUpdate): boolean;
  emit(event: "disable"): boolean;
}

/**
 * @group Adaptive Lighting
 */
export interface SerializedAdaptiveLightingControllerState {
  activeTransition: ActiveAdaptiveLightingTransition;
}

/**
 * This class allows adding Adaptive Lighting support to Lightbulb services.
 * The Lightbulb service MUST have the {@link Characteristic.ColorTemperature} characteristic AND
 * the {@link Characteristic.Brightness} characteristic added.
 * The light may also expose {@link Characteristic.Hue} and {@link Characteristic.Saturation} characteristics
 * (though additional work is required to keep them in sync with the color temperature characteristic. see below)
 *
 * How Adaptive Lighting works:
 *  When enabling AdaptiveLighting the iDevice will send a transition schedule for the next 24 hours.
 *  This schedule will be renewed all 24 hours by a HomeHub in your home
 *  (updating the schedule according to your current day/night situation).
 *  Once enabled the lightbulb will execute the provided transitions. The color temperature value set is always
 *  dependent on the current brightness value. Meaning brighter light will be colder and darker light will be warmer.
 *  HomeKit considers Adaptive Lighting to be disabled as soon a write happens to either the
 *  Hue/Saturation or the ColorTemperature characteristics.
 *  The AdaptiveLighting state must persist across reboots.
 *
 * The AdaptiveLightingController can be operated in two modes: {@link AdaptiveLightingControllerMode.AUTOMATIC} and
 * {@link AdaptiveLightingControllerMode.MANUAL} with AUTOMATIC being the default.
 * The goal would be that the color transition is done DIRECTLY on the light itself, thus not creating any
 * additional/heavy traffic on the network.
 * So if your light hardware/API supports transitions please go the extra mile and use MANUAL mode.
 *
 *
 *
 * Below is an overview what you need to or consider when enabling AdaptiveLighting (categorized by mode).
 * The {@link AdaptiveLightingControllerMode} can be defined with the second constructor argument.
 *
 * <b>AUTOMATIC (Default mode):</b>
 *
 *  This is the easiest mode to setup and needs less to no work form your side for AdaptiveLighting to work.
 *  The AdaptiveLightingController will go through setup procedure with HomeKit and automatically update
 *  the color temperature characteristic base on the current transition schedule.
 *  It is also adjusting the color temperature when a write to the brightness characteristic happens.
 *  Additionally, it will also handle turning off AdaptiveLighting, when it detects a write happening to the
 *  ColorTemperature, Hue or Saturation characteristic (though it can only detect writes coming from HomeKit and
 *  can't detect changes done to the physical devices directly! See below).
 *
 *  So what do you need to consider in automatic mode:
 *   - Brightness and ColorTemperature characteristics MUST be set up. Hue and Saturation may be added for color support.
 *   - Color temperature will be updated all 60 seconds by calling the SET handler of the ColorTemperature characteristic.
 *    So every transition behaves like a regular write to the ColorTemperature characteristic.
 *   - Every transition step is dependent on the current brightness value. Try to keep the internal cache updated
 *    as the controller won't call the GET handler every 60 seconds.
 *    (The cached brightness value is updated on SET/GET operations or by manually calling {@link Characteristic.updateValue}
 *    on the brightness characteristic).
 *   - Detecting changes on the lightbulb side:
 *    Any manual change to ColorTemperature or Hue/Saturation is considered as a signal to turn AdaptiveLighting off.
 *    In order to notify the AdaptiveLightingController of such an event happening OUTSIDE of HomeKit
 *    you must call {@link disableAdaptiveLighting} manually!
 *   - Be aware that even when the light is turned off the transition will continue to call the SET handler
 *    of the ColorTemperature characteristic.
 *   - When using Hue/Saturation:
 *    When using Hue/Saturation in combination with the ColorTemperature characteristic you need to update the
 *    respective other in a particular way depending on if being in "color mode" or "color temperature mode".
 *    When a write happens to Hue/Saturation characteristic in is advised to set the internal value of the
 *    ColorTemperature to the minimal (NOT RAISING an event).
 *    When a write happens to the ColorTemperature characteristic just MUST convert to a proper representation
 *    in hue and saturation values, with RAISING an event.
 *    As noted above you MUST NOT call the {@link Characteristic.setValue} method for this, as this will be considered
 *    a write to the characteristic and will turn off AdaptiveLighting. Instead, you should use
 *    {@link Characteristic.updateValue} for this.
 *    You can and SHOULD use the supplied utility method {@link ColorUtils.colorTemperatureToHueAndSaturation}
 *    for converting mired to hue and saturation values.
 *
 *
 * <b>MANUAL mode:</b>
 *
 *  Manual mode is recommended for any accessories which support transitions natively on the devices end.
 *  Like for example ZigBee lights which support sending transitions directly to the lightbulb which
 *  then get executed ON the lightbulb itself reducing unnecessary network traffic.
 *  Here is a quick overview what you have to consider to successfully implement AdaptiveLighting support.
 *  The AdaptiveLightingController will also in manual mode do all the setup procedure.
 *  It will also save the transition schedule to disk to keep AdaptiveLighting enabled across reboots.
 *  The "only" thing you have to do yourself is handling the actual transitions, check that event notifications
 *  are only sent in the defined interval threshold, adjust the color temperature when brightness is changed
 *  and signal that Adaptive Lighting should be disabled if ColorTemperature, Hue or Saturation is changed manually.
 *
 *  First step is to setup up an event handler for the {@link AdaptiveLightingControllerEvents.UPDATE}, which is called
 *  when AdaptiveLighting is enabled, the HomeHub updates the schedule for the next 24 hours or AdaptiveLighting
 *  is restored from disk on startup.
 *  In the event handler you can get the current schedule via {@link AdaptiveLightingController.getAdaptiveLightingTransitionCurve},
 *  retrieve current intervals like {@link AdaptiveLightingController.getAdaptiveLightingUpdateInterval} or
 *  {@link AdaptiveLightingController.getAdaptiveLightingNotifyIntervalThreshold} and get the date in epoch millis
 *  when the current transition curve started using {@link AdaptiveLightingController.getAdaptiveLightingStartTimeOfTransition}.
 *  Additionally {@link AdaptiveLightingController.getAdaptiveLightingBrightnessMultiplierRange} can be used
 *  to get the valid range for the brightness value to calculate the brightness adjustment factor.
 *  The method {@link AdaptiveLightingController.isAdaptiveLightingActive} can be used to check if AdaptiveLighting is enabled.
 *  Besides, actually running the transition (see {@link AdaptiveLightingTransitionCurveEntry}) you must correctly update
 *  the color temperature when the brightness of the lightbulb changes (see {@link AdaptiveLightingTransitionCurveEntry.brightnessAdjustmentFactor}),
 *  and signal when AdaptiveLighting got disabled by calling {@link AdaptiveLightingController.disableAdaptiveLighting}
 *  when ColorTemperature, Hue or Saturation where changed manually.
 *  Lastly you should set up a event handler for the {@link AdaptiveLightingControllerEvents.DISABLED} event.
 *  In yet unknown circumstances HomeKit may also send a dedicated disable command via the control point characteristic.
 *  Be prepared to handle that.
 *
 *  @group Adaptive Lighting
 */
// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging
export class AdaptiveLightingController
  extends EventEmitter
  implements SerializableController<ControllerServiceMap, SerializedAdaptiveLightingControllerState> {

  private stateChangeDelegate?: StateChangeDelegate;

  private readonly lightbulb: Lightbulb;
  private readonly mode: AdaptiveLightingControllerMode;
  private readonly customTemperatureAdjustment: number;

  private readonly adjustmentFactorChangedListener: (change: CharacteristicChange) => void;
  private readonly characteristicManualWrittenChangeListener: (change: CharacteristicChange) => void;

  private supportedTransitionConfiguration?: SupportedCharacteristicValueTransitionConfiguration;
  private transitionControl?: CharacteristicValueTransitionControl;
  private activeTransitionCount?: CharacteristicValueActiveTransitionCount;

  private colorTemperatureCharacteristic?: ColorTemperature;
  private brightnessCharacteristic?: Brightness;
  private saturationCharacteristic?: Saturation;
  private hueCharacteristic?: Hue;

  private activeTransition?: ActiveAdaptiveLightingTransition;
  private didRunFirstInitializationStep = false;
  private updateTimeout?: NodeJS.Timeout;

  private lastTransitionPointInfo?: SavedLastTransitionPointInfo;
  private lastEventNotificationSent = 0;
  private lastNotifiedTemperatureValue = 0;
  private lastNotifiedSaturationValue = 0;
  private lastNotifiedHueValue = 0;

  /**
   * Creates a new instance of the AdaptiveLightingController.
   * Refer to the {@link AdaptiveLightingController} documentation on how to use it.
   *
   * @param service - The lightbulb to which Adaptive Lighting support should be added.
   * @param options - Optional options to define the operating mode (automatic vs manual).
   */
  constructor(service: Lightbulb, options?: AdaptiveLightingOptions) {
    super();
    this.lightbulb = service;
    this.mode = options?.controllerMode ?? AdaptiveLightingControllerMode.AUTOMATIC;
    this.customTemperatureAdjustment = options?.customTemperatureAdjustment ?? 0;

    assert(this.lightbulb.testCharacteristic(Characteristic.ColorTemperature), "Lightbulb must have the ColorTemperature characteristic added!");
    assert(this.lightbulb.testCharacteristic(Characteristic.Brightness), "Lightbulb must have the Brightness characteristic added!");

    this.adjustmentFactorChangedListener = this.handleAdjustmentFactorChanged.bind(this);
    this.characteristicManualWrittenChangeListener = this.handleCharacteristicManualWritten.bind(this);
  }

  /**
   * @private
   */
  controllerId(): ControllerIdentifier {
    return DefaultControllerType.CHARACTERISTIC_TRANSITION + "-" + this.lightbulb.getServiceId();
  }

  // ----------- PUBLIC API START -----------

  /**
   * Returns if a Adaptive Lighting transition is currently active.
   */
  public isAdaptiveLightingActive(): boolean {
    return !!this.activeTransition;
  }

  /**
   * This method can be called to manually disable the current active Adaptive Lighting transition.
   * When using {@link AdaptiveLightingControllerMode.AUTOMATIC} you won't need to call this method.
   * In {@link AdaptiveLightingControllerMode.MANUAL} you must call this method when Adaptive Lighting should be disabled.
   * This is the case when the user manually changes the value of Hue, Saturation or ColorTemperature characteristics
   * (or if any of those values is changed by physical interaction with the lightbulb).
   */
  public disableAdaptiveLighting(): void {
    if (this.updateTimeout) {
      clearTimeout(this.updateTimeout);
      this.updateTimeout = undefined;
    }

    if (this.activeTransition) {
      this.colorTemperatureCharacteristic?.removeListener(CharacteristicEventTypes.CHANGE, this.characteristicManualWrittenChangeListener);
      this.brightnessCharacteristic?.removeListener(CharacteristicEventTypes.CHANGE, this.adjustmentFactorChangedListener);
      this.hueCharacteristic?.removeListener(CharacteristicEventTypes.CHANGE, this.characteristicManualWrittenChangeListener);
      this.saturationCharacteristic?.removeListener(CharacteristicEventTypes.CHANGE, this.characteristicManualWrittenChangeListener);

      this.activeTransition = undefined;

      this.stateChangeDelegate?.();
    }

    this.colorTemperatureCharacteristic = undefined;
    this.brightnessCharacteristic = undefined;
    this.hueCharacteristic = undefined;
    this.saturationCharacteristic = undefined;

    this.lastTransitionPointInfo = undefined;
    this.lastEventNotificationSent = 0;
    this.lastNotifiedTemperatureValue = 0;
    this.lastNotifiedSaturationValue = 0;
    this.lastNotifiedHueValue = 0;

    this.didRunFirstInitializationStep = false;

    this.activeTransitionCount?.sendEventNotification(0);

    debug("[%s] Disabling adaptive lighting", this.lightbulb.displayName);
  }

  /**
   * Returns the time where the current transition curve was started in epoch time millis.
   * A transition curves is active for 24 hours typically and is renewed every 24 hours by a HomeHub.
   * Additionally see {@link getAdaptiveLightingTimeOffset}.
   */
  public getAdaptiveLightingStartTimeOfTransition(): number {
    if (!this.activeTransition) {
      throw new Error("There is no active transition!");
    }
    return this.activeTransition.transitionStartMillis;
  }

  /**
   * It is not necessarily given, that we have the same time (or rather the correct time) as the HomeKit controller
   * who set up the transition schedule.
   * Thus we record the delta between our current time and the the time send with the setup request.
   * <code>timeOffset</code> is defined as <code>Date.now() - getAdaptiveLightingStartTimeOfTransition();</code>.
   * So in the case were we actually have a correct local time, it most likely will be positive (due to network latency).
   * But of course it can also be negative.
   */
  public getAdaptiveLightingTimeOffset(): number {
    if (!this.activeTransition) {
      throw new Error("There is no active transition!");
    }
    return this.activeTransition.timeMillisOffset;
  }

  public getAdaptiveLightingTransitionCurve(): AdaptiveLightingTransitionCurveEntry[] {
    if (!this.activeTransition) {
      throw new Error("There is no active transition!");
    }
    return this.activeTransition.transitionCurve;
  }

  public getAdaptiveLightingBrightnessMultiplierRange(): BrightnessAdjustmentMultiplierRange {
    if (!this.activeTransition) {
      throw new Error("There is no active transition!");
    }
    return this.activeTransition.brightnessAdjustmentRange;
  }

  /**
   * This method returns the interval (in milliseconds) in which the light should update its internal color temperature
   * (aka changes it physical color).
   * A lightbulb should ideally change this also when turned of in oder to have a smooth transition when turning the light on.
   *
   * Typically this evaluates to 60000 milliseconds (60 seconds).
   */
  public getAdaptiveLightingUpdateInterval(): number {
    if (!this.activeTransition) {
      throw new Error("There is no active transition!");
    }
    return this.activeTransition.updateInterval;
  }

  /**
   * Returns the minimum interval threshold (in milliseconds) a accessory may notify HomeKit controllers about a new
   * color temperature value via event notifications (what happens when you call {@link Characteristic.updateValue}).
   * Meaning the accessory should only send event notifications to subscribed HomeKit controllers at the specified interval.
   *
   * Typically this evaluates to 600000 milliseconds (10 minutes).
   */
  public getAdaptiveLightingNotifyIntervalThreshold(): number {
    if (!this.activeTransition) {
      throw new Error("There is no active transition!");
    }
    return this.activeTransition.notifyIntervalThreshold;
  }

  // ----------- PUBLIC API END -----------

  private handleActiveTransitionUpdated(calledFromDeserializer = false): void {
    if (this.activeTransitionCount) {
      if (!calledFromDeserializer) {
        this.activeTransitionCount.sendEventNotification(1);
      } else {
        this.activeTransitionCount.value = 1;
      }
    }

    if (this.mode === AdaptiveLightingControllerMode.AUTOMATIC) {
      this.scheduleNextUpdate();
    } else if (this.mode === AdaptiveLightingControllerMode.MANUAL) {
      if (!this.activeTransition) {
        throw new Error("There is no active transition!");
      }

      const update: AdaptiveLightingControllerUpdate = {
        transitionStartMillis: this.activeTransition.transitionStartMillis,
        timeMillisOffset: this.activeTransition.timeMillisOffset,
        transitionCurve: this.activeTransition.transitionCurve,
        brightnessAdjustmentRange: this.activeTransition.brightnessAdjustmentRange,
        updateInterval: this.activeTransition.updateInterval,
        notifyIntervalThreshold: this.activeTransition.notifyIntervalThreshold,
      };

      this.emit(AdaptiveLightingControllerEvents.UPDATE, update);
    } else {
      throw new Error("Unsupported adaptive lighting controller mode: " + this.mode);
    }

    if (!calledFromDeserializer) {
      this.stateChangeDelegate?.();
    }
  }

  private handleAdaptiveLightingEnabled(): void { // this method is run when the initial curve was sent
    if (!this.activeTransition) {
      throw new Error("There is no active transition!");
    }

    this.colorTemperatureCharacteristic = this.lightbulb.getCharacteristic(Characteristic.ColorTemperature);
    this.brightnessCharacteristic = this.lightbulb.getCharacteristic(Characteristic.Brightness);

    this.colorTemperatureCharacteristic.on(CharacteristicEventTypes.CHANGE, this.characteristicManualWrittenChangeListener);
    this.brightnessCharacteristic.on(CharacteristicEventTypes.CHANGE, this.adjustmentFactorChangedListener);

    if (this.lightbulb.testCharacteristic(Characteristic.Hue)) {
      this.hueCharacteristic = this.lightbulb.getCharacteristic(Characteristic.Hue)
        .on(CharacteristicEventTypes.CHANGE, this.characteristicManualWrittenChangeListener);
    }
    if (this.lightbulb.testCharacteristic(Characteristic.Saturation)) {
      this.saturationCharacteristic = this.lightbulb.getCharacteristic(Characteristic.Saturation)
        .on(CharacteristicEventTypes.CHANGE, this.characteristicManualWrittenChangeListener);
    }
  }

  private handleAdaptiveLightingDisabled(): void {
    if (this.mode === AdaptiveLightingControllerMode.MANUAL && this.activeTransition) { // only emit the event if a transition is actually enabled
      this.emit(AdaptiveLightingControllerEvents.DISABLED);
    }
    this.disableAdaptiveLighting();
  }

  private handleAdjustmentFactorChanged(change: CharacteristicChange): void {
    if (change.newValue === change.oldValue) {
      return;
    }

    // consider the following scenario:
    // a HomeKit controller queries the light (meaning e.g. Brightness, Hue and Saturation characteristics).
    // As of the implementation of the light the brightness characteristic get handler returns first
    // (and returns a value different than the cached value).
    // This change handler gets called and we will update the color temperature accordingly
    // (which also adjusts the internal cached values for Hue and Saturation).
    // After some short time the Hue or Saturation get handler return with the last known value to the plugin.
    // As those values now differ from the cached values (we already updated) we get a call to handleCharacteristicManualWritten
    // which again disables adaptive lighting.

    if (change.reason === ChangeReason.READ) {
      // if the reason is a read request, we expect that Hue/Saturation are also read
      // thus we postpone our update to ColorTemperature a bit.
      // It doesn't ensure that those race conditions do not happen anymore, but with a 1s delay it reduces the possibility by a bit
      setTimeout(() => {
        if (!this.activeTransition) {
          return; // was disabled in the mean time
        }
        this.scheduleNextUpdate(true);
      }, 1000).unref();
    } else {
      this.scheduleNextUpdate(true); // run a dry scheduleNextUpdate to adjust the colorTemperature using the new brightness value
    }
  }

  /**
   * This method is called when a change happens to the Hue/Saturation or ColorTemperature characteristic.
   * When such a write happens (caused by the user changing the color/temperature) Adaptive Lighting must be disabled.
   *
   * @param change
   */
  private handleCharacteristicManualWritten(change: CharacteristicChange): void {
    if (change.reason === ChangeReason.WRITE && !(isAdaptiveLightingContext(change.context) && change.context.controller === this)) {
      // we ignore write request which are the result of calls made to updateValue or sendEventNotification
      // or the result of a changed value returned by a read handler
      // or the change was done by the controller itself

      debug("[%s] Received a manual write to an characteristic (newValue: %d, oldValue: %d, reason: %s). Thus disabling adaptive lighting!",
        this.lightbulb.displayName, change.newValue, change.oldValue, change.reason);
      this.disableAdaptiveLighting();
    }
  }

  /**
   * Retrieve the {@link AdaptiveLightingTransitionPoint} for the current timestamp.
   * Returns undefined if the current transition schedule reached its end.
   */
  public getCurrentAdaptiveLightingTransitionPoint(): AdaptiveLightingTransitionPoint | undefined {
    if (!this.activeTransition) {
      throw new Error("Cannot calculate current transition point if no transition is active!");
    }

    // adjustedNow is the now() date corrected to the time of the initiating controller
    const adjustedNow = Date.now() - this.activeTransition.timeMillisOffset;
    // "offset" since the start of the transition schedule
    const offset = adjustedNow - this.activeTransition.transitionStartMillis;

    let i = this.lastTransitionPointInfo?.curveIndex ?? 0;
    let lowerBoundTimeOffset = this.lastTransitionPointInfo?.lowerBoundTimeOffset ?? 0; // time offset to the lowerBound transition entry
    let lowerBound: AdaptiveLightingTransitionCurveEntry | undefined = undefined;
    let upperBound: AdaptiveLightingTransitionCurveEntry | undefined = undefined;

    for (; i + 1 < this.activeTransition.transitionCurve.length; i++) {
      const lowerBound0 = this.activeTransition.transitionCurve[i];
      const upperBound0 = this.activeTransition.transitionCurve[i + 1];

      const lowerBoundDuration = lowerBound0.duration ?? 0;
      lowerBoundTimeOffset += lowerBound0.transitionTime;

      if (offset >= lowerBoundTimeOffset) {
        if (offset <= lowerBoundTimeOffset + lowerBoundDuration + upperBound0.transitionTime) {
          lowerBound = lowerBound0;
          upperBound = upperBound0;
          break;
        }
      } else if (this.lastTransitionPointInfo) {
        // if we reached here the entry in the transitionCurve we are searching for is somewhere before current i.
        // This can only happen when we have a faulty lastTransitionPointInfo (otherwise we would start from i=0).
        // Thus we try again by searching from i=0
        this.lastTransitionPointInfo = undefined;
        return this.getCurrentAdaptiveLightingTransitionPoint();
      }

      lowerBoundTimeOffset += lowerBoundDuration;
    }

    if (!lowerBound || !upperBound) {
      this.lastTransitionPointInfo = undefined;
      return undefined;
    }

    this.lastTransitionPointInfo = {
      curveIndex: i,
      // we need to subtract lowerBound.transitionTime. When we start the loop above
      // with a saved transition point, we will always add lowerBound.transitionTime as first step.
      // Otherwise our calculations are simply wrong.
      lowerBoundTimeOffset: lowerBoundTimeOffset - lowerBound.transitionTime,
    };

    return {
      lowerBoundTimeOffset: lowerBoundTimeOffset,
      transitionOffset: offset - lowerBoundTimeOffset,
      lowerBound: lowerBound,
      upperBound: upperBound,
    };
  }

  private scheduleNextUpdate(dryRun = false): void {
    if (!this.activeTransition) {
      throw new Error("tried scheduling transition when no transition was active!");
    }

    if (!dryRun) {
      this.updateTimeout = undefined;
    }

    if (!this.didRunFirstInitializationStep) {
      this.didRunFirstInitializationStep = true;
      this.handleAdaptiveLightingEnabled();
    }

    const transitionPoint = this.getCurrentAdaptiveLightingTransitionPoint();
    if (!transitionPoint) {
      debug("[%s] Reached end of transition curve!", this.lightbulb.displayName);
      if (!dryRun) {
        // the transition schedule is only for 24 hours, we reached the end?
        this.disableAdaptiveLighting();
      }
      return;
    }

    const lowerBound = transitionPoint.lowerBound;
    const upperBound = transitionPoint.upperBound;

    let interpolatedTemperature: number;
    let interpolatedAdjustmentFactor: number;
    if (lowerBound.duration && transitionPoint.transitionOffset  <= lowerBound.duration) {
      interpolatedTemperature = lowerBound.temperature;
      interpolatedAdjustmentFactor = lowerBound.brightnessAdjustmentFactor;
    } else {
      const timePercentage = (transitionPoint.transitionOffset - (lowerBound.duration ?? 0)) / upperBound.transitionTime;
      interpolatedTemperature = lowerBound.temperature + (upperBound.temperature - lowerBound.temperature) * timePercentage;
      interpolatedAdjustmentFactor = lowerBound.brightnessAdjustmentFactor
        + (upperBound.brightnessAdjustmentFactor - lowerBound.brightnessAdjustmentFactor) * timePercentage;
    }

    const adjustmentMultiplier = Math.max(
      this.activeTransition.brightnessAdjustmentRange.minBrightnessValue,
      Math.min(
        this.activeTransition.brightnessAdjustmentRange.maxBrightnessValue,
        this.brightnessCharacteristic?.value as number, // get handler is not called for optimal performance
      ),
    );

    let temperature = Math.round(interpolatedTemperature + interpolatedAdjustmentFactor * adjustmentMultiplier);

    // apply any manually applied temperature adjustments
    temperature += this.customTemperatureAdjustment;

    const min = this.colorTemperatureCharacteristic?.props.minValue ?? 140;
    const max = this.colorTemperatureCharacteristic?.props.maxValue ?? 500;
    temperature = Math.max(min, Math.min(max, temperature));
    const color = ColorUtils.colorTemperatureToHueAndSaturation(temperature);

    debug("[%s] Next temperature value is %d (for brightness %d adj: %s)",
      this.lightbulb.displayName, temperature, adjustmentMultiplier, this.customTemperatureAdjustment);

    const context: AdaptiveLightingCharacteristicContext = {
      controller: this,
      omitEventUpdate: true,
    };

    /*
     * We set saturation and hue values BEFORE we call the ColorTemperature SET handler (via setValue).
     * First thought was so the API user could get the values in the SET handler of the color temperature characteristic.
     * Do this is probably not really elegant cause this would only work when Adaptive Lighting is turned on
     * an the accessory MUST in any case update the Hue/Saturation values on a ColorTemperature write
     * (obviously only if Hue/Saturation characteristics are added to the service).
     *
     * The clever thing about this though is that, that it prevents notifications from being sent for Hue and Saturation
     * outside the specified notifyIntervalThreshold (see below where notifications are manually sent).
     * As the dev will or must call something like updateValue to propagate the updated hue and saturation values
     * to all HomeKit clients (so that the color is reflected in the UI), HAP-NodeJS won't send notifications
     * as the values are the same.
     * This of course only works if the plugin uses the exact same algorithm of "converting" the color temperature
     * value to the hue and saturation representation.
     */
    if (this.saturationCharacteristic) {
      this.saturationCharacteristic.value = color.saturation;
    }
    if (this.hueCharacteristic) {
      this.hueCharacteristic.value = color.hue;
    }

    this.colorTemperatureCharacteristic?.handleSetRequest(temperature, undefined, context).catch(reason => { // reason is HAPStatus code
      debug("[%s] Failed to next adaptive lighting transition point: %d", this.lightbulb.displayName, reason);
    });

    if (!this.activeTransition) {
      console.warn("[" + this.lightbulb.displayName + "] Adaptive Lighting was probably disable my mistake by some call in " +
        "the SET handler of the ColorTemperature characteristic! " +
        "Please check that you don't call setValue/setCharacteristic on the Hue, Saturation or ColorTemperature characteristic!");
      return;
    }

    const now = Date.now();
    if (!dryRun && now - this.lastEventNotificationSent >= this.activeTransition.notifyIntervalThreshold) {
      debug("[%s] Sending event notifications for current transition!", this.lightbulb.displayName);
      this.lastEventNotificationSent = now;

      const eventContext: AdaptiveLightingCharacteristicContext = {
        controller: this,
      };

      if (this.lastNotifiedTemperatureValue !== temperature) {
        this.colorTemperatureCharacteristic?.sendEventNotification(temperature, eventContext);
        this.lastNotifiedTemperatureValue = temperature;
      }
      if (this.saturationCharacteristic && this.lastNotifiedSaturationValue !== color.saturation) {
        this.saturationCharacteristic.sendEventNotification(color.saturation, eventContext);
        this.lastNotifiedSaturationValue = color.saturation;
      }
      if (this.hueCharacteristic && this.lastNotifiedHueValue !== color.hue) {
        this.hueCharacteristic.sendEventNotification(color.hue, eventContext);
        this.lastNotifiedHueValue = color.hue;
      }
    }

    if (!dryRun) {
      this.updateTimeout = setTimeout(this.scheduleNextUpdate.bind(this), this.activeTransition.updateInterval);
    }
  }

  /**
   * @private
   */
  constructServices(): ControllerServiceMap {
    return {};
  }

  /**
   * @private
   */
  // eslint-disable-next-line @typescript-eslint/no-unused-vars
  initWithServices(serviceMap: ControllerServiceMap): void | ControllerServiceMap {
    // do nothing
  }

  /**
   * @private
   */
  configureServices(): void {
    this.supportedTransitionConfiguration = this.lightbulb.getCharacteristic(Characteristic.SupportedCharacteristicValueTransitionConfiguration);
    this.transitionControl = this.lightbulb.getCharacteristic(Characteristic.CharacteristicValueTransitionControl)
      .updateValue("");
    this.activeTransitionCount = this.lightbulb.getCharacteristic(Characteristic.CharacteristicValueActiveTransitionCount)
      .updateValue(0);

    this.supportedTransitionConfiguration
      .onGet(this.handleSupportedTransitionConfigurationRead.bind(this));
    this.transitionControl
      .onGet(() => {
        return this.buildTransitionControlResponseBuffer().toString("base64");
      })
      .onSet(value => {
        try {
          return this.handleTransitionControlWrite(value);
        } catch (error) {
          console.warn(`[%s] DEBUG: '${value}'`);
          console.warn("[%s] Encountered error on CharacteristicValueTransitionControl characteristic: " + error.stack);
          this.disableAdaptiveLighting();
          throw new HapStatusError(HAPStatus.SERVICE_COMMUNICATION_FAILURE);
        }
      });
  }

  /**
   * @private
   */
  handleControllerRemoved(): void {
    this.lightbulb.removeCharacteristic(this.supportedTransitionConfiguration!);
    this.lightbulb.removeCharacteristic(this.transitionControl!);
    this.lightbulb.removeCharacteristic(this.activeTransitionCount!);

    this.supportedTransitionConfiguration = undefined;
    this.transitionControl = undefined;
    this.activeTransitionCount = undefined;

    this.removeAllListeners();
  }

  /**
   * @private
   */
  handleFactoryReset(): void {
    this.handleAdaptiveLightingDisabled();
  }

  /**
   * @private
   */
  serialize(): SerializedAdaptiveLightingControllerState | undefined {
    if (!this.activeTransition) {
      return undefined;
    }

    return {
      activeTransition: this.activeTransition,
    };
  }

  /**
   * @private
   */
  deserialize(serialized: SerializedAdaptiveLightingControllerState): void {
    this.activeTransition = serialized.activeTransition;

    // Data migrations from beta builds
    if (!this.activeTransition.transitionId) {
      // @ts-expect-error: data migration from beta builds
      this.activeTransition.transitionId = this.activeTransition.id1;
      // @ts-expect-error: data migration from beta builds
      delete this.activeTransition.id1;
    }

    if (!this.activeTransition.timeMillisOffset) { // compatibility to data produced by early betas
      this.activeTransition.timeMillisOffset = 0;
    }

    this.handleActiveTransitionUpdated(true);
  }

  /**
   * @private
   */
  setupStateChangeDelegate(delegate?: StateChangeDelegate): void {
    this.stateChangeDelegate = delegate;
  }

  private handleSupportedTransitionConfigurationRead(): string {
    const brightnessIID = this.lightbulb?.getCharacteristic(Characteristic.Brightness).iid;
    const temperatureIID = this.lightbulb?.getCharacteristic(Characteristic.ColorTemperature).iid;
    assert(brightnessIID, "iid for brightness characteristic is undefined");
    assert(temperatureIID, "iid for temperature characteristic is undefined");

    return tlv.encode(SupportedCharacteristicValueTransitionConfigurationsTypes.SUPPORTED_TRANSITION_CONFIGURATION, [
      tlv.encode(
        SupportedValueTransitionConfigurationTypes.CHARACTERISTIC_IID, tlv.writeVariableUIntLE(brightnessIID!),
        SupportedValueTransitionConfigurationTypes.TRANSITION_TYPE, TransitionType.BRIGHTNESS,
      ),
      tlv.encode(
        SupportedValueTransitionConfigurationTypes.CHARACTERISTIC_IID, tlv.writeVariableUIntLE(temperatureIID!),
        SupportedValueTransitionConfigurationTypes.TRANSITION_TYPE, TransitionType.COLOR_TEMPERATURE,
      ),
    ]).toString("base64");
  }

  private buildTransitionControlResponseBuffer(time?: number): Buffer {
    if (!this.activeTransition) {
      return Buffer.alloc(0);
    }

    const active = this.activeTransition;

    const timeSinceStart = time ?? (Date.now() - active.timeMillisOffset - active.transitionStartMillis);
    const timeSinceStartBuffer = tlv.writeVariableUIntLE(timeSinceStart);

    let parameters = tlv.encode(
      ValueTransitionParametersTypes.TRANSITION_ID, uuid.write(active.transitionId),
      ValueTransitionParametersTypes.START_TIME, Buffer.from(active.transitionStartBuffer, "hex"),
    );
    if (active.id3) {
      parameters = Buffer.concat([
        parameters,
        tlv.encode(ValueTransitionParametersTypes.UNKNOWN_3, Buffer.from(active.id3, "hex")),
      ]);
    }

    const status = tlv.encode(
      ValueTransitionConfigurationStatusTypes.CHARACTERISTIC_IID, tlv.writeVariableUIntLE(active.iid!),
      ValueTransitionConfigurationStatusTypes.TRANSITION_PARAMETERS, parameters,
      ValueTransitionConfigurationStatusTypes.TIME_SINCE_START, timeSinceStartBuffer,
    );

    return tlv.encode(
      ValueTransitionConfigurationResponseTypes.VALUE_CONFIGURATION_STATUS, status,
    );
  }

  private handleTransitionControlWrite(value: CharacteristicValue): string {
    if (typeof value !== "string") {
      throw new HapStatusError(HAPStatus.INVALID_VALUE_IN_REQUEST);
    }

    const tlvData = tlv.decode(Buffer.from(value, "base64"));
    const responseBuffers: Buffer[] = [];

    const readTransition = tlvData[TransitionControlTypes.READ_CURRENT_VALUE_TRANSITION_CONFIGURATION];
    if (readTransition) {
      const readTransitionResponse = this.handleTransitionControlReadTransition(readTransition);
      if (readTransitionResponse) {
        responseBuffers.push(readTransitionResponse);
      }
    }
    const updateTransition = tlvData[TransitionControlTypes.UPDATE_VALUE_TRANSITION_CONFIGURATION];
    if (updateTransition) {
      const updateTransitionResponse = this.handleTransitionControlUpdateTransition(updateTransition);
      if (updateTransitionResponse) {
        responseBuffers.push(updateTransitionResponse);
      }
    }

    return Buffer.concat(responseBuffers).toString("base64");
  }

  private handleTransitionControlReadTransition(buffer: Buffer): Buffer | undefined {
    const readTransition = tlv.decode(buffer);

    const iid = tlv.readVariableUIntLE(readTransition[ReadValueTransitionConfiguration.CHARACTERISTIC_IID]);

    if (this.activeTransition) {
      if (this.activeTransition.iid !== iid) {
        console.warn("[" + this.lightbulb.displayName + "] iid of current adaptive lighting transition (" + this.activeTransition.iid
          + ") doesn't match the requested one " + iid);
        throw new HapStatusError(HAPStatus.INVALID_VALUE_IN_REQUEST);
      }

      let parameters = tlv.encode(
        ValueTransitionParametersTypes.TRANSITION_ID, uuid.write(this.activeTransition.transitionId),
        ValueTransitionParametersTypes.START_TIME, Buffer.from(this.activeTransition.transitionStartBuffer, "hex"),
      );
      if (this.activeTransition.id3) {
        parameters = Buffer.concat([
          parameters,
          tlv.encode(ValueTransitionParametersTypes.UNKNOWN_3, Buffer.from(this.activeTransition.id3, "hex")),
        ]);
      }

      return tlv.encode(
        TransitionControlTypes.READ_CURRENT_VALUE_TRANSITION_CONFIGURATION, tlv.encode(
          ValueTransitionConfigurationTypes.CHARACTERISTIC_IID, tlv.writeVariableUIntLE(this.activeTransition.iid),
          ValueTransitionConfigurationTypes.TRANSITION_PARAMETERS, parameters,
          ValueTransitionConfigurationTypes.UNKNOWN_3, 1,
          ValueTransitionConfigurationTypes.TRANSITION_CURVE_CONFIGURATION, tlv.encode(
            TransitionCurveConfigurationTypes.TRANSITION_ENTRY, this.activeTransition.transitionCurve.map((entry, index, array) => {
              const duration = array[index - 1]?.duration ?? 0; // we store stuff differently :sweat_smile:

              return tlv.encode(
                TransitionEntryTypes.ADJUSTMENT_FACTOR, tlv.writeFloat32LE(entry.brightnessAdjustmentFactor),
                TransitionEntryTypes.VALUE, tlv.writeFloat32LE(entry.temperature),
                TransitionEntryTypes.TRANSITION_OFFSET, tlv.writeVariableUIntLE(entry.transitionTime),
                TransitionEntryTypes.DURATION, tlv.writeVariableUIntLE(duration),
              );
            }),
            TransitionCurveConfigurationTypes.ADJUSTMENT_CHARACTERISTIC_IID, tlv.writeVariableUIntLE(this.activeTransition.brightnessCharacteristicIID),
            TransitionCurveConfigurationTypes.ADJUSTMENT_MULTIPLIER_RANGE, tlv.encode(
              // eslint-disable-next-line max-len
              TransitionAdjustmentMultiplierRange.MINIMUM_ADJUSTMENT_MULTIPLIER, tlv.writeUInt32(this.activeTransition.brightnessAdjustmentRange.minBrightnessValue),
              // eslint-disable-next-line max-len
              TransitionAdjustmentMultiplierRange.MAXIMUM_ADJUSTMENT_MULTIPLIER, tlv.writeUInt32(this.activeTransition.brightnessAdjustmentRange.maxBrightnessValue),
            ),
          ),
          ValueTransitionConfigurationTypes.UPDATE_INTERVAL, tlv.writeVariableUIntLE(this.activeTransition.updateInterval),
          ValueTransitionConfigurationTypes.NOTIFY_INTERVAL_THRESHOLD, tlv.writeVariableUIntLE(this.activeTransition.notifyIntervalThreshold),
        ),
      );
    } else {
      return undefined; // returns empty string
    }
  }

  private handleTransitionControlUpdateTransition(buffer: Buffer): Buffer {
    const updateTransition = tlv.decode(buffer);
    const transitionConfiguration = tlv.decode(updateTransition[UpdateValueTransitionConfigurationsTypes.VALUE_TRANSITION_CONFIGURATION]);

    const iid = tlv.readVariableUIntLE(transitionConfiguration[ValueTransitionConfigurationTypes.CHARACTERISTIC_IID]);
    if (!this.lightbulb.getCharacteristicByIID(iid)) {
      throw new HapStatusError(HAPStatus.INVALID_VALUE_IN_REQUEST);
    }

    const param3 = transitionConfiguration[ValueTransitionConfigurationTypes.UNKNOWN_3]?.readUInt8(0); // when present it is always 1
    if (!param3) { // if HomeKit just sends the iid, we consider that as "disable adaptive lighting" (assumption)
      this.handleAdaptiveLightingDisabled();
      return tlv.encode(TransitionControlTypes.UPDATE_VALUE_TRANSITION_CONFIGURATION, Buffer.alloc(0));
    }

    const parametersTLV = tlv.decode(transitionConfiguration[ValueTransitionConfigurationTypes.TRANSITION_PARAMETERS]);
    const curveConfiguration = tlv.decodeWithLists(transitionConfiguration[ValueTransitionConfigurationTypes.TRANSITION_CURVE_CONFIGURATION]);
    const updateInterval = transitionConfiguration[ValueTransitionConfigurationTypes.UPDATE_INTERVAL]?.readUInt16LE(0);
    const notifyIntervalThreshold = transitionConfiguration[ValueTransitionConfigurationTypes.NOTIFY_INTERVAL_THRESHOLD].readUInt32LE(0);

    const transitionId = parametersTLV[ValueTransitionParametersTypes.TRANSITION_ID];
    const startTime = parametersTLV[ValueTransitionParametersTypes.START_TIME];
    const id3 = parametersTLV[ValueTransitionParametersTypes.UNKNOWN_3]; // this may be undefined

    const startTimeMillis = epochMillisFromMillisSince2001_01_01Buffer(startTime);
    const timeMillisOffset = Date.now() - startTimeMillis;

    const transitionCurve: AdaptiveLightingTransitionCurveEntry[] = [];
    let previous: AdaptiveLightingTransitionCurveEntry | undefined = undefined;

    const transitions = curveConfiguration[TransitionCurveConfigurationTypes.TRANSITION_ENTRY] as Buffer[];
    for (const entry of transitions) {
      const tlvEntry = tlv.decode(entry);

      const adjustmentFactor = tlvEntry[TransitionEntryTypes.ADJUSTMENT_FACTOR].readFloatLE(0);
      const value = tlvEntry[TransitionEntryTypes.VALUE].readFloatLE(0);

      const transitionOffset = tlv.readVariableUIntLE(tlvEntry[TransitionEntryTypes.TRANSITION_OFFSET]);

      const duration = tlvEntry[TransitionEntryTypes.DURATION]? tlv.readVariableUIntLE(tlvEntry[TransitionEntryTypes.DURATION]): undefined;

      if (previous) {
        previous.duration = duration;
      }

      previous = {
        temperature: value,
        brightnessAdjustmentFactor: adjustmentFactor,
        transitionTime: transitionOffset,
      };
      transitionCurve.push(previous);
    }

    const adjustmentIID = tlv.readVariableUIntLE((curveConfiguration[TransitionCurveConfigurationTypes.ADJUSTMENT_CHARACTERISTIC_IID] as Buffer));
    const adjustmentMultiplierRange = tlv.decode(curveConfiguration[TransitionCurveConfigurationTypes.ADJUSTMENT_MULTIPLIER_RANGE] as Buffer);
    const minAdjustmentMultiplier = adjustmentMultiplierRange[TransitionAdjustmentMultiplierRange.MINIMUM_ADJUSTMENT_MULTIPLIER].readUInt32LE(0);
    const maxAdjustmentMultiplier = adjustmentMultiplierRange[TransitionAdjustmentMultiplierRange.MAXIMUM_ADJUSTMENT_MULTIPLIER].readUInt32LE(0);

    this.activeTransition = {
      iid: iid,

      transitionStartMillis: startTimeMillis,
      timeMillisOffset: timeMillisOffset,

      transitionId: uuid.unparse(transitionId),
      transitionStartBuffer: startTime.toString("hex"),
      id3: id3?.toString("hex"),

      brightnessCharacteristicIID: adjustmentIID,
      brightnessAdjustmentRange: {
        minBrightnessValue: minAdjustmentMultiplier,
        maxBrightnessValue: maxAdjustmentMultiplier,
      },

      transitionCurve: transitionCurve,

      updateInterval: updateInterval ?? 60000,
      notifyIntervalThreshold: notifyIntervalThreshold,
    };

    if (this.updateTimeout) {
      clearTimeout(this.updateTimeout);
      this.updateTimeout = undefined;
      debug("[%s] Adaptive lighting was renewed.", this.lightbulb.displayName);
    } else {
      debug("[%s] Adaptive lighting was enabled.", this.lightbulb.displayName);
    }

    this.handleActiveTransitionUpdated();

    return tlv.encode(
      TransitionControlTypes.UPDATE_VALUE_TRANSITION_CONFIGURATION, this.buildTransitionControlResponseBuffer(0),
    );
  }

}

homebridge / HAP-NodeJS / 9647691811

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous