# AVR project skeleton generator
<img align="right" src="https://raw.githubusercontent.com/vroncevic/gen_avr8/dev/docs/gen_avr8_logo.png" width="25%">
**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)
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**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)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
### 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/)
Raw data
{
"_id": null,
"home_page": "https://vroncevic.github.io/gen_avr8",
"name": "gen-avr8",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "AVR, AVR8, Atmel, Microchip, Microcontroller",
"author": "Vladimir Roncevic",
"author_email": "elektron.ronca@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a4/40/84a0c9b7e141b6632e347a484ab1dc94658ea8697766eed70ae9b24f9389/gen_avr8-2.6.2.tar.gz",
"platform": "POSIX",
"description": "# AVR project skeleton generator\n\n<img align=\"right\" src=\"https://raw.githubusercontent.com/vroncevic/gen_avr8/dev/docs/gen_avr8_logo.png\" width=\"25%\">\n\n**gen_avr8** is tool for generation of AVR8 project skeleton for development\nof embedded applications.\n\nDeveloped in **[python](https://www.python.org/)** code.\n\nThe README is used to introduce the tool modules and provide instructions on\nhow to install the tool modules, any machine dependencies it may have and any\nother information that should be provided before the modules are installed.\n\n[](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)\n\n<!-- START doctoc generated TOC please keep comment here to allow auto update -->\n<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->\n**Table of Contents**\n\n- [Installation](#installation)\n - [Install using pip](#install-using-pip)\n - [Install using build](#install-using-build)\n - [Install using py setup](#install-using-py-setup)\n - [Install using docker](#install-using-docker)\n- [Dependencies](#dependencies)\n- [Usage](#usage)\n- [Supported MCUS](#supported-mcus)\n- [Tool structure](#tool-structure)\n- [Docs](#docs)\n- [Contributing](#contributing)\n- [Copyright and Licence](#copyright-and-licence)\n\n<!-- END doctoc generated TOC please keep comment here to allow auto update -->\n\n### Installation\n\nUsed next development environment\n\n\n\n[](https://github.com/vroncevic/gen_avr8/actions/workflows/gen_avr8_python3_build.yml)\n\nCurrently there are three ways to install package\n* Install process based on using pip mechanism\n* Install process based on build mechanism\n* Install process based on setup.py mechanism\n* Install process based on docker mechanism\n\n##### Install using pip\n\nPython is located at **[pypi.org](https://pypi.org/project/gen-avr8/)**.\n\nYou can install by using pip\n\n```bash\n#python3\npip3 install gen-avr8\n```\n\n##### Install using build\n\nNavigate to release **[page](https://github.com/vroncevic/gen_avr8/releases/)** download and extract release archive.\n\nTo install **gen_avr8** type the following\n\n```bash\ntar xvzf gen_avr8-x.y.z.tar.gz\ncd gen_avr8-x.y.z/\n# python3\nwget https://bootstrap.pypa.io/get-pip.py\npython3 get-pip.py \npython3 -m pip install --upgrade setuptools\npython3 -m pip install --upgrade pip\npython3 -m pip install --upgrade build\npip3 install -r requirements.txt\npython3 -m build --no-isolation --wheel\npip3 install ./dist/gen_avr8-*-py3-none-any.whl\nrm -f get-pip.py\nchmod 755 /usr/local/lib/python3.9/dist-packages/usr/local/bin/gen_avr8_run.py\nln -s /usr/local/lib/python3.9/dist-packages/usr/local/bin/gen_avr8_run.py /usr/local/bin/gen_avr8_run.py\n```\n\n##### Install using py setup\n\nNavigate to **[release page](https://github.com/vroncevic/gen_avr8/releases)** download and extract release archive.\n\nTo install **gen_avr8** locate and run setup.py with arguments\n\n```bash\ntar xvzf gen_avr8-x.y.z.tar.gz\ncd gen_avr8-x.y.z\n# python3\npip3 install -r requirements.txt\npython3 setup.py install_lib\npython3 setup.py install_egg_info\n```\n\n##### Install using docker\n\nYou can use Dockerfile to create image/container.\n\n### Dependencies\n\n**gen_avr8** tool requires other modules/libraries\n\n- [ats-utilities - Python App/Tool/Script Utilities](https://vroncevic.github.io/gen_avr8)\n\n### Usage\n\nShort example of usage **gen_avr8** tool\n\nCreate workspace directory Blink\n\n```bash\nmkdir Blink\ncd Blink/\n```\n\nCrete AVR8 project files, by using parameters\n\n```bash\npython gen_avr8_run.py -n Blink -t app\n```\n\nRunning build process\n\n```bash\ncd build/\nmake all\n```\n\nIn case for missing subtool from toolchain, please install the following packages with your favorite package manager\n\n- gcc-avr\n- binutils-avr\n- gdb-avr\n- avr-libc\n- avrdude\n\nInstall directly from the shell as root user (**[debian](https://www.debian.org/)**)\n\n```bash\napt-get install gcc-avr binutils-avr gdb-avr avr-libc avrdude\n```\n\n### Supported MCUS\n\nCurrent list of supported microcontrollers\n\n```bash\nattiny2313 atmega128 at90s2313\nattiny24 atmega1280 at90s2333\nattiny25 atmega1281 at90s4414\nattiny26 atmega1284p at90s4433\nattiny261 atmega16 at90s4434\nattiny44 atmega163 at90s8515\nattiny45 atmega164p at90s8535\nattiny461 atmega165\nattiny84 atmega165p\nattiny85 atmega168\nattiny861 atmega169\n atmega169p\n atmega2560\n atmega2561\n atmega32\n atmega324p\n atmega325\n atmega3250\n atmega329\n atmega3290\n atmega32u4\n atmega48\n atmega64\n atmega640\n atmega644\n atmega644p\n atmega645\n atmega6450\n atmega649\n atmega6490\n atmega8\n atmega8515\n atmega8535\n atmega88\n```\n\n### Tool structure\n\n**gen_avr8** is based on Template mechanism\n\nGenerator structure\n\n```bash\n gen_avr8/\n \u251c\u2500\u2500 conf/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 fosc.yaml\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 gen_avr8.cfg\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 gen_avr8.logo\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 gen_avr8_util.cfg\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 mcu.yaml\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 project_app.yaml\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 project_lib.yaml\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 template/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 adc/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 app/\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 cflags.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 csflags.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 Makefile.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 module.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 objects.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 ocflags.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 odflags.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 sources.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 subdir.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 tools.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 eeprom/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 gpio/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 lib/\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 aflags.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 avr_lib_c.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 avr_lib_h.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 cflags.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 csflags.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 Makefile.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 objects.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 ocflags.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 odflags.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 sources.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 subdir.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 tools.template\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 uart\n \u251c\u2500\u2500 __init__.py\n \u251c\u2500\u2500 log/\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 gen_avr8.log\n \u251c\u2500\u2500 pro/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 mcu_selector.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 module_type.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 osc_selector.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 read_template.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 template_dir.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 template_type.py\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 write_template.py\n \u251c\u2500\u2500 py.typed\n \u2514\u2500\u2500 run/\n \u2514\u2500\u2500 gen_avr8_run.py\n \n 12 directories, 41 files\n```\n\n### Code coverage\n\n| Name | Stmts | Miss | Cover |\n|------|-------|------|-------|\n| `gen_avr8/__init__.py` | 76 | 12 | 84% |\n| `gen_avr8/pro/__init__.py` | 81 | 6 | 93% |\n| `gen_avr8/pro/mcu_selector.py` | 53 | 2 | 96% |\n| `gen_avr8/pro/module_type.py` | 49 | 2 | 96% |\n| `gen_avr8/pro/osc_selector.py` | 53 | 2 | 96% |\n| `gen_avr8/pro/read_template.py` | 38 | 2 | 95% |\n| `gen_avr8/pro/template_dir.py` | 37 | 2 | 95% |\n| `gen_avr8/pro/template_type.py` | 45 | 3 | 93% |\n| `gen_avr8/pro/write_template.py` | 89 | 2 | 98% |\n| **Total** | 521 | 33 | 94% |\n\n### Docs\n\n[](https://gen-avr8.readthedocs.io/en/latest/?badge=latest)\n\nMore documentation and info at\n\n* [gen_avr8.readthedocs.io](https://gen-avr8.readthedocs.io)\n* [www.python.org](https://www.python.org/)\n\n### Contributing\n\n[Contributing to gen_avr8](CONTRIBUTING.md)\n\n### Copyright and Licence\n\n[](https://www.gnu.org/licenses/gpl-3.0) [](https://opensource.org/licenses/Apache-2.0)\n\nCopyright (C) 2018 - 2024 by [vroncevic.github.io/gen_avr8](https://vroncevic.github.io/gen_avr8/)\n\n**gen_avr8** is free software; you can redistribute it and/or modify\nit under the same terms as Python itself, either Python version 3.x or,\nat your option, any later version of Python 3 you may have available.\n\nLets help and support PSF.\n\n[](https://www.python.org/psf/)\n\n[](https://www.python.org/psf/donations/)\n",
"bugtrack_url": null,
"license": "GPL 2018 - 2024 Free software to use and distributed it.",
"summary": "Python package for generation of AVR8 project",
"version": "2.6.2",
"project_urls": {
"Homepage": "https://vroncevic.github.io/gen_avr8"
},
"split_keywords": [
"avr",
" avr8",
" atmel",
" microchip",
" microcontroller"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "42ce31b626e4af2505a52b0aae65d0eb1334e9a147b1e41e482a15b0193e0d29",
"md5": "2afa46609f6e05ab73bd37af9f87d935",
"sha256": "d86cea535f01180fbe0354656d0289abf4d880def11624b771134009bacb3f73"
},
"downloads": -1,
"filename": "gen_avr8-2.6.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2afa46609f6e05ab73bd37af9f87d935",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 53898,
"upload_time": "2024-07-08T15:50:52",
"upload_time_iso_8601": "2024-07-08T15:50:52.240420Z",
"url": "https://files.pythonhosted.org/packages/42/ce/31b626e4af2505a52b0aae65d0eb1334e9a147b1e41e482a15b0193e0d29/gen_avr8-2.6.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a44084a0c9b7e141b6632e347a484ab1dc94658ea8697766eed70ae9b24f9389",
"md5": "251e9867a23f71452e34324b2ff139a5",
"sha256": "c3b949cf45f14d9be5ed1c8b96f4f649680cb7ebef211915c54a76d12b187016"
},
"downloads": -1,
"filename": "gen_avr8-2.6.2.tar.gz",
"has_sig": false,
"md5_digest": "251e9867a23f71452e34324b2ff139a5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 32793,
"upload_time": "2024-07-08T15:51:02",
"upload_time_iso_8601": "2024-07-08T15:51:02.271375Z",
"url": "https://files.pythonhosted.org/packages/a4/40/84a0c9b7e141b6632e347a484ab1dc94658ea8697766eed70ae9b24f9389/gen_avr8-2.6.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-08 15:51:02",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "gen-avr8"
}
JSON