Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

This guide covers how to configure Philips Hue Motion Sensors for use with the ResourceXpress workspace management system.

...

Expand
titleOption 1 - Using the Hue Mobile App (requires a Philips Hue light)

For this stage, ResourceXpress server workspace profiles are assumed to be created. These should be Qubi type.

Download the Hue app from the App Store (iPhone) or the Play Store (Android).
Once downloaded open then the App and follow the instructions provided to connect with the Bridge and add any lights.

Info

It is an app requirement to have at least 1 Hue light to progress past these steps.

Next, continue with the setup process for Room setup.

One room is required, however, if using lights with each resource a room each will be required.

Once this is complete navigate to Settings, then tap Accessory setup.
Tap the Add accessory button, then follow the steps to add a Motion Sensor.

Once the sensor has been connected continue following the app's steps.
Firstly, choose the correct location for this sensor, this is required if using lights as this will pair the sensor and lights.

Next, you’ll be asked to configure the default settings for the lights and sensor.
If using lights, configure this as required, if not, tap Done.

After this, you’ll be taken to the sensor settings screen. Tap the sensor name and append the ResourceXpress workspace profile ID to the name in parentheses e.g. { 14 }. For the list of profile ID’s see the image below.

Press the Return key on the keyboard to update the name.

Info

The sensor name needs to contain the ResourceXpress profile ID in parentheses

Tap the tick icon in the top right corner to save these details.

Repeat the steps to add a new accessory for each sensor.

Expand
titleOption 2 - Continue with the Hue API Debug Tool (does not require a Phillips Hue Light)

For this stage, ResourceXpress server workspace profiles are assumed to be created.

This next step locates any new sensors that have not previously been connected.

In the URL textbox add a “/” then paste your API User Token, ensure you keep the original “/api” value.

/api/<new-api-user-token>

Image Removed

For each sensor that will be connected to this Hue Bridge remove the small plastic tap found on the front of the device. The LED on the front of the sensor should start flashing red/orange which indicates the sensor is in pairing mode.

In the URL textbox after the API user token add “/sensors

/api/<new-api-user-token>/sensors

Remove the text from the Message Body textbox.
Click the POST button.

The message shown in the Command Response textbox will indicate that the Hue Bridge is now looking for all new devices.

Image Added

List All New Sensors

Allow a few moments for Hue Bridge to discover all the sensors, then add “/new” to the URL textbox.

/api/<new-api-user-token>/sensors/new

Click the GET button.

In the Command Response textbox, a list of all the newly added sensors will be displayed.
Each Motion Sensor device has 3 different sensors; motion, ambient light and temperature.
The above image is an example of a single Motion Sensor device being added.

In the above example, the ID number for the motion sensor is 2, as shown in the quotation marks above the sensor name.

You will need to take note of the ID number for each “motion” sensor only.

If configuring sensors on a new system it is likely the ID values will be 2, 5, 8, 11, 14, 17… etc

List All Sensors

If you already have sensors connected use the URL as above but remove the “/new” section from the URL, then click the GET button.
This will list all sensors linked with the bridge.

Assign an RX Profile

We advise taking the time now to work out which sensor and RX Profile are to be linked.
To get the RX Profile ID('s), navigate to the Resource ListResource Display Profiles page in your ResourceXpress instance. The ID number will be listed under the ID column.

Note

For a profile to work with the Sensor Service it requires a Qubi configured.

Checking for Motion

Note

The next steps will need to be repeated for each individual Motion Sensor device.

To ensure the sensor is accurately detecting motion, enable usertest.
To turn usertest on, add the sensor ID followed by “/config” in the URL textbox:

/api/<new-api-user-token>/sensors/<sensor-id>/config

Info

In this example, the sensor ID is 2

In the Message Body use the below value:

Code Block
languagejson
{
  "usertest": true
}

Click the PUT button.

In the Command Response textbox, you will see confirmation of the updated change.

When the sensor detects motion, a green LED on the front of the device will turn on.

You can use the green LED to visually find the Motion Sensor device with this sensor ID.
This is useful when dealing with many devices.

Naming the Sensor

To allow the Sensor Service to know which RX Profile a sensor is paired with, the RX Profile ID needs to be added to the sensor name.

To update a sensors name, remove “/config” from the URL textbox.

/api/<new-api-user-token>/sensors/<sensor-id>

Info

In this example, the RX Profile IDis 14.

In the Message Body textbox enter the below value (modify the name to your requirement):

Code Block
{
  "name": "Desk { 14 }"
}
Info

The RX ID value needs to be placed between { and }.
The rest of the name can be whatever you choose.

Click the PUT button.

In the Command Response textbox, you will see a message confirming the new name of the sensor.

Info

We advise labelling the sensor hardware with the assigned Resource.

Disable usertest

To disable usertest, add “/config” after sensor ID in the URL textbox:

/api/<new-api-user-token>/sensors/<sensor-id>/config

In the Message Body use the below value:

Code Block
languagejson
{
  "usertest": false
}

Click the PUT button.

In the Command Response textbox, you will see confirmation of the updated change.

Repeat this step for each sensor being used with this Bridge.

...