From dbbda6bdec848bcfd14e2686bfbce0416942bd35 Mon Sep 17 00:00:00 2001 From: dido18 Date: Mon, 10 Nov 2025 15:22:07 +0100 Subject: [PATCH 01/32] docs: update README and add user documentation --- README.md | 63 ++++++++++++-------------------------- docs/CONTRIBUTING.md | 1 + docs/user-documentation.md | 56 +++++++++++++++++++++++++++++++++ 3 files changed, 76 insertions(+), 44 deletions(-) create mode 100644 docs/CONTRIBUTING.md create mode 100644 docs/user-documentation.md diff --git a/README.md b/README.md index d3593b17..b3c0e489 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Arduino App CLI +# arduino-app-cli `arduino-app-cli` is a command line tool and a service running on Arduino UNO Q boards, that: @@ -6,59 +6,34 @@ - provides multiple APIs to perform actions and fetch data, used by the front-end (ArduinoAppsLab) - auto-updates itself and other components -## Environment Variables +[![Test Go status](https://github.com/arduino/arduino-app-cli/actions/workflows/go-test.yml/badge.svg)](https://github.com/arduino/arduino-app-cli/actions/workflows/go-test.yml) -The following environment variables are used to configure `arduino-app-cli`: +## Docs +For guidance on installation and development, see the [User documentation]. -### Application Directories +## Quickstart -- **`ARDUINO_APP_CLI__APPS_DIR`** Path to the directory where Arduino Apps created by the user are stored.\ - **Default:** `/home/arduino/ArduinoApps` +## How to contribute -- **`ARDUINO_APP_CLI__DATA_DIR`** Path to the directory where internal data is stored.\ - **Default:** `/home/arduino/.local/share/arduino-app-cli`\ - This folder contains: - - **`examples/`** default example Apps (_e.g._ `/home/arduino/.local/share/arduino-app-cli/examples`) - - **`assets/`** contains a subfolder for each asset version (_e.g._ `/home/arduino/.local/share/arduino-app-cli/assets/0.4.5`) - - Each asset folder includes: - - `bricks-list.yaml` - - `models-list.yaml` - - **other data** such as `properties.msgpack` containing variable values -- **`ARDUINO_APP_BRICKS__CUSTOM_MODEL_DIR`** Path to the directory where custom models are stored.\ - **Default:** `$HOME/.arduino-bricks/ei-models`\ - (_e.g._ `/home/arduino/.arduino-bricks/ei-models`) ---- +## Security -### Execution Settings +If you think you found a vulnerability or other security-related bug in the Arduino CLI, please read our [security +policy] and report the bug to our Security Team πŸ›‘οΈ Thank you! -- **`ARDUINO_APP_CLI__ALLOW_ROOT`** Allow running `arduino-app-cli` as root.\ - **Default:** `false` **Not recommended to set to true.** +e-mail contact: security@arduino.cc ---- +## License -### External Services +Arduino CLI is licensed under the GPL-3.0 license. -- **`LIBRARIES_API_URL`** URL of the external service used to search libraries.\ - **Default:** `https://api2.arduino.cc/libraries/v1/libraries` +You can be released from the requirements of the above license by purchasing a commercial license. Buying such a license +is mandatory if you want to modify or otherwise use the software for commercial activities involving the Arduino +software without disclosing the source code of your own applications. To purchase a commercial license, send an email to +license@arduino.cc ---- -### Docker Settings - -- **`DOCKER_REGISTRY_BASE`** Docker registry used to pull images.\ - **Default:** `ghcr.io/arduino/` - -- **`DOCKER_PYTHON_BASE_IMAGE`** Tag of the Docker image for the Python runner.\ - **Default:** `app-bricks/python-apps-base:` - -### App folder and persistent data - -When running an app, persistent files will be saved in the `data` folder inside the app folder; other supporting files, including the Python venv are saved in the `.cache` folder inside the app folder. - -### Docker images registry - -Arduino Apps bricks might required a docker image, in that case the orchestrator will pull those from the registry configured with the `DOCKER_REGISTRY_BASE` environment variable. By default this points to an Arduino GitHub Container Registry (ghcr.io/arduino). - -The only image that needs to be referenced directly is the base Python image (`DOCKER_PYTHON_BASE_IMAGE`), all other containers can be downloaded automatically by the orchestrator depending on the bricks specified as dependencies in the app.yml file. +[user documentation]: https://github.com/arduino/arduino-app-cli/docs/user-documentation.md +[how to contribute]: https://arduino.github.io/arduino-app-cli/latest/CONTRIBUTING/ +[security policy]: https://github.com/arduino/arduino-app-cli/security/policy diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 00000000..a16511d2 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1 @@ +## TODO \ No newline at end of file diff --git a/docs/user-documentation.md b/docs/user-documentation.md new file mode 100644 index 00000000..981776b5 --- /dev/null +++ b/docs/user-documentation.md @@ -0,0 +1,56 @@ + +## Environment Variables +The following environment variables are used to configure `arduino-app-cli`: + +### Application Directories + +- **`ARDUINO_APP_CLI__APPS_DIR`** Path to the directory where Arduino Apps created by the user are stored.\ + **Default:** `/home/arduino/ArduinoApps` + +- **`ARDUINO_APP_CLI__DATA_DIR`** Path to the directory where internal data is stored.\ + **Default:** `/home/arduino/.local/share/arduino-app-cli`\ + This folder contains: + - **`examples/`** default example Apps (_e.g._ `/home/arduino/.local/share/arduino-app-cli/examples`) + - **`assets/`** contains a subfolder for each asset version (_e.g._ `/home/arduino/.local/share/arduino-app-cli/assets/0.4.5`) + - Each asset folder includes: + - `bricks-list.yaml` + - `models-list.yaml` + - **other data** such as `properties.msgpack` containing variable values + +- **`ARDUINO_APP_BRICKS__CUSTOM_MODEL_DIR`** Path to the directory where custom models are stored.\ + **Default:** `$HOME/.arduino-bricks/ei-models`\ + (_e.g._ `/home/arduino/.arduino-bricks/ei-models`) + +--- + +### Execution Settings + +- **`ARDUINO_APP_CLI__ALLOW_ROOT`** Allow running `arduino-app-cli` as root.\ + **Default:** `false` **Not recommended to set to true.** + +--- + +### External Services + +- **`LIBRARIES_API_URL`** URL of the external service used to search libraries.\ + **Default:** `https://api2.arduino.cc/libraries/v1/libraries` + +--- + +### Docker Settings + +- **`DOCKER_REGISTRY_BASE`** Docker registry used to pull images.\ + **Default:** `ghcr.io/arduino/` + +- **`DOCKER_PYTHON_BASE_IMAGE`** Tag of the Docker image for the Python runner.\ + **Default:** `app-bricks/python-apps-base:` + +### App folder and persistent data + +When running an app, persistent files will be saved in the `data` folder inside the app folder; other supporting files, including the Python venv are saved in the `.cache` folder inside the app folder. + +### Docker images registry + +Arduino Apps bricks might required a docker image, in that case the orchestrator will pull those from the registry configured with the `DOCKER_REGISTRY_BASE` environment variable. By default this points to an Arduino GitHub Container Registry (ghcr.io/arduino). + +The only image that needs to be referenced directly is the base Python image (`DOCKER_PYTHON_BASE_IMAGE`), all other containers can be downloaded automatically by the orchestrator depending on the bricks specified as dependencies in the app.yml file. From a501b36b8fb05a9c4e98d3faf2110aff01e289a1 Mon Sep 17 00:00:00 2001 From: dido18 Date: Mon, 10 Nov 2025 15:24:03 +0100 Subject: [PATCH 02/32] docs: enhance contribution guidelines in README --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index b3c0e489..41ed8b12 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,16 @@ For guidance on installation and development, see the [User documentation]. ## Quickstart +// TODO ## How to contribute +Contributions are welcome! + +Please read the document [How to contribute] which will show you how to build the source code, run the tests, and +contribute your changes to the project. + +:sparkles: Thanks to all our [contributors]! :sparkles: ## Security @@ -37,3 +44,5 @@ license@arduino.cc [user documentation]: https://github.com/arduino/arduino-app-cli/docs/user-documentation.md [how to contribute]: https://arduino.github.io/arduino-app-cli/latest/CONTRIBUTING/ [security policy]: https://github.com/arduino/arduino-app-cli/security/policy +[contributors]: https://github.com/arduino/arduino-cli/graphs/contributors + From 333ce2f15496abdc00d201f5c9a4b77643c47590 Mon Sep 17 00:00:00 2001 From: dido18 Date: Mon, 10 Nov 2025 15:38:28 +0100 Subject: [PATCH 03/32] docs: tidy up README and user documentation formatting --- README.md | 7 +++---- docs/CONTRIBUTING.md | 2 +- docs/user-documentation.md | 2 +- 3 files changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 41ed8b12..00e520ba 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,11 @@ [![Test Go status](https://github.com/arduino/arduino-app-cli/actions/workflows/go-test.yml/badge.svg)](https://github.com/arduino/arduino-app-cli/actions/workflows/go-test.yml) ## Docs + For guidance on installation and development, see the [User documentation]. ## Quickstart + // TODO ## How to contribute @@ -23,7 +25,6 @@ contribute your changes to the project. :sparkles: Thanks to all our [contributors]! :sparkles: - ## Security If you think you found a vulnerability or other security-related bug in the Arduino CLI, please read our [security @@ -40,9 +41,7 @@ is mandatory if you want to modify or otherwise use the software for commercial software without disclosing the source code of your own applications. To purchase a commercial license, send an email to license@arduino.cc - -[user documentation]: https://github.com/arduino/arduino-app-cli/docs/user-documentation.md +[user documentation]: https://github.com/arduino/arduino-app-cli/docs/user-documentation.md [how to contribute]: https://arduino.github.io/arduino-app-cli/latest/CONTRIBUTING/ [security policy]: https://github.com/arduino/arduino-app-cli/security/policy [contributors]: https://github.com/arduino/arduino-cli/graphs/contributors - diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index a16511d2..802ac1f6 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1 +1 @@ -## TODO \ No newline at end of file +## TODO diff --git a/docs/user-documentation.md b/docs/user-documentation.md index 981776b5..4893aa30 100644 --- a/docs/user-documentation.md +++ b/docs/user-documentation.md @@ -1,5 +1,5 @@ - ## Environment Variables + The following environment variables are used to configure `arduino-app-cli`: ### Application Directories From a1bfdd877fcfc250fd5f2cb4f55a8b37cc7bfa41 Mon Sep 17 00:00:00 2001 From: dido18 Date: Mon, 10 Nov 2025 16:05:07 +0100 Subject: [PATCH 04/32] docs: enhance contributor guide with detailed contribution methods and resources --- docs/CONTRIBUTING.md | 26 ++- docs/contributor-guide/assets/checks.png | Bin 0 -> 40075 bytes docs/contributor-guide/development.md | 26 +++ docs/contributor-guide/issues.md | 33 ++++ docs/contributor-guide/pull-requests.md | 199 +++++++++++++++++++++++ 5 files changed, 283 insertions(+), 1 deletion(-) create mode 100644 docs/contributor-guide/assets/checks.png create mode 100644 docs/contributor-guide/development.md create mode 100644 docs/contributor-guide/issues.md create mode 100644 docs/contributor-guide/pull-requests.md diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 802ac1f6..3066bc78 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1 +1,25 @@ -## TODO + + +# Contributor Guide + +Thanks for your interest in contributing to this project! + +There are several ways you can get involved: + +| Type of contribution | Contribution method | +| ----------------------------------------- | ---------------------------------------------------------------- | +| - Support
- Question
- Discussion | Post on the [**Arduino Forum**][forum] | +| - Bug report
- Feature request | Issue report (see the guide [**here**][issues]) | +| Testing | Beta testing, PR review (see the guide [**here**][beta-testing]) | +| - Bug fix
- Enhancement | Pull request (see the guide [**here**][prs]) | +| Monetary | [Buy official products][store] | + +[forum]: https://forum.arduino.cc +[issues]: contributor-guide/issues.md#issue-report-guide +[beta-testing]: contributor-guide/beta-testing.md#beta-testing-guide +[prs]: contributor-guide/pull-requests.md#pull-request-guide +[store]: https://store.arduino.cc + +## Resources + +- [**Development Guide**](development.md#development-guide) \ No newline at end of file diff --git a/docs/contributor-guide/assets/checks.png b/docs/contributor-guide/assets/checks.png new file mode 100644 index 0000000000000000000000000000000000000000..888e711b4a2ea0c64d0e470aa4997c0c21ecaa59 GIT binary patch literal 40075 zcmZ^q1B@?0xaI#dcWm39JJucBwr$(Cb;q`S$F^~>P=q?4}hq^qmy ze7|$TRB+e; z00BT;h+oNV?IO!n4`*=oJIA`&vlBhbHx(5I^t^J zMpp3o5eDiI5MRqj@c01$RA>RAgNkqpA4Ej?4{1;&%A)(vIu&}T_bVS5gB!Aua zW3fcIAR^{|;4nvjA|hQBgm4hm(IOPe*Tg+|QNvv^se*W9wip5f|A;Uz1_Y2?%pv?J z2w*YF(e8~)Q#D$Ih!YkGNW$N`LI=>s&xi!1LHrdDpn}xnpW}PSY;eNzLJOT?Bj}Bg zeDo;B>|eTQ-2@P&rCx|}bc_@M5cro>$eo`*k6kS0rw0DtZ>j5kTTgv_^Fj(ji}p8c zL{;nqXBvKeQ=(OhFeL(%gy_!rP-1<`{$r<9u`00w_0D&6c{*z4)AaZ0F5=QI$=?1* zA&9X$L$z|GFg4K~C<5=eLqA-z2&F33VGdU~pK;^oqV!ikxqAo@KY$+q0tCV@9{$zj zT-?5_cv@z_9~q{#yy+8j%$`ktBg?UXjtG0Z6)O7o zuJ>KzGtH)TBQFYo5-2PxxEAe(TV(MjTQ%PFZdzsy{`fe)PX+z6w{@4?zWE-0wi3jOw;5zNGK2tdT-rsPCnhnN99|z!*LK;lTGt zdx+F#<0FM12+wd*C>I^U33)ogVTfktF!2)hF@UW6XxyLPX-RW?nzZe}T?N?Bx)RD& zm;eRzxinUroA9HT!XM$E2ilqyOBBC$iihF*$+FvnEn zkzDMgKsv6pmPdkFgP&hQ;wv%ypFNhsyfIDZ~HbYeNs&|Mej+{U|WOk|x^P1DXJ zz$|gt>>K~sm(y^DH(YH2*b(RwGc_&rOg#iKaiTwi0Qez5i?mr0u%4nz6%C)T0e=2;`c*n&0w2fhdr#bs{jB~ z*AWe_BG%PrviQg*ExE)T2S=a)GK|xDNUpqW7FqK+NGFOp78LBW*qAqv>}c30;k7oy zE(!ny4l?#dv=baXqDta;3M7v}4nFEtDi!Yr#sQxh@AVmEJ|$Uocfv7nT=Z~fxC-N0 zJ~-_|Jf^6fs3F@?v~okJNBIUzfmWNkg74by%`7Ua4i>=y6ibsRSjHwk^Dt6_Az6SW z$0gVPUSm&(_e6#nskZc0+pOB8dJb>jpA^pz`L_ki999%IFEWEgBJdbC>(Ab|uGErE z-^#ILjOa#JAzr3&-`+1puIW&s+SoPtiKrFt&{)}v%L0Wmk|~_aE8KV0^ejYdjHCYD zNU-(#=f9_4>-JSg{jdn-^O996QoX+jdfdT%p5GCOku!-SShfqbu47#eQMg?+8$4v! zdBNwuY?pS3>D0bn>IxlAzlSWOBI$LiUa=#yc)b;#=gzU-Zjfu!CU9s zgLnk>^k_A8j=G*f>WfG9`^I4jM5DbExu{DT<5aZIs|X z4SNv6}WGH zxv1>)Vxk$L{5}jOfW;%f{0RGO1c@m!miRt~o1fnnZ)=pxMwiX5e#EM(t3?yY7h0B4 z`JA>+?*7oV;Qy1hiR+Aw3aXG_6gx{Ums5NAt!Ci;smk_x^2NWNlf$~{8fr1bY%X&& zbDeFBGc`WOh-Iv;ic2W<2e4Q-EM^Wn}UvfJ|k=cD}Q*m?3h#1QEKhKkSfYDbW0o-c9 z7jFM1l1NL$*DTF%V#}L@N#sF@$&&&DAY>r8Xl{BOHbJcy5FgAFr^=}v z-S9mfnU#ad26X@BLc~`Rj8QrT`{?!vM>IllC zU6K~cBc^~kAR9F5JP&Wa)IhaAHprrs7HPPJq(sS;&%#qJGJBwj8Qu;TlRBtLu9#FO zsp(0GzVq%E>i~N17@ThPR;}FukEJq|V&b+ly_Us?US!oZXES6z?ksox+cQ@eb&o!C z$&2OTvpr zhe3GiaRzGgg6gXqc-CgHsqF4O$@@T8N{N!Fk4MsZ@8)_q)rN}aI-romxy=@Z^fZ^l zU@qFi^R|F+eai_*}AXM{b%A0i(=7~U}j`I9G=H)hD zQa4Q^a9R6@kP#asTIL`wa(_%~IoL7zFBcj>+hF#KipQ=A_gHrS3xf(D0PGDQ?*Z>(Y&lWD7?QfdU3AT zrbUWI1d-WMeS*XDevoe&YJVe|Rb!JlXBn#?J6rW^dDrAkTe&AsKt{&@EW4ETg=b;5 zM4O(k)?|2DFG)juFCvpEk^b4@M8u!Z{|V8s^-}wq-zJrjMX;sDdtFm;I zk~kl^OZ>485pud*GrIbQm4@<7ITyR~Zm||pU2%tHRc?g`_mvU;?`u}^Q2K!!LOj+b zyBv4tt8;u-U-NKPqq%uZ+xG5241`%$GD5EdEn;oN#*^ju|DlqYCrvYyQllw zT?He*PfJN*@svnD+?~#DkG}M_l}zEJ zw)j%u{&-I4DNM9^WSq=zZLm&+4t^B_Nf>7+%KVoqcehUkbbNKa<6LS>(g!iS6*6yK z#oaEu+2)okE4s+UPOcx0hx-y3*@i0=BUg@On;;Ef5NiUk^F7TK00 zr_2^mN_l6BKY1G>tRd1juRc3j{Y`#iqroE^3JQnH67L#^bfXXx*h894hJomuh+1b$zNov zq^VNu;BvvWBy}2Zl9KlJ7H-~J=lxz`y3w$q?TbbIY9%V{Uc$-K?6ynt+EtY#PbxJ= zS58+0qd(-_OeY64z{Rb6DVJWe(tQ09m7(HxHZ26vx(SKoDJ`8aocWi+ZZu4;OkqQ>SA&Azah zE|t-F?PIiz!mnpg=K3plm9P*sg(f?bdBNdpWtEnQ$NROia%sQh{PHS5z2d$|a2<|C zjQKWFMaoe%hhzOpJm*gZ-`R$DQ`+M3MzhzL>g=7agcw=ToZ^A7`&gZUIzL=m=8JeD zJfM?i6Y{lnu&}v~u2PbQLULTK)gs`|zg`vJ4(n*E*~P|F5LS9$5uL{OrU?_bq&)O3 zz2L1(x7}ENs&MbrJdH|KCn^}bQYFbLzi9u!KKOatGc^4Q^WUpgXI5FgZI`hR|KVuD zte)NgqV~V97)lFUWy2g#qaL+}2Ig>HuPK*#+~!SYx{ACGD0H`ser&Tc*VBng&jtM5 zjV3(iqKhwO_T$*a=O)z{vAXMSZ$eD_cOt`1c%B^$viM@UsU$phUWak(=E>QZ?1pg) z&3bZ#va7q(!dd;$SUhVkR*G)Jek_Mv?jE7F_BYWs?L59%>xIZ5b{s(TP=nB9w2}l2bTr>w03tqhJ{&-27ZSt_pE1AQCCy1ZOePMvI)-t3_VaRao^e3Y4$dHTfb$H( zE#xWZO0#}9hVn>EQ+8l$UJw6vE_>=~*RNz*GRUJ``wSLaB`)i+e>ZGWa9XP&;JTVo zTH9gz5_)K9Mn7?ARnfND-CWjm*{)~)TwX%GJ#Z?Ar!&{=ETD{%uYT=g&J)d4N!c~V zSUci2Fzd64U)QQ-^~x2D8;R%aF20PFHWlYSM$bOD$Q?5hZ8DjyVl7|%*-8zi)EtMi zgdafIZgkptZqmTgESUQ&rhOB_X``!?Y;IZRWDbSbVX2)?)NyP!dXLegSGSisyC(-i99+yqBx`@3eBD3&CfFXP`cEk&1n6f|@mPwEZ+DW)9Y47R z{XT^`a~V&0iYbdZ0AqRQrq&z3!?8^_ngI_!1EHq((4pR7kCs~9A^MoXAA+s#yR0uUGgkTPQI z&@s%Ds-kdK#l^x$c0NKi#0V8BL&K604II_j!jZtT;}T`(WztsryzwfgkPbpPF+?Rv zeDtrmLAA5Vyc_xOl;TI8IOT9T??hXNf_-YOT=h&qT2PkHo%C(_QT76YBqZx>wrAe4 zS@9~dNfXo6jWOG|eV?Tg9IxW*h6FuXaVx(9t`5KG@TVr>7F!pE>*uL4)SQS-!Esj; zL9}RXGxu<0;^qN!}WqEe>66MadWS-(-F&-U(J9cQvk3vBj2Ndh`` zIgiU2?(al%T5iTho~gf4lR0U!e;MPiEO}NoQbwGaVfm(vAY&dMpB-jhSgpZQOR>vX zXvA~4DEljw&S9qRJChb+>rl+i1&%I!<32|WtbMOE>pIZ9EwW%GyldL z{*#&fBM(&-5|)?EdN~H_cp!!i$WtoGps_Eik75+4QH14Ok9mGeu1ei-d_diAJ9U87 zFbY1skD!n+N#>XW03e(|Mzfi;**rW};8#5WFtV!1!yX;uD$=LyZ*@M_m_XbBzdek; zpiTdiLBh?!fWAeItnEML<1~_T7o5x8PI1ZA=`a8M1`uux+K)gGnEKsU>dLX;!Iv51Y((hj`q3{VxqoEk_{ua#Br)|i%LO+M|d4kS9J|* zd@6(I(m{gg8d!TSxtMG5G_fRQdLpW*eBzYV zUxm8~6l+68)4$7;*@^_cg&L@(dvnniP{bs^JLO9f&tOE-f(S_FUMi&`@T{>T&Sw0W z&Eu7$fe0}8%cDh#w6cu~u{7H*uKc#*OP9yYq~fx&NJ!}=s-q;uSi}OQaX$zlhQM>LqJIA!1f5D^LvMZz`t%wXKt73WwGLw^Sv zsEJX{t{l#t!*t{2lF?b$)~QaA>*DvK!IG4UnbRAg8dVD7(<+N+w_>{VL#1+3GqZ=H zo1VaL`!1{$GyVGj2p}n?6bti~kx3KT`f>;md)Ka%#Rr))7kYNK!hLIq#jpG^# z_mR~lp2JX>Qw1D=gri>X90wAT5_5G_e3a5e+*7lefb{_VaNOW2+24<5@?tM`e`Bl3iu6QnB z=dyHTJ$$P+|3#4;13GGnaPbv_O`?gLwLB1hcfs`qLB7z-M` zQgSw&&h>52{_>|g_FHHirn9?@s5b`AA(4P=2#oLOeYuse8rPmt;PU1HOyvdNPq4Iq z%hThJPK8`mvYXae%m*!jW_yDiDLu2fqpPI z*XTN_OaK7@`MwS6&*l?Rr|$20hIM2@PfsD~@#MUahN11(?}w7Ue2UY-jLRrUh;oaK zz7fH+AO2mCjD+7AX7*ZxJ(c|knRW*&nfQz43qochqoCb1rqY-m3fN2m^|^X(gpII! zI|t(3;ezR-`VEYyZ^ia1|9A!=J&Cb}u;O>-k26a*|8 z*M|^ERzBmGAhK8pgR14DQbULU0$@9)sA1SeM2{{PSJ3MO5~>*nu2yUQkr81=xJULg zjKt!E2)8qrHgM!KPS98PkYL2LU2=*C<|a(en4J? z?hnU9>Hgt(|2c;K7u;JWUS3-qrne%Ih&29zWT3$&?5icnyp#WS&7`RLe+F9l3+9ue zhEHo066;e~n3q2yi2cO>)!F~_^*^A{YxQMf>eAGG3i*DJO$5~>2?DYZByJoC8GZy6 z@l_$R+n{0hhR=P_ERgfe^TcQeEd_7ZeD*@>VrWq;Q<&QL=ec<=)`Y|O7CPMATDXU_ z7r;Agy?=;SL|%?mo@V5|9-%&#GWcnc$2Eiw#+i<;Z{fenKj=ci$LJ`1i2?v$fOdE6 z`>}I`=r2_p+1&nF9!@&1I#<7YYVL*UftMO9YXrBDCRkzXD=O%y=z$Os_a~~)-_B$c zA}6&-JApjOhe4g>T2nV}*7mS&6&Xa!GQBJ(>^`&?mv9#quQTuYYDYJ4?fd&fODyjq zo&wAMFM(1ovMe>KYZ(BJpRv{~k&kzh(y>YBM zm~I!bg4bDkL^-uLCtu}FHQc!Qyz+HgBb(p%wy`cE-F1(g3eNvNJ!74(*~Ycy4W8Pb za=1|c`6lVw{f1d!I|mz*An-6~r}87DIy!@`vj?3;9KwD{wHOk@_$j#wRBldtkK91O ztqX&{$Ez14`(-lMyn3o4D$ zhzo#TsJp%UPiC27?L!pjq!8&57IfkG_ZP;n)irw`Bo}}JVs$#AyNMtVMVNL00|hjG zz(gigF7NR`7||TRv{>t>a5$X zT4gAb{l(2`4(WS_fzKvqNU0z$>5pe$kHxiU@y^SYM1+Pg7~L)r5< zpmrF`oQLH>rs}rcRYdjzCi9$6p=4;gK3Ty4u(SCYunHZ+{@-4J^`smJ)w26Z(}0hM zM9+vzy6%AF%{(Qz*skW3M$t0mW_6PRPo05moc z0L*vG>0m?5fbJ07B6Z)6&My_E6WsnGVck*m2iCgTIBW@{JTJOzGbCJOFiD$c^ zHlD##dJFbFFu03HENdX`{UxV45T_WpV2h>J(35a@ zgJWjmMx?7svK=9f!GC6sS7X+B9g%XU5K?skf5x#xky)mZO1R*;)@GMYNg#ObX#ZS{ zIm*lRzPN`iyFXHk{Fz^XS2ES*QrB~;eJx|2!h`a3u6shUat2!PCmy-(-Ii-|p4rWJ zh^ke;_V5?ZyB}GUHSA8FZH2t!#5^4rLdtD3@i)I>XU}qvjs_pLQnIuWw@0lD$OA*J zy|p76;X2$O`skDJ-Jj%bb2e_WY|l)L^eFtQLW>+0sY>3ypJZ!to-RE5H>EJUzX3-) zOfNplJ2S<3%N2>(S4`D8qGNUdJ&`rA>`fB&HZW}VW4CsluNhWn=zBSJ*}pmSN#bBn6FdPO0)3OUD7S|?0cv7)2pXcZT+t!!IK@l^(LRk&u1z{ z@BZn_m}u9`*A>2unmWPGvp+btwbmSnj!!TjUvy$u4*RUj_s-YwHr8^qEpbxyzps7O zvhuJZk*nGFR@TZsu9_R`6%aWvEG~B0baqbcETM4^1CsC`K0m|Gl0Boalj93*Z@#mk z?#qhtc}gk&36(!ZUDTgZ%%J7ASLG4s)&9dP{3&l8t9o zQHT?uRnt>X6uz$!Rnr6P3O;xFV@o{&06rUya^C}+dtz5h)3TxSU;PdmlyHDT5Cou) z%o*EAl_x%}t|$!rWAG_e@M-5cRc|V%k#R~T3cb`!0Yngn3i>js-^7Gihr~cfTAEQ3 z%0qozRRchBtvJXaghJ4_P{4wv<4fuhObhOq3aFrfuI}&XQ8n|d1QKaV zrIgalZuha}Jzys;XCiAx%&R6AW;-Sm%GMh(LvHMx0>2nJZC$hFKkxVN;)=iRr~xA; zDe)xOTxyd~&2BngENaMw)WBLCn*N2wQ*#H#<|aq>TXAZ#$d?l{+icQV+~UoJ1ZxVC zSvW)lVr>(ei>s`EN1X*v9q`K1aG>M$)J-~htC;!BEh5|BL$IR8YY^2wX-{Z+SJ&)XDu-f;I`ekzt2+l&;UG%2d6-81$`agw zo{%vT0AN)4hX}&|S5&8FYOX@17&Gw|xutxfAjusxH+<0m3KXl;e0XAyJ+Lpsl^S&! ziDqnF{eD*?1SnQQIdJx8S90<{DtJ*g{v7~c?U%~aO7Cp_Yq2<3|8jR8UghQc;Cc3j zm18v!fIgT%Ex@gbnQFN@enYQY<=VCgb4zno%ko*?^i-RCMS*3K>(RVX^YN z7pzQ*j~Tw`?tFdSrA7*Ba{zJ9UY(-FU0Lw_veVBhm?zKc6TvO%^74PqDz`)BS{@=A&4dSpf6`LE?@1pbfBsHzfqipa!^5|AYBm3?4 zn(G?6hD&+9`J(|kdR@Fo=8amyo0aW0A3L1L`gD9RwazEn?RnqJ7ZuRtc*8bZRDfKt zqq2$Xvu*Z)ubrdbvJK%xei74Q@-1>SLbw(W`TW;2nzBcoP#V)mp!ZNsNr0AZmu>lF zEBU7fv4&cDo&M;cR5^OhbEc2Qj%areEY@MxwoE#z?<1bVozZ-ibYSwq6>*sMM}e=l~FE3-`e@Q)Wq$FZD9pg&%Xl#P>|a9)`nO}QvfickpKiR2Ppj@ zhS}88X&BKx4vMrauZbvt9_C&E#(t^2svpiT0D)W<7@)_jh_(%anap8K4TlsAkV~!% z&?AZentZw_0Ko|#>XUyfh`C)`b3Un!@Qr%>@Rh%tsY)B?Jp=Z&U3u`@Hvz~Y-IbVp znwe}IP-Rj8j|0&G0st|D5DurnmT8NT+?0atg@*zT?aG){#{Rrr(cQEWW)S!cNkrj^FcR)af zf!u!X!1)CN#E-y+<_3Tfq*u~Y=c~O{<0AjZMKGe~GlaaW27u{B*kR}A8@lM|sUwIg z0oV~5vN3GUL3Q*v0QOHIKGd2Rc3z>M2Z4rv1rUJ11rXTbKo|!5>9~yd1$__%^w_1` z4b=h%5K=f0asVO#1P~z*)S-H8Vf+4cD73MNu9qy_<1@H=@v{4D8}w^0GT+| zI`PbklI1)&mArbKTyi`-9Qg~X*aQR+F}nBIAid%6-Wc$HdTd%nrgrL35dPYKj9%oZ zLHcR0_*{@TF^Z)=1kEENC!(jT`_8FmsX3``u#|!N(a~P|1G2dC#T=ypDF$}hO zoM+heAINdL3xc5MDJ2skLZ)$HBPj*z@Bl`wxBk&*9+q=a;Sg$^&bbm&{&4oCGT)5v z$ajZjZN=BxtD$7V=^{*i)$>)~j+WZCb?@7Z8?ouQu_wNL|CHFLwe)FK=hm-J&gW=m zJoXv3S@~W3GYfo&Z*mv(o7tXfR$ZU(p4XWm^wOy8^;iDEP*v{Nn2t9a*&D+Te8)0BY%Umci8ZQ*1UaxvitqaQlXUzo?jX$7&@e7V*O$z{|N`E3+&hL+jS5wZNyS5mhsT?MTBd%7% z9Aax5kq(>6Jg63t4MhG5Rs*ZBzvUzlm#}vhEW+=d1ziY53u(-W>n6~5rCVlXD}I}( zBuQ9-B6yD+7yhXlw(IjQw9NqI>g5XyBM*7J)Gnl9Q;6xRcX`^`CYjBv%wKs9o>#$W(Fo6jEtSD`v@NI4iZPi_< z9cJIpc6gcVc3&K2m?+_J6OBC9&Tf_N&e8Tit#M3PbT*XtuD|zoVHpZ&(H3Erv!STA zaVXDu?$|jU*0mUN#v+=aMwUo1wZXB1FoO{?D4f}HT@1nU%NkwPiJQi%mOg}_gg4Z@ zIkB1{AtN_7Y+gRDg?PTNcTm}6V4qal#-@=~XF7l5%4uss2Xpp}*3Feb)=+ z(~OA2rr%Hg_O_At8qQ@pd4>)+>NkuruQ#2Tn7i<_v~&&ROx9^@V%8TM{-gDhCN(C5 zUy6UA6g5vu5gt%C3N4uc*ZHiX>njNpuR{A9GU{Y%IaX6!S5(-Q-o^n=dCQZ5r|7_4 zqL>N0P!Ks3ED+ahEvkqK$sg`&W3}FE6Nx6cSMIRD`(uJKUeEX3uR<(9uVVqhRt{za z=yu;8GF(I{jR_?!Q6J0dUgxp6z5Q*@bRr|O7!hPUj$<>kC{n8WO?y&Mx}+V{oXFpv z#yd+xDgBT4RiaZB!3%t1d(%Z_+jCw<6$UroO^bx}62-t8_1$aq>vsXj+H~ecs9R*V z5U<4#cTSWF$;B87Dgb1z+xKo#44ggTLsCksWElvU1;vZYqeKqn2LKR5=Xsy7k;}}@ z&d&}!0)pqy~3@K8YX*lE$A7y^2j7-Z>5Ahf6j=4bur`tG;{ z?^8ueWE;q&G`kqdNqt7=)WfZ|s~t4oq6SIbl@_;0EC2g0X>kxy#`|9lDhR)F+s6f5dHaVNoGCZp&h`KIh{sv$+cN!XGoUy zBj_7ZWwH0=d2T~FKZ91}u?`>Ca`wlxPt+Xp)qm4`j_G)|s6gH{qZWbOI9*LJBJ0`JHx*jJ7(k;`oE2c=jq>oUKS8O&cy8xlH%w>x-ee$;8S$%`j!gD1t0?e z5PpD>!`WdT*%vp;o}#~ouibzBYvud^L=b&JQd&{)0d~9j`x#(6g3B22#1MUIvs#Zf zLS1(sqDxP{OVS7q(b=Ct1p66!}R(So~Y!--tn_Y%6|ZL ze>bY?`dlumwzsvZJYjNYs2$?NH=QG@L>Eb@XF0Ohb<|(9=oiu+)GkJ_j|W)gI-ORIx-Q<^^^_iXZdFQaM4##L=_c(B{#)U4oDSu%a8n-oYc$`x?aD)!7^P^{Q*T-Z>#r0FVox5%Z1^2D}JkO{eF^o0W zjyksp_LRj%GgBJAu^H`MZJ$@JO*hu5 z-}h@0$tu5T^{U^tTY=d9;&Iu zeTkyPgqDiqkEYGT^Z-!SDe0=!E>jE;o@%4V2PK#ub`)Ao@9St%NH)UomG&mDf8%tL zx}N=eAZ4!4$;3b?^~L1yuAz3-p^;RR!|k!nA}SkR38;>ED~%P4;+0+ZODnHc*xMXO z&zy}{S2U*JeNolS%J~Tr*s(Ym2CY}gU2`nWvXaTJN_Z>E=i?GWsAbT{N9jXjN)W4X zxOiG0g8eJq4Yqpgo}4&lXVFDHA(@`6ohXTiTa6B6Q=qXI8yjc~l{)o|>NJ@v^_O0< zZntmkLmErPhU=Y6>h*On0QxzlS&VramEf2zPXuN+=M>+~%k#dYj&@Jny3L7;?!E&Mw%klS4uT1_yY8|%j{S(Cd56!6ECT<%4 zb+kmM?4N*$mF;Lm#`s*Kv*{CFB^G5CQ-%KeIQd3e-L(%D;mp70A}8;>qu;Q2qUU>e zwpywJ09(s4E@j?aDM}5UV|XclZV`bsjDgzBlg5QOJ0oIjPxWV`*ipXR+CK$his zJ#d`ncKvv<4;Hwsvh|MKZwUv7g3`ZE{?+;H{W+B%HPBKxLGlX|R#*!`*Tku#;gi|2 z=41T)F;bPzcJ*PeY)w(NyTf&C43?=Ll?xu>zT+ttoy|LbZ;um1J~N(@*@Auew&3zO zwyEB=hGz36_Sjib1tlo9!)}PzRYU%0q3FjXouiY;<2?FCsgk!lA>Lm9zS@1AQ|BQ4 zaHILosRcVM^E3{nDkItY*P`_Fqpb6NI*P3=`@R2s2(x)=VLiv)UNp-7dR;Y6t;s23 zqU&DC`t2b8Zu#q)IzhRxq4TZxwUkdr(``JxV+5Kmhgmv3J2T7m9`^ibGABMsvCYCh zyLsPAySt?RNN=#zYLR)dg6`__jO+R0sCbd;c%@=`;mMOOd5UlT)y{)I83_nLyZ3g? zH2v3o+(tch&|wDxwnR32v)fcMcv7?L)OOP7G~Veg$JUm!>(-WhBl)p;D_0N$;FEj1 zBN-aPh%}T%T}9I=o~8~FBx}2FS-`k_Wbf;3zkMRM9G=c2liNNf`|MF|6Z0$3*%OIAk<2l`iph0GJ2D__jJ8JD5D0Zx%C5fQ^jaA37g0K`+62x

