Onboard Service

The Onboard Service is a gRPC & Go based Edge Core activator. This service communicates with all other services and provides the necessary configurations for the Edge Device to successfully onboard.

Table of Contents

• Onboard.proto
• Agent
• Device
• DeviceConfiguration
• Onboarding
• OnboardingStatus
• ProxySettings

• Security

• OnboardService

• Scalar Value Types

Top

Onboard.proto

Agent

Agent section in IEM Onboarding JSON file.

Field	Type	Label	Description
name	string
proxy	string	repeated
agentId	string
security	Security

Device

Security section in IEM Onboarding JSON file.

Field	Type	Label	Description
Network	siemens.iedge.dmapi.network.v1.NetworkSettings
ntpServer	string	repeated
dockerIP	string
customConfiguration	google.protobuf.Any		Device Builder specific custom configuraiton.

DeviceConfiguration

Corresponding proto message for JSON file that had downloaded from IEM. Onboarding JSON file needs to be converted to this type first. Compatible with IEM Onboarding JSON schema, since all field names are same. For more information please refer to IEM Onboarding JSON scheme.

Field	Type	Label	Description
Device	Device		Device seciton in IEM Onboarding JSON file.
onboarding	Onboarding		Onboarding section in IEM Onboarding JSON file.
agents	Agent	repeated	Agent section in IEM Onboarding JSON file.
proxies	ProxySettings	repeated	Proxy section in IEM Onboarding JSON file.

Onboarding

Onboarding section in IEM Onboarding JSON file.

Field	Type	Label	Description
localUserName	string
localPassword	string
deviceName	string
deviceId	string
platformActualName	string
softwarePlatformName	string
potalUrl	string
nodeId	string
userId	string
deviceType	string
swPlatformId	string
platformId	string
isActivationConfirmed	bool
deviceRole	string

OnboardingStatus

Type indicates the Onboarding Status.

Field	Type	Label	Description
isOnboarded	bool		true if onboarding is successful,otherwise false.
message	string		Additonal information for onboarding status.

ProxySettings

Field	Type	Label	Description
proxyId	string
proxyType	string
host	string
protocol	string
authenticationType	string
user	string
password	string
noProxy	string
customPorts	int32	repeated

Security

Security section in IEM Onboarding JSON file.

Field	Type	Label	Description
baseUrl	string
clientCredentialProfile	string	repeated
ca_chain	string

OnboardService

Onboard service ,uses a UNIX Domain Socket "/var/run/devicemodel/onboard.sock" for GRPC communication. protoc generates both client and server instance for this Service. GRPC Status codes : https://developers.google.com/maps-booking/reference/grpc-api/status_codes .

Method Name	Request Type	Response Type	Description
OnboardWithUSB	DeviceConfiguration	.google.protobuf.Empty	Starts onboarding sequence,applies all settings via ApplyConfiguration() and finally calls EdgeCoreRuntime REST API to onboard the device.
ApplyConfiguration	DeviceConfiguration	.google.protobuf.Empty	Applies all settings. Does not call EdgeCoreRuntime REST API.Applicable for UI Onboarding.
SetOnboardingStatus	OnboardingStatus	.google.protobuf.Empty	Sets state for device onboard status.In Onboarding from UI, EdgeCoreRuntime calls this method to set the onboarding status.
ListenOnboardState	.google.protobuf.Empty	OnboardingStatus stream	Server stream for onboarding status changes.

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)