From f03fb32f88612d98f3abcd8f05106255ea9a9108 Mon Sep 17 00:00:00 2001 From: Gunar Schorcht <gunar@schorcht.net> Date: Thu, 13 Dec 2018 11:45:49 +0100 Subject: [PATCH] tests/driver_ccs811: fixes for Codacy --- tests/driver_ccs811/README.md | 15 +++++++++------ tests/driver_ccs811_full/README.md | 17 +++++++++++------ 2 files changed, 20 insertions(+), 12 deletions(-) diff --git a/tests/driver_ccs811/README.md b/tests/driver_ccs811/README.md index c76e3a40af..f0dacac690 100644 --- a/tests/driver_ccs811/README.md +++ b/tests/driver_ccs811/README.md @@ -1,15 +1,18 @@ -# About +# AMS CCS811 device driver test application + +## About This is a manual test application for the CCS811 driver. It shows how the -sensor can be used for periodic polling as well as with interrupts. +sensor can be used for periodic polling. -# Usage +## Usage The test application demonstrates the use of the CCS811 using -- data-ready status function ```ccs811_data_ready``` to wait for new data and -- default configuration parameters, that is, the measurement mode - ```CCS811_MODE_1S``` with one measurement per second. + - data-ready status function ```ccs811_data_ready``` to wait for new data and + + - default configuration parameters, that is, the measurement mode + ```CCS811_MODE_1S``` with one measurement per second. Please refer ```$(RIOTBASE)/tests/driver_ccs811_full``` to learn how to use the CCS811 with interrupts. diff --git a/tests/driver_ccs811_full/README.md b/tests/driver_ccs811_full/README.md index 003e6622d3..997e07841f 100644 --- a/tests/driver_ccs811_full/README.md +++ b/tests/driver_ccs811_full/README.md @@ -1,16 +1,21 @@ -# About +# AMS CCS811 device driver test application + +## About This is a manual test application for the CCS811 driver. It shows how the -sensor can be used for periodic polling as well as with interrupts. +sensor can be used with interrupts. + +**Please note:** The interrupt pin has to be defined for this test application. -# Usage +## Usage The test application demonstrates the use of the CCS811 and pseudomodule ```ccs811_full``` using -- data-ready interrupt ```CCS811_INT_DATA_READY``` and -- default configuration parameters, that is, the measurement mode - ```CCS811_MODE_1S``` with one measurement per second. + - data-ready interrupt ```CCS811_INT_DATA_READY``` and + + - default configuration parameters, that is, the measurement mode + ```CCS811_MODE_1S``` with one measurement per second. The default configuration parameter for the interrupt pin has to be overridden according to the hardware configuration by defining -- GitLab