profile

package
v0.0.0-...-c022866 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 4, 2026 License: Apache-2.0 Imports: 8 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	BootOrderSource_name = map[int32]string{
		0: "BOOT_ORDER_SOURCE_UNSPECIFIED",
		1: "BOOT_ORDER_SOURCE_LPS",
		2: "BOOT_ORDER_SOURCE_CONTROLLER",
		3: "BOOT_ORDER_SOURCE_DEVICE_PROPERTY",
	}
	BootOrderSource_value = map[string]int32{
		"BOOT_ORDER_SOURCE_UNSPECIFIED":     0,
		"BOOT_ORDER_SOURCE_LPS":             1,
		"BOOT_ORDER_SOURCE_CONTROLLER":      2,
		"BOOT_ORDER_SOURCE_DEVICE_PROPERTY": 3,
	}
)

Enum value maps for BootOrderSource.

View Source
var (
	AppCommand_Command_name = map[int32]string{
		0: "COMMAND_UNSPECIFIED",
		1: "COMMAND_RESTART",
		2: "COMMAND_PURGE",
	}
	AppCommand_Command_value = map[string]int32{
		"COMMAND_UNSPECIFIED": 0,
		"COMMAND_RESTART":     1,
		"COMMAND_PURGE":       2,
	}
)

Enum value maps for AppCommand_Command.

View Source
var (
	LocalDevCmd_Command_name = map[int32]string{
		0: "COMMAND_UNSPECIFIED",
		1: "COMMAND_SHUTDOWN",
		2: "COMMAND_GRACEFUL_POWEROFF",

		3: "COMMAND_GRACEFUL_REBOOT",
		4: "COMMAND_COLLECT_INFO",
	}
	LocalDevCmd_Command_value = map[string]int32{
		"COMMAND_UNSPECIFIED":       0,
		"COMMAND_SHUTDOWN":          1,
		"COMMAND_GRACEFUL_POWEROFF": 2,
		"COMMAND_SHUTDOWN_POWEROFF": 2,
		"COMMAND_GRACEFUL_REBOOT":   3,
		"COMMAND_COLLECT_INFO":      4,
	}
)

Enum value maps for LocalDevCmd_Command.

View Source
var (
	IPVersion_name = map[int32]string{
		0: "IP_VERSION_UNSPECIFIED",
		1: "IP_VERSION_DUAL_STACK",
		2: "IP_VERSION_IPV4_ONLY",
		3: "IP_VERSION_IPV6_ONLY",
	}
	IPVersion_value = map[string]int32{
		"IP_VERSION_UNSPECIFIED": 0,
		"IP_VERSION_DUAL_STACK":  1,
		"IP_VERSION_IPV4_ONLY":   2,
		"IP_VERSION_IPV6_ONLY":   3,
	}
)

Enum value maps for IPVersion.

View Source
var (
	WirelessType_name = map[int32]string{
		0: "WIRELESS_TYPE_UNSPECIFIED",
		1: "WIRELESS_TYPE_CELLULAR",
		2: "WIRELESS_TYPE_WIFI",
	}
	WirelessType_value = map[string]int32{
		"WIRELESS_TYPE_UNSPECIFIED": 0,
		"WIRELESS_TYPE_CELLULAR":    1,
		"WIRELESS_TYPE_WIFI":        2,
	}
)

Enum value maps for WirelessType.

View Source
var (
	ConfigEndpoint_name = map[int32]string{
		0: "CONFIG_ENDPOINT_UNSPECIFIED",
		1: "CONFIG_ENDPOINT_LOCAL_PROFILE",
		2: "CONFIG_ENDPOINT_RADIO",
		3: "CONFIG_ENDPOINT_APP_INFO",
		4: "CONFIG_ENDPOINT_APP_BOOT_INFO",
		5: "CONFIG_ENDPOINT_DEV_INFO",
		6: "CONFIG_ENDPOINT_NETWORK",
	}
	ConfigEndpoint_value = map[string]int32{
		"CONFIG_ENDPOINT_UNSPECIFIED":   0,
		"CONFIG_ENDPOINT_LOCAL_PROFILE": 1,
		"CONFIG_ENDPOINT_RADIO":         2,
		"CONFIG_ENDPOINT_APP_INFO":      3,
		"CONFIG_ENDPOINT_APP_BOOT_INFO": 4,
		"CONFIG_ENDPOINT_DEV_INFO":      5,
		"CONFIG_ENDPOINT_NETWORK":       6,
	}
)

Enum value maps for ConfigEndpoint.

View Source
var File_profile_local_profile_proto protoreflect.FileDescriptor
View Source
var File_profile_network_proto protoreflect.FileDescriptor
View Source
var File_profile_signal_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type AppBootConfig

type AppBootConfig struct {

	// Reference the application by its ID (UUID). At least one of id/displayname must be set.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Reference the application by its user-friendly displayname.
	Displayname string `protobuf:"bytes,2,opt,name=displayname,proto3" json:"displayname,omitempty"`
	// USB boot mode for this application.
	// See org.lfedge.eve.common.BootOrder enum for available values.
	UsbBoot evecommon.BootOrder `protobuf:"varint,3,opt,name=usb_boot,json=usbBoot,proto3,enum=org.lfedge.eve.common.BootOrder" json:"usb_boot,omitempty"`
	// contains filtered or unexported fields
}

AppBootConfig contains boot configuration for a single application instance. This message is part of the AppBootConfigList returned by LPS in response to POST /api/v1/appbootinfo.

func (*AppBootConfig) Descriptor deprecated

func (*AppBootConfig) Descriptor() ([]byte, []int)

Deprecated: Use AppBootConfig.ProtoReflect.Descriptor instead.

func (*AppBootConfig) GetDisplayname

func (x *AppBootConfig) GetDisplayname() string

func (*AppBootConfig) GetId

func (x *AppBootConfig) GetId() string

func (*AppBootConfig) GetUsbBoot

func (x *AppBootConfig) GetUsbBoot() evecommon.BootOrder

func (*AppBootConfig) ProtoMessage

func (*AppBootConfig) ProtoMessage()

func (*AppBootConfig) ProtoReflect

func (x *AppBootConfig) ProtoReflect() protoreflect.Message

func (*AppBootConfig) Reset

func (x *AppBootConfig) Reset()

func (*AppBootConfig) String

func (x *AppBootConfig) String() string

type AppBootConfigList

type AppBootConfigList struct {
	ServerToken string           `protobuf:"bytes,1,opt,name=server_token,json=serverToken,proto3" json:"server_token,omitempty"`
	AppConfigs  []*AppBootConfig `protobuf:"bytes,2,rep,name=app_configs,json=appConfigs,proto3" json:"app_configs,omitempty"`
	// contains filtered or unexported fields
}

AppBootConfigList contains boot configurations for applications. Returned by LPS in response to POST /api/v1/appbootinfo (when status code is 200). EVE posts AppBootInfoList with current boot status, LPS responds with this config.

Persistence behavior: EVE caches and persists the received configuration to disk. This is needed to handle EVE reboots: since LPS runs as a VM on the same device, it's unavailable until EVE and the LPS VM come back up. The persisted cache ensures boot order settings are applied immediately when VMs start.

  • LPS unavailable (during EVE boot): Cache preserved, persisted config applied.
  • HTTP 404: Cache cleared; all apps reset to default. This means "LPS has no config for this device" - fall back to Controller/Device settings.
  • HTTP 204: Cache preserved (no changes requested).
  • HTTP 200 with apps: Cache updated. Apps in response get new values; apps NOT in response are removed from cache and reset to default.
  • HTTP 200 with empty app_configs: Cache cleared; all apps reset to default.

Key: LPS unavailable preserves cache; 404 clears cache.

func (*AppBootConfigList) Descriptor deprecated

func (*AppBootConfigList) Descriptor() ([]byte, []int)

Deprecated: Use AppBootConfigList.ProtoReflect.Descriptor instead.

func (*AppBootConfigList) GetAppConfigs

func (x *AppBootConfigList) GetAppConfigs() []*AppBootConfig

func (*AppBootConfigList) GetServerToken

func (x *AppBootConfigList) GetServerToken() string

func (*AppBootConfigList) ProtoMessage

func (*AppBootConfigList) ProtoMessage()

func (*AppBootConfigList) ProtoReflect

func (x *AppBootConfigList) ProtoReflect() protoreflect.Message

func (*AppBootConfigList) Reset

func (x *AppBootConfigList) Reset()

func (*AppBootConfigList) String

func (x *AppBootConfigList) String() string

type AppBootInfo

type AppBootInfo struct {

	// Application UUID.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// User-friendly application display name.
	Displayname string `protobuf:"bytes,2,opt,name=displayname,proto3" json:"displayname,omitempty"`
	// The effective boot order applied to this application.
	// This is the result of merging LPS, Controller, and Device Property settings.
	BootOrder evecommon.BootOrder `` /* 126-byte string literal not displayed */
	// Which configuration source determined the effective boot order.
	Source BootOrderSource `protobuf:"varint,4,opt,name=source,proto3,enum=org.lfedge.eve.profile.BootOrderSource" json:"source,omitempty"`
	// contains filtered or unexported fields
}

AppBootInfo contains the effective boot order and its source for a single application instance. This is published by EVE to LPS via POST /api/v1/appbootinfo.

func (*AppBootInfo) Descriptor deprecated

func (*AppBootInfo) Descriptor() ([]byte, []int)

Deprecated: Use AppBootInfo.ProtoReflect.Descriptor instead.

func (*AppBootInfo) GetBootOrder

func (x *AppBootInfo) GetBootOrder() evecommon.BootOrder

func (*AppBootInfo) GetDisplayname

func (x *AppBootInfo) GetDisplayname() string

func (*AppBootInfo) GetId

func (x *AppBootInfo) GetId() string

func (*AppBootInfo) GetSource

func (x *AppBootInfo) GetSource() BootOrderSource

func (*AppBootInfo) ProtoMessage

