https://github.com/stmicroelectronics/lps33w-pid
lps33w platform independent driver based on Standard C language and compliant with MISRA standard
https://github.com/stmicroelectronics/lps33w-pid
mems-sensors stmicroelectronics
Last synced: 3 months ago
JSON representation
lps33w platform independent driver based on Standard C language and compliant with MISRA standard
- Host: GitHub
- URL: https://github.com/stmicroelectronics/lps33w-pid
- Owner: STMicroelectronics
- License: bsd-3-clause
- Created: 2021-04-21T09:51:48.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-28T14:14:43.000Z (almost 2 years ago)
- Last Synced: 2024-06-28T15:39:40.602Z (almost 2 years ago)
- Topics: mems-sensors, stmicroelectronics
- Language: C
- Homepage:
- Size: 69.3 KB
- Stars: 0
- Watchers: 9
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
(**This device is obsolete and no longer maintained**)
# 1 - Introduction
Sensor driver for LPS33W sensor written in C programming language. This repository contains the sensor driver files (.h and .c) to be included, or linked directly as a git submodule, in your project. The driver is MISRA compliant and the documentation can be generated using the [Doxygen](http://www.doxygen.org/) tool.
In order to `clone` the complete content of the repository folder, use the command:
```
git clone https://github.com/STMicroelectronics/LPS33W-PID/
```
Some examples of driver usage can be found [here](https://github.com/STMicroelectronics/STMems_Standard_C_drivers).
------
# 2 - Integration details
The driver is platform-independent, you only need to define two functions for read and write transactions from the sensor hardware bus (ie. SPI or I²C) and an optional one to implement a delay of millisecond granularity. **A few devices integrate an extra bit in the communication protocol in order to enable multi read/write access, this bit must be managed in the read and write functions defined by the user.** Please refer to the read and write implementation in the [reference examples](https://github.com/STMicroelectronics/STMems_Standard_C_drivers/tree/master/lps33w_STdC/examples).
### 2.a Source code integration
- Include in your project the driver files of the sensor (.h and .c)
- Define in your code the read and write functions that use the I²C or SPI platform driver like the following:
```
/** Please note that is MANDATORY: return 0 -> no Error.**/
int32_t platform_write(void *handle, uint8_t reg, const uint8_t *bufp, uint16_t len)
int32_t platform_read(void *handle, uint8_t reg, uint8_t *bufp, uint16_t len)
/** Optional (may be required by driver) **/
void platform_delay(uint32_t millisec)
```
- Declare and initialize the structure of the device interface:
```
xxxxxxx_ctx_t dev_ctx; /** xxxxxxx is the used part number **/
dev_ctx.write_reg = platform_write;
dev_ctx.read_reg = platform_read;
dev_ctx.mdelay = platform_delay;
```
- If needed by the platform read and write functions, initialize the handle parameter:
```
dev_ctx.handle = &platform_handle;
```
Some integration examples can be found [here](https://github.com/STMicroelectronics/STMems_Standard_C_drivers/tree/master/lps33w_STdC/examples).
### 2.b Required properties
> - A standard C language compiler for the target MCU
> - A C library for the target MCU and the desired interface (ie. SPI, I²C)
------
**More Information: [http://www.st.com](http://st.com/MEMS)**
**Copyright (C) 2021 STMicroelectronics**