Skip to content

Updated Nanoleaf plugin Readme with better directions #1609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
miniman13 wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Updated Nanoleaf plugin Readme with better directions #1609

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
a289764
Updated Readme with better directions
miniman13 Jan 22, 2020
3fa1f3f
Merge branch 'master' into patch-1
peternewman Jan 30, 2020
5565388
Fixed spelling errors, etc
miniman13 Feb 3, 2020
72a6459
Fixed Spacing
miniman13 Feb 3, 2020
3b3b076
Fix some line wrap issues
peternewman Feb 17, 2020
2b1010a
Merge branch 'master' into patch-1
peternewman Feb 17, 2020
abf9f14
Merge branch 'master' into patch-1
peternewman Feb 18, 2020
f3801f7
Merge branch 'master' into patch-1
peternewman Mar 30, 2020
19e158e
Merge branch 'master' into patch-1
peternewman Jun 7, 2020
b9628c7
Merge branch 'master' into patch-1
peternewman Jul 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions plugins/nanoleaf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,13 @@ This plugin uses the streaming external control effects functionality of
the Aurora OpenAPI.

Currently only the [Nanoleaf
Aurora](https://nanoleaf.me/en/consumer-led-lighting/products/
smarter-series/nanoleaf-light-panels-smarter-kit/)
Aurora](https://nanoleaf.me/en/products/smarter-series/nanoleaf-light-panels-smarter-kit/)
is supported.

The Nanoleaf Aurora must be in "ExternalStreaming" mode UDP Enabled via
Nanoleaf API:

`{"write": { "command": "display", "animType": "extControl" }}`

## Config file: `ola-nanoleaf.conf`

Expand All @@ -24,5 +27,6 @@ one controller by adding multiple `controller =` lines
The port to stream to on the controller, range is 1 - 65535.

`<controller IP>-panels = [int]`
The list of panel IDs to control, each panel is mapped to three DMX512 slots
(for Red, Green and Blue).
The list of panel IDs to control, each panel is mapped to three DMX512
slots (for Red, Green and Blue).
Panel IDs are comma separated eg: `321,789,123`

@peternewman peternewman Jul 28, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've just noticed off the back of #1730 these example values are invalid for the v1 protocol. We'd want say (to show order is irrelevant):

Suggested change
Panel IDs are comma separated eg: `321,789,123`
Panel IDs are comma separated eg: `132,178,54`