Class Device

Hierarchy

EventEmitter
- Device

Constructors

constructor

new Device(data: GoveeDeviceData, options: DeviceOpts): Device
Parameters
- data: GoveeDeviceData
- options: DeviceOpts
Returns Device
Overrides EventEmitter.constructor
- Defined in src/device.ts:78

Properties

`Readonly` id

id: string

`Readonly` model

model: string

`Readonly` name

name: string

`Readonly` supported

supported: boolean

`Readonly` versions

versions: {
    ble: {
        hard: string;
        soft: string;
    };
    wifi: {
        hard: string;
        soft: string;
    };
}

Type declaration

ble: {
hard: string;
soft: string;
}
- hard: string
- soft: string
wifi: {
hard: string;
soft: string;
}
- hard: string
- soft: string

Accessors

brightness

get brightness(): number
Returns number
- Defined in src/device.ts:129

color

get color(): {
    b: number;
    g: number;
    r: number;
}
Returns {
    b: number;
    g: number;
    r: number;
}
- b: number
- g: number
- r: number
- Defined in src/device.ts:133

colorObj

get colorObj(): Colord
Returns Colord
- Defined in src/device.ts:141

colorTemperature

get colorTemperature(): number
Returns number
- Defined in src/device.ts:145

ipAddr

get ipAddr(): string
Returns string
- Defined in src/device.ts:121

isOn

get isOn(): boolean
Returns boolean
- Defined in src/device.ts:125

Methods

addListener

addListener<E>(event: E, listener: GoveeDeviceEvents[E]): Device
Type Parameters
- E extends keyof GoveeDeviceEvents
Parameters
- event: E
- listener: GoveeDeviceEvents[E]
Returns Device
Inherited from EventEmitter.addListener
- Defined in src/device.ts:449

autoUpdate

autoUpdate(on?: boolean): void
Switch auto update of the state on/off
Parameters
- on: boolean = true
  
  Whether to turn on or off the auto update
Returns void
- Defined in src/device.ts:237

destroy

destroy(): void
Destroy the device. This will stop the update interval and remove all listeners

Returns void
- Defined in src/device.ts:152

emit

emit<E>(event: E, ...args: Parameters<GoveeDeviceEvents[E]>): boolean
Type Parameters
- E extends keyof GoveeDeviceEvents
Parameters
- event: E
- Rest ...args: Parameters<GoveeDeviceEvents[E]>
Returns boolean
Inherited from EventEmitter.emit
- Defined in src/device.ts:478

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Inherited from EventEmitter.eventNames
- Defined in src/device.ts:482

fadeToColor

fadeToColor(inputColor: ColorInput, steps: number, duration: number, fromColor?: null | ColorInput): Promise<void>
Fade the device to a color

Returns
Promise that resolves when the fade is complete

Throws
Error if the input color is invalid

Throws
Error if the from color is invalid
Parameters
- inputColor: ColorInput
  
  Colord | color input
- steps: number
  
  Number of steps to fade (min 3, max 100000000)
- duration: number
  
  Duration of fade in milliseconds (min 100, max 100000000)
- fromColor: null | ColorInput = null
  
  Colord | color input (optional)
Returns Promise<void>
- Defined in src/device.ts:416

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from EventEmitter.getMaxListeners
- Defined in src/device.ts:490

getState

getState(): DeviceState & DeviceStateInfo
Get the current state of the device. This is not guaranteed to be up to date. Use waitForFirstUpdate to make sure the state is up to date before using this. It also includes some extra information about the last update and last state change.

Returns
The current state of the device

Returns DeviceState & DeviceStateInfo
- Defined in src/device.ts:264

listenerCount

listenerCount<E>(event: E): number
Type Parameters
- E extends keyof GoveeDeviceEvents
Parameters
- event: E
Returns number
Inherited from EventEmitter.listenerCount
- Defined in src/device.ts:489

listeners

listeners<E>(event: E): GoveeDeviceEvents[E][]
Type Parameters
- E extends keyof GoveeDeviceEvents
Parameters
- event: E
Returns GoveeDeviceEvents[E][]
Inherited from EventEmitter.listeners
- Defined in src/device.ts:486

off

off<E>(event: E, listener: GoveeDeviceEvents[E]): Device
Type Parameters
- E extends keyof GoveeDeviceEvents
Parameters
- event: E
- listener: GoveeDeviceEvents[E]
Returns Device
Inherited from EventEmitter.off
- Defined in src/device.ts:469

on

on<E>(event: E, listener: GoveeDeviceEvents[E]): Device
Type Parameters
- E extends keyof GoveeDeviceEvents
Parameters
- event: E
- listener: GoveeDeviceEvents[E]
Returns Device
Inherited from EventEmitter.on
- Defined in src/device.ts:453

once

once<E>(event: E, listener: GoveeDeviceEvents[E]): Device
Type Parameters
- E extends keyof GoveeDeviceEvents
Parameters
- event: E
- listener: GoveeDeviceEvents[E]
Returns Device
Inherited from EventEmitter.once
- Defined in src/device.ts:457

prependListener

prependListener<E>(event: E, listener: GoveeDeviceEvents[E]): Device
Type Parameters
- E extends keyof GoveeDeviceEvents
Parameters
- event: E
- listener: GoveeDeviceEvents[E]
Returns Device
Inherited from EventEmitter.prependListener
- Defined in src/device.ts:461

prependOnceListener

