device

Documentation

Index

• Constants
• type Manager
  • func (m Manager) Status(ctx context.Context) ([]Status, error)
  • func (m Manager) WiFiConnect(ctx context.Context, BSSID string, args WiFiConnectOptions) (string, error)
  • func (m Manager) WiFiList(ctx context.Context, args WiFiListOptions) ([]WiFi, error)
• type Status
• type WiFi
• type WiFiConnectOptions
• type WiFiConnectOptionsHidden
• type WiFiConnectOptionsPrivate
• type WiFiConnectOptionsWEPKeyType
• type WiFiListOptions
• type WiFiListOptionsRescan

Constants

const (
	WiFiConnectOptionsWEPKeyTypeKey    WiFiConnectOptionsWEPKeyType = "key"
	WiFiConnectOptionsWEPKeyTypePhrase WiFiConnectOptionsWEPKeyType = "phrase"
	WiFiConnectOptionsPrivateYes       WiFiConnectOptionsPrivate    = "yes"
	WiFiConnectOptionsPrivateNo        WiFiConnectOptionsPrivate    = "no"
	WiFiConnectOptionsHiddenYes        WiFiConnectOptionsHidden     = "yes"
	WiFiConnectOptionsHiddenNo         WiFiConnectOptionsHidden     = "no"
)

Types

type Manager

type Manager struct {
	CommandContext func(ctx context.Context, name string, args ...string) utils.Cmd
}

func (Manager) Status

func (m Manager) Status(ctx context.Context) ([]Status, error)

Status lists the status for all devices.

func (Manager) WiFiConnect

func (m Manager) WiFiConnect(ctx context.Context, BSSID string, args WiFiConnectOptions) (string, error)

WiFiConnect Connect to a Wi-Fi network specified by BSSID which could also be a SSID. The command finds a matching connection or creates one and then activates it on a device. This is a command-line counterpart of clicking an SSID in a GUI client. If a connection for the network already exists, it is possible to bring up the existing profile as follows: nmcli con up id <name>. Note that only open, WEP and WPA-PSK networks are supported if no previous connection exists. It is also assumed that IP configuration is obtained via DHCP.

func (Manager) WiFiList

func (m Manager) WiFiList(ctx context.Context, args WiFiListOptions) ([]WiFi, error)

WiFiList list available Wi-Fi access points. The IfName and BSSID options can be used to list APs for a particular interface, or with a specific BSSID. The Rescan flag tells whether a new Wi-Fi scan should be triggered.

type Status

type Status struct {
	Device          string
	Type            string
	State           string
	IP4Connectivity string
	IP6Connectivity string
	DbusPath        string
	Connection      string
	ConUUID         string
	ConPath         string
}

type WiFi

type WiFi struct {
	Name      string
	SSID      string
	SSIDHEX   string
	BSSID     string
	Mode      string
	Chan      string
	Frequency string
	Rate      string
	Signal    string
	Bars      string
	Security  string
	WPAFlags  string
	RSNFlags  string
	Device    string
	Active    string
	InUse     string
	DBusPath  string
}

type WiFiConnectOptions

type WiFiConnectOptions struct {
	Password   string
	WEPKeyType WiFiConnectOptionsWEPKeyType
	IfName     string
	BSSID      string
	Name       string
	Private    WiFiConnectOptionsPrivate
	Hidden     WiFiConnectOptionsHidden
}

type WiFiConnectOptionsHidden

type WiFiConnectOptionsHidden string

type WiFiConnectOptionsPrivate

type WiFiConnectOptionsPrivate string

type WiFiConnectOptionsWEPKeyType

type WiFiConnectOptionsWEPKeyType string

type WiFiListOptions

type WiFiListOptions struct {
	IfName string
	BSSID  string
	Rescan WiFiListOptionsRescan
}

type WiFiListOptionsRescan

type WiFiListOptionsRescan string

const (
	WiFiListOptionsRescanAuto WiFiListOptionsRescan = "auto"
	WiFiListOptionsRescanYes  WiFiListOptionsRescan = "yes"
	WiFiListOptionsRescanNo   WiFiListOptionsRescan = "no"
)