Sensors

This page regroups the sensors-related APIs.

Light Level

These are offered by devices with light level sensing capabilities.

List light levels.

List all available light levels.

GEThttps://192.168.1.0/clip/v2/resource/light_level

Authorization

HueApplicationKey

Response

200401403404405406409429500503507

Light Level Success Response

Body

application/json

errorsarray of Error (object)

dataarray of object

dataarray of LightLevelGet (object)

Request

JavaScriptCurl

const response = await fetch('https://192.168.1.0/clip/v2/resource/light_level', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "type": "light",
      "id": "3883f8bf-30a3-445b-ac06-b047d50599df",
      "id_v1": "/lights/8",
      "owner": {
        "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
        "rtype": "device"
      },
      "enabled": false,
      "light": {
        "light_level_valid": false,
        "light_level_report": {
          "changed": "2024-05-08T20:50:36.186Z"
        }
      }
    }
  ]
}

Get light

Get details of a single light from its given {lightId}.

GEThttps://192.168.1.0/clip/v2/resource/light_level/{lightId}

Authorization

HueApplicationKey

Path parameters

lightId*string

ID of the light

Response

200401403404405406409429500503507

Light Level Success Response

Body

application/json

errorsarray of Error (object)

dataarray of object

dataarray of LightLevelGet (object)

Request

JavaScriptCurl

const response = await fetch('https://192.168.1.0/clip/v2/resource/light_level/{lightId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "type": "light",
      "id": "3883f8bf-30a3-445b-ac06-b047d50599df",
      "id_v1": "/lights/8",
      "owner": {
        "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
        "rtype": "device"
      },
      "enabled": false,
      "light": {
        "light_level_valid": false,
        "light_level_report": {
          "changed": "2024-05-08T20:50:36.186Z"
        }
      }
    }
  ]
}

Update light

Update a single light from its given {lightId}.

PUThttps://192.168.1.0/clip/v2/resource/light_level/{lightId}

Authorization

HueApplicationKey

Path parameters

lightId*string

ID of the light

Body

application/json

typestring

Type of the supported resources (always light_level here)

enabledboolean

true when sensor is activated, false when deactivated

Response

200401403404405406409429500503507

Success

Body

application/json

errorsarray of Error (object)

dataarray of object

dataarray of ResourceIdentifier (object)

Request

JavaScriptCurl

const response = await fetch('https://192.168.1.0/clip/v2/resource/light_level/{lightId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "enabled": true
    }),
});
const data = await response.json();

Response

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
      "rtype": "device"
    }
  ]
}

Temperature

These are offered by devices with temperature sensing capabilities.

List temperatures

List all temperatures

GEThttps://192.168.1.0/clip/v2/resource/temperature

Authorization

HueApplicationKey

Response

200401403404405406409429500503507

Temperature Success Response

Body

application/json

errorsarray of Error (object)

dataarray of object

dataarray of TemperatureGet (object)

Request

JavaScriptCurl

const response = await fetch('https://192.168.1.0/clip/v2/resource/temperature', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "type": "light",
      "id": "3883f8bf-30a3-445b-ac06-b047d50599df",
      "id_v1": "/lights/8",
      "owner": {
        "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
        "rtype": "device"
      },
      "enabled": false,
      "temperature": {
        "temperature": 23,
        "temperature_valid": false,
        "temperature_report": {
          "changed": "2024-05-08T20:50:36.186Z",
          "temperature": 23
        }
      }
    }
  ]
}

Get temperature sensor information

Get details of a single temperature sensor from its given {temperatureId}.

GEThttps://192.168.1.0/clip/v2/resource/temperature/{temperatureId}

Authorization

HueApplicationKey

Path parameters

temperatureId*string

ID of the temperature sensor

Response

200401403404405406409429500503507

Temperature Success Response

Body

application/json

errorsarray of Error (object)

dataarray of object

dataarray of TemperatureGet (object)

Request

JavaScriptCurl

const response = await fetch('https://192.168.1.0/clip/v2/resource/temperature/{temperatureId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "type": "light",
      "id": "3883f8bf-30a3-445b-ac06-b047d50599df",
      "id_v1": "/lights/8",
      "owner": {
        "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
        "rtype": "device"
      },
      "enabled": false,
      "temperature": {
        "temperature": 23,
        "temperature_valid": false,
        "temperature_report": {
          "changed": "2024-05-08T20:50:36.186Z",
          "temperature": 23
        }
      }
    }
  ]
}

Update temperature sensor

Update a temperature sensor from its given {temperatureId}.

PUThttps://192.168.1.0/clip/v2/resource/temperature/{temperatureId}

Authorization

HueApplicationKey

Path parameters

temperatureId*string

ID of the temperature sensor

Body

application/json

typeenum

Type of the supported resources (always temperature here)

temperature

enabledboolean

true when sensor is activated, false when deactivated

Response

200401403404405406409429500503507

Success

Body

application/json

errorsarray of Error (object)

dataarray of object

dataarray of ResourceIdentifier (object)

Request

JavaScriptCurl

const response = await fetch('https://192.168.1.0/clip/v2/resource/temperature/{temperatureId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "enabled": true
    }),
});
const data = await response.json();

Response

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
      "rtype": "device"
    }
  ]
}