fix: typo raised by codespell

Signed-off-by: Frederic Pillon <[email protected]>

Author: fpistm

HardwareTimer-library.md

@@ -46,7 +46,7 @@ Each timer may provide several channels, nevertheless it is important to underst
     void setOverflow(uint32_t val, TimerFormat_t format = TICK_FORMAT); // set AutoReload register depending on format provided
     uint32_t getOverflow(TimerFormat_t format = TICK_FORMAT); // return overflow depending on format provided
 
-    void setPWM(uint32_t channel, PinName pin, uint32_t frequency, uint32_t dutycycle, callback_function_t PeriodCallback = nullptr, callback_function_t CompareCallback = nullptr); // Set all in one command freq in HZ, Duty in percentage. Including both interrup.
+    void setPWM(uint32_t channel, PinName pin, uint32_t frequency, uint32_t dutycycle, callback_function_t PeriodCallback = nullptr, callback_function_t CompareCallback = nullptr); // Set all in one command freq in HZ, Duty in percentage. Including both interrupt.
     void setPWM(uint32_t channel, uint32_t pin, uint32_t frequency, uint32_t dutycycle, callback_function_t PeriodCallback = nullptr, callback_function_t CompareCallback = nullptr);
 
     void setCount(uint32_t val, TimerFormat_t format = TICK_FORMAT); // set timer counter to value 'val' depending on format provided
@@ -74,12 +74,12 @@ Each timer may provide several channels, nevertheless it is important to underst
     bool hasInterrupt(uint32_t channel);  //returns true if an interrupt has already been set on the channel compare match
     void timerHandleDeinit();  // Timer deinitialization
 
-    // Refresh() is usefull while timer is running after some registers update
+    // Refresh() is useful while timer is running after some registers update
     void refresh(void); // Generate update event to force all registers (Autoreload, prescaler, compare) to be taken into account
 
     uint32_t getTimerClkFreq();  // return timer clock frequency in Hz.
 
-    static void captureCompareCallback(TIM_HandleTypeDef *htim); // Generic Caputre and Compare callback which will call user callback
+    static void captureCompareCallback(TIM_HandleTypeDef *htim); // Generic Capture and Compare callback which will call user callback
     static void updateCallback(TIM_HandleTypeDef *htim);  // Generic Update (rollover) callback which will call user callback
 
     // The following function(s) are available for more advanced timer options

Libraries.md

@@ -30,7 +30,7 @@ or have a look hereafter to see which one is available:
 
 ## Dedicated
 
