Structures

The following structures are available globally.


                    
                    
                    Auth

Declaration

Swift

public struct Auth

extension Auth: Codable

extension Auth: Fixture


                    
                    
                    AnimationData

Declaration

Swift

public struct AnimationData

extension AnimationData: Equatable

extension AnimationData: Codable

extension AnimationData: CustomStringConvertible


                    
                    
                    AnimationDataFrame

Declaration

Swift

public struct AnimationDataFrame

extension AnimationDataFrame: Equatable

extension AnimationDataFrame: CustomStringConvertible


                    
                    
                    Panel

Declaration

Swift

public struct Panel

extension Panel: Equatable

extension Panel: CustomStringConvertible


                    
                    
                    Effect

Declaration

Swift

public struct Effect

extension Effect: Codable


                    
                    
                    PaletteColor

Declaration

Swift

public struct PaletteColor

extension PaletteColor: Codable


                    
                    
                    LayoutDetails

Declaration

Swift

public struct LayoutDetails

extension LayoutDetails: Codable

extension LayoutDetails: Equatable

extension LayoutDetails: Fixture


                    
                    
                    Layout

Declaration

Swift

public struct Layout

extension Layout: Codable

extension Layout: Equatable

extension Layout: Fixture


                    
                    
                    PanelPosition

Declaration

Swift

public struct PanelPosition

extension PanelPosition: Codable

extension PanelPosition: Equatable

extension PanelPosition: Fixture


                    
                    
                    Device

Declaration

Swift

public struct Device

extension Device: Codable

extension Device: Equatable

extension Device: Fixture


                    
                    
                    EffectList

Declaration

Swift

public struct EffectList

extension EffectList: Codable

extension EffectList: Equatable

extension EffectList: Fixture


                    
                    
                    LightPanelCollectionState

Declaration

Swift

public struct LightPanelCollectionState

extension LightPanelCollectionState: Codable

extension LightPanelCollectionState: Equatable

extension LightPanelCollectionState: Fixture


                    
                    
                    Plugin

Declaration

Swift

public struct Plugin

extension Plugin: Codable

extension Plugin: Fixture


                    
                    
                    RangedValue

Declaration

Swift

public struct RangedValue<T> where T : Decodable, T : Encodable, T : Equatable

extension RangedValue: Codable

extension RangedValue: Equatable


                    
                    
                    Ryhthm

Declaration

Swift

public struct Ryhthm

extension Ryhthm: Codable

extension Ryhthm: Fixture


                    
                    
                    RyhthmPosition

Declaration

Swift

public struct RyhthmPosition

extension RyhthmPosition: Codable

extension RyhthmPosition: Fixture


                    
                    
                    APIError

Declaration

Swift

public struct APIError

extension APIError: LocalizedError

extension APIError: Codable

extension APIError: Equatable


                    
                    
                    Value

Declaration

Swift

public struct Value<T> where T : Decodable, T : Encodable, T : Equatable

extension Value: Codable

extension Value: Equatable


                    
                    
                    ValueRange

Declaration

Swift

public struct ValueRange<T> where T : Decodable, T : Encodable

extension ValueRange: Codable

AuthenticateRequest
Authenticate the user with a Nanoleaf device.

A user is authorized if they can demonstrate physical access to the device. This is achieved by holding the power button down for 5-7 seconds until the LED starts flashing in a pattern.

Once the LED starts flashing, execute this request within 30 seconds.
See more
Declaration
Swift

public struct AuthenticateRequest : HTTPRequest

Rename effect

Empty
Declaration
Swift

public struct Empty : Codable
ExecuteCommandRequest
Execute an effect command.

Use this request to:
- Add and update animations.
- Fetch an effect.
- Fetch all effects.
- Delete an effect.
- Display a preview of an effect.
- Rename an effect.
- Temporarily display an effect.
- Fetch plugins.
See more
Declaration
Swift

public struct ExecuteCommandRequest<T> : HTTPRequest where T : Decodable
FetchEffectsRequest
Fetch a list of effects.
See more
Declaration
Swift

public struct FetchEffectsRequest : HTTPRequest
FetchSelectedEffectRequest
Fetch the currently selected effect.
See more
Declaration
Swift

public struct FetchSelectedEffectRequest : HTTPRequest
UpdateSelectedEffectRequest
Select an effect.

Use FetchEffectsRequest to fetch a list of available effects.
See more
Declaration
Swift

public struct UpdateSelectedEffectRequest : HTTPRequest
FetchDeviceRequest
Fetch all information about a Nanoleaf device.
See more
Declaration
Swift

public struct FetchDeviceRequest : HTTPRequest
IdentifyPanelsRequest
Causes the panels to flash in unison. This is typically used to help users differentiate between multiple panels.
See more
Declaration
Swift

public struct IdentifyPanelsRequest : HTTPRequest
FetchGlobalOrientationRequest
Fetch a device’s global orientation.

The global orientation can be a value between 0 and 360.
See more
Declaration
Swift

public struct FetchGlobalOrientationRequest : HTTPRequest
FetchPanelLayoutRequest
Fetch a device’s panel layout.
See more
Declaration
Swift

public struct FetchPanelLayoutRequest : HTTPRequest
UpdatePanelLayoutRequest
Update a device’s panel layout.
See more
Declaration
Swift

public struct UpdatePanelLayoutRequest : HTTPRequest
FetchBrightnessRequest
Fetch a device’s brightness level.

A RangedValue is returned which will describe the current value and the maximum and minimum the value can be.
See more
Declaration
Swift

public struct FetchBrightnessRequest : HTTPRequest
FetchColorModeRequest
Fetch a device’s color mode.

A ColorMode is returned.
See more
Declaration
Swift

public struct FetchColorModeRequest : HTTPRequest
FetchColorTemperatureRequest
Fetch a device’s colour temperature.

A RangedValue is returned which will describe the current value and the maximum and minimum the value can be.
See more
Declaration
Swift

public struct FetchColorTemperatureRequest : HTTPRequest
FetchHueRequest
Fetch a device’s hue.

A RangedValue is returned which will describe the current value and the maximum and minimum the value can be.
See more
Declaration
Swift

public struct FetchHueRequest : HTTPRequest
FetchOnOffStateRequest
Fetch a device’s on/off state.

A Value<Bool> is returned.
See more
Declaration
Swift

public struct FetchOnOffStateRequest : HTTPRequest
FetchSaturationRequest
Fetch a device’s saturation.

A RangedValue is returned which will describe the current value and the maximum and minimum the value can be.
See more
Declaration
Swift

public struct FetchSaturationRequest : HTTPRequest
UpdateStateRequest
Update a device’s state.

This request can be used to update the device’s:
- On/off status.
- Brightness.
- Hue.
- Saturation.
- Color temperature.
See more
Declaration
Swift

public struct UpdateStateRequest : HTTPRequest

Ranged value mutation

ValueMutation
Value mutation.

This struct provides an abstrated way of building mutations for a device’s state.
See more
Declaration
Swift

public struct ValueMutation : Codable
DeviceAddress
A device’s address.

Use DeviceAddressResolver to resolve local a Nanoleaf devices address. Then use the resulting DeviceAddress to build requests.
See more
Declaration
Swift

public struct DeviceAddress : Codable, Equatable, Hashable

extension DeviceAddress: Fixture


                    
                    
                    DeviceIdentifier

A Nanoleaf device identifier.

Declaration

Swift

public struct DeviceIdentifier : Codable, Equatable, Hashable

extension DeviceIdentifier: Fixture