Murdock results

✔️ PASSED

56660dd drivers/ds18: move to ztimer

Artifacts

• Documentation preview

Can you give me a short rundown on how to use the test? The Readme is... not super helpful.

How is the Onewire pin set?

The Onewire pin is configured in drivers/ds18/include/ds18_params.h - default is GPIO_PIN(0, 0) - PA0.

When you flash the application it shows in endless loop temperature reading each 2 s.

Perhaps we can use the opportunity to improve the documentation a bit:

diff --git a/tests/drivers/ds18/Readme.md b/tests/drivers/ds18/Readme.md
index 108faa555a..6737dbf9a4 100644
--- a/tests/drivers/ds18/Readme.md
+++ b/tests/drivers/ds18/Readme.md
@@ -1,7 +1,21 @@
 ## About
-This is a test application for the Maxime [DS18B20](https://datasheets.maximintegrated.com/en/ds/DS18B20.pdf) 1-Wire temperature
-sensor.
+This is a test application for the Maxim
+[DS18B20](https://datasheets.maximintegrated.com/en/ds/DS18B20.pdf)
+1-Wire temperature sensor.

 ## Usage
-The application will initialize the DS18B20 sensor and every 2 seconds will read
-the temperature and print the measurement to STDOUT.
\ No newline at end of file
+The application will initialize the DS18B20 sensor, read
+the temperature and print the measurement to STDOUT every two seconds.
+
+The default GPIO pin is (0,0), which equates for example to PA0 for STM32s.
+You can change the pin by setting the according CFLAG in the Makefile
+or on the command line:
+
+```shell
+CFLAGS+=-DDS18_PARAM_PIN="GPIO_PIN(PORT_C,0)" BOARD=nucleo-l152re make flash term -j
+```
+
+Please note that only certain boards are tested and therefore whitelisted
+due to the timing requirements of the underlying code.
+If your board is not on that whitelist, you can either extend the list in
+the Makefile. The test might still fail for your specific board though!

It would also be nice if you could rename the Readme.md to README.md to fit the standard format.

README.md renamed and updated!

You could have saved your time - xtimer_usleep() is just a wrapper around ztimer_sleep(ZTIMER_USEC) nowadays, so this should produce the exact same binary.

I would like to sum up all information, and agree final solution.

1. README.md should contain minimal information which helps execution of test - information that DS18_PARAM_PIN define should be configured.
2. README.md should not contain details how to configure DS18_PARAM_PIN.
   In my opinion link to driver configuration provided by @Enoch247 would be beneficial.
3. Actually, accordingly to the xtimer_compat.h xtimer_usleep() is inline as ztimer_sleep(ZTIMER_USEC).
   However, in my opinion, as xtimer is deprecated and used only in around 100 files, it should be directly moved to ztimer.

All comments are welcome.

If there is no veto - I prepare new version of READM.md in following days.

I commit new version of README.md, which I believe, should fix all raised issues.

Murdock is happy.

Can we finalize this PR?

Did you intend to squash to a single commit? When I first reviewed this PR, I believe you had broken it into several commits, but now there is only one.

After approval. @crasbe asked me for squashing commits.

If there is no veto - I prepare new version of READM.md in following days.

That's fine with me 👍

After approval. @crasbe asked me for squashing commits.

Ahh, ok. Thanks for the clarification.