Class Lights

Hierarchy

BaseSystem<Light>
- Lights

Index

Constructors

Properties

Methods

getCompleteStatus getItemById getItems getStatusById getTrendByItemId getTrendStatus getTrends getTrendsStatuses parseItemTrend setColor setDimLevel setState setTunableWhiteLevel

Constructors

constructor

new Lights(client): Lights
Parameters
- client: LocalClient | RemoteClient
Returns Lights
Overrides BaseSystem<Light>.constructor
- Defined in src/systems/lights/index.ts:12

Properties

`Protected` `Readonly` client

client: LocalClient | RemoteClient

The client instance

`Protected` `Readonly` parseItem

parseItem: ((config, status, itemId) => Light)

Type declaration

- (config, status, itemId): Light
- Parameters
  - config: SystemConfig
  - status: ItemStatusResponse
  - itemId: string
  Returns Light

`Protected` `Readonly` systemType

systemType: SystemType

Methods

`Protected` getCompleteStatus

getCompleteStatus(systemType): Promise<SystemStatusResponse>
Return the complete status by system.
Parameters
- systemType: SystemType
  
  The system type.
Returns Promise<SystemStatusResponse>

Throws
ClientError
Inherited from BaseSystem.getCompleteStatus
- Defined in src/systems/base/index.ts:144

getItemById

getItemById(itemId): Promise<Light>
Returns a single item by id.
Parameters
- itemId: string
  
  The item id.
Returns Promise<Light>
Inherited from BaseSystem.getItemById
- Defined in src/systems/base/index.ts:210

getItems

getItems(): Promise<Light[]>
Returns all items.

Returns Promise<Light[]>

Throws
ClientError
Inherited from BaseSystem.getItems
- Defined in src/systems/base/index.ts:199

`Protected` getStatusById

getStatusById(systemType, itemId): Promise<ItemStatusResponse>
Return the status by system and item id.
Parameters
- systemType: SystemType
  
  The system type.
- itemId: string
  
  The item id.
Returns Promise<ItemStatusResponse>

Throws
ClientError
Inherited from BaseSystem.getStatusById
- Defined in src/systems/base/index.ts:156

getTrendByItemId

getTrendByItemId(itemId, startDate, endDate, count): Promise<Trend>
Returns a single trend by item id.
Parameters
- itemId: string
  
  The item id.
- startDate: string
  
  The start date as date string.
- endDate: string
  
  The start date as date string.
- count: number
  
  The data count.
Returns Promise<Trend>

Throws
ClientError
Inherited from BaseSystem.getTrendByItemId
- Defined in src/systems/base/index.ts:234

`Protected` getTrendStatus

getTrendStatus(systemType, itemId, startDate, endDate, count): Promise<Trend>
Return a parsed trend item.
Parameters
- systemType: SystemType
  
  The system type.
- itemId: string
  
  The item id.
- startDate: string
  
  The start date as date string.
- endDate: string
  
  The start date as date string.
- count: number
  
  The data count.
Returns Promise<Trend>

Throws
ClientError
Inherited from BaseSystem.getTrendStatus
- Defined in src/systems/base/index.ts:175

getTrends

getTrends(startDate, endDate, count): Promise<Trend[]>
Returns all trends.
Parameters
- startDate: string
  
  The start date as date string.
- endDate: string
  
  The start date as date string.
- count: number
  
  The data count.
Returns Promise<Trend[]>

Throws
ClientError
Inherited from BaseSystem.getTrends
- Defined in src/systems/base/index.ts:222

`Protected` getTrendsStatuses

getTrendsStatuses(systemType, startDate, endDate, count): Promise<Trend[]>
Return parsed trends.
Parameters
- systemType: SystemType
  
  The system type.
- startDate: string
  
  The start date as date string.
- endDate: string
  
  The start date as date string.
- count: number
  
  The data count.
Returns Promise<Trend[]>

Throws
ClientError
Inherited from BaseSystem.getTrendsStatuses
- Defined in src/systems/base/index.ts:84

`Protected` parseItemTrend

parseItemTrend(systemType, item, itemId, startDate, endDate, count): Promise<Trend>
Return a parsed trend.
Parameters
- systemType: SystemType
  
  The system type.
- item: string
  
  The item.
- itemId: string
  
  The item id.
- startDate: string
  
  The start date as date string.
- endDate: string
  
  The start date as date string.
- count: number
  
  The data count.
Returns Promise<Trend>

Throws
ClientError
Inherited from BaseSystem.parseItemTrend
- Defined in src/systems/base/index.ts:39

setColor

setColor(itemId, color): Promise<void>
Sets the color.
Parameters
- itemId: string
  
  The item id.
- color: number
  
  The new color.
Returns Promise<void>
- Defined in src/systems/lights/index.ts:69

setDimLevel

setDimLevel(itemId, dimLevel): Promise<void>
Sets the dim level.
Parameters
- itemId: string
  
  The item id.
- dimLevel: number
  
  The new dim level.
Returns Promise<void>
- Defined in src/systems/lights/index.ts:51

setState

setState(itemId, state): Promise<void>
Sets the state.
Parameters
- itemId: string
  
  The item id.
- state: LightState
  
  The new state.
Returns Promise<void>
- Defined in src/systems/lights/index.ts:42

setTunableWhiteLevel

setTunableWhiteLevel(itemId, tunableWhiteLevel): Promise<void>
Sets the tunable white level.
Parameters
- itemId: string
  
  The item id.
- tunableWhiteLevel: number
  
  The new tunable white level.
Returns Promise<void>
- Defined in src/systems/lights/index.ts:60

Class Lights

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: LocalClient | RemoteClient

Returns Lights

Properties

Protected Readonly client

Protected Readonly parseItem

Type declaration

Parameters

config: SystemConfig

status: ItemStatusResponse

itemId: string

Returns Light

Protected Readonly systemType

Methods

Protected getCompleteStatus

Parameters

systemType: SystemType

Returns Promise<SystemStatusResponse>

Throws

getItemById

Parameters

itemId: string

Returns Promise<Light>

getItems

Returns Promise<Light[]>

Throws

Protected getStatusById

Parameters

systemType: SystemType

itemId: string

Returns Promise<ItemStatusResponse>

Throws

getTrendByItemId

Parameters

itemId: string

startDate: string

endDate: string

count: number

Returns Promise<Trend>

Throws

Protected getTrendStatus

Parameters

systemType: SystemType

itemId: string

startDate: string

endDate: string

count: number

Returns Promise<Trend>

Throws

getTrends

Parameters

startDate: string

endDate: string

count: number

Returns Promise<Trend[]>

Throws

Protected getTrendsStatuses

Parameters

systemType: SystemType

startDate: string

endDate: string

count: number

Returns Promise<Trend[]>

Throws

Protected parseItemTrend

Parameters

systemType: SystemType

item: string

itemId: string

startDate: string

endDate: string

count: number

`Protected` `Readonly` client

`Protected` `Readonly` parseItem

`Protected` `Readonly` systemType

`Protected` getCompleteStatus

`Protected` getStatusById

`Protected` getTrendStatus

`Protected` getTrendsStatuses

`Protected` parseItemTrend