feat: EF572 support reading units mechanism by HaydenCummins-eaton · Pull Request #606 · edgexfoundry/device-sdk-c

HaydenCummins-eaton · 2026-05-05T17:46:32Z

PR Checklist

Please check if your PR fulfills the following requirements:

[X ] I am not introducing a breaking change (if you are, flag in conventional commit message with BREAKING CHANGE: describing the break)
I am not introducing a new dependency (add notes below if you are)
I have added unit tests for the new feature or bug fix (if not, why?)
[X ] I have fully tested (add details below) this the new feature or bug fix (if not, why?)
I have opened a PR for the related docs change (if not, why?)

Testing Instructions

Add the ReadingUnits field to the configuration.yaml file for your example under the Writable section and set it to true.

Writable:
 LogLevel: DEBUG
 Reading:
   ReadingUnits: true

Customize a device example profile as follows (device-counter for this example):
a. Under deviceResources, add the units field to the properties, and choose a unit

"deviceResources":
  [
    {
      "name": "Counter",
      "description": "A counter generating incrementing values",
      "attributes": { "register": "count01" },
      "properties": { "valueType": "Uint32", "readWrite": "RW", "units": "Kelvin" }
    }
  ]

Compile and run the example, now, within mqtt explorer or another similar tool, you should be able to see the units field populated as a property of the device.

Signed-off-by: HaydenCummins-eaton <haydenmcummins@eaton.com>

…hanism

cloudxxx8 · 2026-05-06T03:41:24Z

@HaydenCummins-eaton please squash your commit message to pass the DCO check

Copilot

Pull request overview

This PR adds support for optionally including a device resource’s configured units value in generated EdgeX readings/events, controlled via a new dynamic configuration flag (Writable/Reading/ReadingUnits).

Changes:

Extend edgex_data_process_event() to accept the service context so it can read Writable/Reading/ReadingUnits and conditionally add the units field to each reading.
Add a default config entry for Writable/Reading/ReadingUnits (default false).
Update the random example configuration to enable Writable.Reading.ReadingUnits.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/c/service.c	Updates event creation call to pass `svc` into `edgex_data_process_event()`.
src/c/device.c	Updates GET handling to pass `svc` into `edgex_data_process_event()`.
src/c/autoevent.c	Updates auto-event generation to pass `ai->svc` into `edgex_data_process_event()`.
src/c/data.h	Extends `edgex_data_process_event()` prototype with a `devsdk_service_t *svc` parameter.
src/c/data.c	Reads `Writable/Reading/ReadingUnits` and conditionally injects `units` into reading maps.
src/c/config.c	Adds default config key `Writable/Reading/ReadingUnits` set to `false`.
src/c/examples/random/res/configuration.yaml	Enables `Writable.Reading.ReadingUnits: true` for the random example.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

+  //check ReadingUnits configuration
+  bool includeUnits = false;
+  includeUnits = iot_data_string_map_get_bool(svc->config.sdkconf, "Writable/Reading/ReadingUnits", false);
+  printf("DEBUG: CHECKING REGISTRY includeUnits = %s\n", includeUnits ? "true" : "false");


+    printf("DEBUG: includeUnits = %s\n", includeUnits ? "true" : "false");
+    printf("DEBUG: commandinfo->pvals[%d]->units = %s\n", i, 
+           commandinfo->pvals[i]->units ? commandinfo->pvals[i]->units : "NULL");
+
+    if (includeUnits && commandinfo->pvals[i]->units && *commandinfo->pvals[i]->units)
+    {
+      printf("DEBUG: Adding units field: %s\n", commandinfo->pvals[i]->units);
+      iot_data_string_map_add (rmap, "units", iot_data_alloc_string (commandinfo->pvals[i]->units, IOT_DATA_REF));
+    }
+    else
+    {
+      printf("DEBUG: NOT adding units field\n");
+    }


