Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Register your application with appropriate metadata in RDK-M DAC cloud system setup for RDK Video Accelerators either via AppStore Admin Portal or directly via ASMS REST APIs. There is microservice called ASMS (AppStore Metadata Service) that offers API that allows Application Maintainers to register their app with appropriate metadata. Once registered this will add you app to the DAC App catalog for RDK-M Video Accelerators (VA) and you will be able to discover your App in the Resident UI of all RDK6.1 Video Accelerators and as user/tester of VA you can then choose to install it on any RDK6.1 VA and once installed you can run it. In the background the RDK-M instance of the DAC cloud system will automatically fetch your oci-AppContainer image, create bundle of it for the specific Video Accelerator Hardware (SoC/OEM), encrypt (optionally) and make it available for Video Accelerator to download and store securely. 

...

Thank you for your assistance.

...

...

 Register App using AppStore Admin portal

AppStore Admin Portal Overview

The AppStore Admin Portal is a user-friendly, intuitive management interface designed by Consult Red for efficient control and administration of your applications and platform configurations. This portal empowers administrators with robust tools to streamline various processes, ensuring smooth operations and optimal performance.

...


Access to the Admin Portal requires credentials (contact dac-info@consult.red) and acceptance of Terms of Use during first login.

register app using AppStore Admin Portal

using WebUI of admin portal, click on specific maintainer (eg "RDK" maintainer)

then click on green "Add" button in upper right corner to add an app. You will get following UI to enter in your application metadata

Image Added 


Register App using ASMS REST API

...

  1. on your development PC/laptop: install dactest.py dependencies. You need python3 and then pip3 install requests colorama websocket-client
  2. use ./dactest.py 192.168.0.117 (replace IP address with your RPI IP)
  3. 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
  4. 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.


List all apps with ASMS API

Swagger API for it see http://rdkm-asms-external-1156877020.eu-central-1.elb.amazonaws.com:8080/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config#/STB/listApplications

concrete call on running instance :

see screenshot

Image Added

 Get DAC bundle URL for specific App via ASMS api

The STB needs to know the location where to download the DAC bundle created by DAC cloud system for a specific app & appversion and for its platform. This section describes the API call to do this.

Remember as per architecture description, the RDK-M instance of the DAC cloud system is responsible for creating appropriate DAC bundle out of oci-image for a specific app & version and make it available for Video Accelerator to download and store securely on certain location URL. That bundle is also specific for certain Video Accelerator Hardware (SoC/OEM) platform, can be encrypted or not (is optional) and is specific for range of firmware versions on that platform, represented by a ID which we call "dacBundleFirmwareCompatibilityKey". See more information on latter here.

So for ASMS to provide right location of a bundle, it needs to get from the requester (STB) the following:

  • the applicationID and app_version : for which application are you requesting a bundle?  And for which version of that application. example for version "1.0.0" of appId "com.rdk.app.flutter-slide-puzzle" is represented by string "com.rdk.app.flutter-slide-puzzle:1.0.0"   If you don't provide version, then default "latest" version is assumed
  • the platformName of the STB as defined in ASMS:  because bundles are specific to specific modeltype. Each CPE modeltype registered in DAC cloud system has a template for autogenerating the appropriate oci run config. The RDK-VA modeltype specific templates are available in https://github.com/stagingrdkm/lgpub/tree/master/dac/templates/oe_3.1 You can find platformName of STB in filename of files listed here example is "7218c". That platformName is also retrievable via LISA (defined in lisa config see  https://code.rdkcentral.com/r/plugins/gitiles/components/generic/rdk-oe/meta-cmf-video/+/refs/heads/rdk-next/recipes-extended/rdkservices/rdkservice-lisa-dac-config.inc  more info see LISA#lisa.dac.confg )
  • dacBundleFirmwareCompatibilityKey:  this is unique ID that represents a set of firmware versions of a given platform for which the same App bundle is guaranteed to keep on working. example for 7218c platform this is the "1.0.0-41abf2fba994b2d04baedeca6d5adf097ece9f79" part of of  "7218c_1.0.0-41abf2fba994b2d04baedeca6d5adf097ece9f79-dbg_dac_configs.tgz" file you see here . You can also retrieval current applicable "dacBundleFirmwareCompatibilityKey" of the STB from LISA when configured correctly in here 

so all together above example becomes request with following input parameters 

  • applicationID: com.rdk.app.flutter-slide-puzzle:1.0.0
  • Platform name:  7218c
  • Firmware version, it's not really the firmware version it is the "dacBundleFirmwareCompatibilityKey" you need enter: 1.0.0-41abf2fba994b2d04baedeca6d5adf097ece9f79-dbg 

So when enter those in tryout in swagger API

http://rdkm-asms-external-1156877020.eu-central-1.elb.amazonaws.com:8080/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config#/STB/getApplicationDetails

you get following output/screenshot of with above example values

Image Added


You can also retrieve directly using following pattern

http://rdkm-asms-external-1156877020.eu-central-1.elb.amazonaws.com:8080/apps/com.rdk.app.flutter-slide-puzzle%3A1.0.0?platformName=7218c&firmwareVer=1.0.0-41abf2fba994b2d04baedeca6d5adf097ece9f79-dbg

The resulting output of above request is all metadata details for that specific app_id and under "url" field is the location of the appropriate bundle. see red circle in screenshot below

Image Added

Install and run your DAC app on the Video Accelerator

...