Change to light theme (or icon here)

PhilipsHue

Philips Hue Lights

Contents

Outgoing channel : "PHILIPSHUE_CHANNEL"

Pairing

Pair the extension using the 'pair' option in the small settings dialog and press the button on the philips hue hub.

Triggers/Actions

Triggers and actions below are updated when the automatic document generation system is run and only contain triggers actions relating to this specific extension.

Table last updated: Wed, 12 Mar 2025 05:38:02 GMT

Triggers

name trigger description

Actions

name trigger description
PhilipsHueActivateScene action_ActivateScene Activates a given scene in the Philips Hue hub

"PhilipsHue" Extension Details...

Allows control over philips hue lights
Source:

Methods

SaveConfigToServer()

Saves our config to the server
Source:

SendSettingsWidgetSmall(tochannel)

send some modal code
Parameters:
Name Type Description
tochannel String
Source:

UpdateCredentials()

Saves our credentials to the server
Source:

(async) UpdateHueData()

Requests all Hue data
Source:

activateSceneById(scenedID)

Activates the philips hue scene specified by id
Parameters:
Name Type Description
scenedID number
Source:

activateSceneByName(sceneName)

Activates the philips hue scene specified by name
Parameters:
Name Type Description
sceneName string
Source:

(async) connectToHub(perform_pairing)

connect to the HueHub
Parameters:
Name Type Default Description
perform_pairing boolean false
Source:

(async) discoverBridge_nupnp()

Performs nupnp lookup to find the hub on the network
Source:

(async) discoverBridge_upnp(timeout)

Performs upnp lookup to find the hub on the network
Parameters:
Name Type Description
timeout number
Source:

(async) getAllGroups()

Gets all groups from the hue hub. Currently untested and unused needs someone with a philips hue hub to test and report results
Source:

(async) getAllScenes()

gets all scenes from the hue bridge
Source:

heartBeatCallback()

Sends out heartbeat messages so other extensions can see our status
Source:

initialise(app, host, port, heartbeat)

Starts the extension using the given data.
Parameters:
Name Type Description
app object:Express
host string
port number
heartbeat number
Source:

(async) initialiseHue(force_paring)

Initialises the philips hue system and optionally pairs
Parameters:
Name Type Default Description
force_paring boolean false
Source:

onDataCenterConnect(socket)

Connection message handler
Parameters:
Name Type Description
socket *
Source:

onDataCenterDisconnect(reason)

Disconnection message sent from the server
Parameters:
Name Type Description
reason String
Source:

onDataCenterMessage(server_packet)

receives message from the socket
Parameters:
Name Type Description
server_packet data
Source:

outputScenes()

Sends a message out containing all the scenes in the hue hub
Source:

(async) pair()

Pair with the philips hue hub
Source:

processScenes()

This function will go through the scenes and mark them as on, on_part, or off
Source: