unpoller_unpoller/core/unifi
David Newhall II 78cf4e282a Convert rxbytes in USG to FlexInt 2019-05-30 11:00:09 -07:00
..
.gitignore Add dep constraints. 2019-01-23 23:50:59 -08:00
Gopkg.lock Use new influx db lib path. Make Points() work with an interface. 2019-01-26 12:33:18 -08:00
Gopkg.toml Use new influx db lib path. Make Points() work with an interface. 2019-01-26 12:33:18 -08:00
LICENSE fix license again. 2019-01-26 15:52:41 -08:00
README.md FlexBool it up 2019-04-17 02:38:57 -07:00
clients_influx.go FlexBool it up 2019-04-17 02:38:57 -07:00
clients_type.go FlexBool it up 2019-04-17 02:38:57 -07:00
parsers.go a little more cleanup 2019-04-17 02:06:06 -07:00
types.go Re-arrange 2019-04-17 00:21:24 -07:00
types_test.go Re-arrange 2019-04-17 00:21:24 -07:00
uap_influx.go Avoid field errors. Fix influxdb regressions. 2019-05-30 01:45:02 -07:00
uap_type.go FlexBool it up 2019-04-17 02:38:57 -07:00
unifi.go Rename the init func. 2019-04-17 01:15:22 -07:00
unifi_test.go Rename the init func. 2019-04-17 01:15:22 -07:00
usg_influx.go Convert rxbytes in USG to FlexInt 2019-05-30 11:00:09 -07:00
usg_type.go Convert rxbytes in USG to FlexInt 2019-05-30 11:00:09 -07:00
usw_influx.go Avoid field errors. Fix influxdb regressions. 2019-05-30 01:45:02 -07:00
usw_type.go Avoid field errors. Fix influxdb regressions. 2019-05-30 01:45:02 -07:00

README.md

Go Library: unifi

It connects to a Unifi Controller, given a url, username and password. Returns an authenticated http Client you may use to query the device for data. Also contains some built-in methods for de-serializing common client and device data. The data is provided in a large struct you can consume in your application.

This library also contains methods to export the Unifi data in InfluxDB format, and this can be used as an example to base your own metrics collection methods.

If more features are requested, I'll certainly consider them. Do you need to do more than just collect data? Let me know! Pull requests and feedback are welcomed!

Here's a working example:

package main

import "log"
import "github.com/golift/unifi"

func main() {
	username := "admin"
	password := "superSecret1234"
	URL := "https://127.0.0.1:8443/"
	uni, err := unifi.NewUnifi(username, password, URL, false)
	if err != nil {
		log.Fatalln("Error:", err)
	}
	// Log with log.Printf or make your own interface that accepts (msg, fmt)
	uni.ErrorLog = log.Printf
	uni.DebugLog = log.Printf

	sites, err := uni.GetSites()
	if err != nil {
		log.Fatalln("Error:", err)
	}
	clients, err := uni.GetClients(sites)
	if err != nil {
		log.Fatalln("Error:", err)
	}
	devices, err := uni.GetDevices(sites)
	if err != nil {
		log.Fatalln("Error:", err)
	}

	log.Println(len(sites), "Unifi Sites Found: ", sites)
	log.Println(len(clients.UCLs), "Clients connected:")
	for i, client := range clients.UCLs {
		log.Println(i+1, client.ID, client.Hostname, client.IP, client.Name, client.LastSeen)
	}

	log.Println(len(devices.USWs), "Unifi Switches Found")
	log.Println(len(devices.USGs), "Unifi Gateways Found")

	log.Println(len(devices.UAPs), "Unifi Wireless APs Found:")
	for i, uap := range devices.UAPs {
		log.Println(i+1, uap.Name, uap.IP)
	}
}