From d80d874ae35653d69e7d157fc3252ee332d97d38 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 8 Apr 2019 14:12:49 -0700 Subject: API Reference: Added files to support API reference overview. Signed-off-by: Scott Rifenbark --- docs/api-reference-book.yml | 14 ++++++++++ docs/api-reference/0-api-introduction.md | 45 ++++++++++++++++++++++++++++++++ 2 files changed, 59 insertions(+) create mode 100755 docs/api-reference-book.yml create mode 100755 docs/api-reference/0-api-introduction.md diff --git a/docs/api-reference-book.yml b/docs/api-reference-book.yml new file mode 100755 index 0000000..1b612c5 --- /dev/null +++ b/docs/api-reference-book.yml @@ -0,0 +1,14 @@ +type: books +books: +- + id: api-reference + order: 10 + title: "API Reference" + description: + keywords: + author: + version: master + chapters: + - url: "api-reference/0-api-introduction.md" + name: API Reference + diff --git a/docs/api-reference/0-api-introduction.md b/docs/api-reference/0-api-introduction.md new file mode 100755 index 0000000..1a7a5b7 --- /dev/null +++ b/docs/api-reference/0-api-introduction.md @@ -0,0 +1,45 @@ +# Available APIs + +Introduction of Available APIs with categorization. If multiple categories apply, they will all be listed in the third column (e.g. first row in the following). + + + +| API | Description | Profile | +| --- | --- | --- | +| [agl-service-audio-4a](https://git.automotivelinux.org/apps/agl-service-audio-4a/) | High Level Alsa Binding for the AGL Advanced Audio Agent (4a) | Infotainment
Instrument Cluster | +| [agl-service-audio-mpcd](https://git.automotivelinux.org/apps/agl-service-audio-mpcd/) | MPCd binding (empty) | | +| [agl-service-bluetooth](https://git.automotivelinux.org/apps/agl-service-bluetooth/) | bluetooth binding | Infotainment | +| [agl-service-bluetooth-avrcp](https://git.automotivelinux.org/apps/agl-service-bluetooth-avrcp/) | AGL service that allow multimedia control over Bluetooth AVRCP profile | Infotainment | +| [agl-service-bluetooth-pbap](https://git.automotivelinux.org/apps/agl-service-bluetooth-pbap/) | Bluetooth Phone Book Access Protocoll service | Infotainment | +| [agl-service-can-low-level](https://git.automotivelinux.org/apps/agl-service-can-low-level/) | Low level CAN service made to decode and write on CAN bus. | Instrument Cluster | +| [agl-service-data-persistence](https://git.automotivelinux.org/apps/agl-service-data-persistence/) | AGL binding for data persistence | Instrument Cluster | +| [agl-service-geoclue](https://git.automotivelinux.org/apps/agl-service-geoclue/) | AGL Geoclue service to backup GPS positioning with network-based
positioning | Infotainment | +| [agl-service-geofence](https://git.automotivelinux.org/apps/agl-service-geofence/) | AGL geofence binding to signal vehicle POI bounding box events | Infotainment | +| [agl-service-gps](https://git.automotivelinux.org/apps/agl-service-gps/) | GPS binding | Infotainment | +| [agl-service-gstreamer](https://git.automotivelinux.org/apps/agl-service-gstreamer/) | (deprecated) GStreamer binding for multimedia control and playback | Infotainment | +| [agl-service-harvester](https://git.automotivelinux.org/apps/agl-service-harvester/) | V2C interface that collect data to TimeSeries database | | +| [agl-service-homescreen](https://git.automotivelinux.org/apps/agl-service-homescreen/) | Applications need a new binding to communicate with homescreen | Infotainment | +| [agl-service-homescreen-2017](https://git.automotivelinux.org/apps/agl-service-homescreen-2017/) | Binding for applications to communicate with the homescreen-2017 | Infotainment | +| [agl-service-hvac](https://git.automotivelinux.org/apps/agl-service-hvac/) | Unnamed repository | | +| [agl-service-identity-agent](https://git.automotivelinux.org/apps/agl-service-identity-agent/) | Identity Agent | | +| [agl-service-iiodevices](https://git.automotivelinux.org/apps/agl-service-iiodevices/) | iiodevices support | Telematics/Connectivity | +| [agl-service-mediaplayer](https://git.automotivelinux.org/apps/agl-service-mediaplayer/) | AGL Media Player service that allows applications to control
playing media. | Infotainment | +| [agl-service-mediascanner](https://git.automotivelinux.org/apps/agl-service-mediascanner/) | AGL Media Scanning service that allows applications to detect
and index media at... | Telematics/Connectivity | +| [agl-service-navigation](https://git.automotivelinux.org/apps/agl-service-navigation/) | Navigation API with binding | Infotainment | +| [agl-service-network](https://git.automotivelinux.org/apps/agl-service-network/) | AGL Network service providing support for management of networking
interfaces in... | | +| [agl-service-nfc](https://git.automotivelinux.org/apps/agl-service-nfc/) | AGL service NFC binding | | +| [agl-service-radio](https://git.automotivelinux.org/apps/agl-service-radio/) | radio binding | | +| [agl-service-signal-composer](https://git.automotivelinux.org/apps/agl-service-signal-composer/) | AGL High Level Signaling service to handle CAN, LIN, and others
signaling source... | Instrument Cluster | +| [agl-service-soundmanager](https://git.automotivelinux.org/apps/agl-service-soundmanager/) | Binding for applications to communicate with the soundmanager | | +| [agl-service-soundmanager-2017](https://git.automotivelinux.org/apps/agl-service-soundmanager-2017/) | Binding for applications to communicate with the soundmanager-2017 | | +| [agl-service-speech](https://git.automotivelinux.org/apps/agl-service-speech/) | AGL App Framework Binding for Speech Services | Telematics/Connectivity | +| [agl-service-steering-wheel](https://git.automotivelinux.org/apps/agl-service-steering-wheel/) | And binding service for steering wheel demo | Instrument Cluster | +| [agl-service-taskmanager](https://git.automotivelinux.org/apps/agl-service-taskmanager/) | Simple taskmanager service to retrieve data from procps | | +| [agl-service-telephony](https://git.automotivelinux.org/apps/agl-service-telephony/) | Unnamed repository | | +| [agl-service-unicens](https://git.automotivelinux.org/apps/agl-service-unicens/) | Infotainment network setup and access (using Unified Centralized
Network Stack) | Infotainment | +| [agl-service-weather](https://git.automotivelinux.org/apps/agl-service-weather/) | AGL binding that uses OpenWeathermap data to display current
conditions on Homes... | Telematics/Connectivity | +| [agl-service-wifi](https://git.automotivelinux.org/apps/agl-service-wifi/) | wifi binding | Telematics/Connectivity | +| [agl-service-windowmanager](https://git.automotivelinux.org/apps/agl-service-windowmanager/) | Binding for applications to communicate with the windowmanager | | +| [agl-service-windowmanager-2017](https://git.automotivelinux.org/apps/agl-service-windowmanager-2017/) | Binding for applications to communicate with the windowmanager-2017 | | +| [agl-service-xds](https://git.automotivelinux.org/apps/agl-service-xds/) | AGL binding used to control collected data from AGL
supervision. (empty) | | +| [agl-service-xds-monitoring](https://git.automotivelinux.org/apps/agl-service-xds-monitoring/) | UNDER DEVELOPMENT | | -- cgit 1.2.3-korg From bda2587179ca94153c6e0eb328db5c842b64b44d Mon Sep 17 00:00:00 2001 From: Clément Bénier Date: Mon, 15 Apr 2019 16:21:48 +0200 Subject: machines/renesas: fix broken link MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: I92b239f38ce82bed3305b98f26d5de1fb0c31c0d Signed-off-by: Clément Bénier --- docs/getting-started/app-workflow-prep-app.md | 10 +++++----- docs/getting-started/machines/renesas.md | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/getting-started/app-workflow-prep-app.md b/docs/getting-started/app-workflow-prep-app.md index 7768c76..3474801 100644 --- a/docs/getting-started/app-workflow-prep-app.md +++ b/docs/getting-started/app-workflow-prep-app.md @@ -22,11 +22,11 @@ and then use XDS to install the SDK: Three install types exist: container, virtual machine, or native. Follow the steps from the appropriate section to install and start an XDS server: - * **Container:** [Installation based on Docker container](../../../../../docs/devguides/en/dev/reference/xds/part-1/1-1_install-xds-server-docker.html) + * **Container:** [Installation based on Docker container](../../../devguides/reference/xds/part-1/1-1_install-xds-server-docker.html) - * **Virtual Machine:** [Installation based on Virtual Machine appliance](../../../../../docs/devguides/en/dev/reference/xds/part-1/1-2_install-xds-server-vm.html) + * **Virtual Machine:** [Installation based on Virtual Machine appliance](../../../devguides/reference/xds/part-1/1-2_install-xds-server-vm.html) - * **Native:** [Native installation](../../../../../docs/devguides/en/dev/reference/xds/part-1/1-3_install-xds-server-native.html) + * **Native:** [Native installation](../../../devguides/reference/xds/part-1/1-3_install-xds-server-native.html) 2. **Install the XDS Client Tools** The XDS Agent (``xds-agent``) needs to run on your build host. The agent interfaces with a Command-line Interpretor (CLI) tool (``xds-cli``) and an @@ -34,13 +34,13 @@ and then use XDS to install the SDK: Installation involves making sure you have the correct packages installed on the build host. Follow the steps in the - "[Installing XDS Client Tools](../../../../../docs/devguides/en/dev/reference/xds/part-1/2_install-client.html)" + "[Installing XDS Client Tools](../../../devguides/reference/xds/part-1/2_install-client.html)" section to install the XDS client tools and learn how to start the agent. 3. **Install the SDK:** Once you have XDS up, you need to install the SDK using either the command line or the Dashboard. See the - "[Installing AGL SDKs](../../../../../docs/devguides/en/dev/reference/xds/part-1/3_install-sdks.html)" + "[Installing AGL SDKs](../../../reference/xds/part-1/3_install-sdks.html)" section for information on using both. ## Installing a Stand-Alone SDK ## diff --git a/docs/getting-started/machines/renesas.md b/docs/getting-started/machines/renesas.md index 895fe19..88bdc92 100644 --- a/docs/getting-started/machines/renesas.md +++ b/docs/getting-started/machines/renesas.md @@ -167,7 +167,7 @@ Follow these steps to download the drivers you need: ## 4. Making Sure Your Build Environment is Correct The - "[Initializing Your Build Environment](../image-workflow-initialize-build-environment.html/Initializing-your-build-environment)" + "[Initializing Your Build Environment](../image-workflow-initialize-build-environment.html#Initializing-your-build-environment)" section presented generic information for setting up your build environment using the `aglsetup.sh` script. If you are building an image for a supported Renesas board, -- cgit 1.2.3-korg From 812f08f3f463e55ab8972a720561811236fdac4e Mon Sep 17 00:00:00 2001 From: Clément Bénier Date: Mon, 15 Apr 2019 16:23:58 +0200 Subject: app-workflow-prep-app: fix broken links MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: Ie2ed6d694506ac6bbc84e602ba94d998a27f65e1 Signed-off-by: Clément Bénier --- docs/getting-started/app-workflow-prep-app.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/app-workflow-prep-app.md b/docs/getting-started/app-workflow-prep-app.md index 3474801..31b1686 100644 --- a/docs/getting-started/app-workflow-prep-app.md +++ b/docs/getting-started/app-workflow-prep-app.md @@ -40,7 +40,7 @@ and then use XDS to install the SDK: 3. **Install the SDK:** Once you have XDS up, you need to install the SDK using either the command line or the Dashboard. See the - "[Installing AGL SDKs](../../../reference/xds/part-1/3_install-sdks.html)" + "[Installing AGL SDKs](../../../devguides/reference/xds/part-1/3_install-sdks.html)" section for information on using both. ## Installing a Stand-Alone SDK ## -- cgit 1.2.3-korg From e6c887c8a169cc54adebb33a8509b66926e85bc0 Mon Sep 17 00:00:00 2001 From: Clément Bénier Date: Mon, 15 Apr 2019 16:27:16 +0200 Subject: app-workflow-build-app: fix broken links MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: I963f5ec2e2fb02a5feb2e3a65f732747a92b3188 Signed-off-by: Clément Bénier --- docs/getting-started/app-workflow-build-app.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/getting-started/app-workflow-build-app.md b/docs/getting-started/app-workflow-build-app.md index 6ce3fdd..518d773 100644 --- a/docs/getting-started/app-workflow-build-app.md +++ b/docs/getting-started/app-workflow-build-app.md @@ -9,7 +9,7 @@ A simple application you can experiment with is the standard "hello world" application. For information on how to get set up and then clone the Git repository for the "Hello World" application, see the -"[Setup](../../../../../docs/devguides/en/dev/reference/xds/part-1/4-1_build-first-app-setup.html)" +"[Setup](../../../devguides/reference/xds/part-1/4-1_build-first-app-setup.html)" section. Key to developing an application suited for your target hardware is the @@ -30,12 +30,12 @@ The following list describes several: * Use the XDS command line tool. For information on how to build the "Hello World" application using the XDS command line, see the - "[Build using command line tool](../../../../../docs/devguides/en/dev/reference/xds/part-1/4-2_build-first-app-cmd.html)" + "[Build using command line tool](../../../devguides/reference/xds/part-1/4-2_build-first-app-cmd.html)" section. * Use the XDS Dashboard. For information on how to build the application using the XDS Dashboard, see the - "[Build using XDS Dashboard](../../../../../docs/devguides/en/dev/reference/xds/part-1/4-3_build-first-app-dashboard.html)" + "[Build using XDS Dashboard](../../../devguides/reference/xds/part-1/4-3_build-first-app-dashboard.html)" section. * **Build the Application Using a Stand-Alone SDK:** -- cgit 1.2.3-korg From d59af25033ad3cc8e0b9b1254708f0f862f4c6e6 Mon Sep 17 00:00:00 2001 From: Clément Bénier Date: Mon, 15 Apr 2019 17:22:06 +0200 Subject: app-workflow-deploy-app: fix broken link MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: I66054c45b9f70ca3db3b4a1a739498361a55529b Signed-off-by: Clément Bénier --- docs/getting-started/app-workflow-deploy-app.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/app-workflow-deploy-app.md b/docs/getting-started/app-workflow-deploy-app.md index b79a06a..ef2b67b 100644 --- a/docs/getting-started/app-workflow-deploy-app.md +++ b/docs/getting-started/app-workflow-deploy-app.md @@ -23,7 +23,7 @@ Several general methods exist: * Use remote commands from a host over a network, such as `scp` (i.e. secure copy). * You can set up your build environment to leverage a procedure's - [application template](../../../../../docs/devguides/en/dev/reference/sdk-devkit/docs/part-2/2_4-Use-app-templates.html) + [application template](../../../devguides/reference/sdk-devkit/docs/part-2/2_4-Use-app-templates.html) (app-template). An app-template is an application framework that contains [CMake](https://cmake.org/) macros that abstract deploying the application. -- cgit 1.2.3-korg From 19ff402d77d0cdae0259bd059d0970f5c354c587 Mon Sep 17 00:00:00 2001 From: Clément Bénier Date: Mon, 15 Apr 2019 17:27:28 +0200 Subject: app-workflow-debug-app: fix broken links MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: If979579933408beb9ac4383659766c3bd4ec96eb Signed-off-by: Clément Bénier --- docs/getting-started/app-workflow-debug-app.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/getting-started/app-workflow-debug-app.md b/docs/getting-started/app-workflow-debug-app.md index c0899de..63ec8cd 100644 --- a/docs/getting-started/app-workflow-debug-app.md +++ b/docs/getting-started/app-workflow-debug-app.md @@ -11,7 +11,7 @@ Or, is it better for you to use a remote user interface that is part of an Integrated Development Environment (IDE) such as Eclipse? For general information on debugging an application, see the -"[Debug your first AGL application](../../../../../docs/devguides/en/dev/reference/xds/part-1/5_debug-first-app.html)" +"[Debug your first AGL application](../../../devguides/reference/xds/part-1/5_debug-first-app.html)" section. Here are three methods: @@ -33,11 +33,11 @@ Here are three methods: * Use XDS remotely, which is based on `gdb` and [`gdbserver`](https://en.wikipedia.org/wiki/Gdbserver). See the - "[XDS remote debugging mode](../../../../../docs/devguides/en/dev/reference/xds/part-1/5-2_debug-first-app-cmd.html#xds-remote-debugging-mode)" + "[XDS remote debugging mode](../../../devguides/reference/xds/part-1/5-2_debug-first-app-cmd.html#xds-remote-debugging-mode)" section for more information. For information on how to remotely debug the application using XDS from within an IDE, see the - "[Debug using `xds-gdb` within an IDE](../../../../../docs/devguides/en/dev/reference/xds/part-1/5-3_debug-first-app-ide.html)" + "[Debug using `xds-gdb` within an IDE](../../../devguides/reference/xds/part-1/5-3_debug-first-app-ide.html)" section. In order to use third-party debugging tools, you need to include the tools in the target image. -- cgit 1.2.3-korg