william/lis3dh
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

README

Browse Source
This commit is contained in:
William Clark 2024-01-06 17:53:39 +00:00
parent 4dcc5b109d
commit 91ada989f6
1 changed files with 26 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -39,8 +39,28 @@ All above functions return `0` on success, and any non-zero value on error.
If `init` and/or `deinit` are set to `NULL`, they will be ignored. Useful on microcontrollers.
---
## Functions
### STM32
```c
int lis3dh_init(lis3dh_t *lis3dh);
int lis3dh_deinit(lis3dh_t *lis3dh);
int lis3dh_configure(lis3dh_t *lis3dh);
int lis3dh_read(lis3dh_t *lis3dh);
int lis3dh_read_fifo(lis3dh_t *lis3dh, struct lis3dh_fifo_data *fifo);
int lis3dh_read_int1(lis3dh_t *lis3dh);
int lis3dh_read_int2(lis3dh_t *lis3dh);
int lis3dh_read_click(lis3dh_t *lis3dh);
int lis3dh_reference(lis3dh_t *lis3dh);
int lis3dh_reset(lis3dh_t *lis3dh);
int lis3dh_read_adc(lis3dh_t *lis3dh);
int lis3dh_read_temp(lis3dh_t *lis3dh);
```
All functions return `0` on success, and any non-zero value on error.
## STM32
Example i2c and SPI functions that work
### i2c
```c
#define LIS3DH_I2C_ADDR 0x18 /* can also be 0x19 */
@ -61,3 +81,8 @@ int i2c_read(uint8_t reg, uint8_t *dst, uint32_t size) {
}
```
### SPI
```c
TODO
```