client

README

UniFi Go Client

A Go client for the Ubiquiti UniFi Controller.

• Requirements
• Contributing
• License

Requirements

• Go v1.13+

Contributing

The UniFi Controller client is not feature complete, so help is greatly appreciated. See the contribution guidelines for details.

License

The UniFi Controller client is licensed under the BSD 3-Clause License.

Documentation

Index

• func ReadResponse(r io.Reader) (json.RawMessage, error)
• type Client
  • func New(opts ...option.ClientOption) (*Client, error)
• type Error
  • func (e *Error) Error() string

Functions

func ReadResponse

func ReadResponse(r io.Reader) (json.RawMessage, error)

ReadResponse reads a JSON response.

Types

type Client

type Client struct {
	Endpoint string
	// contains filtered or unexported fields
}

Client represents a UniFi client connection.

func New

func New(opts ...option.ClientOption) (*Client, error)

New creates a new client.

type Error

type Error struct {
	// contains filtered or unexported fields
}

Error represents an API error.

func (*Error) Error

func (e *Error) Error() string

Error returns a formatted error.