drivers/tmp117: TMP117 driver by leocordier · Pull Request #22310 · RIOT-OS/RIOT

leocordier · 2026-05-19T13:09:16Z

Contribution description

This pull request add a basic driver for the TMP117 sensor with the following capabilities:

tmp117 initialization
tmp117 configuration : update the conversion mode, cycle and averaging parameters
tmp117 temperature reading : with a result in centi-degrees
check if tmp117 temperature measure is ready

This pull request add a driver in the drivers folder and a test in the test/drivers folder

Testing procedure

The basic test that i wrote, initialize the sensor with default paramaters and i2c address.
After the initialization, it display the measured temperature every 1.5 seconds.

If the initialization or the temperature reading fail, it displays anb error.

Issues/PRs references

issue #22308

Declaration of AI-Tools / LLMs usage:

AI-Tools / LLMs that were used are:

none

tests/drivers/tmp117: test for the TMP117 driver This driver add the support for the TMP117 i2c temperature sensor.

Co-authored-by: crasbe <crasbe@gmail.com>

basilfx · 2026-05-19T14:32:54Z

+	tmp117_params_t params;
+	uint8_t is_initialized;
+} tmp117_t;
+


Too many blank lines.

Static checks will highlight a few more.

still more blank than needed

Suggested change

basilfx · 2026-05-19T14:49:27Z

Thanks @leocordier.

Could you also check if SAUL support would be easy to add? See https://docs.riot-os.org/advanced_tutorials/device_drivers/#saul

basilfx · 2026-05-26T10:04:07Z

I gave it another quick pass. It's getting there :-)

basilfx · 2026-05-26T11:10:49Z

+#pragma once
+
+/**
+ * @defgroup    driver_tmp117


Suggested change

* @defgroup driver_tmp117

* @defgroup drivers_tmp117

Other sensors use drivers_XXX. This needs to be adapted in multiple files.

…fessel review

kfessel

the temperature conversion seem right now; please test with you sensor

please use "speaking" names

conf_reg or conf_val where appropriate

please check for c++ style comments

please ensure exactly 1 NL before EOF

kfessel · 2026-05-26T13:44:20Z

+int tmp117_set_averaging(tmp117_t *dev, tmp117_avg_t avg)
+{
+    int res = TMP117_NOI2C;
+    uint16_t value;


Suggested change

uint16_t value;

uint16_t conf_reg;

kfessel · 2026-05-26T13:51:02Z

@@ -0,0 +1 @@
+FEATURES_REQUIRED += periph_i2c


missing newline

kfessel · 2026-05-26T13:51:13Z

@@ -0,0 +1,2 @@
+USEMODULE_INCLUDES_tmp117 := $(LAST_MAKEFILEDIR)/include
+USEMODULE_INCLUDES += $(USEMODULE_INCLUDES_tmp117)


missing newline

kfessel · 2026-05-26T13:51:40Z

+USEMODULE += ztimer
+USEMODULE += ztimer_msec
+
+include $(RIOTBASE)/Makefile.include


missing newline

kfessel · 2026-05-26T13:52:21Z

+int tmp117_set_conversion_cycle(tmp117_t *dev, tmp117_conv_cycle_t cycle)
+{
+    int res = TMP117_NOI2C;
+    uint16_t value;


Suggested change

uint16_t value;

uint16_t conf_reg;

kfessel · 2026-05-26T13:54:48Z

+int tmp117_set_conversion_mode(tmp117_t *dev, tmp117_conv_mode_t mode)
+{
+    int res = TMP117_NOI2C;
+    uint16_t value;


Suggested change

uint16_t value;

uint16_t conf_reg;

kfessel · 2026-05-26T13:57:00Z

+
+    status = _read_16_reg(dev, TMP117_REG_DEVICE_ID, &reg);
+
+    //checking if sensor is a tmp117


@basilfx is right we do not like sane c++ single line comments we always want /* */

