nRF Cloud CoAP Sample #11648

plskeggs · 2023-06-28T21:51:26Z

This sample is used to demonstrate the nRF Cloud CoAP library in PR: #11535.

This PR contains the sample that previously had been contained within the above PR.

Only the 2 last commits belong to this current PR.

NordicBuilder · 2023-06-30T03:53:12Z

Test specification

CI/Jenkins/NRF

Integration Platforms

CI/Jenkins/integration

Test Module	File based changes	Manually selected	West overwrite
test-ci-nrfconnect-boot-fw-update	X
test-fw-nrfconnect-nrf-iot_cloud	X
test-fw-nrfconnect-nrf-iot_mosh	X
test-fw-nrfconnect-nrf-iot_positioning	X
test-fw-nrfconnect-nrf-iot_serial_lte_modem	X
test-fw-nrfconnect-nrf-iot_thingy91	X

Detailed information of selected test modules

Note: This message is automatically posted and updated by the CI

NordicBuilder · 2023-06-30T06:13:44Z

You can find the documentation preview for this PR at this link. It will be updated about 10 minutes after the documentation build succeeds.

Note: This comment is automatically posted by the Documentation Publishing GitHub Action.

samples/nrf9160/nrf_cloud_coap_client/overlay-nrf7002ek-wifi-scan-only.conf

samples/nrf9160/nrf_cloud_coap_client/Kconfig

jayteemo · 2023-06-30T19:07:39Z

samples/nrf9160/nrf_cloud_coap_client/src/handle_fota.c

a lot of this is copied from the REST sample.
as a separate ticket, can we make a "FOTA helpers" module for the shared stuff?
it might make sense for it to live in the samples folder.
regardless, it would be better to not have to maintain duplicate code.

Yes, I did this to expedite testing of FOTA without getting distracted with a refactor.

I agree it should be reusable. I think it should live as a helper module within the nrfcloud library folder.

samples/nrf9160/nrf_cloud_coap_client/src/main.c

samples/nrf9160/nrf_cloud_coap_client/src/handle_fota.c

jayteemo · 2023-06-30T20:05:37Z

samples/nrf9160/nrf_cloud_coap_client/src/main.c

