-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
albezanc
committed
Jun 25, 2021
1 parent
de3d67a
commit f356f14
Showing
8 changed files
with
1,957 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
## Contributing guide | ||
This document serves as a checklist before contributing to this repository. It includes links to additional information if topics are unclear to you. | ||
|
||
This guide mainly focuses on the proper use of Git. | ||
|
||
### 1. Before opening an issue | ||
To report a bug/request please enter the issue in the right repository. | ||
|
||
Please check the following boxes before posting an issue: | ||
- [ ] `Make sure you are using the latest commit (major releases are Tagged, but corrections are available as new commits).` | ||
- [ ] `Make sure your issue is a question/feedback/suggestion RELATED TO the software provided in this repository.` Otherwise, it should be discussed on the [ST Community forum](https://community.st.com/s/). | ||
- [ ] `Make sure your issue is not already reported/fixed on GitHub or discussed in a previous issue.` Please refer to the tab issue for the list of issues and pull-requests. Do not forget to browse to the **closed** issues. | ||
|
||
### 2. Posting the issue | ||
When you have checked the previous boxes, you will find two templates (Bug Report or Other Issue) available in the **Issues** tab of the repository. | ||
|
||
### 3. Pull Requests | ||
STMicroelectronics is happy to receive contributions from the community, based on an initial Contributor License Agreement (CLA) procedure. | ||
|
||
* If you are an individual writing original source code and you are sure **you own the intellectual property**, then you need to sign an Individual CLA (https://cla.st.com). | ||
* If you work for a company that wants also to allow you to contribute with your work, your company needs to provide a Corporate CLA (https://cla.st.com) mentioning your GitHub account name. | ||
* If you are not sure that a CLA (Individual or Corporate) has been signed for your GitHub account, you can check here (https://cla.st.com). | ||
|
||
Please note that: | ||
* The Corporate CLA will always take precedence over the Individual CLA. | ||
* One CLA submission is sufficient for any project proposed by STMicroelectronics. | ||
|
||
#### How to proceed | ||
|
||
* We recommend to engage first a communication through an issue, in order to present your proposal and just to confirm that it corresponds to a STMicroelectronics domain or scope. | ||
* Then fork the project to your GitHub account to further develop your contribution. Please use the latest commit version. | ||
* Please submit one Pull Request for one new feature or proposal. This will facilitate the analysis and the final merge if accepted. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
BSD 3-Clause License | ||
|
||
Copyright (c) 2019, STMicroelectronics | ||
All rights reserved. | ||
|
||
Redistribution and use in source and binary forms, with or without | ||
modification, are permitted provided that the following conditions are met: | ||
|
||
* Redistributions of source code must retain the above copyright notice, this | ||
list of conditions and the following disclaimer. | ||
|
||
* Redistributions in binary form must reproduce the above copyright notice, | ||
this list of conditions and the following disclaimer in the documentation | ||
and/or other materials provided with the distribution. | ||
|
||
* Neither the name of the copyright holder nor the names of its | ||
contributors may be used to endorse or promote products derived from | ||
this software without specific prior written permission. | ||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE | ||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | ||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER | ||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, | ||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# 1 - Introduction | ||
|
||
Sensor driver for IIS3DWB 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/IIS3DWB/ | ||
``` | ||
|
||
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). **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/IIS3DWB_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, uint8_t *Bufp, uint16_t len) | ||
int32_t platform_read(void *handle, uint8_t Reg, uint8_t *Bufp, uint16_t len) | ||
``` | ||
|
||
- 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; | ||
``` | ||
|
||
- 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/IIS3DWB_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** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
<!DOCTYPE html> | ||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> | ||
<head> | ||
<meta charset="utf-8" /> | ||
<meta name="generator" content="pandoc" /> | ||
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" /> | ||
<title>Release Notes for IIS3DWB Component</title> | ||
<style> | ||
code{white-space: pre-wrap;} | ||
span.smallcaps{font-variant: small-caps;} | ||
span.underline{text-decoration: underline;} | ||
div.column{display: inline-block; vertical-align: top; width: 50%;} | ||
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;} | ||
ul.task-list{list-style: none;} | ||
.display.math{display: block; text-align: center; margin: 0.5rem auto;} | ||
</style> | ||
<link rel="stylesheet" href="_htmresc/mini-st_2020.css" /> | ||
<!--[if lt IE 9]> | ||
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> | ||
<![endif]--> | ||
<link rel="icon" type="image/x-icon" href="_htmresc/favicon.png" /> | ||
</head> | ||
<body> | ||
<div class="row"> | ||
<div class="col-sm-12 col-lg-4"> | ||
<center> | ||
<h1 id="release-notes-for-iis3dwb-component-driver">Release Notes for IIS3DWB Component Driver</h1> | ||
<p>Copyright © 2021 STMicroelectronics<br /> | ||
</p> | ||
<a href="https://www.st.com" class="logo"><img src="_htmresc/st_logo_2020.png" alt="ST logo" /></a> | ||
</center> | ||
<h1 id="license">License</h1> | ||
<p>This software component is licensed by ST under BSD 3-Clause license, the “License”. You may not use this component except in compliance with the License. You may obtain a copy of the License at:</p> | ||
<p><a href="https://opensource.org/licenses/BSD-3-Clause">BSD 3-Clause license</a></p> | ||
<h1 id="purpose">Purpose</h1> | ||
<p>This directory contains the IIS3DWB component drivers.</p> | ||
</div> | ||
<section id="update-history" class="col-sm-12 col-lg-8"> | ||
<h1>Update history</h1> | ||
<div class="collapse"> | ||
<input type="checkbox" id="collapse-section1" checked aria-hidden="true"> <label for="collapse-section1" aria-hidden="true">V1.0.0 / 18-June-2021</label> | ||
<div> | ||
<h2 id="main-changes">Main changes</h2> | ||
<h3 id="first-release">First release</h3> | ||
<ul> | ||
<li>First official release</li> | ||
</ul> | ||
<h2 id="section"></h2> | ||
</div> | ||
</div> | ||
</section> | ||
</div> | ||
<footer class="sticky"> | ||
<div class="columns"> | ||
<div class="column" style="width:95%;"> | ||
<p>For complete documentation on IIS3DWB, visit: <a href="https://www.st.com/content/st_com/en/products/mems-and-sensors/accelerometers/iis3dwb.html">IIS3DWB</a></p> | ||
</div><div class="column" style="width:5%;"> | ||
<p><abbr title="Based on template cx566953 version 2.0">Info</abbr></p> | ||
</div> | ||
</div> | ||
</footer> | ||
</body> | ||
</html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
--- | ||
pagetitle: Release Notes for IIS3DWB Component | ||
lang: en | ||
header-includes: <link rel="icon" type="image/x-icon" href="_htmresc/favicon.png" /> | ||
--- | ||
|
||
::: {.row} | ||
::: {.col-sm-12 .col-lg-4} | ||
|
||
<center> | ||
# Release Notes for IIS3DWB Component Driver | ||
Copyright © 2021 STMicroelectronics\ | ||
|
||
[![ST logo](_htmresc/st_logo_2020.png)](https://www.st.com){.logo} | ||
</center> | ||
|
||
# License | ||
|
||
This software component is licensed by ST under BSD 3-Clause license, the "License". | ||
You may not use this component except in compliance with the License. You may obtain a copy of the License at: | ||
|
||
[BSD 3-Clause license](https://opensource.org/licenses/BSD-3-Clause) | ||
|
||
# Purpose | ||
|
||
This directory contains the IIS3DWB component drivers. | ||
::: | ||
|
||
::: {.col-sm-12 .col-lg-8} | ||
# Update history | ||
|
||
::: {.collapse} | ||
<input type="checkbox" id="collapse-section1" checked aria-hidden="true"> | ||
<label for="collapse-section1" aria-hidden="true">V1.0.0 / 18-June-2021</label> | ||
<div> | ||
|
||
## Main changes | ||
|
||
### First release | ||
|
||
- First official release | ||
|
||
## | ||
|
||
</div> | ||
::: | ||
|
||
::: | ||
::: | ||
|
||
<footer class="sticky"> | ||
::: {.columns} | ||
::: {.column width="95%"} | ||
For complete documentation on IIS3DWB, | ||
visit: | ||
[IIS3DWB](https://www.st.com/content/st_com/en/products/mems-and-sensors/accelerometers/iis3dwb.html) | ||
::: | ||
::: {.column width="5%"} | ||
<abbr title="Based on template cx566953 version 2.0">Info</abbr> | ||
::: | ||
::: | ||
</footer> |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.