Service: Network

This API is not yet officially released neither maintained.

The network service allows to setup network configuration of Qb2 device. The exact structure of configuration settings is defined by "Network" protocol message. Service provides "SetConfig()" and "GetConfig()" API which allow to apply and read out configuration settings at run-time. The "GetStatus()" API brings configuration and statistical information about currently active network connection.

Table 1. Available methods
Method Request Response

GetStatus

google.protobuf.Empty

data.NetworkStatus

SetConfig

config.Network

google.protobuf.Empty

GetConfig

google.protobuf.Empty

config.Network

Validate

NetworkValidateRequest

NetworkValidateResponse

GetMacAddresses

google.protobuf.Empty

NetworkGetMacAddressesResponse

GetStatus

Brings information about currently active connection

SetConfig

Applies specified network configuration

GetConfig

Reads out provided network configuration

Validate

Validates the network configuration by applying it shortly. If DHCP is configured, it checks if it can acquire an IPv4 address. For static IP address, the validation only works for wireless networks. It then, still cannot allocate a manual IP address if the credentials are wrong.

The validation does not yet separate error messages for misconfigured wireless credentials or wrongly configured DHCP server. Thus, the issue is not necessarily on the device side.

Request

Request to validate method

Table 2. Available fields in blickfeld.system.services.NetworkValidateRequest
Field Type Default Unit

config

config.Network

-

-

Configuration which should be validated

Response

Response to validate method

Table 3. Available fields in blickfeld.system.services.NetworkValidateResponse
Field Type Default Unit

status

data.NetworkStatus

-

-

Status message with allocated IP addresses

GetMacAddresses

Get MAC addresses of the available interfaces

Response

Response with mac addresses

Table 4. Available fields in blickfeld.system.services.NetworkGetMacAddressesResponse
Field Type Default Unit

ethernet

string

-

-

Mac address of ethernet / LAN interface

wireless

string

-

-

Mac address of wireless / WiFi interface