Skip to content

Exports

github-actions[bot] edited this page Aug 11, 2023 · 51 revisions

hue.ts

Table of contents

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

By

Ƭ By: string | ResourceIdentifier

Defined in

src/managers/Manager.ts:7


DeviceEditOptions

Ƭ DeviceEditOptions: ArcheTypeResourceEditOptions

Defined in

src/structures/Device.ts:5


Force

Ƭ Force<B, T>: B extends true ? NarrowResource<T> : NarrowResource<T> | undefined

Type parameters

Name Type
B extends boolean
T extends ResourceType

Defined in

src/managers/Manager.ts:9


NamedResourceCreateOptions

Ƭ NamedResourceCreateOptions: Required<NamedResourceEditOptions>

Defined in

src/structures/NamedResource.ts:10


NarrowResource

Ƭ NarrowResource<T>: Resources[T]

Type parameters

Name Type
T extends ResourceType = ResourceType

Defined in

src/structures/Resource.ts:48


ResourceConstructorSignature

Ƭ ResourceConstructorSignature<T>: (bridge: Hue, data: any) => NarrowResource<T>

Type parameters

Name Type
T extends ResourceType

Type declaration

• (bridge, data)

Parameters
Name Type
bridge Hue
data any

Defined in

src/managers/Manager.ts:13


ResourceTypeGet

Ƭ ResourceTypeGet<T>: ResourceTypesGet[T]

Type parameters

Name Type
T extends ResourceType

Defined in

src/api/ResourceType.ts:81


ResourceTypePost

Ƭ ResourceTypePost<T>: ResourceTypesPost[T]

Type parameters

Name Type
T extends ResourceType

Defined in

src/api/ResourceType.ts:141


ResourceTypePut

Ƭ ResourceTypePut<T>: ResourceTypesPut[T]

Type parameters

Name Type
T extends ResourceType

Defined in

src/api/ResourceType.ts:111


RoomCreateOptions

Ƭ RoomCreateOptions: Required<RoomEditOptions>

Defined in

src/structures/Room.ts:11


SceneCreateOptions

Ƭ SceneCreateOptions: Pick<Required<SceneEditOptions>, "name" | "actions">

Defined in

src/structures/Scene.ts:42


ZoneCreateOptions

Ƭ ZoneCreateOptions: Required<ZoneEditOptions>

Defined in

src/structures/Zone.ts:11

Variables

CA

Const CA: string

Defined in

src/hue/Hue.ts:19


Events

Const Events: Object

Type declaration

Name Type
Add "add"
BridgeAdd "bridgeAdd"
BridgeDelete "bridgeDelete"
BridgeUpdate "bridgeUpdate"
Debug "debug"
Delete "delete"
DeviceAdd "deviceAdd"
DeviceDelete "deviceDelete"
DevicePowerAdd "devicePowerAdd"
DevicePowerDelete "devicePowerDelete"
DevicePowerUpdate "devicePowerUpdate"
DeviceUpdate "deviceUpdate"
Error "error"
GroupedLightAdd "groupedLightAdd"
GroupedLightDelete "groupedLightDelete"
GroupedLightUpdate "groupedLightUpdate"
LightAdd "lightAdd"
LightDelete "lightDelete"
LightUpdate "lightUpdate"
MotionAdd "motionAdd"
MotionDelete "motionDelete"
MotionUpdate "motionUpdate"
Raw "raw"
Ready "ready"
Request "request"
Response "response"
RoomAdd "roomAdd"
RoomDelete "roomDelete"
RoomUpdate "roomUpdate"
SceneAdd "sceneAdd"
SceneDelete "sceneDelete"
SceneUpdate "sceneUpdate"
Update "update"
ZigbeeConnectivityAdd "zigbeeConnectivityAdd"
ZigbeeConnectivityDelete "zigbeeConnectivityDelete"
ZigbeeConnectivityUpdate "zigbeeConnectivityUpdate"
ZigbeeDeviceDiscoveryAdd "zigbeeDeviceDiscoveryAdd"
ZigbeeDeviceDiscoveryDelete "zigbeeDeviceDiscoveryDelete"
ZigbeeDeviceDiscoveryUpdate "zigbeeDeviceDiscoveryUpdate"
ZoneAdd "zoneAdd"
ZoneDelete "zoneDelete"
ZoneUpdate "zoneUpdate"

