Skip to content

Commit 0193abf

Browse files
committed
Updated readme
More information about the LIS3DHTR driver implementations.
1 parent 3453685 commit 0193abf

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Just experimenting with some sensors and the Nucleo-STM32H755ZI
88
Driver implementation for the LIS3DHTR accelerometer providing both high level and low level APIs. It abstracts the underlying transport layer (I2C/SPI) and is easily portable to other MCUs.
99

1010
### High Level API
11-
The high level API exposes device functionality rather than register operations.
11+
The high level API exposes device functionality rather than register operations. It uses the ll API and expects that it is blocking.
1212

1313
Instead of manipulating registers and bitfields directly, the user interacts with device features through functions such as:
1414

@@ -19,7 +19,7 @@ Instead of manipulating registers and bitfields directly, the user interacts wit
1919
The goal is to expose the device capabilities while hiding register layout and configuration details.
2020

2121
### Low Level API
22-
The low level API provides register level access through blocking and non-blocking implementations.
22+
The low level API provides register level access. Currently, there are two implementations, no-OS and FreeRTOS based, both are blocking. The no-OS one waits while communication with the device is facilitated. The FreeRTOS implementation yields and continues when notified through an interrupt that the communication is completed.
2323

2424
The ll API consists of the following functions:
2525
- `LIS3DHTR_read_reg()`: Reads from a register on the device.

0 commit comments

Comments
 (0)