neeo-api

Table of Contents

• discoverBrains
• NeeoBrain
  • name
  • host
  • port
  • apiVersion
  • getSystemInfo
  • blink
  • getRooms
  • getRecipes
  • getActiveRecipes
  • setForwardActions
  • deleteForwardActions
• Room
  • brain
  • name
  • key
  • deviceCount
  • devices
  • getDevice
• Device
  • brain
  • name
  • roomName
  • type
  • manufacturer
  • key
  • macros
  • getMacro
• Macro
  • brain
  • name
  • key
  • label
  • deviceName
  • deviceKey
  • roomName
  • roomKey
  • trigger
• Recipe
  • brain
  • key
  • name
  • roomKey
  • roomName
  • devices
  • getDevice
  • powerOn
  • powerOff

discoverBrains

Find all brains connected to the local network

Returns Array<NeeoBrain> All discovered brains on the local network

NeeoBrain

Class representing a NEEO Brain.

name

The brain name

Type: string

host

The brain host

Type: string

port

The brain port

Type: number

apiVersion

The brain API version

Type: string

getSystemInfo

Get system info.

Returns Promise

blink

Make the LED blink

Returns Promise

getRooms

Get all rooms

Returns Promise<Array<Room>>

getRecipes

Get all recipes

Returns Promise<Array<Recipe>>

getActiveRecipes

Get all active recipes

Returns Promise<Array<Recipe>>

setForwardActions

Set the forward actions endpoint config

Parameters

• options Object The forward actions options
  • options.host string The forward actions server host
  • options.port string The forward actions server port
  • options.path string The forward actions server path (optional, default '/neeo')

Returns Promise

deleteForwardActions

Delete the forward actions endpoint config

Returns Promise

Room

Class representing a NEEO Recipe.

brain

The brain this room belongs to

Type: NeeoBrain

name

The room name

Type: string

key

The room key

Type: string

deviceCount

The number of devices assigned to this room

Type: number

devices

The devices assigned to this room

Type: Array<Device>

getDevice

Get a device that belongs to this room

Parameters

• name string The name of the device to get

Returns Device The matched device

Device

Class representing a NEEO Device.

brain

The brain this device belongs to

Type: NeeoBrain

name

The name of the device

Type: string

roomName

The name of the room this device is assigned to

Type: string

type

The device type

Type: string

manufacturer

The device manufacturer name

Type: string

key

The device key

Type: string

macros

The macros for this device

Type: Array<Macro>

getMacro

Get a macro that belongs to this device

Parameters

• name string The name of the macro to get

Returns Macro

Macro

Class representing a NEEO Device Macro.

brain

The brain this macro belongs to

Type: NeeoBrain

name

The macro name

Type: string

key

The macro key

Type: string

label

The macro label

Type: string

deviceName

The device name this macro belongs to

Type: string

deviceKey

The device key this macro belongs to

Type: string

roomName

The room name this macro belongs to

Type: string

roomKey

The room key this macro belongs to

Type: string

trigger

Trigger this macro on the brain

Returns Promise

Recipe

Class representing a NEEO Recipe.

brain

The brain this recipe belongs to

Type: NeeoBrain

key

The recipe key

Type: string

name

The recipe name

Type: string

roomKey

The room key this recipe belongs to

Type: string

roomName

The room name this recipe belongs to

Type: string

devices

The devices in this recipe

Type: Array<Device>

getDevice

Get a device that belongs to this recipe

Parameters

• name string The name of the device to get

Returns Device The matched device

powerOn

Power on the recipe

Returns Promise

powerOff

Power off the recipe

Returns Promise