yasimavr
========
Yet another simulator for Microchip AVR microcontrollers, inspired from simavr
------------------------------------------------------------------------------
_yasimavr_ is a simulator for AVR 8-bits microcontrollers.
It is mainly aimed at the Mega0 and Mega1 series (ATmega80x-160x-320x-480x and others)
with a possibility to work with the "classic" series. (ATMega48/88/168/328 and others)
It is composed of 2 layers:
* a C++ layer for the core API and the various peripheral simulation models
* a Python layer to handle the configuration, utilities, data recording, and external components
Installation
------------
Prerequisites:
**************
* Python (version >=3.7) and PIP
* For Ubuntu, libelf is required: ``sudo apt-get install libelf-dev``
Install:
********
* execute: ``pip install yasimavr``
The python bindings for the C++ librairies are built with the SIP tool from RiverbankComputing
(https://www.riverbankcomputing.com)
Thanks
------
Quite a few ideas in this software - and even big chunks of code - originate from simavr.
(https://github.com/buserror/simavr)
Big thanks to the simavr authors for this great tool !
Supported IOs
--------------
* GPIO
* SPI
* TWI
* USART
Supported Cores
---------------
The package includes a predefined set of MCU models:
* ATMegaxx8 series (ATMega48/88/168/328)
* ATMega 0-series (ATMega808/809/1608/1609/3208/3209/4808/4809)
Other device models can be easily simulated by creating a YAML config file.
A template is provided, and the example _atgiga4809_ shows how to load and use a customised device configuration.
New simulation models for peripherals can be created in Python or C++ using the provided API.
Features
--------
* Real-time/Fast mode : yasimavr can try to sync the simulated time with system time or run as fast as possible
* AVR-GDB integration : yasimavr can acts as a GDB backend stub, with support for breakpoints and watchpoints
* VCD export : yasimavr can export traces of pin states, GPIO ports, interrupt vectors, memory locations or generic signals in Value Change Dump (VCD) files
* MCU dump : at any point of the simulation, yasimavr can create a snapshot of the state of the MCU model, including all registers and memories and save it in a text file.
* "Zombie" mode : yasimavr can directly interact with simulated peripherals by acting as the CPU. This is useful to verify customised peripheral models or a test script.
* Probing : yasimavr can read/write CPU registers or memories on-the-fly. This is useful to force the firmware into certain branches for example, improving test coverage.
How to use
----------
_yasimavr_ can be used as a Python package to run a prepared simulation script.
(See the examples for how it looks like)
It also supports direct command line use:
* python -m yasimavr [options] [firmware]
For the list of command line options, execute python -m yasimavr -h
Some simple script examples are available here:
https://github.com/clesav/yasimavr/tree/main/examples
Documentation
-------------
The documentation is still a work in progress but will be progressively completed.
The online version, including an API reference, can be read on the Read the Docs:
* [Development documentation] http://yasimavr.readthedocs.io/en/latest/
* [Stable documentation] http://yasimavr.readthedocs.io/en/stable/
Raw data
{
"_id": null,
"home_page": "https://github.com/clesav/yasimavr",
"name": "yasimavr",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "avr simavr",
"author": "C. Savergne",
"author_email": "csavergne@yahoo.com",
"download_url": "https://files.pythonhosted.org/packages/8c/71/cf72e4d137ec09836106aa658c7037504a656cc95af39775ee0d055ac296/yasimavr-0.1.1.tar.gz",
"platform": "Any",
"description": "yasimavr\r\n========\r\n\r\nYet another simulator for Microchip AVR microcontrollers, inspired from simavr\r\n------------------------------------------------------------------------------\r\n\r\n_yasimavr_ is a simulator for AVR 8-bits microcontrollers.\r\nIt is mainly aimed at the Mega0 and Mega1 series (ATmega80x-160x-320x-480x and others)\r\nwith a possibility to work with the \"classic\" series. (ATMega48/88/168/328 and others)\r\n\r\nIt is composed of 2 layers:\r\n\r\n* a C++ layer for the core API and the various peripheral simulation models\r\n* a Python layer to handle the configuration, utilities, data recording, and external components\r\n\r\nInstallation\r\n------------\r\n\r\nPrerequisites:\r\n**************\r\n\r\n* Python (version >=3.7) and PIP\r\n* For Ubuntu, libelf is required: ``sudo apt-get install libelf-dev``\r\n\r\nInstall:\r\n********\r\n\r\n* execute: ``pip install yasimavr``\r\n\r\nThe python bindings for the C++ librairies are built with the SIP tool from RiverbankComputing\r\n(https://www.riverbankcomputing.com)\r\n\r\nThanks\r\n------\r\n\r\nQuite a few ideas in this software - and even big chunks of code - originate from simavr.\r\n(https://github.com/buserror/simavr)\r\nBig thanks to the simavr authors for this great tool !\r\n\r\nSupported IOs\r\n--------------\r\n\r\n* GPIO\r\n* SPI\r\n* TWI\r\n* USART\r\n\r\nSupported Cores\r\n---------------\r\n\r\nThe package includes a predefined set of MCU models:\r\n\r\n* ATMegaxx8 series (ATMega48/88/168/328)\r\n* ATMega 0-series (ATMega808/809/1608/1609/3208/3209/4808/4809)\r\n\r\nOther device models can be easily simulated by creating a YAML config file.\r\nA template is provided, and the example _atgiga4809_ shows how to load and use a customised device configuration.\r\nNew simulation models for peripherals can be created in Python or C++ using the provided API.\r\n\r\nFeatures\r\n--------\r\n\r\n* Real-time/Fast mode : yasimavr can try to sync the simulated time with system time or run as fast as possible\r\n* AVR-GDB integration : yasimavr can acts as a GDB backend stub, with support for breakpoints and watchpoints\r\n* VCD export : yasimavr can export traces of pin states, GPIO ports, interrupt vectors, memory locations or generic signals in Value Change Dump (VCD) files\r\n* MCU dump : at any point of the simulation, yasimavr can create a snapshot of the state of the MCU model, including all registers and memories and save it in a text file.\r\n* \"Zombie\" mode : yasimavr can directly interact with simulated peripherals by acting as the CPU. This is useful to verify customised peripheral models or a test script.\r\n* Probing : yasimavr can read/write CPU registers or memories on-the-fly. This is useful to force the firmware into certain branches for example, improving test coverage.\r\n\r\nHow to use\r\n----------\r\n\r\n_yasimavr_ can be used as a Python package to run a prepared simulation script.\r\n(See the examples for how it looks like)\r\n\r\nIt also supports direct command line use:\r\n\r\n* python -m yasimavr [options] [firmware]\r\n\r\nFor the list of command line options, execute python -m yasimavr -h\r\n\r\nSome simple script examples are available here:\r\nhttps://github.com/clesav/yasimavr/tree/main/examples\r\n\r\nDocumentation\r\n-------------\r\n\r\nThe documentation is still a work in progress but will be progressively completed.\r\nThe online version, including an API reference, can be read on the Read the Docs:\r\n\r\n* [Development documentation] http://yasimavr.readthedocs.io/en/latest/\r\n* [Stable documentation] http://yasimavr.readthedocs.io/en/stable/\r\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "Yet Another SIMulator for AVR",
"version": "0.1.1",
"project_urls": {
"Bug Tracker": "https://github.com/clesav/yasimavr/issues",
"Homepage": "https://github.com/clesav/yasimavr",
"Source Code": "https://github.com/clesav/yasimavr"
},
"split_keywords": [
"avr",
"simavr"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7a9c9f30dd901d12a408ce190911bebef53847bd7787c64ff6c0f381044d5508",
"md5": "55463722b214a4c96de9b15e9b93a52e",
"sha256": "736ca6412e3b746432a63b02d5c86aed5132598448fa22e57ef04d6063cfa637"
},
"downloads": -1,
"filename": "yasimavr-0.1.1-cp310-cp310-win_amd64.whl",
"has_sig": false,
"md5_digest": "55463722b214a4c96de9b15e9b93a52e",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.7",
"size": 1162143,
"upload_time": "2024-02-29T19:34:01",
"upload_time_iso_8601": "2024-02-29T19:34:01.352227Z",
"url": "https://files.pythonhosted.org/packages/7a/9c/9f30dd901d12a408ce190911bebef53847bd7787c64ff6c0f381044d5508/yasimavr-0.1.1-cp310-cp310-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7bba750b3ef9bf5a5395992e19b8d270bd04f022eacb697fa7cd8c59563f8153",
"md5": "9c29c27de3b2a99ad74a275dae84f426",
"sha256": "c8e8986aab9a7dfbdcd65ed03a03d4e83d2808b57465b2ae970ed89837d46f90"
},
"downloads": -1,
"filename": "yasimavr-0.1.1-cp311-cp311-win_amd64.whl",
"has_sig": false,
"md5_digest": "9c29c27de3b2a99ad74a275dae84f426",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.7",
"size": 1162471,
"upload_time": "2024-02-29T19:34:03",
"upload_time_iso_8601": "2024-02-29T19:34:03.615461Z",
"url": "https://files.pythonhosted.org/packages/7b/ba/750b3ef9bf5a5395992e19b8d270bd04f022eacb697fa7cd8c59563f8153/yasimavr-0.1.1-cp311-cp311-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7ea85b38fe6b17dfd4e095158d42c74068e9177afaedea6c9821a1ba20a4c004",
"md5": "49ce5f3bcbd6d9e84a7cf9bc1c439203",
"sha256": "a5a1e655c469af3c9fcce8e4f31e622a570c966231024225abc2bd5a74a06767"
},
"downloads": -1,
"filename": "yasimavr-0.1.1-cp312-cp312-win_amd64.whl",
"has_sig": false,
"md5_digest": "49ce5f3bcbd6d9e84a7cf9bc1c439203",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": ">=3.7",
"size": 1164666,
"upload_time": "2024-02-29T19:34:05",
"upload_time_iso_8601": "2024-02-29T19:34:05.865594Z",
"url": "https://files.pythonhosted.org/packages/7e/a8/5b38fe6b17dfd4e095158d42c74068e9177afaedea6c9821a1ba20a4c004/yasimavr-0.1.1-cp312-cp312-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "97caa4bcfa4498dfd80a007a8e0abf4912284e4672894672620e07c3b341d716",
"md5": "d49af17f6379517a74a4097e84427be5",
"sha256": "41a3fdcb5a9071de5162260548b855d138c9e01c45e6cd446c696d641c2ec4ad"
},
"downloads": -1,
"filename": "yasimavr-0.1.1-cp37-cp37m-win_amd64.whl",
"has_sig": false,
"md5_digest": "d49af17f6379517a74a4097e84427be5",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.7",
"size": 1161858,
"upload_time": "2024-02-29T19:34:07",
"upload_time_iso_8601": "2024-02-29T19:34:07.355599Z",
"url": "https://files.pythonhosted.org/packages/97/ca/a4bcfa4498dfd80a007a8e0abf4912284e4672894672620e07c3b341d716/yasimavr-0.1.1-cp37-cp37m-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e2add6fa744d13fc5f5cf9644dbbb51b409a54f5918593f5669484b0bc82eaa2",
"md5": "bec7abba5850df4fcd3701fa3055739b",
"sha256": "712bb0870331cacf26a1abac46ba5c1f92ddf11a5d8139467b2ce71a35fbd5d5"
},
"downloads": -1,
"filename": "yasimavr-0.1.1-cp38-cp38-win_amd64.whl",
"has_sig": false,
"md5_digest": "bec7abba5850df4fcd3701fa3055739b",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.7",
"size": 1162233,
"upload_time": "2024-02-29T19:34:08",
"upload_time_iso_8601": "2024-02-29T19:34:08.981336Z",
"url": "https://files.pythonhosted.org/packages/e2/ad/d6fa744d13fc5f5cf9644dbbb51b409a54f5918593f5669484b0bc82eaa2/yasimavr-0.1.1-cp38-cp38-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bd031216dca5957073f9dbd0efe474259031a08958923727fa091ee27cf17641",
"md5": "a720da992dd3bcc956d5a0bb9a6958ae",
"sha256": "35c1ffeff2470d2187beb90ee56e719f287fba289aff813b0ab78caa4084b67b"
},
"downloads": -1,
"filename": "yasimavr-0.1.1-cp39-cp39-win_amd64.whl",
"has_sig": false,
"md5_digest": "a720da992dd3bcc956d5a0bb9a6958ae",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.7",
"size": 1162776,
"upload_time": "2024-02-29T19:34:11",
"upload_time_iso_8601": "2024-02-29T19:34:11.163185Z",
"url": "https://files.pythonhosted.org/packages/bd/03/1216dca5957073f9dbd0efe474259031a08958923727fa091ee27cf17641/yasimavr-0.1.1-cp39-cp39-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8c71cf72e4d137ec09836106aa658c7037504a656cc95af39775ee0d055ac296",
"md5": "3e8776831d896792b6b7edc484772de3",
"sha256": "4b2a59fb9c30a367dba7269123c6ffb3c157f52e24b9c72923921a1c0736c88d"
},
"downloads": -1,
"filename": "yasimavr-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "3e8776831d896792b6b7edc484772de3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 285074,
"upload_time": "2024-02-29T19:34:12",
"upload_time_iso_8601": "2024-02-29T19:34:12.571460Z",
"url": "https://files.pythonhosted.org/packages/8c/71/cf72e4d137ec09836106aa658c7037504a656cc95af39775ee0d055ac296/yasimavr-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-29 19:34:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "clesav",
"github_project": "yasimavr",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "yasimavr"
}
JSON
