summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorronan <ronan.lemartret@iot.bzh>2019-10-10 11:44:25 +0200
committerronan <ronan.lemartret@iot.bzh>2019-11-04 11:47:06 +0100
commit895e65610c78eb883b70c971c2c29e300ca063d3 (patch)
tree2c67a5d3c45204dd8cb86192d5a51a4cb03328f2 /README.md
parent7a5a796cdbd2658cf6f621aab209849818a67839 (diff)
- Add dependency on agl-libafb-helpers, very useful on agl binding. - Add subscription button on html interface. - After starting the timer, you can subscribe and so unsubscribe to a timer event. - Update the README.md. Bug-AGL: SPEC-2778 Signed-off-by: ronan <ronan.lemartret@iot.bzh> Change-Id: I8cc08a191a93972082060d267276df467b053589 Signed-off-by: ronan <ronan.lemartret@iot.bzh>
Diffstat (limited to 'README.md')
-rw-r--r--README.md40
1 files changed, 23 insertions, 17 deletions
diff --git a/README.md b/README.md
index 2e6bad9..fb96fec 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,8 @@ A binding example for AGL
## Pre-requisites
Please follow [this guide](https://docs.automotivelinux.org/docs/en/master/devguides/reference/2-download-packages.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 :
+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**
@@ -13,6 +14,8 @@ to add the AGL-Master repository to your distribution. In order to load these f
source /etc/profile.d/agl-app-framework-binder.sh
```
+### CMake module
+
Then install the cmake module using your distribution package manager.
* **Debian/Ubuntu**
@@ -32,24 +35,27 @@ sudo zypper install agl-cmake-apps-module
```bash
sudo dnf install agl-cmake-apps-module
```
+
+### Build dependency
+
Because the helloworld-service binding uses json, the following package has to be installed.
* **Debian/Ubuntu**
```bash
-sudo apt-get install libjson-c-dev
+sudo apt-get install libjson-c-dev agl-libafb-helpers-dev
```
* **openSUSE**
```bash
-sudo zypper install libjson-c-dev
+sudo zypper install libjson-c-devel agl-libafb-helpers-devel
```
* **Fedora**
```bash
-sudo dnf install libjson-c-dev
+sudo dnf install libjson-c-devel
```
## Setup
@@ -62,23 +68,21 @@ cd agl-service-helloworld
## Build for AGL
```bash
-#setup your build environement
+#setup your build environnement
. /xdt/sdk/environment-setup-aarch64-agl-linux
#build your application
./autobuild/agl/autobuild package
```
-## Build for 'native' Linux distros (Fedora, openSUSE, Debian, Ubuntu, ...)
+## Build for 'native' Linux distribution (Fedora, openSUSE, Debian, Ubuntu, ...)
```bash
./autobuild/linux/autobuild package
```
-You can also use binary package from OBS: [opensuse.org/LinuxAutomotive][opensuse.org/LinuxAutomotive]
-
## Deploy
-### AGL
+### Deploy on AGL
```bash
export YOUR_BOARD_IP=192.168.1.X
@@ -91,7 +95,7 @@ ssh root@${YOUR_BOARD_IP} afm-util start ${APP_NAME}@${APP_VERSION}
## TEST
-### AGL
+### TEST on AGL
```bash
export YOUR_BOARD_IP=192.168.1.X
@@ -108,20 +112,23 @@ curl http://${YOUR_BOARD_IP}:${PORT}/api/helloworld/ping?token=x 2>/dev/null | p
### Native Linux
-For native build you need to have tools **afb-daemon**.
-You can build it by yourself [app-framework-binder][app-framework-binder], or use binary package from OBS: [opensuse.org/LinuxAutomotive][opensuse.org/LinuxAutomotive]
+For native build you need to have tools **afb-daemon**.\
+You can build it by yourself [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/
+export PORT=1234
+cd build
+afb-daemon --port=${PORT} --ldpaths=package --workdir=. --roothttp=../htdocs --token= --verbose
+
+xdg-open http://localhost:${PORT}/
+#Command line test
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
+## Activate authentication security
To test auth just switch the line:
@@ -139,5 +146,4 @@ To test auth just switch the line:
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