JSDoc: Class: huepi

new huepi()

huepi Object, Entry point for all interaction with Lights etc via the Bridge.

Source:

huepi.js, line 19

Classes

Lightstate

Members

BridgeCache :object

Cache Hashmap of huepi BridgeID and Whitelisted Username

Type:

object

Source:

huepi.js, line 37

BridgeCacheAutosave :boolean

Autosave Cache Hasmap of huepi BridgeID and Whitelisted Username

Type:

boolean

Source:

huepi.js, line 39

BridgeConfig :object

Configuration of the Current(active) Bridge

Type:

object

Source:

huepi.js, line 43

BridgeID :string

ID (Unique, is MAC address) of the Current(active) Bridge

Type:

string

Source:

huepi.js, line 32

BridgeIP :string

IP address of the Current(active) Bridge

Type:

string

Source:

huepi.js, line 30

BridgeName :string

Name of the Current(active) Bridge

Type:

string

Source:

huepi.js, line 45

GroupIds :array

Array of all GroupIds of the Current(active) Bridge

Type:

array

Source:

huepi.js, line 55

Groups :array

Array of all Groups of the Current(active) Bridge

Type:

array

Source:

huepi.js, line 53

LightIds :array

Array of all LightIds of the Current(active) Bridge

Type:

array

Source:

huepi.js, line 50

Lights :array

Array of all Lights of the Current(active) Bridge

Type:

array

Source:

huepi.js, line 48

LocalBridges :array

Array of all Bridges on the local network

Type:

array

Source:

huepi.js, line 24

Rules :array

Array of all Rules of the Current(active) Bridge, NOTE: There are no Setter functions yet

Type:

array

Source:

huepi.js, line 65

ScanningNetwork :bool

get: local network scan in progress / set:proceed with scan

Type:

bool

Source:

huepi.js, line 27

Scenes :array

Array of all Scenes of the Current(active) Bridge, NOTE: There are no Setter functions yet

Type:

array

Source:

huepi.js, line 61

Schedules :array

Array of all Schedules of the Current(active) Bridge, NOTE: There are no Setter functions yet

Type:

array

Source:

huepi.js, line 59

Sensors :array

Array of all Sensors of the Current(active) Bridge, NOTE: There are no Setter functions yet

Type:

array

Source:

huepi.js, line 63

Username :string

Username for Whitelisting, generated by the Bridge

Type:

string

Source:

huepi.js, line 34

version :string

version of the huepi interface

Type:

string

Source:

huepi.js, line 21

Methods

(static) HelperColortemperaturetoCT(ColorTemperature) → {number}

Parameters:

Name	Type	Description
`ColorTemperature`	number

Source:

huepi.js, line 966

Returns:

CT in Mired (micro reciprocal degree)

Type: number

(static) HelperColortemperaturetoHueAngSatBri(Temperature) → {object}

Parameters:

Name	Type	Description
`Temperature`	number	ranges [1000..6600]

Source:

huepi.js, line 925

Returns:

[Ang, Sat, Bri] - Ranges [0..360] [0..1] [0..1]

Type: object

(static) HelperColortemperaturetoRGB(Temperature) → {object}

Parameters:

Name	Type	Description
`Temperature`	number	ranges [1000..6600]

Source:

huepi.js, line 659

Returns:

[Red, Green, Blue] ranges [0..1] [0..1] [0..1]

Type: object

(static) HelperColortemperaturetoXY(Temperature) → {object}

Parameters:

Name	Type	Description
`Temperature`	number	ranges [1000..6600]

Source:

huepi.js, line 947

Returns:

[x, y] - Ranges [0..1] [0..1]

Type: object

(static) HelperCTtoColortemperature(CT) → {number}

Parameters:

Name	Type	Description
`CT`	number	in Mired (micro reciprocal degree)

Source:

huepi.js, line 957

Returns:

ColorTemperature

Type: number

(static) HelperGamutXYforModel(Px, Py, Model) → {object}

Tests if the Px,Py resides within the Gamut for the model. Otherwise it will calculated the closesed point on the Gamut.

Parameters:

Name	Type	Description
`Px`	float	Range [0..1]
`Py`	float	Range [0..1]
`Model`	string	Modelname of the Light to Gamutcorrect Px, Py for

Source:

huepi.js, line 839

Returns:

[x, y] - Ranges [0..1] [0..1]

Type: object

