From 4edf6cc629af725548430ea75af25fe9ca76ed33 Mon Sep 17 00:00:00 2001 From: Frederic Marec Date: Fri, 28 Jun 2019 11:22:11 +0200 Subject: Initial commit Bug-AGL: SPEC-2020 Create README.md add git submodule from app-templates Change-Id: I091f4e527a9713772356bdb2cf6e89e2ea5267a4 Signed-off-by: Stephane Desneux add sources and CMakelists Change-Id: I6b54d16764435c166e6ae261f48d1d6df34fdcad Signed-off-by: Stephane Desneux CMakelists: fix config.cmake path Change-Id: I87d774cb09d41b4f83a1ebea92feef27791dfadc Signed-off-by: Stephane Desneux conf.d: move to master branch Change-Id: Idd92d6aa5e136b1fd193ad4774204535bb423964 Signed-off-by: Stephane Desneux Add build instruction in README Signed-off-by: Sebastien Douheret Add gitignore Signed-off-by: Sebastien Douheret move config.cmake to subdir conf.d Change-Id: I329f858f0d5a56f6db4c7441cb9e8e2fa0a1a5f0 Signed-off-by: Stephane Desneux conf.d/default: add submodule to app-templates Change-Id: I201a35efe3ea9679d39f3f5e9e28e47bf88481ab Signed-off-by: Stephane Desneux CMakeLists: fix path to use conf.d/default Change-Id: Ic6d5b467baa0e871466d893073687a396a2d0ccf Signed-off-by: Stephane Desneux config.cmake: fix app-templates path Change-Id: I9e5c7cd0648a23c006642b4031cee5394551579f Signed-off-by: Stephane Desneux config.cmake: update content entry point and mimetype Change-Id: I671633e3b10c540aa38c8ab160136be971d575a4 Signed-off-by: Stephane Desneux update gitignore for vim Change-Id: I7925ef65d3e35fd6458be58ec7e1130e74d02af1 Signed-off-by: Stephane Desneux README: updated Change-Id: I8af6297184c1633aa07dda4dcd5f37b261795e6b Signed-off-by: Stephane Desneux bump app-templates Change-Id: I88353abd15bade3df0538e47a332b5ef10606587 Signed-off-by: Stephane Desneux config: add custom widget config; bump app-templates Change-Id: I1407d99ea9eced4f653c3b9ef78b5064266843a1 Signed-off-by: Stephane Desneux add RPM specfile; bump app-templates; fix conf.d/* paths Change-Id: I06cf8cae10f0783b45ef10c0891202347d8c7ec4 Signed-off-by: Stephane Desneux rename conf.d/default to conf.d/app-templates Change-Id: I3e91069c5f3019274f2b09255c783b240134faab Signed-off-by: Stephane Desneux config.cmake: fix widget entry point Change-Id: I5a0c1fd2ac97c0643273e25d2cbb1d761b2af5d5 Signed-off-by: Stephane Desneux adjust config.xml (required-api); bump app-templates Change-Id: I8b68f239fa0ee7107ac211cda24060b0ba447300 Signed-off-by: Stephane Desneux fix binder api export mode; fix 'licence' typo Change-Id: I57c4f4480412850160e4b0d523a2b52b30567fc3 Signed-off-by: Stephane Desneux Allows kernel minimal version check Update submodule that allows the check to be performed against a Yocto generated SDK or current running kernel Change-Id: If5a1f312091d9ad0b9c80b4824c8e0081513aced Signed-off-by: Romain Forlot Use latest app-templates version Change-Id: If485ae471590a529e038a1636708a7e819aa22ce Signed-off-by: Romain Forlot update cmake config file Signed-off-by: Ronan Le Martret fix build warning Signed-off-by: Ronan Le Martret Update packaging * Add debian packaging Signed-off-by: Ronan Le Martret Update to the latest app-templates version No more needs to call any macro and only include config.cmake file is mandatory. Common.cmake is include from config.cmake file Generation autobuild script in conf.d/autobuild dir Change-Id: I0b9bf73209e9ffbcab687024b6580f0a8c399597 Signed-off-by: Romain Forlot update gitignore Signed-off-by: Ronan Le Martret Use latest version of conf.d/app-templates submodule. Changes of conf.d/app-templates: > Fix: idem... > Fix: Debian things triggered even when use the SDK > Merge "Add pkg-config for deb packaging" > Fix: wrong variable expands at configure_file time > Comments and README update > Autobuild scripts directory execution proof > Use variable to handle autobuild target directory > Fix: Debian detection, only valid in native env > Move variable definition to the right place. > change path etc/config.cmake to conf.d/cmake/config.cmake Signed-off-by: Sebastien Douheret conf.d/autobuild: add generated autobuild script Change-Id: I79772a93e98e6f990890336728e356d6ddd2e3d0 Signed-off-by: Stephane Desneux Migration to binding version 2 Change-Id: I4dd1b0bf213a5b0d3d1751dbde781f88645f3f56 Signed-off-by: Romain Forlot Update app-templates Change-Id: Idbb3fe78aab559b5c81899861a07d01265f09867 Signed-off-by: Romain Forlot Fix: missing MimeType Change-Id: Ia114680759481cf8eefd795143760485026c8680 Signed-off-by: Romain Forlot Updated autobuild scripts. Change-Id: I7c16f07420eeb312061b5164a00dbd10a9325f5d Signed-off-by: Romain Forlot Update to the latest version resolving yocto build Change-Id: I6ad988bc1ac457eaf24c0b586ab9d3754fa62bbf Signed-off-by: Romain Forlot Fix widget type Use latest version of conf.d/app-templates submodule. Changes of conf.d/app-templates: (48149ac - Sebastien Douheret) Set scripts sh as executable (8c2d06a - Romain Forlot) Add configured file to files to clean up with make (e475d27 - Romain Forlot) Fix: wrong extension of configured files (e2fefbf - Romain Forlot) Add some reminder (6be72c1 - Romain Forlot) Fix: Yocto cross compile flag same the last commit Signed-off-by: Sebastien Douheret Use latest version of conf.d/app-templates submodule. Changes of conf.d/app-templates: (70dc538 - Romain Forlot) Default execution flag on shell scripts templates. (be6f910 - Romain Forlot) Fix: also avoid cleaning generated packaging files (85ece74 - Romain Forlot) Fix: cleaning of autobuild script using make clean (747c39c - Romain Forlot) Fix: cleaning generated additionals files (48149ac - Sebastien Douheret) Set scripts sh as executable Signed-off-by: Sebastien Douheret update app-templates Signed-off-by: Builder update autobuild script Signed-off-by: Builder update .gitignore Signed-off-by: Ronan Le Martret add security auth Signed-off-by: Ronan Le Martret update documentation Signed-off-by: Ronan Le Martret fix README Signed-off-by: Ronan Le Martret Update README.md Update For New App Template Set correct ldpaths in closing message. Git ignore private files/dirs (starting by __*) Add simple html page to test helloworld service. Add htdocs/assets to install Update version Signed-off-by: Ronan Le Martret update app-templates Signed-off-by: Ronan Le Martret update packaging Signed-off-by: Ronan Le Martret app-templates: bump to 42e5f14 Change-Id: I33a3680db8109e2c817e564662d965ef22274a11 Signed-off-by: Stephane Desneux bump submodule conf.d/app-templates Change-Id: I605aa515568dbbada37b3ff0a7f9ed21a2aed51a Signed-off-by: Stephane Desneux Update app-templates and autobuild script Change-Id: Ic8a2cb9b7e42d821a1452923a714280a432a508f Signed-off-by: Romain Forlot Fix variable overlapping Issue #3 Change-Id: I0f0b81a59ab45bbb9a54350878553a4f4332d20f Signed-off-by: Romain Forlot Fix typo ! C/C is the evil, C/C is the evil, C/C is the evil ! app-templates migration to cmake module Change-Id: I402cdc81f933201b6260fa72145e349b48b8c902 Signed-off-by: Romain Forlot Update readme about CMake module dependency Change-Id: Id7ee12069a47fcf05821d2338cf501fffb4cbbe2 Signed-off-by: Romain Forlot Switch to bindings V3 Aply automatic migration script. Update disclamer dates Remove dumb dependencies Signed-off-by: Jose Bollo Reorganization, new helloworld variant - Add a new binding service example with subscription/unsubscription and event mechanisms implementation example. - Adding the autobuild scripts within the repository Change-Id: I53efc22ac868e47ea7cffd3f8916fe21528ab9c7 Signed-off-by: Romain Forlot Correct some errors in README.md Adding information about JSON library and HTTPD alternative package package. Signed-off-by: Marc-Antoine Riou readme: Update agl script name Since the commit https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/app-framework-binder.git;a=commit;h=c80873f04c5122e579333b4cf363dd623200e822, AGL-app-framework-binder.sh script has been renamed. Signed-off-by: Pierre MARZIN conf.d: Correct name of the required-api Needed since the "Reorganization" of helloworld service (commit 2f2658dc9fe2abe2d059e52dc8fbb3ab531f8a9d). Signed-off-by: Pierre MARZIN test: Add test scripts to test hello binding Scripts come from the app-afb-test binding example. They have been added here to complete the demo example of helloworld binding. Use the official documentation to build and launch the test : http://docs.automotivelinux.org/master/docs/apis_services/en/dev/reference/afb-test/the-test-widget.html Signed-off-by: Pierre MARZIN test: Correct helloworld tests Correct API name. Correct some tests exemple. Delete event tests (event are not in helloworld-skeleton anymore). Signed-off-by: Pierre MARZIN binding: change api name Use a different api name to differenciate both helloworld example. Signed-off-by: Pierre MARZIN Remove redundant autobuild script. Signed-off-by: Li Xiaoming Change-Id: I7d694edc236ce918db54d1e830a26eb32b83de5a Signed-off-by: Frederic Marec --- README.md | 163 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 163 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..29d52db --- /dev/null +++ b/README.md @@ -0,0 +1,163 @@ +# helloworld-service + +A binding example for AGL + +## Pre-requisites + +Please follow [this guide](http://docs.automotivelinux.org/master/docs/devguides/en/dev/reference/host-configuration/docs/1_Prerequisites.html) +to add the AGL-Master repository to your distribution. In order to load these files into the current shell script, use the following command : + +* **Debian/Ubuntu** + +```bash +source /etc/profile.d/agl-app-framework-binder.sh +``` + +Then install the cmake module using your distribution package manager. + +* **Debian/Ubuntu** + +```bash +sudo apt-get install agl-cmake-apps-module-bin +``` + +* **openSUSE** + +```bash +sudo zypper install agl-cmake-apps-module +``` + +* **Fedora** + +```bash +sudo dnf install agl-cmake-apps-module +``` +Because the helloworld-service binding uses json, the following package has to be installed. + +* **Debian/Ubuntu** + +```bash +sudo apt-get install libjson-c-dev +``` + +* **openSUSE** + +```bash +sudo zypper install libjson-c-dev +``` + +* **Fedora** + +```bash +sudo dnf install libjson-c-dev +``` + +Binder and client communicate through HTTP protocol : + +* **Debian/Ubuntu** + +```bash +sudo apt-get install agl-libmicrohttpd-dev +``` + +* **openSUSE** + +```bash +sudo zypper install agl-libmicrohttpd-dev +``` + +* **Fedora** + +```bash +sudo dnf install agl-libmicrohttpd-dev +``` + +## Setup + +```bash +git clone https://gerrit.automotivelinux.org/gerrit/admin/repos/apps/agl-service-helloworld +cd agl-service-helloworld +``` + +## Build for AGL + +```bash +#setup your build environement +. /xdt/sdk/environment-setup-aarch64-agl-linux +#build your application +./conf.d/autobuild/agl/autobuild package +``` + +## Build for 'native' Linux distros (Fedora, openSUSE, Debian, Ubuntu, ...) + +```bash +./conf.d/autobuild/linux/autobuild package +``` + +You can also use binary package from OBS: [opensuse.org/LinuxAutomotive][opensuse.org/LinuxAutomotive] + +## Deploy + +### AGL + +```bash +export YOUR_BOARD_IP=192.168.1.X +export APP_NAME=helloworld-service +scp build/${APP_NAME}.wgt root@${YOUR_BOARD_IP}:/tmp +ssh root@${YOUR_BOARD_IP} afm-util install /tmp/${APP_NAME}.wgt +APP_VERSION=$(ssh root@${YOUR_BOARD_IP} afm-util list | grep ${APP_NAME}@ | cut -d"\"" -f4| cut -d"@" -f2) +ssh root@${YOUR_BOARD_IP} afm-util start ${APP_NAME}@${APP_VERSION} +``` + +## TEST + +### AGL + +```bash +export YOUR_BOARD_IP=192.168.1.X +export PORT=8000 +ssh root@${YOUR_BOARD_IP} afb-daemon --ws-client=unix:/run/user/0/apis/ws/helloworld --port=${PORT} --token='x' -v + +#On an other terminal +ssh root@${YOUR_BOARD_IP} afb-client-demo -H 127.0.0.1:${PORT}/api?token=x helloworld ping true +#or +curl http://${YOUR_BOARD_IP}:${PORT}/api/helloworld/ping?token=x +#For a nice display +curl http://${YOUR_BOARD_IP}:${PORT}/api/helloworld/ping?token=x 2>/dev/null | python -m json.tool +``` + +### Native Linux + +For native build you need to have tools **afb-daemon**. +You can build it by your self [app-framework-binder][app-framework-binder], or use binary package from OBS: [opensuse.org/LinuxAutomotive][opensuse.org/LinuxAutomotive] + +```bash +export PORT=8000 +afb-daemon --port=${PORT} --ldpaths=/opt/AGL/helloworld-service/lib/ + +curl http://localhost:${PORT}/api/helloworld/ping +#For a nice display +curl http://localhost:${PORT}/api/helloworld/ping 2>/dev/null | python -m json.tool + +``` + +# Activate authentification security + +To test auth just switch the line: + +```diff + static const struct afb_verb_v2 verbs[]= { + /*Without security*/ +- { .verb = "ping" , .session = AFB_SESSION_NONE, .callback = pingSample , .auth = NULL}, ++ /*{ .verb = "ping" , .session = AFB_SESSION_NONE, .callback = pingSample , .auth = NULL},*/ + /*With security "urn:AGL:permission:monitor:public:get"*/ +- /*{ .verb = "ping" , .session = AFB_SESSION_NONE, .callback = pingSample , .auth = &_afb_auths_v2_monitor[1]},*/ ++ { .verb = "ping" , .session = AFB_SESSION_NONE, .callback = pingSample , .auth = &_afb_auths_v2_monitor[1]}, + {NULL} + }; +``` + +And rebuild your application + +[opensuse.org/LinuxAutomotive]:https://en.opensuse.org/LinuxAutomotive +[app-framework-binder]:https://gerrit.automotivelinux.org/gerrit/#/admin/projects/src/app-framework-binder -- cgit 1.2.3-korg