Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vroncevic/gen_avr8
AVR project skeleton generator
https://github.com/vroncevic/gen_avr8
8-bit at90s atmega attiny avr c embedded generator linux mcu microchip python3 template
Last synced: 23 days ago
JSON representation
AVR project skeleton generator
- Host: GitHub
- URL: https://github.com/vroncevic/gen_avr8
- Owner: vroncevic
- License: gpl-3.0
- Created: 2018-12-08T09:32:56.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-08T15:54:01.000Z (4 months ago)
- Last Synced: 2024-09-15T01:56:10.681Z (2 months ago)
- Topics: 8-bit, at90s, atmega, attiny, avr, c, embedded, generator, linux, mcu, microchip, python3, template
- Language: Python
- Homepage: https://vroncevic.github.io/gen_avr8
- Size: 8.88 MB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# AVR project skeleton generator
**gen_avr8** is tool for generation of AVR8 project skeleton for development
of embedded applications.
Developed in **[python](https://www.python.org/)** code.
The README is used to introduce the tool modules and provide instructions on
how to install the tool modules, any machine dependencies it may have and any
other information that should be provided before the modules are installed.
[](https://github.com/vroncevic/gen_avr8/actions/workflows/gen_avr8_python_checker.yml) [](https://github.com/vroncevic/gen_avr8/actions/workflows/gen_avr8_package.yml) [](https://github.com/vroncevic/gen_avr8/issues) [](https://github.com/vroncevic/gen_avr8/graphs/contributors)
**Table of Contents**
- [Installation](#installation)
- [Install using pip](#install-using-pip)
- [Install using build](#install-using-build)
- [Install using py setup](#install-using-py-setup)
- [Install using docker](#install-using-docker)
- [Dependencies](#dependencies)
- [Usage](#usage)
- [Supported MCUS](#supported-mcus)
- [Tool structure](#tool-structure)
- [Docs](#docs)
- [Contributing](#contributing)
- [Copyright and Licence](#copyright-and-licence)
### Installation
Used next development environment
[](https://github.com/vroncevic/gen_avr8/actions/workflows/gen_avr8_python3_build.yml)
Currently there are three ways to install package
* Install process based on using pip mechanism
* Install process based on build mechanism
* Install process based on setup.py mechanism
* Install process based on docker mechanism
##### Install using pip
Python is located at **[pypi.org](https://pypi.org/project/gen-avr8/)**.
You can install by using pip
```bash
#python3
pip3 install gen-avr8
```
##### Install using build
Navigate to release **[page](https://github.com/vroncevic/gen_avr8/releases/)** download and extract release archive.
To install **gen_avr8** type the following
```bash
tar xvzf gen_avr8-x.y.z.tar.gz
cd gen_avr8-x.y.z/
# python3
wget https://bootstrap.pypa.io/get-pip.py
python3 get-pip.py
python3 -m pip install --upgrade setuptools
python3 -m pip install --upgrade pip
python3 -m pip install --upgrade build
pip3 install -r requirements.txt
python3 -m build --no-isolation --wheel
pip3 install ./dist/gen_avr8-*-py3-none-any.whl
rm -f get-pip.py
chmod 755 /usr/local/lib/python3.9/dist-packages/usr/local/bin/gen_avr8_run.py
ln -s /usr/local/lib/python3.9/dist-packages/usr/local/bin/gen_avr8_run.py /usr/local/bin/gen_avr8_run.py
```
##### Install using py setup
Navigate to **[release page](https://github.com/vroncevic/gen_avr8/releases)** download and extract release archive.
To install **gen_avr8** locate and run setup.py with arguments
```bash
tar xvzf gen_avr8-x.y.z.tar.gz
cd gen_avr8-x.y.z
# python3
pip3 install -r requirements.txt
python3 setup.py install_lib
python3 setup.py install_egg_info
```
##### Install using docker
You can use Dockerfile to create image/container.
### Dependencies
**gen_avr8** tool requires other modules/libraries
- [ats-utilities - Python App/Tool/Script Utilities](https://vroncevic.github.io/gen_avr8)
### Usage
Short example of usage **gen_avr8** tool
Create workspace directory Blink
```bash
mkdir Blink
cd Blink/
```
Crete AVR8 project files, by using parameters
```bash
python gen_avr8_run.py -n Blink -t app
```
Running build process
```bash
cd build/
make all
```
In case for missing subtool from toolchain, please install the following packages with your favorite package manager
- gcc-avr
- binutils-avr
- gdb-avr
- avr-libc
- avrdude
Install directly from the shell as root user (**[debian](https://www.debian.org/)**)
```bash
apt-get install gcc-avr binutils-avr gdb-avr avr-libc avrdude
```
### Supported MCUS
Current list of supported microcontrollers
```bash
attiny2313 atmega128 at90s2313
attiny24 atmega1280 at90s2333
attiny25 atmega1281 at90s4414
attiny26 atmega1284p at90s4433
attiny261 atmega16 at90s4434
attiny44 atmega163 at90s8515
attiny45 atmega164p at90s8535
attiny461 atmega165
attiny84 atmega165p
attiny85 atmega168
attiny861 atmega169
atmega169p
atmega2560
atmega2561
atmega32
atmega324p
atmega325
atmega3250
atmega329
atmega3290
atmega32u4
atmega48
atmega64
atmega640
atmega644
atmega644p
atmega645
atmega6450
atmega649
atmega6490
atmega8
atmega8515
atmega8535
atmega88
```
### Tool structure
**gen_avr8** is based on Template mechanism
Generator structure
```bash
gen_avr8/
├── conf/
│ ├── fosc.yaml
│ ├── gen_avr8.cfg
│ ├── gen_avr8.logo
│ ├── gen_avr8_util.cfg
│ ├── mcu.yaml
│ ├── project_app.yaml
│ ├── project_lib.yaml
│ └── template/
│ ├── adc/
│ ├── app/
│ │ ├── cflags.template
│ │ ├── csflags.template
│ │ ├── Makefile.template
│ │ ├── module.template
│ │ ├── objects.template
│ │ ├── ocflags.template
│ │ ├── odflags.template
│ │ ├── sources.template
│ │ ├── subdir.template
│ │ └── tools.template
│ ├── eeprom/
│ ├── gpio/
│ ├── lib/
│ │ ├── aflags.template
│ │ ├── avr_lib_c.template
│ │ ├── avr_lib_h.template
│ │ ├── cflags.template
│ │ ├── csflags.template
│ │ ├── Makefile.template
│ │ ├── objects.template
│ │ ├── ocflags.template
│ │ ├── odflags.template
│ │ ├── sources.template
│ │ ├── subdir.template
│ │ └── tools.template
│ └── uart
├── __init__.py
├── log/
│ └── gen_avr8.log
├── pro/
│ ├── __init__.py
│ ├── mcu_selector.py
│ ├── module_type.py
│ ├── osc_selector.py
│ ├── read_template.py
│ ├── template_dir.py
│ ├── template_type.py
│ └── write_template.py
├── py.typed
└── run/
└── gen_avr8_run.py
12 directories, 41 files
```
### Code coverage
| Name | Stmts | Miss | Cover |
|------|-------|------|-------|
| `gen_avr8/__init__.py` | 76 | 12 | 84% |
| `gen_avr8/pro/__init__.py` | 81 | 6 | 93% |
| `gen_avr8/pro/mcu_selector.py` | 53 | 2 | 96% |
| `gen_avr8/pro/module_type.py` | 49 | 2 | 96% |
| `gen_avr8/pro/osc_selector.py` | 53 | 2 | 96% |
| `gen_avr8/pro/read_template.py` | 38 | 2 | 95% |
| `gen_avr8/pro/template_dir.py` | 37 | 2 | 95% |
| `gen_avr8/pro/template_type.py` | 45 | 3 | 93% |
| `gen_avr8/pro/write_template.py` | 89 | 2 | 98% |
| **Total** | 521 | 33 | 94% |
### Docs
[](https://gen-avr8.readthedocs.io/en/latest/?badge=latest)
More documentation and info at
* [gen_avr8.readthedocs.io](https://gen-avr8.readthedocs.io)
* [www.python.org](https://www.python.org/)
### Contributing
[Contributing to gen_avr8](CONTRIBUTING.md)
### Copyright and Licence
[](https://www.gnu.org/licenses/gpl-3.0) [](https://opensource.org/licenses/Apache-2.0)
Copyright (C) 2018 - 2024 by [vroncevic.github.io/gen_avr8](https://vroncevic.github.io/gen_avr8/)
**gen_avr8** is free software; you can redistribute it and/or modify
it under the same terms as Python itself, either Python version 3.x or,
at your option, any later version of Python 3 you may have available.
Lets help and support PSF.
[](https://www.python.org/psf/)
[](https://www.python.org/psf/donations/)