(static) HelperHueAngSatBritoColortemperature(Ang, Sat, Bri) → {number}

Parameters:

Name	Type	Description
`Ang`	float	Range [0..360]
`Sat`	float	Range [0..1]
`Bri`	float	Range [0..1]

Source:

huepi.js, line 915

Returns:

Temperature ranges [2200..6500]

Type: number

(static) HelperHueAngSatBritoRGB(Ang, Sat, Bri) → {object}

Parameters:

Name	Type	Description
`Ang`	float	Range [0..360]
`Sat`	float	Range [0..1]
`Bri`	float	Range [0..1]

Source:

huepi.js, line 579

Returns:

[Red, Green, Blue] - Ranges [0..1] [0..1] [0..1]

Type: object

(static) HelperModelCapableCT(Model) → {boolean}

Parameters:

Name	Type	Description
`Model`	string

Source:

huepi.js, line 526

Returns:

Model is capable of CT

Type: boolean

(static) HelperModelCapableXY(Model) → {boolean}

Parameters:

Name	Type	Description
`Model`	string

Source:

huepi.js, line 537

Returns:

Model is capable of XY

Type: boolean

(static) HelperRGBtoColortemperature(Red, Green, Blue) → {number}

Parameters:

Name	Type	Description
`Red`	float	Range [0..1]
`Green`	float	Range [0..1]
`Blue`	float	Range [0..1]

Source:

huepi.js, line 635

Returns:

Temperature ranges [2200..6500]

Type: number

(static) HelperRGBtoHueAngSatBri(Red, Green, Blue) → {object}

Parameters:

Name	Type	Description
`Red`	float	Range [0..1]
`Green`	float	Range [0..1]
`Blue`	float	Range [0..1]

Source:

huepi.js, line 550

Returns:

[Ang, Sat, Bri] - Ranges [0..360] [0..1] [0..1]

Type: object

(static) HelperRGBtoXY(Red, Green, Blue) → {object}

Parameters:

Name	Type	Description
`Red`	float	Range [0..1]
`Green`	float	Range [0..1]
`Blue`	float	Range [0..1]

Source:

huepi.js, line 713

Returns:

[x, y] - Ranges [0..1] [0..1]

Type: object

(static) HelperToStringArray(Items) → {string}

Parameters:

Name	Type	Description
`Items`	multiple	Items to convert to StringArray

Source:

huepi.js, line 975

Returns:

String array containing Items

Type: string

(static) HelperXYtoColortemperature(x, y, Brightness) → {number}

Parameters:

Name	Type	Description
`x`	float
`y`	float
`Brightness`	float	Optional

Source:

huepi.js, line 937

Returns:

Temperature ranges [1000..6600]

Type: number

(static) HelperXYtoRGB(x, y, Brightness) → {object}

Parameters:

Name	Type	Description
`x`	float
`y`	float
`Brightness`	float	Optional

Source:

huepi.js, line 744

Returns:

[Red, Green, Blue] - Ranges [0..1] [0..1] [0..1]

Type: object

(static) HelperXYtoRGBforModel(x, y, Brightness, Model) → {object}

Parameters:

Name	Type	Description
`x`	float
`y`	float
`Brightness`	float	Optional
`Model`	string	Modelname of the Light

Source:

huepi.js, line 825

Returns:

[Red, Green, Blue] - Ranges [0..1] [0..1] [0..1]

Type: object

_BridgeCacheLoad()

Loads the BridgeCache, typically on startup

Source:

huepi.js, line 112

_BridgeCacheSave()

Saves the BridgeCache, typically on Whitelist new Device or Device no longer whitelisted as is the case with with @BridgeCacheAutosave on @_BridgeCacheAddCurrent and @_BridgeCacheRemoveCurrent NOTE: Saving this cache might be considered a security issue To counter this security issue, arrange your own load/save code with proper encryption

Source:

huepi.js, line 182

_BridgeCacheSelectFromLocalBridges()

Selects the first Bridge from LocalBridges found in BridgeCache and stores in BridgeIP defaults to 1st Bridge in LocalBridges if no bridge from LocalBridges is found in BridgeCache Internally called in PortalDiscoverLocalBridges and NetworkDiscoverLocalBridges

Source:

huepi.js, line 156

BridgeCreateUser(DeviceName)

Whitelists the Username stored in this object. Note: a buttonpress on the bridge is requered max 30 sec before this to succeed. please only use this once per device, Username is stored in cache.