prependOnceListener<E>(event: E, listener: GoveeDeviceEvents[E]): Device
Type Parameters
- E extends keyof GoveeDeviceEvents
Parameters
- event: E
- listener: GoveeDeviceEvents[E]
Returns Device
Inherited from EventEmitter.prependOnceListener
- Defined in src/device.ts:465

rawListeners

rawListeners<E>(event: E): GoveeDeviceEvents[E][]
Type Parameters
- E extends keyof GoveeDeviceEvents
Parameters
- event: E
Returns GoveeDeviceEvents[E][]
Inherited from EventEmitter.rawListeners
- Defined in src/device.ts:483

removeAllListeners

removeAllListeners<E>(event?: E): Device
Type Parameters
- E extends keyof GoveeDeviceEvents
Parameters
- Optional event: E
Returns Device
Inherited from EventEmitter.removeAllListeners
- Defined in src/device.ts:473

removeListener

removeListener<E>(event: E, listener: GoveeDeviceEvents[E]): Device
Type Parameters
- E extends keyof GoveeDeviceEvents
Parameters
- event: E
- listener: GoveeDeviceEvents[E]
Returns Device
Inherited from EventEmitter.removeListener
- Defined in src/device.ts:474

setBrightness

setBrightness(brightness: number): Promise<void>
Set the brightness of the device
Parameters
- brightness: number
  
  0-100
Returns Promise<void>
- Defined in src/device.ts:332

setColor

setColor(input: ColorInput, brightness?: null | number): Promise<void>
Set the color of the device, using Colord
Parameters
- input: ColorInput
  
  Colord | color input
- brightness: null | number = null
  
  0-100 (optional)
Returns Promise<void>
- Defined in src/device.ts:382

setColorKelvin

setColorKelvin(colorTemp: number, safe?: boolean): Promise<void>
Set the color temperature of the device
Parameters
- colorTemp: number
  
  2000-9000
- safe: boolean = true
  
  If true, the color temperature will be clamped to the range 2000-9000 (default true)
Returns Promise<void>
- Defined in src/device.ts:345

setColorRGB

setColorRGB(color: {
    b: number;
    g: number;
    r: number;
}): Promise<void>
Set the color of the device
Parameters
- color: {
      b: number;
      g: number;
      r: number;
  }
  
  { r: 0-255, g: 0-255, b: 0-255 }
  - b: number
  - g: number
  - r: number
Returns Promise<void>
- Defined in src/device.ts:360

setMaxListeners

setMaxListeners(maxListeners: number): Device
Parameters
- maxListeners: number
Returns Device
Inherited from EventEmitter.setMaxListeners
- Defined in src/device.ts:491

sync

sync(): Promise<void>
Wait for an update to be received to make sure the device state is in sync with the device

Returns
Promise that resolves when an update is received

Returns Promise<void>
- Defined in src/device.ts:295

triggerUpdate

triggerUpdate(): void
Trigger the Govee API to update the device state

Returns void
- Defined in src/device.ts:254

turnOff

turnOff(): Promise<void>
Turn off the device

Returns Promise<void>
- Defined in src/device.ts:321

turnOn

turnOn(): Promise<void>
Turn on the device

Returns Promise<void>
- Defined in src/device.ts:312

updateDevice

updateDevice(data: GoveeDeviceData): void
This is called when the device sends an update. Should not be called by the user. It checks if the ip has changed and emits an event if it has
Parameters
- data: GoveeDeviceData
  
  Device data
Returns void
- Defined in src/device.ts:162

updateState

updateState(data: GoveeDeviceStatusData): void
This is called when the device sends a status update. Should not be called by the user
Parameters
- data: GoveeDeviceStatusData
  
  Device status data
Returns void
- Defined in src/device.ts:174

waitForFirstUpdate

waitForFirstUpdate(): Promise<void>
Wait for the first state update to be received to make sure the device state is in sync with the device

Returns
Promise that resolves when the first state update is received

Returns Promise<void>
- Defined in src/device.ts:280

Class Device

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

data: GoveeDeviceData

options: DeviceOpts

Returns Device

Properties

Readonly id

Readonly model

Readonly name

Readonly supported

Readonly versions

Type declaration

ble: { hard: string; soft: string; }

hard: string

soft: string

wifi: { hard: string; soft: string; }

hard: string

soft: string

Accessors

brightness

Returns number

color

Returns { b: number; g: number; r: number; }

b: number

g: number

r: number

colorObj

Returns Colord

colorTemperature

Returns number

ipAddr

Returns string

isOn

Returns boolean

Methods

addListener

Type Parameters

E extends keyof GoveeDeviceEvents

Parameters

event: E

listener: GoveeDeviceEvents[E]

Returns Device

autoUpdate

Parameters

on: boolean = true

Returns void

destroy

Returns void

emit

Type Parameters

E extends keyof GoveeDeviceEvents

Parameters

event: E

Rest ...args: Parameters<GoveeDeviceEvents[E]>

Returns boolean

eventNames

Returns (string | symbol)[]

fadeToColor

Returns

Throws

Throws

Parameters

inputColor: ColorInput

steps: number

duration: number

fromColor: null | ColorInput = null

Returns Promise<void>

getMaxListeners

Returns number

getState

Returns

Returns DeviceState & DeviceStateInfo

`Readonly` id

`Readonly` model

`Readonly` name

`Readonly` supported

`Readonly` versions

ble: {
hard: string;
soft: string;
}

wifi: {
hard: string;
soft: string;
}

Returns {
b: number;
g: number;
r: number;
}

`Rest` ...args: Parameters<GoveeDeviceEvents[E]>

`Optional` event: E