func (*AppBootInfo) ProtoMessage()

func (*AppBootInfo) ProtoReflect

func (x *AppBootInfo) ProtoReflect() protoreflect.Message

func (*AppBootInfo) Reset

func (x *AppBootInfo) Reset()

func (*AppBootInfo) String

func (x *AppBootInfo) String() string

type AppBootInfoList

type AppBootInfoList struct {

	// List of boot information for all application instances.
	AppsBootInfo []*AppBootInfo `protobuf:"bytes,1,rep,name=apps_boot_info,json=appsBootInfo,proto3" json:"apps_boot_info,omitempty"`
	// contains filtered or unexported fields
}

AppBootInfoList is sent by EVE to LPS via POST /api/v1/appbootinfo. This allows LPS to display the effective boot order and its source for each application, helping operators understand which configuration "won" when multiple sources (LPS, Controller API, Device Property) are configured.

LPS responds with AppBootConfigList containing new boot configurations: - HTTP 200: Response contains AppBootConfigList with new config to apply. - HTTP 204: No changes; EVE preserves current cached config. - HTTP 404: Not implemented or no config for this device; cache cleared.

func (*AppBootInfoList) Descriptor deprecated

func (*AppBootInfoList) Descriptor() ([]byte, []int)

Deprecated: Use AppBootInfoList.ProtoReflect.Descriptor instead.

func (*AppBootInfoList) GetAppsBootInfo

func (x *AppBootInfoList) GetAppsBootInfo() []*AppBootInfo

func (*AppBootInfoList) ProtoMessage

func (*AppBootInfoList) ProtoMessage()

func (*AppBootInfoList) ProtoReflect

func (x *AppBootInfoList) ProtoReflect() protoreflect.Message

func (*AppBootInfoList) Reset

func (x *AppBootInfoList) Reset()

func (*AppBootInfoList) String

func (x *AppBootInfoList) String() string

type AppCommand