Parameters:

Name	Type	Description
`DeviceName`	string	Optional device name to Whitelist.

Source:

huepi.js, line 476

BridgeDeleteUser(UsernameToDelete)

Parameters:

Name	Type	Description
`UsernameToDelete`	string	Username that will be revoked from the Whitelist. Note: Username stored in this object need to be Whitelisted to succeed.

Source:

huepi.js, line 505

BridgeGetConfig(ConfigBridgeIP, ConfigTimeOut)

Function to retreive BridgeConfig before Checking Whitelisting. ONCE call BridgeGetConfig Before BridgeGetData to validate we are talking to a hue Bridge available members (as of 'apiversion': '1.11.0'): name, apiversion, swversion, mac, bridgeid, replacesbridgeid, factorynew, modelid

Parameters:

Name	Type	Description
`ConfigBridgeIP`	string	Optional BridgeIP to GetConfig from, otherwise uses huepi.BridgeIP (this/self).
`ConfigTimeOut`	string	Optional TimeOut for network request, otherwise uses 60 seconds.

Source:

huepi.js, line 341

BridgeGetData()

Update function to retreive Bridge data and store it in this object. Consider this the main 'Get' function. Typically used for Heartbeat or manual updates of local data.

Source:

huepi.js, line 427

BridgeGetDescription(ConfigBridgeIP, ConfigTimeOut)

Function to retreive BridgeDescription before Checking Whitelisting. ONCE call BridgeGetDescription Before BridgeGetData to validate we are talking to a hue Bridge REMARK: Needs a fix of the hue bridge to allow CORS on xml endpoint too, just like on json endpoints already is implemented.

Parameters:

Name	Type	Description
`ConfigBridgeIP`	string	Optional BridgeIP to GetConfig from, otherwise uses huepi.BridgeIP (this/self).
`ConfigTimeOut`	string	Optional TimeOut for network request, otherwise uses 60 seconds.

Source:

huepi.js, line 382

GroupAlertLSelect(GroupNr, Transitiontime)

Parameters:

Name	Type	Description
`GroupNr`	number
`Transitiontime`	number	optional

Source:

huepi.js, line 1825

GroupAlertNone(GroupNr, Transitiontime)

Parameters:

Name	Type	Description
`GroupNr`	number
`Transitiontime`	number	optional

Source:

huepi.js, line 1837

GroupAlertSelect(GroupNr, Transitiontime)

Parameters:

Name	Type	Description
`GroupNr`	number
`Transitiontime`	number	optional

Source:

huepi.js, line 1813

GroupCreate(Name, Lights)

Note: Bridge doesn't accept lights in a Group that are unreachable at moment of creation

Parameters:

Name	Type	Description
`Name`	string	New name of the light Range [1..32]
`Lights`	multiple	LightNr or Array of Lights to Group

Source:

huepi.js, line 1541

GroupDelete(GroupNr)

Parameters:

Name	Type	Description
`GroupNr`	number

Source:

huepi.js, line 1603

GroupEffectColorloop(GroupNr, Transitiontime)

Parameters:

Name	Type	Description
`GroupNr`	number
`Transitiontime`	number	optional

Source:

huepi.js, line 1849

GroupEffectNone(GroupNr, Transitiontime)

Parameters:

Name	Type	Description
`GroupNr`	number
`Transitiontime`	number	optional

Source:

huepi.js, line 1861

GroupGetId(GroupNr) → {string}

Parameters:

Name	Type	Description
`GroupNr`	number	GroupNr

Source:

huepi.js, line 1483

Returns:

GroupId

Type: string

GroupGetNr(GroupId) → {number}

Parameters:

Name	Type	Description
`GroupId`	string	GroupId

Source:

huepi.js, line 1498

Returns:

GroupNr

Type: number

GroupOff(GroupNr, Transitiontime)

Parameters:

Name	Type	Description
`GroupNr`	number
`Transitiontime`	number	optional

Source:

huepi.js, line 1644

GroupOn(GroupNr, Transitiontime)

Parameters:

Name	Type	Description
`GroupNr`	number
`Transitiontime`	number	optional

Source:

huepi.js, line 1632

GroupSetAttributes(GroupNr, Name, Lights)

Note: Bridge doesn't accept lights in a Group that are unreachable at moment of creation

Parameters:

