michaelh/zephyr
1
0
Fork 0
Code Releases Activity

subsys/mgmt/hawkbit: change 'Hawkbit' & 'hawkbit' to 'hawkBit'

Browse source 
Change 'Hawkbit' and 'hawkbit' to 'hawkBit' wherever
makes sense, and a bit of touch ups here and there.

Signed-off-by: Yong Cong Sin <yongcong.sin@gmail.com>
This commit is contained in:
Yong Cong Sin 2024-04-03 22:46:02 +08:00 • committed by Fabio Baltieri
commit 10592b9df4
9 changed files with 46 additions and 46 deletions
Download patch file Download diff file Expand all files Collapse all files

8
samples/subsys/mgmt/hawkbit/Kconfig
View file

@ -3,22 +3,22 @@
# #
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# #
mainmenu "Hawkbit sample configuration" mainmenu "hawkBit sample configuration"
choice choice
prompt "Hawkbit mode" prompt "hawkBit mode"
default HAWKBIT_POLLING default HAWKBIT_POLLING
depends on HAWKBIT depends on HAWKBIT
config HAWKBIT_POLLING config HAWKBIT_POLLING
bool "Hawkbit Polling mode" bool "hawkBit Polling mode"
help help
Polling mode runs automatically on a predefined period, probing the Polling mode runs automatically on a predefined period, probing the
server for updates and installing them without requiring user server for updates and installing them without requiring user
intervention. intervention.
config HAWKBIT_MANUAL config HAWKBIT_MANUAL
bool "Hawkbit manual mode" bool "hawkBit manual mode"
help help
Manual mode requires the user to call the server probe and then, if Manual mode requires the user to call the server probe and then, if
there is an available update, also requires the user to decide if there is an available update, also requires the user to decide if

24
samples/subsys/mgmt/hawkbit/README.rst
View file

