Skip to content
Snippets Groups Projects

Draft: cats.rst: add documentation for cats

Closed Grzegorz Gwóźdź requested to merge gwozdzcfs/docsbps:cats-docs into main
Files
2
cats.rst 0 → 100644
+ 108
0
.. SPDX-FileCopyrightText: Huawei Inc.
..
.. SPDX-License-Identifier: CC-BY-4.0
.. include:: ./definitions.rst
##############
CATS Blueprint
##############
.. contents::
:depth: 4
********
Overview
********
The CATS (Context Aware Touch Screen) Blueprint provides support for touch screen which responds
to tapped buttons on it and sends further signal.
************
The Hardware
************
Needed components
=================
..TODO
************
The Software
************
Get sources
===========
#.
Get |main_project_name| sources as described in the :ref:`blueprints workspace documentation <Workspace>`.
For this specific build, you need to
clone `meta-oniro-blueprints-doorlock <https://gitlab.eclipse.org/eclipse/oniro-blueprints/doorlock/meta-oniro-blueprints-doorlock>`_.
.. code-block:: bash
$ cd $CHECKOUT_DIR
$ git clone --recursive https://gitlab.eclipse.org/eclipse/oniro-blueprints/core/meta-oniro-blueprints-core.git
$ git clone --recursive git@gitlab.eclipse.org:eclipse/oniro-blueprints/context-aware-touch-screen/meta-oniro-blueprints-cats.git
$ cd meta-oniro-blueprints-cats
$ git checkout brgl/cats-linux
.. note::
Make sure you define or replace
`CHECKOUT_DIR` as described in :ref:`blueprints workspace documentation <Workspace>`.
#.
If you already have sources cloned, update them to the most recent revision
.. code-block:: bash
user@pc:~/oniroproject$ repo sync -d
Also, update the `meta-oniro-blueprint` git checkout.
Build the software
==================
#. To build the image for this blueprint, you need to set the corresponding distro in the conf/local.conf file or on the command line as seen below:
.. code-block:: bash
$ TEMPLATECONF=../oniro/flavours/zephyr . ./oe-core/oe-init-build-env build-oniro-doorlock
#. Add the `meta-oniro-blueprints-doorlock`` & `meta-oniro-blueprints-core` layers to the build.
This is only needed once after initializing a new build.
.. code-block:: bash
$ bitbake-layers add-layer $CHECKOUT_DIR/meta-oniro-blueprints-core
$ bitbake-layers add-layer $CHECKOUT_DIR/meta-oniro-blueprints-cats
#. Start building the image
.. code-block:: bash
DISTRO=oniro-linux-blueprint-cats MACHINE=raspberrypi4-64 bitbake blueprint-cats-image
Flashing the software
=====================
After the image is built, you are ready to burn the generated image onto the SD card. We recommend using
`bmaptool <https://github.com/intel/bmap-tools>`_ and the instructions below will use it.
For example, if you are building oniro-image-base run the following command replacing (or defining) ``$DEVNODE`` accordingly:
.. code-block:: bash
$ cd tmp/deploy/images/raspberrypi4-64
$ bmaptool copy blueprint-cats-image-raspberrypi4-64.wic.gz $DEVNODE
.. note::
Remember about umounting SD card for the boot.
Booting up
==========
Connect the contect aware touch screen to Raspberrypi4-64 and insert the SD card with flashed CATS blueprint image.
Loading