hueget 0.7.6 → 1.0.0

package/CHANGELOG.md

@@ -4,6 +4,9 @@ See the [Readme file](https://github.com/jsiegenthaler/hueget/blob/master/README
 
 # Bug Fixes and Improvements
 
+## 1.0.0 (2025-01-01)
+* Added support for further controllable api endpoints: schedules,scenes,sensors,rules,resourcelinks,capabilities
+
 
 ## 0.7.6 (2024-12-13)
 * Added Docker config (thanks @Yannis4444)

package/README.md

@@ -9,13 +9,11 @@
 A simple API to control Philips Hue lamps with http GET requests.
 
 # Background
-The existing Philips Hue REST API requires a PUT request to control the Hue lights and groups. 
+The existing Philips Hue REST API requires a PUT request to control the Hue lights, groups, sensors and other resources of the Hue system. 
 
-I needed GET, so I made a simple API to translate from GET to PUT. It also supports the standard GET command so you can use hueget for both.
+I had a specific use case where I could only use GET requests, so I made a simple API to translate from GET to PUT. It also supports the standard GET command so you can use hueget for both GET and PUT.
 
-hueget suports controlling lights as well as groups. A group is a collection of a number of lights, which in the Philips Hue app appears as a room.
-
-This is my first ever API javascript program, so if you see any way it can be improved, I'd be happy to receive your suggestions.
+hueget supports controlling lights, groups, sensors and more. A group is a collection of a number of lights, which in the Philips Hue app appears as a room. Sensors are devices such as the daylight sensor, the geofence sensor, motion sensors (which include light level and temperature) and switch sensors.
 
 If you like this tool, consider buying me a coffee!<br>
 <a target="blank" href="https://ko-fi.com/jsiegenthaler"><img src="https://img.shields.io/badge/Ko--Fi-Buy%20me%20a%20coffee-29abe0.svg?logo=ko-fi"/></a>
@@ -23,16 +21,16 @@ If you like this tool, consider buying me a coffee!<br>
 # Creative Ways to use hueget
 
 ## Visual Door Bell
-Flash your lights in the entire house when the doorbell rings. I have a Shelly1 as my doorbell. The doorbell connects to the Shelly1 SW input using a relay on the doorbell buzzer. Thus when the doorbell button is pressed, the Shelly1 sees an input, and calls a url, which flashes a group of lights for 15 seconds using the ```alert=lselect``` command. I use the Philips Hue app to determine what lights should be in the group.
+Flash your lights in the entire house when the doorbell rings. I have a Shelly1 as my doorbell. The doorbell connects to the Shelly1 SW input using a relay on the doorbell buzzer. Thus when the doorbell button is pressed, the Shelly1 sees an input, and calls a url, which flashes a group of lights for 15 seconds using the `alert=lselect` command. I use the Philips Hue app to determine what lights should be in the group.
 
 ## Control Hue Lights directly from Shelly Motion Sensors
 Anything that can call a url when triggered - such as a Shelly Motion Sensor - can be used to turn the lights on and off again. Make sure the motion sensor calls a url to turn lights on, and a url to turn lights off. The Shelly Motion Sensor is ideal for this, as you can activate call urls for different motion triggers.
 
 ## Toggle lights from a Shelly Button 1
-Toggle a light or group of lights from a button that sends a non-changing URL. The ```toggle``` command is perfect for any pushbutton controller that does not know (or can not know) the current light state, and only sends a non-changing static URL, such as a Shelly Button 1.
+Toggle a light or group of lights from a button that sends a non-changing URL. The `toggle` command is perfect for any pushbutton controller that does not know (or can not know) the current light state, and only sends a non-changing static URL, such as a Shelly Button 1.
 
 ## Be Home Soon Alert
-Flash lights in a room or in any group (zone, room) when someone comes home. The ```alert=lselect``` command is perfect to generate a 15 second long flash without any extra programming. Just call the URL from Apple HomeKit automations when a person arrives in your geofence.
+Flash lights in a room or in any group (zone, room) when someone comes home. The `alert=lselect` command is perfect to generate a 15 second long flash without any extra programming. Just call the URL from Apple HomeKit automations when a person arrives in your geofence.
 
 
 # Installing hueget
@@ -84,7 +82,7 @@ $ node /home/pi/node_modules/hueget/hueget.js -i 192.168.0.101 -u UBxWZChHseyjeF
 ```
 A successful start of hueget (using the above command to specify ip address 192.168.0.100 and port 1234) will show:
 ```
-hueget v0.7.6
+hueget v1.0.0
 commands will be sent to 192.168.0.101 with username UBxWZChHseyjeFwAkwgbdQ08x9XASWpanZZVg-mj
 listening on port 1234
 ```
@@ -121,7 +119,7 @@ For more information about pm2, see https://github.com/Unitech/pm2
 
 
 # Getting your Philips Hue Bridge API Username
-If you have [Homebridge](https://homebridge.io/), and the [homebridge-hue](https://github.com/ebaauw/homebridge-hue) plugin, look at the **users** section of the hue config. You will see the Hue bridge MAC address folowed by the Hue bridge api username
+If you have [Homebridge](https://homebridge.io/), and the [homebridge-hue](https://github.com/ebaauw/homebridge-hue) plugin, look at the **users** section of the hue config. You will see the Hue bridge MAC address followed by the Hue bridge api username
 ```
 "users": {
   "ECB5FAFFFEFFFFFF": "yourPhilipsHueBridgeUsername"
@@ -132,6 +130,9 @@ The username will look something like this:
 UBxWZChHseyjeFwAkwgbdQ08x9XASWpanZZVg-mj
 ```
 
+Otherwise, if you do not have the homebridge-hue plugin installed, you need to create a new api username using the instructions shown here: https://developers.meethue.com/develop/get-started-2/ (this page does not require a Hue Developer Account).
+
+
 # Running hueget with Docker (optional, only if you use a Docker environment)
 You can run hueget easily using Docker and Docker Compose. This approach simplifies the setup in a Docker environment and ensures hueget is isolated and always running reliably.
 
@@ -145,17 +146,25 @@ You can run hueget easily using Docker and Docker Compose. This approach simplif
    ```bash
    docker compose up -d
    ```
+ 
 
-
-# Reading the Status of your Hue Lights or Groups with hueget
-Enter a URL (in the format shown below) into your browser and press Enter. The ip address is the ip address of the device running hueget, eg: a raspberry pi.
+# Reading the Status of your Hue Lights, Groups, Sensors and other Resources with hueget
+Enter a URL (in the format shown below) into your browser and press Enter. The ip address is the ip address of the device running hueget, e.g.: a raspberry pi.
 Examples:
 
 * Get status of light 31: http://192.168.0.101:3000/api/yourPhilipsHueBridgeUsername/lights/31
 * Get status of group 2: http://192.168.0.101:3000/api/yourPhilipsHueBridgeUsername/groups/2
+* Get status of sensor 1: http://192.168.0.101:3000/api/yourPhilipsHueBridgeUsername/sensors/1
+* Get status of resourcename 1: http://192.168.0.101:3000/api/yourPhilipsHueBridgeUsername/resourcename/1
+
+# Get the Capabilities of your Hue Bridge with hueget
+The capabilities api endpoint shows how many lights, sensors, groups, scenes, schedules, rules, resourcelinks and other resources are available and how many exist in total. This is very useful to determine how many resources are configured and being used.
+Example:
+
+* Get capabilities of the Hue bridge: http://192.168.0.101:3000/api/yourPhilipsHueBridgeUsername/capabilities
 
-# Controlling your Hue Lights or Groups with hueget
-Enter a URL (in the format shown below) into your browser and press Enter. The ip address is the ip address of the device running hueget, eg: a raspberry pi.
+# Controlling your Hue Lights, Groups or Sensors with hueget
+Enter a URL (in the format shown below) into your browser and press Enter. The ip address is the ip address of the device running hueget, e.g.: a raspberry pi.
 Examples:
 ## Lights
 ### Light 31 (example)
@@ -188,29 +197,101 @@ Examples:
 
 Groups are collections of lights, and are used for Rooms and Zones in the Hue app.
 
-## Special Commands
-The hueget server supports a special toggle command, which does not exist natively in the Philips Hue bridge. This toggles (changes the state) of a specified light or a group, allowing you to toggle the light/group state with a single URL.
+
+## Sensors
+### Sensor 1 (the daylight sensor)
+* Turn sensor 1 on: http://192.168.0.101:3000/api/yourPhilipsHueBridgeUsername/sensors/1/config?on=true
+* Turn sensor 1 off: http://192.168.0.101:3000/api/yourPhilipsHueBridgeUsername/sensors/1/config?on=false
+* Toggle sensor 1: http://192.168.0.101:3000/api/yourPhilipsHueBridgeUsername/sensors/1/toggle
+
+### Sensor 15 (example, a Hue motion sensor)
+* Turn sensor 15 on: http://192.168.0.101:3000/api/yourPhilipsHueBridgeUsername/sensors/15/config?on=true
+* Turn sensor 15 off: http://192.168.0.101:3000/api/yourPhilipsHueBridgeUsername/sensors/15/config?on=false
+* Toggle sensor 15: http://192.168.0.101:3000/api/yourPhilipsHueBridgeUsername/sensors/15/toggle
+
+
+## Special Toggle Command for Lights, Groups and Sensors
+The hueget server supports a special `toggle` command, which does not exist natively in the Philips Hue bridge. This toggles (changes the state) of a specified light or group or sensor, allowing you to toggle the light/group/sensor state with a single URL. Toggling only makes sense for items that have an on and off state, which is why it is currently restricted to lights, groups and sensors.
+
+The toggling of a light, group or sensor is the same as turning it on or off in the Hue app, and thus applies to the `on` parameter of the relevant `state` (lights), `action` (groups) or `config` (sensors).
 
 Syntax:
 * Toggle light 1: http://192.168.0.101:3000/api/yourPhilipsHueBridgeUsername/lights/1/toggle
 * Toggle group 2: http://192.168.0.101:3000/api/yourPhilipsHueBridgeUsername/groups/2/toggle
+* Toggle sensor 15: http://192.168.0.101:3000/api/yourPhilipsHueBridgeUsername/sensors/15/toggle
+
 
+## Supported Command Keywords and Parameters
+The API is transparent to all Philips Hue command keywords and parameters. It expects all parameter name=value pairs to be separated by a comma. If any comma is required inside a value, e.g.: for the xy command which expects a value array, then you must url encode the comma to %2c.
 
-## Supported Keywords
-The API is transparent to all Philips Hue keywords. It expects all name=value pairs to be separated by a comma. If any comma is required inside a value, eg: for the xy command which expects a value array, then you must url encode the comma to %2c.
+If you include a parameter that the Hue bridge does not understand, an error message will be returned from the Hue bridge. Example:
 
+url: http://192.168.0.101:3000/api/yourPhilipsHueBridgeUsername/sensors/15/config?xxxx=on
+
+Response:
+```
+[{"error":{"type":6,"address":"/sensors/15/config/xxxx","description":"parameter, xxxx, not available"}}]
+```
+
+
+## Example JSON Responses
+### Lights
 The full JSON response for a light looks like this:
 ```
 {"1":{"state":{"on":false,"bri":198,"hue":5360,"sat":192,"effect":"none","xy":[0.5330,0.3870],"ct":500,"alert":"select","colormode":"xy","mode":"homeautomation","reachable":true},"swupdate":{"state":"noupdates","lastinstall":"2021-08-21T01:50:00"},"type":"Extended color light","name":"Standard Lamp","modelid":"LCA001","manufacturername":"Signify Netherlands B.V.","productname":"Hue color lamp","capabilities":{"certified":true,"control":{"mindimlevel":200,"maxlumen":800,"colorgamuttype":"C","colorgamut":[[0.6915,0.3083],[0.1700,0.7000],[0.1532,0.0475]],"ct":{"min":153,"max":500}},"streaming":{"renderer":true,"proxy":true}},"config":{"archetype":"floorshade","function":"mixed","direction":"omnidirectional","startup":{"mode":"safety","configured":true}},"uniqueid":"00:17:88:01:08:ff:ff:ff-0b","swversion":"1.90.1","swconfigid":"35F80D40","productid":"Philips-LCA001-4-A19ECLv6"}}
 ```
 
+### Groups
 The full JSON response for a group looks like this:
 ```
 {"name":"Lounge","lights":["9","1","2"],"sensors":[],"type":"Room","state":{"all_on":false,"any_on":false},"recycle":false,"class":"Lounge","action":{"on":false,"bri":0,"hue":7800,"sat":138,"effect":"none","xy":[0.5302,0.392],"ct":153,"alert":"select","colormode":"xy"}}
 ```
+
+### Sensors
+The full JSON response for a sensor varies according to the sensor type. A few types are shown below:
+
+#### Daylight
+A Daylight sensor is a built-in sensor used for sunrise and sunset functions
+```
+{"1":{"state":{"daylight":true,"lastupdated":"2025-01-01T07:12:00"},"config":{"on":true,"configured":true,"sunriseoffset":0,"sunsetoffset":0},"name":"Daylight","type":"Daylight","modelid":"PHDL00","manufacturername":"Signify Netherlands B.V.","swversion":"1.0"}
+```
+
+#### Geofence
+A Geofence sensor is a built-in sensor used for coming and leaving home functions
+```
+"4":{"state":{"presence":true,"lastupdated":"2021-05-27T17:54:43"},"config":{"on":true,"reachable":true},"name":"John's iPhone","type":"Geofence","modelid":"HA_GEOFENCE","manufacturername":"Philips","swversion":"1.0","uniqueid":"L_02_AaRRM","recycle":false}
+```
+
+#### ZLLPresence
+A ZLLPresence sensor is the motion sensor component of a Hue Motion Sensor
+```
+"15":{"state":{"presence":false,"lastupdated":"2025-01-01T09:09:13"},"swupdate":{"state":"noupdates","lastinstall":"2019-12-31T21:39:06"},"config":{"on":true,"battery":70,"reachable":true,"alert":"lselect","sensitivity":2,"sensitivitymax":2,"ledindication":false,"usertest":false,"pending":[]},"name":"Motion sensor 1","type":"ZLLPresence","modelid":"SML001","manufacturername":"Signify Netherlands B.V.","productname":"Hue motion sensor","swversion":"6.1.1.27575","uniqueid":"00:17:88:01:06:f5:1f:36-02-0406","capabilities":{"certified":true,"primary":true}},
+```
+
+#### ZLLLightLevel
+A ZLLLightLevel sensor is the ambient light sensor component of a Hue Motion Sensor
+```
+"16":{"state":{"lightlevel":11427,"dark":false,"daylight":true,"lastupdated":"2025-01-01T09:10:17"},"swupdate":{"state":"noupdates","lastinstall":"2019-12-31T21:39:06"},"config":{"on":true,"battery":70,"reachable":true,"alert":"none","tholddark":2702,"tholdoffset":7000,"ledindication":false,"usertest":false,"pending":[]},"name":"Hue ambient light sensor 1","type":"ZLLLightLevel","modelid":"SML001","manufacturername":"Signify Netherlands B.V.","productname":"Hue ambient light sensor","swversion":"6.1.1.27575","uniqueid":"00:17:88:01:06:f5:1f:36-02-0400","capabilities":{"certified":true,"primary":false}},
+```
+
+#### ZLLTemperature
+A ZLLTemperature sensor is the temperature sensor component of a Hue Motion Sensor
+```
+"17":{"state":{"temperature":2030,"lastupdated":"2025-01-01T09:08:13"},"swupdate":{"state":"noupdates","lastinstall":"2019-12-31T21:39:06"},"config":{"on":true,"battery":70,"reachable":true,"alert":"none","ledindication":false,"usertest":false,"pending":[]},"name":"Hue temperature sensor 1","type":"ZLLTemperature","modelid":"SML001","manufacturername":"Signify Netherlands B.V.","productname":"Hue temperature sensor","swversion":"6.1.1.27575","uniqueid":"00:17:88:01:06:f5:1f:36-02-0402","capabilities":{"certified":true,"primary":false}}
+```
+
+#### ZLLSwitch
+A ZLLSwitch sensor is the dimmer switch buttons of a Hue dimmer switch (original version)
+```
+"79":{"state":{"buttonevent":1002,"lastupdated":"2024-12-31T21:19:34"},"swupdate":{"state":"noupdates","lastinstall":"2020-07-18T12:47:52"},"config":{"on":true,"battery":15,"reachable":true,"pending":[]},"name":"Hue dimmer switch","type":"ZLLSwitch","modelid":"RWL021","manufacturername":"Signify Netherlands B.V.","productname":"Hue dimmer switch","diversityid":"73bbabea-3420-499a-9856-46bf437e119b","swversion":"6.1.1.28573","uniqueid":"00:17:88:01:08:09:d4:cd-02-fc00","capabilities":{"certified":true,"primary":true,"inputs":[{"repeatintervals":[800],"events":[{"buttonevent":1000,"eventtype":"initial_press"},{"buttonevent":1001,"eventtype":"repeat"},{"buttonevent":1002,"eventtype":"short_release"},{"buttonevent":1003,"eventtype":"long_release"},{"buttonevent":1004,"eventtype":"long_press"}]},{"repeatintervals":[800],"events":[{"buttonevent":2000,"eventtype":"initial_press"},{"buttonevent":2001,"eventtype":"repeat"},{"buttonevent":2002,"eventtype":"short_release"},{"buttonevent":2003,"eventtype":"long_release"},{"buttonevent":2004,"eventtype":"long_press"}]},{"repeatintervals":[800],"events":[{"buttonevent":3000,"eventtype":"initial_press"},{"buttonevent":3001,"eventtype":"repeat"},{"buttonevent":3002,"eventtype":"short_release"},{"buttonevent":3003,"eventtype":"long_release"},{"buttonevent":3004,"eventtype":"long_press"}]},{"repeatintervals":[800],"events":[{"buttonevent":4000,"eventtype":"initial_press"},{"buttonevent":4001,"eventtype":"repeat"},{"buttonevent":4002,"eventtype":"short_release"},{"buttonevent":4003,"eventtype":"long_release"},{"buttonevent":4004,"eventtype":"long_press"}]}]}}
+```
+
+## Common Action Keywords for Lights and Groups
 The most common action keywords for state or group are:
+
 on, bri, hue, sat, effect, xy, ct, alert, colormode, mode (lights only).
-More keywords exist, see the [API documentation](#api-documentation).
+
+For the full documentation of all keywords, see the [API documentation for lights](https://developers.meethue.com/develop/hue-api/lights-api/) and the [API documentation for groups](https://developers.meethue.com/develop/hue-api/groupds-api/).
 
 ## on (get and set)
 Turn a light on or off. On=true, Off=false.
@@ -226,7 +307,7 @@ The hue value to set the light to. The hue value is a wrapping value between 0 a
 Saturation of the light. 254 is the most saturated (colored) and 0 is the least saturated (white).
 
 ## xy (get and set)
-The xy values represent x and y coordinates of a color in CIE color space. The first value is the x coordinate and the second value is the y coordinate. Both x and y must be between 0 and 1, and will be rounded to 4 decimal places by the Hue bridge, eg: 0.666666 becomes 0.6667.
+The xy values represent x and y coordinates of a color in CIE color space. The first value is the x coordinate and the second value is the y coordinate. Both x and y must be between 0 and 1, and will be rounded to 4 decimal places by the Hue bridge, e.g.: 0.666666 becomes 0.6667.
 If the specified coordinates are not in the CIE color space, the closest color to the coordinates will be chosen.
 
 When sending the xy array, you **must** url encode the comma to %2c (or %2C). Here is an example for "xy":\[0.25,0.52\] :
@@ -273,17 +354,32 @@ Increments or decrements the value of the xy.  xy_inc is ignored if the xy attri
 Exact use unknown. Looks like it reflects an operating mode. Observed values are: homeautomation
 
 
-## Further commands
-See the [API documentation](#api-documentation).
+## Common Config Keywords for Sensors
+Sensors can have their state and config updated by the api. You can also update other parameters. 
+
+The state and config capabilities are dependent on the sensor type. The most common config keywords for sensors are:
+
+on, battery, reachable, alert, tholddark, tholdoffset, sensitivity, sensitivitymax, ledindication, usertest
+
+For the full documentation of all keywords, see the [API documentation for sensors](https://developers.meethue.com/develop/hue-api/5-sensors-api/).
+
+## on (get and set)
+Turn a sensor on or off. On=true, Off=false. This is the same as enabling or disabling the sensor in the Hue app.
+Valid for Daylight, Geofence, ZLLPresence, ZLLLightLevel, ZLLTemperature, ZLLSwitch and likely more.
+
+
+
 
 ## API Documentation
 For full details of the control capabilities, please see the [official Philips Hue API reference](https://developers.meethue.com/develop/hue-api/).
-An [alternative unoffical reference](http://www.burgestrand.se/hue-api/), somewhat outdated, also exists.
+
+An [alternative unofficial reference](http://www.burgestrand.se/hue-api/), somewhat outdated, also exists.
 
 
-# Finding your Light or Group ids
-You need to know the light id or the group id of the light or group you wish to control.
-Go to http://192.168.0.101:3000/api/yourPhilipsHueBridgeUsername/lights respectively http://192.168.0.101:3000/api/yourPhilipsHueBridgeUsername/groups. You will see a JSON responce that looks like this (truncated here for brevity, only lights is shown. Groups is similar):
+# Finding your Light, Group, Sensor or other Resource ids
+You need to know the id of the resource (light, group, sensor etc) that you wish to control.
+Ids can be either a numeric integer (generally starting at 0) or a string, depending on the resource.
+Go to http://192.168.0.101:3000/api/yourPhilipsHueBridgeUsername/resourcename. The resourcename is lights, groups, sensors, etc. You will see a JSON response that looks like this (truncated here for brevity, only lights is shown. Groups is similar):
 ```
 {"1":{"state":{"on":false,"bri":198,"hue":5360,"sat":192,"effect":"none","xy":[0.5330,0.3870],"ct":500," ...
 ```
@@ -291,11 +387,11 @@ Copy and paste the response into a text editor and format as JSON (or use an onl
 ```
 ... ,"type":"Extended color light","name":"Desk lamp","modelid":"LCT012", ...
 ```
-Go backwards in the text until you find the keyword **state**, this is at the start of the JSON text for the light. The light id is the number immediately before state. In this case, my light id is 31:
+Go backwards in the text until you find the keyword **state**, this is at the start of the JSON text for the light. The light id is the value immediately before state. In this case, my light id is 31:
 ```
 ... ,"31":{"state":{"on":true,"bri":100,"hue":65396 ...
 ```
 
-Use the same method for groups to find the group id of the room you wish to control. Note that group id 0 is a special group containing all lights in the system, and is not returned by the ‘get all groups’ command. Group 0 is not visible, and cannot be created, modified or deleted using the API, but group 0 can be controlled by the API.
+Use the same method for other resources groups to find the group id of the room you wish to control. Note that group id 0 is a special group containing all lights in the system, and is not returned by the ‘get all groups’ command. Group 0 is not visible, and cannot be created, modified or deleted using the API, but group 0 can be controlled by the API.
 
 

package/hueget.js

@@ -61,19 +61,35 @@ app.use('/api/' + options.username, (req, res) => {
     const resource  = (urlPathParts[1] || '').toLowerCase(); 
     const id  = urlPathParts[2]; 
     const command  = (urlPathParts[3] || '').toLowerCase(); 
-    //console.log('resource', resource );
-    //console.log('id', id );
-    //console.log('command', command );
+    var commandParts = command.split('?'); // split on ? if exists, the put command is the first array index
+    var putCommand = commandParts[0]; // the possible PUT command
+    /*
+    // Debug:
+    console.log('commandParts[0]', commandParts[0] );
+    console.log('commandParts[1]', commandParts[1] );
+    console.log('resource', resource );
+    console.log('id', id );
+    console.log('command', command );
+    console.log('putCommand', putCommand );
+    */
 
     // throw error if resource is not supported
-    if ( !((resource  == 'lights') || (resource  == 'groups')) ) {
-      throw errPrefix + 'unknown resource "' + resource + '", expecting "lights" or "groups": "' + req.url + '"';
+    // more resources added in v1.0.0
+    const supportedResources = ['lights','groups','schedules','scenes','sensors','rules','resourcelinks','capabilities'];
+    //console.log(JSON.stringify(supportedResources));
+    //console.log(resource, supportedResources.indexOf(resource));
+    if (supportedResources.indexOf(resource) < 0) {
+      throw errPrefix + 'unknown resource "' + resource + '", expecting one of ' + JSON.stringify(supportedResources).replace('[', '').replace(']', '').replace('"', '') + ': "' + req.url + '"';
     }
 
-    // get the id, throw error if not a number
-    if ( (isNaN((id || '')) || (id == '')) ){ throw errPrefix + 'id "' + id + '" is not an integer: "' + req.url + '"';}
+    // get the id, throw error if not a number only for resources that need a numeric id
+    const resourcesWithIdInteger = ['lights','groups','sensors','rules','schedules'];
+    if (resourcesWithIdInteger.indexOf(resource) > 0) {
+      if ( (isNaN((id || '')) || (id == '')) ){ throw errPrefix + 'id "' + id + '" is not an integer: "' + req.url + '"';}
+    }
 
     // throw error if unexpected quantity of url components
+    // supported quantity of url components: up to 3
     // allowed: 
     // /<resource>
     // /<resource>/<id>
@@ -82,45 +98,27 @@ app.use('/api/' + options.username, (req, res) => {
       throw errPrefix + (urlPathParts.length - 1).toString() + ' url path components found, expecting maximum 3: "' + req.url + '"';
     }
 
-    // throw error if unexpected command
-    // for lights  /lights/<id>/state  expectedCommand = state or nothing
-    // for groups, /groups/<id>/action expectedCommand = action or nothing
-    var expectedCommand;
-    if (urlPathParts.length > 3) {
-      switch(resource) {
-        case 'lights':
-          expectedCommand = 'state'
-          break;
-        case 'groups':
-          expectedCommand = 'action'
-          break;
-      }
-      //console.log('expectedCommand', expectedCommand );
-      // toggle is a special case, raise error for anything else that does not fit the syntax
-      if (command != 'toggle') {
-        if (!command.startsWith(expectedCommand)) { throw errPrefix + 'unknown command "' + command + '", expecting "' + expectedCommand + '": "' + req.url + '"'; }
-        if (!command.includes(expectedCommand + '?')) { throw errPrefix + 'query character "?" missing in "' + command + '", expecting "' + expectedCommand + '?<query>": "' + req.url + '"'; }
-        if (command.endsWith(expectedCommand + '?')) { throw errPrefix + 'query missing in "' + command + '", expecting "' + expectedCommand + '?<query>": "' + req.url + '"'; }
-      }
-    }
-
+    // DEPRECATED throw error if unexpected command DEPRECATED
+    // as of 1.0.0, do not test the commands, as they vary a lot.
+    // So allow the hue bridge to reject a command if incorrect.
 
-    // get the query parts, throw error if unexpected quantity
-    const urlQueryParts = req.url.split('?'); 
-    if ( (urlPathParts[0].toLowerCase() == expectedCommand) && (urlQueryParts.length != 2) ) { 
-      throw errPrefix + (urlQueryParts.length - 1).toString() + ' "?" delimiters found, expecting 1: "' + req.url + '"';
+    // throw error if unexpected quantity of ? delimiters
+    // get the commandParts parts, identified by the presence of a ? delimiter, throw error if unexpected quantity of delimiters exist
+    if ((commandParts.length > 1) && (commandParts.length != 2) ) { 
+        throw errPrefix + (commandParts.length - 1).toString() + ' "?" delimiters found, expecting 1: "' + req.url + '"';
     }
 
 
 
-    // if a query exists, split the query part [1] into name-value pairs on &, loop and construct a json result
+    // if a commandParts[1] (the parameters) exists, split the parameters into name-value pairs on &, loop and construct a json result
+    // the existance of a query part generates a dataObj, which determines whether a PUT or a GEt is used
     var dataObj;
-    if (urlQueryParts.length > 1){
+    if (commandParts.length > 1){
       var result = '{';
       errPrefix = 'url query syntax error, ';
-      urlQueryParts[1].split('&').forEach(function(nameValuePair) {
+      commandParts[1].split('&').forEach(function(nameValuePair) {
         
-        //console.log('nameValuePair', nameValuePair );
+        //console.log('nameValuePair', nameValuePair );}
 
         const pair = nameValuePair.split('=');
         if (pair.length != 2){ throw errPrefix + (pair.length - 1).toString() + ' "=" delimiters found, expecting 1: "' + nameValuePair + '"';}
@@ -152,34 +150,45 @@ app.use('/api/' + options.username, (req, res) => {
     // PUT http://192.168.0.101/api/<username>/lights/31/state --data "{""on"":true}"
     var url = 'http://' + options.ip + '/api/' + options.username + '/' + resource;
     if (id) { url = url + '/' + id; } // add id if supplied
+    
 
 
     // special handling for toggle command, this toggles a light or group state
+    // lights:  http://localhost:3000/api/<username>/lights/31/toggle
+    // groups:  http://localhost:3000/api/<username>/groups/0/toggle
+    // sensors: http://localhost:3000/api/<username>/sensors/15/toggle
     if (command == 'toggle') {
       console.log('toggling current state')
       // Get actual state
       console.log('sending GET: %s', url);
       axios.get(url)
         .then(response => {
-          // for lights  /lights/<id>  state = on     true/false
-          // for groups, /groups/<id>  state = all_on true/false
+          // for lights   /lights/<id>   state = on      true/false
+          // for groups,  /groups/<id>   state = all_on  true/false
+          // for sensors, /sensors/<id>  config = on     true/false
           switch(resource) {
             case 'lights':
               console.log('GET response:', response.status, response.statusText, "state:on="+response.data["state"]["on"]  );
               state = !response.data["state"]["on"] // get the current on state , as a boolean, and invert it
-              expectedCommand = 'state'
+              toggleCommand = 'state'
               break;
             case 'groups':
               console.log('GET response:', response.status, response.statusText, "state:all_on="+response.data["state"]["all_on"]  );
               state = !response.data["state"]["all_on"] // get the current all_on state, as a boolean, and invert it
-              expectedCommand = 'action'
+              toggleCommand = 'action'
+              break;
+            case 'sensors':
+              console.log('GET response:', response.status, response.statusText, "config:on="+response.data["config"]["on"]  );
+              state = !response.data["config"]["on"] // get the current on state, as a boolean, and invert it
+              toggleCommand = 'config'
               break;
-          }
+            }
           // toggle light or group state
-          // lights: http://localhost:3000/api/<username>/lights/31/state?on=true
-          // groups: http://localhost:3000/api/<username>/groups/0/action?on=true
+          // lights:  http://localhost:3000/api/<username>/lights/31/state?on=true
+          // groups:  http://localhost:3000/api/<username>/groups/0/action?on=true
+          // sensors: http://localhost:3000/api/<username>/sensors/15/config?on=true
           console.log('sending PUT: %s%s', url + '/' + "state?on=", state.toString() || '');
-          axios.put(url + '/' + expectedCommand,'{"on":' + state.toString() + '}')
+          axios.put(url + '/' + toggleCommand,'{"on":' + state.toString() + '}')
           .then(response => {
             console.log('PUT response:', response.status, response.statusText, JSON.stringify(response.data) );
             res.json(response.data);
@@ -200,8 +209,8 @@ app.use('/api/' + options.username, (req, res) => {
     // normal handling for non-toggle commands
     } else {    
       if (dataObj){
-        console.log('sending PUT: %s %s', url + '/' + expectedCommand, dataObj || '');
-        axios.put(url + '/' + expectedCommand, dataObj)
+        console.log('sending PUT: %s %s', url + '/' + putCommand, dataObj || '');
+        axios.put(url + '/' + putCommand, dataObj)
           .then(response => {
             console.log('PUT response:', response.status, response.statusText, JSON.stringify(response.data) );
             res.json(response.data);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hueget",
-  "version": "0.7.6",
-  "description": "A simple API that converts the Philips Hue API PUT to GET requests, allowing control of Philips Hue lights via http GET requests",
+  "version": "1.0.0",
+  "description": "A simple API that converts the Philips Hue API PUT to GET requests, allowing control of Philips Hue lights, groups, sensors and more via http GET requests",
   "main": "hueget.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"