Name	Type	Description
`GroupNr`	number
`Name`	string	New name of the light Range [1..32]
`Lights`	multiple	LightNr or Array of Lights to Group

Source:

huepi.js, line 1589

GroupSetBrightness(GroupNr, Brightness, Transitiontime)

Parameters:

Name	Type	Description
`GroupNr`	number
`Brightness`		Range [0..255]
`Transitiontime`	number	optional

Source:

huepi.js, line 1706

GroupSetColortemperature(GroupNr, Colortemperature, Transitiontime)

Parameters:

Name	Type	Description
`GroupNr`	number
`Colortemperature`	number	Range [2200..6500] for the 2012 model
`Transitiontime`	number	optional

Source:

huepi.js, line 1775

GroupSetCT(GroupNr, CT, Transitiontime)

Parameters:

Name	Type	Description
`GroupNr`	number
`CT`	number	micro reciprocal degree
`Transitiontime`	number	optional

Source:

huepi.js, line 1747

GroupSetHSB(GroupNr, Hue, Saturation, Brightness, Transitiontime)

Sets Gamut Corrected values for HSB

Parameters:

Name	Type	Description
`GroupNr`	number
`Hue`	number	Range [0..65535]
`Saturation`	number	Range [0..255]
`Brightness`	number	Range [0..255]
`Transitiontime`	number	optional

Source:

huepi.js, line 1660

GroupSetHue(GroupNr, Hue, Transitiontime)

Parameters:

Name	Type	Description
`GroupNr`	number
`Hue`	number	Range [0..65535]
`Transitiontime`	number	optional

Source:

huepi.js, line 1680

GroupSetHueAngSatBri(GroupNr, Ang, Sat, Bri, Transitiontime)

Parameters:

Name	Type	Description
`GroupNr`	number
`Ang`		Range [0..360]
`Sat`		Range [0..1]
`Bri`		Range [0..1]
`Transitiontime`	number	optional

Source:

huepi.js, line 1721

GroupSetLights(GroupNr, Lights)

Note: Bridge doesn't accept lights in a Group that are unreachable at moment of creation

Parameters:

Name	Type	Description
`GroupNr`	number
`Lights`	multiple	LightNr or Array of Lights to Group

Source:

huepi.js, line 1572

GroupSetName(GroupNr, Name)

Parameters:

Name	Type	Description
`GroupNr`	number
`Name`	string	New name of the light Range [1..32]

Source:

huepi.js, line 1556

GroupSetRGB(GroupNr, Red, Green, Blue, Transitiontime)

Parameters:

Name	Type	Description
`GroupNr`	number
`Red`		Range [0..1]
`Green`		Range [0..1]
`Blue`		Range [0..1]
`Transitiontime`	number	optional

Source:

huepi.js, line 1736

GroupSetSaturation(GroupNr, Saturation, Transitiontime)

Parameters:

Name	Type	Description
`GroupNr`	number
`Saturation`		Range [0..255]
`Transitiontime`	number	optional

Source:

huepi.js, line 1693

GroupSetState(GroupNr, State)

Parameters:

Name	Type	Description
`GroupNr`	number
`State`	LightState

Source:

huepi.js, line 1617

GroupSetXY(GroupNr, X, Y, Transitiontime)

Parameters:

Name	Type	Description
`GroupNr`	number
`X`	float
`Y`	float
`Transitiontime`	number	optional

Source:

huepi.js, line 1786

GroupsGetData()

Source:

huepi.js, line 1507

GroupsGetZero()

Source:

huepi.js, line 1524

LightAlertLSelect(LightNr, Transitiontime)

Parameters:

Name	Type	Description
`LightNr`	number
`Transitiontime`	number	optional

Source:

huepi.js, line 1429

LightAlertNone(LightNr, Transitiontime)

Parameters:

Name	Type	Description
`LightNr`	number
`Transitiontime`	number	optional

Source:

huepi.js, line 1441

LightAlertSelect(LightNr, Transitiontime)

Parameters:

Name	Type	Description
`LightNr`	number
`Transitiontime`	number	optional

Source:

huepi.js, line 1417

LightEffectColorloop(LightNr, Transitiontime)

Parameters:

Name	Type	Description
`LightNr`	number
`Transitiontime`	number	optional

Source:

huepi.js, line 1453

LightEffectNone(LightNr, Transitiontime)

Parameters:

