network

Documentation

Index

• Constants
• type InterfaceType
• type Network
• type NetworkInterface
• type NetworkProtocol

Constants

const (
	// DefaultName of the machine
	DefaultName = "My Duet"
	// DefaultHostName as fallback if Name is invalid
	DefaultHostName = "duet"
	// DefaultPassword of the machine
	DefaultPassword = "reprap"
)

const (
	// HTTP protocol
	HTTP NetworkProtocol = "http"
	// FTP protocol
	FTP = "ftp"
	// Telnet protocol
	Telnet = "telnet"
)

Types

type InterfaceType

type InterfaceType string

InterfaceType represents supported interface types

const (
	// WiFi is a wireless network interface
	WiFi InterfaceType = "wifi"
	// LAN is a wired network interface
	LAN = "lan"
)

type Network

type Network struct {
	// Hostname of the machine
	Hostname string `json:"hostname"`
	// Interfaces is a list of available network interfaces
	Interfaces []NetworkInterface `json:"interfaces"`
	// Name of the machine
	Name string `json:"name"`
}

Network holds information about the network subsytem

type NetworkInterface

type NetworkInterface struct {
	// ActiveProtocols is a list of active network protocols
	ActiveProtocols []NetworkProtocol `json:"activeProtocols"`
	// ActualIP tis the actual IPv4 address of the network adapter
	ActualIP string `json:"actualIP"`
	// ConfiguredIP is the IPv4 address of the network adapter
	ConfiguredIP string `json:"configuredIP"`
	// FirmwareVersion of the network interface (empty for unknonw)
	// This is primarily intended for the ESP8266-based network interfaces as used on the Duet WiFi
	FirmwareVersion string `json:"firmwareVersion"`
	// Gateway address for this network adapter
	Gateway string `json:"gateway"`
	// Mac address of the network adapter
	Mac string `json:"mac"`
	// NumReconnnects is the number of reconnect attempts
	NumReconnnects *int64 `json:"numReconnnects"`
	// Signal strength of the WiFi adapter (in dBm)
	Signal *int64 `json:"signal"`
	// Speed of the network interface (in MBit, nil if unknown, 0 if not connected)
	Speed *uint64 `json:"speed"`
	// Subnet mask of the network adapter
	Subnet string `json:"subnet"`
	// Type of this network interface
	Type InterfaceType `json:"type"`
}

NetworkInterface holds information about a network interface

type NetworkProtocol

type NetworkProtocol string

NetworkProtocol represents supported network protocols