This page explains how you as AppDeveloper can create/, compile your native (c/c++) application using DAC SDK and how to publish it to RDK-M staging DAC-Appstore in the cloud staging area.
When your application meets the DAC App contract for binary compatibility it will allow you as AppDeveloper
...
Multimedia |
---|
name | dac_warehouse_e2e_rdk_tech_summit_2024.mp4 |
---|
space | Quickstart |
---|
|
View filetoc |
---|
name | dac_warehouse_e2e_rdk_tech_summit_2024.mp4 |
---|
height | 250 |
---|
|
// TO REMOVE This page will guide you through publishing your DAC app to the RDK ASMS cloud as an AppDeveloper, then installing and running it on a Raspberry Pi (RPI). More detailed documentation of all the components used is available on their respective pages.
What you need
What you need
- Video Accelerator with final RDK6.1 image on it. This can be Raspberry Pi 4 (RPI4) on which you can flash RDK6.1 final release image. Note Video Accelerator with final RDK6.1 image on it. This can be Raspberry Pi 4 (RPI4) on which you can flash RDK6.1 final release image. Note that RPIv3B/3B+ is deprecated, not supported by RDK-M anymore. Tool to flash RDK6.1 rpi image to SD card, example is provided with https://www.balena.io/etcher/ tool. Contact RDK-M if you want to test it on more carrier grade Video Accelerator (with amlogic, broadcom or realtek SoC) with RDK6.1 image
- Your application source code with bitbake recipe. Needs to meet the DAC contract for binary compatibility.
- DAC SDK https://github.com/rdkcentral/meta-dac-sdk to cross compile your application, add dependent libraries in application container and package/output your application as oci compliant dac container image.
- As App developer company/entity you will need to request RDK-M DAC support team via support@rdkcentral.com :
- a login/pswd to register your app and its metadata in RDK-M ASMS instance (ASMS is AppStore Metdata µService and part of DAC cloud setup of RDK-M for Video Accelerators)
- an associated "Maintainer" identifier (string) to be able to upload/register your app.
- credentials for uploading your OCI image to the private RDK OCI container registry. This is not required if you choose to upload it to a public accessible OCI container registry or ask support team to upload it for you.
Above credentials are one time request per App developer entity. Once you have above credentials, you can reuse them for publishing other apps under your entity. At this moment requesting these credentials is still manual process, a point to improve in future
...
put RDK6.1 SW image on your RPI4
As an Appdeveloper you want to test and run your DAC Application on a set of real hardware reference devices. RDK-M created the Video Accelerators for that.
...
To get your hands on other Video Accelerator HWs and their RDK6.1 SW images, we refer you to RDK-M
Flash the RDK6.1 image to your RPI
Download and install https://www.balena.io/etcher/ tool
- Find and download the .wic.bz2 file from your build: find tmp/deploy/ -name *.wic.bz2
- Flash it to the Raspberry Pi's SD card using Etcher. In principle, it can handle a wic.bz2 directly but sometimes this doesn't work great. Unzipping it first can help: bzip2 -df xxx.wic.bz2
Image Added
- Currently the image foresees 256MB 256-512 MB of available space to store DAC apps. That is enough for installing several DAC apps. If you want to You can foresee more space, you can do that by resizing the main partition of firmware image partion on the SD card to higher size .(eg 2GB) using Gparted
Image Added
- Insert the SD card back in the RaspberryPi and power up the Pi. Connect the Raspberry Pi to your network with an ethernet cable, and to your TV with a HDMI cable.
- Make sure you can SSH into the Pi as this is important for later. The default user is root with no password
- You should see the RDK Resident GUI application on your TV at bootup (after following some initial setup questions)
...
- . In section X we explain how to use that resident UI to install existing DAC apps. But
Before
use SDK and build your first DAC app
...
As part of the DAC project, an SDK has been created to make it easier to develop and build oci and DAC compliant containerized applications. The SDK is public, fully open source and uses standard Yocto 3.1 Dunfel Poky environment.
It is available on https://github.com/rdkcentral/meta-dac-sdk
Install SDK
The SDK consists of
- manifest that will download Yocto Poky environment with all required meta-layers, see manifest content in https://github.com/rdkcentral/meta-dac-sdk/blob/master/manifests/dac-dunfell-manifest.xml
- meta-dac-sdk meta-layer specifically developed to make building of DAC application easy for Appdeveloper.
- It defined some base classes (dac-image-wayland, dac-image-essos, dac-image-base ) App developer can start from (inherit)
- It links the application to DAC abstraction interfaces (gles2, essos, wayland-egl, rialto) correctly and configures these appropriately.
- It removes that complexity/specific expertise-need from Appdeveloper because:
- SDK links the application to DAC abstraction interfaces (gles2, essos, wayland-egl, rialto) correctly and configures these appropriately.
- A c/c++ application typically depends on several other standard libraries, The SDK automatically adds the correct application dependency tree into the Application Container Image
- As enf of building process the SDK itself generates and outputs an oci compliant Application Container image.
- It comes with various DAC compliant Application container examples. The recipe that defines the Application Container examples are here https://github.com/rdkcentral/meta-dac-sdk/tree/master/recipes-example/images Each one of them is yocto target that you would then build against. We provided some examples for various Graphics frameworks (Flutter, QT, SDL, directly on wayland, directly on essos). Those also have full open-source reference or hello-world application code provided so App developer can understand how App can use/configure Gfx framework so it will work seamlessly with DAC abstraction interfaces.
- build instructions as per https://github.com/rdkcentral/meta-dac-sdk/blob/master/README.md It is best to read the instructions there. They are always the latest because they are maintained together with the rest of the layer. Below is the "setup" part of the SDK.
Code Block |
---|
# Create build directory
mkdir build; cd build
# Install 'repo' tool from: https://android.googlesource.com/tools/repo
repo init -u https://github.com/rdkcentral/meta-dac-sdk/ -m manifests/dac-dunfell-manifest.xml
repo sync --no-clone-bundle -v -j$(getconf _NPROCESSORS_ONLN)
. ./oe-init-build-env
cp ../.repo/manifests/manifests/bblayers.conf conf/
echo 'MACHINE = "raspberrypi4"' >> conf/local.conf |
If everything worked, the SDK is now set up and ready for use. You only need to run these steps the first time you set up the SDK. For subsequent uses, you only need to run the following command to configure the build environment:
Code Block |
---|
cd build
. ./oe-init-build-env |
Multimedia |
---|
name | DAC SDK cobalt24 example.mp4 |
---|
|
...
https://youtu.be/Ie7fQy5HTlc
Publish your DAC app to RDK-M DAC cloud
There are two ways to publish a new application in ASMS:
...
But before publishing the new app into ASMS, you need to publish the oci compliant container image of your DAC application into a container registry that supports the OCI standard format. In next section we explain how to do that.
How to publish the application oci container image to RDK-M oci container registry
You can either publish your oci container image to
...
We provide the instructions for Amazon Elastic Container Registry. The private container registry setup RDK-M DAC team is also such type.
instructions for amazon Elastic Container Registry
You need to have the following util programs installed: aws cli tools and skopeo.
...
Obviously, you have to remember the OCI image URL of your application, which in this example is docker://public.ecr.aws/a0v6o9z7/cobalt:latest. Because you will have to specify it when publishing the DAC app to the ASMS (AppStore Metdata service).
Publish the DAC app using ASMS REST API
You can access the swagger UI here: http://rdkm-asms-external-1156877020.eu-central-1.elb.amazonaws.com:8080/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config
...
Code Block |
---|
|
{
"header": {
"icon": "https://280222515084-default-apps-resources.s3.eu-central-1.amazonaws.com/images/apps/com.rdk.app.chocolate-doom.png",
"name": "Chocolate Doom",
"description": "Chocolate Doom aims to accurately reproduce the original DOS version of Doom and other games based on the Doom engine in a form that can be run on modern computers.",
"type": "application/dac.native",
"size": 10000000,
"category": "application",
"localization": [
{
"languageCode": "nld",
"name": "Geweldige applicatie",
"description": "Dit is een geweldige applicatie"
}
],
"id": "com.rdk.app.chocolate-doom",
"version": "1.0.0",
"visible": true,
"encryption": false,
"preferred": false,
"ociImageUrl": "docker://public.ecr.aws/a0v6o9z7/chocolate-doom:latest"
},
"requirements": {
"dependencies": [
{
"id": "com.libertyglobal.service.voice",
"version": "1.0.0"
}
],
"platform": {
"architecture": "arm",
"variant": "v7",
"os": "linux"
},
"hardware": {
"ram": "512M",
"dmips": "2000",
"persistent": "60M",
"cache": "200M"
},
"features": [
{
"name": "rdk.api.awc",
"version": "2",
"required": false
}
]
},
"maintainer": {
"code": "rdk",
"name": "RDK",
"address": "RDK Management, LLC",
"homepage": "https://rdkcentral.com",
"email": "support@rdkcentral.com"
},
"versions": [
{
"version": "1.0.0",
"visible": true,
"preferred": false,
"encryption": false
}
]
} |
Among other things, dactest.py can be used list ASMS apps, add entries and remove entries.
...
- on your development PC/laptop: install dactest.py dependencies. You need python3 and then pip3 install requests colorama websocket-client
- use ./dactest.py 192.168.0.117 (replace with your RPI IP)
- it will use the RDK ASMS to list apps available from the cloud. Use "A" to start the procedure to add an app to ASMS
- you will need to provide an id, name, version, the OCI image URL (see previous step) and a link to an icon to use. When prompted for "encryption" input "false". Unless you really want to test encrypted DAC apps. But for this feature there is a separate wiki page to read. Extra steps are needed for encryption. You can skip that for now and don't use encryption.
Install and run your DAC app on the Video Accelerator
We explain here 2 ways to download your DAC application from Staging RDK-M DAC Appstore and install it on the video Accelerator :
- via the Resident UI on RDK-Video Accelerator (is the regular, user-friendly way)
- using the dactest.py test tool
Using RDK-VA Resident UI
In the resident UI go to the icon with the 9 small squares (left bottom) to navigate to the DAC menu. There you will see three submenu items:
- My Apps: initially empty. From here you can start installed DAC apps. Use the "Home" key to exit a DAC app.
- App Catalog: these are the DAC apps from ASMS available for installation. If you published your app to ASMS you should see it here.
- Manage Apps: here you can uninstall DAC apps from your RPI
![](/download/attachments/288001739/Screenshot%202023-10-24%20at%2008.55.16.png?version=1&modificationDate=1698222843000&api=v2)
dactest.py can be used list, install, uninstall, start and stop DAC apps. It also connects to RDK ASMS to list available DAC apps in the cloud. The DAC apps downloaded from the cloud are generated to bundles inside that cloud and cached there. Sometimes the download can take a while if the bundle still needs to be generated for a specific platform and/or version.
...