apex

package module

v0.1.1 Latest Latest Go to latest Published: Feb 3, 2022 License: Apache-2.0 Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/reefassistant/apex

Links

Open Source Insights

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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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 ¶ added in v0.1.1

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.

Source Files ¶

View all Source files

client.go

Directories ¶

Path	Synopsis
client
private/v1alpha1
public/v1
example
test
e2e
simulator Apex Controller Simulator The simulator is currently a work in progress.	Apex Controller Simulator The simulator is currently a work in progress.
util

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