From 2dbf9d7fccd7573c73496684a4518bdaa8ddcfb3 Mon Sep 17 00:00:00 2001 From: Mike Sul Date: Mon, 12 Feb 2024 16:50:20 +0100 Subject: [PATCH] ug: Update the custom sota client doc Extend the custom sota client doc with info on new modes it supports. Signed-off-by: Mike Sul --- source/user-guide/custom-sota-client.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/source/user-guide/custom-sota-client.rst b/source/user-guide/custom-sota-client.rst index 985635642..560bbbb64 100644 --- a/source/user-guide/custom-sota-client.rst +++ b/source/user-guide/custom-sota-client.rst @@ -49,3 +49,21 @@ Producing a factory-specific SOTA client can be done by: .. _custom-sota-client: https://github.com/foundriesio/meta-lmp/tree/main/meta-lmp-base/recipes-sota/custom-sota-client + +Custom SOTA Client Work Modes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +By default, the the example `SOTA client`_ works as a daemon updating a device to the latest version once it becomes available. +In addition to the default daemon mode, users can run it as a CLI utility and perform specific steps of the overall update process separately. + +.. prompt:: bash + + /build-custom/custom-sota-client --help + Usage: + custom-sota-client [cmd] [options] + Supported commands: check install run pull daemon + Default command is "daemon" + +* ``check`` - updates the device's TUF repo with the latest factory's TUF metadata or with the TUF metadata specified in the offline update bundle, and checks if there is a newer than currently installed target. +* ``pull`` - pulls the delta between the currently installed and the specified one. +* ``install`` - installs the previously pulled target; yields an error if the specified target has not been pulled before. +* ``run`` - finalizes the installed target; confirms an update after reboot on a new rootfs version and/or starts the updated apps. \ No newline at end of file