mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-22 08:46:51 +00:00
Add Nanoleaf Config Flow (#18349)
This commit is contained in:
parent
3581aa71bb
commit
acdac67593
@ -21,7 +21,6 @@ Home Assistant can discover and automatically configure [zeroconf](https://en.wi
|
||||
* [Linn / Openhome](/integrations/openhome)
|
||||
* [Logitech Harmony Hub](/integrations/harmony)
|
||||
* [Logitech Media Server (Squeezebox)](/integrations/squeezebox)
|
||||
* [Nanoleaf](/integrations/nanoleaf)
|
||||
* [NETGEAR routers](/integrations/netgear)
|
||||
* [Philips Hue](/integrations/hue)
|
||||
* [SABnzbd downloader](/integrations/sabnzbd)
|
||||
@ -76,7 +75,6 @@ Valid values for ignore are:
|
||||
* `frontier_silicon`: Frontier Silicon internet radios
|
||||
* `harmony`: Logitech Harmony Hub
|
||||
* `logitech_mediaserver`: Logitech Media Server (Squeezebox)
|
||||
* `nanoleaf_aurora`: Nanoleaf
|
||||
* `netgear_router`: NETGEAR routers
|
||||
* `octoprint`: Octoprint
|
||||
* `openhome`: Linn / Openhome
|
||||
|
@ -1,56 +1,22 @@
|
||||
---
|
||||
title: Nanoleaf
|
||||
description: Instructions how to integrate Nanoleaf Light Panels into Home Assistant.
|
||||
description: Instructions how to integrate Nanoleaf Panels into Home Assistant.
|
||||
ha_category:
|
||||
- Light
|
||||
ha_codeowners:
|
||||
- '@milanmeu'
|
||||
ha_config_flow: true
|
||||
ha_homekit: true
|
||||
ha_iot_class: Local Polling
|
||||
ha_release: 0.67
|
||||
ha_domain: nanoleaf
|
||||
ha_platforms:
|
||||
- light
|
||||
ha_zeroconf: true
|
||||
---
|
||||
|
||||
### Configuration Sample
|
||||
The Nanoleaf integration allows you to control and monitor Nanoleaf Light Panels, Canvas and Shapes.
|
||||
|
||||
The Nanoleaf integration allows you to control [Nanoleaf Light Panels](https://nanoleaf.me) 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.
|
||||
This integration does not support the Nanoleaf Remote and Essentials lights.
|
||||
|
||||
The preferred way to set up this platform is by enabling the [discovery component](/integrations/discovery/). 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:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
light:
|
||||
- platform: nanoleaf
|
||||
host: 192.168.1.10
|
||||
token: xxxxxxxxxxxxxxxxxxxxx
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
host:
|
||||
description: IP address or host-name of the device, e.g., 192.168.1.10.
|
||||
required: true
|
||||
type: string
|
||||
token:
|
||||
description: The *auth* token that you get via *POST* to */api/v1/new*
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: Name of the component, make this unique if you have multiple Light Panels
|
||||
required: false
|
||||
type: string
|
||||
default: Nanoleaf
|
||||
{% endconfiguration %}
|
||||
|
||||
### 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.](/integrations/light/) Of particular interest for Nanoleaf devices is using the `effect` in service calls, to choose the pattern/effect that the lights display.
|
||||
{% include integrations/config_flow.md %}
|
||||
|
Loading…
x
Reference in New Issue
Block a user