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
  • Get Rooms
  • Usage
  • Flags
  • Examples
  • Set Rooms
  • Usage
  • Flags
  • Examples

Was this helpful?

Edit on GitHub
Export as PDF
  1. CLI
  2. Commands

Rooms

Display and control the lights.

Get Rooms

Usage

openhue get room [roomId|roomName] [flags]

Aliases: room, rooms

Flags

Name
Shorthand
Default
Usage

json

j

false

Format output as JSON

Examples

# List all rooms as a table
openhue get room

# List all rooms as JSON
openhue get room --json

# Get details for a single room in JSON format
openhue get room aa31ba26-98a7-4830-8ae9-1b7caa8b5700 --json

# Get room by name
openhue get room Studio

Set Rooms

Usage

openhue set room [roomId] [flags]

Aliases: room, rooms

Flags

Name
Shorthand
Default
Usage

on

false

Turn on the light(s)

off

false

Turn off the light(s)

brightness

b

Set the brightness [min=0, max=100]

color

c

rgb

RGB hexadecimal value (example #CCE5FF)

cie-x

x

X coordinate in the CIE color space

cie-y

y

Y coordinate in the CIE color space

temperature

t

Color temperature in Mirek [min=153, max=500]

Examples

# Turn on a room
openhue set room 15f51223-1e83-4e48-9158-0c20dbd5734e --on

# Turn on multiple rooms
openhue set room 83111103-a3eb-40c5-b22a-02deedd21fcb 8f0a7b52-df25-4bc7-b94d-0dd1a88068ff --on

# Turn off a room identified by name
openhue set room Studio --off

# Set brightness of a single room
openhue set room 15f51223-1e83-4e48-9158-0c20dbd5734e --on --brightness 42.65

# Set color (in RGB) of a single room
openhue set room 15f51223-1e83-4e48-9158-0c20dbd5734e --on --rgb #3399FF

# Set color (in CIE space) of a single room
openhue set room 15f51223-1e83-4e48-9158-0c20dbd5734e --on -x 0.675 -y 0.322

# Set color (by name) of a single room
openhue set room 15f51223-1e83-4e48-9158-0c20dbd5734e --on --color powder_blue

# Set color temperature (in Mirek) of a single room
openhue set light Studio --on -t 250
PreviousLightsNextScenes

Last updated 1 year ago

Was this helpful?

Color name. See

💻
#available-colors