NanoLeaf <Local API>

Table of Contents

1. Getting Started
2. Setting your Environment
3. File Content

    .
    ├── ...
    ├── NanoLeaf Getting Started        # Folder
    │   ├── Add an API user             # POST | Create an API user
    ├── Basic                           # Folder
    │   └── Get controller info         # GET | Get controller info
    │   └── Turn on                     # PUT | Turn NanoLeaf on
    │   └── Turn off                    # PUT | Turn NanoLeaf off
    │   └── List Effects                # GET | List installed effects
    │   └── Activte Effect              # PUT | Activate an effect
    │   └── Identify                    # PUT | Identify your NanoLeaf
    ├── Auth                            # Folder 
    │   └── Delete user                 # DEL | Remove API user
    │   └── Add an API user             # POST | Create an API user
    ├── State                           # Folder 
    │   └── On/Off                      # GET | Get current state (On/Off)
    │   └── On/Off - update             # PUT | Update state (On/Off)
    │   └── Brightness                  # GET | Get the current brightness
    │   └── Brightness - update         # PUT | Update the brightness
    │   └── Hue                         # GET | Get the current Hue
    │   └── Hue - update                # PUT | Update the hue
    │   └── Saturation                  # GET | Get the current Saturation
    │   └── Saturation - update         # PUT | Update the Saturation
    │   └── Color Temperature           # GET | Get the current Color Temperature
    │   └── Color Temperature - update  # PUT | Update the Color Temperature
    │   └── Color Mode                  # GET | Get the current Color Mode
    ├── Effects                         # Folder
    │   └── Select                      # GET | Get current effect
    │   └── Select - update             # PUT | Update effect
    │   └── List                        # GET | Get the list of installed effects
    │   └── Write                       # PUT | write effect to NanoLeaf
    ├── Layout                          # Folder
    │   └── Global Orientation          # GET | Get orientation info
    │   └── Global Orientation - update # PUT | Update orientation info
    │   └── Layout                      # GET | Get the current layout
    ├── Rhythm                          # Folder 
    │   └── Rhythm connected            # GET | Get the rhythm connection info
    │   └── Rhythm active               # GET | Get the rhythm active status
    │   └── Rhythm id                   # GET | Get the rhythm id
    │   └── Hardware version            # GET | Get the hardware information
    │   └── Firmware version            # GET | Get the firmware information
    │   └── Aux available               # GET | Get the aux status
    │   └── Rhythm mode                 # GET | Get the rhythm mode
    │   └── Rhythm mode - update        # GET | Update the rhythm mode
    │   └── Rhythm position             # GET | Get the x,y position of the rhythm controller
    └── ...

Getting Started

• Import NanoLeaf JSON file
• Find the IP address of your NanoLeaf (MAC Address will always start with 00da ) and update your environment.

• Add an api user

  Add an API User

  A user is authorized to access the OpenAPI if they can demonstrate physical access of the Light Panels.

  Generate an authorization token

  1. On the Nanoleaf controller, hold the on-off button for 5-7 seconds until the LED starts flashing in a pattern.

  2. From the Postman app or your own app, send a POST request to the authorization endpoint within 30 seconds of activating pairing, like this (substituting the IP address and port for your central controller):

     http://xx.xx.xx.xx:16021/api/v1/new

     Finding your IP: The IP address of your Nanoleaf can be found using your router (MAC Address will always start with 00da ). Once you have the Nanoleaf connected to your WiFi, go to your router webpage and browse the devices connected to your network. Once you find your Nanoleaf, you can see the IP assigned to the device.

     Remember if you’re accessing the Nanoleaf at a local IP address, like when your router assigns a local IP address to the connected devices, both the Nanoleaf device and the client accessing the Nanoleaf (Postman) must be on the same local network. For example, both the Nanoleaf and laptop with Postman should be connected to the same WiFi network.

     The result returned will be a 32-character authorization token that you will use in all of your subsequent calls.

**Note:** In this request's test script, the auth token value will be set as an environment variable called `authToken`. If you already have an authorization token that you'd like to use, update your environment with the token.

Setting your Environment

• These examples will be from Insomnia API
• Base Environment {"ipAddress":"xx.xx.xx.xxL18021","authToken":"XXXXX"}

More updates coming soon