README
¶
dishy
Package dishy provides an interface to manage a Starlink Dishy device over the network.
dishy command
The dishy command controls a dishy device over the network.
See the command documentation.
To install using the go tools:
go install olowe.co/dishy/cmd/dishy@latest
gRPC Code Generation
A starlink device supports gRPC server reflection. This is used to eventually generate code to interact with its gRPC service. Regenerating the code requires:
- grpcurl
- protoc
- connectivity to a Starlink Dishy's gRPC service listening on the default address (192.168.100.1:9200).
To regenerate the code:
go generate
This calls protoc.sh. For more information on protoc.sh, see the inline documentation in the script.
Documentation
¶
Index ¶
- Constants
- func WriteOpenMetrics(w io.Writer, status *device.DishGetStatusResponse) error
- type Client
- func (c *Client) Interfaces() ([]device.NetworkInterface, error)
- func (c *Client) Reboot() error
- func (c *Client) Status() (*device.DishGetStatusResponse, error)
- func (c *Client) Stow() error
- func (c *Client) TransceiverStat() (*device.TransceiverGetStatusResponse, error)
- func (c *Client) TransceiverTelemetry() (*device.TransceiverGetTelemetryResponse, error)
- func (c *Client) Unstow() error
Constants ¶
const ( DefaultDishyAddr = "192.168.100.1:9200" DefaultWifiAddr = "192.168.1.1:9000" )
Variables ¶
This section is empty.
Functions ¶
func WriteOpenMetrics ¶
func WriteOpenMetrics(w io.Writer, status *device.DishGetStatusResponse) error
WriteOpenMetrics writes any metrics found in status in OpenMetrics format to w for use in systems such as Prometheus and VictoriaMetrics.
Types ¶
type Client ¶
type Client struct {
// Timeout specifies a time limit for requests made by the
// client. A timeout of zero means no timeout.
Timeout time.Duration
// contains filtered or unexported fields
}
A Client is a high-level client to communicate with dishy over the network. A new Client must be created with Dial.
func Dial ¶
Dial returns a new Client connected to the dishy device at addr. Most callers should specify DefaultDishyAddr.
func (*Client) Interfaces ¶
func (c *Client) Interfaces() ([]device.NetworkInterface, error)
func (*Client) TransceiverStat ¶
func (c *Client) TransceiverStat() (*device.TransceiverGetStatusResponse, error)
func (*Client) TransceiverTelemetry ¶
func (c *Client) TransceiverTelemetry() (*device.TransceiverGetTelemetryResponse, error)
Source Files
Directories