kfessel · 2026-05-26T14:03:36Z

If you think your code is working as intended please test with your hardware and post:

a test setup description (mcu, connection (maybe photo)) and
test results (console or display photo)

kfessel · 2026-05-26T14:10:30Z

+};
+
+typedef enum {
+	TMP117_CONV_CC = 0,	/**< continous conversion mode */


somehow tabs made it into this file please use 4 space for indention only

(makefiles aside)

kfessel · 2026-05-26T14:17:50Z

+#define DEFAULT_CONFIG_VALUE    (dev->params.conv_mode << 10 | dev->params.conv_cycle << \
+                                 7 | dev->params.avg << 5)


use your defines

#define TMP117_DATA_READY_SHIFT 13 /**< data ready bit shift in configuration register */ #define TMP117_CONV_MODE_SHIFT 10 /**< conversion mode bits shift in configuration register */ #define TMP117_CONV_CYCLE_SHIFT 7 /**< conversion cycle bits shift in configuration register */ #define TMP117_AVG_SHIFT

Suggested change

#define DEFAULT_CONFIG_VALUE (dev->params.conv_mode << 10 | dev->params.conv_cycle << \

7 | dev->params.avg << 5)

#define DEFAULT_CONFIG_VALUE ( dev->params.conv_mode << TMP117_CONV_MODE_SHIFT \

| dev->params.conv_cycle << TMP117_CONV_CYCLE_SHIFT \

| dev->params.avg << TMP117_AVG_SHIFT)

leocordier · 2026-05-27T08:35:27Z

If you think your code is working as intended please test with your hardware and post:
* a test setup description (mcu, connection (maybe photo)) and

* test results (console or display photo)

Here is the setup i use to test the TMP117 driver:
Hardware

SenseCAP Solar Nopde
- based on the XIAO nRF52840 Plus board
homemade TMP117 test PCB

Result

################################
####### TMP117 test app ########
################################

Initializing tmp117 sensor ...
  done.

temperature : 25.78°C
temperature : 25.77°C
temperature : 25.78°C
temperature : 25.78°C
temperature : 25.78°C
temperature : 25.77°C
temperature : 25.80°C
temperature : 25.85°C
temperature : 26.02°C
temperature : 26.10°C
temperature : 26.25°C
temperature : 26.30°C
temperature : 26.39°C
temperature : 26.44°C
temperature : 26.46°C
temperature : 26.46°C
temperature : 26.46°C
temperature : 26.46°C
temperature : 26.45°C
temperature : 26.42°C
temperature : 26.42°C
temperature : 26.39°C

kfessel · 2026-05-28T12:39:31Z

If you think your code is working as intended please test with your hardware and post:

Here is the setup i use to test the TMP117 driver: Hardware
...
Result
################################
####### TMP117 test app ########
################################

Initializing tmp117 sensor ...
  done.

temperature : 25.78°C
...
temperature : 26.39°C
temperature : 26.44°C
temperature : 26.46°C

I see your test PCB has multiple of these sensors is that supported by the driver

What is the i2c address translation IC?'

is that LTC4316?

kfessel

sorry for all the white space things but there will be a time the static test will complain again

kfessel · 2026-05-28T12:51:50Z

+/**
+ * @brief   Define the number of configured sensors
+ */
+#define TMP117_NUM     (unsigned)(sizeof((tmp117_params)) / sizeof((tmp117_params)[0]))


did you include container.h

I assume it is this run
https://ci.riot-os.org/details/786c4cfa69eb4a8089a198ac2141682f

kfessel · 2026-05-28T12:52:12Z

+/**
+ * @brief   Define the number of saul info
+ */
+#define TMP117_INFO_NUM    (unsigned)(sizeof((tmp117_saul_info)) / sizeof((tmp117_saul_info)[0]))


kfessel · 2026-05-28T12:54:04Z