+    printf("DEBUG: includeUnits = %s\n", includeUnits ? "true" : "false");
+    printf("DEBUG: commandinfo->pvals[%d]->units = %s\n", i, 
+           commandinfo->pvals[i]->units ? commandinfo->pvals[i]->units : "NULL");
+
+    if (includeUnits && commandinfo->pvals[i]->units && *commandinfo->pvals[i]->units)
+    {
+      printf("DEBUG: Adding units field: %s\n", commandinfo->pvals[i]->units);
+      iot_data_string_map_add (rmap, "units", iot_data_alloc_string (commandinfo->pvals[i]->units, IOT_DATA_REF));
+    }
+    else
+    {
+      printf("DEBUG: NOT adding units field\n");
+    }


iain-anderson · 2026-05-06T09:43:00Z

  bool doTransforms,
-  bool reducedEvents
+  bool reducedEvents,
+  devsdk_service_t *svc


Either pass includeUnits as a bool (the calling function would get the value from the service_t structure, as per the AI comment on sdkconf use) or pass svc as const devsdk_service_t* and remove the doTransforms and reducedEvents parameters (the function can get them from svc itself)

iain-anderson · 2026-05-06T09:43:23Z

  iot_data_string_map_add (result, "Device/Discovery/Enabled", iot_data_alloc_bool (true));
  iot_data_string_map_add (result, "Device/Discovery/Interval", iot_data_alloc_ui32 (0));
  iot_data_string_map_add (result, "Device/MaxCmdOps", iot_data_alloc_ui32 (0));
+  //adding reading Units here


Signed-off-by: HaydenCummins-eaton <haydenmcummins@eaton.com>

HaydenCummins-eaton · 2026-05-13T19:09:51Z

Most recent commit removes the printf statements and unnecessary comments. It also removes the svc reference passed in in favor of the includeUnits bool. Testing tells me this functions the same. Let me know what other changes are necessary and I'll make them as requested.

HaydenCummins-eaton · 2026-05-13T19:11:09Z

Once everything looks okay I'll squash my commit

Copilot

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.

Comments suppressed due to low confidence (1)

src/c/device.c:722

Same concurrency concern as the other edgex_data_process_event call site: reading svc->config.sdkconf here can race with dynamic config updates that replace/free values in the map. Prefer caching Writable/Reading/ReadingUnits into an atomic field during config update/population and passing that cached value into edgex_data_process_event.

      result = edgex_data_process_event (dev, cmdinfo, results, tags, svc->config.device.datatransform, svc->reduced_events, iot_data_string_map_get_bool(svc->config.sdkconf, "Writable/Reading/ReadingUnits", false));

          }
          edgex_event_cooked *event =