@ -11,7 +11,7 @@ The Eclipse hawkBit update server provides REST resources which are consumed by
device to retrieve software update tasks. This API is based on HTTP standards device to retrieve software update tasks. This API is based on HTTP standards
and a polling mechanism. and a polling mechanism.
This sample shows how to use Hawkbit DDI API in both a polling and manual This sample shows how to use hawkBit DDI API in both a polling and manual
update mode. update mode.
Polling mode run automatically on a predefined period, probing the server Polling mode run automatically on a predefined period, probing the server
@ -25,7 +25,7 @@ source code for this mode hawkbit_manual
Caveats Caveats
******* *******
* The Zephyr port of ``Hawkbit`` is configured to run on a * The Zephyr port of hawkBit is configured to run on a
:ref:`Freedom-K64F <frdm_k64f>` MCU by default. The application should :ref:`Freedom-K64F <frdm_k64f>` MCU by default. The application should
build and run for other platforms with support internet connection. Some build and run for other platforms with support internet connection. Some
platforms need some modification. Overlay files would be needed to support platforms need some modification. Overlay files would be needed to support
@ -33,14 +33,14 @@ Caveats
understanding that most other connectivity options would require an edge understanding that most other connectivity options would require an edge
gateway of some sort (Border Router, etc). gateway of some sort (Border Router, etc).
* The MCUboot bootloader is required for ``Hawkbit`` to function properly. * The MCUboot bootloader is required for hawkBit to function properly.
More information about the Device Firmware Upgrade subsystem and MCUboot More information about the Device Firmware Upgrade subsystem and MCUboot
can be found in :ref:`mcuboot`. can be found in :ref:`mcuboot`.
Building and Running Building and Running
******************** ********************
The below steps describe how to build and run the ``Hawkbit`` sample in The below steps describe how to build and run the hawkBit sample in
Zephyr. Where examples are given, it is assumed the sample is being build for Zephyr. Where examples are given, it is assumed the sample is being build for
the Freedom-K64F Development Kit (``BOARD=frdm_k64f``). the Freedom-K64F Development Kit (``BOARD=frdm_k64f``).
@ -60,7 +60,7 @@ be done by,
west flash west flash
Step 3: Start the Hawkbit Docker Step 3: Start the hawkBit Docker
================================ ================================
By default, the hawkbit application is set to run on http at port:8080. By default, the hawkbit application is set to run on http at port:8080.
@ -75,10 +75,10 @@ This will start the hawkbit server on the host system.Opening your browser to
the server URL, ``<your-ip-address>:8080``, and logging into the server using the server URL, ``<your-ip-address>:8080``, and logging into the server using
``admin`` as the login and password by default. ``admin`` as the login and password by default.
Step 4: Build Hawkbit Step 4: Build hawkBit
===================== =====================
``Hawkbit`` can be built for the frdm_k64f as follows: hawkBit can be built for the frdm_k64f as follows:
.. zephyr-app-commands:: .. zephyr-app-commands::
:zephyr-app: samples/subsys/mgmt/hawkbit :zephyr-app: samples/subsys/mgmt/hawkbit
@ -102,7 +102,7 @@ From this section onwards you use a binary (``.bin``) image format.
The command above creates a signed and confirmed image file called The command above creates a signed and confirmed image file called
:file:`zephyr.signed.confirmed.bin` in the build directory. It's important for :file:`zephyr.signed.confirmed.bin` in the build directory. It's important for
the first image to be confirmed as MCUboot isn't able to confirm an image that the first image to be confirmed as MCUboot isn't able to confirm an image that
is flashed using a hardware tool, and Hawkbit will reboot to trigger a firmware is flashed using a hardware tool, and hawkBit will reboot to trigger a firmware
swap if it isn't able to confirm the running image on init. swap if it isn't able to confirm the running image on init.
Step 6: Flash the first image Step 6: Flash the first image
@ -123,7 +123,7 @@ upload a firmware binary to the server, and update it using this UI.
Step 7: Building and signing the test image Step 7: Building and signing the test image
=========================================== ===========================================
The easiest way to test the functionality of Hawkbit is to repeat step 4 to The easiest way to test the functionality of hawkBit is to repeat step 4 to
build the sample again, so that the build time will be different. Then, similar build the sample again, so that the build time will be different. Then, similar
to step 5, sign the image and assign it a different version number but without to step 5, sign the image and assign it a different version number but without
confirming it like so: confirming it like so:
@ -143,7 +143,7 @@ Then upload the signed image to the server with Upload file Icon.
Click on distribution icon in the left pane of UI and create a new Distribution Click on distribution icon in the left pane of UI and create a new Distribution
with type Apps only (``name:frdm_k64f_update,version:1.0.1``). Assign the with type Apps only (``name:frdm_k64f_update,version:1.0.1``). Assign the
``hawkbit`` software module to the created distribution. Click on Deployment hawkBit software module to the created distribution. Click on Deployment
icon in the left pane of UI and assign the ``frdm_k64f_update`` distribution to icon in the left pane of UI and assign the ``frdm_k64f_update`` distribution to
the target ``frdm_k64f``. the target ``frdm_k64f``.
@ -278,13 +278,13 @@ Change authentication security from false to true.
java -jar ./hawkbit-runtime/hawkbit-update-server/target/ \ java -jar ./hawkbit-runtime/hawkbit-update-server/target/ \
hawkbit-update-server-#version#-SNAPSHOT.jar hawkbit-update-server-#version#-SNAPSHOT.jar
Step 11: Build Hawkbit HTTPS Step 11: Build hawkBit HTTPS
============================ ============================
* Convert the server.pem file to self_sign.der and place the der file in * Convert the server.pem file to self_sign.der and place the der file in
hawkbit/src directory hawkbit/src directory
``Hawkbit https`` can be built for the frdm_k64f as follows: ``hawkBit https`` can be built for the frdm_k64f as follows:
.. zephyr-app-commands:: .. zephyr-app-commands::
:zephyr-app: samples/subsys/mgmt/hawkbit :zephyr-app: samples/subsys/mgmt/hawkbit

8
samples/subsys/mgmt/hawkbit/prj.conf
View file