type AppCommand struct {

	// Reference the application instance by its ID (which is an instance of UUID).
	// At least one of the id and displayname should be defined.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Reference the application instance by the user-friendly displayname.
	// At least one of the id and displayname should be defined.
	Displayname string `protobuf:"bytes,2,opt,name=displayname,proto3" json:"displayname,omitempty"`
	// Timestamp to record when the request to run the command was made.
	// The format of the timestamp is not defined. It can be a Unix timestamp
	// or a different time representation. It is not even required for the timestamp
	// to match the real time or to be in-sync with the device clock.
	// What is required, however, is that two successive but distinct requests made
	// for the same application will have different timestamps attached.
	// This requirement applies even between restarts of the Local profile server.
	// A request made after a restart should not have the same timestamp attached
	// as the previous request made for the same application before the restart.
	//
	// EVE guarantees that a newly added command request or a change of the timestamp
	// will result in the command being triggered ASAP. Even if the execution of a command
	// is interrupted by a device reboot/crash, the eventuality of the command completion
	// is still guaranteed. The only exception is if Local Profile Server restarts/crashes
	// shortly after a request is made, in which case it can get lost before EVE is able
	// to receive it. For this scenario to be avoided, a persistence of command requests
	// on the side of the Local Profile server is necessary.
	Timestamp uint64 `protobuf:"varint,3,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// Command to run.
	Command AppCommand_Command `protobuf:"varint,4,opt,name=command,proto3,enum=org.lfedge.eve.profile.AppCommand_Command" json:"command,omitempty"`
	// contains filtered or unexported fields
}

AppCommand references a running application instance by UUID and/or displayname, and describes a command to execute for this instance.

func (*AppCommand) Descriptor deprecated

func (*AppCommand) Descriptor() ([]byte, []int)

Deprecated: Use AppCommand.ProtoReflect.Descriptor instead.

func (*AppCommand) GetCommand

func (x *AppCommand) GetCommand() AppCommand_Command

func (*AppCommand) GetDisplayname

func (x *AppCommand) GetDisplayname() string

func (*AppCommand) GetId

func (x *AppCommand) GetId() string

func (*AppCommand) GetTimestamp

func (x *AppCommand) GetTimestamp() uint64

func (*AppCommand) ProtoMessage

func (*AppCommand) ProtoMessage()

func (*AppCommand) ProtoReflect

func (x *AppCommand) ProtoReflect() protoreflect.Message

func (*AppCommand) Reset

func (x *AppCommand) Reset()

func (*AppCommand) String

func (x *AppCommand) String() string

type AppCommand_Command

type AppCommand_Command int32
const (
	AppCommand_COMMAND_UNSPECIFIED AppCommand_Command = 0
	// Application instance, which is either running or transitioning to a running state,
	// will be stopped and subsequently started again, preserving the mutated run time state.
	AppCommand_COMMAND_RESTART AppCommand_Command = 1
	// Application instance, which is either running or transitioning to a running state,
	// will be stopped and the mutated run time state of the app is deleted.
	// A subsequent action to start the app will start it with a pristine runtime state.
	// This command will purge ALL volumes used by the application.
	AppCommand_COMMAND_PURGE AppCommand_Command = 2
)

func (AppCommand_Command) Descriptor

func (AppCommand_Command) Enum

func (AppCommand_Command) EnumDescriptor deprecated

func (AppCommand_Command) EnumDescriptor() ([]byte, []int)

Deprecated: Use AppCommand_Command.Descriptor instead.

func (AppCommand_Command) Number

func (AppCommand_Command) String

func (x AppCommand_Command) String() string

func (AppCommand_Command) Type

type BootOrderSource

type BootOrderSource int32

BootOrderSource indicates which configuration source determined the effective boot order for an application. This is published by EVE to LPS via the POST /api/v1/appbootinfo endpoint to help operators understand which setting "won" when multiple sources are configured.

const (
	// Default/unspecified - no explicit boot order was configured from any source.
	BootOrderSource_BOOT_ORDER_SOURCE_UNSPECIFIED BootOrderSource = 0
	// Boot order was set by the Local Profile Server (LPS) via /api/v1/appbootinfo.
	// This is the highest priority source.
	BootOrderSource_BOOT_ORDER_SOURCE_LPS BootOrderSource = 1
	// Boot order was set by the Controller API via VmConfig.boot_order.
	// Used when LPS does not specify a value.
	BootOrderSource_BOOT_ORDER_SOURCE_CONTROLLER BootOrderSource = 2
	// Boot order was set by the device property app.boot.order.
	// Used when neither LPS nor Controller specifies a value.
	BootOrderSource_BOOT_ORDER_SOURCE_DEVICE_PROPERTY BootOrderSource = 3
)

func (BootOrderSource) Descriptor

func (BootOrderSource) Enum

func (x BootOrderSource) Enum() *BootOrderSource

func (BootOrderSource) EnumDescriptor deprecated

func (BootOrderSource) EnumDescriptor() ([]byte, []int)

Deprecated: Use BootOrderSource.Descriptor instead.

func (BootOrderSource) Number

func (BootOrderSource) String

func (x BootOrderSource) String() string

func (BootOrderSource) Type

type CellularConfig

type CellularConfig struct {

	// Access Point Name (APN) for the default bearer. Defaults to "internet".
	Apn string `protobuf:"bytes,1,opt,name=apn,proto3" json:"apn,omitempty"`
	// APN used for the attach (initial) bearer.
	// Optional. If omitted, EVE will skip submitting attach bearer configuration
	// to the modem, allowing the modem to fall back to its internal/default profiles.
	AttachApn string `protobuf:"bytes,2,opt,name=attach_apn,json=attachApn,proto3" json:"attach_apn,omitempty"`
	// IP address type for the default bearer.
	IpType evecommon.CellularIPType `protobuf:"varint,3,opt,name=ip_type,json=ipType,proto3,enum=org.lfedge.eve.common.CellularIPType" json:"ip_type,omitempty"`
	// IP address type for the attach bearer. Ignored if attach_apn is not set.
	AttachIpType evecommon.CellularIPType `` /* 142-byte string literal not displayed */
	// SIM card slot to activate (single-standby only).
	// 0 = unspecified (keep the current);
	// 1 = activate the first SIM slot;
	// 2 = activate the second SIM slot;
	// etc.
	ActivateSimSlot uint32 `protobuf:"varint,5,opt,name=activate_sim_slot,json=activateSimSlot,proto3" json:"activate_sim_slot,omitempty"`
	// If true, then modem will avoid connecting to networks with roaming.
	ForbidRoaming bool `protobuf:"varint,6,opt,name=forbid_roaming,json=forbidRoaming,proto3" json:"forbid_roaming,omitempty"`
	// Authentication settings for the default bearer.
	DefaultBearerAuth *CellularNetworkAuth `protobuf:"bytes,7,opt,name=default_bearer_auth,json=defaultBearerAuth,proto3" json:"default_bearer_auth,omitempty"`
	// Authentication settings for the attach bearer.
	AttachBearerAuth *CellularNetworkAuth `protobuf:"bytes,8,opt,name=attach_bearer_auth,json=attachBearerAuth,proto3" json:"attach_bearer_auth,omitempty"`
	// Optional cellular connectivity probing.
	// By default it is enabled.
	Probe *CellularConnectivityProbe `protobuf:"bytes,9,opt,name=probe,proto3" json:"probe,omitempty"`
	// Some LTE modems have GNSS receiver integrated and can be used for device
	// location tracking.
	// Enable this option to have location info periodically obtained from this
	// modem and published to controller and to applications.
	LocationTracking bool `protobuf:"varint,10,opt,name=location_tracking,json=locationTracking,proto3" json:"location_tracking,omitempty"`
	// contains filtered or unexported fields
}

Configuration details specific to a cellular modem.

func (*CellularConfig) Descriptor deprecated

func (*CellularConfig) Descriptor() ([]byte, []int)

Deprecated: Use CellularConfig.ProtoReflect.Descriptor instead.

func (*CellularConfig) GetActivateSimSlot

func (x *CellularConfig) GetActivateSimSlot() uint32

func (*CellularConfig) GetApn

func (x *CellularConfig) GetApn() string

func (*CellularConfig) GetAttachApn

func (x *CellularConfig) GetAttachApn() string

func (*CellularConfig) GetAttachBearerAuth

func (x *CellularConfig) GetAttachBearerAuth() *CellularNetworkAuth

func (*CellularConfig) GetAttachIpType

func (x *CellularConfig) GetAttachIpType() evecommon.CellularIPType

func (*CellularConfig) GetDefaultBearerAuth

func (x *CellularConfig) GetDefaultBearerAuth() *CellularNetworkAuth

func (*CellularConfig) GetForbidRoaming

func (x *CellularConfig) GetForbidRoaming() bool

func (*CellularConfig) GetIpType

func (x *CellularConfig) GetIpType() evecommon.CellularIPType

func (*CellularConfig) GetLocationTracking

func (x *CellularConfig) GetLocationTracking() bool

func (*CellularConfig) GetProbe

func (*CellularConfig) ProtoMessage

func (*CellularConfig) ProtoMessage()

func (*CellularConfig) ProtoReflect

func (x *CellularConfig) ProtoReflect() protoreflect.Message

func (*CellularConfig) Reset

func (x *CellularConfig) Reset()

func (*CellularConfig) String

func (x *CellularConfig) String() string

type CellularConnectivityProbe

type CellularConnectivityProbe struct {

	// If true, then probing is disabled.
	Disable bool `protobuf:"varint,1,opt,name=disable,proto3" json:"disable,omitempty"`
	// User-defined probe for cellular connectivity testing.
	// Only IP address is allowed as ConnectivityProbe.probe_address (and port if needed),
	// not hostname.
	// The probing algorithm is more complex that just testing reachability of a remote
	// endpoint and the goal is to minimize generated traffic, probing time and false negatives
	// (that would trigger undesired re-connect).
	// EVE will periodically check the modem status, accessibility of DNS server(s) and potentially
	// also proxies in the local network, and only as the last resort (if connectivity state
	// is still unclear) it will probe the remote endpoint. If custom_probe is not defined,
	// EVE will try to ping "8.8.8.8" (Google public DNS).
	// It is recommended to use custom probe for private LTE networks where public DNS servers
	// might not be allowed by the firewall (and hence ping would fail even with a working
	// connectivity).
	CustomProbe *evecommon.ConnectivityProbe `protobuf:"bytes,3,opt,name=custom_probe,json=customProbe,proto3" json:"custom_probe,omitempty"`
	// contains filtered or unexported fields
}

CellularConnectivityProbe is used to periodically check the connectivity status of a cellular network by probing a remote endpoint. Whenever the probe fails, the cellular connection is automatically restarted.

func (*CellularConnectivityProbe) Descriptor deprecated

func (*CellularConnectivityProbe) Descriptor() ([]byte, []int)

Deprecated: Use CellularConnectivityProbe.ProtoReflect.Descriptor instead.

func (*CellularConnectivityProbe) GetCustomProbe

func (*CellularConnectivityProbe) GetDisable

func (x *CellularConnectivityProbe) GetDisable() bool

func (*CellularConnectivityProbe) ProtoMessage

func (*CellularConnectivityProbe) ProtoMessage()

func (*CellularConnectivityProbe) ProtoReflect

func (*CellularConnectivityProbe) Reset

func (x *CellularConnectivityProbe) Reset()

func (*CellularConnectivityProbe) String

func (x *CellularConnectivityProbe) String() string

type CellularNetworkAuth

type CellularNetworkAuth struct {

	// Authentication protocol used for cellular network access.
	AuthProtocol evecommon.CellularAuthProtocol `` /* 146-byte string literal not displayed */
	// Username is not published in NetworkInfo but may be set in LocalNetworkConfig.
	Username string `protobuf:"bytes,2,opt,name=username,proto3" json:"username,omitempty"`
	// Password is not published in NetworkInfo but may be set in LocalNetworkConfig.
	Password string `protobuf:"bytes,3,opt,name=password,proto3" json:"password,omitempty"`
	// contains filtered or unexported fields
}

CellularNetworkAuth defines the authentication credentials and protocol used to connect to a cellular network. It includes sensitive information such as username and password, which are not published to LPS in status reports but can be configured by LPS via network configuration updates.

func (*CellularNetworkAuth) Descriptor deprecated

func (*CellularNetworkAuth) Descriptor() ([]byte, []int)

Deprecated: Use CellularNetworkAuth.ProtoReflect.Descriptor instead.

func (*CellularNetworkAuth) GetAuthProtocol

func (x *CellularNetworkAuth) GetAuthProtocol() evecommon.CellularAuthProtocol

func (*CellularNetworkAuth) GetPassword

func (x *CellularNetworkAuth) GetPassword() string

func (*CellularNetworkAuth) GetUsername

func (x *CellularNetworkAuth) GetUsername() string

func (*CellularNetworkAuth) ProtoMessage

func (*CellularNetworkAuth) ProtoMessage()

func (*CellularNetworkAuth) ProtoReflect

func (x *CellularNetworkAuth) ProtoReflect() protoreflect.Message

func (*CellularNetworkAuth) Reset

func (x *CellularNetworkAuth) Reset()

func (*CellularNetworkAuth) String

func (x *CellularNetworkAuth) String() string

type CellularStatus

type CellularStatus struct {

	// Logical label assigned to the physical cellular modem.
	Logicallabel string                    `protobuf:"bytes,1,opt,name=logicallabel,proto3" json:"logicallabel,omitempty"`
	Module       *info.ZCellularModuleInfo `protobuf:"bytes,2,opt,name=module,proto3" json:"module,omitempty"`
	SimCards     []*info.ZSimcardInfo      `protobuf:"bytes,3,rep,name=sim_cards,json=simCards,proto3" json:"sim_cards,omitempty"`
	Providers    []*info.ZCellularProvider `protobuf:"bytes,4,rep,name=providers,proto3" json:"providers,omitempty"`
	ConfigError  string                    `protobuf:"bytes,10,opt,name=config_error,json=configError,proto3" json:"config_error,omitempty"`
	ProbeError   string                    `protobuf:"bytes,11,opt,name=probe_error,json=probeError,proto3" json:"probe_error,omitempty"`
	// contains filtered or unexported fields
}

CellularStatus contains status information for a single LTE network.

func (*CellularStatus) Descriptor deprecated

func (*CellularStatus) Descriptor() ([]byte, []int)

Deprecated: Use CellularStatus.ProtoReflect.Descriptor instead.

func (*CellularStatus) GetConfigError

func (x *CellularStatus) GetConfigError() string

func (*CellularStatus) GetLogicallabel

func (x *CellularStatus) GetLogicallabel() string

func (*CellularStatus) GetModule

func (x *CellularStatus) GetModule() *info.ZCellularModuleInfo

func (*CellularStatus) GetProbeError

func (x *CellularStatus) GetProbeError() string

func (*CellularStatus) GetProviders

func (x *CellularStatus) GetProviders() []*info.ZCellularProvider

func (*CellularStatus) GetSimCards

func (x *CellularStatus) GetSimCards() []*info.ZSimcardInfo

func (*CellularStatus) ProtoMessage

func (*CellularStatus) ProtoMessage()

func (*CellularStatus) ProtoReflect

func (x *CellularStatus) ProtoReflect() protoreflect.Message

func (*CellularStatus) Reset

func (x *CellularStatus) Reset()

func (*CellularStatus) String

func (x *CellularStatus) String() string

type ConfigEndpoint

type ConfigEndpoint int32

ConfigEndpoint identifies an LPS endpoint that may carry configuration changes from LPS to EVE and can therefore be referenced by a Signal.

The /api/v1/location endpoint is intentionally not represented here because it only carries information from EVE to LPS and never returns configuration.

const (
	ConfigEndpoint_CONFIG_ENDPOINT_UNSPECIFIED ConfigEndpoint = 0
	// GET  /api/v1/local_profile
	ConfigEndpoint_CONFIG_ENDPOINT_LOCAL_PROFILE ConfigEndpoint = 1
	// POST /api/v1/radio
	ConfigEndpoint_CONFIG_ENDPOINT_RADIO ConfigEndpoint = 2
	// POST /api/v1/appinfo
	ConfigEndpoint_CONFIG_ENDPOINT_APP_INFO ConfigEndpoint = 3
	// POST /api/v1/appbootinfo
	ConfigEndpoint_CONFIG_ENDPOINT_APP_BOOT_INFO ConfigEndpoint = 4
	// POST /api/v1/devinfo
	ConfigEndpoint_CONFIG_ENDPOINT_DEV_INFO ConfigEndpoint = 5
	// POST /api/v1/network
	ConfigEndpoint_CONFIG_ENDPOINT_NETWORK ConfigEndpoint = 6
)

func (ConfigEndpoint) Descriptor

func (ConfigEndpoint) Enum

func (x ConfigEndpoint) Enum() *ConfigEndpoint

func (ConfigEndpoint) EnumDescriptor deprecated

func (ConfigEndpoint) EnumDescriptor() ([]byte, []int)

Deprecated: Use ConfigEndpoint.Descriptor instead.

func (ConfigEndpoint) Number

func (ConfigEndpoint) String

func (x ConfigEndpoint) String() string

func (ConfigEndpoint) Type

type IPVersion

type IPVersion int32

Specifies the IP version(s) enabled on a network port.

const (
	// IP version is not specified.
	// But default, port operates in dual-stack mode.
	IPVersion_IP_VERSION_UNSPECIFIED IPVersion = 0
	// Port operates in dual-stack mode, supporting both IPv4 and IPv6 simultaneously.
	IPVersion_IP_VERSION_DUAL_STACK IPVersion = 1
	// Port operates with IPv4 only.
	IPVersion_IP_VERSION_IPV4_ONLY IPVersion = 2
	// Port operates with IPv6 only.
	IPVersion_IP_VERSION_IPV6_ONLY IPVersion = 3
)

func (IPVersion) Descriptor

func (IPVersion) Descriptor() protoreflect.EnumDescriptor

func (IPVersion) Enum

func (x IPVersion) Enum() *IPVersion

func (IPVersion) EnumDescriptor deprecated

func (IPVersion) EnumDescriptor() ([]byte, []int)

Deprecated: Use IPVersion.Descriptor instead.

func (IPVersion) Number

func (x IPVersion) Number() protoreflect.EnumNumber

func (IPVersion) String

func (x IPVersion) String() string

func (IPVersion) Type

type LocalAppCmdList

type LocalAppCmdList struct {

	// Security token. EVE will verify that server_token matches the profile server
	// token received from the controller. Not used for the LOC case.
	ServerToken string `protobuf:"bytes,1,opt,name=server_token,json=serverToken,proto3" json:"server_token,omitempty"`
	// A list of commands requested to be executed for locally running application instances.
	// A new request created for the same application should overwrite the previous entry
	// with the 'timestamp' field updated. In other words, the list should contain at most
	// one entry for each application instance.
	// It is not required for the Local profile server to persist command requests.
	// Also, it is not required for the Local profile server to stop submitting command
	// requests that have been already processed by EVE. Using the `timestamp` field,
	// EVE is able to determine if a given command request has been already handled or not.
	// To check if the last requested command has completed, compare its timestamp with
	// 'last_cmd_timestamp' from `LocalAppInfo` message, submitted by EVE in the request
	// body of the api/v1/appinfo API.
	AppCommands []*AppCommand `protobuf:"bytes,2,rep,name=app_commands,json=appCommands,proto3" json:"app_commands,omitempty"`
	// contains filtered or unexported fields
}

LocalAppCmdList message may be returned in the response from a POST request sent to the api/v1/appinfo API by the local profile server (see PROFILE.md), or the message can be a part of the CompoundEdgeDevConfig message and returned by the local operator console (see config/compound_devconfig.proto)

func (*LocalAppCmdList) Descriptor deprecated

func (*LocalAppCmdList) Descriptor() ([]byte, []int)

Deprecated: Use LocalAppCmdList.ProtoReflect.Descriptor instead.

func (*LocalAppCmdList) GetAppCommands

func (x *LocalAppCmdList) GetAppCommands() []*AppCommand

func (*LocalAppCmdList) GetServerToken

func (x *LocalAppCmdList) GetServerToken() string

func (*LocalAppCmdList) ProtoMessage

func (*LocalAppCmdList) ProtoMessage()

func (*LocalAppCmdList) ProtoReflect

func (x *LocalAppCmdList) ProtoReflect() protoreflect.Message

func (*LocalAppCmdList) Reset

func (x *LocalAppCmdList) Reset()

func (*LocalAppCmdList) String

func (x *LocalAppCmdList) String() string

type LocalAppInfo

type LocalAppInfo struct {
	Id      string          `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Version string          `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	Name    string          `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	Err     *info.ErrorInfo `protobuf:"bytes,4,opt,name=err,proto3" json:"err,omitempty"`
	State   info.ZSwState   `protobuf:"varint,5,opt,name=state,proto3,enum=org.lfedge.eve.info.ZSwState" json:"state,omitempty"`
	// Value of the field `timestamp` from the last `AppCommand` that was
	// requested by the Local profile server, received by EVE and has completed
	// its execution for this application instance.
	LastCmdTimestamp uint64 `protobuf:"varint,6,opt,name=last_cmd_timestamp,json=lastCmdTimestamp,proto3" json:"last_cmd_timestamp,omitempty"`
	// contains filtered or unexported fields
}

