Home Assistant Home Assistant

Nanoleaf

Configuration Sample

The Nanoleaf integration allows you to control Nanoleaf Light Panels from Home Assistant. Note that for full control of Nanoleaf devices, particularly effects, make sure they are set up as instructed on this page and not as a HomeKit device.

The preferred way to set up this platform is by enabling the discovery component. Make sure to press and hold the ON button for 5 seconds (the LED will start flashing) on your Nanoleaf Lights while Home Assistant is starting.

To configure the Nanoleaf lights manually, add the following lines to your configuration.yaml file:

# Example configuration.yaml entry
light:
  - platform: nanoleaf
    host: 192.168.1.10
    token: xxxxxxxxxxxxxxxxxxxxx

Configuration Variables

host string Required

IP address or host-name of the device, e.g., 192.168.1.10.

token string Required

The auth token that you get via POST to /api/v1/new

name string (Optional, default: Nanoleaf)

Name of the component, make this unique if you have multiple Light Panels

Getting The Auth Token

  1. Make sure that your Nanoleaf Light Panel is fully patched (as of the time of writing the latest version was 3.0.8 for Aurora and 1.2.0 for Canvas)
  2. Hold down the ON button on the Panel for 5 seconds; the LED will start flashing
  3. Issue a POST request to the API endpoint, e.g., via $ curl -i -X POST http://192.168.1.155:16021/api/v1/new
  4. The output should include the auth token like {“auth_token”:“xxxxxxxxxxxxxxxxxxxxx”}, copy the resulting token into your configuration

If you get a 403 Forbidden message, you probably did not press the ON button long enough. The time-frame to get a valid token is only 30 seconds, so you have to be quick to issue the curl request.

Using the Nanoleaf Device

The Nanoleaf device is a standard light, so can be used with standard Home Assistant Light services for automations and scripts. For full details see the Light Integrations Page. Of particular interest for Nanoleaf devices is using the effect in service calls, to choose the pattern/effect that the lights display.