@ -1,4 +1,4 @@
#Turn on the Hawkbit #Enable hawkBit
CONFIG_HAWKBIT=y CONFIG_HAWKBIT=y
CONFIG_NVS=y CONFIG_NVS=y
CONFIG_FLASH=y CONFIG_FLASH=y
@ -18,7 +18,7 @@ CONFIG_BOOTLOADER_MCUBOOT=y
#Main Stack Size #Main Stack Size
CONFIG_MAIN_STACK_SIZE=4096 CONFIG_MAIN_STACK_SIZE=4096
#Minimal Heap mem pool size for the Hawkbit working #Minimal Heap mem pool size for hawkBit to work
CONFIG_HEAP_MEM_POOL_SIZE=4096 CONFIG_HEAP_MEM_POOL_SIZE=4096
CONFIG_SYSTEM_WORKQUEUE_STACK_SIZE=4096 CONFIG_SYSTEM_WORKQUEUE_STACK_SIZE=4096
@ -42,10 +42,10 @@ CONFIG_HAWKBIT_SHELL=y
CONFIG_KERNEL_SHELL=y CONFIG_KERNEL_SHELL=y
CONFIG_SHELL_STACK_SIZE=4096 CONFIG_SHELL_STACK_SIZE=4096
#Hawkbit polling mode #hawkBit polling mode
CONFIG_HAWKBIT_POLLING=y CONFIG_HAWKBIT_POLLING=y
#Config Hawkbit Server #Config hawkBit Server
CONFIG_HAWKBIT_SERVER="192.168.1.110" CONFIG_HAWKBIT_SERVER="192.168.1.110"
#Debug helpers #Debug helpers

2
samples/subsys/mgmt/hawkbit/sample.yaml
View file

@ -1,7 +1,7 @@
common: common:
filter: CONFIG_FULL_LIBC_SUPPORTED filter: CONFIG_FULL_LIBC_SUPPORTED
sample: sample:
description: Hawkbit Firmware Over-the-Air (FOTA) description: hawkBit Firmware Over-the-Air (FOTA)
name: hawkbit name: hawkbit
tests: tests:
sample.net.hawkbit: sample.net.hawkbit:

12
samples/subsys/mgmt/hawkbit/src/main.c
View file