+ * @{
+ */
+#ifndef TMP117_PARAM_I2C
+#  define TMP117_PARAM_I2C      (I2C_DEV(0))


Suggested change

# define TMP117_PARAM_I2C (I2C_DEV(0))

# define TMP117_PARAM_I2C (I2C_DEV(0))

kfessel · 2026-05-28T12:54:07Z

+#  define TMP117_PARAM_I2C      (I2C_DEV(0))
+#endif
+#ifndef TMP117_PARAM_ADDR
+#  define TMP117_PARAM_ADDR     (0x48)


Suggested change

# define TMP117_PARAM_ADDR (0x48)

# define TMP117_PARAM_ADDR (0x48)

kfessel · 2026-05-28T12:56:08Z

+#ifndef TMP117_PARAMS
+#  define TMP117_PARAMS       { .i2c = TMP117_PARAM_I2C, \
+                                .addr = TMP117_PARAM_ADDR, \
+                                .conv_mode = TMP117_PARAM_CONV_MODE, \
+                                .conv_cycle = TMP117_PARAM_CONV_CYCLE, \
+                                .avg = TMP117_PARAM_AVG }
+#endif


Suggested change

#ifndef TMP117_PARAMS

# define TMP117_PARAMS { .i2c = TMP117_PARAM_I2C, \

.addr = TMP117_PARAM_ADDR, \

.conv_mode = TMP117_PARAM_CONV_MODE, \

.conv_cycle = TMP117_PARAM_CONV_CYCLE, \

.avg = TMP117_PARAM_AVG }

#endif

#ifndef TMP117_PARAMS

# define TMP117_PARAMS { .i2c = TMP117_PARAM_I2C, \

.addr = TMP117_PARAM_ADDR, \

.conv_mode = TMP117_PARAM_CONV_MODE, \

.conv_cycle = TMP117_PARAM_CONV_CYCLE, \

.avg = TMP117_PARAM_AVG }

#endif

kfessel · 2026-05-28T12:58:34Z

+
+    conf_reg &= ~TMP117_AVG_MASK;
+    conf_reg |= avg << TMP117_AVG_SHIFT;
+


Suggested change

kfessel · 2026-05-28T12:58:41Z

+        DEBUG("[tmp117] set averaging - error: unable to read conf reg \n");
+        goto release;
+    }
+


Suggested change

kfessel · 2026-05-28T12:59:10Z

+
+

Suggested change

kfessel · 2026-05-28T12:59:27Z

+
+#include "tmp117.h"
+#include "tmp117_params.h"
+


Suggested change

kfessel · 2026-05-28T12:59:44Z

+
+        ztimer_sleep(ZTIMER_MSEC, 1500);
+    }
+


Suggested change

leocordier · 2026-06-15T09:26:42Z

If you think your code is working as intended please test with your hardware and post:

Here is the setup i use to test the TMP117 driver: Hardware
...
Result
################################
####### TMP117 test app ########
################################

Initializing tmp117 sensor ...
  done.

temperature : 25.78°C
...
temperature : 26.39°C
temperature : 26.44°C
temperature : 26.46°C
I see your test PCB has multiple of these sensors is that supported by the driver

What is the i2c address translation IC?'

is that LTC4316?

Hello,
it's a test PCB that i am using currently at work. It has 8 TMP117 sensor but in this test i use only one.
You can initialize and use more thant one sensor with the driver, you just need to pass to the init function a new tmp117_t structure with parameters.

And yes the i2c address shifting IC is a LTCLTC4316.

leocordier · 2026-06-15T09:35:27Z

sorry for all the white space things but there will be a time the static test will complain again

Is there a tool to automatically delete those blank lines and apply the appropriate spacing?
I use uncrustify with the riot-os spec every time i push a commit but this seems not to be enough.

basilfx · 2026-06-23T09:28:14Z

sorry for all the white space things but there will be a time the static test will complain again

Is there a tool to automatically delete those blank lines and apply the appropriate spacing? I use uncrustify with the riot-os spec every time i push a commit but this seems not to be enough.

