diff options
| -rwxr-xr-x | docs/api-reference-book.yml | 14 | ||||
| -rwxr-xr-x | docs/api-reference/0-api-introduction.md | 45 |
2 files changed, 59 insertions, 0 deletions
diff --git a/docs/api-reference-book.yml b/docs/api-reference-book.yml new file mode 100755 index 0000000..c953711 --- /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: guppy + 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 <br /> 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 <br /> 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 <br /> playing media. | Infotainment | +| [agl-service-mediascanner](https://git.automotivelinux.org/apps/agl-service-mediascanner/) | AGL Media Scanning service that allows applications to detect <br /> 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 <br /> 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 <br /> 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 <br /> Network Stack) | Infotainment | +| [agl-service-weather](https://git.automotivelinux.org/apps/agl-service-weather/) | AGL binding that uses OpenWeathermap data to display current <br /> 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 <br /> supervision. (empty) | | +| [agl-service-xds-monitoring](https://git.automotivelinux.org/apps/agl-service-xds-monitoring/) | UNDER DEVELOPMENT | | |