You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Refresh plugin description, tags, and compatibility (Python >=3.9, OctoPrint >=1.8.0)
- Replace outdated screenshots with 4 new ones covering the full setup flow
- Replace Featured-Image.png with updated event lighting screenshot
- Rewrite body content to reflect v2 CLIP API, guided pairing, combined
light/group dropdown, CT mode, night mode, smart plug, and API table
- Remove stale TODO section and outdated setup instructions
Copy file name to clipboardExpand all lines: _plugins/octohue.md
+56-41Lines changed: 56 additions & 41 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,86 +3,101 @@ layout: plugin
3
3
4
4
id: octohue
5
5
title: OctoHue
6
-
description: Hue lighting control for Octoprint - Illuminate your printer and signal its status using Phillips Hue lights
7
-
author: Simon Beckett
6
+
description: Illuminate your 3D printer and signal its status using Philips Hue lights. Supports event-driven colour changes, CT mode for white-spectrum bulbs, night mode, smart plug auto power-off, and guided in-settings bridge pairing.
# You only need the following if your plugin requires specific OctoPrint versions or
39
-
# specific operating systems to function - you can safely remove the whole
40
-
# "compatibility" block if this is not the case.
41
-
42
45
compatibility:
46
+
octoprint:
47
+
- 1.8.0
43
48
44
-
python: ">=2.7,<4"
49
+
os:
50
+
- linux
51
+
- windows
52
+
- macos
53
+
- freebsd
54
+
55
+
python: ">=3.9"
45
56
46
57
---
47
58
48
59
# OctoPrint-OctoHue
49
60
50
-
Illuminate your print job and signal its status using a Philips Hue light.
61
+
Illuminate your 3D print job and signal its status using Philips Hue lights — and optionally cut power to your printer automatically once it cools down.
51
62
52
63
## Features
53
-
* Light on and off in coordination with the connection between Octoprint and your printer
54
-
* Configure "Connected" light colour using colour picker or HTML hex colour codes
55
-
* Customisable default brightness
56
-
* Available Customisable Statuses:
57
-
* Connected - Default White
58
-
* Print Finished - Default Green
59
-
* Error - Default Red
60
64
61
-
See the TODO list at the end of this page for features on the roadmap
65
+
-**Event-driven lighting** — map any OctoPrint event (Connected, PrintStarted, PrintDone, PrintFailed, etc.) to a specific colour or colour temperature, brightness, optional delay, flash alert, and on/off state
66
+
-**CT mode** — switch any event to colour-temperature mode for RGBCCT lights, activating the white channel instead of the RGB LEDs
67
+
-**Configurable toggle colour** — the navbar toggle button turns your light on with a dedicated colour, CT value, and brightness you configure
68
+
-**Night mode** — define a time window during which light changes are paused entirely, or brightness is capped at a configurable maximum
69
+
-**Smart plug control** — configure a Hue smart plug to cut printer power after a completed print
70
+
-**Auto power-off** — automatically switch off the plug once all extruders cool below a configurable temperature threshold
71
+
-**Guided bridge pairing** — find your Hue bridge on the network and pair it without leaving OctoPrint settings; after pairing, a single button takes you straight to the Lights tab
72
+
-**Navbar toggle** — optional toolbar button to toggle your lights on/off at any time
73
+
-**Group support** — target individual lights or Hue rooms/zones from a single combined dropdown
74
+
-**Configurable delay** — add a delay (in seconds) before each event triggers its light change
75
+
-**API** — `getstate`, `turnon`, `turnoff`, `togglehue`, `getdevices`, `getgroups`, and `cooldown` commands for third-party integrations
62
76
63
77
## Setup
64
78
65
-
Install via the bundled [Plugin Manager](https://github.com/foosel/OctoPrint/wiki/Plugin:-Plugin-Manager)
66
-
or manually using this URL:
79
+
### 1. Bridge pairing
80
+
81
+
Open OctoPrint **Settings → OctoHue → Bridge**.
82
+
83
+
- Click **Find My Bridge** to locate your Hue bridge automatically on your local network.
84
+
- Once found, press the **physical button on top of your Hue bridge**, then click **Start Pairing** within 30 seconds.
85
+
- After a successful pairing, click **Select your light →** to jump straight to the Lights tab with your devices already populated.
86
+
87
+
> If auto-discovery does not work (e.g. the bridge is on a different subnet), you can enter the bridge IP address and API key manually after pairing via the [Hue Getting Started guide](https://developers.meethue.com/develop/get-started-2/).
On the **Lights** tab, select your light or group from the dropdown. Individual lights and Hue rooms/zones appear in the same list — groups are labelled **(Group)**. Set **Default Brightness** (1–100%) to control brightness when an event does not specify its own.
71
92
72
-
Octohue requires 3 settings to function
73
-
1. The IP Address of you Hue Bridge
74
-
2. A User for octoprint to use when contacting your bridge
75
-
3. The numberic ID of your Hue light.
93
+
### 3. Event configuration
76
94
77
-
Steps to find or configure these can be found in [How to Develop for Hue - Getting Started](https://developers.meethue.com/develop/get-started-2/)
95
+
Still on the **Lights** tab, expand **Event Lighting Options** to configure which OctoPrint events trigger a light change. For each event you can set colour (RGB or CT), brightness (1–100%), delay, flash, and turn-off behaviour.
78
96
79
-
##Configuration
97
+
### 4. Power control (optional)
80
98
81
-
Once you have the Hue IP, Username, and Light ID, enter these into the appropriate field in Octohues menu in settings.
99
+
Open the **Power** tab to select a Hue smart plug and configure auto power-off after prints complete.
OctoHue exposes a [SimpleAPI](https://docs.octoprint.org/en/master/plugins/mixins.html#octoprint.plugin.SimpleApiPlugin) for third-party integrations. Light-control commands (`turnon`, `turnoff`, `togglehue`, `cooldown`) are accessible without authentication; device and bridge commands require OctoPrint admin access.
0 commit comments