I usually have my editor configured to remove trailing whitespaces. For example VS Code can do this. I also have a plugin to highlight them.

leocordier · 2026-06-23T14:10:38Z

sorry for all the white space things but there will be a time the static test will complain again

Is there a tool to automatically delete those blank lines and apply the appropriate spacing? I use uncrustify with the riot-os spec every time i push a commit but this seems not to be enough.

I usually have my editor configured to remove trailing whitespaces. For example VS Code can do this. I also have a plugin to highlight them.

I just removed them by hand, it should be good now

crasbe

Also a lot of other review comments are still open.

crasbe · 2026-06-23T16:08:09Z

+* conversion cycle : 1s
+* averaging : 8 samples
+
+After the initialization, the temperature value is displayed every 1s5.


Suggested change

After the initialization, the temperature value is displayed every 1s5.

After the initialization, the temperature value is displayed every 1.5 seconds.

crasbe · 2026-06-23T16:08:22Z

+* conversion mode : continuous
+* conversion cycle : 1s
+* averaging : 8 samples


Suggested change

* conversion mode : continuous

* conversion cycle : 1s

* averaging : 8 samples

* conversion mode: continuous

* conversion cycle: 1s

* averaging: 8 samples

crasbe · 2026-06-23T16:09:16Z

+    puts("Initializing tmp117 sensor ...");
+
+    if (tmp117_init(&tmp117, tmp117_params) != TMP117_OK) {
+        return -1;


Suggested change

return -1;

puts(" failed.\n");

return -1;

crasbe · 2026-06-23T16:09:57Z

+
+    while (1) {
+        if (tmp117_read_temperature(&tmp117, &raw_temp) == TMP117_OK) {
+            printf("temperature : %02d.%02d°C\n", raw_temp / 100, raw_temp % 100);


Suggested change

printf("temperature : %02d.%02d°C\n", raw_temp / 100, raw_temp % 100);

printf("Temperature: %02d.%02d°C\n", raw_temp / 100, raw_temp % 100);

crasbe · 2026-06-23T16:10:13Z

+            printf("temperature : %02d.%02d°C\n", raw_temp / 100, raw_temp % 100);
+        }
+        else {
+            puts("[tmp117 test] error : unable to read temperature\n");


Suggested change

puts("[tmp117 test] error : unable to read temperature\n");

puts("ERROR: unable to read temperature\n");

I think in this case it's clear which test is running.

crasbe · 2026-06-23T16:16:31Z

+ * @param[in, out] dev device descriptor
+ * @param[out] value read value in centi-celsius
+ *
+ * @return TMP117_OK on success
+ * @return TMP117_I2C if other error occurs


Suggested change

* @param[in, out] dev device descriptor

* @param[out] value read value in centi-celsius

*

* @return TMP117_OK on success

* @return TMP117_I2C if other error occurs

* @param[in,out] dev device descriptor

* @param[out] value read value in centi-celsius

*

* @retval TMP117_OK on success

* @retval TMP117_I2C if other error occurs

crasbe · 2026-06-23T16:17:46Z

+    tmp117_conv_mode_t conv_mode;   /**< conversion mode */
+    tmp117_conv_cycle_t conv_cycle; /**< conversion cycle time */
+    tmp117_avg_t avg;               /**< data averaging*/
+}tmp117_params_t;


Suggested change

}tmp117_params_t;

} tmp117_params_t;

crasbe · 2026-06-23T16:18:06Z

