Skip to content

Commit 051d3f9

Browse files
committed
Refactor wiki
Remove useless pages Fix some typos Add a sidebar for better readability Rework folder structure
1 parent c8c6043 commit 051d3f9

26 files changed

+112
-168
lines changed

API.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,10 @@
1212
* [I2C](https://github.com/stm32duino/wiki/wiki/API#i2C)
1313
* [CMSIS DSP](https://github.com/stm32duino/wiki/wiki/API#cmsis-dsp)
1414
* [EEPROM emulation](https://github.com/stm32duino/wiki/wiki/API#EEPROM-Emulation)
15+
* [Servo](https://github.com/stm32duino/wiki/wiki/Servo-library)
1516
* [Other](https://github.com/stm32duino/wiki/wiki/API#other)
1617
* [Remembering variables across resets](https://github.com/stm32duino/wiki/wiki/API#Remembering-variables-across-resets)
18+
1719
# Core
1820

1921
This part describes the STM32 core functions.
@@ -587,6 +589,9 @@ For example, NUCLEO_F767ZI is by default configured in single bank. Last sector
587589
If this configuration is changed, it is then mandatory to customize `FLASH_BASE_ADDRESS`/`FLASH_DATA_SECTOR`,
588590
even to use last sector of Flash.
589591
592+
## Servo library
593+
https://github.com/stm32duino/wiki/wiki/Servo-library
594+
590595
# Other
591596
592597
## Remembering variables across resets

Boards-Manager.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

Libraries.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ Some libraries have been developped to support specific features (hardware or no
3434

3535
* [STM32Ethernet](https://github.com/stm32duino/STM32Ethernet): for on board Ethernet port (ex: Nucleo-F429ZI). This library is fully compatible with Arduino [Ethernet](https://www.arduino.cc/en/Reference/Ethernet) API. It depends on the following libraries:
3636
* [LwIP](https://github.com/stm32duino/LwIP): lightweight TCP/IP stack (LwIP) is a small independent implementation of the TCP/IP protocol suite
37+
38+
Dedicated [Wiki page](https://github.com/stm32duino/wiki/wiki/STM32Ethernet)
3739
* [STM32FreeRTOS](https://github.com/stm32duino/STM32FreeRTOS): this is a port of [FreeRTOS](https://www.freertos.org/) for STM32 as Arduino libraries
3840
* [STM32LowPower](https://github.com/stm32duino/STM32LowPower): to support some STM32 low power mode. It depends on the following libraries:
3941
* [STM32RTC](https://github.com/stm32duino/STM32RTC)
@@ -42,30 +44,31 @@ Some libraries have been developped to support specific features (hardware or no
4244
* [FatFS](https://github.com/stm32duino/FatFs): FatFs is a generic FAT file system module for small embedded systems. The FatFs is written in compliance with ANSI C and completely separated from the disk I/O layer. Therefore it is independent of hardware architecture
4345

4446

45-
* [HTS221](https://github.com/stm32duino/HTS221): to support the HTS221 capacitive digital sensor for relative humidity and temperature
47+
* [HTS221](https://github.com/stm32duino/HTS221): to support the HTS221 capacitive digital sensor for relative humidity and temperature.
48+
Dedicated [Wiki page](https://github.com/stm32duino/wiki/wiki/HTS221)
4649
* [IIS2MDC](https://github.com/stm32duino/IIS2MDC): to support the IIS2MDC high-performance 3-axis magnetometer
4750
* [ISM330DLC](https://github.com/stm32duino/ISM330DLC): to support the ISM330DLC 3D accelerometer and 3D gyroscope
4851
* [LIS2DW12](https://github.com/stm32duino/LIS2DW12): to support the LIS2DW12 3D accelerometer
4952
* [LIS2MDL](https://github.com/stm32duino/LIS2MDL): to support the LIS2MDL high-performance 3-axis magnetometer
5053
* [LIS3DHH](https://github.com/stm32duino/LIS3DHH): to support the LIS3DHH 3D accelerometer
51-
* [LIS3MDL](https://github.com/stm32duino/LIS3MDL): to support the LIS3MDL high-performance 3-axis magnetometer
52-
* [LPS22HB](https://github.com/stm32duino/LPS22HB): to support the LPS22HB 260-1260 hPa absolute digital ouput barometer
54+
* [LIS3MDL](https://github.com/stm32duino/LIS3MDL): to support the LIS3MDL high-performance 3-axis magnetometer. Dedicated [Wiki page](https://github.com/stm32duino/wiki/wiki/LIS3MDL)
55+
* [LPS22HB](https://github.com/stm32duino/LPS22HB): to support the LPS22HB 260-1260 hPa absolute digital ouput barometer. Dedicated [Wiki page](https://github.com/stm32duino/wiki/wiki/LPS22HB)
5356
* [LPS25HB](https://github.com/stm32duino/LPS25HB): to support the LPS25HB 260-1260 hPa absolute digital ouput barometer
5457
* [LPS22HH](https://github.com/stm32duino/LPS22HH): to support the LPS22HH 260-1260 hPa absolute digital ouput barometer
5558
* [LSM303AGR](https://github.com/stm32duino/LSM303AGR): to support the LSM303AGR 3D accelerometer and 3D magnetometer
5659
* [LSM6DSO](https://github.com/stm32duino/LSM6DSO): to support the LSM6DSO 3D accelerometer and 3D gyroscope
5760
* [LSM6DSOX](https://github.com/stm32duino/LSM6DSOX): to support the LSM6DSOX 3D accelerometer and 3D gyroscope
5861
* [LSM6DS0](https://github.com/stm32duino/LSM6DS0): to support the LSM6DS0 3D accelerometer and 3D gyroscope
5962
* [LSM6DS3 ](https://github.com/stm32duino/LSM6DS3): to support the LSM6DS3 3D accelerometer and 3D gyroscope
60-
* [LSM6DSL](https://github.com/stm32duino/LSM6DSL): to support the LSM6DSL 3D accelerometer and 3D gyroscope
61-
* [M24SR64-Y](https://github.com/stm32duino/M24SR64-Y): to support the dynamic NFC/RFID Tag IC dual interface M24SR64-Y
62-
* [MX25R6435F](https://github.com/stm32duino/MX25R6435F): to support the Quad-SPI NOR Flash memory MX25R6435F
63+
* [LSM6DSL](https://github.com/stm32duino/LSM6DSL): to support the LSM6DSL 3D accelerometer and 3D gyroscope. Dedicated [Wiki page](https://github.com/stm32duino/wiki/wiki/LSM6DSL)
64+
* [M24SR64-Y](https://github.com/stm32duino/M24SR64-Y): to support the dynamic NFC/RFID Tag IC dual interface M24SR64-Y. Dedicated [Wiki page](https://github.com/stm32duino/wiki/wiki/M24SR64-Y)
65+
* [MX25R6435F](https://github.com/stm32duino/MX25R6435F): to support the Quad-SPI NOR Flash memory MX25R6435F. Dedicated [Wiki page](https://github.com/stm32duino/wiki/wiki/MX25R6435F)
6366
* [Proximity Gesture](https://github.com/stm32duino/Proximity_Gesture): o support gesture-detection using proximity sensors (VL53L0X or VL53L1X or VL6180X). The APIs provide single swipe gesture detection, directional (left/right) swipe gesture detection and single tap gesture detection
64-
* [SPBTLE-RF](https://github.com/stm32duino/SPBTLE-RF): to support the Bluetooth (V4.1 compliant) SPBTLE-RF
67+
* [SPBTLE-RF](https://github.com/stm32duino/SPBTLE-RF): to support the Bluetooth (V4.1 compliant) SPBTLE-RF. Dedicated [Wiki page](https://github.com/stm32duino/wiki/wiki/SPBTLE-RF)
6568
* [ST25DV](https://github.com/stm32duino/ST25DV): to support the ST25DV components
6669
* [STTS22H](https://github.com/stm32duino/STTS22H): to support the STTS22H digital temperature sensor
6770
* [STTS751](https://github.com/stm32duino/STTS751): to support the STTS751 digital temperature sensor
68-
* [VL53L0X](https://github.com/stm32duino/VL53L0X): to support the VL53L0X Time-of-Flight and gesture-detection sensor
71+
* [VL53L0X](https://github.com/stm32duino/VL53L0X): to support the VL53L0X Time-of-Flight and gesture-detection sensor. Dedicated [Wiki page](https://github.com/stm32duino/wiki/wiki/VL53L0X)
6972
* [VL53L1X](https://github.com/stm32duino/VL53L1X): to support the VL53L1X Time-of-Flight and gesture-detection sensor
7073
* [VL6180X](https://github.com/stm32duino/VL6180X): to support the VL6180X proximity and ambient light sensing (ALS) sensor
7174
* [WiFi-ISM43362-M3G-L44](https://github.com/stm32duino/WiFi-ISM43362-M3G-L44): to support the Wi-Fi module Inventek ISM43362-M3G-L44 (802.11 b/g/n)
File renamed without changes.

MP34DT01.md

Lines changed: 0 additions & 53 deletions
This file was deleted.

Release-Versioning-change.md

Lines changed: 0 additions & 62 deletions
This file was deleted.

STM32duinoBLE-with-STEVAL_MKSBOX1V1.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

STM32duinoBLE-with-X_NUCLEO_BNRG2A1.md renamed to STM32duinoBLE.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,36 @@
1+
2+
# STM32duinoBLE with STEVAL_MKSBOX1V1
3+
4+
STM32duinoBLE library does not work with the stock firmware that is loaded in the BLE module of STEVAL-MKSBOX1V1.
5+
For this reason, first of all, it is needed to solder on STEVAL-MKSBOX1V1 a JTAG/SWD 0.05" pitch 10pin male connector in the apposite space of the PCB.
6+
7+
[[/img/SensorTile_Box1.PNG|alt="Space on PCB where soldering the JTAG connector"]]
8+
9+
Then you can use a standard ST-Link V2-1 with a JTAG/SWD 0.05" pitch 10pin to 20pin IDC cable together with [STSW-BNRGFLASHER](https://www.st.com/content/st_com/en/products/embedded-software/wireless-connectivity-software/stsw-bnrgflasher.html) software tool (currently available only for Windows PC) in order to update the firmware of the BLE module of STEVAL-MKSBOX1V1.
10+
11+
First of all, install the ST BlueNRG-1_2 Flasher Utility and open it, then select the SWD tab:
12+
13+
[[/img/SensorTile_Box2.PNG|alt="SWD tab of ST BlueNRG-1_2 Flasher Utility"]]
14+
15+
Erase the flash memory of the BlueNRG-1 chip:
16+
17+
[[/img/SensorTile_Box3.PNG|alt="Erase of the BlueNRG-1 chip"]]
18+
19+
Download the Link Layer Only firmware for the BLE module from the following link:
20+
21+
[DTM_LLOnly.bin](https://github.com/stm32duino/wiki/raw/master/STEVAL-MKSBOX1V1/DTM_LLOnly.bin)
22+
23+
Load the Link Layer Only firmware in the ST BlueNRG-1_2 Flasher Utility and then press the "Flash" button:
24+
25+
[[/img/SensorTile_Box4.PNG|alt="Load and flash the new firmware into BlueNRG-1 chip"]]
26+
27+
If you need to restore the stock firmware of the BLE module of STEVAL-MKSBOX1V1, you can repeat the procedure using this firmware image:
28+
29+
[DTM_Full.bin](https://github.com/stm32duino/wiki/raw/master/STEVAL-MKSBOX1V1/DTM_Full.bin)
30+
31+
32+
# STM32duinoBLE with X-NUCLEO-BNRG2A1
33+
134
STM32duinoBLE library does not work with the stock firmware that is loaded in the BLE module of X-NUCLEO-BNRG2A1 expansion board.
235

336
For this reason, first of all, it is needed to solder on X-NUCLEO-BNRG2A1, if it is not soldered, a 0 Ohm resistor at R117.
@@ -39,3 +72,4 @@ If you need to restore the stock firmware of the BLE module of X-NUCLEO-BNRG2A1,
3972
[DTM_Full.bin](https://github.com/stm32duino/wiki/raw/master/X-NUCLEO-BNRG2A1/DTM_Full.bin)
4073

4174
If you should find some issues during the update process, you can try to repeat the procedure closing the J15 jumper on the X-NUCLEO-BNRG2A1 expansion board.
75+

_Sidebar.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
[Home](https://github.com/stm32duino/wiki/wiki)
2+
3+
* [Getting Started](https://github.com/stm32duino/wiki/wiki/Getting-Started)
4+
* [Upload methods](https://github.com/stm32duino/wiki/wiki/Upload-methods)
5+
* [FAQ](https://github.com/stm32duino/wiki/wiki/FAQ)
6+
* <details>
7+
<summary>API References</summary>
8+
9+
* [Core](https://github.com/stm32duino/wiki/wiki/API#core)
10+
* [Core version](https://github.com/stm32duino/wiki/wiki/API#core-version)
11+
* [Core Callback](https://github.com/stm32duino/wiki/wiki/API#core-callback)
12+
* [Wiring](https://github.com/stm32duino/wiki/wiki/API#wiring)
13+
* [Analog](https://github.com/stm32duino/wiki/wiki/API#analog)
14+
* [HardwareSerial](https://github.com/stm32duino/wiki/wiki/API#hardwareserial)
15+
* [HardwareTimer](https://github.com/stm32duino/wiki/wiki/HardwareTimer-library)
16+
* [Built-In Library](https://github.com/stm32duino/wiki/wiki/API#built-in-library)
17+
* [SPI](https://github.com/stm32duino/wiki/wiki/API#spi)
18+
* [I2C](https://github.com/stm32duino/wiki/wiki/API#i2C)
19+
* [CMSIS DSP](https://github.com/stm32duino/wiki/wiki/API#cmsis-dsp)
20+
* [EEPROM emulation](https://github.com/stm32duino/wiki/wiki/API#EEPROM-Emulation)
21+
* [Servo](https://github.com/stm32duino/wiki/wiki/Servo-library)
22+
* [Other](https://github.com/stm32duino/wiki/wiki/API#other)
23+
* [Remembering variables across resets](https://github.com/stm32duino/wiki/wiki/API#Remembering-variables-across-resets)
24+
25+
</details>
26+
27+
* <details>
28+
<summary>Libraries</summary>
29+
30+
* [Introduction](https://github.com/stm32duino/wiki/wiki/Libraries)
31+
* [Built-in (delivered with the core package)](https://github.com/stm32duino/wiki/wiki/Libraries#built-in-delivered-with-the-core-package)
32+
* [Dedicated](https://github.com/stm32duino/wiki/wiki/Libraries#dedicated)
33+
* [Expansion boards](https://github.com/stm32duino/wiki/wiki/Libraries#expansion-boards)
34+
* [Official from Arduino](https://github.com/stm32duino/wiki/wiki/Libraries#official-from-arduino)
35+
* [Third party](https://github.com/stm32duino/wiki/wiki/Libraries#third-party)
36+
</details>
37+
38+
* <details>
39+
<summary>Advanced usage</summary>
40+
41+
* Contributing
42+
* [Add a new variant (board)](https://github.com/stm32duino/wiki/wiki/Add-a-new-variant-%28board%29)
43+
* [Using git repository](https://github.com/stm32duino/wiki/wiki/Using-git-repository)
44+
* [Astyle](https://github.com/stm32duino/wiki/wiki/Astyle)
45+
* Customization
46+
* [Custom definitions](https://github.com/stm32duino/wiki/wiki/Custom-definitions)
47+
* [Customize build options (build_opt.h)](https://github.com/stm32duino/wiki/wiki/Customize-build-options-using-build_opt.h)
48+
* [HAL module configuration](https://github.com/stm32duino/wiki/wiki/HAL-configuration)
49+
* [custom board support based on a core](https://github.com/stm32duino/wiki/wiki/Custom-board-based-on-a-core)
50+
* [How to debug](https://github.com/stm32duino/wiki/wiki/How-to-debug)
51+
</details>
52+
53+
* <details>
54+
<summary>Connectivities</summary>
55+
* [BLE](https://github.com/stm32duino/wiki/wiki/stm32duinoble)
56+
* [LoRa](https://github.com/stm32duino/wiki/wiki/lora)
57+
58+
</details>

0 commit comments

Comments
 (0)