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

@oddbit/unifi

v2.0.1

Published

Unifi API client library

Downloads

7

Readme

@oddbit/unifi

npm version npm

An easy to use and Typscript friendly API client for managing UBNT UniFi accesspoints.

The UniFi API is officially not very well documented, the project started out from this shell script but I've found that the source code of the PHP project UniFi-API-browser is the best API documentation at the moment. Thanks guys!

Actions

The following actions are supported.

  • Authorization
    • Login
    • Logout
  • Clients (STA/connected devices)
    • Reconnect client
    • List clients
    • Get client
    • Block client
    • Unblock client
    • Set or remove client alias
    • Set or remove client notes
  • Hotspot guest access
    • Authorize guest
    • Unauthorize guest
    • List vouchers
    • Create vouchers
    • Delete vouchers
  • System
    • Get UniFi controller system info
    • List sites
    • List access points with device info
    • List sessions

How to use it

Below is a simple example of synchronous communication with the UniFI controller to authorize a guest (device) at the hotspot.

Basic

The basics of how to create a controller reference and login / logout.

import * as unifi from "@oddbit/unifi";

const controller = new unifi.UnifiController({
    host: "10.11.12.13",
    isSelfSigned: true,
    siteName: "default"
});

await controller.login("admin", "secretPassword");
// ...
// Work with the controller
// ...
await controller.logout();

Discovering controller information

In some cases it can be good to first look up information about the site and update configuration accordingly. This is a sample of fetching the site names and setting to a non-default value

const sites = await controller.listSites();
sites.forEach(site => {
    if (site.name !== "default") {
        controller.setSite(site.name);
    }
})

Authorizing a guest to connect through the hotspot

The first parameter is the MAC of the connecting device. This is captured by the hotspot and passed to your portal page in the page redirection.

const clientMac = "00:11:22:33:44:55";
const accessPointMac = "66:77:88:99:aa:bb";
const authResponse = await controller.authorizeGuest(clientMac, accessPointMac);