-            edgex_data_process_event (dev, ai->resource, results, tags, ai->svc->config.device.datatransform, ai->svc->reduced_events);
+            edgex_data_process_event (dev, ai->resource, results, tags, ai->svc->config.device.datatransform, ai->svc->reduced_events, iot_data_string_map_get_bool(ai->svc->config.sdkconf, "Writable/Reading/ReadingUnits", false));


    {
      devsdk_error err = EDGEX_OK;
-      result = edgex_data_process_event (dev, cmdinfo, results, tags, svc->config.device.datatransform, svc->reduced_events);
+      result = edgex_data_process_event (dev, cmdinfo, results, tags, svc->config.device.datatransform, svc->reduced_events, iot_data_string_map_get_bool(svc->config.sdkconf, "Writable/Reading/ReadingUnits", false));


    edgex_event_cooked *event = edgex_data_process_event
-      (dev, command, values, tags, svc->config.device.datatransform, svc->reduced_events);
+      (dev, command, values, tags, svc->config.device.datatransform, svc->reduced_events, iot_data_string_map_get_bool(svc->config.sdkconf, "Writable/Reading/ReadingUnits", false));


Signed-off-by: HaydenCummins-eaton <haydenmcummins@eaton.com>

HaydenCummins-eaton · 2026-05-19T20:32:08Z

Changed that to an atomic bool located in config and adjusted calls accordingly, atomic bool should be populated by edgex_device_populateCommonConfigFromMap now and each call to edgex_data_process_event should be thread safe now

Copilot

Pull request overview

Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.

  iot_data_string_map_add (result, "Device/Discovery/Enabled", iot_data_alloc_bool (true));
  iot_data_string_map_add (result, "Device/Discovery/Interval", iot_data_alloc_ui32 (0));
  iot_data_string_map_add (result, "Device/MaxCmdOps", iot_data_alloc_ui32 (0));
+


+    // Add units field if ReadingUnits is enabled and the device resource has units configured
+    if (includeUnits && commandinfo->pvals[i]->units && *commandinfo->pvals[i]->units)
+    {
+      iot_data_string_map_add (rmap, "units", iot_data_alloc_string (commandinfo->pvals[i]->units, IOT_DATA_REF));
+    }


  bool useCBOR = false;
  uint64_t timenow = iot_time_nsecs ();
-
+  


iain-anderson

In addition to the items identified by CoPilot:

add code to edgex_device_config_toJson so that the new configuration element is included in the results of a request for the current config
if the units configuration is to be dynamic, add code to edgex_device_updateConf to reset it when a new config is pushed

cloudxxx8 · 2026-06-04T01:54:12Z

@HaydenCummins-eaton We are releasing v4.0.2. Are you able to address the review comments recently?

Copilot

Pull request overview

Copilot reviewed 8 out of 8 changed files in this pull request and generated no new comments.

iain-anderson · 2026-07-02T16:15:30Z

@cloudxxx8 @HaydenCummins-eaton comments re edgex_device_config_toJson / edgex_device_updateConf not yet addressed

HaydenCummins-eaton and others added 3 commits March 13, 2026 14:47

feat: Added ReadingUnits Mechanism

41574c1

feat: Adding ReadingUnits Mechanism

3f46fcf

Signed-off-by: HaydenCummins-eaton <haydenmcummins@eaton.com>

Merge branch 'edgexfoundry:main' into EF-572-Support-ReadingUnits-Mec…

06f6864

…hanism

cloudxxx8 requested a review from Copilot May 6, 2026 03:40

Copilot started reviewing on behalf of cloudxxx8 May 6, 2026 03:41 View session

cloudxxx8 requested a review from iain-anderson May 6, 2026 03:41

Copilot AI reviewed May 6, 2026

View reviewed changes

iain-anderson reviewed May 6, 2026

View reviewed changes

feat: Adding ReadingUnits Mechanism

0657fe9

Signed-off-by: HaydenCummins-eaton <haydenmcummins@eaton.com>

cloudxxx8 requested a review from Copilot May 14, 2026 03:49

Copilot started reviewing on behalf of cloudxxx8 May 14, 2026 03:49 View session

Copilot AI reviewed May 14, 2026

View reviewed changes

feat: Adding ReadingUnits Mechanism

e1dc4db

Signed-off-by: HaydenCummins-eaton <haydenmcummins@eaton.com>

cloudxxx8 requested a review from Copilot May 20, 2026 01:55

Copilot started reviewing on behalf of cloudxxx8 May 20, 2026 01:55 View session

Copilot AI reviewed May 20, 2026

View reviewed changes

cloudxxx8 requested a review from iain-anderson May 20, 2026 02:36

iain-anderson requested changes May 20, 2026

View reviewed changes

addresing comments involving spacing and documentation

7c86024

cloudxxx8 requested a review from Copilot June 30, 2026 04:58

Copilot started reviewing on behalf of cloudxxx8 June 30, 2026 04:58 View session

Copilot AI reviewed Jun 30, 2026

View reviewed changes

cloudxxx8 requested a review from iain-anderson June 30, 2026 05:38

Uh oh!

Conversation

HaydenCummins-eaton commented May 5, 2026

PR Checklist

Testing Instructions

Uh oh!

cloudxxx8 commented May 6, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

iain-anderson May 6, 2026

Choose a reason for hiding this comment

Uh oh!

iain-anderson May 6, 2026

Choose a reason for hiding this comment

Uh oh!

HaydenCummins-eaton commented May 13, 2026

Uh oh!

HaydenCummins-eaton commented May 13, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

HaydenCummins-eaton commented May 19, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

iain-anderson left a comment

Choose a reason for hiding this comment

Uh oh!

cloudxxx8 commented Jun 4, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

iain-anderson commented Jul 2, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants