unifi

package module
v0.0.0-...-d890b74 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 13, 2025 License: MIT Imports: 5 Imported by: 0

README

Demonstration of leveraging the Unifi API

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type UnClients

type UnClients struct {
	Count float64 `json:"count"`
	Data  []struct {
		ConnectedAt    time.Time `json:"connectedAt"`
		ID             string    `json:"id"`
		IpAddress      string    `json:"ipAddress"`
		MacAddress     string    `json:"macAddress"`
		Name           string    `json:"name"`
		Type           string    `json:"type"`
		UplinkDeviceID string    `json:"uplinkDeviceId"`
	} `json:"data"`
	Limit      float64 `json:"limit"`
	Offset     float64 `json:"offset"`
	TotalCount float64 `json:"totalCount"`
}

type UnDeviceStats

type UnDeviceStats struct {
	CpuUtilizationPct    float64   `json:"cpuUtilizationPct"`
	Interfaces           struct{}  `json:"interfaces"`
	LastHeartbeatAt      time.Time `json:"lastHeartbeatAt"`
	LoadAverage15Min     float64   `json:"loadAverage15Min"`
	LoadAverage1Min      float64   `json:"loadAverage1Min"`
	LoadAverage5Min      float64   `json:"loadAverage5Min"`
	MemoryUtilizationPct float64   `json:"memoryUtilizationPct"`
	NextHeartbeatAt      time.Time `json:"nextHeartbeatAt"`
	Uplink               struct {
		RxRateBps float64 `json:"rxRateBps"`
		TxRateBps float64 `json:"txRateBps"`
	} `json:"uplink"`
	UptimeSec float64 `json:"uptimeSec"`
}

type UnDevices

type UnDevices struct {
	Count float64 `json:"count"`
	Data  []struct {
		Features   []string `json:"features"`
		ID         string   `json:"id"`
		Interfaces []string `json:"interfaces"`
		IpAddress  string   `json:"ipAddress"`
		MacAddress string   `json:"macAddress"`
		Model      string   `json:"model"`
		Name       string   `json:"name"`
		State      string   `json:"state"`
	} `json:"data"`
	Limit      float64 `json:"limit"`
	Offset     float64 `json:"offset"`
	TotalCount float64 `json:"totalCount"`
}

type UnSites

type UnSites struct {
	Count float64 `json:"count"`
	Data  []struct {
		ID   string `json:"id"`
		Name string `json:"name"`
	} `json:"data"`
	Limit      float64 `json:"limit"`
	Offset     float64 `json:"offset"`
	TotalCount float64 `json:"totalCount"`
}

type Unifi

type Unifi struct {
	Devices     UnDevices     // List of all devices from the hub
	DeviceStats UnDeviceStats // Stats for the last called device
	Clients     UnClients     // List of all scenes from the hub
	Sites       UnSites       // List of all scenes from the hub
	// contains filtered or unexported fields
}

func New

func New(URL string) *Unifi

func (*Unifi) Dump

func (pUn *Unifi) Dump()

func (*Unifi) GetClients

func (pUn *Unifi) GetClients(SiteID string, bSave bool) bool

func (*Unifi) GetDeviceStats

func (pUn *Unifi) GetDeviceStats(SiteID string, DeviceID string, bSave bool) bool

func (*Unifi) GetDevices

func (pUn *Unifi) GetDevices(SiteID string, bSave bool) bool

func (*Unifi) GetSites

func (pUn *Unifi) GetSites(bSave bool) bool

func (*Unifi) GetStructClients

func (pUn *Unifi) GetStructClients(SiteID string) bool

func (*Unifi) GetStructDeviceStats

func (pUn *Unifi) GetStructDeviceStats(SiteID string, DeviceID string) bool

func (*Unifi) GetStructDevices

func (pUn *Unifi) GetStructDevices(SiteID string) bool

func (*Unifi) GetStructSites

func (pUn *Unifi) GetStructSites() bool

func (*Unifi) GetStructs

func (pUn *Unifi) GetStructs() bool

func (*Unifi) ListDevices

func (pUn *Unifi) ListDevices(SiteID string) bool

func (*Unifi) ListSitesIDs

func (pUn *Unifi) ListSitesIDs() bool

func (*Unifi) SetApiKey

func (pUn *Unifi) SetApiKey(sApiKey string) bool

func (*Unifi) SetSiteId

func (pUn *Unifi) SetSiteId(sSiteId string) bool

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL