npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

neeo-api

v1.0.1

Published

API Wrapper For NEEO Brain API

Downloads

7

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

sheplessshepless

Keywords

Readme

Table of Contents

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