Skip to content

Commit

Permalink
Merge pull request #67 from vroncevic/dev
Browse files Browse the repository at this point in the history
[gen_stm32] Updated ATS CLI mechanism, docs
  • Loading branch information
vroncevic committed Jul 9, 2024
2 parents cf19959 + c743dcc commit f440bf2
Show file tree
Hide file tree
Showing 38 changed files with 512 additions and 209 deletions.
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[**.py]
indent_style = tab
tab_width = 4
tab_width = 4
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
__pycache__/
*.py[cod]
*$py.class
*$py.class
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -671,4 +671,4 @@ into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.
<https://www.gnu.org/licenses/why-not-lgpl.html>.
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
global-exclude *.py[cod]
global-exclude *.editorconfig
global-exclude *.editorconfig
226 changes: 118 additions & 108 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,118 +107,128 @@ gen_stm32 is based on OOP.
Generator structure

```bash
gen_stm32/
├── conf/
│ ├── gen_stm32.logo
│   ├── 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/
│   ├── __init__.py
│   ├── read_template.py
│   └── write_template.py
└── run/
└── gen_stm32_run.py
gen_stm32/
├── conf/
│ ├── gen_stm32.logo
│   ├── 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/
│   ├── __init__.py
│   ├── read_template.py
│   └── write_template.py
└── run/
└── gen_stm32_run.py

19 directories, 89 files
```

### Code coverage

| Name | Stmts | Miss | Cover |
|------|-------|------|-------|
| `gen_stm32/__init__.py` | 71 | 12 | 83% |
| `gen_stm32/pro/__init__.py` | 59 | 2 | 97% |
| `gen_stm32/pro/read_template.py` | 52 | 2 | 96% |
| `gen_stm32/pro/write_template.py` | 78 | 3 | 96% |
| **Total** | 260 | 19 | 93% |

### Docs

[![Documentation Status](https://readthedocs.org/projects/gen-stm32/badge/?version=latest)](https://gen-stm32.readthedocs.io/en/latest/?badge=latest)
Expand Down
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/doctrees/gen_stm32.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/gen_stm32.pro.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/gen_stm32.pro.write_template.doctree
Binary file not shown.
Loading

0 comments on commit f440bf2

Please sign in to comment.