@ -24,7 +24,7 @@ int main(void)
{ {
int ret = -1; int ret = -1;
LOG_INF("Hawkbit sample app started"); LOG_INF("hawkBit sample app started");
LOG_INF("Image build time: " __DATE__ " " __TIME__); LOG_INF("Image build time: " __DATE__ " " __TIME__);
app_dhcpv4_startup(); app_dhcpv4_startup();
@ -37,16 +37,16 @@ int main(void)
ret = hawkbit_init(); ret = hawkbit_init();
if (ret < 0) { if (ret < 0) {
LOG_ERR("Failed to init hawkbit"); LOG_ERR("Failed to init hawkBit");
} }
#if defined(CONFIG_HAWKBIT_POLLING) #if defined(CONFIG_HAWKBIT_POLLING)
LOG_INF("Starting hawkbit polling mode"); LOG_INF("Starting hawkBit polling mode");
hawkbit_autohandler(); hawkbit_autohandler();
#endif #endif
#if defined(CONFIG_HAWKBIT_MANUAL) #if defined(CONFIG_HAWKBIT_MANUAL)
LOG_INF("Starting hawkbit manual mode"); LOG_INF("Starting hawkBit manual mode");
switch (hawkbit_probe()) { switch (hawkbit_probe()) {
case HAWKBIT_UNCONFIRMED_IMAGE: case HAWKBIT_UNCONFIRMED_IMAGE:
@ -63,7 +63,7 @@ int main(void)
break; break;
case HAWKBIT_CANCEL_UPDATE: case HAWKBIT_CANCEL_UPDATE:
LOG_INF("Hawkbit update cancelled from server"); LOG_INF("hawkBit update cancelled from server");
break; break;
case HAWKBIT_OK: case HAWKBIT_OK:
@ -75,7 +75,7 @@ int main(void)
break; break;
case HAWKBIT_PROBE_IN_PROGRESS: case HAWKBIT_PROBE_IN_PROGRESS:
LOG_INF("Hawkbit is already running"); LOG_INF("hawkBit is already running");
break; break;
default: default:

20
subsys/mgmt/hawkbit/Kconfig
View file

@ -2,7 +2,7 @@
# SPDX -License-Identifier: Apache-2.0 # SPDX -License-Identifier: Apache-2.0
menuconfig HAWKBIT menuconfig HAWKBIT
bool "Hawkbit Firmware Over-the-Air support" bool "Eclipse hawkBit Firmware Over-the-Air support"
depends on NVS depends on NVS
depends on FLASH depends on FLASH
depends on REBOOT depends on REBOOT
@ -19,7 +19,7 @@ menuconfig HAWKBIT
select IMG_ENABLE_IMAGE_CHECK select IMG_ENABLE_IMAGE_CHECK
select IMG_ERASE_PROGRESSIVELY select IMG_ERASE_PROGRESSIVELY
help help
Hawkbit is a domain independent back-end framework for polling out hawkBit is a domain independent back-end framework for polling out
software updates to constrained edge devices as well as more powerful software updates to constrained edge devices as well as more powerful
controllers and gateways connected to IP based networking infrastructure. controllers and gateways connected to IP based networking infrastructure.
@ -33,10 +33,10 @@ config HAWKBIT_POLL_INTERVAL
This time interval is zero and 43200 minutes(30 days). This time interval is zero and 43200 minutes(30 days).
config HAWKBIT_SHELL config HAWKBIT_SHELL
bool "Hawkbit shell utilities" bool "hawkBit shell utilities"
depends on SHELL depends on SHELL
help help
Activate shell module that provides Hawkbit commands. Activate shell module that provides hawkBit commands.
config HAWKBIT_SERVER config HAWKBIT_SERVER
string "User address for the hawkbit server" string "User address for the hawkbit server"
@ -51,23 +51,23 @@ config HAWKBIT_PORT
Configure the hawkbit port number. Configure the hawkbit port number.
choice HAWKBIT_DDI_SECURITY choice HAWKBIT_DDI_SECURITY
prompt "Hawkbit DDI API authentication modes" prompt "hawkBit DDI API authentication modes"
default HAWKBIT_DDI_NO_SECURITY default HAWKBIT_DDI_NO_SECURITY
config HAWKBIT_DDI_NO_SECURITY config HAWKBIT_DDI_NO_SECURITY
bool "No authentication security" bool "No authentication security"
help help
No authentication security for the Hawkbit DDI API. No authentication security for the hawkBit DDI API.
config HAWKBIT_DDI_TARGET_SECURITY config HAWKBIT_DDI_TARGET_SECURITY
bool "Use target security token authentication" bool "Use target security token authentication"
help help
Use target security token authentication for the Hawkbit DDI API. Use target security token authentication for the hawkBit DDI API.
config HAWKBIT_DDI_GATEWAY_SECURITY config HAWKBIT_DDI_GATEWAY_SECURITY
bool "Use gateway security token authentication" bool "Use gateway security token authentication"
help help
Use gateway security token authentication for the Hawkbit DDI API. Use gateway security token authentication for the hawkBit DDI API.
endchoice endchoice
@ -76,12 +76,12 @@ config HAWKBIT_DDI_SECURITY_TOKEN
depends on HAWKBIT_DDI_TARGET_SECURITY || HAWKBIT_DDI_GATEWAY_SECURITY depends on HAWKBIT_DDI_TARGET_SECURITY || HAWKBIT_DDI_GATEWAY_SECURITY
default "" default ""
help help
Authentication security token for the configured Hawkbit DDI Authentication security token for the configured hawkBit DDI
authentication mode. authentication mode.
module = HAWKBIT module = HAWKBIT
module-str = Log Level for hawkbit module-str = Log Level for hawkbit
module-help = Enables logging for Hawkbit code. module-help = Enables logging for hawkBit code.
source "subsys/logging/Kconfig.template.log_config" source "subsys/logging/Kconfig.template.log_config"
endif endif

6
subsys/mgmt/hawkbit/hawkbit.c
View file

@ -348,7 +348,7 @@ static int hawkbit_device_acid_update(int32_t new_value)
} }
/* /*
* Update sleep interval, based on results from hawkbit base polling * Update sleep interval, based on results from hawkBit base polling
* resource * resource
*/ */
static void hawkbit_update_sleep(struct hawkbit_ctl_res *hawkbit_res) static void hawkbit_update_sleep(struct hawkbit_ctl_res *hawkbit_res)
@ -513,7 +513,7 @@ static int hawkbit_parse_deployment(struct hawkbit_dep_res *res, int32_t *json_a
/* /*
* Find the download-http href. We only support the DEFAULT * Find the download-http href. We only support the DEFAULT
* tenant on the same hawkbit server. * tenant on the same hawkBit server.
*/ */
href = artifact->_links.download_http.href; href = artifact->_links.download_http.href;
if (!href) { if (!href) {
@ -1004,7 +1004,7 @@ enum hawkbit_response hawkbit_probe(void)
} }
/* /*
* Query the hawkbit base polling resource. * Query the hawkBit base polling resource.
*/ */
LOG_INF("Polling target data from hawkBit"); LOG_INF("Polling target data from hawkBit");

2
subsys/mgmt/hawkbit/hawkbit_priv.h
View file

@ -7,7 +7,7 @@
/** @file /** @file
* *
* @brief This file contains structures representing JSON messages * @brief This file contains structures representing JSON messages
* exchanged with a hawkbit * exchanged with a hawkBit server
*/ */
#ifndef __HAWKBIT_PRIV_H__ #ifndef __HAWKBIT_PRIV_H__

10
subsys/mgmt/hawkbit/shell.c
View file

@ -18,7 +18,7 @@ static void cmd_run(const struct shell *sh, size_t argc, char **argv)
ARG_UNUSED(argc); ARG_UNUSED(argc);
ARG_UNUSED(argv); ARG_UNUSED(argv);
shell_fprintf(sh, SHELL_INFO, "Starting Hawkbit run...\n"); shell_fprintf(sh, SHELL_INFO, "Starting hawkBit run...\n");
switch (hawkbit_probe()) { switch (hawkbit_probe()) {
case HAWKBIT_UNCONFIRMED_IMAGE: case HAWKBIT_UNCONFIRMED_IMAGE:
shell_fprintf( shell_fprintf(
@ -30,7 +30,7 @@ static void cmd_run(const struct shell *sh, size_t argc, char **argv)
case HAWKBIT_CANCEL_UPDATE: case HAWKBIT_CANCEL_UPDATE:
shell_fprintf(sh, SHELL_INFO, shell_fprintf(sh, SHELL_INFO,
"Hawkbit update Cancelled from server\n"); "hawkBit update Cancelled from server\n");
break; break;
case HAWKBIT_NO_UPDATE: case HAWKBIT_NO_UPDATE:
@ -84,8 +84,8 @@ static int cmd_info(const struct shell *sh, size_t argc, char *argv)
SHELL_STATIC_SUBCMD_SET_CREATE( SHELL_STATIC_SUBCMD_SET_CREATE(
sub_hawkbit, sub_hawkbit,
SHELL_CMD(info, NULL, "Dump Hawkbit information", cmd_info), SHELL_CMD(info, NULL, "Dump hawkBit information", cmd_info),
SHELL_CMD(run, NULL, "Trigger an Hawkbit update run", cmd_run), SHELL_CMD(run, NULL, "Trigger an hawkBit update run", cmd_run),
SHELL_SUBCMD_SET_END); SHELL_SUBCMD_SET_END);
SHELL_CMD_REGISTER(hawkbit, &sub_hawkbit, "Hawkbit commands", NULL); SHELL_CMD_REGISTER(hawkbit, &sub_hawkbit, "hawkBit commands", NULL);