+ LOG_ERR("A-GPS data processing failed, error: %d", err);
+ } else {
+ LOG_INF("A-GPS data processed");
+ got_agps = true;


this is never set back to false, so A-GPS is only done once in the sample's lifetime?

Yes, I have not decided whether I should implement the full set of GNSS interactions with the modem, including handling the assistance needed event, or just wait for the location library update.

samples/nrf9160/nrf_cloud_coap_client/src/main.c

glarsennordic · 2023-07-01T00:50:16Z

samples/nrf9160/nrf_cloud_coap_client/nrf9160dk_with_nrf7002ek.overlay

+/* Use high drive mode on SPI pins that handle communication with nRF7002
+ * so that SCK frequency > 4 MHz can be used. */
+ &spi3_default {
+ group1 {
+ nordic,drive-mode = <NRF_DRIVE_H0H1>;
+ };
+};


Will this be needed once cb74894 merges?

The commit I referenced there was from #11559 -- I think rebase has destroyed the linking

It looks like it was merged

Now I have no idea what your suggestion means. What are you thinking I should change?

glarsennordic · 2023-07-01T01:00:07Z

samples/nrf9160/nrf_cloud_coap_client/src/handle_fota.c

+ if (strncmp(key, FOTA_SETTINGS_KEY_PENDING_JOB, strlen(FOTA_SETTINGS_KEY_PENDING_JOB))) {
+ return -ENOMSG;
+ }
+
+ if (len_rd > sizeof(pending_job)) {
+ LOG_INF("FOTA settings size larger than expected");
+ len_rd = sizeof(pending_job);
+ }
+
+ sz = read_cb(cb_arg, (void *)&pending_job, len_rd);
+ if (sz == 0) {
+ LOG_DBG("FOTA settings key-value pair has been deleted");
+ return -EIDRM;
+ } else if (sz < 0) {
+ LOG_ERR("FOTA settings read error: %d", sz);
+ return -EIO;
+ }


Some comments on why each of these functions is called would be helpful I think

I reused all this file from code inside of the nrf_cloud_rest_fota sample. I didn't write it. Justin made a comment in this PR that I should make it a common module between these samples. I suggested it should live as a helper module in the nrf_cloud library folder.

If there is a definite plan to incorporate this under a helper library then it is less important that the lines be documented in this PR, makes sense to me

glarsennordic · 2023-07-01T01:00:23Z

samples/nrf9160/nrf_cloud_coap_client/src/handle_fota.c

+SETTINGS_STATIC_HANDLER_DEFINE(coap_fota, FOTA_SETTINGS_NAME, NULL,
+ coap_fota_settings_set, NULL, NULL);
+
+static int coap_fota_settings_set(const char *key, size_t len_rd, settings_read_cb read_cb,


Comments indicating overall purpose of these static functions would be nice as well

glarsennordic · 2023-07-01T01:06:34Z

samples/nrf9160/nrf_cloud_coap_client/src/main.c

+ }
+
+ lte_lc_register_handler(lte_handler);
+#if defined(CONFIG_LTE_LINK_CONTROL)


If you decide to keep this, consider gating the whole function behind a modem availability check and skipping the LTE_LC check

I'm not sure I understand what your suggestion is.

Instead of the CONFIG_LTE_LINK_CONTROL guard on just the section that uses lte_lc, you could guard the entire function for modem being enabled (since it doesn't seem to me like modem will be enabled in this sample without lte_lc being enabled)

It's a minor thing, though. CONFIG_LTE_LINK_CONTROL is arguably more specific, but I do suspect you'll eventually need to guard for modem enablement anyways

Alternatively, if you're gonna assume modem is always enabled, you could probably also assume the same of lte_lc

This originally came from the sdk-nrf coap_client sample.

Huh, interesting. I'm not sure why they would support modem builds both with and without lte_lc

glarsennordic · 2023-07-01T01:13:39Z

samples/nrf9160/nrf_cloud_coap_client/src/main.c

+ int err;
+ int i = 1;
+
+ LOG_INF("\n");


Are you planning to keep this LOG_INF("\n"); in the final version, or is this a temporary thing?

glarsennordic · 2023-07-06T20:50:00Z

samples/cellular/nrf_cloud_coap_client/src/main.c

+static void get_cell_info(void)
+{
+ int err;
+
+ if (!connected || !request_cells) {
+ return;
+ }
+
+ struct lte_lc_ncellmeas_params ncellmeas_params = {
+ .search_type = search_type,
+ .gci_count = ARRAY_SIZE(gci_cells)
+ };
+
+ /* Set the result buffers */
+ cell_info.neighbor_cells = neighbor_cells;
+ cell_info.gci_cells = gci_cells;
+
+ LOG_INF("Requesting neighbor cell measurement");
+ err = lte_lc_neighbor_cell_measurement(&ncellmeas_params);
+ if (err) {
+ LOG_ERR("Failed to start neighbor cell measurement, error: %d", err);
+ } else {
+ request_cells = false;
+ LOG_INF("Waiting for measurement results...");
+ }
+}


Maybe a scan_cells.c to match with scan_wifi.c would make sense?

glarsennordic · 2023-07-06T20:54:12Z

samples/cellular/nrf_cloud_coap_client/src/main.c

+}
+
+#if defined(CONFIG_NRF_CLOUD_PGPS)
+static int do_pgps(struct gps_pgps_request *pgps_req)


If you don't switch to using location lib, consider giving agps/pgps their own file

glarsennordic · 2023-07-06T21:44:33Z

samples/cellular/nrf_cloud_coap_client/src/main.c

+ }
+
+ printk("\n***********************************************\n");
+ switch (cur_test) {


I think you're gonna redo all this, but in case you don't, you could avoid using the coroutine pattern if you make these steps execute synchronously in the main loop and do the button checking, etc, in a function that gets called between each step

glarsennordic · 2023-07-06T22:00:01Z

samples/cellular/nrf_cloud_coap_client/README.rst

+After programming the sample and all prerequisites to the development kit, test it by performing the following steps:
+
+1. Connect your nRF9160 DK to the PC using a USB cable and power on or reset your nRF9160 DK.
+#. Open a terminal emulator and observe that the following information is displayed::


Is the double colon intentional?

Define strings related to encoding a device message in JSON. Signed-off-by: Pete Skeggs <peter.skeggs@nordicsemi.no>

Add a general purpose JSON message encoder, nrf_cloud_encode_message(). Signed-off-by: Pete Skeggs <peter.skeggs@nordicsemi.no>

When encoding the shadow, let the caller determine if the reported object should be included. Signed-off-by: Pete Skeggs <peter.skeggs@nordicsemi.no>

Split out update function so it can be used for CoAP. Signed-off-by: Pete Skeggs <peter.skeggs@nordicsemi.no>

This was incorrectly using the ++ operator when atomic_inc() would be better. Signed-off-by: Pete Skeggs <peter.skeggs@nordicsemi.no>

Modem sec tags are unsigned, so use that representation instead of plain int. Signed-off-by: Pete Skeggs <peter.skeggs@nordicsemi.no>

Uses the Zephyr coap_client library. Sends and receives data with nRF Cloud using CBOR and sometimes JSON. Supports most nRF Cloud services - FOTA, data messaging, location services (cellular, Wi-Fi, A-GPS, P-GPS). Signed-off-by: Pete Skeggs <peter.skeggs@nordicsemi.no>

Document the new nrf_cloud_coap library. Signed-off-by: Pete Skeggs <peter.skeggs@nordicsemi.no> Co-authored-by: Pekka Niskanen <pekka.niskanen@nordicsemi.no>

Implemented support for A-GPS and cellular positioning using nRF Cloud CoAP. Signed-off-by: Tommi Kangas <tommi.kangas@nordicsemi.no>

Added support for connecting to nRF Cloud using CoAP. Signed-off-by: Tommi Kangas <tommi.kangas@nordicsemi.no>

Document a sample which uses nRF Cloud CoAP. Signed-off-by: Pete Skeggs <peter.skeggs@nordicsemi.no>

This nRF Cloud CoAP client demonstrates using FOTA, messaging, cellular positioning, A-GPS, and P-GPS over CoAP. Get modem info IMEI and mfw. Init the modem, which waits for LTE connection. Look up server IP. Init the client, including looking up device IP with modem info. Send real cell pos parameters, receive, decode, and display location. Send cell pos back as fake GNSS PVT data. Send fake temperature sensor data. Receive and process MODEM and APP FOTA types. Signed-off-by: Pete Skeggs <peter.skeggs@nordicsemi.no>

WIP. Signed-off-by: Pete Skeggs <peter.skeggs@nordicsemi.no>

plskeggs · 2023-07-28T00:14:41Z

Closed this when we decided to move towards a modified nrf_cloud_mqtt_multi_service sample for CoAP instead.

plskeggs requested review from tony-le-24, jayteemo, glarsennordic, rlubos, SeppoTakalo, anangl and carlescufi as code owners June 28, 2023 21:51

github-actions bot added changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. doc-required PR must not be merged without tech writer approval. labels Jun 28, 2023

plskeggs marked this pull request as draft June 28, 2023 21:51

plskeggs force-pushed the feature-nrfcloud-coap-sample branch from 9db8f05 to 6b7dd1c Compare June 29, 2023 00:11

SeppoTakalo requested a review from juhaylinen June 29, 2023 12:16

plskeggs force-pushed the feature-nrfcloud-coap-sample branch from 6b7dd1c to fec8aef Compare June 30, 2023 03:42

plskeggs force-pushed the feature-nrfcloud-coap-sample branch 2 times, most recently from 5571f40 to 441e46c Compare June 30, 2023 05:22

stig-bjorlykke reviewed Jun 30, 2023

View reviewed changes

samples/nrf9160/nrf_cloud_coap_client/overlay-nrf7002ek-wifi-scan-only.conf Outdated Show resolved Hide resolved

plskeggs force-pushed the feature-nrfcloud-coap-sample branch from 441e46c to 4291761 Compare June 30, 2023 19:01

jayteemo reviewed Jun 30, 2023

View reviewed changes

plskeggs force-pushed the feature-nrfcloud-coap-sample branch 7 times, most recently from 14c7ba4 to 7996a1c Compare July 6, 2023 18:03

glarsennordic reviewed Jul 6, 2023

View reviewed changes

plskeggs force-pushed the feature-nrfcloud-coap-sample branch from 7996a1c to 55cf61e Compare July 7, 2023 22:15

net: lib: nrf_cloud: Add REST device message defines

a255a45

Define strings related to encoding a device message in JSON. Signed-off-by: Pete Skeggs <peter.skeggs@nordicsemi.no>

plskeggs force-pushed the feature-nrfcloud-coap-sample branch from 55cf61e to 70cad91 Compare July 18, 2023 01:41

github-actions bot removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jul 18, 2023

plskeggs force-pushed the feature-nrfcloud-coap-sample branch from 70cad91 to 531b669 Compare July 18, 2023 19:34

plskeggs and others added 12 commits July 18, 2023 18:05

net: lib: nrf_cloud: Add general message encoder

18fe27f

Add a general purpose JSON message encoder, nrf_cloud_encode_message(). Signed-off-by: Pete Skeggs <peter.skeggs@nordicsemi.no>

net: lib: nrf_cloud: Add control over reported

597b23d

When encoding the shadow, let the caller determine if the reported object should be included. Signed-off-by: Pete Skeggs <peter.skeggs@nordicsemi.no>

net: lib: nrf_cloud: Separate P-GPS decode from update

3eafdb0

Split out update function so it can be used for CoAP. Signed-off-by: Pete Skeggs <peter.skeggs@nordicsemi.no>

net: lib: nrf_cloud: Use atomic_inc on atomic_t variable

2d5a7a7

This was incorrectly using the ++ operator when atomic_inc() would be better. Signed-off-by: Pete Skeggs <peter.skeggs@nordicsemi.no>

lib: modem_jwt: Use unsigned int for sec_tag

4e8268b

Modem sec tags are unsigned, so use that representation instead of plain int. Signed-off-by: Pete Skeggs <peter.skeggs@nordicsemi.no>

docs: Add docs for nRF Cloud CoAP

baaac2b

Document the new nrf_cloud_coap library. Signed-off-by: Pete Skeggs <peter.skeggs@nordicsemi.no> Co-authored-by: Pekka Niskanen <pekka.niskanen@nordicsemi.no>

lib: location: Add nRF Cloud CoAP support

36a70ff

Implemented support for A-GPS and cellular positioning using nRF Cloud CoAP. Signed-off-by: Tommi Kangas <tommi.kangas@nordicsemi.no>

samples: nrf9160: modem_shell: Add nRF Cloud CoAP support

6abfa5a

Added support for connecting to nRF Cloud using CoAP. Signed-off-by: Tommi Kangas <tommi.kangas@nordicsemi.no>

docs: Mention modem_shell for nRF Cloud CoAP

15b03f6

Document a sample which uses nRF Cloud CoAP. Signed-off-by: Pete Skeggs <peter.skeggs@nordicsemi.no>

docs: Add docs for the nRF Cloud CoAP Client sample

9b689fa

WIP. Signed-off-by: Pete Skeggs <peter.skeggs@nordicsemi.no>

plskeggs force-pushed the feature-nrfcloud-coap-sample branch from 531b669 to 9b689fa Compare July 19, 2023 02:04

plskeggs closed this Jul 28, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

nRF Cloud CoAP Sample #11648

nRF Cloud CoAP Sample #11648

plskeggs commented Jun 28, 2023 •

edited

Loading

NordicBuilder commented Jun 30, 2023 •

edited

Loading

NordicBuilder commented Jun 30, 2023

jayteemo Jun 30, 2023

plskeggs Jun 30, 2023

jayteemo Jun 30, 2023

plskeggs Jun 30, 2023

glarsennordic Jul 1, 2023

glarsennordic Jul 6, 2023 •

edited

Loading

plskeggs Jul 7, 2023

glarsennordic Jul 1, 2023

plskeggs Jul 7, 2023

glarsennordic Jul 10, 2023

glarsennordic Jul 1, 2023

glarsennordic Jul 1, 2023

plskeggs Jul 7, 2023

glarsennordic Jul 7, 2023 •

edited

Loading

plskeggs Jul 7, 2023

glarsennordic Jul 7, 2023 •

edited

Loading

glarsennordic Jul 1, 2023

glarsennordic Jul 6, 2023

glarsennordic Jul 6, 2023

glarsennordic Jul 6, 2023

glarsennordic Jul 6, 2023

plskeggs commented Jul 28, 2023

nRF Cloud CoAP Sample #11648

nRF Cloud CoAP Sample #11648

Conversation

plskeggs commented Jun 28, 2023 • edited Loading

NordicBuilder commented Jun 30, 2023 • edited Loading

Test specification

NordicBuilder commented Jun 30, 2023

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

glarsennordic Jul 6, 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

glarsennordic Jul 7, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

glarsennordic Jul 7, 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

plskeggs commented Jul 28, 2023

plskeggs commented Jun 28, 2023 •

edited

Loading

NordicBuilder commented Jun 30, 2023 •

edited

Loading

glarsennordic Jul 6, 2023 •

edited

Loading

glarsennordic Jul 7, 2023 •

edited

Loading

glarsennordic Jul 7, 2023 •

edited

Loading