+    assert(TMP117_NUM == TMP117_INFO_NUM);
+
+    for (unsigned i = 0; i < TMP117_NUM; i++) {
+        LOG_DEBUG("[auto_init_saul] initializing tmp117 #%u\n", i);


Suggested change

LOG_DEBUG("[auto_init_saul] initializing tmp117 #%u\n", i);

LOG_DEBUG("[auto_init_saul] initializing TMP117 #%u\n", i);

crasbe · 2026-06-23T16:18:15Z

+        LOG_DEBUG("[auto_init_saul] initializing tmp117 #%u\n", i);
+
+        if (tmp117_init(&tmp117_devs[i], &tmp117_params[i]) != TMP117_OK) {
+            LOG_ERROR("[auto_init_saul] error initializing tmp117 #%u\n", i);


Suggested change

LOG_ERROR("[auto_init_saul] error initializing tmp117 #%u\n", i);

LOG_ERROR("[auto_init_saul] error initializing TMP117 #%u\n", i);

drivers/tmp117: TMP117 driver

31210b7

tests/drivers/tmp117: test for the TMP117 driver This driver add the support for the TMP117 i2c temperature sensor.

leocordier requested review from MichelRottleuthner, aabadie and leandrolanzieri as code owners May 19, 2026 13:09

github-actions Bot added Area: doc Area: Documentation Area: tests Area: tests and testing framework Area: drivers Area: Device drivers labels May 19, 2026

crasbe added Type: new feature The issue requests / The PR implemements a new feature for RIOT CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR labels May 19, 2026

AnnsAnns mentioned this pull request May 19, 2026

.github/workflows: First Time Contributor workflow does not trigger #22311

Closed

crasbe requested changes May 19, 2026

View reviewed changes

crasbe linked an issue May 19, 2026 that may be closed by this pull request

Add a driver for the TMP117 temperature sensor #22308

Open

leocordier and others added 14 commits May 19, 2026 16:15

Update drivers/include/tmp117.h

33e7f11

Co-authored-by: crasbe <crasbe@gmail.com>

Update drivers/include/tmp117.h

7f93db1

Co-authored-by: crasbe <crasbe@gmail.com>

Update drivers/include/tmp117.h

53375b9

Co-authored-by: crasbe <crasbe@gmail.com>

Update drivers/include/tmp117.h

41c205f

Co-authored-by: crasbe <crasbe@gmail.com>

Update drivers/include/tmp117.h

0ad27c0

Co-authored-by: crasbe <crasbe@gmail.com>

Update drivers/include/tmp117.h

b970951

Co-authored-by: crasbe <crasbe@gmail.com>

Update drivers/tmp117/tmp117.c

9b92f13

Co-authored-by: crasbe <crasbe@gmail.com>

Update drivers/tmp117/tmp117.c

d8d4b5d

Co-authored-by: crasbe <crasbe@gmail.com>

Update tests/drivers/tmp117/README.md

1a9a218

Co-authored-by: crasbe <crasbe@gmail.com>

Update tests/drivers/tmp117/README.md

2c62eda

Co-authored-by: crasbe <crasbe@gmail.com>

Apply suggestion from @crasbe

c1cd55e

Co-authored-by: crasbe <crasbe@gmail.com>

Apply suggestion from @crasbe

0c89813

Co-authored-by: crasbe <crasbe@gmail.com>

Apply suggestion from @crasbe

d74c5c6

Co-authored-by: crasbe <crasbe@gmail.com>

Apply suggestion from @crasbe

3c372c9

Co-authored-by: crasbe <crasbe@gmail.com>

basilfx reviewed May 19, 2026

View reviewed changes

leocordier added 2 commits May 19, 2026 16:58

review of crasbe sugestions

92d730e

uncrustify source file

ea621ff

basilfx reviewed May 26, 2026

View reviewed changes

proccessing basilfx review

928b221

leocordier requested a review from basilfx May 26, 2026 12:37

kfessel reviewed May 26, 2026

View reviewed changes

Comment thread tests/drivers/tmp117/Makefile.uncrustify Outdated

kfessel reviewed May 26, 2026

View reviewed changes

Comment thread drivers/tmp117/tmp117.c Outdated

Comment thread drivers/tmp117/tmp117.c Outdated

leocordier added 2 commits May 26, 2026 15:27

remove tests/drivers/tmp117/Makefile.uncrustify

59a3b64

drivers/tmp117/tmp117.c: change temperature conversion according to k…

a98131f

…fessel review

leocordier requested a review from kfessel May 26, 2026 13:39

kfessel reviewed May 26, 2026

View reviewed changes

change according to kfessel review

b5212b6

leocordier requested a review from kfessel May 27, 2026 08:35

kfessel reviewed May 28, 2026

View reviewed changes

drivers/tmp117: add comments and removing whitespaces

4703875

crasbe requested changes Jun 23, 2026

View reviewed changes

correct review comments

9a69aac

leocordier requested a review from crasbe June 29, 2026 12:02

leocordier added 4 commits June 29, 2026 15:35

drivers/include/tmp117.h: remove tab line 9

54e8194

drivers/tmp117/include/tmp117_params.h: remove defgroup

24b10f1

drivers/tmp117/include/tmp117_regs.h: remove defgroup

92ae0c0

tests/drivers/tmp117/main.c: remove tab line 9

177d1d3

		@@ -0,0 +1 @@
		FEATURES_REQUIRED += periph_i2c No newline at end of file

		@@ -0,0 +1,2 @@
		USEMODULE_INCLUDES_tmp117 := $(LAST_MAKEFILEDIR)/include
		USEMODULE_INCLUDES += $(USEMODULE_INCLUDES_tmp117) No newline at end of file


		status = _read_16_reg(dev, TMP117_REG_DEVICE_ID, &reg);

		//checking if sensor is a tmp117

		#define DEFAULT_CONFIG_VALUE (dev->params.conv_mode << 10 \| dev->params.conv_cycle << \
		7 \| dev->params.avg << 5)

-#define DEFAULT_CONFIG_VALUE    (dev->params.conv_mode << 10 | dev->params.conv_cycle << \
-| dev->params.avg << 5)
+#define DEFAULT_CONFIG_VALUE   ( dev->params.conv_mode << TMP117_CONV_MODE_SHIFT \
+                               | dev->params.conv_cycle << TMP117_CONV_CYCLE_SHIFT \
+                               | dev->params.avg << TMP117_AVG_SHIFT)

	# define TMP117_PARAM_I2C (I2C_DEV(0))
	# define TMP117_PARAM_I2C (I2C_DEV(0))

	# define TMP117_PARAM_ADDR (0x48)
	# define TMP117_PARAM_ADDR (0x48)


		conf_reg &= ~TMP117_AVG_MASK;
		conf_reg \|= avg << TMP117_AVG_SHIFT;

	After the initialization, the temperature value is displayed every 1s5.
	After the initialization, the temperature value is displayed every 1.5 seconds.

	printf("temperature : %02d.%02d°C\n", raw_temp / 100, raw_temp % 100);
	printf("Temperature: %02d.%02d°C\n", raw_temp / 100, raw_temp % 100);


		#include "tmp117.h"
		#include "tmp117_params.h"

	puts("[tmp117 test] error : unable to read temperature\n");
	puts("ERROR: unable to read temperature\n");

	LOG_DEBUG("[auto_init_saul] initializing tmp117 #%u\n", i);
	LOG_DEBUG("[auto_init_saul] initializing TMP117 #%u\n", i);

	LOG_ERROR("[auto_init_saul] error initializing tmp117 #%u\n", i);
	LOG_ERROR("[auto_init_saul] error initializing TMP117 #%u\n", i);

Uh oh!

Conversation

leocordier commented May 19, 2026

Contribution description

Testing procedure

Issues/PRs references

Declaration of AI-Tools / LLMs usage:

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

basilfx commented May 19, 2026

Uh oh!

basilfx commented May 26, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kfessel left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kfessel commented May 26, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

leocordier commented May 27, 2026

Uh oh!

kfessel commented May 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kfessel left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kfessel left a comment •

edited

Loading

kfessel commented May 28, 2026 •

edited

Loading