LocalAppInfo contains information about app on EdgeNode

func (*LocalAppInfo) Descriptor deprecated

func (*LocalAppInfo) Descriptor() ([]byte, []int)

Deprecated: Use LocalAppInfo.ProtoReflect.Descriptor instead.

func (*LocalAppInfo) GetErr

func (x *LocalAppInfo) GetErr() *info.ErrorInfo

func (*LocalAppInfo) GetId

func (x *LocalAppInfo) GetId() string

func (*LocalAppInfo) GetLastCmdTimestamp

func (x *LocalAppInfo) GetLastCmdTimestamp() uint64

func (*LocalAppInfo) GetName

func (x *LocalAppInfo) GetName() string

func (*LocalAppInfo) GetState

func (x *LocalAppInfo) GetState() info.ZSwState

func (*LocalAppInfo) GetVersion

func (x *LocalAppInfo) GetVersion() string

func (*LocalAppInfo) ProtoMessage

func (*LocalAppInfo) ProtoMessage()

func (*LocalAppInfo) ProtoReflect

func (x *LocalAppInfo) ProtoReflect() protoreflect.Message

func (*LocalAppInfo) Reset

func (x *LocalAppInfo) Reset()

func (*LocalAppInfo) String

func (x *LocalAppInfo) String() string

type LocalAppInfoList

type LocalAppInfoList struct {
	AppsInfo []*LocalAppInfo `protobuf:"bytes,1,rep,name=apps_info,json=appsInfo,proto3" json:"apps_info,omitempty"`
	// contains filtered or unexported fields
}

LocalAppInfoList contains information about all app on EdgeNode sent to the api/v1/appinfo

func (*LocalAppInfoList) Descriptor deprecated

func (*LocalAppInfoList) Descriptor() ([]byte, []int)

Deprecated: Use LocalAppInfoList.ProtoReflect.Descriptor instead.

func (*LocalAppInfoList) GetAppsInfo

func (x *LocalAppInfoList) GetAppsInfo() []*LocalAppInfo

func (*LocalAppInfoList) ProtoMessage

func (*LocalAppInfoList) ProtoMessage()

func (*LocalAppInfoList) ProtoReflect

func (x *LocalAppInfoList) ProtoReflect() protoreflect.Message

func (*LocalAppInfoList) Reset

func (x *LocalAppInfoList) Reset()

func (*LocalAppInfoList) String

func (x *LocalAppInfoList) String() string

type LocalDevCmd

type LocalDevCmd struct {

	// Security token. EVE will verify that server_token matches the profile server
	// token received from the controller. Not used for the LOC case.
	ServerToken string `protobuf:"bytes,1,opt,name=server_token,json=serverToken,proto3" json:"server_token,omitempty"`
	Timestamp   uint64 `protobuf:"varint,2,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// Command to run.
	Command LocalDevCmd_Command `protobuf:"varint,3,opt,name=command,proto3,enum=org.lfedge.eve.profile.LocalDevCmd_Command" json:"command,omitempty"`
	// contains filtered or unexported fields
}

LocalDevCmd message may be returned in the response from a POST request sent to the api/v1/devinfo API by the local profile server (see PROFILE.md), or the message can be a part of the CompoundEdgeDevConfig message and returned by the local operator console (see config/compound_devconfig.proto).

func (*LocalDevCmd) Descriptor deprecated

func (*LocalDevCmd) Descriptor() ([]byte, []int)

Deprecated: Use LocalDevCmd.ProtoReflect.Descriptor instead.

func (*LocalDevCmd) GetCommand

func (x *LocalDevCmd) GetCommand() LocalDevCmd_Command

func (*LocalDevCmd) GetServerToken

func (x *LocalDevCmd) GetServerToken() string

func (*LocalDevCmd) GetTimestamp

func (x *LocalDevCmd) GetTimestamp() uint64

func (*LocalDevCmd) ProtoMessage

func (*LocalDevCmd) ProtoMessage()

func (*LocalDevCmd) ProtoReflect

func (x *LocalDevCmd) ProtoReflect() protoreflect.Message

func (*LocalDevCmd) Reset

func (x *LocalDevCmd) Reset()

func (*LocalDevCmd) String

func (x *LocalDevCmd) String() string

type LocalDevCmd_Command

type LocalDevCmd_Command int32
const (
	LocalDevCmd_COMMAND_UNSPECIFIED LocalDevCmd_Command = 0
	// SHUTDOWN: Edge node will initiate a graceful shutdown of all of the app
	// instances on the node (including an application instance implementing
	// the local profile server API).
	// The state of the application instances (HALTING, HALTED, etc) can be
	// observed since is sent to the api/v1/appinfo API endpoint as normal.
	// Any local profile server is shut down after all the other app instances
	// have halted.
	LocalDevCmd_COMMAND_SHUTDOWN LocalDevCmd_Command = 1
	// GRACEFUL_POWEROFF: As above, but once all of the app instances have
	// been shut down the edge node will also power off. Note that the power
	// on will need to be done through other local means (UPS power cycling
	// the edge node or someone manually power cycling the edge node.)
	// In older versions of the API this was called SHUTDOWN_POWEROFF; only
	// the name changes, the id and the meaning stay the same.
	LocalDevCmd_COMMAND_GRACEFUL_POWEROFF LocalDevCmd_Command = 2
	// SHUTDOWN_POWEROFF: deprecated, please use GRACEFUL_POWEROFF
	//
	// Deprecated: Marked as deprecated in profile/local_profile.proto.
	LocalDevCmd_COMMAND_SHUTDOWN_POWEROFF LocalDevCmd_Command = 2
	// SHUTDOWN_REBOOT: Edge node will initiate a graceful reboot.
	// The state of the application instances (HALTING, HALTED, etc) can be
	// observed since is sent to the api/v1/appinfo API endpoint as normal.
	// Any local profile server is shut down after all the other app instances
	// have halted.
	LocalDevCmd_COMMAND_GRACEFUL_REBOOT LocalDevCmd_Command = 3
	// COLLECT_INFO: Edge node will call the collect-info.sh script with
	// the datastore parameters (see datastore_collect_info_id) to upload
	// the generated output to that datastore
	LocalDevCmd_COMMAND_COLLECT_INFO LocalDevCmd_Command = 4
)

func (LocalDevCmd_Command) Descriptor

func (LocalDevCmd_Command) Enum

func (LocalDevCmd_Command) EnumDescriptor deprecated

func (LocalDevCmd_Command) EnumDescriptor() ([]byte, []int)

Deprecated: Use LocalDevCmd_Command.Descriptor instead.

func (LocalDevCmd_Command) Number

func (LocalDevCmd_Command) String

func (x LocalDevCmd_Command) String() string

func (LocalDevCmd_Command) Type

type LocalDevInfo

type LocalDevInfo struct {
	DeviceUuid             string                       `protobuf:"bytes,1,opt,name=device_uuid,json=deviceUuid,proto3" json:"device_uuid,omitempty"`
	State                  info.ZDeviceState            `protobuf:"varint,2,opt,name=state,proto3,enum=org.lfedge.eve.info.ZDeviceState" json:"state,omitempty"`
	MaintenanceModeReasons []info.MaintenanceModeReason `` /* 184-byte string literal not displayed */
	BootTime               *timestamppb.Timestamp       `protobuf:"bytes,4,opt,name=boot_time,json=bootTime,proto3" json:"boot_time,omitempty"`
	LastBootReason         info.BootReason              `` /* 142-byte string literal not displayed */
	// Value of the field `timestamp` from the last `DevCommand` that was
	// requested by the Local profile server, received by EVE and has completed
	// its execution for this edge node.
	LastCmdTimestamp uint64 `protobuf:"varint,10,opt,name=last_cmd_timestamp,json=lastCmdTimestamp,proto3" json:"last_cmd_timestamp,omitempty"`
	// contains filtered or unexported fields
}

LocalDevInfo contains information about an EdgeNode sent to the api/v1/devinfo

func (*LocalDevInfo) Descriptor deprecated

func (*LocalDevInfo) Descriptor() ([]byte, []int)

Deprecated: Use LocalDevInfo.ProtoReflect.Descriptor instead.

func (*LocalDevInfo) GetBootTime

func (x *LocalDevInfo) GetBootTime() *timestamppb.Timestamp

func (*LocalDevInfo) GetDeviceUuid

func (x *LocalDevInfo) GetDeviceUuid() string

func (*LocalDevInfo) GetLastBootReason

func (x *LocalDevInfo) GetLastBootReason() info.BootReason

func (*LocalDevInfo) GetLastCmdTimestamp

func (x *LocalDevInfo) GetLastCmdTimestamp() uint64

func (*LocalDevInfo) GetMaintenanceModeReasons

func (x *LocalDevInfo) GetMaintenanceModeReasons() []info.MaintenanceModeReason

func (*LocalDevInfo) GetState

func (x *LocalDevInfo) GetState() info.ZDeviceState

func (*LocalDevInfo) ProtoMessage

func (*LocalDevInfo) ProtoMessage()

func (*LocalDevInfo) ProtoReflect

func (x *LocalDevInfo) ProtoReflect() protoreflect.Message

func (*LocalDevInfo) Reset

func (x *LocalDevInfo) Reset()

func (*LocalDevInfo) String

func (x *LocalDevInfo) String() string

type LocalNetworkConfig

type LocalNetworkConfig struct {

	// Security token. EVE verifies that `server_token` matches the profile server
	// token provisioned via the controller.
	ServerToken string `protobuf:"bytes,1,opt,name=server_token,json=serverToken,proto3" json:"server_token,omitempty"`
	// Declarative network configuration for ports managed locally.
	// Contains all ports with locally defined configuration, regardless of whether
	// they were newly configured, updated, or remain unchanged since the last submission.
	// Ports not listed here are expected to use the controller-provided (or fallback)
	// configuration.
	Ports []*NetworkPortConfig `protobuf:"bytes,2,rep,name=ports,proto3" json:"ports,omitempty"`
	// contains filtered or unexported fields
}

LocalNetworkConfig is optionally returned by the Local Profile Server in response to a POST request to the `api/v1/network` endpoint. If the server responds with HTTP 204 (no content), EVE will continue using the most recently submitted local configuration without changes.

func (*LocalNetworkConfig) Descriptor deprecated

func (*LocalNetworkConfig) Descriptor() ([]byte, []int)

Deprecated: Use LocalNetworkConfig.ProtoReflect.Descriptor instead.

func (*LocalNetworkConfig) GetPorts

func (x *LocalNetworkConfig) GetPorts() []*NetworkPortConfig

func (*LocalNetworkConfig) GetServerToken

func (x *LocalNetworkConfig) GetServerToken() string

func (*LocalNetworkConfig) ProtoMessage

func (*LocalNetworkConfig) ProtoMessage()

func (*LocalNetworkConfig) ProtoReflect

func (x *LocalNetworkConfig) ProtoReflect() protoreflect.Message

func (*LocalNetworkConfig) Reset

func (x *LocalNetworkConfig) Reset()

func (*LocalNetworkConfig) String

func (x *LocalNetworkConfig) String() string

type LocalNetworkConfigInfo

type LocalNetworkConfigInfo struct {

	// List of ports with locally provided network configuration.
	Ports []*NetworkPortConfig `protobuf:"bytes,1,rep,name=ports,proto3" json:"ports,omitempty"`
	// Error related to the processing of the local configuration as a whole.
	// Indicates problems that prevented EVE from accepting or processing the request
	// (e.g., invalid token, malformed payload, or missing logical labels).
	// Unlike per-port errors (reported in NetworkPortConfig.error_message),
	// this error is not tied to a specific port. Empty if the local configuration
	// was accepted without errors.
	ErrorMessage string `protobuf:"bytes,2,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
	// contains filtered or unexported fields
}

LocalNetworkConfigInfo reports the current state of locally provided network configuration. It lists all ports configured locally, and any errors from processing the local configuration

func (*LocalNetworkConfigInfo) Descriptor deprecated

func (*LocalNetworkConfigInfo) Descriptor() ([]byte, []int)

Deprecated: Use LocalNetworkConfigInfo.ProtoReflect.Descriptor instead.

func (*LocalNetworkConfigInfo) GetErrorMessage

func (x *LocalNetworkConfigInfo) GetErrorMessage() string

func (*LocalNetworkConfigInfo) GetPorts

func (x *LocalNetworkConfigInfo) GetPorts() []*NetworkPortConfig

func (*LocalNetworkConfigInfo) ProtoMessage

func (*LocalNetworkConfigInfo) ProtoMessage()

func (*LocalNetworkConfigInfo) ProtoReflect

func (x *LocalNetworkConfigInfo) ProtoReflect() protoreflect.Message

func (*LocalNetworkConfigInfo) Reset

func (x *LocalNetworkConfigInfo) Reset()

func (*LocalNetworkConfigInfo) String

func (x *LocalNetworkConfigInfo) String() string

type LocalProfile

type LocalProfile struct {
	LocalProfile string `protobuf:"bytes,1,opt,name=local_profile,json=localProfile,proto3" json:"local_profile,omitempty"`
	ServerToken  string `protobuf:"bytes,2,opt,name=server_token,json=serverToken,proto3" json:"server_token,omitempty"`
	// contains filtered or unexported fields
}

LocalProfile message is sent in response to a GET to the api/v1/local_profile API

func (*LocalProfile) Descriptor deprecated

func (*LocalProfile) Descriptor() ([]byte, []int)

Deprecated: Use LocalProfile.ProtoReflect.Descriptor instead.

func (*LocalProfile) GetLocalProfile

func (x *LocalProfile) GetLocalProfile() string

func (*LocalProfile) GetServerToken

func (x *LocalProfile) GetServerToken() string

func (*LocalProfile) ProtoMessage

func (*LocalProfile) ProtoMessage()

func (*LocalProfile) ProtoReflect

func (x *LocalProfile) ProtoReflect() protoreflect.Message

func (*LocalProfile) Reset

func (x *LocalProfile) Reset()

func (*LocalProfile) String

func (x *LocalProfile) String() string

type NetworkConfigTestingStatus

type NetworkConfigTestingStatus struct {

	// True if the device currently has connectivity to the controller.
	ControllerReachable bool `protobuf:"varint,1,opt,name=controller_reachable,json=controllerReachable,proto3" json:"controller_reachable,omitempty"`
	// Describes the last connectivity failure; empty if connectivity is fine.
	ConnectivityError string `protobuf:"bytes,2,opt,name=connectivity_error,json=connectivityError,proto3" json:"connectivity_error,omitempty"`
	// Timestamp of the most recent (completed) controller connectivity test.
	LastTestTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=last_test_time,json=lastTestTime,proto3" json:"last_test_time,omitempty"`
	// Indicates whether connectivity testing is still in progress.
	// True if the device has not yet completed the test.
	TestingInProgress bool `protobuf:"varint,4,opt,name=testing_in_progress,json=testingInProgress,proto3" json:"testing_in_progress,omitempty"`
	// Optional human-readable description of the current testing phase or reason
	// for waiting (e.g., interface not yet available, waiting for DHCP IP,
	// waiting for DNS configuration). Empty if testing is not in progress.
	TestingPhase string `protobuf:"bytes,5,opt,name=testing_phase,json=testingPhase,proto3" json:"testing_phase,omitempty"`
	// contains filtered or unexported fields
}

Reports the current status of controller connectivity testing.

func (*NetworkConfigTestingStatus) Descriptor deprecated

func (*NetworkConfigTestingStatus) Descriptor() ([]byte, []int)

Deprecated: Use NetworkConfigTestingStatus.ProtoReflect.Descriptor instead.

func (*NetworkConfigTestingStatus) GetConnectivityError

func (x *NetworkConfigTestingStatus) GetConnectivityError() string

func (*NetworkConfigTestingStatus) GetControllerReachable

func (x *NetworkConfigTestingStatus) GetControllerReachable() bool

func (*NetworkConfigTestingStatus) GetLastTestTime

func (x *NetworkConfigTestingStatus) GetLastTestTime() *timestamppb.Timestamp

func (*NetworkConfigTestingStatus) GetTestingInProgress

func (x *NetworkConfigTestingStatus) GetTestingInProgress() bool

func (*NetworkConfigTestingStatus) GetTestingPhase

func (x *NetworkConfigTestingStatus) GetTestingPhase() string

func (*NetworkConfigTestingStatus) ProtoMessage

func (*NetworkConfigTestingStatus) ProtoMessage()

func (*NetworkConfigTestingStatus) ProtoReflect

func (*NetworkConfigTestingStatus) Reset

func (x *NetworkConfigTestingStatus) Reset()

func (*NetworkConfigTestingStatus) String

func (x *NetworkConfigTestingStatus) String() string

type NetworkInfo

type NetworkInfo struct {

	// The most recent network configuration received from the controller.
	LatestConfig []*NetworkPortConfig `protobuf:"bytes,1,rep,name=latest_config,json=latestConfig,proto3" json:"latest_config,omitempty"`
	// Current status of controller connectivity and the state of fallback configuration.
	ConfigTesting *NetworkConfigTestingStatus `protobuf:"bytes,2,opt,name=config_testing,json=configTesting,proto3" json:"config_testing,omitempty"`
	// True if EVE is currently using a fallback configuration due to controller
	// connectivity loss.
	IsUsingFallbackConfig bool `` /* 129-byte string literal not displayed */
	// The fallback network configuration currently in use.
	// Empty if not using fallback configuration.
	FallbackConfig []*NetworkPortConfig `protobuf:"bytes,4,rep,name=fallback_config,json=fallbackConfig,proto3" json:"fallback_config,omitempty"`
	// Contains information about locally provided network configuration.
	// Includes only ports with local configuration and any associated errors.
	// Errors may result from invalid input from the Local Profile Server (LPS)
	// or from attempts to configure ports that cannot be modified locally.
	// Ports not listed here are using either the latest controller config
	// or the fallback config, as indicated by `NetworkPortConfig.config_applied`.
	LocalConfig *LocalNetworkConfigInfo `protobuf:"bytes,5,opt,name=local_config,json=localConfig,proto3" json:"local_config,omitempty"`
	// Per-port runtime status observed on the device (kernel interface,
	// routing table, resolver state). Unlike the NetworkPortConfig variants
	// above, which describe what *should* be configured, this field
	// describes what is *currently* in effect, regardless of which config
	// source (latest / fallback / local) produced it.
	PortStatus []*NetworkPortStatus `protobuf:"bytes,6,rep,name=port_status,json=portStatus,proto3" json:"port_status,omitempty"`
	// contains filtered or unexported fields
}

NetworkInfo is sent by EVE in a POST request to the `api/v1/network` endpoint. It publishes multiple configurations for each network port, including:

  • The latest configuration received from the controller.
  • The fallback configuration used when controller connectivity is lost or the latest configuration is invalid.
  • locally submitted network configuration (from LPS) that overrides controller or fallback settings for one or more ports.

For each port, the `NetworkPortConfig.config_applied` flag indicates which of these configurations is currently active on the device.

func (*NetworkInfo) Descriptor deprecated

func (*NetworkInfo) Descriptor() ([]byte, []int)

Deprecated: Use NetworkInfo.ProtoReflect.Descriptor instead.

func (*NetworkInfo) GetConfigTesting

func (x *NetworkInfo) GetConfigTesting() *NetworkConfigTestingStatus

func (*NetworkInfo) GetFallbackConfig

func (x *NetworkInfo) GetFallbackConfig() []*NetworkPortConfig

func (*NetworkInfo) GetIsUsingFallbackConfig

func (x *NetworkInfo) GetIsUsingFallbackConfig() bool

func (*NetworkInfo) GetLatestConfig

func (x *NetworkInfo) GetLatestConfig() []*NetworkPortConfig

func (*NetworkInfo) GetLocalConfig

func (x *NetworkInfo) GetLocalConfig() *LocalNetworkConfigInfo

func (*NetworkInfo) GetPortStatus

func (x *NetworkInfo) GetPortStatus() []*NetworkPortStatus

func (*NetworkInfo) ProtoMessage

func (*NetworkInfo) ProtoMessage()

func (*NetworkInfo) ProtoReflect

func (x *NetworkInfo) ProtoReflect() protoreflect.Message

func (*NetworkInfo) Reset

func (x *NetworkInfo) Reset()

func (*NetworkInfo) String

func (x *NetworkInfo) String() string

type NetworkPortAddresses

type NetworkPortAddresses struct {

	// The interface name assigned by the Linux kernel.
	InterfaceName string `protobuf:"bytes,1,opt,name=interface_name,json=interfaceName,proto3" json:"interface_name,omitempty"`
	// PCI address of the network adapter in the long format.
	// For example: `0000:00:15.0`
	PciAddress string `protobuf:"bytes,2,opt,name=pci_address,json=pciAddress,proto3" json:"pci_address,omitempty"`
	// USB address of the network adapter in the format `<BUS>:[<PORT>]`, with nested ports
	// separated by dots. For example: `1:2.3`
	// Empty if the network adapter is not a USB device.
	UsbAddress string `protobuf:"bytes,3,opt,name=usb_address,json=usbAddress,proto3" json:"usb_address,omitempty"`
	// contains filtered or unexported fields
}

Specifies system and hardware identifiers for a network port. These fields are included in NetworkInfo to help the user identify the port, but may be omitted in LocalNetworkConfig. None of these identifiers (including the interface name) can be changed. For identification in LocalNetworkConfig, use the port's logical label instead.

func (*NetworkPortAddresses) Descriptor deprecated

func (*NetworkPortAddresses) Descriptor() ([]byte, []int)

Deprecated: Use NetworkPortAddresses.ProtoReflect.Descriptor instead.

func (*NetworkPortAddresses) GetInterfaceName

func (x *NetworkPortAddresses) GetInterfaceName() string

func (*NetworkPortAddresses) GetPciAddress

func (x *NetworkPortAddresses) GetPciAddress() string

func (*NetworkPortAddresses) GetUsbAddress

func (x *NetworkPortAddresses) GetUsbAddress() string

func (*NetworkPortAddresses) ProtoMessage

func (*NetworkPortAddresses) ProtoMessage()

func (*NetworkPortAddresses) ProtoReflect

func (x *NetworkPortAddresses) ProtoReflect() protoreflect.Message

func (*NetworkPortAddresses) Reset

func (x *NetworkPortAddresses) Reset()

func (*NetworkPortAddresses) String

func (x *NetworkPortAddresses) String() string

type NetworkPortConfig

