gen-stm32

STM32 project skeleton generator


Keywords
STM, STM32, project, C, Unix, Linux, 32-bit, arm, arm-gcc, asembly, cxx, eabi, embedded, generator, macos, mcu, python, skeleton-generator
License
AFL-3.0
Install
pip install gen-stm32==1.1.1

Documentation

STM32 project skeleton generator

gen_stm32 is toolset for generation STM32 project skeleton for development of embedded applications.

Developed in python code: 100%.

The README is used to introduce the modules and provide instructions on how to install the modules, any machine dependencies it may have and any other information that should be provided before the modules are installed.

Python package GitHub issues open GitHub contributors

Table of Contents

Installation

Install Python2 Package Install Python3 Package

Currently there are three ways to install tool:

  • Install process based on pip
  • Install process based on setup.py (setuptools)
  • Install process based on docker mechanism
Install using pip

Python package is located at pypi.org.

You can install by using pip

#python2
pip install gen_stm32
#python3
pip3 install gen_stm32
Install using setuptools

Navigate to release page download and extract release archive.

To install modules, locate and run setup.py, type the following:

tar xvzf gen_stm32-x.y.z.tar.gz
cd gen_stm32-x.y.z
#python2
pip install -r requirements.txt
python setup.py install_lib
python setup.py install_egg_info
python setup.py install_data
#python3
pip3 install -r requirements.txt
python3 setup.py install_lib
python3 setup.py install_egg_info
python3 setup.py install_data
Install using docker

You can use Dockerfile to create image/container.

gen_stm32 docker checker

Dependencies

This module requires these other modules and libraries:

Generation flow

Base flow of generation process:

alt tag

Tool structure

gen_stm32 is based on Template mechanism:

alt tag

Generator structure:

gen_stm32/
├── conf/
│   ├── gen_stm32.cfg
│   ├── gen_stm32_util.cfg
│   ├── project.yaml
│   └── template/
│       ├── build/
│       │   ├── includes/
│       │   │   └── STM32F4xx_StdPeriph_Driver/
│       │   │       └── src/
│       │   │           └── subdir.template
│       │   ├── Makefile.template
│       │   ├── objects.template
│       │   ├── source/
│       │   │   └── subdir.template
│       │   └── sources.template
│       ├── includes/
│       │   ├── CMSIS/
│       │   │   ├── arm_common_tables.template
│       │   │   ├── arm_math.template
│       │   │   ├── core_cm0.template
│       │   │   ├── core_cm3.template
│       │   │   ├── core_cm4_simd.template
│       │   │   ├── core_cm4.template
│       │   │   ├── core_cmFunc.template
│       │   │   └── core_cmInstr.template
│       │   ├── STM32F4xx/
│       │   │   ├── stm32f4xx_conf.template
│       │   │   ├── stm32f4xx.template
│       │   │   └── system_stm32f4xx.template
│       │   └── STM32F4xx_StdPeriph_Driver/
│       │       ├── inc/
│       │       │   ├── misc.template
│       │       │   ├── stm32f4xx_adc.template
│       │       │   ├── stm32f4xx_can.template
│       │       │   ├── stm32f4xx_crc.template
│       │       │   ├── stm32f4xx_cryp.template
│       │       │   ├── stm32f4xx_dac.template
│       │       │   ├── stm32f4xx_dbgmcu.template
│       │       │   ├── stm32f4xx_dcmi.template
│       │       │   ├── stm32f4xx_dma.template
│       │       │   ├── stm32f4xx_exti.template
│       │       │   ├── stm32f4xx_flash.template
│       │       │   ├── stm32f4xx_fsmc.template
│       │       │   ├── stm32f4xx_gpio.template
│       │       │   ├── stm32f4xx_hash.template
│       │       │   ├── stm32f4xx_i2c.template
│       │       │   ├── stm32f4xx_iwdg.template
│       │       │   ├── stm32f4xx_pwr.template
│       │       │   ├── stm32f4xx_rcc.template
│       │       │   ├── stm32f4xx_rng.template
│       │       │   ├── stm32f4xx_rtc.template
│       │       │   ├── stm32f4xx_sdio.template
│       │       │   ├── stm32f4xx_spi.template
│       │       │   ├── stm32f4xx_syscfg.template
│       │       │   ├── stm32f4xx_tim.template
│       │       │   ├── stm32f4xx_usart.template
│       │       │   └── stm32f4xx_wwdg.template
│       │       └── src/
│       │           ├── misc.template
│       │           ├── stm32f4xx_adc.template
│       │           ├── stm32f4xx_can.template
│       │           ├── stm32f4xx_crc.template
│       │           ├── stm32f4xx_cryp_aes.template
│       │           ├── stm32f4xx_cryp_des.template
│       │           ├── stm32f4xx_cryp_tdes.template
│       │           ├── stm32f4xx_cryp.template
│       │           ├── stm32f4xx_dac.template
│       │           ├── stm32f4xx_dbgmcu.template
│       │           ├── stm32f4xx_dcmi.template
│       │           ├── stm32f4xx_dma.template
│       │           ├── stm32f4xx_exti.template
│       │           ├── stm32f4xx_flash.template
│       │           ├── stm32f4xx_fsmc.template
│       │           ├── stm32f4xx_gpio.template
│       │           ├── stm32f4xx_hash_md5.template
│       │           ├── stm32f4xx_hash_sha1.template
│       │           ├── stm32f4xx_hash.template
│       │           ├── stm32f4xx_i2c.template
│       │           ├── stm32f4xx_iwdg.template
│       │           ├── stm32f4xx_pwr.template
│       │           ├── stm32f4xx_rcc.template
│       │           ├── stm32f4xx_rng.template
│       │           ├── stm32f4xx_rtc.template
│       │           ├── stm32f4xx_sdio.template
│       │           ├── stm32f4xx_spi.template
│       │           ├── stm32f4xx_syscfg.template
│       │           ├── stm32f4xx_tim.template
│       │           ├── stm32f4xx_usart.template
│       │           └── stm32f4xx_wwdg.template
│       ├── scripts/
│       │   └── arm_cortex_m4_512.template
│       └── source/
│           ├── main.template
│           ├── startup_stm32f4xx.template
│           ├── syscall.template
│           ├── system_stm32f4xx.template
│           └── tinynew.template
├── __init__.py
├── log/
│   └── gen_stm32.log
├── pro/
│   ├── config
│   │   ├── __init__.py
│   │   ├── pro_name.py
│   │   └── template_dir.py
│   ├── __init__.py
│   ├── read_template.py
│   └── write_template.py
└── run/
    └── gen_stm32_run.py

Docs

Documentation Status

More documentation and info at:

Copyright and licence

License: GPL v3 License

Copyright (C) 2018 by vroncevic.github.io/gen_stm32

gen_stm32 is free software; you can redistribute it and/or modify it under the same terms as Python itself, either Python version 2.x/3.x or, at your option, any later version of Python 3 you may have available.

Lets help and support PSF.

Python Software Foundation

Donate