https://github.com/simplefoc/stm32pinouts
Autogenerated docs providing an easy navigation of stm32 pinouts for different families
https://github.com/simplefoc/stm32pinouts
docs simplefoc stm32
Last synced: about 1 year ago
JSON representation
Autogenerated docs providing an easy navigation of stm32 pinouts for different families
- Host: GitHub
- URL: https://github.com/simplefoc/stm32pinouts
- Owner: simplefoc
- License: mit
- Created: 2024-02-26T09:09:04.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-29T16:53:56.000Z (over 1 year ago)
- Last Synced: 2025-02-13T01:55:13.538Z (over 1 year ago)
- Topics: docs, simplefoc, stm32
- Language: Python
- Homepage: https://docs.simplefoc.com/stm32pinouts/
- Size: 1.01 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# STM32 Family Pinout
This page contains a list of pinout information for each subfamily of STM32 variants.
This page is automatically generated from the [STM32duino](https://github.com/stm32duino/Arduino_Core_STM32) repository. This webpage has been generated using version [2.7.1](https://github.com/stm32duino/Arduino_Core_STM32/releases).
This page is intended to be used for quick search of available PWM timers and ADC channels for a given STM32 family and subfamily. The information is extracted from the `PeripheralPins.c` file of the STM32duino repository. The `variant_*.cpp` files are used to provide the variant names for each subfamily. The `variant_generic.cpp` file is used as a generic variant for each subfamily.
## How to Use It
1. Navigate to the STM32 family and subfamily of interest using the provided links.
2. Click on the subfamily link to view the pinout information for that specific STM32 variant.
3. Use the provided information to identify available PWM timers and ADC channels for your project.
## Contributing
This page is automatically generated using a Python script. The script is [parser.py](parser.py). Please feel free to contribute to the script if you find any issues or have any suggestions.
## Generating the website locally
Clone this repo to your computer
```
git clone https://github.com/simplefoc/stm32pinouts.git
cd stm32pinouts
```
Clone the stm32duino repo
```
git clone https://github.com/stm32duino/Arduino_Core_STM32.git
```
Parse the stm32duino repo
```shell
python parser.py
```
> This command will create the website from scratch, it will take some time and generate a lot of folders and files
run the website
```
jekyll serve
```