Zephyr: examples: add hello #129

szczys · 2023-07-19T16:37:25Z

add samples common support for hardcoded credentials
add samples common support for default configuration
select common symbols by default when building with zephyr port
add symbols to select between PSK and certificate auth
add the hello sample

github-actions · 2023-07-19T16:38:27Z

Visit the preview URL for this PR (updated for commit 9f9c43c):

https://golioth-firmware-sdk-doxygen-dev--pr129-szczys-zephyr-x726rk3c.web.app

_{(expires Fri, 04 Aug 2023 16:29:44 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: a9993e61697a3983f3479e468bcb0b616f9a0578}

port/zephyr/CMakeLists.txt

mniestroj · 2023-07-25T10:44:29Z

port/zephyr/Kconfig

+	select MBEDTLS
+	select MBEDTLS_DTLS if MBEDTLS_BUILTIN
+	select NET_SOCKETS
+	select NET_UDP
+	select ZCBOR
+	imply DNS_RESOLVER if NET_NATIVE
+	imply NET_SOCKETS_SOCKOPT_TLS
+	imply NET_SOCKETS_ENABLE_DTLS
+	help
+	  Enable library for communication with Golioth cloud.


Maybe let's remove those symbols from examples/zephyr/golioth_basics and actually see how much this simplifies prj.conf.

I have done so by adding this commit:
b9048cb

I was trying to keep golioth_basics as a more verbose example. Combining the default symbols from this commit with the common/Kconfig.defconfig committed later in this PR makes for nearly-empty prj.conf files in the more simplified samples.

There should be really just a single way how to configure examples. Otherwise such inconsistency is confusing to people wanting to compare those samples (e.g. "what does it take to configure more services at once, just like in golioth_basics sample").

Do you think it would be better to leave this commit out and move this set of symbol selection to the common/Kconfig.defconfig file for samples?

I discussed with @sam-golioth and have left these symbols as is for now.

port/zephyr/Kconfig

examples/zephyr/hello/README.md

examples/zephyr/common/Kconfig

examples/zephyr/common/hardcoded_credentials.c

examples/zephyr/golioth_basics/Kconfig

examples/zephyr/hello/README.md

examples/zephyr/common/Kconfig

examples/zephyr/hello/scripts/generate-keys.py

Use absolute path when sourcing other Kconfig files. Signed-off-by: Mike Szczys <[email protected]>

* Add GOLIOTH_SAMPLE_COMMON * Add the `hardcoded_credentials` samples common helper from the Golioth Zephyr SDK. * add `hardcoded_credentials_get()` to return a `golioth_client_config_t` used to create a Golioth client * PSK or PKI (certificate auth) are returned automatically based on the `CONFIG_GOLIOTH_AUTH_METHOD_CERT` symbol * PKI is not yet implemented in the port. Placeholder code must be updated/replace when support is available Signed-off-by: Mike Szczys <[email protected]>

Use the GOLIOTH_SAMPLE_CONFIG symbol to conditionally include the common library files in the build. Signed-off-by: Mike Szczys <[email protected]>

automatically select necessary symbols when Golioth is enabled in a build: * MBEDTLS * MBEDTLS_DTLS * NET_SOCKETS * NET_UDP * ZCBOR * DNS_RESOLVER * NET_SOCKETS_SOCKOPT_TLS * NET_SOCKETS_ENABLE_DTLS Signed-off-by: Mike Szczys <[email protected]>

* port/zephyr/Kconfig: add symbols to select either certificate or PSK auth * port/zephyr/Kconfig: add symbols to configure mbedtls based on auth type * examples/zephyr/common/Kconfig: add symbols to define PSK/PSK-ID and certificate symbols Signed-off-by: Mike Szczys <[email protected]>

sam-golioth · 2023-07-27T21:27:19Z

port/zephyr/Kconfig

-rsource '../../src/Kconfig'
+rsource '${ZEPHYR_GOLIOTH_FIRMWARE_SDK_MODULE_DIR}/src/Kconfig'
+
+config GOLIOTH_CIPHERSUITES


I don't think is being used anywhere, let's remove it.

I think we might need this. When I remove it I get this:

warning: the int symbol GOLIOTH_ZEPHYR_THREAD_STACK_SIZE (defined at /home/mike/golioth-compile/golioth-firmware-sdk/modules/lib/golioth-firmware-sdk/port/zephyr/Kconfig:121) has a non-int default GOLIOTH_COAP_THREAD_STACK_SIZE (undefined)

And I see that's in src/Kconfig:

➜ grep GOLIOTH_COAP_THREAD_STACK_SIZE ../../../src/Kconfig -A4 config GOLIOTH_COAP_THREAD_STACK_SIZE int "Golioth CoAP thread stack size" default 6144 help Thread stack size of the Golioth CoAP thread, in bytes.

Hmm, it doesn't seem like removing GOLIOTH_CIPHERSUITES should cause that particular error.

@sam-golioth I was confused by what you were commenting on. I thought you were asking to remove the rsource line.

Sorry that I merged before reading this comment. I can make a new PR to remove this block.

No worries! We're an agile team 😄

Ah, looking into this I remember why I added it. It's a value used in the twister testing:

golioth-firmware-sdk/examples/zephyr/hello/sample.yaml

Lines 40 to 48 in 8a0825b

sample.golioth.hello.psk.fast.ccm_8:

platform_allow: >

nrf52840dk_nrf52840

qemu_x86

extra_configs:

- CONFIG_MBEDTLS_CIPHER_GCM_ENABLED=n

- CONFIG_MBEDTLS_CIPHER_CCM_ENABLED=y

- CONFIG_MBEDTLS_CIPHER_MODE_CBC_ENABLED=n

- CONFIG_GOLIOTH_CIPHERSUITES="TLS_PSK_WITH_AES_128_CCM_8"

Do want me to remove the GOLIOTH_CIPHERSUITES along with that test?

sam-golioth · 2023-07-27T21:30:37Z

examples/zephyr/common/Kconfig.defconfig

+	default 2048 if MINIMAL_LIBC
+
+config LOG_PROCESS_THREAD_STACK_SIZE
+	default 2048 if LOG_BACKEND_GOLIOTH


There is no Golioth log backend yet, so we don't need this. Are there other settings in this file that go beyond what we need for these samples?

Ah, good point. I've removed everything form defconfig that wasn't directly used in the current state of golioth_basics.

sam-golioth · 2023-07-27T21:33:10Z

examples/zephyr/hello/prj.conf

+CONFIG_FLASH=y
+CONFIG_FLASH_MAP=y
+CONFIG_STREAM_FLASH=y
+CONFIG_IMG_MANAGER=y


Why do we need these flash and image symbols for a "hello" sample?

It seems like the DFU portions of the SDK are built automatically and I don't see a way to turn them off (the Zephyr SDK has a CONFIG_GOLIOTH_FW symbol for this).

In file included from /home/mike/golioth-compile/golioth-firmware-sdk/modules/lib/golioth-firmware-sdk/port/zephyr/golioth_fw_zephyr.c:1: /home/mike/golioth-compile/golioth-firmware-sdk/zephyr/include/zephyr/dfu/flash_img.h:33:21: error: 'CONFIG_IMG_BLOCK_BUF_SIZE' undeclared here (not in a function); did you mean 'CONFIG_ISR_STACK_SIZE'? 33 | uint8_t buf[CONFIG_IMG_BLOCK_BUF_SIZE]; | ^~~~~~~~~~~~~~~~~~~~~~~~~ | CONFIG_ISR_STACK_SIZE

These symbols are necessary to complete the build. But I don't think they should be part of the default config. I've left them here to be removed later when building DFU components is configurable.

Works for me! Can you file a ticket to make DFU configurable?

sam-golioth · 2023-07-27T21:33:41Z

examples/zephyr/golioth_basics/prj.conf

-CONFIG_DNS_RESOLVER=y
-CONFIG_NET_SOCKETS_SOCKOPT_TLS=y
-CONFIG_NET_SOCKETS_ENABLE_DTLS=y
-
 # TLS configuration
 CONFIG_MBEDTLS_ENABLE_HEAP=y
 CONFIG_MBEDTLS_HEAP_SIZE=10240


Some of these TLS options are enabled by GOLIOTH_AUTH_PSK_MBEDTLS_DEPS in port/zephyr/Kconfig so we don't need to set them here.

I've pared this prj.conf down to only the necessary symbols.

add symbols needed by all samples as the default when the common library is enabled. Signed-off-by: Mike Szczys <[email protected]>

Source the examples/zephyr/common/Kconfig from the main Zephyr port Kconfig file. All symbols in the common Kconfig are guarded and will only be built when `GOLIOTH_SAMPLE_COMMON` is selected. Signed-off-by: Mike Szczys <[email protected]>

Add the ciphersuites Kconfig options. These are used during Twister testing. Signed-off-by: Mike Szczys <[email protected]>

Remove the symbols that are now selected by default. This commit also changes the name of the symbol used for PSK/PSK-ID from CONFIG_GOLIOTH_* to CONFIG_GOLIOTH_SAMPLE_*. Signed-off-by: Mike Szczys <[email protected]>

Add a sample that sends "hello world" style message to Golioth. Includes support for qemu_x86 and nrf52840dk_nrf52840. Signed-off-by: Mike Szczys <[email protected]>

ignore hidden .cache directories created by vim Signed-off-by: Mike Szczys <[email protected]>

szczys marked this pull request as draft July 19, 2023 16:40

szczys force-pushed the szczys/zephyr-samples-add-hello branch 5 times, most recently from cac7bca to 1ba6838 Compare July 20, 2023 14:11

szczys marked this pull request as ready for review July 20, 2023 14:34

szczys requested review from mniestroj and sam-golioth July 20, 2023 14:34

szczys force-pushed the szczys/zephyr-samples-add-hello branch from 1ba6838 to d10685c Compare July 20, 2023 15:56

szczys changed the title ~~Szczys/zephyr samples add hello~~ Zephyr: examples: add hello Jul 24, 2023

szczys force-pushed the szczys/zephyr-samples-add-hello branch 4 times, most recently from 09c668c to 60168c2 Compare July 24, 2023 22:36

mniestroj reviewed Jul 25, 2023

View reviewed changes

szczys force-pushed the szczys/zephyr-samples-add-hello branch from 60168c2 to 2939c17 Compare July 25, 2023 22:27

sam-golioth reviewed Jul 26, 2023

View reviewed changes

szczys force-pushed the szczys/zephyr-samples-add-hello branch 4 times, most recently from 27ab152 to 750d9d6 Compare July 26, 2023 21:18

szczys added 5 commits July 26, 2023 16:19

port/zephyr/Kconfig: use absolute path

5cc53c6

Use absolute path when sourcing other Kconfig files. Signed-off-by: Mike Szczys <[email protected]>

examples/zephyr/common: include common lib

7158586

Use the GOLIOTH_SAMPLE_CONFIG symbol to conditionally include the common library files in the build. Signed-off-by: Mike Szczys <[email protected]>

szczys force-pushed the szczys/zephyr-samples-add-hello branch from 750d9d6 to fdc33ca Compare July 26, 2023 21:23

szczys requested a review from mniestroj July 26, 2023 21:43

szczys requested a review from sam-golioth July 26, 2023 21:43

sam-golioth reviewed Jul 27, 2023

View reviewed changes

sam-golioth approved these changes Jul 27, 2023

View reviewed changes

sam-golioth reviewed Jul 27, 2023

View reviewed changes

sam-golioth self-requested a review July 27, 2023 21:30

sam-golioth reviewed Jul 27, 2023

View reviewed changes

szczys added 6 commits July 28, 2023 11:27

zephyr/samples/common: add default configuration

a8703e3

add symbols needed by all samples as the default when the common library is enabled. Signed-off-by: Mike Szczys <[email protected]>

port/zephyr/Kconfig: source common Kconfig

36e847f

Source the examples/zephyr/common/Kconfig from the main Zephyr port Kconfig file. All symbols in the common Kconfig are guarded and will only be built when `GOLIOTH_SAMPLE_COMMON` is selected. Signed-off-by: Mike Szczys <[email protected]>

zephyr/Kconfig: add GOLIOTH_CIPHERSUITES

e0597fa

Add the ciphersuites Kconfig options. These are used during Twister testing. Signed-off-by: Mike Szczys <[email protected]>

zephyr: golioth_basics: remove default symbols

1edab73

Remove the symbols that are now selected by default. This commit also changes the name of the symbol used for PSK/PSK-ID from CONFIG_GOLIOTH_* to CONFIG_GOLIOTH_SAMPLE_*. Signed-off-by: Mike Szczys <[email protected]>

examples/zephyr: add hello sample

08514ef

Add a sample that sends "hello world" style message to Golioth. Includes support for qemu_x86 and nrf52840dk_nrf52840. Signed-off-by: Mike Szczys <[email protected]>

gitignore: ignore .cache

9f9c43c

ignore hidden .cache directories created by vim Signed-off-by: Mike Szczys <[email protected]>

szczys force-pushed the szczys/zephyr-samples-add-hello branch from fdc33ca to 9f9c43c Compare July 28, 2023 16:28

szczys merged commit 8a0825b into develop Jul 28, 2023
12 checks passed

szczys deleted the szczys/zephyr-samples-add-hello branch July 28, 2023 16:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Zephyr: examples: add hello #129

Zephyr: examples: add hello #129

szczys commented Jul 19, 2023 •

edited

Loading

github-actions bot commented Jul 19, 2023 •

edited

Loading

mniestroj Jul 25, 2023

szczys Jul 25, 2023

mniestroj Jul 26, 2023

szczys Jul 26, 2023

szczys Jul 26, 2023

sam-golioth Jul 27, 2023

szczys Jul 28, 2023

sam-golioth Jul 28, 2023

szczys Jul 28, 2023

sam-golioth Jul 28, 2023

szczys Jul 28, 2023

sam-golioth Jul 27, 2023

szczys Jul 28, 2023

sam-golioth Jul 27, 2023 •

edited

Loading

szczys Jul 28, 2023 •

edited

Loading

sam-golioth Jul 28, 2023

sam-golioth Jul 27, 2023

szczys Jul 28, 2023

	sample.golioth.hello.psk.fast.ccm_8:
	platform_allow: >
	nrf52840dk_nrf52840
	qemu_x86
	extra_configs:
	- CONFIG_MBEDTLS_CIPHER_GCM_ENABLED=n
	- CONFIG_MBEDTLS_CIPHER_CCM_ENABLED=y
	- CONFIG_MBEDTLS_CIPHER_MODE_CBC_ENABLED=n
	- CONFIG_GOLIOTH_CIPHERSUITES="TLS_PSK_WITH_AES_128_CCM_8"

Zephyr: examples: add hello #129

Zephyr: examples: add hello #129

Conversation

szczys commented Jul 19, 2023 • edited Loading

github-actions bot commented Jul 19, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sam-golioth Jul 27, 2023 • edited Loading

Choose a reason for hiding this comment

szczys Jul 28, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

szczys commented Jul 19, 2023 •

edited

Loading

github-actions bot commented Jul 19, 2023 •

edited

Loading

sam-golioth Jul 27, 2023 •

edited

Loading

szczys Jul 28, 2023 •

edited

Loading