shepless / neeo-api Goto Github PK

• 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

Find all brains connected to the local network

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

Class representing a NEEO Brain.

The brain name

Type: string

The brain host

Type: string

The brain port

Type: number

The brain API version

Type: string

Get system info.

Returns Promise

Make the LED blink

Returns Promise

Get all rooms

Returns Promise<Array<Room>>

Get all recipes

Returns Promise<Array<Recipe>>

Get all active recipes

Returns Promise<Array<Recipe>>

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

Delete the forward actions endpoint config

Returns Promise

Class representing a NEEO Recipe.

The brain this room belongs to

Type: NeeoBrain

The room name

Type: string

The room key

Type: string

The number of devices assigned to this room

Type: number

The devices assigned to this room

Type: Array<Device>

Get a device that belongs to this room

Parameters

• name string The name of the device to get

Returns Device The matched device

Class representing a NEEO Device.

The brain this device belongs to

Type: NeeoBrain

The name of the device

Type: string

The name of the room this device is assigned to

Type: string

The device type

Type: string

The device manufacturer name

Type: string

The device key

Type: string

The macros for this device

Type: Array<Macro>

Get a macro that belongs to this device

Parameters

• name string The name of the macro to get

Returns Macro

Class representing a NEEO Device Macro.

The brain this macro belongs to

Type: NeeoBrain

The macro name

Type: string

The macro key

Type: string

The macro label

Type: string

The device name this macro belongs to

Type: string

The device key this macro belongs to

Type: string

The room name this macro belongs to

Type: string

The room key this macro belongs to

Type: string

Trigger this macro on the brain

Returns Promise

Class representing a NEEO Recipe.

The brain this recipe belongs to

Type: NeeoBrain

The recipe key

Type: string

The recipe name

Type: string

The room key this recipe belongs to

Type: string

The room name this recipe belongs to

Type: string

The devices in this recipe

Type: Array<Device>

Get a device that belongs to this recipe

Parameters

• name string The name of the device to get

Returns Device The matched device

Power on the recipe

Returns Promise

Power off the recipe

Returns Promise