diff --git a/pkg/driver_bme680/doc.txt b/pkg/driver_bme680/doc.txt index 46a287fc4e..9d61a71bae 100644 --- a/pkg/driver_bme680/doc.txt +++ b/pkg/driver_bme680/doc.txt @@ -3,4 +3,6 @@ * @ingroup pkg * @brief Provides the Bosch Sensortec's BME680 gas sensor API * @see https://github.com/BoschSensortec/BME680_driver + * + * @include pkg/driver_bme680/README.md */ diff --git a/pkg/u8g2/doc.txt b/pkg/u8g2/doc.txt index 78da76c0fa..d6b3b814c4 100644 --- a/pkg/u8g2/doc.txt +++ b/pkg/u8g2/doc.txt @@ -15,4 +15,6 @@ * to your makefile. * 48kB is enough for the test other uses may need more or may * need this to be applied to other threads using `THREAD_STACKSIZE_DEFAULT` + * + * @include pkg/u8g2/README.md */ diff --git a/pkg/ucglib/doc.txt b/pkg/ucglib/doc.txt index e5d37b91d5..1a06fcdbc6 100644 --- a/pkg/ucglib/doc.txt +++ b/pkg/ucglib/doc.txt @@ -3,4 +3,6 @@ * @ingroup pkg * @brief Provides a color graphics library for OLED and LCD displays * @see https://github.com/olikraus/ucglib + * + * @include pkg/ucglib/README.md */ \ No newline at end of file diff --git a/pkg/uwb-dw1000/README.md b/pkg/uwb-dw1000/README.md index e69de29bb2..72696f6bf9 100644 --- a/pkg/uwb-dw1000/README.md +++ b/pkg/uwb-dw1000/README.md @@ -0,0 +1,34 @@ +# Decawave uwb-dw1000 RIOT Port + +The distribution https://github.com/decawave/uwb-core contains the +device driver implementation for the Decawave Impulse Radio-Ultra +Wideband (IR-UWB) transceiver(s). The driver includes hardware abstraction +layers (HAL), media access control (MAC) layer, Ranging Services (RNG). + +## Abstraction details + +uwb-dw1000 is meant as a hardware and architecture agnostic driver. It +was developed with MyNewt as its default OS, but its abstractions are +well defined which makes it easy to use with another OS. + +A porting layer DPL (Decawave Porting Layer) has been implemented that +wraps around OS functionalities and modules: mutex, semaphores, threads, +etc.. In most cases the mapping is direct although some specific +functionalities might not be supported. This layer is found in the uwb-core +pkg. + +A hardware abstraction layer is defined under `hal` which wraps around +modules such as: periph_gpio, periph_spi, etc. + +Since the library was used on top of mynewt most configuration values +are prefixed with `MYNEWT_VAL_%`, all configurations can be found under +`pkg/uwb-dw1000/include/syscfg`. + +## Todos + +The uwb-dw1000 can be used to provide a netdev driver for the dw1000 +module. + +uwb-dw1000 repository uses fixed length arrays to keep track of the +devices that are present. This port uses linked list but some of the +upstream code is not compatible with this. diff --git a/pkg/uwb-dw1000/doc.txt b/pkg/uwb-dw1000/doc.txt index d54f7da58b..b463730240 100644 --- a/pkg/uwb-dw1000/doc.txt +++ b/pkg/uwb-dw1000/doc.txt @@ -3,39 +3,6 @@ * @ingroup pkg * @brief uwb-core driver for Decawave DW1000 transceiver * @see https://github.com/Decawave/uwb-dw1000 + * + * @include pkg/ucglib/README.md */ - -# Decawave uwb-dw1000 RIOT Port - -The distribution https://github.com/decawave/uwb-core contains the -device driver implementation for the Decawave Impulse Radio-Ultra -Wideband (IR-UWB) transceiver(s). The driver includes hardware abstraction -layers (HAL), media access control (MAC) layer, Ranging Services (RNG). - -## Abstraction details - -uwb-dw1000 is meant as a hardware and architecture agnostic driver. It -was developed with MyNewt as its default OS, but its abstractions are -well defined which makes it easy to use with another OS. - -A porting layer DPL (Decawave Porting Layer) has been implemented that -wraps around OS functionalities and modules: mutex, semaphores, threads, -etc.. In most cases the mapping is direct although some specific -functionalities might not be supported. This layer is found in the uwb-core -pkg. - -A hardware abstraction layer is defined under `hal` which wraps around -modules such as: periph_gpio, periph_spi, etc. - -Since the library was used on top of mynewt most configuration values -are prefixed with `MYNEWT_VAL_%`, all configurations can be found under -`pkg/uwb-dw1000/include/syscfg`. - -## Todos - -The uwb-dw1000 can be used to provide a netdev driver for the dw1000 -module. - -uwb-dw1000 repository uses fixed length arrays to keep track of the -devices that are present. This port uses linked list but some of the -upstream code is not compatible with this.