OnboardService - Manual - Industrial Edge Platform - Industrial Edge - Industrial Edge - Documentation of the Industrial Edge Platform - IEM - Hub - Industrial - Device - IED - Edge - IEH

Industrial Edge Platform Operation - APIs & References

Portfolio
Industrial Edge
Product
Industrial Edge Platform
Edition
02/2025
Language
en-US (original)

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.