Defined in

src/hue/HueEvents.ts:16


GAMUT_A

Const GAMUT_A: Gamut

Defined in

src/color/gamut.ts:13


GAMUT_B

Const GAMUT_B: Gamut

Defined in

src/color/gamut.ts:14


GAMUT_C

Const GAMUT_C: Gamut

Defined in

src/color/gamut.ts:15


RateLimits

RateLimits: RateLimits

Defined in

src/connections/Limit.ts:5

src/connections/Limit.ts:9

Functions

checkXyInReach

checkXyInReach(point, gamut): boolean

Parameters

Name Type
point XyPoint
gamut Gamut

Returns

boolean

Defined in

src/color/xy.ts:17


clone

clone<T>(object): T

Type parameters

Name Type
T extends Record<string, any>

Parameters

Name Type
object T

Returns

T

Defined in

src/util/clone.ts:1


createGamut

createGamut(red, green, blue): Gamut

Parameters

Name Type
red XyPoint
green XyPoint
blue XyPoint

Returns

Gamut

Defined in

src/color/gamut.ts:9


createResourceIdentifier

createResourceIdentifier<T>(id, type): ResourceIdentifier<T>

Type parameters

Name Type
T extends ResourceType

Parameters

Name Type
id string
type T

Returns

ResourceIdentifier<T>

Defined in

src/util/resourceIdentifier.ts:4


createXy

createXy(x, y, z?): XyPoint

Parameters

Name Type
x number
y number
z? number

Returns

XyPoint

Defined in

src/color/xy.ts:9


crossPoints

crossPoints(a, b): number

Parameters

Name Type
a XyPoint
b XyPoint

Returns

number

Defined in

src/color/xy.ts:13


fromHex

fromHex(hex): XyPoint

Parameters

Name Type
hex string

Returns

XyPoint

Defined in

src/color/hex.ts:25


fromRGB

fromRGB(rgb): XyPoint

Parameters

Name Type
rgb RGB

Returns

XyPoint

Defined in

src/color/rgb.ts:38


getClosestXy

getClosestXy(point, gamut): XyPoint

Parameters

Name Type
point XyPoint
gamut Gamut

Returns

XyPoint

Defined in

src/color/xy.ts:47


getClosestXyToLine

getClosestXyToLine(xy, a, b): XyPoint

Parameters

Name Type
xy XyPoint
a XyPoint
b XyPoint

Returns

XyPoint

Defined in

src/color/xy.ts:35


getDistanceBetweenXy

getDistanceBetweenXy(a, b): number

Parameters

Name Type
a XyPoint
b XyPoint

Returns

number

Defined in

src/color/xy.ts:28


hexToRgb

hexToRgb(hex): RGB

Parameters

Name Type
hex string

Returns

RGB

Defined in

src/color/hex.ts:8


merge

merge<T>(target, source): T

Type parameters

Name Type
T extends Record<string, any>

Parameters

Name Type
target Record<string, any>
source Record<string, any>

Returns

T

Defined in

src/util/merge.ts:1


resolveGamutByType

resolveGamutByType(type): Gamut

Parameters

Name Type
type "A" | "B" | "C"

Returns

Gamut

Defined in

src/color/gamut.ts:17


rgbToHex

rgbToHex(«destructured»): string

Parameters

Name Type
«destructured» RGB

Returns

string

Defined in

src/color/hex.ts:4


toHex

toHex(point): string

Parameters

Name Type
point XyPoint

Returns

string

Defined in

src/color/hex.ts:19


toRGB

toRGB(point): RGB

Parameters

Name Type
point XyPoint

Returns

RGB

Defined in

src/color/rgb.ts:9

hue.ts

Clone this wiki locally