OpenHue
GitHubHue Developer Portal
  • OpenHue
  • ๐Ÿ“—API
    • OpenHue API
      • Authentication
      • Resource
      • Bridge
      • Home
      • Device
      • Light
      • Scene
      • Room
      • Zone
      • Sensors
  • ๐Ÿ’ปCLI
    • OpenHue CLI
    • Installation
    • Setup
    • Commands
      • Lights
      • Rooms
      • Scenes
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
Export as PDF
  1. API
  2. OpenHue API

Sensors

This page regroups the sensors-related APIs.

PreviousZoneNextOpenHue CLI

Last updated 1 year ago

Was this helpful?

Light Level

These are offered by devices with light level sensing capabilities.

Temperature

These are offered by devices with temperature sensing capabilities.

๐Ÿ“—

List light levels.

get

List all available light levels.

Authorizations
Responses
200
Light Level Success Response
application/json
Responseall of
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
405
Method Not Allowed
application/json
406
Not Acceptable
application/json
409
Conflict
application/json
429
Too Many Requests
application/json
500
Internal Server Error
application/json
503
Service Unavailable
application/json
507
Insufficient Storage
application/json
get
GET /clip/v2/resource/light_level HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*
{
  "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": true,
      "light": {
        "light_level": 1,
        "light_level_valid": true,
        "light_level_report": {
          "changed": "2025-05-14T21:25:54.228Z",
          "light_level": 1
        }
      }
    }
  ]
}

Get light

get

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

Authorizations
Path parameters
lightIdstringRequired

ID of the light

Responses
200
Light Level Success Response
application/json
Responseall of
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
405
Method Not Allowed
application/json
406
Not Acceptable
application/json
409
Conflict
application/json
429
Too Many Requests
application/json
500
Internal Server Error
application/json
503
Service Unavailable
application/json
507
Insufficient Storage
application/json
get
GET /clip/v2/resource/light_level/{lightId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*
{
  "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": true,
      "light": {
        "light_level": 1,
        "light_level_valid": true,
        "light_level_report": {
          "changed": "2025-05-14T21:25:54.228Z",
          "light_level": 1
        }
      }
    }
  ]
}

List temperatures

get

List all temperatures

Authorizations
Responses
200
Temperature Success Response
application/json
Responseall of
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
405
Method Not Allowed
application/json
406
Not Acceptable
application/json
409
Conflict
application/json
429
Too Many Requests
application/json
500
Internal Server Error
application/json
503
Service Unavailable
application/json
507
Insufficient Storage
application/json
get
GET /clip/v2/resource/temperature HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*
{
  "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": true,
      "temperature": {
        "temperature": 23,
        "temperature_valid": true,
        "temperature_report": {
          "changed": "2025-05-14T21:25:54.228Z",
          "temperature": 23
        }
      }
    }
  ]
}

Get temperature sensor information

get

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

Authorizations
Path parameters
temperatureIdstringRequired

ID of the temperature sensor

Responses
200
Temperature Success Response
application/json
Responseall of
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
405
Method Not Allowed
application/json
406
Not Acceptable
application/json
409
Conflict
application/json
429
Too Many Requests
application/json
500
Internal Server Error
application/json
503
Service Unavailable
application/json
507
Insufficient Storage
application/json
get
GET /clip/v2/resource/temperature/{temperatureId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*
{
  "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": true,
      "temperature": {
        "temperature": 23,
        "temperature_valid": true,
        "temperature_report": {
          "changed": "2025-05-14T21:25:54.228Z",
          "temperature": 23
        }
      }
    }
  ]
}
  • Light Level
  • GETList light levels.
  • GETGet light
  • PUTUpdate light
  • Temperature
  • GETList temperatures
  • GETGet temperature sensor information
  • PUTUpdate temperature sensor

Update light

put

Update a single light from its given {lightId}.

Authorizations
Path parameters
lightIdstringRequired

ID of the light

Body
typestringOptional

Type of the supported resources (always light_level here)

enabledbooleanOptional

true when sensor is activated, false when deactivated

Responses
200
Success
application/json
Responseall of
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
405
Method Not Allowed
application/json
406
Not Acceptable
application/json
409
Conflict
application/json
429
Too Many Requests
application/json
500
Internal Server Error
application/json
503
Service Unavailable
application/json
507
Insufficient Storage
application/json
put
PUT /clip/v2/resource/light_level/{lightId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

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

Update temperature sensor

put

Update a temperature sensor from its given {temperatureId}.

Authorizations
Path parameters
temperatureIdstringRequired

ID of the temperature sensor

Body
typestring ยท enumOptional

Type of the supported resources (always temperature here)

Possible values:
enabledbooleanOptional

true when sensor is activated, false when deactivated

Responses
200
Success
application/json
Responseall of
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
405
Method Not Allowed
application/json
406
Not Acceptable
application/json
409
Conflict
application/json
429
Too Many Requests
application/json
500
Internal Server Error
application/json
503
Service Unavailable
application/json
507
Insufficient Storage
application/json
put
PUT /clip/v2/resource/temperature/{temperatureId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

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