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.

...

  • ResourceXpress server (V5 or above)

  • ResourceXpress Workspace licences (1 per workspace sensor)

  • Philips Hue Bridge (v2.0) - 1 per local group of sensors
    (see appendix 1 Philips Hue Sensor & Bridge Limitations for range and capacity guidelines)

  • Philips Hue Motion Sensor (1 per workspace)

Optional

  • Hue Light Bulb (if using Hue Mobile App for setup )

  • Windows 10 PC (if not installing RX Sensor Service on ResourceXpress server - administrator rights required)

...

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>

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.

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.

...

Now that the sensors are all configured the RX Sensor Service can be installed onto either the ResourceXpress server or a Windows 10 or above PC. Both require network connectivity to the Hue Bridge(s).

Install Node.js

The Sensor Service utilises Node.js, using the link below, download and install the latest LTS version of Node.js. We advise following the guidelines provided for this simple installation.

...

⚠ Make sure to deselect the Management Tools option before starting the installation as this is a large installation.

Download the Sensor Service Kit

If not already provided please request the latest installation kit by sending a request to helpdesk@qedas.com.

Running the Installation

Extract the setup kit from the ZIP file and run the application found in the extracted folder.

...

Once the installation has completed click, Finish.

...

Configuring the Service

Now that the service is installed, the next step is to configure the Hue Bridge details as well as the ResourceXpress server details.

...

Once updated save the changes.

ResourceXpress Service User

For the service to authenticate with the ResourceXpress server a Service User will need to be created.

...

Set the RFID value as MOTION, this value is used to allow the service to communicate with the server.

Start the Service

Once the service user has been created and the service details configured it’s time to start the service.
Navigate to Windows Services.

...

As soon as the service has started the sensors will be actively monitored.
There are a couple of ways to ensure everything is communicating.

Bookings

The simplest way, if using the create booking function, is to check that bookings are being created.
If using Qubi’s for the workspace after a period of motion in front of the sensor the Qubi should go Red and display a booking on the display.

...

Warning

Do not leave verbose mode on for long periods otherwise performance could be affected.

Appendix 1 - Hue Sensor and Hue Bridge Limitations

...

Range - The Phillips Hue Bridges and Sensors communicate using Zigbee (2.4GHz) so are short range devices i.e. similar to 2.4 GHz WiFi. Range will therefore depend on office layout and construction and if range issues are experienced additional bridges may be required.

...

affected.

...