Repository files navigation

TheArduino Core API module for zephyr leverages the power of Zephyr under an Arduino-C++ style abtraction layer thus helping zephyr new-comers to start using it without worrying about learning about new APIs and libraries. See the project documentation folder for detailed documentation on these topics:

• Using external Arduino Libraries
• Adding custom boards/ variants

• Pre requisites: It is assumed that you have zephyrproject configured and installed on your system as per the officialGet Started Guide. The recommended path to install is~/zephyrproject as specified in the guide. If you have zephyr installed in a custom path you may need to make changes to the CMakeLists.txt file in the sample code directory when building these samples.

• Add following entry towest.yml file inmanifest/projects subtree of Zephyr:

# Arduino API repository.- name: Arduino-Core-Zephyr  path: modules/lib/Arduino-Zephyr-API  revision: main  url: https://github.com/zephyrproject-rtos/gsoc-2022-arduino-core

• Then, clone the repository by running

west update

• Note: ForLinux users only there exists aninstall.sh script in this project that can be run to quickly link the ArduinoCore-API to this module.If you are able to run that script successfully then you can skip the next steps.

• To "complete" the core you need to copy or symlink the api folder from theArduinoCore-API repo to the target'scores/arduino folder:

$ git clone git@github.com:arduino/ArduinoCore-API# Any location$ ln -s /<your>/<location>/ArduinoCore-API/api cores/arduino/.

Thecores folder can be found at~/zephyrproject/modules/lib/Arduino-Zephyr-API/cores.

Known Bug(s):

NOTE: You can skip this step as well if you raninstall.sh.

Maintainers:

• DhruvaG2000
• soburi
• szczys
• beriberikix
• alvarowolfx

Please note that the current license is Apache 2. Previously it was LGPL 2.1 but after careful review it was determined that no LGPL code or derivates was used and the more permissive license was chosen.

Additional Links

• Official Project Blog
• Golioth's Article:Zephyr + Arduino: a Google Summer of Code story