W`+0NwJpCYq|gkp3MnG?=k~g0**X^r20} z6AbHpeaol+7@93Ay2?#rv_T3Pn0~M7yoUWMt>f)U9C-_ROY`<+UpC+2JOteFGxVv* zl#Gg9Q_@+M{231Q-poXV)B}mUh_N*>-!4r{WETQ3V1>J=&3&P1J4bsx0YMX|aBD7( zbYV~sLb(W5FF)K0W}W!>6~LBOjKHmc3z)%Vh7^J2@WXIkEu#!4bCy3{VD`2YIPpq+ zY9Ak;c4BT4Sp|uT*GCH1A~ZEdiYGB<+!GjE%X~;oL?J@q=2#gjpDQ6J|M8h99h0d= zuN_@c&R^kNlZ03WGTd(}DmJ2^*_g*Np_vqsrb;2U&!1MG+7R*BCFK2O?lhoayIwaA zNBgO74!9d#&nm-n+a$*5GWQKrU;+UY0?P$f z3r;KroL)+71mf2JhR5*6Vwr9!mn5sYd!T`*pIMq88`pF^izW|yjFT_emzH>WzrSdn zHznhOP?APT%!G;w`fXysd#W86%CwCCWEeR_;GL}byk(9bNq1>1Dcxd{(WIHp+!E^6 zoY|ZcLx^nRx%E(9w@ZtMoxveVq88sff67er*xu{7ZHSNfJ}&u|B_&1xDZ}CH zNvtb8CNbG?+TIXa3nja?o^OAn30Z()jQblS*V*pdVI<+u)> zMKRe$f`EH5`en_Y0RT51GFGe~3@a)cUxBSf|1NO7Jio?e@TM{Jf-Oyw$Ug+9>byc$ zkp|&?Th1IvF;~AA7|!Zr-871gcGmQHxv@H=W$qDF!e^n;<)X3}6MY}?rCTQf3?TWt zMFGth#GSpxpE0l~mQIaDiiLNDdD_Ulc4>_Nd4dQ6q!pKqdfim%X;(dny=Srgu4$+( zt0L1f59TLH0dskAbsTywDu`w&;_#u@7YM)6BkY9|le*+Z^ZFCKOLX0$A^mirn}pP& z#!C1-8|$W?AYdpaDT&zU?Ws|4ZlkVTYrNc8&K5#MQU)Ij^TK!D$bPxMXX>>H`|E&) zm2UfeDUQmLa`?~E5?M(R^8=fSarv~pP#wAC6{R8o5HtkV z?euthv&V8254Db39X4T*Mat80sr8RS{Qb0=W2>6yZiHCXBTAiCq<$e3?z0nYtE#;N z|04YT^1D2l#;NlonQwmXBXd0SCT?Wj_sx)>pWnlyO{eDi^77H6lOm$HsOa-$m{+I4 zY_>NLoYi*gqx1Tkx9Cow8@d-peZJ19AQT?g_T=#}Nh)5XVCaGi7B4dYY;>@mQK^8_ z1@9!1(sVLYyU?)7c5`>R&{*RD#-_!7vg2vZLs}yyT?i!RcK9#lt2$c*0D$|1ymqj_ zrfA}_(Hh7p!`yaPjFukF;d>q~!=vvZuW=sUnc2t}33;1vG%02LbhV;*Eg%6kuco{5 zH_J3JHbrygdY-IAvr!>&0qy8i_R_68P}+T`DMV#`_rJXWMHZ0Pus4{m>wUEmg}ukFWWCLkRqa+l4NhSw9E=k&9p9Z zSN5r9KYLDNijXvw!m3(nytZnm{SThbIXJQ|?DieonfQ$+6Wh*AoQZAQwr$%J+fK)} zZQFKkfA_m}|Lf{Lr)pOp?7g1fTF<8QoejXfYX5wvexHYrFv=1DB@oh6>=qd_lC64B z;~1~XuXY-}ychEtV9}~^;(hkN@b@OemHypY`8HBg{UWK6qk4G^Z?hmP{yWiNG4!6L z#X1m|lBHxQsMFQyu-w&9b+*tU;z;hAwYGc`e;1!q)?kyCV9MpK$C0d+lz_@%`9!MN z>U>@u$j?loJq$|pIF`iuT(`GLs8}A4cK*?}_;~kKpMp@gTzq5t7`2@qcsujNtir?Ef!}lOEZ(Q_)9x7N4V*1H-m=Jcvhw^0r30F z8vi}L-hVG3%j~IWMWy&gZHzxmzShLQm*PYNjmqF_4H%`A5dzCrPzBN;4!GzAgNi>sh(!N-QQ z*3O?%$!@*o=-!ZkJu-a5s~5EJM7gS5zqTvTJsl*JHAE01-7O>o2Yd+OSy?HxTAW^( zcTbu~N=p2dk=bf6js05`Kzy=lnu`PpE*49u-R;vkf9iG93xki35A=Lb{`;#F$+MGg zBN0j2P_V4KzR_b>*0-B6Lh?;pEH+oW(O5Mp&6xp)IQR7!Ii;x`fC?>At=_3I)H&Hzu>7>AtF!WX5ecVomAZM+7?stv&|NbmyB=t%1KiAWBv4LTXO%~;Ckow!b?w6TYEF+KOUEhmD!DrkGpXO z2mrlyJLtWTulxPB41-KCGCt1ZTpTua-`4B%5tEXkQH3yI^5cLa$mhNSZ0VT&C0q>{=g_HB!n-3gftl&&J+AuIxVY;iZuC*y$~zWqh0n)3L7|S zFvlh?bk7Gh91bLSO^3Zpp7S&}GwV`(`M}{jF3HQwi_Q%R31Roa%OGOe7EC~qNbu>7 z?YUi*2u1}U29568ogfN;ek;E9l(#({Oh9?Q>ZEER(r0dHsL$~_D~rx-xp990^Jirh zpxvjCs6Y64{eGMNo;iQ4tEYLhoZ8`myYlD>X#`wNk50(d2V1vPV4sp00hqOR4IPX zKR1K=X8jO;Yb6A%+(b=mJey2iKYDC?KL6LL(+#>s5)u+Pw%qo6VTd-`9FJ*gIuuk? znq4k63T9unfY+Sb)tO(jmF5CBy*aAiU$cI*N)OAbnH1f>nYJps9+pCn!_^f=e3l<> zy=#_Zb(Ax&ssw=7TK82yIzHz^zn&aoA48@etdDiMHZWV)0|9dDZqmxwf4~7Z&9YnE zn+62dwA3~^WVWn_{zoC<>V3ETCDrZK7~P#Q&6XXnhbS@sbS86BzpI_MEoG%&H1Y5* z_`S+os;&E+f#bXykLfI?vOiQcu0%v}!rv|EF`X-#zRt%M4&m}l7^cSCphm=KPJ>0C{j6==5a3lF~0&){?~E( zfzPeF#_~W6M7WW1|F-6rz`N-95)ho9oQTVUY%spQ5)u;b?rjQXg_L6!P2Aa2&)dGf z$5YwV$z#VtU@uw?>8z}|uepjD)|$%)b$n?80DyV+2_636+`U8pF9M*=KkMH$VbfC) z@xW-qs_ejznMOHKOC83NJjack^z?}kup>5ArR1;&wA1eV8 zf4ERyc0-vgv(|!jkw1v5Q2{t?8;esh;wdjk(wm7%i^#uW|A|N1)E2mEp{8e`{lv#1 z92J*siE-kAyp^|l56edPjFy3(<}{8Nors0o)4iYY_g}lmyB!*A;H{!0CCUEPB>QxJ zQP^LIJ$y9efOOsUY=6N0-EVmu8o}k)r@_x-KI*nogg?XMzs?#SWPC6{!^-!W5X6dm zadFNe25Yk$T?$yL!MkD7k}_8a7+LLQu259wwr2IL~9ADKQte@a<$Arix#Wa<9i9j0;lGBB?%d|Oxz(&eW$+2&P3Ej>4o z9-fQVbOTFVhp}R(6GEpJl)J>l!lH6M6ANu*mvHkk;52O&vPSY7XtXN!bkJKMgNqE0 zjB9($;IHB%Dzt63eb@Dm`@2F% z!T2eSb1^pmk`&m-f-QQ4^!O3O%-O^y8R3B`B(Tju&R)|A=>x_zJIYKZFaV%OUwC~8 zf@C-Ap%&P(#*HHXS(^X;L#Qavs)9>_?OaO?_PEC?}I9__lPE7ZK- zg%Q~T__$p6e%*e>J`*nF)8@{fAOKKrba@~C1P+1u5)uqDgc&)ZNOMi{El#Dql7NE) zx+eqbh>wSDeM+BkrZ2x+*^NEBz?(gzw2{4tlmNl1b|?_{8@nhsex0P zLZEAJ+-*4y~wen>SZVVO(M1VGfpnhh!Rb3ntOHq+{PtP!{+6AHgdLU_~lyJOus- zPK!I%e9l|u5&=uTiVax+@>VTQ7*K#EFe*6l*(^h+ufn70%$XK{Rqaye9v0^L-22VP z^7U5NJXQ9Up1WNwFvC~%HNUn^{lak`!JIxZ7>Nzksy;ij2q3<(WMySdlPV5IuvNMH z2Rm_L5JFuoK&nVgtJYz)nt<5w$MmG4Qso@Tt)$_sY%J2r)w&Z;H=crd1dsO5vQy4H z!rjh$>v0fFoRxu2V{uDfrA)JhHWz==*$mYu~IrO^o%(Z4^Lt&2l*{Fa@9!cV(? z^U_c95(YM4tJ&Z*+hGOhaZ`n0G3gCClvF*UV(UNpkjob;Y92Pe3Ht&Iq@gB32gCvO zb`yReRQB(`uD04nibNZm8J6+%5wH$uh_w~7+gmyn`HIbJ+7^x_+ib_r4uj#os_(G!z<=eW{GN%>j8!BRB;GlF7jljN|`lR`<#VOZRD^NIDe z3QFYXp!>-~p~G$f*7iC|rH&vtvum>X@Z0zLWh4#PRP631g`Y2R5Gf+rjHjK~k0K>B zXrxg8&mO~BYUM;nWn&>1X$-{suzUQr{Ps$=TpWW@KOmqWDPi_c^mQ&@$K`pj|8H9Q z8B4A9(cjA0DrG_v$U^i%82xFaxRw?h^L)~6wd%0|5(l_NzJLHGzVRZX`5no7*@<=*U5E03^77<`TH6R{vzeme%YTSJuy5EmWIKh5-4j z{$Q}69!7wl@F#(Yk`wKI?{LeVi$F~Jx(*))zwxsJ1f^)e%*7ycM@yM(3l+oJJ+O!_ zP4!{y53~LhJls72U}dBTTi`$6qml~l3gpQbeb^8Hz$(wk@sF3Xy3od7xT_ibOPNj= zJU>*4xVbq2lly~nBzE_c04|c-X#ybV&uU8Cbhe27o`p?^*Gd+%e-%ij?!{k+c2NDs zY%h3!L?go@Rp+%sj0ya=(&DIK}KfAi3%n35T{P=1Np+@)M&Tb98K-)ZbnAJ zhWFcU5gg!MKD=`DjJCJ8z4ikQHBf#b!yPf{lZzE9iM!1ra1?tWcRWwUkMl(w46ZA# zUUxpVfRF^HCJs8`^G>yM=i(0xdXSftWo3+*OOddfnuCnT6)lwpF5T=xltS(9i2_V)Z+I)XoCw6}fXe?dChu54U zEXDa_C{zfWNt7Sg$H*gIrsuttz(}h~&54*s6TM!~e)S@D?d4QFL?gZ4{M+pzu#*oO z#Sg&1$;UC)^lb(wghqOJqiVZSTEX*l^e!f*{WY6X&+$y4XhJU;4XY7{>Hap5ZeQS? z1tubCo96)+@Beia0TC*bWa%E6P&hVnQyt-`tgQ%6qMDONw5v+Q?a-`vuG7v~(R9(! zU&7!SIJdXjzE3etNM-G;iI_@{nO(kUQY5j+mK-Xpq+ma)fINW#t5;0P2F>q$(E3+4 z%*`t1_dw^9n-pR0w0<2FDRLqhaTr7EpLL>L_+YIdBFu)zyih`4x8sc0bjxG%XVxSl z`f3c3K`)qnA9O#(!)EMQHC8fLcQ6iSNnx{%n(X>4>qi4CBXvrL$~6ku5R_C6i$=^; zs5-Z>Fr?cc*ibZ1T_d0C2wgPSXMCb(wV{e-M$Ca!D1?KSkBUJHiHKOuI)lO7?~mi# zTl>^;Hb?&DiF$#|NuRq>3fU}9CPq#IJiIrdmGr!@sl;m+QU05gj~QUt6gl@acG<6c z+)1Q?08^LA?t5lQTM^@mEpR~Cv}PS8-G$4tG)Kp`hwfgkPyL>xE3QSysZtyL)ooRq z6!+)Z`w$29elnp0g@_YYWOjPGy1aaRd_3BZAB%HydoDmQ02~~g7X34W@2ez8^m=%_ zp@{Wh2r^%Pry{=4a~KuWFMUgL7o9s5p++#Yr)0M~DU(Wo0rZBl*OKs)(lY;jP^%z{ z9NBu;`}O{#`-U0jSS#cuybdqPL5B~v?R->GR8&+^S(-Sms;cUKTddLXc?H$CKL-+J zbp)!9VdT1D9iB}fdSUy*rZihjbox?TlSU2d)M%Ho$1x}>SDIKaY1+Kf{2BE$BtBtA zII6bJpWI|}IJ>R`pFKT1Y{aic;vOCzC_qv+FO&!k9@43QX2xq%|GR~F^FLU~EE$T3 zd=3d$M^1uxai@8U|54h{hEw0hdW<+Al~0{KXDuXjZDcsIZo9$QU!b}w){h@ejg1G#$Fb4TphFnA zw5NE2kcH^z6svo(5d^FDt+g|1s5gv2jS`o)^UW6Y*|}zbUPeN?=QFJC$B}lPo{GSC z8dIfzo2qNHGOn7Q4frS@jNBE9JZcqq50eT*RL=%MSIwkVtX3t7hQ?y4#}YU;Dk=k4Y5M`dMYZ*T9;&Q51%X9x(0>&|B# z2Z#EVw9$QhlSLFdUc0f~-`m*u!%|2TGG)>$*qD4})a@(0lIEEf46B~C8baXZ z-Co;7{ItCijGNBx*Wn?n78^p*B^A(8-zQ9nfs@hN7&6j}@poVA)|m=vZ7&4{7~jOy zmpJ8|>H-f?pNlmDu9Yhe1;5F6=d$^gtXdOA+X^0L(j^ivFVZnozWK0A$=}YWQXVuZ zlov%7J6lf8lIH(WaXTIK^v+lP9P*SSzcQ=7`T;#2r*4b7{}j%?xFQABN1LP72UJci z@{-YXJWaoAuDecUdS1x{=na74alPVoy&?$gO-r|@)#-Toc)gG1ds?~n z{q|&L1Y(87OXd<@?0tX4mjtTuXAKh+hQTSHZcnW)U9RMyk<)uTg zEjO=b5Ua+dd&aBE-DqJtRz{9HO1?j(&^+>g|GHW3Ekzic`59zbHD?9x!L7Y6d zlS-hv+|pyby~t2H)%j!Lkm{ozBh>RE0mj7^0qm&0!Sro&tm@n##>>GjZ2s#!_mZHd zW^qzF_TbA5}eabbloBMB2!bGfY26Lp_LDuV=}Me7Dr z%%plfW4JX#wSs)a!GGf{Qa{Vbqkrz6Lbb_PuAOPL5YvlUSQ7j<9rYKJ>!Bk|>DT%y z*G@P>#wBWWKRNO`+Zxv?+sR`*SMYs;V6~_kGDb+PLjf38s zbT1g0is{DwD*$1UlH8Q9QB54jOY}>*Ec29PIGmlAO0t#xl74xlDaVWI@Mgdt-fFgY$oGk zS4V}#Ce?WnE{uh#6PRqPDuv=_=nAX=_20b%#rR9*7rUPHPe0y$>sf`Q;sGy}@7u3_ zc~KaQAZucLT(AbTb$eddzc!$t*C+SpZ&f`Vl^g$-ZPlsujPn|g>x7VjPQ#&|r+4fY z?>ikw%SHTS#7x)Aupf%#(!)KNU1mBqbA9hiCNREtXX{x3my&@|*WM1Vj+YllM>!8% zt1K1?&9lX-PbyX3C%5iQ%m6?4F<#f*{FMG&WT~=k?@!^OrCf2*F zeqQ#G>)N_KL34>l*a-Qsd_jjGdN7XgdKF1G;0Sp@~fs}KactPhq|I)S2W(p8%B zj7pA&Ys&#f@e;SY`RTe*fqd-hduN;%PJ=T6P2-|?G}gK%GQsO(GOESZzIxjF==b<2 zVCeJiX}JGg*0Jx6IIa&GKC;UP5%Z+9IWpxU{5j{KIugu@vEN_|j#&c<+XS++%ugWu z_;O)g_hZOGu2Pj+ZDS1(E3kXY6VXt%BZy0=bM3wmR+YWoa`teG!6#)Z)&GE4FP6B;_ z4#l+RD{;i;5(Z|d;Qmx}u(DIp(Xa?diEFpvV4JnZ-@w96R3ejWW^|NK)}P`7&^AD2 z9^SCy@2~iCZg-uDA$?K+3`wtf-7JZ?ml<#o4GsXnlt{pIU#B8UoctRVNoKWau~~cC z11#*vDX>H0F1u`F>P1B-QPzGe2gH#{?0)&r)^*M9d(g|k&nq0$pVHBL*Rbwm%T}7! zr%BPH=rgu?g$(XP>|mkS%?)%!GY7U;z1GK$Wb&~&ul$goC4~h?`?H2@JJx3w1KUHG zYV2_Ek=}rMg*0wbbQHXh#TVaYC!`?yRP;7pbaau-r2zX|w_^$6r~d3LIF~@gWQX$| zml$e!Tm)quWfa5VjT$d1F$m*n^2jM{AAW}7Dj2PO{BX>NO&uqJjZ6^)1bN@z`uY+3 z18&nk4Fd;s$v=_N4-&~B0f_R1wmV);>MZ}MVR2O;>yh#N;PUD1Fsmk`$atm0_mxpQ zvyI4UasLluD4w|MVmUGwwbllW>-Ezous1F>RaH$*O0yqQPCm!qfXdQ zjc(QpTTgx?z7BdE`!|t1Q~*m~D<&GMNbz9sE1~cOuSsfdl%Al4|h(UpP|KSAU<7beq-JG03`e*79gX$Dn9SZP= zm53NRd~ULsSSHlf%Xo84MD&mVgNchWRN6XbmGs(^yxfvI`!Fc)C3%f)ZrW+gJsmBq z$Mt<@sb^1qQ+TVBw~8sESFW!*!+CpE!&L zDO{d>%J;?;7d*f~&~$CO;>}6RXINNg&{gR?10S1$Id5eJi0&a zGCcRw;5zqf&RT6KNTOv`M!{hMKkn9stK&tKt$8JAW+Cb1J{wvEeBI1(2SEO|UwO%+m4DRO*ED`Q9_!~w{YCK$>wBC-%j-SSg@gxGzcz6#Z`Y5cW_S<$pq<(_j z#LD4dnVJr}b#4a{1tWrll_~P^#S2upcB}sDT2bw$x`~~z&1>9!>x=GS92@E`%hB$b zf31MGZ{hp7PxS3}AAo{(V+a}gX{@X>NU*zck|n!7Eh;Yf?Ri+UGD5e8_?YMG3ocgx z+Be{T_Xs$zN~h}#2ng8N*l2I(h7P>#Ltp^;5-bUjkBd@uKG7jIH9Lj!q;UN(R-P6{bqjiG`s|)T1Z?^-WMs^2Y6nU5guWLt^hW3N zyWJ^zd#i{vB(NSi${!j69r<=K;>CVd)fd5${Y43&E1Ghbe@3Y3VMC7n4>qy9?38BX zafSDn&)p1#P*>QnOBJRde=#fdPnOLMcXxuA73b}br^pf-AccV-egO{VgTR_7vED0qrL%FNS)BkS4N2HCu0 z7AD9jd$bzec?|0ZX=LGlfDl30;EJjL{IBXWm+tL(vB4T|C-c8*QX6VQWg=;qL>Te$ zxWPQNr3=Dg0~m?(ts_yt;!4M9WW|xY zo2Zv$`_H?-KCHGn68rqE#6hL<0a+!t;uKysI}?v?kP#KL7!^TnQ}t}JmXn&5mo-QX zpi`;<4)GhxPJk3Kl@W}AQmL;`P7odK&RyWAJz}kJFFe@M^X*}t0sEmT?9ad;et}{{ zB*UM&J5yh^_0yo!#Hx|NeYk zLRp@lZ*aRe2(lA+gFM}X2KL6zRa*4lU9>A6QD-cNhCGB?{U#gZ8;~1Z@>-P{i7_4C ze_a|DZe!_pXarBfv;oV5qDkoy-X$L7A{Q9l%jd} z)NQdYAv_<*KOIkJy1G86zd-eZ>+i4Yva&K1-Wvd5XQj>%G`4BquZHo%w`Je=OW&{M zYg>({_gTReat&4`AD;(4^#D>vQ^izr28ztUnPw^cZw~sMQwN|d0Z+T__Ey){R_1~y zs5C+3dsh}p}UDnsOqqW~V>+6xHB`$%obcXFWi*acMo1XT&B`~mK%L$UfnFn6>6m);M? z?z@_QGko8-to5CYqI&eOOoTr?mt4ZrARBugFz^#Ufw=Z`bi$%Iak_Kb^-6jM%Q~vv}(|9}ulo~ltH_geTJX@(NsKze> zQf;ieoGwWE`h0bNzbMSNmVK?<`h$jSE#RGJ-^^UI%zZcJD8RK*`V%A-%X#m{d^;R> zmq_JWALnlS3plRg(_rvpRUQ&uEft>N7H{XHA>jbT(Brbp<<@UsYis=dNP?63(I_Q?H}S!@*FagQ zIxo)HyyCFYsk>!{m1V1L0Y0VD>oRV|MQlFb{*VrwbF=j_N4A6o<@*58yv2t2qeZ$( zyIZ&i0Jc$KuVE#Ey*%+69*|YpI>Vjwj|^;8-TusBS;^^Z?H#nr%cZGHKt%_2KOWGc zqCz*KMS4Ugq&iJ<=l}!(BC<}Zsk#=bM>M*ciR;U|+#fR**NPL&UjwYZlp=GKxLKh? zgjqNfT3kGRvMw}g2HwvZ65(Q*P24ro29xev+o#61%6cBeYaFhYeuYbc@NzcWU{f!` z5*i;iHFuQbl9gr_AvhR7PTM)qWqvwUi(9!55&q!;FLkqpCZ?#nl-Ww7)2y-0LIc%T z5)LKTy|pzDL9O;8`n+ySvgp4jHk6AI_(Lbv+zP@w(IDbKT$yTy#vcc4=3e8s)cx&9 zj=fIPyZO`-bNSX4^`VxL0>c=0ecoMn|pMAo5m!x%iW6pVll5o8E=sklPxw=CeP2xC=uXMQ;&&WKo6*mKj zy=M#82_6i9e=d!$-^pFnhvBvwS3hC*OaX=I%N9ycI&8aikp4xO&+dpwc<-W)_?1MtfOUR+{q;uHE1oN+pL zC{$Hkj+?c*>lcrneyPXyd@T;Wbmn$pN%AwJtzbkuIov;T@%*i%Xd zdsVK$lG?oWO*v2bFs;r`dUeN~X~X%}nq$7*K6}m^NG=?2^Rjg~tUsxd{N(esaeDf& z9=}tVLx*lU(;TAMixW>VzA+F=jioVAOmlIHf(1-e&*OAzD<6t0eJu^9*Ba)xS~z_^ z(Lpf@dawV=CU$lFW27yV*;O`Fl+|E;@6ZP9b_uI{{X$B=WomoHy@x*%Yp67wr~e(V zxQ}tQ8jpsHLx?9RKP@K<6rgm~QTtbCd}7feN|xRxVFj6STcYh~sm8er!9uw&s3|d__49G2L*&&772xlx)zbnw*?mrpwCb z=HV$RE(XP>UqA32;Yq^aAQoIZ>sG+^Ra7j5tst*zaYT7M$U)9z!nt;-pL`JFQa*nS z?2MdfQNS?D&q&BT)t_hw6?-yr6E{{D-2MbtPs#V80&w_?ZFrTv^aW#~D0_D6_X~v5 z84ny+V^Wc;yKT9KdBDgf1eWqEL0;KK~6~2wd9~sFQ4*2HzK?5r@X=cU4rjIZFhOLe2-44zqV)0$f zxZe+nKQ)rL_L=2kaj|OAKy6^h$77HqB}pKbrXz_*d7%6+YG2f##7g9!ofocNUpgX1 z%tAc_91(uz=PT?RvB;!@`;kfjD7(F-<_oxd^n5=#Mely97W?%g$L1q8NN+QSX|t%Rk~}I|G~B-+nF*r5fc%N9OC8EKOr(j(Hm^r>JtHH zRO*jRvbtx}ON;GCYRFkGgXd-lcY87Pm&Rl771wi>th!4iXJ|e#?4Cm#tV4ekM2J3r zF3O)7>3ULBu|}KlyB!`PwnyYx#K!0I8TGTyAWBj;dfvy`T)zA3@5gRS1Ow}z+7_MC z98CVuzm>kutXl8;emq_P2M-Q-GN{Re;%B`e0Xz5=tG=ssUYA2SREPk;jB-3gjQH2e zQ`U40CJ%AhG%q8w@yRtIBmh!mP!`F>!g}g!w=6Dgk8|7H_tUG&gS1ilWO2TgIxX~w^WbBgEe+$xxhjnJ*dxhDI>6(gTu1XJKD>*@9Ej+_^)mj z7mXSfVP%x7V_Trm?QnL-(qKl-v(t4EdaxRCNLt9tAm^e^qystmy;`!<^sKXtB)n?v zDpn%~lz95`8T@Wx^&y0`xw@f@=z2QaW@cvI+uuKQcwJdZ+q4PQ=cK27)!7DUabaurgrs2cBe2nl{CXv{Oh<0jJGmV%TGnWSc837xM zek@^Eq$Dysp;h=7kr?K)tvdJ0?5}W1v<4DtKOS!-7Zsf}g4i(~tY46X5xLo^C=b%v z9;o=($r=C2y4Qv+Ai~k?xV+A*2w)ywFV-b+7~N0lSiwpBO{DpGJUJbExF(zZ7A0`p z^`2S?f8g+)#N#^p;TD5{kdvBA`^=-Au=1d1)3a-Qa70GR7!A?7tgNBTnJWH&u54{hHtXGj-`_a^o^y3P^ z!$-wVOC4i=#{Hzu1}l@5s7ZY9q;tgtONIZV)9$|G#Xsb)U``<{@^p4$`hWdgzE4)E z{Bb$xT0VDnB_ekt{pSXP0eV8Z709L=XrBamOLcL}$?TaqxubA%KLJfZlBKb=K@ggpxmi7SLq0C~hEd5b+emiI)u3FSEs84(C zcbrIGGbQ~?w84<-u8%kg7lNqD5lCX9!7CO3AT}69?MY=hle|182S>n$73xMf>$K^9 zjytpJ;PqIn6zN)Bv1)EiDm*wi;PZScRicIs$N|aZ-^6wgC$o>|%RJdrFhpLpAchNU z(JfQ@LUl2r%s+1UsTiKAQY8L;I`KeBj zhCz;?+b;2=xF3y&yJFoFIA_(sz{|j}+%do}pNGtkZOZ?IBKz5(c!f^==h~vK_ zoDGxt`Em@!5+kxl@^i(4zJm7|cI3D+`jCQry*up$*#o!PynLc^{=XIAf4Kf+Y`QJU zXegNkCMaD8r0S0yHM(=-B7&z%m92m&utJ9+eoCdc?k*(OMW3G3z4J$`6Zx2lDldR4%x3nQ9X1hge)pirdT z=?D3eo?oJ1Bl5))8rLq8*;Mb2j3fp~*IsI3U-^m3+g6ZmVmMg9j8cu-K|j>^@;Lp-N@u9ms?mCU~IMX z;SZhs%E*BUAchV^D~w}E%Uqt@V)C^i%yedW9=BuN0Y^-fbi8q_mf0GTWAGZQt!P>F`l8#W4H(=0C~!^9wNL zqBhevLh(2sZ6WB0_buxerM@40%C(M5P6&yTgCL{E3#d4Qfq{|Apv%w3rmUsK%ks)V zO&t*x<@GQtX6*t42*|Xdgb$xofDH8WZS1!EZ8@!0OAA@o(&7X;Q0IOsFX~)^u!~k$nbo2;>eSd$3Ttm=BTA48$HP|j3-7tRs<;uNyh}n%N|YZ807zQr zoSj=m3I7T2F#oEX|Cjb`DZ&P{xg@?(kVvEffTA79N*Ofpt7r@-XO{~5fc<5q*FL@@ zrrkrEkxUIImb-)xOAwtJ3%-pW_QiT_=!i<)$iRS6Ou$+`gc_oBau3cdGjqMtpv%mj z5`_o{?{+8aVFNQ}n!k(<2*$$1A2SYF>Z}nvX87{}&_kOO*AGp0Mu0QN3FqUY0?y7i zSK}HqR2&j{dnysRcttEcwlN@AVz0$#k{modK-IP%m|>1Bo|#B$pp*SzKsc_Zd!3|$ z3FJZm>tS6IFt~*YH=e6y9N;Qz+4rN1M1tn)+^3Z=b5Ov!V0K270ncM*pqePeZ(8rb zib^N=nM1G`Ns68?6vRI-d|WDlj+IM5JtHHdCzHz7GY;}}uPix;j30!jiqQn4`lVTc zWg-9{GIaj01)p6QRPX=1>h0C%K{XkMz8wH32OQmkMZ+nJW7f~07E9XNDY9oO;t~;& zV5ki(3W?gPY5h&gI%kn}iNcBZBLbXG?gG&4II~H2k3Zpwtj*=BKc!Pzj#gI3wgozG zB`dKwJ(WIRdv`C^I}(nv3C*&MswUvGUzN$xP*7t19(dmDGktY(oMb5H)Ga?t$!`|W z^L!T8jY(M0-K|(W>X*X9R@zAZd7@IhM74zzKw}^qvyhv3WuaN)qXY#x&h=l-MRbGc ze(3u%+kclVh}IIC-hn?Ur~-)TwOW76D}nNw#>R&iYyt^nl9H10n7_(25pNPN7meu> z&)V~285--;lkC@&9BzKsV9YAz(3=yO@ppbJ%_n(Rx?jgTXxl!54Ex~hOva2UUiIC> z{$|wENvyFD0B#MBy*b61FG*hkg>#f18DKUzz|U{+VCP2N`WQLun%OIT$3V}G)%z=7 zjwF%}DO%M5Xh|>q-U<$BU2gfT@lb@#&`vz6rn&jAcYMDd5*#eblRmdC%%LsFxvdG6bHq%)3_5?C?rJ7&~kXq3oPI8#|&mez*n(w7>Z{B&1Ir zZf$GpfM}97AzD?}WQ!)160pc6?5e~|lxTx^WYg$3n!UwK7*DfmtJ5dl4r5A*2~LEwBU8uCS&K+ztvalRMs{j$(^@*>dS{is+|TI^k)+PfoN>u%U-?UFbXmk*VqTwLoy(9M)v_EV#bps8 zb84Sr+gQ{*J#^^k&P!-(k|Tl^C{35xUY8I87OvC>WPioGwjgXqWk$<&%B1Ib+?oGW z&W84nTh?~gv3|g7w`3?IPXkjmH;&w%(Ou=DL$zB!x4b0R7O`f~rM|@(s(hg<&H^Lt z$)dxTlt+%7HR=xx6tsJOcr_&Iei>VT9|T9O?6i3<|8r zL{N)eiBWcE&Rr_;%F#l%Hq4^R{)HrLIDiZsr|Crk%iyZT*#fR%ZMD3=H_FMiDRNRs zSnFh+==FSf4bn=-#f%!%q3R7n=xA1;>a!}qw*jJAqY65Zgq(axk5R2^33q>bdV1Kt zqoHBmqyZNZI>>vy1%$YpC$}GLY377rg^st#n`oiPDc)E2CZqs&2-uTCYS>$Hb?j5e zZN+%3OtM4i{5DFGih2(9xxW@|G>K2~pR2Y0n{%+!eM$fAG%L}ft%7>(eo%U%0+ z81F7@0D|D9z`Ay?IcLXHL6L!kK5!CzNXi}qovL=gnKBPoW(t`-fSX<8nxu83HfdwR zE#7kC2&NYv4Ht`k&+RoY-W*Q8D?FVFnt_MnCl%8~O)le_33flc!q^WvySSA_6D+Li zaV#dr@zr}5TQ?&sL9NC+cFTEoU~*~;v*H9G@jv4?w9f5g=CsNPVG&_11C75a1Ld=8 z#3HDLSNMpr5%{N<3cx}Y{N37iUdefNSU^w%(3{)%934K&!g;=@JbY9w2W$9PCYDPd zz>;o%oBr46?c&6UF#ZAMiO8R$5_LEV#Q=N_Q70 z{tFRMgpU_4MJFYTc`v=sj?;r^qF`d&Fzymp$9(ua@#TtFwz_a;giMu!96w#{*n7BX*uIeNOtSql(j&}725Slc3g8imL)>VtrgYRcbsKuwn ziPHx9Mebu&%roq%(Sq3zU{}hL5Vj1SJv89r{0?GL=c>Ri27~R>5?Uh^09gu5zxdw1HARkcHbmqbF%C_Q`33ez@ZEgPGl^iBzz%6Kb8@C}60>UdNswXm7G@k{$gk zt;NN0NPK+s%wKHTm>GaNY{ZX>=i1ill$8h$*s;Tf4*ZGAFmw7ia-83b2%Xw{V5cs@ zg)8Y;fCCULfq@pigaokf2mKe#A}hrhC^VQ=(cJ5YON)gt96rsqPXb-9x1T7XC{iL& zp&lc*I^M!p$Gv*a1ZsQ~+i!ph7LgCgWVm_X(5V^cIRC|w7dNdh=o8hn=TE^t(6G7k zklSbsaxf7fNeKT@`szkv!RZm(m@$-NpvHvnI_R^uZJ|*k2Q3k}UOOI7wE$pGixXNG zf6G`*jpZCtd*LRpB8YvB#j}=_RgSkhPw7#bJ5A>{|LVsD(X1_dEd+Y%s=eE`GM zHsxET^$5X_ib{T6-CB3Uq`0cEaKb7E`l`#lkY7DZ5c^Zl8mdl3t|5y5j0m59wTXOZdCOQ*cpnr5Fr3ya=2fd zx@g0)xj9+M9HWMeo9i36T;HSdc|dS-3g0`8OX4CzBtleswz_>_%n%Y0uK>nNSK0@L z#}$z&xOI{f6fK3ETAv^#Tr{bhPRz&#hTih#p0R01Xjr(-I2{?E0OJm`hZ7$u?C_01P9HT4ODQ1vF?ztU1cIc)Ja+&`s;a~St{Yxjo=iFq%a{49UVeM$lQ zJMn!8f9c7htaY2iC3l$yLQzzGV{2MUqD(6J;uY)R%0E>S|NHdnyLOPH#dLI zx7*vkLmGZAw_CvDFktx5p+o!j?ZdF^8yO4+WB2aePe1)M1j8=3_xhn7_i96#A_D;m zK^U}Ee<6Ou@Y!mWk6JMyPmhqLQ)ad`;-g!pHbzFCRUfbRQY+o#TB?u7g1Peq+kjy61 z5+zZxRqfc;vEw+7WFOh`iB4>v@K$V z^7ie%k`L?@n^Et+0tyXW^wCRBd9^mu&zCchck>VIsDdf&r5G-r6J6Boe*$ ziPxJzDBvpI`VQy0V49n0o4OR2%o}Xuuu3oNusDW?N0|Z9SfbG3_%JI^ot$PCd zPEhAkn{Y|5|J~i;vCon}k4w4Vc*XL&t{Xprn0EAxKKI>#`-*3t!n4nRXZFz41v4gS znRxc=UJH4hI&G&18eWbjuX`2l(FeZa8u7x;2f16tANc4{wj<{(WSxlh?3KUUartqOU11 zfM}npr$*aDdrl&ybvX~$34~a*`;+kDA#BwmmW3|~$Xz?~XFNX2K7a9lFqwp(pL_mK zL2&_k=^|fh%1VbLR~)$Uib`&JjAA(^>LVGM*mNdc4;%dGgV0nU;T-YqIYq@2k>*2z z)>%}Ym9ceucYYFedjoqu2psO9Q<-FMXJph%Cj-Hc_V}86V>83P-|kINOxoJ#`Tc=t zFcA1~mv4VZhB>P`Htq{Gx1^FFbnwIAh>MKabj zd)_%5k0--N_WF*DG5|!5?e^{MNTia{$@w!=2sY{Se{?uS5wvf{_d!!U$%K#Y3k*29 zxZU&Shv6AdxTS@@-4UZ9kk3#2(Nmq=rExw8bx!`Tek!Z40|4ZFWxMf}zr*FSOWqeg zA2~X4Wh1t3pT_eisMe4Ox;?t3fYlWLaNC~`8v_l|iE|Cti4DEjr!OTYUV z#=~LHgWRp+r>t|AZS19{W<9@qOY=8hHN5;C)#eA?|MB~@>ykw~mZUO);FT{zq*83D zjlR9h(`?IXSbAnxARY2^IFD7SxSTS>Yu^;*hyVb1wi3`8HWJ~Pv;=|kq;ll)fCWk- zi;oFJm;~q2WX8_$jM*rGV^YbLHXHc*AG{>uTOF_b*xT*8a6dRfXtPiP$7Et8ojJEE zn4vv1p~*sUoKR+=M2z(Z7=cuzRw5XVo=J4iQK?BMo^QZWB<=SiG8v;#3hsYY|7;yM z7sGWXT!dpXIf_ExD#%?cemW5P^gl!Un^NOb+83Ymf4DE+GjRD@7)3Fm$ki@GQNNk( z|3ikWl$D&FVhamuaNwf?X*@Rv5IDgokOnFIc-?VUV$5KTwxQOADmSimA>MWY-juUm-Th*+5WO zvr;JIiK}br`5|h=EnJe981ZLqybmM8sJ>X7D`5hZWbGmz!qI_{pn8>RX$=ycBnR9? zwVCV-sh?O!U?>29%TRPIEv{XZ8EQ^6b)ki8bWhg{cxOb;&;e4oYC-z=F<@F|{MsfS zL1#iq;lf3#x)mtvOdL7^^ec4V*dmrnrK@Y{sXnrO3@xk_>x4{*Q*L=kl8+=#T4j%I z6K6At!$;FzmS0sSFJFX<0;yAj=;Dkap~sp_AfMq!p-$UVay@$i$aU5OF|dy(G` zWwl#hdM!Qg1^|Q(97zt1(f;72D}vd=vf|rvOYyNIw*NkXka3#GGW=*GpLf-g>G9Ty z-!viV7|SzhzrO*2%7;MCzXEP<=VMG{2R3tRxMR-xc|1ju}};Z2vDH_ zy|(fJ02fL^O@(eoDKfX+;vte^XAYTOW0|4af*A)Ej z7sBF#tDe|HQQ6v+#c#bKxM3UN1_?T?&OqWeRv7m?-TqsvkfZ0P$NI-?6nhJmq~nuz z-yMDAEEyf2uwN|`Q*?gT9i=_?*g@c;m*fR8KWf|5ehPrje`udfLT@~&P* z^5ZxEG~_tD{~xmV{@;72m>UoeUnCasZ>OJ}cWQ8S+J8%(F%do8F(?s>Z)t*&@Ez~F z{-LJGRM#iH^PlyEfUV<`zBv+Lgj^=N+Jm1TJT>M@jrX3m`pN4*f1EFq2uRQD;S+-Z zfbq@~uE?c2;+T-zx%>A!XQJe7@45o1^wzrof)a9>_}*Lxz76^j>kb|uICpB;QDu|^kQ_ZW=sj>ypFXzpT9=AlwD>M>ynJnVUs1VoCND>c?+taJpHRNUSY(2+XEdG+>DpQ``m?HxK zuvDV`_>rlIsJ?z_a=N!`CQ!1tenly7pk>6H2+yNAPc<&V&usxDyc6%e)0thiVqL9? zc3XC}42et&x7C%Lxz4%10S`@0PW#H1u3l7_<+pSk=$Xq~R9}}b92n^f*hqwp4$nFy z#YvsYap>drfGE4Mew8X^YZ>>0B%7-j1*0LGpQ>NF;COpi?t;~I6`GXaaiq09r6_rL z-9k1s-}F%%E|pN=oTD+Dv2>s6obnaatf{LIjdgkpmKCLK!}A&0=!v#2pV+ATYCg}g z?{F_8S2wJ!69mV5>=C~+P_k-qsH@ADUHa(S@{nVsxpkD&6x~-QJ=WUc6s2>vFPe2F zb=s_uW3;(-L}0F5TcS8|@|2HNZ`o9L{=rZoTW?HJU1f?|his_1CRavl(Mnl2cYkaB|Wn$*;YCMV_s1&>eSYXiT&D zk+t6b4sk)PR+bv?w9*`B9Ic^D7E^jb`c~X*RKs=|d z%*tBx^yrwWxKhmj0y<^hwp+qg3fYfIX{ukZiq3So_>VujIzBdP^OHX7j4K$n4tKct z6^&JjQ!PEd@s2j1;>qn>6T_|6&>3@(89jEGGA!R(Un@m2B5mR08jVORI*O56{o^ zeKJfxx_v7>essbf>S-RVXk1&jzHae?1#8O1Eg!e#t=q6|vHE0de=2Annj=@NuT4x2 z%oD{8rNn=J(6ecM?QCm{n@%2YYA;#!;8J|%_<*ftZ(I3;TNf3H$7Mn_%2hRGWwmRIWTArxx|cL=Z7dbHw2dU)v*S*rzM-t?ce~9E zt2OraZad9#_}Yyd^uaMJt65TEUUA==Y&JeP=>W;u1IKJ@Hg2rVSCK5YbXDVh+VHX7 z3m(}h!MBYLrO4Pw_gr?46aau=JnLYu-xY9LI%mD4b9j==L?))gWs4V;RaUL4G|-VK zXDHiTC22ZoIcvRP!s6;0^(7r46+=x=ZvPTC(?01;jCUNRbJuKLQ+#aiA&+aewJZ3g z?OP@8j?Qtn)6x?bSFJ4KA2>9)s&V6{#iBz82grEHGV4vvjt)|6VAK*$18Z-mS5mO0 zTDb4%(0un{n_%(7YZgomc8AW)S~zZgq9-VvlxngYS#^ysYD>aq{__!54{R1CvWIP%{a5T3bGH$65LPkU=B zOGho%bTBySu?2VSN=1`ZIfX!FFv@tI*&ttE#plTjOEjYwzN}nWu9n3Z88I33(*?## zf*{Pr1<`X8`GAk8xL+&B0Yk^^{XIvV?r=!R0g$8B>9VuXJgt>X0dS^o5+!A35kcgc z^q!C}XrKDii&RMt$PfSk5R{jjBr>j0B6j+GUhC}6cjjUVR#}>s==IrrKFZ)I zhGMD6JWuzaL5wpR+41=pKxMjIxc~=1P;6F za7{xNfgwh@!hQDgF(zW2Jksh41n|pdTNsL>7{)}y36(iNn*c%`-9M970JYgH7l;g{ znjC?O%;I^-B*ny9TRxhf^R8ZjVi=0y*qPH1!35(?-064$P=bEzY^bUuTcvY=3?C?2JP+$}}28I)w zO8ysgr|7TZm6oM1NIBXqL77n_1pp9Yah|^LksUj}{hb%;N;PM<3?zccoQvg>lVi?L ztvp~D2E=0Cl-&aWm>r)uH=6S?G-#O#lHrJbyn8yOdG68s^@2qsuutT@p>YtA*D>HG-6FB0KXcAvJiDmHLhRARoee=>#>R}a}n zdS+W@!PlPoa!rm9001IBcRWM+W+Ons=dm*m9{|*x%_CJR&o3DVebb?2CKIp*3609A zN!y+CEUHmn8Wj@72!xQz(Wx14CLS7dct5rDtjsRRd;Ib3-}=@!8W*T^24kSFmDQDt zc_;vgM6NVfE_?RbCtrH;vBG?VG~o8p0-auC>71#k(s?F_MxD_wp7?LlxBqsoJtydF zbDmMaC@Yp}MI4#ojQJ&ce(-~Xt$ov8gH8(o$TR6AN)7Oh9XLKAQ6jvY5`&l%sB(k| z$TAy*97oYy;le7+G4ye3H&3S5=nPtw7yw*bV4iL}baFaUQnrwE^&K5|8?y{~B^o-$ zY4fx=lgjY3bP7HIfTk!c={tO~N40R>^2%JJD6#us>yX8kV=9sI0RYVW$V4a=>KL?E zuc6G)`t&Dz2U76_c-lpj|?}7W4^Er|c<>-_=lFI0f29`V; zXFI*GwbvG;^K$c)f+(dbD>ujkG_R`6nDosj2!%#2xa;J7M|}G~f0zvE^Mo?#aBs(C z&Bo1U+2uA1Ly^8fD8r_@S_YPF*kDxM-q#k@_3j6}b&phQ@0HUyY$j4q zA+wiFC*OJh}u{16BPiXQ@j+;iebVDc#lGb{@m6au-6z)+M&;K)^uSKg5LArQzH59r + +# Development Guide + +## Prerequisites + +The following development tools must be available in your local environment: + +- [Go](https://go.dev/dl/) +- [Taskfile](https://taskfile.dev/) + +## Building the Project + + + +## Running Checks + +Checks and tests are set up to ensure the project content is functional and compliant with the established standards. + + + +## Automatic Corrections + +Tools are provided to automatically bring the project into compliance with some of the required checks. + + diff --git a/docs/contributor-guide/issues.md b/docs/contributor-guide/issues.md new file mode 100644 index 00000000..0e99c088 --- /dev/null +++ b/docs/contributor-guide/issues.md @@ -0,0 +1,33 @@ + + +# Issue Report Guide + +--- + +❗ Do you need help or have a question about using this project? Support requests should be made to the [Arduino Forum](https://forum.arduino.cc). + +--- + +High quality bug reports and feature requests are valuable contributions to this project. These can be made by submitting an issue report to the project's GitHub repository: + +https://github.com/arduino/TODO_REPO_NAME/issues/new/choose + +## Before Reporting an Issue + +- Give the latest development version a test drive to see if your issue was already resolved:
+ +- Search [existing pull requests and issues](https://github.com/arduino/TODO_REPO_NAME/issues?q=) to see if it was already reported.
+ If you have additional information to provide about an existing issue, please comment there instead of creating a duplicate. You can use [GitHub's "Reactions" feature](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) if you only want to express support πŸ‘. + +## Qualities of an Excellent Report + +- Concise and descriptive issue title.
+ Vague titles make it difficult to decipher the purpose of the issue when looking through the list of reports, which might result in your issue not being given proper attention. +- Describe the issue and what behavior you were expecting.
+ Include the full and exact text of any relevant error or warning messages you might have encountered. +- Provide a full set of steps necessary to reproduce the issue.
+ Demonstration code or commands should be complete and simplified to the minimum necessary to reproduce the issue. +- Be responsive.
+ We may need you to provide additional information in order to investigate and resolve the issue.
+ Make sure your GitHub account is configured so that you will receive notifications of responses to your issue report. +- If you find a solution to your problem, please comment on your issue report with an explanation of how you were able to fix it, then close the issue. diff --git a/docs/contributor-guide/pull-requests.md b/docs/contributor-guide/pull-requests.md new file mode 100644 index 00000000..0adae385 --- /dev/null +++ b/docs/contributor-guide/pull-requests.md @@ -0,0 +1,199 @@ + + +# Pull Request Guide + +A [**pull request**](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) (PR) is the mechanism used to propose changes to the content of this project's repository. + +If you are looking for ideas of what to work on, check [the list of open issue reports](https://github.com/arduino/arduino-app-cli/issues). Pull requests addressing any of those bug reports and feature requests are welcome. + +## Contribution Workflow + +Each contribution travels through a formal process which allows it to be efficiently incorporated into the project. + +### 1. Plan + +#### Research + +Start by searching the repository for existing pull requests and issues related to your planned contribution so you can see any related conversations and proposals and avoid duplicate effort: + +https://github.com/arduino/arduino-app-cli/issues?q= + +#### Discussion + +It can sometimes be useful to get feedback from others during the planning process. There are a couple good options for discussing planned development work: + +- Talk with the user community on the [Arduino Forum](https://forum.arduino.cc/). +- Talk with Arduino developers on the [Arduino Developers Mailing List](https://groups.google.com/a/arduino.cc/g/developers). + +### 2. Fork + +Forking a GitHub repository creates a copy of it under your account. You will stage contributions in your fork of this project. + +[More information about forking repositories](https://docs.github.com/get-started/quickstart/fork-a-repo) + +#### Enabling CI in Your Fork + +The repository is configured to run automated [continuous integration](https://wikipedia.org/wiki/Continuous_integration) (CI) checks and tests. It's a good idea to enable CI in your fork so you can make sure your work will pass the checks before you submit a pull request: + +1. Open the homepage of your fork in the browser. +1. Click the "**Actions**" tab. +1. Click the **I understand my workflows, go ahead and enable them** button. +1. Some of the workflows will now need to be activated individually. Perform the following steps for each of the useful workflows listed on the left side of the page that have a "**!**" icon: + 1. Click on the workflow name. + 1. Click the **Enable workflow** button. + +### 3. Clone + +Cloning a repository creates a copy of it on your computer. + +It is possible to make simple changes to your repository using the GitHub web interface without cloning the repository. However, the GitHub web interface is quite limiting so you will likely find the need to work with a clone (using **Git** directly or your choice of [Git client software](https://git-scm.com/downloads/guis)) for any significant development work. + +[More information about cloning repositories](https://git-scm.com/docs/git-clone) + +### 4. Branch + +Create a branch in your fork to contain the changes for your contribution. You must make a separate branch in your fork for each pull request you submit. + +[More information about branches](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches) + +### 5. Make a change + +Some things to keep in mind: + +- Make sure your change complies with the project's established style conventions. +- Remember to also update the documentation content in the repository if required by your changes. +- If the project contains a test suite, update or add tests according to your change as appropriate. + +See [the development guide](../development.md#development-guide) for more information. + +### 6. Test + +Test your change carefully to make sure it works correctly and did not break other components of the project. + +As a supplement for general testing, the project is set up with automated checks and tests to facilitate development. + +See [the development guide](../development.md#development-guide) for instructions. + +### 7. Commit + +Once the work on your change is complete, add it to the revision history of the Git repository by making a commit. + +Make sure to follow the [Commit Guidelines](#commit-guidelines). + +[More information about commits](https://git-scm.com/docs/git-commit) + +### 8. Push + +If you're working from a [clone](#3-clone), you will need to push your commit to your fork on GitHub. + +[More information about pushing commits](https://git-scm.com/docs/git-push) + +#### Checking CI Results + +If you have [enabled CI in your repository](#enabling-ci-in-your-fork), GitHub will run the relevant checks automatically every time you push a commit to your fork. + +You can see the results of these checks by doing either of the following: + +- Clicking the status icon (βœ”οΈ or ❌) shown to the right of a commit. +- Opening the repository's "**Actions**" tab. + +### 9. Pull request + +A pull request (PR) is a proposal to make a change in a repository. The repository maintainer is able to accept the changes you propose in a pull request by simply clicking a button. + +[More information about pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) + +#### Scope + +Each pull request should address a single bug fix or enhancement. If you have multiple unrelated fixes or enhancements to contribute, submit them as separate pull requests. + +#### Description + +Pull request title and description should follow [the same guidelines as commit messages](#commit-message). + +If your pull request fixes an issue in the issue tracker, use [a closing keyword](https://docs.github.com/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) in the body to indicate this. + +In some cases, it might make sense to request feedback on a proposal before it is ready to be merged. You can indicate this by starting the pull request title with **[WIP]** (work in progress). Once the pull request is ready to be merged, edit the title and remove the "[WIP]". + +#### Cross-repository Contributions + +Some proposals may require changes to multiple repositories. Pull requests should be submitted in parallel to each repository. + +Clearly note any dependencies on other PRs in the description so that these can be evaluated by the reviewer and the merges coordinated. + +--- + +Please check whether any changes are required to the related documentation content hosted in the separate dedicated repositories: + +- [**arduino/docs-content**](https://github.com/arduino/docs-content) +- [**arduino/help-center-content**](https://github.com/arduino/help-center-content) + +### 10. Resolve CI failures + +Relevant checks will run automatically once you have submitted the pull request. Once these checks are finished, you can see a summary of the results near the bottom of the pull request page: + +![checks](assets/checks.png) + +Failed checks will be indicated with an ❌. If any checks failed, please fix whatever caused it to fail. Click the "**Details**" link to the right of the check name to open the logs, which provide details about the failure. + +--- + +**β“˜** In some rare cases, a CI failure may be unrelated to the changes made in your pull request. So if the information in the logs doesn't seem relevant, please comment on the pull request to ask a maintainer to take a look. + +--- + +When you push to the branch of your fork the pull request was submitted from, the commit is automatically added to the pull request. Don't create a new pull request to fix problems; update the existing pull request. + +### 11. Resolve changes requested from reviews + +Interested parties may review your pull request and suggest improvements. + +To act on general review suggestions, you can add commits to the branch you submitted the pull request from, which will automatically be added to the pull request. Don't create a new pull request to act on review suggestions; update the existing pull request. + +Reviewers may suggest specific changes, which can be applied by [clicking the **Commit suggestion** button](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request#applying-suggested-changes). + +[More information about pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews) + +### 12. Merge + +One of the repository maintainers can now choose to accept your proposed change. Once the pull request is [merged](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request), you can delete the branch you created in your fork for the pull request and delete the fork as well if you like. + +Thanks so much for your contribution! + +--- + +It is possible that the maintainers may decide a pull request doesn't align with Arduino's goals for the project and close it rather than merging. A record of the proposed changes will always be available on GitHub for future reference. If you think your modifications will be of use to others, you are welcome to maintain your own fork of the repository. + +--- + +## Commit Guidelines + +The commit history of a repository is an important resource for developers. Repositories may accumulate thousands of commits over the course of decades. Each individual commit contributes either to the commit history being pleasant and efficient to work with, or to it being a confusing mess. For this reason, it's essential for contributors to create clean, high quality commits. + +### Scope + +Commits must be "atomic". This means that the commit completely accomplishes a single task. Each commit should result in fully functional code. Multiple tasks should not be combined in a single commit, but a single task should not be split over multiple commits (e.g., one commit per file modified is not a good practice). + +[More information about atomic commits](https://www.freshconsulting.com/insights/blog/atomic-commits/) + +### Commit Message + +The commit message documents what the change was and why it was done. A little effort now writing a good commit message can save future developers from wasted time and frustration trying to understand the purpose of a poorly documented commit. + +#### Commit Message Title + +- Use the [imperative mood](https://cbea.ms/git-commit/#imperative) in the title.
+ For example: + > Use LED_BUILTIN macro in LED pin definition +- Capitalize the title. +- Do not end the title with punctuation. +- Do not use GitHub's default commit titles (e.g., "Update examples/Foo/Foo.ino"). + +#### Commit Message Body + +- Separate title from the body with a blank line. If you're committing via GitHub or [GitHub Desktop](https://desktop.github.com/) this will be done automatically. +- Wrap body at 120 characters. +- Completely explain the purpose of the commit.
+ Include a rationale for the change, any caveats, side-effects, etc. + +[More information on commit messages](https://cbea.ms/git-commit/) From a85d3f9b14d39bf6ba681752f40a77a3f0754817 Mon Sep 17 00:00:00 2001 From: dido18 Date: Mon, 10 Nov 2025 16:22:44 +0100 Subject: [PATCH 05/32] docs: update development guide with additional instructions and resources --- docs/CONTRIBUTING.md | 2 +- docs/contributor-guide/development.md | 14 +++++++++++--- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 3066bc78..ba7e7dfe 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -22,4 +22,4 @@ There are several ways you can get involved: ## Resources -- [**Development Guide**](development.md#development-guide) \ No newline at end of file +- [**Development Guide**](development.md#development-guide) diff --git a/docs/contributor-guide/development.md b/docs/contributor-guide/development.md index f63f0816..8448e9a6 100644 --- a/docs/contributor-guide/development.md +++ b/docs/contributor-guide/development.md @@ -8,19 +8,27 @@ The following development tools must be available in your local environment: - [Go](https://go.dev/dl/) - [Taskfile](https://taskfile.dev/) +- [ddb client]//https://developer.android.com/tools/adb) [optionally] ## Building the Project - +- `task init` + +## Uploading the arduino-app-cli into the board +Connect an [Arduino UNO Q](https://www.arduino.cc/product-uno-q) board to the PC via USB. + + - `task board:install` it installs the current `arduino-app-cli` inside the board (`adb` is needed). The password of the `ardiuno` username of the board is requested. ## Running Checks Checks and tests are set up to ensure the project content is functional and compliant with the established standards. - +- `task fmt-check` +- `task test` ## Automatic Corrections Tools are provided to automatically bring the project into compliance with some of the required checks. - +- `task lint` +- `task fmt` From f4117d8d41589886b414aa261f8d5115797f79b9 Mon Sep 17 00:00:00 2001 From: Davide Date: Tue, 11 Nov 2025 09:33:56 +0100 Subject: [PATCH 06/32] Update docs/contributor-guide/development.md Co-authored-by: Per Tillisch --- docs/contributor-guide/development.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributor-guide/development.md b/docs/contributor-guide/development.md index 8448e9a6..6d6b2fef 100644 --- a/docs/contributor-guide/development.md +++ b/docs/contributor-guide/development.md @@ -7,7 +7,7 @@ The following development tools must be available in your local environment: - [Go](https://go.dev/dl/) -- [Taskfile](https://taskfile.dev/) +- [Task](https://taskfile.dev/) - [ddb client]//https://developer.android.com/tools/adb) [optionally] ## Building the Project From 3a65f23a3193b2cad19e8b735fbe19ed99107af4 Mon Sep 17 00:00:00 2001 From: Davide Date: Tue, 11 Nov 2025 09:46:20 +0100 Subject: [PATCH 07/32] Update docs/contributor-guide/development.md Co-authored-by: Per Tillisch --- docs/contributor-guide/development.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributor-guide/development.md b/docs/contributor-guide/development.md index 6d6b2fef..9cfbacd7 100644 --- a/docs/contributor-guide/development.md +++ b/docs/contributor-guide/development.md @@ -8,7 +8,7 @@ The following development tools must be available in your local environment: - [Go](https://go.dev/dl/) - [Task](https://taskfile.dev/) -- [ddb client]//https://developer.android.com/tools/adb) [optionally] +- [ddb client](https://developer.android.com/tools/adb) [optionally] ## Building the Project From 86c2ba085e032ae4101bdc67f9466c309d950046 Mon Sep 17 00:00:00 2001 From: Davide Date: Tue, 11 Nov 2025 09:47:40 +0100 Subject: [PATCH 08/32] Update docs/contributor-guide/development.md Co-authored-by: Per Tillisch --- docs/contributor-guide/development.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributor-guide/development.md b/docs/contributor-guide/development.md index 9cfbacd7..0766f9f3 100644 --- a/docs/contributor-guide/development.md +++ b/docs/contributor-guide/development.md @@ -15,7 +15,7 @@ The following development tools must be available in your local environment: - `task init` ## Uploading the arduino-app-cli into the board -Connect an [Arduino UNO Q](https://www.arduino.cc/product-uno-q) board to the PC via USB. +Connect an [Arduino UNO Q](https://docs.arduino.cc/hardware/uno-q/) board to the PC via USB. - `task board:install` it installs the current `arduino-app-cli` inside the board (`adb` is needed). The password of the `ardiuno` username of the board is requested. From 3ec35e9fd25a0defeaec9e48bb0f8b5e84e494a8 Mon Sep 17 00:00:00 2001 From: Davide Date: Tue, 11 Nov 2025 09:47:49 +0100 Subject: [PATCH 09/32] Update docs/contributor-guide/development.md Co-authored-by: Per Tillisch --- docs/contributor-guide/development.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributor-guide/development.md b/docs/contributor-guide/development.md index 0766f9f3..920a40b1 100644 --- a/docs/contributor-guide/development.md +++ b/docs/contributor-guide/development.md @@ -17,7 +17,7 @@ The following development tools must be available in your local environment: ## Uploading the arduino-app-cli into the board Connect an [Arduino UNO Q](https://docs.arduino.cc/hardware/uno-q/) board to the PC via USB. - - `task board:install` it installs the current `arduino-app-cli` inside the board (`adb` is needed). The password of the `ardiuno` username of the board is requested. + - `task board:install` installs the current version of Arduino App CLI on the board (`adb` is needed). The password of the `arduino` username of the board is requested. ## Running Checks From 608e486b0f615c404da8c9ff7561199cf8a7b649 Mon Sep 17 00:00:00 2001 From: Davide Date: Tue, 11 Nov 2025 09:47:57 +0100 Subject: [PATCH 10/32] Update docs/contributor-guide/issues.md Co-authored-by: Per Tillisch --- docs/contributor-guide/issues.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributor-guide/issues.md b/docs/contributor-guide/issues.md index 0e99c088..24583857 100644 --- a/docs/contributor-guide/issues.md +++ b/docs/contributor-guide/issues.md @@ -10,7 +10,7 @@ High quality bug reports and feature requests are valuable contributions to this project. These can be made by submitting an issue report to the project's GitHub repository: -https://github.com/arduino/TODO_REPO_NAME/issues/new/choose +https://github.com/arduino/arduino-app-cli/issues/new/choose ## Before Reporting an Issue From f36b0b6523ab137b6866c1068eacf6dc3a85b19c Mon Sep 17 00:00:00 2001 From: Davide Date: Tue, 11 Nov 2025 09:48:07 +0100 Subject: [PATCH 11/32] Update docs/contributor-guide/issues.md Co-authored-by: Per Tillisch --- docs/contributor-guide/issues.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributor-guide/issues.md b/docs/contributor-guide/issues.md index 24583857..2507fcfb 100644 --- a/docs/contributor-guide/issues.md +++ b/docs/contributor-guide/issues.md @@ -16,7 +16,7 @@ https://github.com/arduino/arduino-app-cli/issues/new/choose - Give the latest development version a test drive to see if your issue was already resolved:
-- Search [existing pull requests and issues](https://github.com/arduino/TODO_REPO_NAME/issues?q=) to see if it was already reported.
+- Search [existing pull requests and issues](https://github.com/arduino/arduino-app-cli/issues?q=) to see if it was already reported.
If you have additional information to provide about an existing issue, please comment there instead of creating a duplicate. You can use [GitHub's "Reactions" feature](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) if you only want to express support πŸ‘. ## Qualities of an Excellent Report From 5e7502af242a8a2480d7c9a334181bf0b1926b10 Mon Sep 17 00:00:00 2001 From: Davide Date: Tue, 11 Nov 2025 09:48:21 +0100 Subject: [PATCH 12/32] Update docs/user-documentation.md Co-authored-by: Per Tillisch --- docs/user-documentation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-documentation.md b/docs/user-documentation.md index 4893aa30..3d262dfb 100644 --- a/docs/user-documentation.md +++ b/docs/user-documentation.md @@ -1,6 +1,6 @@ ## Environment Variables -The following environment variables are used to configure `arduino-app-cli`: +The following environment variables are used to configure Arduino App CLI: ### Application Directories From 2894d794eb1e4493c3ce8f2214988c6f4b2fe2cd Mon Sep 17 00:00:00 2001 From: Davide Date: Tue, 11 Nov 2025 09:48:29 +0100 Subject: [PATCH 13/32] Update README.md Co-authored-by: Per Tillisch --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 00e520ba..46b71b85 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# arduino-app-cli +# Arduino App CLI `arduino-app-cli` is a command line tool and a service running on Arduino UNO Q boards, that: From a7c6c8fa0281fd32c66d73ce66e9127d94154de2 Mon Sep 17 00:00:00 2001 From: Davide Date: Tue, 11 Nov 2025 09:48:44 +0100 Subject: [PATCH 14/32] Update README.md Co-authored-by: Per Tillisch --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 46b71b85..9582004b 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ e-mail contact: security@arduino.cc ## License -Arduino CLI is licensed under the GPL-3.0 license. +Arduino App CLI is licensed under the GPL-3.0 license. You can be released from the requirements of the above license by purchasing a commercial license. Buying such a license is mandatory if you want to modify or otherwise use the software for commercial activities involving the Arduino From bc7ef206f27ac9a6246b890a13d4c69da05fa693 Mon Sep 17 00:00:00 2001 From: Davide Date: Tue, 11 Nov 2025 09:48:53 +0100 Subject: [PATCH 15/32] Update README.md Co-authored-by: Per Tillisch --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9582004b..64d41df6 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ For guidance on installation and development, see the [User documentation]. Contributions are welcome! -Please read the document [How to contribute] which will show you how to build the source code, run the tests, and +Please read the [Contributor Guide] document, which will show you how to build the source code, run the tests, and contribute your changes to the project. :sparkles: Thanks to all our [contributors]! :sparkles: From 506dc89a2300eb41a71ff7962e51ff41efe21bec Mon Sep 17 00:00:00 2001 From: Davide Date: Tue, 11 Nov 2025 09:49:01 +0100 Subject: [PATCH 16/32] Update README.md Co-authored-by: Per Tillisch --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 64d41df6..4eb4e95c 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,6 @@ software without disclosing the source code of your own applications. To purchas license@arduino.cc [user documentation]: https://github.com/arduino/arduino-app-cli/docs/user-documentation.md -[how to contribute]: https://arduino.github.io/arduino-app-cli/latest/CONTRIBUTING/ +[contributor guide]: https://arduino.github.io/arduino-app-cli/latest/CONTRIBUTING/ [security policy]: https://github.com/arduino/arduino-app-cli/security/policy [contributors]: https://github.com/arduino/arduino-cli/graphs/contributors From 506c0005cc404d98848d81d068d83ce8e85b219b Mon Sep 17 00:00:00 2001 From: dido18 Date: Tue, 11 Nov 2025 09:49:33 +0100 Subject: [PATCH 17/32] docs: clarify terminology in Docker images registry section of user documentation --- docs/user-documentation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/user-documentation.md b/docs/user-documentation.md index 3d262dfb..b96a7fd1 100644 --- a/docs/user-documentation.md +++ b/docs/user-documentation.md @@ -51,6 +51,6 @@ When running an app, persistent files will be saved in the `data` folder inside ### Docker images registry -Arduino Apps bricks might required a docker image, in that case the orchestrator will pull those from the registry configured with the `DOCKER_REGISTRY_BASE` environment variable. By default this points to an Arduino GitHub Container Registry (ghcr.io/arduino). +Arduino Apps bricks might required a docker image, in that case the arduino-app-cli will pull those from the registry configured with the `DOCKER_REGISTRY_BASE` environment variable. By default this points to an Arduino GitHub Container Registry (ghcr.io/arduino). -The only image that needs to be referenced directly is the base Python image (`DOCKER_PYTHON_BASE_IMAGE`), all other containers can be downloaded automatically by the orchestrator depending on the bricks specified as dependencies in the app.yml file. +The only image that needs to be referenced directly is the base Python image (`DOCKER_PYTHON_BASE_IMAGE`), all other containers can be downloaded automatically by the arduino-app-cli depending on the bricks specified as dependencies in the app.yml file. From 2d4f4612fc0ac544ad20b3942e4697a5fe74672b Mon Sep 17 00:00:00 2001 From: dido18 Date: Tue, 11 Nov 2025 10:00:08 +0100 Subject: [PATCH 18/32] docs: simplify description of arduino-app-cli in README.md --- README.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/README.md b/README.md index 4eb4e95c..6d520513 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,6 @@ # Arduino App CLI -`arduino-app-cli` is a command line tool and a service running on Arduino UNO Q boards, that: - -- manages and runs Arduino Apps on the board (both Linux and microcontroller parts) -- provides multiple APIs to perform actions and fetch data, used by the front-end (ArduinoAppsLab) -- auto-updates itself and other components +`arduino-app-cli` is a command line tool running on the [Arduino UNO Q](https://docs.arduino.cc/hardware/uno-q/) boards, that manages and runs Arduino Apps (both Linux and microcontroller parts), provides a HTTP daemon mode to expose RestFul APIs, and auto-updates itself and other components. [![Test Go status](https://github.com/arduino/arduino-app-cli/actions/workflows/go-test.yml/badge.svg)](https://github.com/arduino/arduino-app-cli/actions/workflows/go-test.yml) From 901f8dede5db1acb2c1abe2c596a0ae060f2c54a Mon Sep 17 00:00:00 2001 From: dido18 Date: Tue, 11 Nov 2025 11:29:46 +0100 Subject: [PATCH 19/32] docs: update contributor guide for clarity and accuracy --- docs/CONTRIBUTING.md | 2 -- docs/contributor-guide/development.md | 17 +++++++++++------ 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index ba7e7dfe..e68d437a 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,5 +1,3 @@ - - # Contributor Guide Thanks for your interest in contributing to this project! diff --git a/docs/contributor-guide/development.md b/docs/contributor-guide/development.md index 920a40b1..91d18caf 100644 --- a/docs/contributor-guide/development.md +++ b/docs/contributor-guide/development.md @@ -8,17 +8,12 @@ The following development tools must be available in your local environment: - [Go](https://go.dev/dl/) - [Task](https://taskfile.dev/) -- [ddb client](https://developer.android.com/tools/adb) [optionally] +- [adb client](https://developer.android.com/tools/adb) [optionally] ## Building the Project - `task init` -## Uploading the arduino-app-cli into the board -Connect an [Arduino UNO Q](https://docs.arduino.cc/hardware/uno-q/) board to the PC via USB. - - - `task board:install` installs the current version of Arduino App CLI on the board (`adb` is needed). The password of the `arduino` username of the board is requested. - ## Running Checks Checks and tests are set up to ensure the project content is functional and compliant with the established standards. @@ -26,9 +21,19 @@ Checks and tests are set up to ensure the project content is functional and comp - `task fmt-check` - `task test` +## Testing arduino-app-cli into the board +Connect an [Arduino UNO Q](https://docs.arduino.cc/hardware/uno-q/) board via USB. + + - `task board:install` installs the current version of Arduino App CLI on the board (`adb` is needed). The password of the `arduino` username of the board is requested. + + ## Automatic Corrections Tools are provided to automatically bring the project into compliance with some of the required checks. - `task lint` - `task fmt` + + +## Generate API docs +If th \ No newline at end of file From 4b5e754bbfd5ec85d5ebc0fa736aaa082e7c2db0 Mon Sep 17 00:00:00 2001 From: dido18 Date: Tue, 11 Nov 2025 12:11:55 +0100 Subject: [PATCH 20/32] docs: update development guide and issue report instructions for clarity --- Taskfile.yml | 14 ++++++++------ docs/contributor-guide/development.md | 21 +++++++++++++++------ docs/contributor-guide/issues.md | 4 ++-- 3 files changed, 25 insertions(+), 14 deletions(-) diff --git a/Taskfile.yml b/Taskfile.yml index d11bae23..b5a3d92d 100644 --- a/Taskfile.yml +++ b/Taskfile.yml @@ -123,11 +123,17 @@ tasks: echo "Examples successfully cloned." silent: false - arduino-app-cli:build:local: + build: desc: "Build the arduino-app-cli locally" cmds: - go build -v -o ./build/arduino-app-cli ./cmd/arduino-app-cli + start: + desc: "build and launch the arduino-app-cli in daemon mode" + cmds: + - task build + - ./build/arduino-app-cli daemon --port 8800 + arduino-app-cli:release: desc: Create a tag on the current commit and push it to the remote to create the release cmds: @@ -139,11 +145,7 @@ tasks: - git tag -a "{{.CLI_ARGS}}" -m "Release {{.CLI_ARGS}}" - git push origin "{{.CLI_ARGS}}" - arduino-app-cli:start: - desc: "build and launch the arduino-app-cli in daemon mode" - cmds: - - task arduino-app-cli:build:local - - ./build/arduino-app-cli daemon --port 6060 + # To to forward a port, using ssh, you can use this command: # ssh -L 8800:localhost:8800 arduino@ diff --git a/docs/contributor-guide/development.md b/docs/contributor-guide/development.md index 91d18caf..68e2b420 100644 --- a/docs/contributor-guide/development.md +++ b/docs/contributor-guide/development.md @@ -2,6 +2,11 @@ # Development Guide +> [!NOTE] +> The `arduino-app-cli` is designed to run on the Board and access peripherals that are not available on a development PC (e.g., the microcontroller). +> +> For easier testing, using an **Arduino UNO Q** is recommended, as local testing is limited to functionalities that do not require board-specific features. + ## Prerequisites The following development tools must be available in your local environment: @@ -13,6 +18,9 @@ The following development tools must be available in your local environment: ## Building the Project - `task init` +- `task build` +- `task generate:assets` to download locally the assets of the [Arduino Bricks](`https://github.com/arduino/app-bricks-py`) +- `ARDUINO_APP_CLI__DATA_DIR=debian/arduino-app-cli/home/arduino/.local/share/arduino-app-cli task start` to build and start the arduino-app-cli in daemon mode. ## Running Checks @@ -21,11 +29,10 @@ Checks and tests are set up to ensure the project content is functional and comp - `task fmt-check` - `task test` -## Testing arduino-app-cli into the board -Connect an [Arduino UNO Q](https://docs.arduino.cc/hardware/uno-q/) board via USB. - - - `task board:install` installs the current version of Arduino App CLI on the board (`adb` is needed). The password of the `arduino` username of the board is requested. - +## Installing arduino-app-cli into the board +This is reccomended way to test a local development version of the arduino-app-cli into a board. + 1. Connect an [Arduino UNO Q](https://docs.arduino.cc/hardware/uno-q/) board via USB. + 1. `task board:install` installs the current version of Arduino App CLI on the board (`adb` is needed). The password of the `arduino` username of the board is requested. ## Automatic Corrections @@ -36,4 +43,6 @@ Tools are provided to automatically bring the project into compliance with some ## Generate API docs -If th \ No newline at end of file +If a PR, change the HTTP API definitions, the following steps are needed: +1. Open the `cmd/gendoc/docs.go` and modify/add/remove the definitions +1. Run `task doc` to generate the docs (i.e., the files `internal/api/docs/openapi.yaml` and `internal/e2e/client/client.gen.go` are generated) diff --git a/docs/contributor-guide/issues.md b/docs/contributor-guide/issues.md index 2507fcfb..c430864e 100644 --- a/docs/contributor-guide/issues.md +++ b/docs/contributor-guide/issues.md @@ -14,8 +14,8 @@ https://github.com/arduino/arduino-app-cli/issues/new/choose ## Before Reporting an Issue -- Give the latest development version a test drive to see if your issue was already resolved:
- +- Give the latest development version t (pre-releases) a test drive to see if your issue was already resolved:
+ https://github.com/arduino/arduino-app-cli/releases?q=prerelease%3Atrue - Search [existing pull requests and issues](https://github.com/arduino/arduino-app-cli/issues?q=) to see if it was already reported.
If you have additional information to provide about an existing issue, please comment there instead of creating a duplicate. You can use [GitHub's "Reactions" feature](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) if you only want to express support πŸ‘. From 511aba4444dc2ea6d46327295a0934bd6eae9126 Mon Sep 17 00:00:00 2001 From: dido18 Date: Tue, 11 Nov 2025 12:51:13 +0100 Subject: [PATCH 21/32] docs: restructure environment variables section for clarity and organization --- docs/user-documentation.md | 108 +++++++++++++++++++------------------ 1 file changed, 56 insertions(+), 52 deletions(-) diff --git a/docs/user-documentation.md b/docs/user-documentation.md index b96a7fd1..363d0c58 100644 --- a/docs/user-documentation.md +++ b/docs/user-documentation.md @@ -1,56 +1,60 @@ +# Arduino App CLI + ## Environment Variables The following environment variables are used to configure Arduino App CLI: -### Application Directories - -- **`ARDUINO_APP_CLI__APPS_DIR`** Path to the directory where Arduino Apps created by the user are stored.\ - **Default:** `/home/arduino/ArduinoApps` - -- **`ARDUINO_APP_CLI__DATA_DIR`** Path to the directory where internal data is stored.\ - **Default:** `/home/arduino/.local/share/arduino-app-cli`\ - This folder contains: - - **`examples/`** default example Apps (_e.g._ `/home/arduino/.local/share/arduino-app-cli/examples`) - - **`assets/`** contains a subfolder for each asset version (_e.g._ `/home/arduino/.local/share/arduino-app-cli/assets/0.4.5`) - - Each asset folder includes: - - `bricks-list.yaml` - - `models-list.yaml` - - **other data** such as `properties.msgpack` containing variable values - -- **`ARDUINO_APP_BRICKS__CUSTOM_MODEL_DIR`** Path to the directory where custom models are stored.\ - **Default:** `$HOME/.arduino-bricks/ei-models`\ - (_e.g._ `/home/arduino/.arduino-bricks/ei-models`) - ---- - -### Execution Settings - -- **`ARDUINO_APP_CLI__ALLOW_ROOT`** Allow running `arduino-app-cli` as root.\ - **Default:** `false` **Not recommended to set to true.** - ---- - -### External Services - -- **`LIBRARIES_API_URL`** URL of the external service used to search libraries.\ - **Default:** `https://api2.arduino.cc/libraries/v1/libraries` - ---- - -### Docker Settings - -- **`DOCKER_REGISTRY_BASE`** Docker registry used to pull images.\ - **Default:** `ghcr.io/arduino/` - -- **`DOCKER_PYTHON_BASE_IMAGE`** Tag of the Docker image for the Python runner.\ - **Default:** `app-bricks/python-apps-base:` - -### App folder and persistent data - -When running an app, persistent files will be saved in the `data` folder inside the app folder; other supporting files, including the Python venv are saved in the `.cache` folder inside the app folder. - -### Docker images registry - -Arduino Apps bricks might required a docker image, in that case the arduino-app-cli will pull those from the registry configured with the `DOCKER_REGISTRY_BASE` environment variable. By default this points to an Arduino GitHub Container Registry (ghcr.io/arduino). - -The only image that needs to be referenced directly is the base Python image (`DOCKER_PYTHON_BASE_IMAGE`), all other containers can be downloaded automatically by the arduino-app-cli depending on the bricks specified as dependencies in the app.yml file. +| Environment Variable | Default Value | Description | +|---------------------|---------------|-------------| +| `ARDUINO_APP_CLI__APPS_DIR` | `/home/arduino/ArduinoApps` | Path to the directory where Arduino Apps created by the user are stored | +| `ARDUINO_APP_CLI__DATA_DIR` | `/home/arduino/.local/share/arduino-app-cli` | Path to the directory where internal data is stored (examples, assets, properties) | +| `ARDUINO_APP_BRICKS__CUSTOM_MODEL_DIR` | `$HOME/.arduino-bricks/ei-models` | Path to the directory where custom AI models are stored | +| `ARDUINO_APP_CLI__ALLOW_ROOT` | `false` | Allow running `arduino-app-cli` as root (**Not recommended to set to true**) | +| `LIBRARIES_API_URL` | `https://api2.arduino.cc/libraries/v1/libraries` | URL of the external service used to search Arduino libraries | +| `DOCKER_REGISTRY_BASE` | `ghcr.io/arduino/` | Docker registry used to pull docker images | +| `DOCKER_PYTHON_BASE_IMAGE` | `app-bricks/python-apps-base:` | Tag of the Docker image for the Python runner | + +## Directory Structures +Examples of user-defined apps stored into the `ARDUINO_APP_CLI__APPS_DIR` folder. +``` +β”œβ”€β”€ my-first-app +β”‚Β Β  β”œβ”€β”€ app.yaml +β”‚Β Β  β”œβ”€β”€ README.md +β”‚Β Β  β”œβ”€β”€ python +β”‚Β Β  β”‚Β Β  └── main.py +β”‚Β Β  sketch +β”‚Β Β  β”‚ β”œβ”€β”€ sketch.ino +β”‚Β Β  β”‚ └── sketch.yaml +| └── .cache/ # Temporary files and dependencies +└── my-second-app + β”œβ”€β”€ app.yaml + β”œβ”€β”€ python + β”‚Β Β  └── main.py +``` + +Examples of the `assets` and the builtin `examples` stored into the `ARDUINO_APP_CLI__DATA_DIR` folder. + +``` +/home/arduino/.local/share/arduino-app-cli/ +β”œβ”€β”€ assets +β”‚Β Β  └── 0.5.0 # Version-specific assets +β”‚Β Β  β”œβ”€β”€ bricks-list.yaml # Available bricks +β”‚Β Β  β”œβ”€β”€ models-list.yaml # Available models +β”‚Β Β  └── ... +β”œβ”€β”€ bootloader_burned.flag +β”œβ”€β”€ default.app +β”œβ”€β”€ properties.msgpack # Variable values +β”œβ”€β”€ examples +β”‚Β Β  β”œβ”€β”€ air-quality-monitoring +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ app.yaml +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ assets +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ python +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ README.md +β”‚Β Β  β”‚Β Β  └── sketch +β”‚Β Β  β”œβ”€β”€ anomaly-detection +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ app.yaml +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ assets +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ python +β”‚Β Β  β”‚Β Β  └── README.md +β”‚Β Β  └── ... +``` From e2c472a335eaee7ea9a8eb6b0bc9a2dc5feba1ed Mon Sep 17 00:00:00 2001 From: dido18 Date: Tue, 11 Nov 2025 14:01:48 +0100 Subject: [PATCH 22/32] docs: improve clarity and consistency in user documentation --- docs/user-documentation.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/user-documentation.md b/docs/user-documentation.md index 363d0c58..170a590d 100644 --- a/docs/user-documentation.md +++ b/docs/user-documentation.md @@ -15,21 +15,21 @@ The following environment variables are used to configure Arduino App CLI: | `DOCKER_PYTHON_BASE_IMAGE` | `app-bricks/python-apps-base:` | Tag of the Docker image for the Python runner | ## Directory Structures -Examples of user-defined apps stored into the `ARDUINO_APP_CLI__APPS_DIR` folder. +Examples of user-defined Arduino Apps stored into the `ARDUINO_APP_CLI__APPS_DIR` folder. ``` β”œβ”€β”€ my-first-app β”‚Β Β  β”œβ”€β”€ app.yaml β”‚Β Β  β”œβ”€β”€ README.md β”‚Β Β  β”œβ”€β”€ python β”‚Β Β  β”‚Β Β  └── main.py -β”‚Β Β  sketch +β”‚Β Β  β”œβ”€β”€ sketch β”‚Β Β  β”‚ β”œβ”€β”€ sketch.ino β”‚Β Β  β”‚ └── sketch.yaml | └── .cache/ # Temporary files and dependencies └── my-second-app β”œβ”€β”€ app.yaml β”œβ”€β”€ python - β”‚Β Β  └── main.py + Β Β  └── main.py ``` Examples of the `assets` and the builtin `examples` stored into the `ARDUINO_APP_CLI__DATA_DIR` folder. @@ -39,12 +39,12 @@ Examples of the `assets` and the builtin `examples` stored into the `ARDUINO_APP β”œβ”€β”€ assets β”‚Β Β  └── 0.5.0 # Version-specific assets β”‚Β Β  β”œβ”€β”€ bricks-list.yaml # Available bricks -β”‚Β Β  β”œβ”€β”€ models-list.yaml # Available models +β”‚Β Β  β”œβ”€β”€ models-list.yaml # Available models β”‚Β Β  └── ... β”œβ”€β”€ bootloader_burned.flag -β”œβ”€β”€ default.app -β”œβ”€β”€ properties.msgpack # Variable values -β”œβ”€β”€ examples +β”œβ”€β”€ default.app # Default App +β”œβ”€β”€ properties.msgpack # Variable values +β”œβ”€β”€ examples # Built-in App examples β”‚Β Β  β”œβ”€β”€ air-quality-monitoring β”‚Β Β  β”‚Β Β  β”œβ”€β”€ app.yaml β”‚Β Β  β”‚Β Β  β”œβ”€β”€ assets From 164300940bf10725e9060c4c9264a2af59e3412a Mon Sep 17 00:00:00 2001 From: dido18 Date: Tue, 11 Nov 2025 15:00:57 +0100 Subject: [PATCH 23/32] docs: add bug report and feature request issue templates for better user feedback --- .github/ISSUE_TEMPLATE/bug-report.yml | 49 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.yml | 44 +++++++++++++++++++ 2 files changed, 93 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..a106869e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,49 @@ +# Source: https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/forms/platform-dependent/bug-report.yml +# See: https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms + +name: Bug report +description: Report a problem with the code or documentation in this repository. +labels: + - "type: imperfection" +body: + - type: textarea + id: description + attributes: + label: Describe the problem + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: To reproduce + description: Provide the specific set of steps we can follow to reproduce the problem. + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected behavior + description: What would you expect to happen after following those instructions? + validations: + required: true + - type: input + id: project-version + attributes: + label: Arduino App CLI version + description: | + Which version of Arduino App CLI are you using? (output of `arduino-app-cli version`) + _This should be the most recent version available._ + validations: + required: true + - type: checkboxes + id: checklist + attributes: + label: Issue checklist + description: Please double-check that you have done each of the following things before submitting the issue. + options: + - label: I searched for previous reports in [the issue tracker](https://github.com/arduino/arduino-app-cli/issues?q=) + required: true + - label: I verified the problem still occurs when using the latest version + required: true + - label: My report contains all necessary details + required: true diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 00000000..f450c568 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,44 @@ +# Source: https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/forms/platform-dependent/bug-report.yml +# See: https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms + +name: Feature request +description: Suggest an enhancement to this project. +labels: + - "type: enhancement" +body: + - type: textarea + id: description + attributes: + label: Describe the request + validations: + required: true + - type: textarea + id: current + attributes: + label: Describe the current behavior + description: | + What is the current behavior of Arduino App CLI in relation to your request? (output of `arduino-app-cli version`) + How can we reproduce that behavior? + validations: + required: true + - type: input + id: project-version + attributes: + label: Arduino App CLI version + description: | + Which version of Arduino App CLI are you using? (output of `arduino-app-cli version`) + _This should be the most recent version available._ + validations: + required: true + - type: checkboxes + id: checklist + attributes: + label: Issue checklist + description: Please double-check that you have done each of the following things before submitting the issue. + options: + - label: I searched for previous requests in [the issue tracker](https://github.com/arduino/arduino-app-cli/issues?q=) + required: true + - label: I verified the feature was still missing when using the latest version + required: true + - label: My request contains all necessary details + required: true From 50c3cf7d9282e3aef2a841a5a688766d271b0ef9 Mon Sep 17 00:00:00 2001 From: dido18 Date: Tue, 11 Nov 2025 15:06:10 +0100 Subject: [PATCH 24/32] docs: improve formatting and clarity in environment variables section --- Taskfile.yml | 2 -- docs/contributor-guide/development.md | 9 ++++++--- docs/user-documentation.md | 22 ++++++++++++---------- 3 files changed, 18 insertions(+), 15 deletions(-) diff --git a/Taskfile.yml b/Taskfile.yml index b5a3d92d..09d1a756 100644 --- a/Taskfile.yml +++ b/Taskfile.yml @@ -145,8 +145,6 @@ tasks: - git tag -a "{{.CLI_ARGS}}" -m "Release {{.CLI_ARGS}}" - git push origin "{{.CLI_ARGS}}" - - # To to forward a port, using ssh, you can use this command: # ssh -L 8800:localhost:8800 arduino@ arduino-app-cli:pprof: diff --git a/docs/contributor-guide/development.md b/docs/contributor-guide/development.md index 68e2b420..c2c01650 100644 --- a/docs/contributor-guide/development.md +++ b/docs/contributor-guide/development.md @@ -30,9 +30,11 @@ Checks and tests are set up to ensure the project content is functional and comp - `task test` ## Installing arduino-app-cli into the board + This is reccomended way to test a local development version of the arduino-app-cli into a board. - 1. Connect an [Arduino UNO Q](https://docs.arduino.cc/hardware/uno-q/) board via USB. - 1. `task board:install` installs the current version of Arduino App CLI on the board (`adb` is needed). The password of the `arduino` username of the board is requested. + +1. Connect an [Arduino UNO Q](https://docs.arduino.cc/hardware/uno-q/) board via USB. +1. `task board:install` installs the current version of Arduino App CLI on the board (`adb` is needed). The password of the `arduino` username of the board is requested. ## Automatic Corrections @@ -41,8 +43,9 @@ Tools are provided to automatically bring the project into compliance with some - `task lint` - `task fmt` - ## Generate API docs + If a PR, change the HTTP API definitions, the following steps are needed: + 1. Open the `cmd/gendoc/docs.go` and modify/add/remove the definitions 1. Run `task doc` to generate the docs (i.e., the files `internal/api/docs/openapi.yaml` and `internal/e2e/client/client.gen.go` are generated) diff --git a/docs/user-documentation.md b/docs/user-documentation.md index 170a590d..29af4028 100644 --- a/docs/user-documentation.md +++ b/docs/user-documentation.md @@ -4,18 +4,20 @@ The following environment variables are used to configure Arduino App CLI: -| Environment Variable | Default Value | Description | -|---------------------|---------------|-------------| -| `ARDUINO_APP_CLI__APPS_DIR` | `/home/arduino/ArduinoApps` | Path to the directory where Arduino Apps created by the user are stored | -| `ARDUINO_APP_CLI__DATA_DIR` | `/home/arduino/.local/share/arduino-app-cli` | Path to the directory where internal data is stored (examples, assets, properties) | -| `ARDUINO_APP_BRICKS__CUSTOM_MODEL_DIR` | `$HOME/.arduino-bricks/ei-models` | Path to the directory where custom AI models are stored | -| `ARDUINO_APP_CLI__ALLOW_ROOT` | `false` | Allow running `arduino-app-cli` as root (**Not recommended to set to true**) | -| `LIBRARIES_API_URL` | `https://api2.arduino.cc/libraries/v1/libraries` | URL of the external service used to search Arduino libraries | -| `DOCKER_REGISTRY_BASE` | `ghcr.io/arduino/` | Docker registry used to pull docker images | -| `DOCKER_PYTHON_BASE_IMAGE` | `app-bricks/python-apps-base:` | Tag of the Docker image for the Python runner | +| Environment Variable | Default Value | Description | +| -------------------------------------- | ------------------------------------------------ | ---------------------------------------------------------------------------------- | +| `ARDUINO_APP_CLI__APPS_DIR` | `/home/arduino/ArduinoApps` | Path to the directory where Arduino Apps created by the user are stored | +| `ARDUINO_APP_CLI__DATA_DIR` | `/home/arduino/.local/share/arduino-app-cli` | Path to the directory where internal data is stored (examples, assets, properties) | +| `ARDUINO_APP_BRICKS__CUSTOM_MODEL_DIR` | `$HOME/.arduino-bricks/ei-models` | Path to the directory where custom AI models are stored | +| `ARDUINO_APP_CLI__ALLOW_ROOT` | `false` | Allow running `arduino-app-cli` as root (**Not recommended to set to true**) | +| `LIBRARIES_API_URL` | `https://api2.arduino.cc/libraries/v1/libraries` | URL of the external service used to search Arduino libraries | +| `DOCKER_REGISTRY_BASE` | `ghcr.io/arduino/` | Docker registry used to pull docker images | +| `DOCKER_PYTHON_BASE_IMAGE` | `app-bricks/python-apps-base:` | Tag of the Docker image for the Python runner | ## Directory Structures -Examples of user-defined Arduino Apps stored into the `ARDUINO_APP_CLI__APPS_DIR` folder. + +Examples of user-defined Arduino Apps stored into the `ARDUINO_APP_CLI__APPS_DIR` folder. + ``` β”œβ”€β”€ my-first-app β”‚Β Β  β”œβ”€β”€ app.yaml From 838c8a7413a5ec2ff9ca4c3adda575d7c8398e60 Mon Sep 17 00:00:00 2001 From: dido18 Date: Tue, 11 Nov 2025 15:18:22 +0100 Subject: [PATCH 25/32] docs: update contribution methods for testing section in CONTRIBUTING.md --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index e68d437a..61119143 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -8,7 +8,7 @@ There are several ways you can get involved: | ----------------------------------------- | ---------------------------------------------------------------- | | - Support
- Question
- Discussion | Post on the [**Arduino Forum**][forum] | | - Bug report
- Feature request | Issue report (see the guide [**here**][issues]) | -| Testing | Beta testing, PR review (see the guide [**here**][beta-testing]) | +| Testing | PR review (see the guide [**here**][prs]) | | - Bug fix
- Enhancement | Pull request (see the guide [**here**][prs]) | | Monetary | [Buy official products][store] | From 10898fdeaf6fac0e76ee2d638c58e4a2309c2fb7 Mon Sep 17 00:00:00 2001 From: dido18 Date: Tue, 11 Nov 2025 15:19:59 +0100 Subject: [PATCH 26/32] docs: fix formatting in contribution methods table for consistency --- docs/CONTRIBUTING.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 61119143..d6e00e87 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -4,13 +4,13 @@ Thanks for your interest in contributing to this project! There are several ways you can get involved: -| Type of contribution | Contribution method | -| ----------------------------------------- | ---------------------------------------------------------------- | -| - Support
- Question
- Discussion | Post on the [**Arduino Forum**][forum] | -| - Bug report
- Feature request | Issue report (see the guide [**here**][issues]) | -| Testing | PR review (see the guide [**here**][prs]) | -| - Bug fix
- Enhancement | Pull request (see the guide [**here**][prs]) | -| Monetary | [Buy official products][store] | +| Type of contribution | Contribution method | +| ----------------------------------------- | ----------------------------------------------- | +| - Support
- Question
- Discussion | Post on the [**Arduino Forum**][forum] | +| - Bug report
- Feature request | Issue report (see the guide [**here**][issues]) | +| Testing | PR review (see the guide [**here**][prs]) | +| - Bug fix
- Enhancement | Pull request (see the guide [**here**][prs]) | +| Monetary | [Buy official products][store] | [forum]: https://forum.arduino.cc [issues]: contributor-guide/issues.md#issue-report-guide From b496fface0c80ec81628a6ce194b3da72686d5d6 Mon Sep 17 00:00:00 2001 From: Davide Date: Tue, 11 Nov 2025 14:46:10 +0100 Subject: [PATCH 27/32] chore: update cli messages (#61) --- cmd/arduino-app-cli/config/config.go | 2 +- cmd/arduino-app-cli/daemon/daemon.go | 2 +- cmd/arduino-app-cli/main.go | 2 +- cmd/arduino-app-cli/system/system.go | 3 ++- 4 files changed, 5 insertions(+), 4 deletions(-) diff --git a/cmd/arduino-app-cli/config/config.go b/cmd/arduino-app-cli/config/config.go index 635ad2bd..f6367fd3 100644 --- a/cmd/arduino-app-cli/config/config.go +++ b/cmd/arduino-app-cli/config/config.go @@ -29,7 +29,7 @@ import ( func NewConfigCmd(cfg config.Configuration) *cobra.Command { appCmd := &cobra.Command{ Use: "config", - Short: "Manage arduino-app-cli config", + Short: "Manage Arduino App CLI config", } appCmd.AddCommand(newConfigGetCmd(cfg)) diff --git a/cmd/arduino-app-cli/daemon/daemon.go b/cmd/arduino-app-cli/daemon/daemon.go index f96a4e0c..eeac105c 100644 --- a/cmd/arduino-app-cli/daemon/daemon.go +++ b/cmd/arduino-app-cli/daemon/daemon.go @@ -38,7 +38,7 @@ import ( func NewDaemonCmd(cfg config.Configuration, version string) *cobra.Command { daemonCmd := &cobra.Command{ Use: "daemon", - Short: "Run an HTTP server to expose arduino-app-cli functionality through REST API", + Short: "Run the Arduino App CLI as an HTTP daemon", Run: func(cmd *cobra.Command, args []string) { daemonPort, _ := cmd.Flags().GetString("port") diff --git a/cmd/arduino-app-cli/main.go b/cmd/arduino-app-cli/main.go index e859aae2..c9dfddca 100644 --- a/cmd/arduino-app-cli/main.go +++ b/cmd/arduino-app-cli/main.go @@ -48,7 +48,7 @@ func run(configuration cfg.Configuration) error { defer func() { _ = servicelocator.CloseDockerClient() }() rootCmd := &cobra.Command{ Use: "arduino-app-cli", - Short: "A CLI to manage the Python app", + Short: "A CLI to manage Arduino Apps", PersistentPreRun: func(cmd *cobra.Command, args []string) { format, ok := feedback.ParseOutputFormat(format) if !ok { diff --git a/cmd/arduino-app-cli/system/system.go b/cmd/arduino-app-cli/system/system.go index dd9986de..54c89128 100644 --- a/cmd/arduino-app-cli/system/system.go +++ b/cmd/arduino-app-cli/system/system.go @@ -37,7 +37,8 @@ import ( func NewSystemCmd(cfg config.Configuration) *cobra.Command { cmd := &cobra.Command{ - Use: "system", + Use: "system", + Short: "Manage the board’s system configuration", } cmd.AddCommand(newDownloadImageCmd(cfg)) From d16133cc0bd95d269421e3fe5b0747c22b60b480 Mon Sep 17 00:00:00 2001 From: mirkoCrobu <214636120+mirkoCrobu@users.noreply.github.com> Date: Tue, 11 Nov 2025 14:52:04 +0100 Subject: [PATCH 28/32] Add Serial Number to Avahi Service for Board Deduplication (#48) * set serial number for network discovery at post install time * adds space in a comment * set script running before Avahi service * code review fix * code review fix * code review fix --- debian/arduino-app-cli/DEBIAN/postinst | 1 + debian/arduino-app-cli/DEBIAN/prerm | 1 + .../system/arduino-avahi-serial.service | 17 +++++++++ .../arduino-app-cli/arduino-avahi-serial.sh | 37 +++++++++++++++++++ 4 files changed, 56 insertions(+) create mode 100644 debian/arduino-app-cli/etc/systemd/system/arduino-avahi-serial.service create mode 100755 debian/arduino-app-cli/var/lib/arduino-app-cli/arduino-avahi-serial.sh diff --git a/debian/arduino-app-cli/DEBIAN/postinst b/debian/arduino-app-cli/DEBIAN/postinst index 8dbe7413..da060a89 100755 --- a/debian/arduino-app-cli/DEBIAN/postinst +++ b/debian/arduino-app-cli/DEBIAN/postinst @@ -4,3 +4,4 @@ chown -R arduino:arduino /home/arduino/.local/share/arduino-app-cli systemctl enable arduino-app-cli systemctl enable arduino-burn-bootloader +systemctl enable arduino-avahi-serial.service diff --git a/debian/arduino-app-cli/DEBIAN/prerm b/debian/arduino-app-cli/DEBIAN/prerm index 44e8a76c..6d35c65c 100755 --- a/debian/arduino-app-cli/DEBIAN/prerm +++ b/debian/arduino-app-cli/DEBIAN/prerm @@ -2,3 +2,4 @@ systemctl disable arduino-app-cli systemctl disable arduino-burn-bootloader +systemctl disable arduino-avahi-serial.service diff --git a/debian/arduino-app-cli/etc/systemd/system/arduino-avahi-serial.service b/debian/arduino-app-cli/etc/systemd/system/arduino-avahi-serial.service new file mode 100644 index 00000000..f25ef825 --- /dev/null +++ b/debian/arduino-app-cli/etc/systemd/system/arduino-avahi-serial.service @@ -0,0 +1,17 @@ +[Unit] +Description=Configure Avahi with board serial number +Before=avahi-daemon.service +ConditionPathExists=!/var/lib/arduino-app-cli/avahi_serial_configured.flag + +[Service] +Type=oneshot +RemainAfterExit=true +ExecStart=/var/lib/arduino-app-cli/arduino-avahi-serial.sh +ExecStartPost=/bin/mkdir -p /var/lib/arduino-app-cli +ExecStartPost=/bin/touch /var/lib/arduino-app-cli/avahi_serial_configured.flag + +StandardOutput=journal +StandardError=journal + +[Install] +WantedBy=multi-user.target \ No newline at end of file diff --git a/debian/arduino-app-cli/var/lib/arduino-app-cli/arduino-avahi-serial.sh b/debian/arduino-app-cli/var/lib/arduino-app-cli/arduino-avahi-serial.sh new file mode 100755 index 00000000..77b5a81b --- /dev/null +++ b/debian/arduino-app-cli/var/lib/arduino-app-cli/arduino-avahi-serial.sh @@ -0,0 +1,37 @@ +#!/bin/sh +# Configure Avahi with the serial number. + + +TARGET_FILE="/etc/avahi/services/arduino.service" +SERIAL_NUMBER_PATH="/sys/devices/soc0/serial_number" + +echo "Configuring Avahi with serial number for network discovery..." + +if [ ! -f "$SERIAL_NUMBER_PATH" ]; then + echo "Error: Serial number path not found at $SERIAL_NUMBER_PATH." >&2 + exit 1 +fi + + +if [ ! -w "$TARGET_FILE" ]; then + echo "Error: Target file $TARGET_FILE not found or not writable." >&2 + exit 1 +fi + +SERIAL_NUMBER=$(cat "$SERIAL_NUMBER_PATH") + +if [ -z "$SERIAL_NUMBER" ]; then + echo "Error: Serial number file is empty." >&2 + exit 1 +fi + +if grep -q "serial_number=" "$TARGET_FILE"; then + echo "Serial number ($SERIAL_NUMBER) already configured." + exit 0 +fi + +echo "Adding serial number to $TARGET_FILE..." +sed -i "/<\/service>/i serial_number=${SERIAL_NUMBER}<\/txt-record>" "$TARGET_FILE" + +echo "Avahi configuration attempt finished." +exit 0 \ No newline at end of file From e7ac2da4eff96261bd4424ff0d355620fba2a769 Mon Sep 17 00:00:00 2001 From: martacarbone Date: Tue, 11 Nov 2025 16:27:06 +0100 Subject: [PATCH 29/32] Improve the arduino-app-cli version command by adding the "server version" #31 (#49) * Add the server version to arduino-app-cli version. * Add copyright header. --------- Co-authored-by: Luca Rinaldi --- cmd/arduino-app-cli/version/version.go | 77 ++++++++++-- cmd/arduino-app-cli/version/version_test.go | 125 ++++++++++++++++++++ 2 files changed, 194 insertions(+), 8 deletions(-) create mode 100644 cmd/arduino-app-cli/version/version_test.go diff --git a/cmd/arduino-app-cli/version/version.go b/cmd/arduino-app-cli/version/version.go index 86ed7b3c..1cb06d05 100644 --- a/cmd/arduino-app-cli/version/version.go +++ b/cmd/arduino-app-cli/version/version.go @@ -16,34 +16,95 @@ package version import ( + "encoding/json" "fmt" + "net" + "net/http" + "net/url" + "time" "github.com/spf13/cobra" "github.com/arduino/arduino-app-cli/cmd/feedback" ) -func NewVersionCmd(version string) *cobra.Command { +// The actual listening address for the daemon +// is defined in the installation package +const ( + DefaultHostname = "localhost" + DefaultPort = "8800" + ProgramName = "Arduino App CLI" +) + +func NewVersionCmd(clientVersion string) *cobra.Command { cmd := &cobra.Command{ Use: "version", Short: "Print the version number of Arduino App CLI", Run: func(cmd *cobra.Command, args []string) { - feedback.PrintResult(versionResult{ - AppName: "Arduino App CLI", - Version: version, - }) + port, _ := cmd.Flags().GetString("port") + + daemonVersion, err := getDaemonVersion(http.Client{}, port) + if err != nil { + feedback.Warnf("Warning: cannot get the running daemon version on %s:%s\n", DefaultHostname, port) + } + + result := versionResult{ + Name: ProgramName, + Version: clientVersion, + DaemonVersion: daemonVersion, + } + + feedback.PrintResult(result) }, } + cmd.Flags().String("port", DefaultPort, "The daemon network port") return cmd } +func getDaemonVersion(httpClient http.Client, port string) (string, error) { + + httpClient.Timeout = time.Second + + url := url.URL{ + Scheme: "http", + Host: net.JoinHostPort(DefaultHostname, port), + Path: "/v1/version", + } + + resp, err := httpClient.Get(url.String()) + if err != nil { + return "", err + } + defer resp.Body.Close() + + if resp.StatusCode != http.StatusOK { + return "", fmt.Errorf("unexpected status code received") + } + + var daemonResponse struct { + Version string `json:"version"` + } + if err := json.NewDecoder(resp.Body).Decode(&daemonResponse); err != nil { + return "", err + } + + return daemonResponse.Version, nil +} + type versionResult struct { - AppName string `json:"appName"` - Version string `json:"version"` + Name string `json:"name"` + Version string `json:"version"` + DaemonVersion string `json:"daemon_version,omitempty"` } func (r versionResult) String() string { - return fmt.Sprintf("%s v%s", r.AppName, r.Version) + resultMessage := fmt.Sprintf("%s version %s", ProgramName, r.Version) + + if r.DaemonVersion != "" { + resultMessage = fmt.Sprintf("%s\ndaemon version: %s", + resultMessage, r.DaemonVersion) + } + return resultMessage } func (r versionResult) Data() interface{} { diff --git a/cmd/arduino-app-cli/version/version_test.go b/cmd/arduino-app-cli/version/version_test.go new file mode 100644 index 00000000..39617968 --- /dev/null +++ b/cmd/arduino-app-cli/version/version_test.go @@ -0,0 +1,125 @@ +// This file is part of arduino-app-cli. +// +// Copyright 2025 ARDUINO SA (http://www.arduino.cc/) +// +// This software is released under the GNU General Public License version 3, +// which covers the main part of arduino-app-cli. +// The terms of this license can be found at: +// https://www.gnu.org/licenses/gpl-3.0.en.html +// +// You can be released from the requirements of the above licenses by purchasing +// a commercial license. Buying such a license is mandatory if you want to +// modify or otherwise use the software for commercial activities involving the +// Arduino software without disclosing the source code of your own applications. +// To purchase a commercial license, send an email to license@arduino.cc. + +package version + +import ( + "errors" + "io" + "net/http" + "strings" + "testing" + + "github.com/stretchr/testify/require" +) + +func TestDaemonVersion(t *testing.T) { + testCases := []struct { + name string + serverStub Tripper + port string + expectedResult string + expectedErrorMessage string + }{ + { + name: "return the server version when the server is up", + serverStub: successServer, + port: "8800", + expectedResult: "3.0-server", + expectedErrorMessage: "", + }, + { + name: "return error if default server is not listening on default port", + serverStub: failureServer, + port: "8800", + expectedResult: "", + expectedErrorMessage: `Get "http://localhost:8800/v1/version": connection refused`, + }, + { + name: "return error if provided server is not listening on provided port", + serverStub: failureServer, + port: "1234", + expectedResult: "", + expectedErrorMessage: `Get "http://localhost:1234/v1/version": connection refused`, + }, + { + name: "return error for server response 500 Internal Server Error", + serverStub: failureInternalServerError, + port: "0", + expectedResult: "", + expectedErrorMessage: "unexpected status code received", + }, + + { + name: "return error for server up and wrong json response", + serverStub: successServerWrongJson, + port: "8800", + expectedResult: "", + expectedErrorMessage: "invalid character '<' looking for beginning of value", + }, + } + + for _, tc := range testCases { + t.Run(tc.name, func(t *testing.T) { + // arrange + httpClient := http.Client{} + httpClient.Transport = tc.serverStub + + // act + result, err := getDaemonVersion(httpClient, tc.port) + + // assert + require.Equal(t, tc.expectedResult, result) + if err != nil { + require.Equal(t, tc.expectedErrorMessage, err.Error()) + } + }) + } +} + +// Leverage the http.Client's RoundTripper +// to return a canned response and bypass network calls. +type Tripper func(*http.Request) (*http.Response, error) + +func (t Tripper) RoundTrip(request *http.Request) (*http.Response, error) { + return t(request) +} + +var successServer = Tripper(func(*http.Request) (*http.Response, error) { + body := io.NopCloser(strings.NewReader(`{"version":"3.0-server"}`)) + return &http.Response{ + StatusCode: http.StatusOK, + Body: body, + }, nil +}) + +var successServerWrongJson = Tripper(func(*http.Request) (*http.Response, error) { + body := io.NopCloser(strings.NewReader(` Date: Tue, 11 Nov 2025 17:01:16 +0100 Subject: [PATCH 30/32] docs: clarify description of temporary files in user documentation --- docs/user-documentation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/user-documentation.md b/docs/user-documentation.md index 29af4028..bc2cb376 100644 --- a/docs/user-documentation.md +++ b/docs/user-documentation.md @@ -23,11 +23,11 @@ Examples of user-defined Arduino Apps stored into the `ARDUINO_APP_CLI__APPS_DIR β”‚Β Β  β”œβ”€β”€ app.yaml β”‚Β Β  β”œβ”€β”€ README.md β”‚Β Β  β”œβ”€β”€ python -β”‚Β Β  β”‚Β Β  └── main.py +β”‚Β Β  β”‚Β Β  └── main.py β”‚Β Β  β”œβ”€β”€ sketch β”‚Β Β  β”‚ β”œβ”€β”€ sketch.ino β”‚Β Β  β”‚ └── sketch.yaml -| └── .cache/ # Temporary files and dependencies +| └── .cache/ # Temporary files and dependencies of the App └── my-second-app β”œβ”€β”€ app.yaml β”œβ”€β”€ python From 7b26ce3912943a1fb1022e6daec9455f7c38296d Mon Sep 17 00:00:00 2001 From: dido18 Date: Wed, 12 Nov 2025 11:30:54 +0100 Subject: [PATCH 31/32] fix: correct contributors link in README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6d520513..944fe78e 100644 --- a/README.md +++ b/README.md @@ -40,4 +40,4 @@ license@arduino.cc [user documentation]: https://github.com/arduino/arduino-app-cli/docs/user-documentation.md [contributor guide]: https://arduino.github.io/arduino-app-cli/latest/CONTRIBUTING/ [security policy]: https://github.com/arduino/arduino-app-cli/security/policy -[contributors]: https://github.com/arduino/arduino-cli/graphs/contributors +[contributors]: https://github.com/arduino/arduino-app-cli/graphs/contributors From 2d62074b6a26f4a96a2a9bf67cebdb61fcd6eb10 Mon Sep 17 00:00:00 2001 From: dido18 Date: Wed, 12 Nov 2025 14:26:57 +0100 Subject: [PATCH 32/32] feat: enhance issue templates by adding additional context field and clarifying version prompts --- .github/ISSUE_TEMPLATE/bug-report.yml | 9 ++++++++- .github/ISSUE_TEMPLATE/feature-request.yml | 11 +++++++++-- 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index a106869e..f9996403 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -31,10 +31,17 @@ body: attributes: label: Arduino App CLI version description: | - Which version of Arduino App CLI are you using? (output of `arduino-app-cli version`) + Which version of Arduino App CLI are you using? (output of `arduino-app-cli version` executed inside the board) _This should be the most recent version available._ validations: required: true + - type: textarea + id: additional + attributes: + label: Additional context + description: Add any additional information here. + validations: + required: false - type: checkboxes id: checklist attributes: diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index f450c568..54810758 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -17,7 +17,7 @@ body: attributes: label: Describe the current behavior description: | - What is the current behavior of Arduino App CLI in relation to your request? (output of `arduino-app-cli version`) + What is the current behavior of Arduino App CLI in relation to your request? How can we reproduce that behavior? validations: required: true @@ -26,10 +26,17 @@ body: attributes: label: Arduino App CLI version description: | - Which version of Arduino App CLI are you using? (output of `arduino-app-cli version`) + Which version of Arduino App CLI are you using? (output of `arduino-app-cli version` executed inside the board) _This should be the most recent version available._ validations: required: true + - type: textarea + id: additional + attributes: + label: Additional context + description: Add any additional information here. + validations: + required: false - type: checkboxes id: checklist attributes: