summaryrefslogtreecommitdiffstats
path: root/docs/06_Component_Documentation
AgeCommit message (Collapse)AuthorFilesLines
2024-12-16Update documentation for Unified HMIsalmon_18.92.0salmon/18.92.018.92.0Kenta11-73/+375
Updated the README to include support for the Distributed Display Framework (DDFW) and Flutter applications. Instructions for environment setup and the demo procedure using the Unified HMI framework are provided. Bug-AGL: SPEC-5254 Change-Id: I2a0a05d7307ccb9f0c48c90dcbfa1e64d7c6ed72 Signed-off-by: Kenta <murakami.kenta002@jp.panasonic.com> Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/30498 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Reviewed-by: Marius Vlad <marius.vlad@collabora.com>
2024-11-04agl-demo-control-panel: Update DocumentationSuchinton Chakravarty10-35/+83
- Explain new Config options - Provide Tips and Workarounds to CARLA playback steps - Update Steps required to run Qt6 version of Demo Control Panel - Add new Screenshots to documentation Bug-AGL: SPEC-5161 Change-Id: I1005b216bda6e5515137eb549dc38e1d4b72b90b Signed-off-by: Suchinton Chakravarty <suchinton.2001@gmail.com> Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/30444 Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2024-10-22Update documenatation for AGL Voice AssistantAnuj Solanki8-28/+88
- Update documentation for voice assistant. Bug-AGL: SPEC-5200 Change-Id: Ib0144041b2d152c22038bfb64402c43bf5601501 Signed-off-by: Anuj Solanki <anuj603362@gmail.com> Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/30417 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2024-08-26GSoC '24 Add and Update Documentation for CARLA and Demo Control PanelSuchinton2-14/+112
- Update the AGL Demo Control Panel documentation. - Add Documentation for CARLA with AGL. Bug-AGL: SPEC-5161 Change-Id: I33e4b488749959a055183596ec187d1cb01827d6 Signed-off-by: Suchinton Chakravarty <suchinton.2001@gmail.com> Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/30097 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2024-08-19Updated AGL Persistent Storage API: added config info, fixed typosLudwig Schwiedrzik1-225/+229
Bug-AGL: [SPEC-5223] Change-Id: Ia98f7484df89d9fb7020840216a494543cef05e3 Signed-off-by: Ludwig Schwiedrzik <ludwig.schwiedrzik@d-fine.com> Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/30160 Reviewed-by: Walt Miner <walt@linux.com> Tested-by: Walt Miner <walt@linux.com>
2024-08-19Add Momi Navi information to documentationNaoto Yamaguchi3-0/+40
The Momi Navi need few environment variable to show map and customize view. This patch add these information. Bug-AGL: SPEC-5224 Change-Id: I64e19175bdaa1e8c63f8bd2b796c98bdf91fb69b Signed-off-by: Naoto Yamaguchi <naoto.yamaguchi@aisin.co.jp> Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/30161 Reviewed-by: Walt Miner <walt@linux.com> Tested-by: Walt Miner <walt@linux.com>
2024-06-26Add documentation for persistent storage grpc APILudwig Schwiedrzik1-0/+225
This change adds documentation for the recently merged AGL Persistent Storage API (Gerrit Change 29996). Bug-AGL: [SPEC-5187] Change-Id: Ic9743c95885b2d60b3728f58568a7e27aefe6a59 Signed-off-by: Ludwig Schwiedrzik <ludwig.schwiedrzik@d-fine.com> Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/30013 Reviewed-by: Walt Miner <walt@linux.com> Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2024-06-03doc changes for image renaming.Jan-Simon Moeller2-5/+5
Changes: - Global replace of image names with post-rework names. - .rootfs image name suffix added to locally built image filenames. - Image list updated in a couple of places to match conf-notes.txt update that has been submitted for meta-agl-core. Bug-AGL: SPEC-5138 Signed-off-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Signed-off-by: Scott Murray <scott.murray@konsulko.com> Change-Id: I437f1e32078972ead2d1156686c54475e87bebaf Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29915
2024-05-23Update release name.Jan-Simon Moeller1-2/+2
Signed-off-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Change-Id: I9bbc4ccca03df50010801b813c72e504c915a2ac
2024-03-0802_agl_compositor.md: How to change default ref UIMarius Vlad1-1/+42
02_agl_compositor.md: Add simple client examples + how to incorporate/integrate a different UI. Bug-AGL: SPEC-4832 Signed-off-by: Marius Vlad <marius.vlad@collabora.com> Change-Id: I5750c309dc36f5a87bbeab492efa730e7e0c708a Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29724 Reviewed-by: Lisandro Perez Meyer <lpmeyer@ics.com> Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2024-03-0802_agl_compositor.md: Update agl-shell versionsMarius Vlad1-0/+75
Signed-off-by: Marius Vlad <marius.vlad@collabora.com> Change-Id: I8d27816611990ee736deaaf33aa4ddab31f51f85 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29723 Reviewed-by: Lisandro Perez Meyer <lpmeyer@ics.com> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2024-03-0802_agl_compositor: Added gRPC proxy docsMarius Vlad1-1/+153
Adds the proto buf protocol as well as pointing out to agl-shell-activator or window-management-clieng-grpc. Bug-AGL: SPEC-4833 Signed-off-by: Marius Vlad <marius.vlad@collabora.com> Change-Id: Ib683c09e81cfbb03c9fdbc290e475c6563de9025 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29722 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Reviewed-by: Lisandro Perez Meyer <lpmeyer@ics.com> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2024-03-0801_AGL_components, 02_agl_compositor: Remove Waltham mentionsMarius Vlad2-5/+7
Signed-off-by: Marius Vlad <marius.vlad@collabora.com> Change-Id: Iec9e1b1c75c134a297dab3f8fa5a4fe38ea863db Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29720 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Reviewed-by: Lisandro Perez Meyer <lpmeyer@ics.com> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2024-02-19Add documentation for Unified HMIFumiya Kohzu3-0/+165
This will add documentation to build, setup, boot and run the RVGPU of Unified HMI. Bug-AGL: SPEC-4744 Change-Id: Ib6fca25316532197dd998d5b54a798cad832186a Signed-off-by: Fumiya Kohzu <kohzu.fumiya@jp.panasonic.com> Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29692 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2023-10-30Update voice agent documentationquillback_16.91.1quillback_16.91.0quillback/16.91.1quillback/16.91.016.91.116.91.0Malik Talha1-10/+20
Add details about loading config from a file and change links to point to gerrit. Change-Id: I3ac442c4d0c6e9fcfcb26fe70f296441ff7126cc Signed-off-by: Malik Talha <talhamalik727x@gmail.com> Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29338 Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2023-10-23Update application framework documentationScott Murray8-591/+414
Changes: - Moved "Creating a New Service" page back over to "Developer Guides" since it is not application framework specific. - Removed obsolete applaunchd D-Bus configuration documentation now that the functionality has been completely removed as of Pike. - Updated the application framework introduction discussion around protocols to document preference for gRPC over D-Bus for AGL projects. - Updated "Creating a New Application" documentation to document the requirements for having applications usable with applaunchd, as well as using the application templates, with BitBake recipe examples. - Added "Application Sandboxing" section that documents the existing example configurations and discusses other potential configuration options for systemd. Bug-AGL: SPEC-4928 Signed-off-by: Scott Murray <scott.murray@konsulko.com> Change-Id: I6e0c0afcf571d9214df5300d2082b15fa3bb2a27 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29284 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2023-10-23Move application framework sectionScott Murray12-9/+975
Move application framework section from "Developer Guides" to "Component Documentation" and fix all links. Bug-AGL: SPEC-4928 Signed-off-by: Scott Murray <scott.murray@konsulko.com> Change-Id: I6bb10908860860d6634b23f6a458959397a98e81 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29283 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2023-10-23agl-demo-control-panel: Update documentationsuchinton200112-44/+62
- Add steps to add custom configs - Update image assets and fix typo in dir name Bug-AGL: SPEC-4905 Signed-off-by: suchinton2001 <suchinton.2001@gmail.com> Change-Id: Ib0ffcdc3c6c0ee9fa693bba2959901c174f01a4e Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29292 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2023-10-23Add documentation for AGL voice agentMalik Talha4-0/+276
This adds in-depth documentation of the voice agent service, flutter app, intent engines, and vosk kaldi. SPEC-4906 Signed-off-by: Malik Talha <talhamalik727x@gmail.com> Change-Id: I4ba8a76ff036100b2ec9ee72a224721e4cd919af Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29280 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2023-09-27agl-demo-control-panel: Upload documentationsuchinton20017-0/+122
V1: - Add screen-shots - Provide steps to setup and use control panel V2: - Add steps to add cannilloni to AGL builds - Update installation step to clone from gerrit Bug-AGL: SPEC-4905 Signed-off-by: suchinton2001 <suchinton.2001@gmail.com> Change-Id: Iaa247cda14162108dfcd78a7c0e64af8e5ff512c Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29243 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2023-05-30Removing Waltham pagepike_15.92.0pike_15.91.1pike_15.91.0pike/15.92.0pike/15.91.1pike/15.91.015.92.015.91.115.91.0Vinod Ahuja1-96/+0
Removing Waltham page as dicussed in community meeting. Bug-AGL: [SPEC-4470] Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu> Change-Id: Ibc28380500ba7454ac695894fd9a5f084f04f359 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28872 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2023-01-20Fixing broken linksoctopus_14.93.0octopus/14.93.014.93.0Vinod Ahuja1-2/+2
I have fixed all the broken links in the documentation except links for Yocto project and security section. Bug-AGL: [SPEC-4470] Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu> Change-Id: I1c05bf2c3a9365bba0b67077cf51b294352e7943 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28384 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2022-11-21Updating File name and links in the documentationoctopus_14.92.0octopus_14.91.0octopus/14.92.0octopus/14.91.014.92.014.91.0Vinod Ahuja15-0/+2226
Updating documentation: 1. Renamed all the files and folder following 01-99 index numbering 2. Matched title name and file name 3. Inserted title in the files where ever missing 4. Updated all the reference links in the documentation Bug-AGL: [SPEC-4470] Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu> Change-Id: Ib73e1f91107646e11b5b19ab6ead4080add506e4 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28170 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>