SystemService - Manual - Industrial Edge - Industrial Edge - Industrial Edge - Documentation of Industrial Edge APIs - CLI tools - Industrial Edge - References - APIs

Industrial Edge Platform Operation - APIs & References

Product
Industrial Edge
Edition
12/2024
Language
en-US (original)

System service ,uses a UNIX Domain Socket "/var/run/devicemodel/system.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
RestartDevice .google.protobuf.Empty .google.protobuf.Empty Restarts the device
ShutdownDevice .google.protobuf.Empty .google.protobuf.Empty ShutsDown the device.
HardReset .google.protobuf.Empty .google.protobuf.Empty Performs host side actions in addition to edge-core for hard reset. e.g: cleaning hard-reset flag(mandatory) ,custom Device Builder steps(optional) and finally reboots the system(mandatory).
GetModelNumber .google.protobuf.Empty ModelNumber Returns model number (mlfb) for siemens or any type model for 3rd party vendors.
GetFirmwareInfo .google.protobuf.Empty FirmwareInfo Returns firmware information of currently installed firmware
GetResourceStats .google.protobuf.Empty Stats Returns current Cpu, Memory, Uptime and Storage usage
GetLimits .google.protobuf.Empty Limits Returns limits for how many applications and how much cpu, ram and storage should be available for applications.
GetCustomSettings .google.protobuf.Empty .google.protobuf.Any Returns device specific custom settings.
ApplyCustomSettings .google.protobuf.Any .google.protobuf.Empty Applies device specific custom settings.
GetLogFile LogRequest LogResponse Collects and compress all Journald logs (mandatory) from host ,(plus optional device specific log/report) and then returns a single file path for this new log archive.