Class Dimmer

constructor

• new Dimmer(device, apiModuleName): Dimmer

• Parameters

  • device: Plug

  • apiModuleName: string

  Returns Dimmer

Readonly apiModuleName

Readonly device

brightness

• get brightness(): number

• Cached value of sysinfo.brightness.

  Returns number

getDefaultBehavior

• getDefaultBehavior(sendOptions?): Promise<unknown>

• Get Plug/Dimmer default behavior configuration.

  Requests dimmer.get_default_behavior. Does not support childId.

  Parameters

  • Optional sendOptions: SendOptions

  Returns Promise<unknown>

  parsed JSON response

  Throws

  ResponseError

getDimmerParameters

• getDimmerParameters(sendOptions?): Promise<unknown>

• Get Plug/Dimmer parameters configuration.

  Requests dimmer.get_dimmer_parameters. Does not support childId.

  Parameters

  • Optional sendOptions: SendOptions

  Returns Promise<unknown>

  parsed JSON response

  Throws

  ResponseError

setBrightness

• setBrightness(brightness, sendOptions?): Promise<unknown>

• Sets Plug to the specified brightness.

  Sends dimmer.set_brightness command. Does not support childId.

  Parameters

  • brightness: number

    0-100

  • Optional sendOptions: SendOptions

  Returns Promise<unknown>

  parsed JSON response

  Throws

  ResponseError

setDimmerTransition

• setDimmerTransition(dimmerTransition, sendOptions?): Promise<unknown>

• Transitions Plug to the specified brightness.

  Sends dimmer.set_dimmer_transition command. Does not support childId.

  Parameters

  • dimmerTransition: DimmerTransitionInput

  • Optional sendOptions: SendOptions

  Returns Promise<unknown>

  parsed JSON response

  Throws

  ResponseError

setDoubleClickAction

• setDoubleClickAction(__namedParameters, sendOptions?): Promise<unknown>

• Set Plug/Dimmer default_behavior configuration for double_click.

  Sends dimmer.set_double_click_action. Does not support childId.

  Parameters

  • __namedParameters: DimmerActionInput

  • Optional sendOptions: SendOptions

  Returns Promise<unknown>

  parsed JSON response

  Throws

  ResponseError

setFadeOffTime

• setFadeOffTime(fadeTime, sendOptions?): Promise<unknown>

• Set Plug dimmer_parameters for fadeOffTime.

  Sends dimmer.set_fade_off_time. Does not support childId.

  Parameters

  • fadeTime: number

    duration in ms

  • Optional sendOptions: SendOptions

  Returns Promise<unknown>

  parsed JSON response

  Throws

  ResponseError

setFadeOnTime

• setFadeOnTime(fadeTime, sendOptions?): Promise<unknown>

• Set Plug dimmer_parameters for fadeOnTime.

  Sends dimmer.set_fade_on_time. Does not support childId.

  Parameters

  • fadeTime: number

    duration in ms

  • Optional sendOptions: SendOptions

  Returns Promise<unknown>

  parsed JSON response

  Throws

  ResponseError

setGentleOffTime

• setGentleOffTime(duration, sendOptions?): Promise<unknown>

• Set Plug dimmer_parameters for gentleOffTime.

  Sends dimmer.set_gentle_off_time. Does not support childId.

  Parameters

  • duration: number

    duration in ms

  • Optional sendOptions: SendOptions

  Returns Promise<unknown>

  parsed JSON response

  Throws

  ResponseError

setGentleOnTime

• setGentleOnTime(duration, sendOptions?): Promise<unknown>

• Set Plug dimmer_parameters for gentleOnTime.

  Sends dimmer.set_gentle_on_time. Does not support childId.

  Parameters

  • duration: number

    duration in ms

  • Optional sendOptions: SendOptions

  Returns Promise<unknown>

  parsed JSON response

  Throws

  ResponseError

setLongPressAction

• setLongPressAction(options, sendOptions?): Promise<unknown>

• Set Plug/Dimmer default_behavior configuration for long_press.

  Sends dimmer.set_long_press_action. Does not support childId.

  Parameters

  • options: DimmerActionInput

  • Optional sendOptions: SendOptions

  Returns Promise<unknown>

  parsed JSON response

  Throws

  ResponseError

setSwitchState

• setSwitchState(state, sendOptions?): Promise<unknown>

• Sets Plug to the specified on/off state.

  Sends dimmer.set_switch_state command. Does not support childId.

  Parameters

  • state: boolean | 0 | 1

    true=on, false=off

  • Optional sendOptions: SendOptions

  Returns Promise<unknown>

  parsed JSON response

  Throws

  ResponseError