type NetworkPortConfig struct {

	// Logical label of the port as defined in the device model.
	// This identifier is used to reference the port across configurations
	// and status reports.
	LogicalLabel string `protobuf:"bytes,1,opt,name=logical_label,json=logicalLabel,proto3" json:"logical_label,omitempty"`
	// System and hardware identifiers of the network port (informational only).
	// When included in `LocalNetworkConfig.ports` received from LPS,
	// this field is ignored by EVE. Port identification must be done exclusively
	// using the logical label.
	PortAddresses *NetworkPortAddresses `protobuf:"bytes,2,opt,name=port_addresses,json=portAddresses,proto3" json:"port_addresses,omitempty"`
	// Indicates whether this configuration is currently applied to the port.
	// If false, the port is using a different configuration (latest controller config,
	// local config, or fallback) instead of this one.
	// Inside `LocalNetworkConfig.ports`, received by EVE from LPS, this field is ignored.
	ConfigApplied bool `protobuf:"varint,3,opt,name=config_applied,json=configApplied,proto3" json:"config_applied,omitempty"`
	// IP version(s) enabled for the port.
	IpVersion IPVersion `` /* 127-byte string literal not displayed */
	// Enables DHCP for IP configuration.
	// When enabled, static IP configurations can still be provided.
	// By default, static settings are merged with DHCP-provided configuration,
	// but merging behavior can be controlled per IP-related field.
	UseDhcp bool `protobuf:"varint,5,opt,name=use_dhcp,json=useDhcp,proto3" json:"use_dhcp,omitempty"`
	// Specifies which DHCP options should be ignored when merging static and DHCP
	// configurations.
	DhcpOptionsIgnore *evecommon.DhcpOptionsIgnore `protobuf:"bytes,6,opt,name=dhcp_options_ignore,json=dhcpOptionsIgnore,proto3" json:"dhcp_options_ignore,omitempty"`
	// Static IP addresses, in CIDR format (e.g., "192.168.1.10/24").
	IpAddresses []string `protobuf:"bytes,7,rep,name=ip_addresses,json=ipAddresses,proto3" json:"ip_addresses,omitempty"`
	// Statically configured gateway IP addresses.
	// Use the `without_default_route` option to specify whether these gateways
	// should NOT be used as default routes.
	// When `without_default_route` is true, no default route will be added
	// for this adapter, regardless of the gateway list or DHCP settings.
	Gateways []string `protobuf:"bytes,8,rep,name=gateways,proto3" json:"gateways,omitempty"`
	// When set to true, the network adapter will be configured without any default route.
	// This overrides gateway settings and applies even if DHCP is enabled (`use_dhcp = true`).
	WithoutDefaultRoute bool `protobuf:"varint,9,opt,name=without_default_route,json=withoutDefaultRoute,proto3" json:"without_default_route,omitempty"`
	// Statically configured DNS server IP addresses.
	DnsServers []string `protobuf:"bytes,10,rep,name=dns_servers,json=dnsServers,proto3" json:"dns_servers,omitempty"`
	// Statically configured local DNS domain suffix.
	DnsDomain string `protobuf:"bytes,11,opt,name=dns_domain,json=dnsDomain,proto3" json:"dns_domain,omitempty"`
	// Statically configured NTP server addresses (IP or hostname).
	NtpServers []string `protobuf:"bytes,12,rep,name=ntp_servers,json=ntpServers,proto3" json:"ntp_servers,omitempty"`
	// MTU (Maximum Transmission Unit) in bytes.
	// The max allowed value is 65535 (protobuf does not define uint16).
	// If not defined (zero value), EVE will set the default MTU size, which depends
	// on the network adapter type. Ethernet and WiFi adapters default to 1500 bytes,
	// while cellular modems typically receive their MTU value from the network provider
	// (which EVE will use unless user overrides the MTU value).
	Mtu uint32 `protobuf:"varint,13,opt,name=mtu,proto3" json:"mtu,omitempty"`
	// Proxy configuration.
	ProxyConfig *evecommon.ProxyConfig `protobuf:"bytes,14,opt,name=proxy_config,json=proxyConfig,proto3" json:"proxy_config,omitempty"`
	// Specifies the type of wireless device.
	// Should correspond to which oneof field is set in `wireless_config`.
	WirelessDeviceType WirelessType `` /* 160-byte string literal not displayed */
	// Configuration for a wireless adapter (WiFi or cellular modem).
	// For cellular modems, IP-related fields such as addresses, DNS, gateways, etc.
	// must not be specified, because they are always obtained dynamically from the
	// cellular network. Any user-specified values will be ignored by EVE.
	//
	// Types that are assignable to WirelessConfig:
	//
	//	*NetworkPortConfig_CellularConfig
	//	*NetworkPortConfig_WifiConfig
	WirelessConfig isNetworkPortConfig_WirelessConfig `protobuf_oneof:"wireless_config"`
	// Identifies the source of this network port configuration.
	// Inside `LocalNetworkConfig.ports`, received by EVE from LPS, this field is ignored.
	ConfigSource *evecommon.PortConfigSource `protobuf:"bytes,18,opt,name=config_source,json=configSource,proto3" json:"config_source,omitempty"`
	// Error message associated with this specific port configuration.
	// Indicates problems with the configuration itself (invalid values or disallowed settings)
	// or with the port's current state (e.g., missing IP/DNS on the management port,
	// link down, or other connectivity issues).
	// Empty if the configuration for this port was accepted and fully operational.
	// Even if an error is reported, the configuration might still be (at least partially)
	// applied; use the `config_applied` field to determine whether the port is currently
	// using the requested configuration despite any issues.
	// Inside `LocalNetworkConfig.ports`, received by EVE from LPS, this field is ignored.
	ErrorMessage string `protobuf:"bytes,19,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
	// Indicates whether this port is permitted to have its configuration modified
	// locally via LPS. Mirrors the controller-provisioned
	// `SystemAdapter.allow_local_modifications` (see config/devmodel.proto) and
	// is reported by EVE to LPS so that the operator UI can distinguish ports
	// that accept local configuration from those managed exclusively by the
	// controller. Attempts to locally configure a port with this flag set to
	// false are rejected by EVE, with an error reported in
	// `NetworkPortConfig.error_message`.
	// Inside `LocalNetworkConfig.ports`, received by EVE from LPS, this field is ignored.
	LocalModificationsAllowed bool `` /* 140-byte string literal not displayed */
	// contains filtered or unexported fields
}

NetworkPortConfig defines the configuration settings for a network port on a device. It includes identification fields, IP addressing details, routing information, DNS and NTP servers, MTU settings, and optional proxy and wireless adapter configurations.

This message supports both static and DHCP-based IP configurations. When DHCP is enabled (`use_dhcp` = true), static IP fields can still be specified. By default, static configurations are merged with DHCP-provided settings, but the user can control, for each IP-related field, whether static config should override DHCP values or be merged alongside them.

For cellular modems, IP settings are always provided by the cellular network, so user-specified IP configurations are ignored during cellular modem updates.

func (*NetworkPortConfig) Descriptor deprecated

func (*NetworkPortConfig) Descriptor() ([]byte, []int)

Deprecated: Use NetworkPortConfig.ProtoReflect.Descriptor instead.

func (*NetworkPortConfig) GetCellularConfig

func (x *NetworkPortConfig) GetCellularConfig() *CellularConfig

func (*NetworkPortConfig) GetConfigApplied

func (x *NetworkPortConfig) GetConfigApplied() bool

func (*NetworkPortConfig) GetConfigSource

func (x *NetworkPortConfig) GetConfigSource() *evecommon.PortConfigSource

func (*NetworkPortConfig) GetDhcpOptionsIgnore

func (x *NetworkPortConfig) GetDhcpOptionsIgnore() *evecommon.DhcpOptionsIgnore

func (*NetworkPortConfig) GetDnsDomain

func (x *NetworkPortConfig) GetDnsDomain() string

func (*NetworkPortConfig) GetDnsServers

func (x *NetworkPortConfig) GetDnsServers() []string

func (*NetworkPortConfig) GetErrorMessage

func (x *NetworkPortConfig) GetErrorMessage() string

func (*NetworkPortConfig) GetGateways

func (x *NetworkPortConfig) GetGateways() []string

func (*NetworkPortConfig) GetIpAddresses

func (x *NetworkPortConfig) GetIpAddresses() []string

func (*NetworkPortConfig) GetIpVersion

func (x *NetworkPortConfig) GetIpVersion() IPVersion

func (*NetworkPortConfig) GetLocalModificationsAllowed

func (x *NetworkPortConfig) GetLocalModificationsAllowed() bool

func (*NetworkPortConfig) GetLogicalLabel

func (x *NetworkPortConfig) GetLogicalLabel() string

func (*NetworkPortConfig) GetMtu

func (x *NetworkPortConfig) GetMtu() uint32

func (*NetworkPortConfig) GetNtpServers

func (x *NetworkPortConfig) GetNtpServers() []string

func (*NetworkPortConfig) GetPortAddresses

func (x *NetworkPortConfig) GetPortAddresses() *NetworkPortAddresses

func (*NetworkPortConfig) GetProxyConfig

func (x *NetworkPortConfig) GetProxyConfig() *evecommon.ProxyConfig

func (*NetworkPortConfig) GetUseDhcp

func (x *NetworkPortConfig) GetUseDhcp() bool

func (*NetworkPortConfig) GetWifiConfig

func (x *NetworkPortConfig) GetWifiConfig() *WifiConfig

func (*NetworkPortConfig) GetWirelessConfig

func (m *NetworkPortConfig) GetWirelessConfig() isNetworkPortConfig_WirelessConfig

func (*NetworkPortConfig) GetWirelessDeviceType

func (x *NetworkPortConfig) GetWirelessDeviceType() WirelessType

func (*NetworkPortConfig) GetWithoutDefaultRoute

func (x *NetworkPortConfig) GetWithoutDefaultRoute() bool

func (*NetworkPortConfig) ProtoMessage

func (*NetworkPortConfig) ProtoMessage()

func (*NetworkPortConfig) ProtoReflect

func (x *NetworkPortConfig) ProtoReflect() protoreflect.Message

func (*NetworkPortConfig) Reset

func (x *NetworkPortConfig) Reset()

func (*NetworkPortConfig) String

func (x *NetworkPortConfig) String() string

type NetworkPortConfig_CellularConfig

type NetworkPortConfig_CellularConfig struct {
	// Configuration details specific to a cellular modem.
	CellularConfig *CellularConfig `protobuf:"bytes,16,opt,name=cellular_config,json=cellularConfig,proto3,oneof"`
}

type NetworkPortConfig_WifiConfig

type NetworkPortConfig_WifiConfig struct {
	// Configuration details specific to a WiFi adapter.
	WifiConfig *WifiConfig `protobuf:"bytes,17,opt,name=wifi_config,json=wifiConfig,proto3,oneof"`
}

type NetworkPortStatus

type NetworkPortStatus struct {

	// Logical label of the port as defined in the device model. Used to
	// correlate this entry with the corresponding NetworkPortConfig.
	LogicalLabel string `protobuf:"bytes,1,opt,name=logical_label,json=logicalLabel,proto3" json:"logical_label,omitempty"`
	// Interface name as seen by the Linux kernel (e.g. "eth0", "wlan0").
	InterfaceName string `protobuf:"bytes,2,opt,name=interface_name,json=interfaceName,proto3" json:"interface_name,omitempty"`
	// True if the L2 link is currently up.
	LinkUp bool `protobuf:"varint,3,opt,name=link_up,json=linkUp,proto3" json:"link_up,omitempty"`
	// MAC address of the interface, formatted with colon separators
	// (e.g. "aa:bb:cc:dd:ee:ff"). Empty if not applicable.
	MacAddress string `protobuf:"bytes,4,opt,name=mac_address,json=macAddress,proto3" json:"mac_address,omitempty"`
	// IP addresses currently assigned to the interface, in CIDR format
	// (e.g. "192.168.1.10/24"). Includes both IPv4 and IPv6 addresses.
	IpAddresses []string `protobuf:"bytes,5,rep,name=ip_addresses,json=ipAddresses,proto3" json:"ip_addresses,omitempty"`
	// IP addresses of default routers (gateways) active on this port.
	Gateways []string `protobuf:"bytes,6,rep,name=gateways,proto3" json:"gateways,omitempty"`
	// DNS servers currently used for name resolution on this port,
	// including DHCP-provided and statically configured entries.
	DnsServers []string `protobuf:"bytes,7,rep,name=dns_servers,json=dnsServers,proto3" json:"dns_servers,omitempty"`
	// Effective DNS search domain, from DHCP or static configuration.
	DnsDomain string `protobuf:"bytes,8,opt,name=dns_domain,json=dnsDomain,proto3" json:"dns_domain,omitempty"`
	// NTP servers currently used on this port (DHCP + static).
	// Entries may be IP addresses or hostnames.
	NtpServers []string `protobuf:"bytes,9,rep,name=ntp_servers,json=ntpServers,proto3" json:"ntp_servers,omitempty"`
	// MTU currently applied to the interface, in bytes. 0 if unknown.
	Mtu uint32 `protobuf:"varint,10,opt,name=mtu,proto3" json:"mtu,omitempty"`
	// contains filtered or unexported fields
}

NetworkPortStatus reports the current runtime state of a single network port as observed on the device. This is distinct from NetworkPortConfig, which describes what was declaratively configured: NetworkPortStatus describes what is actually applied on the kernel interface, routing table, and resolver at the time NetworkInfo is published.

func (*NetworkPortStatus) Descriptor deprecated

func (*NetworkPortStatus) Descriptor() ([]byte, []int)

Deprecated: Use NetworkPortStatus.ProtoReflect.Descriptor instead.

func (*NetworkPortStatus) GetDnsDomain

func (x *NetworkPortStatus) GetDnsDomain() string

func (*NetworkPortStatus) GetDnsServers

func (x *NetworkPortStatus) GetDnsServers() []string

func (*NetworkPortStatus) GetGateways

func (x *NetworkPortStatus) GetGateways() []string

func (*NetworkPortStatus) GetInterfaceName

func (x *NetworkPortStatus) GetInterfaceName() string

func (*NetworkPortStatus) GetIpAddresses

func (x *NetworkPortStatus) GetIpAddresses() []string

func (*NetworkPortStatus) GetLinkUp

func (x *NetworkPortStatus) GetLinkUp() bool

func (*NetworkPortStatus) GetLogicalLabel

func (x *NetworkPortStatus) GetLogicalLabel() string

func (*NetworkPortStatus) GetMacAddress

func (x *NetworkPortStatus) GetMacAddress() string

func (*NetworkPortStatus) GetMtu

func (x *NetworkPortStatus) GetMtu() uint32

func (*NetworkPortStatus) GetNtpServers

func (x *NetworkPortStatus) GetNtpServers() []string

func (*NetworkPortStatus) ProtoMessage

func (*NetworkPortStatus) ProtoMessage()

func (*NetworkPortStatus) ProtoReflect

func (x *NetworkPortStatus) ProtoReflect() protoreflect.Message

func (*NetworkPortStatus) Reset

func (x *NetworkPortStatus) Reset()

func (*NetworkPortStatus) String

func (x *NetworkPortStatus) String() string

type RadioConfig

type RadioConfig struct {

	// Security token. EVE will verify that serverToken matches the profile server
	// token received from the controller. Not used for the LOC case.
	ServerToken string `protobuf:"bytes,1,opt,name=server_token,json=serverToken,proto3" json:"server_token,omitempty"`
	// If enabled, EVE will disable radio transmission on all wireless devices available
	// to the host (i.e. it does not cover wireless devices directly attached to applications).
	RadioSilence bool `protobuf:"varint,2,opt,name=radio_silence,json=radioSilence,proto3" json:"radio_silence,omitempty"`
	// contains filtered or unexported fields
}

RadioConfig message may be returned in the response from a POST request sent to the api/v1/radio API by the local profile server (see PROFILE.md), or the message can be a part of the CompoundEdgeDevConfig message and returned by the local operator console (see config/compound_devconfig.proto).

func (*RadioConfig) Descriptor deprecated

func (*RadioConfig) Descriptor() ([]byte, []int)

Deprecated: Use RadioConfig.ProtoReflect.Descriptor instead.

func (*RadioConfig) GetRadioSilence

func (x *RadioConfig) GetRadioSilence() bool

func (*RadioConfig) GetServerToken

func (x *RadioConfig) GetServerToken() string

func (*RadioConfig) ProtoMessage

func (*RadioConfig) ProtoMessage()

func (*RadioConfig) ProtoReflect

func (x *RadioConfig) ProtoReflect() protoreflect.Message

func (*RadioConfig) Reset

func (x *RadioConfig) Reset()

func (*RadioConfig) String

func (x *RadioConfig) String() string

type RadioStatus

type RadioStatus struct {

	// radio_silence is True if the Radio-Silence mode is enabled by config AND successfully
	// applied for all radio devices.
	// If the radio silence was requested but this field is still returned as False,
	// expect non-empty config_error attached.
	RadioSilence bool `protobuf:"varint,1,opt,name=radio_silence,json=radioSilence,proto3" json:"radio_silence,omitempty"`
	// If the last radio configuration change failed, error message is reported here.
	// Please note that there is also a per-modem configuration error reported under CellularStatus.
	ConfigError string `protobuf:"bytes,2,opt,name=config_error,json=configError,proto3" json:"config_error,omitempty"`
	// Status of every LTE network.
	CellularStatus []*CellularStatus `protobuf:"bytes,3,rep,name=cellular_status,json=cellularStatus,proto3" json:"cellular_status,omitempty"`
	// Metrics for every LTE network.
	CellularMetrics []*metrics.CellularMetric `protobuf:"bytes,4,rep,name=cellular_metrics,json=cellularMetrics,proto3" json:"cellular_metrics,omitempty"` // XXX Later we can add status for every WiFi network adapter.
	// contains filtered or unexported fields
}

RadioStatus message is sent in the POST request to the api/v1/radio API.

func (*RadioStatus) Descriptor deprecated

func (*RadioStatus) Descriptor() ([]byte, []int)

Deprecated: Use RadioStatus.ProtoReflect.Descriptor instead.

func (*RadioStatus) GetCellularMetrics

func (x *RadioStatus) GetCellularMetrics() []*metrics.CellularMetric

func (*RadioStatus) GetCellularStatus

func (x *RadioStatus) GetCellularStatus() []*CellularStatus

func (*RadioStatus) GetConfigError

func (x *RadioStatus) GetConfigError() string

func (*RadioStatus) GetRadioSilence

func (x *RadioStatus) GetRadioSilence() bool

func (*RadioStatus) ProtoMessage

func (*RadioStatus) ProtoMessage()

func (*RadioStatus) ProtoReflect

func (x *RadioStatus) ProtoReflect() protoreflect.Message

func (*RadioStatus) Reset

func (x *RadioStatus) Reset()

func (*RadioStatus) String

func (x *RadioStatus) String() string

type Signal

type Signal struct {

	// Endpoints with pending configuration changes that EVE should poll now.
	// MUST contain at least one entry; empty Signals are not sent.
	// The order of entries is not significant.
	PendingChanges []ConfigEndpoint `` /* 154-byte string literal not displayed */
	// contains filtered or unexported fields
}

Signal is published by the Local Profile Server to EVE over a long-lived GET /api/v1/signal stream whenever one or more configuration changes are pending for the existing LPS endpoints. Upon receiving a Signal, EVE immediately polls each endpoint listed in `pending_changes`, bypassing the normal periodic polling cadence.

The signal channel is strictly a latency optimization. Periodic polling of the other LPS endpoints continues unchanged as the correctness guarantee: if the signal stream is unavailable, broken, or not implemented by LPS, EVE transparently falls back to polling only.

Wire format: NDJSON (application/x-ndjson). Each Signal is encoded using the canonical protobuf JSON mapping and terminated by a single '\n'. See PROFILE.md for full endpoint semantics.

func (*Signal) Descriptor deprecated

func (*Signal) Descriptor() ([]byte, []int)

Deprecated: Use Signal.ProtoReflect.Descriptor instead.

func (*Signal) GetPendingChanges

func (x *Signal) GetPendingChanges() []ConfigEndpoint

func (*Signal) ProtoMessage

func (*Signal) ProtoMessage()

func (*Signal) ProtoReflect

func (x *Signal) ProtoReflect() protoreflect.Message

func (*Signal) Reset

func (x *Signal) Reset()

func (*Signal) String

func (x *Signal) String() string

type WifiConfig

type WifiConfig struct {

	// SSID (network name) of the WiFi network.
	Ssid string `protobuf:"bytes,1,opt,name=ssid,proto3" json:"ssid,omitempty"`
	// Key management scheme (e.g., WPA-PSK, WPA-EAP).
	KeyScheme evecommon.WiFiKeyScheme `` /* 130-byte string literal not displayed */
	// Identity/username for WPA2 Enterprise networks.
	// Not included in NetworkInfo, but can be updated via LocalNetworkConfig.
	Identity string `protobuf:"bytes,3,opt,name=identity,proto3" json:"identity,omitempty"`
	// WiFi password or pre-shared key (PSK).
	// This value should be the hashed PSK generated by the `wpa_passphrase` tool.
	// For security, it is excluded from NetworkInfo but can be updated through
	// LocalNetworkConfig.
	Password string `protobuf:"bytes,4,opt,name=password,proto3" json:"password,omitempty"`
	// contains filtered or unexported fields
}

Configuration details specific to a WiFi adapter.

func (*WifiConfig) Descriptor deprecated

func (*WifiConfig) Descriptor() ([]byte, []int)

Deprecated: Use WifiConfig.ProtoReflect.Descriptor instead.

func (*WifiConfig) GetIdentity

func (x *WifiConfig) GetIdentity() string

func (*WifiConfig) GetKeyScheme

func (x *WifiConfig) GetKeyScheme() evecommon.WiFiKeyScheme

func (*WifiConfig) GetPassword

func (x *WifiConfig) GetPassword() string

func (*WifiConfig) GetSsid

func (x *WifiConfig) GetSsid() string

func (*WifiConfig) ProtoMessage

func (*WifiConfig) ProtoMessage()

func (*WifiConfig) ProtoReflect

func (x *WifiConfig) ProtoReflect() protoreflect.Message

func (*WifiConfig) Reset

func (x *WifiConfig) Reset()

func (*WifiConfig) String

func (x *WifiConfig) String() string

type WirelessType

type WirelessType int32

Enum representing the type of wireless device associated with the network port.

const (
	// Indicates that the device is not a wireless device.
	WirelessType_WIRELESS_TYPE_UNSPECIFIED WirelessType = 0
	// Indicates that the device is a cellular modem.
	WirelessType_WIRELESS_TYPE_CELLULAR WirelessType = 1
	// Indicates that the device is a WiFi adapter.
	WirelessType_WIRELESS_TYPE_WIFI WirelessType = 2
)

func (WirelessType) Descriptor

func (WirelessType) Enum

func (x WirelessType) Enum() *WirelessType

func (WirelessType) EnumDescriptor deprecated

func (WirelessType) EnumDescriptor() ([]byte, []int)

Deprecated: Use WirelessType.Descriptor instead.

func (WirelessType) Number

func (WirelessType) String

func (x WirelessType) String() string

func (WirelessType) Type

Jump to

Keyboard shortcuts

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