Class LightningChannel

This class is used to display the Lightning Channel on the Timebox Evo

Hierarchy

TimeboxEvoRequest
- LightningChannel

Index

Constructors

constructor

Properties

Accessors

Methods

Object literals

_opts

Constructors

constructor

new LightningChannel(opts?: LightningOpts): LightningChannel

- Defined in channels/lightning.ts:32
Generates the appropriate message to display the Lightning Channel on the Divoom Timebox Evo

Parameters
- Optional opts: LightningOpts
  
  the lightning options
Returns LightningChannel

Properties

Private _PACKAGE_PREFIX

_PACKAGE_PREFIX: string = "4501"

Private _PACKAGE_SUFFIX

_PACKAGE_SUFFIX: string = "000000"

Private _color

_color: string

Accessors

brightness

get brightness(): number
set brightness(brightness: number): void

- Defined in channels/lightning.ts:114
Gets the brightness

Returns number
- Defined in channels/lightning.ts:107
Sets the brighness (0-100)

Parameters
- brightness: number
Returns void

color

get color(): string | RGB | RGBA | HSL | HSLA | HSV | HSVA | TinyColor
set color(color: ColorInput): void

- Defined in channels/lightning.ts:88
Gets the color of the lightning

Returns string | RGB | RGBA | HSL | HSLA | HSV | HSVA | TinyColor
- Defined in channels/lightning.ts:78
Sets the color of the Lightning

Parameters
- color: ColorInput
Returns void

messages

get messages(): TimeboxEvoMessageArray

Inherited from TimeboxEvoRequest.messages
- Defined in requests.ts:30
Returns the message queue

Returns TimeboxEvoMessageArray

The message queue

power

get power(): boolean
set power(bool: boolean): void

- Defined in channels/lightning.ts:100
Gets the power

Returns boolean
- Defined in channels/lightning.ts:95
Sets the power on of off

Parameters
- bool: boolean
Returns void

type

get type(): LightningType
set type(type: LightningType): void

- Defined in channels/lightning.ts:71
Gets the type of Lightning

Returns LightningType
- Defined in channels/lightning.ts:64
Sets the type of Lightning you want to display

Parameters
- type: LightningType
Returns void

Methods

Private _updateMessage

_updateMessage(): void

- Defined in channels/lightning.ts:49
Updates the message queue based on the parameters used

Returns void

clear

clear(): void

Inherited from TimeboxEvoRequest.clear
- Defined in requests.ts:22
Clears the message queue

Returns void

push

push(msg: string): number

Inherited from TimeboxEvoRequest.push
- Defined in requests.ts:15
This queues a message in the message queue

Parameters
- msg: string
  
  the message to append in the message queue
Returns number

the length of the message queue

Object literals

Private _opts

_opts: object

brightness

brightness: number = 100

power

power: true = true

type

type: PlainColor = LightningType.PlainColor

Generated using TypeDoc