Name	Type	Description
`LightNr`	number
`Transitiontime`	number	optional

Source:

huepi.js, line 1465

LightGetId(LightNr) → {string}

Parameters:

Name	Type	Description
`LightNr`	number	LightNr

Source:

huepi.js, line 1155

Returns:

LightId

Type: string

LightGetNr(LightId) → {number}

Parameters:

Name	Type	Description
`LightId`	string	LightId

Source:

huepi.js, line 1167

Returns:

LightNr

Type: number

LightOff(LightNr, Transitiontime)

Parameters:

Name	Type	Description
`LightNr`	number
`Transitiontime`	number	optional

Source:

huepi.js, line 1256

LightOn(LightNr, Transitiontime)

Parameters:

Name	Type	Description
`LightNr`	number
`Transitiontime`	number	optional

Source:

huepi.js, line 1244

LightSetBrightness(LightNr, Brightness, Transitiontime)

Parameters:

Name	Type	Description
`LightNr`	number
`Brightness`		Range [0..255]
`Transitiontime`	number	optional

Source:

huepi.js, line 1317

LightSetColortemperature(LightNr, Colortemperature, Transitiontime)

Parameters:

Name	Type	Description
`LightNr`	number
`Colortemperature`	number	Range [2200..6500] for the 2012 model
`Transitiontime`	number	optional

Source:

huepi.js, line 1384

LightSetCT(LightNr, CT, Transitiontime)

Parameters:

Name	Type	Description
`LightNr`	number
`CT`	number	micro reciprocal degree
`Transitiontime`	number	optional

Source:

huepi.js, line 1362

LightSetHSB(LightNr, Hue, Saturation, Brightness, Transitiontime)

Sets Gamut Corrected values for HSB

Parameters:

Name	Type	Description
`LightNr`	number
`Hue`	number	Range [0..65535]
`Saturation`	number	Range [0..255]
`Brightness`	number	Range [0..255]
`Transitiontime`	number	optional

Source:

huepi.js, line 1272

LightSetHue(LightNr, Hue, Transitiontime)

Parameters:

Name	Type	Description
`LightNr`	number
`Hue`	number	Range [0..65535]
`Transitiontime`	number	optional

Source:

huepi.js, line 1291

LightSetHueAngSatBri(LightNr, Ang, Sat, Bri, Transitiontime)

Parameters:

Name	Type	Description
`LightNr`	number
`Ang`		Range [0..360]
`Sat`		Range [0..1]
`Bri`		Range [0..1]
`Transitiontime`	number	optional

Source:

huepi.js, line 1332

LightSetName(LightNr, Name)

Parameters:

Name	Type	Description
`LightNr`	number
`Name`	string	New name of the light Range [1..32]

Source:

huepi.js, line 1214

LightSetRGB(LightNr, Red, Green, Blue, Transitiontime)

Parameters:

Name	Type	Description
`LightNr`	number
`Red`		Range [0..1]
`Green`		Range [0..1]
`Blue`		Range [0..1]
`Transitiontime`	number	optional

Source:

huepi.js, line 1347

LightSetSaturation(LightNr, Saturation, Transitiontime)

Parameters:

Name	Type	Description
`LightNr`	number
`Saturation`		Range [0..255]
`Transitiontime`	number	optional

Source:

huepi.js, line 1304

LightSetState(LightNr, State)

Parameters:

Name	Type	Description
`LightNr`	number
`State`	LightState

Source:

huepi.js, line 1229

LightSetXY(LightNr, X, Y, Transitiontime)

Parameters:

Name	Type	Description
`LightNr`	number
`X`	float
`Y`	float
`Transitiontime`	number	optional

Source:

huepi.js, line 1395

LightsGetData()

Source:

huepi.js, line 1176

LightsGetNew()

Source:

huepi.js, line 1205

LightsSearchForNew()

Source:

huepi.js, line 1193

NetworkDiscoverLocalBridges()

Creates the list of hue-Bridges on the local network

Source:

huepi.js, line 207

PortalDiscoverLocalBridges()

Retreives the list of hue-Bridges on the local network from the hue Portal

Source:

huepi.js, line 298

RulesGetData()

Source:

huepi.js, line 1937

ScenesGetData()

Source:

huepi.js, line 1897

SchedulesGetData()

Source:

huepi.js, line 1877

SensorsGetData()

Source:

huepi.js, line 1917