|
1 | 1 | About
|
2 | 2 | =====
|
3 | 3 |
|
4 |
| -This is a Arduino add-on package which use [Zephyr OS](https://www.zephyrproject.org/) as backend and develop with Arduino API. |
| 4 | +This is a Arduino package which able to develop with Arduino API with using [Zephyr RTOS](https://www.zephyrproject.org/) as base system. |
| 5 | + |
| 6 | +This source code can also use as a module for Zephyr. |
5 | 7 |
|
6 | 8 | Install
|
7 | 9 | =======
|
8 | 10 |
|
9 |
| -Install Arduino on Zephyr plugin |
| 11 | +Install from ArduinoIDE |
10 | 12 | --------------------------------
|
11 | 13 |
|
12 | 14 | Use this additional package definition of 'Additional Boards Manager URLs' option that is on Arduino's preferences.
|
13 | 15 | * [https://soburi.github.io/arduino-on-zephyr/package_soburi_scirocco_index.json](https://soburi.github.io/arduino-on-zephyr/package_soburi_scirocco_index.json)
|
14 | 16 |
|
15 |
| -Build environment setup |
16 |
| ----------------------------- |
17 |
| - |
18 |
| -Read [Set Up a Development System](https://docs.zephyrproject.org/latest/getting_started/index.html#set-up-a-development-system) instructions. |
| 17 | +Use as a Zephyr Module |
| 18 | +-------------------------------- |
19 | 19 |
|
20 |
| -On Debian/Ubuntu system, run this commands. |
| 20 | +To use this module download(clone) `zephyr` source and configure `west.yml`. |
| 21 | +Append lines to `remotes` and `projects` section to `west.yml` like a below. |
21 | 22 |
|
22 | 23 | ```
|
23 |
| -sudo apt-get install --no-install-recommends git cmake ninja-build gperf \ |
24 |
| - ccache dfu-util device-tree-compiler wget \ |
25 |
| - python3-pip python3-setuptools python3-wheel xz-utils file make gcc \ |
26 |
| - gcc-multilib |
| 24 | +manifest: |
| 25 | + defaults: |
| 26 | + remote: upstream |
27 | 27 |
|
28 |
| -sudo apt-get install --no-install-recommends automake libtool |
| 28 | + remotes: |
| 29 | + - name: upstream |
| 30 | + url-base: https://github.com/zephyrproject-rtos |
| 31 | + - name: soburi # ADD |
| 32 | + url-base: https://github.com/soburi # ADD |
| 33 | + # |
| 34 | + # Please add items below based on alphabetical order |
| 35 | + projects: |
| 36 | + - name: arduino-on-zephyr # ADD |
| 37 | + revision: 9e23502fe34bb1edf524b9177c75cce056e98840 # ADD |
| 38 | + path: modules/lib/arduino-on-zephyr # ADD |
| 39 | + remote: soburi # ADD |
| 40 | + - name: hal_atmel |
| 41 | + revision: 5a44c9d54dffd685fb6664a646922cfe41c5cf8e |
| 42 | + path: modules/hal/atmel |
| 43 | + ........ snip ........ |
| 44 | +``` |
29 | 45 |
|
30 |
| -pip3 install -r <(wget https://raw.githubusercontent.com/zephyrproject-rtos/zephyr/master/scripts/requirements.txt) |
31 |
| -pip3 install west |
| 46 | +And run command in below to fetch modules. |
32 | 47 |
|
33 |
| -wget https://github.com/zephyrproject-rtos/meta-zephyr-sdk/releases/download/0.9.5/zephyr-sdk-0.9.5-setup.run |
34 |
| -chmod +x zephyr-sdk-0.9.5-setup.run |
35 |
| -sudo ./zephyr-sdk-0.9.5-setup.run --target /opt/zephyr-sdk/ -- -y -d /opt/zephyr-sdk/ |
36 | 48 | ```
|
| 49 | +west init -l zephyr |
| 50 | +west update |
| 51 | +``` |
| 52 | + |
| 53 | +See a example in [https://github.com/soburi/zephyr/tree/arduino-example](https://github.com/soburi/zephyr/tree/arduino-api-example) for using this module. |
| 54 | + |
| 55 | +Build environment setup |
| 56 | +---------------------------- |
| 57 | + |
| 58 | +Read [Set Up a Development System](https://docs.zephyrproject.org/latest/getting_started/index.html#set-up-a-development-system) instructions. |
37 | 59 |
|
| 60 | +In summary, |
| 61 | +- Install OS packages and python dependencies |
| 62 | +- Install `zephyr-sdk` |
| 63 | +- Install `west` (Don't forget append `.local/bin` to `PATH`) |
38 | 64 |
|
39 | 65 | Limitations
|
40 | 66 | ===========
|
|
0 commit comments