gRPC API Documentation

Methods

GetAvailableUpdateBundles

Signature

func GetAvailableUpdateBundles(req GetAvailableUpdateBundlesRequest) GetAvailableUpdateBundlesResponse

Description

Retrieves a list of available update bundles from the specified update URL.

GetAvailableUpdateBundlesRequest Fields

Field	Type	Description
updateUrl	string	URL to the update source to check updates

These update URLs are currently supported:

URL	Description
usb:directory-path	USB-Stick
file://update-file	file in local filesystem
http://cloud-service	cloud update
https://cloud-service	cloud update

GetAvailableUpdateBundlesResponse Fields

Field	Type	Description
engineVersion	string	Version of the update engine.
isError	bool	Indicates if an error occurred.
message	string	Additional information or error message.
currentVersion	string	Current version of installed bundle.
installedComponents	map[string]string	Installed components and their versions.
availableBundles	[]UpdateBundle	List of available update bundles.

InstallUpdateBundle

Signature

func InstallUpdateBundle(req InstallUpdateBundleRequest) (stream InstallUpdateBundleResponse)

Description

Initiates the installation of a specified update bundle.

InstallUpdateBundleRequest Fields

Field	Type	Description
bundleUrl	string	URL of the update bundle to install.

InstallUpdateBundleResponse Fields

Field	Type	Description
progress	float	Progress of the installation (percentage).
isDone	bool	Indicates if the installation is complete.
isError	bool	Indicates if an error occurred.
message	string	Additional information or error message.

Reboot

Signature

func Reboot() EmptyResponse

Description

Performs a system reboot operation.

EmptyResponse Fields

No fields (empty response).

GetStatus

Signature

func GetStatus() GetStatusResponse

Description

Retrieves the current status, indicating if a rollback is needed.

GetStatusResponse Fields

Field	Type	Description
shouldRollback	bool	Indicates if a rollback should be performed.

Rollback

Signature

func Rollback() RollbackResponse

Description

Executes a rollback to the previous state.

RollbackResponse Fields

Field	Type	Description
isError	bool	Indicates if an error occurred.
message	string	Additional information or error message.

GetClientInformation

Signature

func GetClientInformation() GetClientInformationResponse

Description

Retrieves information specific to the client device or application.

GetClientInformationResponse Fields

Field	Type	Description
source	string	Bundle source url used for initial installation
bootStrap	string	Bootstrap program that starts when no firmware is installed.
tmpDir	string	Temporary directory path.
customer	string	Customer identifier.
product	string	Product identifier.
infos	map[string]string	Additional user-defined key-value information.

GetInstalledBundleInformation

Signature

func GetInstalledBundleInformation() GetInstalledBundleInformationResponse

Description

Retrieves information about the currently installed update bundle.

GetInstalledBundleInformationResponse Fields

Field	Type	Description
componentVersions	map[string]string	Versions of components in the bundle.
userInformation	map[string]string	User-specific information in the bundle.

Structures

UpdateBundle

Description

UpdateBundle represents an update bundle with its URL, version, and associated component and user data.

Fields

Field	Type	Description
bundleUrl	string	URL of the update bundle.
bundleVersion	string	Version of the update bundle.
componentVersions	map[string]string	Versions of individual components in the bundle.
userData	map[string]string	Additional user-specific data.