apex

README

Neptune Apex Go API Client

This package provides a Go API client to interface with your Neptune Apex aquarium controller over your local network.

⚠ This API client is not designed nor to be used against Apex Fusion !

Documentation

See documentation for more details.

Trademarks

This software is provided "as is" and is not affiliated with Neptune Systems, LLC. Apex, Apex Lite, Apex Jr. and AquaController are registered trademarks of Neptune Systems, LLC.

Documentation

Index

• type Client
  • func NewClient(url string, cfg ClientConfig) (*Client, error)
  • func NewDefaultClient(url string) (*Client, error)
  • func (c *Client) PrivateV1() *privatev1.APIClient
  • func (c *Client) PublicV1() *publicv1.APIClient
• type ClientConfig

Types

type Client

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

Client is a local Apex API client.

func NewClient

func NewClient(url string, cfg ClientConfig) (*Client, error)

NewClient creates a new local Apex Client using given configuration.

func NewDefaultClient

func NewDefaultClient(url string) (*Client, error)

NewDefaultClient creates a new local Apex Client using defaults.

func (*Client) PrivateV1

func (c *Client) PrivateV1() *privatev1.APIClient

PrivateV1 manages communication with the Apex Private API v1.

func (*Client) PublicV1

func (c *Client) PublicV1() *publicv1.APIClient

PublicV1 manages communication with the Apex Public API v1.

type ClientConfig

type ClientConfig struct {
	HTTPClient *http.Client
	UserAgent  string
	Debug      bool
}

ClientConfig stores the configuration of the API client.