mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
doc/pkg: include some Readme.md within doc.txt
This commit is contained in:
parent
fb9bd122b3
commit
f8191a03ff
@ -3,4 +3,6 @@
|
|||||||
* @ingroup pkg
|
* @ingroup pkg
|
||||||
* @brief Provides the Bosch Sensortec's BME680 gas sensor API
|
* @brief Provides the Bosch Sensortec's BME680 gas sensor API
|
||||||
* @see https://github.com/BoschSensortec/BME680_driver
|
* @see https://github.com/BoschSensortec/BME680_driver
|
||||||
|
*
|
||||||
|
* @include pkg/driver_bme680/README.md
|
||||||
*/
|
*/
|
||||||
|
@ -15,4 +15,6 @@
|
|||||||
* to your makefile.
|
* to your makefile.
|
||||||
* 48kB is enough for the test other uses may need more or may
|
* 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`
|
* need this to be applied to other threads using `THREAD_STACKSIZE_DEFAULT`
|
||||||
|
*
|
||||||
|
* @include pkg/u8g2/README.md
|
||||||
*/
|
*/
|
||||||
|
@ -3,4 +3,6 @@
|
|||||||
* @ingroup pkg
|
* @ingroup pkg
|
||||||
* @brief Provides a color graphics library for OLED and LCD displays
|
* @brief Provides a color graphics library for OLED and LCD displays
|
||||||
* @see https://github.com/olikraus/ucglib
|
* @see https://github.com/olikraus/ucglib
|
||||||
|
*
|
||||||
|
* @include pkg/ucglib/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.
|
@ -3,39 +3,6 @@
|
|||||||
* @ingroup pkg
|
* @ingroup pkg
|
||||||
* @brief uwb-core driver for Decawave DW1000 transceiver
|
* @brief uwb-core driver for Decawave DW1000 transceiver
|
||||||
* @see https://github.com/Decawave/uwb-dw1000
|
* @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.
|
|
||||||
|
Loading…
Reference in New Issue
Block a user