Skip to content

Commit f1b63f6

Browse files
committed
Release v1.1.0
1 parent d87812a commit f1b63f6

File tree

17,655 files changed

+5352560
-2
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

17,655 files changed

+5352560
-2
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Caution**
11+
The Issues are strictly limited for the reporting of problem encountered with the software provided in this project.
12+
For any other problem related to the STM32 product, the performance, the hardware characteristics and boards, the tools the environment in general, please post a topic in the [ST Community/STM32 MCUs forum](https://community.st.com/s/group/0F90X000000AXsASAW/stm32-mcus)
13+
14+
**Describe the set-up**
15+
* The board (either ST RPN reference or your custom board)
16+
* IDE or at least the compiler and its version
17+
18+
**Describe the bug**
19+
A clear and concise description of what the bug is.
20+
21+
**How To Reproduce**
22+
1. Indicate the global behavior of your application project
23+
24+
2. The modules that you suspect to be the cause of the problem (Driver, BSP, MW ...)
25+
26+
3. The use case that generates the problem
27+
28+
4. How we can reproduce the problem
29+
30+
31+
**Additional context**
32+
If you have a first analysis or patch correction, thank you to share your proposal.
33+
34+
**Screenshots**
35+
If applicable, add screenshots to help explain your problem.

.github/ISSUE_TEMPLATE/other-issue.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: 'Other Issue '
3+
about: Generic issue description
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Caution**
11+
The Issues are strictly limited for the reporting of problem encountered with the software provided in this project.
12+
For any other problem related to the STM32 product, the performance, the hardware characteristics and boards, the tools the environment in general, please post a topic in the [ST Community/STM32 MCUs forum](https://community.st.com/s/group/0F90X000000AXsASAW/stm32-mcus)
13+
14+
**Describe the set-up**
15+
* The board (either ST RPN reference or your custom board)
16+
* IDE or at least the compiler and its version
17+
18+
**Additional context**
19+
If you have a first analysis or a patch proposal, thank you to share your proposal.
20+
21+
**Screenshots**
22+
If applicable, add screenshots to help explain your problem.

.github/PULL_REQUEST_TEMPLATE.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## IMPORTANT INFORMATION
2+
3+
### Contributor License Agreement (CLA)
4+
* The Pull Request feature will be considered by STMicroelectronics only after a **Contributor License Agreement (CLA)** mechanism has been deployed.
5+
* We are currently working on the set-up of this procedure.
6+
7+
8+

CODE_OF_CONDUCT.md

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at https://www.st.com/content/st_com/en/contact-us.html. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

CONTRIBUTING.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## Contributing guide
2+
This document serves as a checklist before contributing to this repository.
3+
It includes links to read up on if topics are unclear to you.
4+
5+
This guide mainly focuses on the proper use of Git.
6+
7+
### 1. Before opening an issue
8+
To report a bug/request please file an issue in the right repository
9+
(example for [STM32CubeL5](https://github.com/STMicroelectronics/STM32CubeL5/issues/new/choose)).
10+
But check the following boxes before posting an issue:
11+
12+
- [ ] `Make sure you are using the latest commit (major releases are Tagged, but corrections are available as new commits).`
13+
- [ ] `Make sure your issue is a question/feedback/suggestions RELATED TO the software provided in this repo.` Otherwise, it should be discussed on the [ST Community/STM32 MCUs forum](https://community.st.com/s/group/0F90X000000AXsASAW/stm32-mcus).
14+
- [ ] `Make sure your issue is not already reported/fixed on GitHub or discussed on a previous Issue.` Please refer to this [dashboard](https://github.com/orgs/STMicroelectronics/projects/2) for the list of issues and pull-requests. Do not forget to browse into the **closed** issues.
15+
16+
17+
### 2. Posting the issue
18+
When you have checked the previous boxes. You will find two templates Issues (Bug Report or Other Issue) available in the **Issues** tab of the repo.
19+
20+
### 3. Pull Requests
21+
For the moment, the Pull Request feature is not deployed. STMicrolectronics is working on a Contributor License Agreement procedure.
22+
563 KB
Binary file not shown.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,197 @@
1+
<!DOCTYPE html>
2+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
3+
<head>
4+
<meta charset="utf-8" />
5+
<meta name="generator" content="pandoc" />
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
7+
<title>Release Notes for BSP Common Components Drivers</title>
8+
<style type="text/css">
9+
code{white-space: pre-wrap;}
10+
span.smallcaps{font-variant: small-caps;}
11+
span.underline{text-decoration: underline;}
12+
div.column{display: inline-block; vertical-align: top; width: 50%;}
13+
</style>
14+
<link rel="stylesheet" href="_htmresc/mini-st.css" />
15+
<!--[if lt IE 9]>
16+
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
17+
<![endif]-->
18+
</head>
19+
<body>
20+
<div class="row">
21+
<div class="col-sm-12 col-lg-4">
22+
<div class="card fluid">
23+
<div class="sectione dark">
24+
<center>
25+
<h1 id="release-notes-for-bsp-common-components-drivers"><small>Release Notes for</small> <mark>BSP Common Components Drivers</mark></h1>
26+
<p>Copyright © 2014 STMicroelectronics<br />
27+
</p>
28+
<a href="https://www.st.com" class="logo"><img src="_htmresc/st_logo.png" alt="ST logo" /></a>
29+
</center>
30+
</div>
31+
</div>
32+
<h1 id="license">License</h1>
33+
<p>Licensed by ST under BSD 3-Clause license (the "License"). You may not use this package except in compliance with the License. You may obtain a copy of the License at:</p>
34+
<p><a href="https://opensource.org/licenses/BSD-3-Clause">https://opensource.org/licenses/BSD-3-Clause</a></p>
35+
<h1 id="purpose">Purpose</h1>
36+
<p>This directory contains the BSP Common components drivers.</p>
37+
</div>
38+
<div class="col-sm-12 col-lg-8">
39+
<h1 id="update-history">Update History</h1>
40+
<div class="collapse">
41+
<input type="checkbox" id="collapse-section15" checked aria-hidden="true"> <label for="collapse-section15" aria-hidden="true">V6.0.1 / 15-October-2019</label>
42+
<div>
43+
<h2 id="main-changes">Main Changes</h2>
44+
<h3 id="component-release">Component release</h3>
45+
<ul>
46+
<li>Update st_logo.png inclusion path in Release notes.</li>
47+
</ul>
48+
</div>
49+
</div>
50+
<div class="collapse">
51+
<input type="checkbox" id="collapse-section14" checked aria-hidden="true"> <label for="collapse-section14" aria-hidden="true">V6.0.0 / 12-April-2019</label>
52+
<div>
53+
<h2 id="main-changes-1">Main Changes</h2>
54+
<h3 id="component-release-1">Component release</h3>
55+
<p>Official release of BSP Common components drivers in line with STM32Cube BSP drivers development guidelines (UM2298).</p>
56+
<h2 id="backward-compatibility">Backward Compatibility</h2>
57+
<p>This release breaks compatibility with previous versions.</p>
58+
</div>
59+
</div>
60+
<div class="collapse">
61+
<input type="checkbox" id="collapse-section13" aria-hidden="true"> <label for="collapse-section13" aria-hidden="true">V5.1.1 / 31-August-2018</label>
62+
<div>
63+
<h2 id="main-changes-2">Main Changes</h2>
64+
<p>Reformat the BSD 3-Clause license declaration in the files header (replace license terms by a web reference to OSI website where those terms lie)<br />
65+
Correct sensor names in headers files hsensor.h and psensor.h</p>
66+
</div>
67+
</div>
68+
<div class="collapse">
69+
<input type="checkbox" id="collapse-section12" aria-hidden="true"> <label for="collapse-section12" aria-hidden="true">V5.1.0 / 21-November-2017</label>
70+
<div>
71+
<h2 id="main-changes-3">Main Changes</h2>
72+
<p>Add dpredriver.h: support of DP redriver class<br />
73+
Add pwrmon.h: support of power monitor class<br />
74+
Add usbtypecswitch.h: support of USB type C switch class</p>
75+
</div>
76+
</div>
77+
<div class="collapse">
78+
<input type="checkbox" id="collapse-section11" aria-hidden="true"> <label for="collapse-section11" aria-hidden="true">V5.0.0 / 01-March-2017</label>
79+
<div>
80+
<h2 id="main-changes-4">Main Changes</h2>
81+
<p>Add hsensor.h: support of humidity class<br />
82+
Add psensor.h: support of pressure class<br />
83+
Update tsensor.h: Temperature can be negative<br />
84+
Update accelero.h: LowPower API can enable or disable the low power mode<br />
85+
Update magneto.h: LowPower API can enable or disable the low power mode</p>
86+
<h2 id="backward-compatibility-1">Backward Compatibility</h2>
87+
<p>This release breaks compatibility with previous versions.</p>
88+
</div>
89+
</div>
90+
<div class="collapse">
91+
<input type="checkbox" id="collapse-section10" aria-hidden="true"> <label for="collapse-section10" aria-hidden="true">V4.0.1 / 21-July-2015</label>
92+
<div>
93+
<h2 id="main-changes-5">Main Changes</h2>
94+
<p>tsensor.h: Fix compilation issue on <em>TSENSOR_InitTypeDef</em></p>
95+
</div>
96+
</div>
97+
<div class="collapse">
98+
<input type="checkbox" id="collapse-section9" aria-hidden="true"> <label for="collapse-section9" aria-hidden="true">V4.0.0 / 22-June-2015</label>
99+
<div>
100+
<h2 id="main-changes-6">Main Changes</h2>
101+
<p>accelero.h: add <em>DeInit</em> field in <em>ACCELERO_DrvTypeDef</em> structure<br />
102+
audio.h: add <em>DeInit</em> field in <em>AUDIO_DrvTypeDef</em> structure<br />
103+
idd.h:</p>
104+
<ul>
105+
<li>add <em>Shunt0StabDelay</em>, <em>Shunt1StabDelay</em>, <em>Shunt2StabDelay</em>, <em>Shunt3StabDelay</em>, <em>Shunt4StabDelay</em> and <em>ShuntNbOnBoard</em> fields in <em>IDD_ConfigTypeDef</em> structure<br />
106+
</li>
107+
<li>rename <em>ShuntNumber</em> field to <em>ShuntNbUsed</em> in <em>IDD_ConfigTypeDef</em> structure</li>
108+
</ul>
109+
<p>magneto.h: add <em>DeInit</em> field in <em>MAGNETO_DrvTypeDef</em> structure</p>
110+
<h2 id="backward-compatibility-2">Backward Compatibility</h2>
111+
<p>This release breaks compatibility with previous versions.</p>
112+
</div>
113+
</div>
114+
<div class="collapse">
115+
<input type="checkbox" id="collapse-section8" aria-hidden="true"> <label for="collapse-section8" aria-hidden="true">V3.0.0 / 28-April-2015</label>
116+
<div>
117+
<h2 id="main-changes-7">Main Changes</h2>
118+
<p>accelero.h: add <em>LowPower</em> field in <em>ACCELERO_DrvTypeDef</em> structure<br />
119+
magneto.h: add <em>LowPower</em> field in <em>MAGNETO_DrvTypeDef</em> structure<br />
120+
gyro.h: add <em>DeInit</em> and <em>LowPower</em> fields in <em>GYRO_DrvTypeDef</em> structure<br />
121+
camera.h: add CAMERA_COLOR_EFFECT_NONE define<br />
122+
idd.h:</p>
123+
<ul>
124+
<li>add <em>MeasureNb</em>, <em>DeltaDelayUnit</em> and <em>DeltaDelayValue</em> fields in <em>IDD_ConfigTypeDef</em> structure<br />
125+
</li>
126+
<li>rename <em>PreDelay</em> field to <em>PreDelayUnit</em> in <em>IDD_ConfigTypeDef</em> structure</li>
127+
</ul>
128+
<h2 id="backward-compatibility-3">Backward Compatibility</h2>
129+
<p>This release breaks compatibility with previous versions.</p>
130+
</div>
131+
</div>
132+
<div class="collapse">
133+
<input type="checkbox" id="collapse-section7" aria-hidden="true"> <label for="collapse-section7" aria-hidden="true">V2.2.0 / 09-February-2015</label>
134+
<div>
135+
<h2 id="main-changes-8">Main Changes</h2>
136+
<p>Magnetometer driver function prototypes added (magneto.h file)<br />
137+
Update “idd.h” file to provide DeInit() and WakeUp() services in IDD current measurement driver</p>
138+
</div>
139+
</div>
140+
<div class="collapse">
141+
<input type="checkbox" id="collapse-section6" aria-hidden="true"> <label for="collapse-section6" aria-hidden="true">V2.1.0 / 06-February-2015</label>
142+
<div>
143+
<h2 id="main-changes-9">Main Changes</h2>
144+
<p>IDD current measurement driver function prototypes added (idd.h file)<br />
145+
io.h: add new typedef enum IO_PinState with IO_PIN_RESET and IO_PIN_SET values</p>
146+
</div>
147+
</div>
148+
<div class="collapse">
149+
<input type="checkbox" id="collapse-section5" aria-hidden="true"> <label for="collapse-section5" aria-hidden="true">V2.0.0 / 15-December-2014</label>
150+
<div>
151+
<h2 id="main-changes-10">Main Changes</h2>
152+
<p>Update “io.h” file to support MFX (Multi Function eXpander) device available on some STM32 boards</p>
153+
<ul>
154+
<li>add new entries for <em>IO_ModeTypedef</em> enumeration structure</li>
155+
<li>update the <em>IO_DrvTypeDef</em> structure</li>
156+
<li>Update all return values and function parameters to uint32_t</li>
157+
<li>Add a return value for <em>Config</em> field</li>
158+
</ul>
159+
<h2 id="backward-compatibility-4">Backward Compatibility</h2>
160+
<p>This release breaks compatibility with previous versions.</p>
161+
</div>
162+
</div>
163+
<div class="collapse">
164+
<input type="checkbox" id="collapse-section4" aria-hidden="true"> <label for="collapse-section4" aria-hidden="true">V1.2.1 / 02-December-2014</label>
165+
<div>
166+
<h2 id="main-changes-11">Main Changes</h2>
167+
<p>gyro.h: change “__GIRO_H” by “__GYRO_H” to fix compilation issue under Mac OS</p>
168+
</div>
169+
</div>
170+
<div class="collapse">
171+
<input type="checkbox" id="collapse-section3" aria-hidden="true"> <label for="collapse-section3" aria-hidden="true">V1.2.0 / 18-June-2014</label>
172+
<div>
173+
<h2 id="main-changes-12">Main Changes</h2>
174+
<p>EPD (E Paper Display) driver function prototype added (epd.h file)</p>
175+
</div>
176+
</div>
177+
<div class="collapse">
178+
<input type="checkbox" id="collapse-section2" aria-hidden="true"> <label for="collapse-section2" aria-hidden="true">V1.1.0 / 21-March-2014</label>
179+
<div>
180+
<h2 id="main-changes-13">Main Changes</h2>
181+
<p>Temperature Sensor driver function prototype added</p>
182+
</div>
183+
</div>
184+
<div class="collapse">
185+
<input type="checkbox" id="collapse-section1" aria-hidden="true"> <label for="collapse-section1" aria-hidden="true">V1.0.0 / 18-February-2014</label>
186+
<div>
187+
<h2 id="main-changes-14">Main Changes</h2>
188+
<p>First official release with Accelerometer, Audio, Camera, Gyroscope, IO, LCD and Touch Screen drivers function prototypes</p>
189+
</div>
190+
</div>
191+
</div>
192+
</div>
193+
<footer class="sticky">
194+
For complete documentation on <mark>STM32 Microcontrollers</mark> , visit: <a href="http://www.st.com/STM32">http://www.st.com/STM32</a>
195+
</footer>
196+
</body>
197+
</html>

0 commit comments

Comments
 (0)