The Arduino 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:
-
Pre requisites: It is assumed that you have zephyrproject configured and installed on your system as per the official Get Started Guide. The recommended path to install is
~/zephyrprojectas 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 to
west.ymlfile inmanifest/projectssubtree 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: For Linux users only there exists an
install.shscript 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 the ArduinoCore-API repo to the target's
cores/arduinofolder:
$ git clone git@github.com:arduino/ArduinoCore-API # Any location
$ ln -s /<your>/<location>/ArduinoCore-API/api cores/arduino/.The cores 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 ran install.sh.
Maintainers:
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