https://github.com/blueandi/arduinonative

Arduino for native enviroment.
https://github.com/blueandi/arduinonative

arduino native platformio-library

Last synced: 30 days ago
JSON representation

Arduino for native enviroment.

• Host: GitHub
• URL: https://github.com/blueandi/arduinonative
• Owner: BlueAndi
• License: mit
• Created: 2024-06-06T19:10:44.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-09-13T10:59:03.000Z (2 months ago)
• Last Synced: 2024-10-06T12:04:54.750Z (about 1 month ago)
• Topics: arduino, native, platformio-library
• Language: C++
• Homepage:
• Size: 79.1 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ArduinoNative 

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](http://choosealicense.com/licenses/mit/)

[![Repo Status](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)

[![Release](https://img.shields.io/github/release/BlueAndi/ArduinoNative.svg)](https://github.com/BlueAndi/ArduinoNative/releases)

Projects have sometimes the need to run on different platforms. For example a robot software shall run in a simulation on a native environment and on a microcontroller. If the software on the microcontroller is Arduino based, the problem appears in the native environment, because there is no Arduino framework available.

This library provides for this use case some Arduino interfaces, but not all yet. If something is missing, feel free to contribute, which make our all lifes easier. :-)

## Table of content

* [Architecture](#architecture)

  * [The Principle](#the-principle)

  * [Detail](#detail)

* [How to integrate the library?](#how-to-integrate-the-library)

  * [Example](#example)

* [Used Libraries](#used-libraries)

* [Issues, Ideas And Bugs](#issues-ideas-and-bugs)

* [License](#license)

* [Contribution](#contribution)

# Architecture

## The Principle

![Principle](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com//BlueAndi/ArduinoNative/master/doc/uml/Principle.plantuml)

## Detail

![ArduinoNative](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/ArduinoNative/master/doc/uml/ArduinoNative.plantuml)

![DynamicFlow](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/BlueAndi/ArduinoNative/master/doc/uml/DynamicFlow.plantuml)

# How to integrate the library?

1. Add it to the _platformio.ini_ in your environment to the _lib\_deps_ section:

    ```

    lib_deps =

        BlueAndi/ArduinoNative @ ~0.1.0

    ```

2. Call the ```Arduino::setup()``` once and the ```Arduino::loop()``` in a infinite loop in your main entry point function.

## Example

See [minimal example](./examples/example/).

# Used Libraries

| Library                                                            | Description                                                      | License    |

| ------------------------------------------------------------------ | ---------------------------------------------------------------- | ---------- |

| - | - | - |

# Issues, Ideas And Bugs

If you have further ideas or you found some bugs, great! Create a [issue](https://github.com/BlueAndi/ArduinoNative/issues) or if you are able and willing to fix it by yourself, clone the repository and create a pull request.

# License

The whole source code is published under the [MIT license](http://choosealicense.com/licenses/mit/).

Consider the different licenses of the used third party libraries too!

# Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, shall be licensed as above, without any

additional terms or conditions.