-Some libraries have been developped to support specific features (hardware or not):
+Some libraries have been developed to support specific features (hardware or not):
 
 * [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:
   * [LwIP](https://github.com/stm32duino/LwIP): lightweight TCP/IP stack (LwIP) is a small independent implementation of the TCP/IP protocol suite
@@ -52,9 +52,9 @@ Some libraries have been developped to support specific features (hardware or no
 * [LIS2MDL](https://github.com/stm32duino/LIS2MDL):  to support the LIS2MDL high-performance 3-axis magnetometer
 * [LIS3DHH](https://github.com/stm32duino/LIS3DHH): to support the LIS3DHH 3D accelerometer
 * [LIS3MDL](https://github.com/stm32duino/LIS3MDL): to support the LIS3MDL high-performance 3-axis magnetometer. Dedicated [[Wiki page|LIS3MDL]]
-* [LPS22HB](https://github.com/stm32duino/LPS22HB): to support the LPS22HB 260-1260 hPa absolute digital ouput barometer. Dedicated [[Wiki page|LPS22HB]]
-* [LPS25HB](https://github.com/stm32duino/LPS25HB): to support the LPS25HB 260-1260 hPa absolute digital ouput barometer
-* [LPS22HH](https://github.com/stm32duino/LPS22HH): to support the LPS22HH 260-1260 hPa absolute digital ouput barometer
+* [LPS22HB](https://github.com/stm32duino/LPS22HB): to support the LPS22HB 260-1260 hPa absolute digital output barometer. Dedicated [[Wiki page|LPS22HB]]
+* [LPS25HB](https://github.com/stm32duino/LPS25HB): to support the LPS25HB 260-1260 hPa absolute digital output barometer
+* [LPS22HH](https://github.com/stm32duino/LPS22HH): to support the LPS22HH 260-1260 hPa absolute digital output barometer
 * [LSM303AGR](https://github.com/stm32duino/LSM303AGR): to support the LSM303AGR 3D accelerometer and 3D magnetometer
 * [LSM6DSO](https://github.com/stm32duino/LSM6DSO): to support the LSM6DSO 3D accelerometer and 3D gyroscope
 * [LSM6DSOX](https://github.com/stm32duino/LSM6DSOX): to support the LSM6DSOX 3D accelerometer and 3D gyroscope

Upload-methods.md

@@ -161,7 +161,7 @@ The `hid-flash` tool is available on Windows, Linux and MacOS.
 
 Details of HID bootloader v2.2 (and newer) hid-flash tool as well as ready-to-use binary files can be found at the GitHub repository: https://github.com/Serasidis/STM32_HID_Bootloader
 
-[[/img/Warning-icon.png|alt="Warning"]] **USB CDC have to be enable else you will not be able to upload automatically as bootloader reset sequence are manged through the USB CDC communication port.**
+[[/img/Warning-icon.png|alt="Warning"]] **USB CDC have to be enable else you will not be able to upload automatically as bootloader reset sequence are managed through the USB CDC communication port.**
 
 ## Maple DFU Bootloader
 
@@ -186,7 +186,7 @@ Details about the STM32duino-bootloader as well as ready to use binary files can
  * Maple bootloader 2.0 consumes 8KB of flash.
  * Maple bootloader original consumes 20kb of flash and some of the SRAM.
 
-[[/img/Warning-icon.png|alt="Warning"]] **USB CDC have to be enable else you will not be able to upload automatically as bootloader reset sequence are manged through the USB CDC communication port.**
+[[/img/Warning-icon.png|alt="Warning"]] **USB CDC have to be enable else you will not be able to upload automatically as bootloader reset sequence are managed through the USB CDC communication port.**
 
 
 [Discovery]: https://www.st.com/content/st_com/en/products/evaluation-tools/product-evaluation-tools/mcu-mpu-eval-tools/stm32-mcu-mpu-eval-tools/stm32-discovery-kits.html

_cmake/Functions-reference.md

@@ -35,8 +35,8 @@ This is the main function that encapsulates most of the automation of Arduino. I
 - `targetName` is the name of the [binary target](https://cmake.org/cmake/help/latest/manual/cmake-buildsystem.7.html#binary-executables) that will be created as a result of this function; this is a handle that may be reused in later calls, to e.g., `insights()`.
 - `sourcefile...` is a list of sources files to be compiled. This does not comprise header files (`.h`).
   You are strongly advised to hard-code the list of files directly in the CMakeLists.txt. Using [wildcards](https://cmake.org/cmake/help/latest/command/file.html#glob) is possible, but not guaranteed to work in all cases.
-- the optional `dependencies` are targets, usually Arduino libraries such as created by `external_library()`, that the sketch depdends on.
-  The CMake build model makes it awkward at best to automatically handle dependencies the way Arduino does, so they have to be specified explicitely.
+- the optional `dependencies` are targets, usually Arduino libraries such as created by `external_library()`, that the sketch dedends on.
+  The CMake build model makes it awkward at best to automatically handle dependencies the way Arduino does, so they have to be specified explicitly.
 
 What this function does is the following:
 
@@ -94,8 +94,8 @@ insights(TARGET <targetName>
 
 This function lets you produce insights about the build process.
 It uses Graphviz to generate SVG files in order to better understand what happens throughout the build: configuration, compilation, linking.
-The mandatory TARGET argument is the name of the element to analyze, usually your sketch target (crated with `build_sketch()`).
-Each insight keyword is optional; even when provided, they are not built by default, you have to explicitely generate them with the build tool (e.g., `ninja symbols.svg`).
+The mandatory TARGET argument is the name of the element to analyze, usually your sketch target (created with `build_sketch()`).
+Each insight keyword is optional; even when provided, they are not built by default, you have to explicitly generate them with the build tool (e.g., `ninja symbols.svg`).
 
 | Keyword | Generated file | Description |
 | :------ | :------------- | :---------- |

_cmake/Introduction-to-CMake.md

@@ -16,7 +16,7 @@ Both these kinds of files are written using CMake's own language; cf. below.
 Whatever the user interface (system shell, cmake-gui, IDE, ...), there always are two main steps: configuration and build.
 - In the __configuration step__, CMake reads the build description (CMakeLists.txt) and generates files for the build tool to use (e.g., `Makefile` or `build.ninja`).
 - In the __build step__, the build tool is called, either directly or indirectly, to perform the build and generate the required build artifacts.
-In case CMake needs to be re-run (maybe because one of the CMakeLists.txt has been edited), this is handled automatically without requiring the user to go through another configuration step. This means the _configuration step needs only to be invoked once_ explicitely, even when rebuilding an updated project.
+In case CMake needs to be re-run (maybe because one of the CMakeLists.txt has been edited), this is handled automatically without requiring the user to go through another configuration step. This means the _configuration step needs only to be invoked once_ explicitly, even when rebuilding an updated project.
 
 CMake projects are usually built "out-of-source", meaning the build artifacts end up in a parallel directory tree,
 as opposed to "in-source" builds, where they are mixed with the source files.
@@ -40,7 +40,7 @@ The syntax of the CMake language is very simple: the only statement is the funct
 You may want to read [the CMake tutorial](https://cmake.org/cmake/help/latest/guide/tutorial/index.html) to get a comprehensive overview of the features CMake offers.
 
 For a detailed list of the functions this project provides, please refer to [[Functions reference]].
-Below is an introduction to general-purpose CMake; most of it is abstracted away in said funtions.
+Below is an introduction to general-purpose CMake; most of it is abstracted away in said functions.
 
 Here are some key points about the structure of a `CMakeLists.txt` (Also read [the documentation](https://cmake.org/cmake/help/latest/manual/cmake-buildsystem.7.html)):
 - The main file must start with a call to [`cmake_minimum_required()`](https://cmake.org/cmake/help/latest/command/cmake_minimum_required.html), to make sure the version of CMake meets the expectations;

_cmake/Quickstart-guide.md

@@ -53,7 +53,7 @@ optional arguments:
   --cli CLI, -x CLI     path to arduino-cli
   --board BOARD, -b BOARD
                         board name
-  --fire                lauch the build immediately (use with caution!)
+  --fire                launch the build immediately (use with caution!)
   --output OUTPUT, -o OUTPUT
                         output file (CMake) with placeholders
   --sketch SKETCH, -s SKETCH

_cmake/Setup.md

@@ -29,7 +29,7 @@ We demand version >= 3.9. Please browse the official [Python download page](http
 
 These are available on [PyPi](https://pypi.org/), meaning you can install them with `pip install <package>`. When using third-party modules, in order not to impact any other project you may be working on, it is customary (but not mandatory!) to set up a [virtual environment](https://packaging.python.org/en/latest/tutorials/installing-packages/#creating-virtual-environments) (Look up `virtualenv`, `virtualenvwrapper` on PyPi for more information on this process).
 
-The following modules are used througout the project:
+The following modules are used throughout the project:
 - `jinja2`, a templating engine to autogenerate some CMake configuration files.
 - `graphviz`, a rendering engine to generate graphs as insights into the project
 

_dev/How-to-debug.md

@@ -105,7 +105,7 @@ Two standard tools are required in order to debug the code:
 
 ### 3.2 Setting up debug configuration 
 
-If you are using sloeber directly, not CDT with the plugin. The you probaly will not find the below mentiones menue "Debug Configurations" under "Run". This is, because you are in the arduino view. In this view, all "unneccessary" menues are hidden. To overcome this, you can change the view: 
+If you are using sloeber directly, not CDT with the plugin. The you probably will not find the below mentioned menu "Debug Configurations" under "Run". This is, because you are in the arduino view. In this view, all "unnecessary" menus are hidden. To overcome this, you can change the view: 
 
 You can choose the regular C/C++ view. 
 Alternatively you can also reach the debug configurations menu by right-click on your project under the arduino view. 

_libs/_dedicated/VL53L0X.md

@@ -9,20 +9,23 @@ directional (left/right) swipe gesture detection and single tap gesture detectio
 
 ### VL53L0X class
 
-* **VL53L0X(TwoWire\*, int, int, uint8_t)**: class constructor  
+* **VL53L0X(TwoWire\*, int, int, uint8_t)**: class constructor
+
 _Params_ pointer to I2C instance  
 _Params_ sensor shutdown pin  
 _Params_ sensor interrupt pin  
 _Params_ (optional) device address (0x29 by default)  
 
-* **VL53L0X_On**: power on the sensor  
+* **VL53L0X_On**: power on the sensor
+
+* **VL53L0X_Off**: power off the sensor
 
-* **VL53L0X_Off**: power off the sensor  
+* **InitSensor**: initialize the sensor with default values
 
-* **InitSensor**: initialize the sensor with default values  
 _Return_ 0 on Success, error code otherwise  
 
-* **StartMeasurementSimplified(OperatingMode, void(*)(void))**: Start the measure indicated by operating mode  
+* **StartMeasurementSimplified(OperatingMode, void(*)(void))**: Start the measure indicated by operating mode
+
 _Params_ specifies requested measure (range_single_shot_polling,
    range_continuous_polling,
    range_continuous_interrupt,
@@ -35,7 +38,8 @@ _Params_ specifies requested measure (range_single_shot_polling,
 _Params_ pointer to callback function. Must be not NULL in case of interrupt measure  
 _Return_ 0 on Success, error code otherwise  
 
-* **GetMeasurementSimplified(OperatingMode, VL53L0X_RangingMeasurementData_t\*)**: Get results for the measure indicated by operating mode  
+* **GetMeasurementSimplified(OperatingMode, VL53L0X_RangingMeasurementData_t\*)**: Get results for the measure indicated by operating mode
+
 _Params_ specifies requested measure (range_single_shot_polling,
    range_continuous_polling,
    range_continuous_interrupt,
@@ -48,7 +52,8 @@ _Params_ specifies requested measure (range_single_shot_polling,
 _Params_ Data pointer to the MeasureData_t structure to read data in to  
 _Return_ 0 on Success, error code otherwise  
 
-* **StopMeasurementSimplified(OperatingMode)**: Stop the currently running measure indicate by operating_mode  
+* **StopMeasurementSimplified(OperatingMode)**: Stop the currently running measure indicate by operating_mode
+
 _Params_ specifies requested measure (range_single_shot_polling,
    range_continuous_polling,
    range_continuous_interrupt,
@@ -60,17 +65,21 @@ _Params_ specifies requested measure (range_single_shot_polling,
    range_continuous_interrupt_out_of_window)  
 _Return_ 0 on Success, error code otherwise  
 
-* **WaitDeviceBooted**: Wait for device booted after chip enable (hardware standby)  
+* **WaitDeviceBooted**: Wait for device booted after chip enable (hardware standby)
+
 _Return_ 0 on Success, error code otherwise  
 
-* **Prepare**: Prepare device for operation. Does static initialization and reprogram common default setting.  
+* **Prepare**: Prepare device for operation. Does static initialization and reprogram common default setting.
+
 _Return_ 0 on Success, error code otherwise  
 
-* **GetDistance(uint32_t\*)**: Get ranging result and only that  
+* **GetDistance(uint32_t\*)**: Get ranging result and only that
+
 _Params_ pointer to range distance (value in millimeter)  
 _Return_ 0 on Success, error code otherwise  
 
-* **SetDeviceAddress(int)**: Set new device i2c address  
+* **SetDeviceAddress(int)**: Set new device i2c address
+
 _Params_ The new i2c address (7bit)  
 _Return_ 0 on Success, error code otherwise  
 
@@ -89,43 +98,51 @@ _You can find a complete description of the following functions in the API user
 
 ### ToF gestures
 
-* **tof_gestures_initDIRSWIPE_1(int32_t, long, long, Gesture_DIRSWIPE_1_Data_t\*)**: Initialize directional (left/right) gesture dectection  
+* **tof_gestures_initDIRSWIPE_1(int32_t, long, long, Gesture_DIRSWIPE_1_Data_t\*)**: Initialize directional (left/right) gesture detection
+
 _Params_ swipe threshold  
 _Params_ Minimum duration of a swipe to be detected  
 _Params_ Maximum duration of a swipe to be detected  
 _Params_ pointer to Gesture_DIRSWIPE_1_Data_t structure  
 _Return_ 0 on Success, error code otherwise  
 
-* **tof_gestures_detectDIRSWIPE_1(int32_t, int32_t, Gesture_DIRSWIPE_1_Data_t\*)**: Detect directional (left/right) gesture  
+* **tof_gestures_detectDIRSWIPE_1(int32_t, int32_t, Gesture_DIRSWIPE_1_Data_t\*)**: Detect directional (left/right) gesture
+
 _Params_ left range value in millimeter    
 _Params_ right range value in millimeter    
 _Params_ pointer to Gesture_DIRSWIPE_1_Data_t structure  
 _Return_ One of these gestures code: GESTURES_SWIPE_LEFT_RIGHT, GESTURES_SWIPE_RIGHT_LEFT, GESTURES_NULL, GESTURES_DISCARDED_TOO_SLOW or GESTURES_DISCARDED_TOO_FAST  
 
-* **tof_gestures_initSWIPE_1(Gesture_SWIPE_1_Data_t\*)**: Initialize single swipe gesture dectection  
+* **tof_gestures_initSWIPE_1(Gesture_SWIPE_1_Data_t\*)**: Initialize single swipe gesture detection
+
 _Params_ pointer to Gesture_SWIPE_1_Data_t structure  
 _Return_ 0 on Success, error code otherwise  
 
-* **tof_gestures_detectSWIPE_1(int32_t, Gesture_SWIPE_1_Data_t\*)**: Detect single swipe gesture  
+* **tof_gestures_detectSWIPE_1(int32_t, Gesture_SWIPE_1_Data_t\*)**: Detect single swipe gesture
+
 _Params_ range value in millimeter  
 _Params_ pointer to Gesture_SWIPE_1_Data_t structure  
 _Return_ One of these gestures code: GESTURES_HAND_ENTERING, GESTURES_HAND_LEAVING, GESTURES_SINGLE_SWIPE or GESTURES_NULL, GESTURES_DISCARDED, GESTURES_DISCARDED_TOO_SLOW  
 
-* **tof_gestures_initTAP_1(Gesture_TAP_1_Data_t\*)**: Initialize single tap gesture dectection  
+* **tof_gestures_initTAP_1(Gesture_TAP_1_Data_t\*)**: Initialize single tap gesture detection
+
 _Params_ pointer to Gesture_TAP_1_Data_t structure  
 _Return_ 0 on Success, error code otherwise  
 
-* **tof_gestures_detectTAP_1(int32_t, Gesture_TAP_1_Data_t\*)**: Detect single tap gesture  
+* **tof_gestures_detectTAP_1(int32_t, Gesture_TAP_1_Data_t\*)**: Detect single tap gesture
+
 _Params_ range value in millimeter  
 _Params_ pointer to Gesture_TAP_1_Data_t structure  
 _Return_ One of these gestures code: GESTURES_SINGLE_TAP or GESTURES_NULL  
 
-* **tof_initMotion(int, MotionData_t\*)**: Initialize motion dectector  
+* **tof_initMotion(int, MotionData_t\*)**: Initialize motion detector
+
 _Params_ range threshold  
 _Params_ pointer to MotionData_t structure  
 _Return_ 0 on Success, error code otherwise  
 
-* **tof_getMotion(int32_t, MotionData_t\*)**: return current motion state  
+* **tof_getMotion(int32_t, MotionData_t\*)**: return current motion state
+
 _Params_ range value in millimeter  
 _Params_ pointer to MotionData_t structure  
 _Return_ One of these gestures code: GESTURES_MOTION_NULL, GESTURES_MOTION_DOWN_STATE, GESTURES_MOTION_UP_STATE, GESTURES_MOTION_RAISE_UP or GESTURES_MOTION_DROP_DOWN