Skip to end of metadata
Go to start of metadata

INPROGRESS

Overview

An RDK-V Virtual Remote basically focuses on emulating the features of physical RDK remote control unit to provide support to application developers and testers to make there life easier with the new RDK-V Virtual Remote feature. It comes in a form of installer package that can be installed on desktop pc and launched. RDK-V Virtual Remote application starts with all the RCU keys present in physical RDK remote. After application launch, a RDK-V Virtual Remote screen is displayed which mainly contains virtual keys same as RCU keys present in physical rdk remote.

Note: Few RCU keys are not implemented in physical RDK remote, same keys will not work in RDK-V Virtual Remote. Details will be added soon.

Prerequisite

Emulator app manager and Virtual remote has been developed and tested on below environment

  • VS Code: Version-1.63.0

Visual Studio Code is a source-code editor made by Microsoft for Windows, Linux and macOS.

  • Electron: 13.5.2

Electron (formerly known as Atom Shell) is a free and open-source software framework developed and maintained by GitHub. It allows for the development of desktop GUI applications using web technologies: it combines the Chromium rendering engine and the Node. js runtime.

  • Google Chrome: Version 96.0.4664.93 (Official Build) (64-bit)

Google Chrome is a cross-platform web browser developed by Google.

  • Node.js: 14.16.0

Node.js is an open-source, cross-platform, back-end JavaScript runtime environment that runs on the V8 engine and executes JavaScript code outside a web browser.

  • V8: 9.1.269.39-electron.0

V8 is Google's open source high-performance JavaScript and WebAssembly engine, written in C++. It is used in Chrome and in Node.js, among others.

  • OS: Linux x64 5.11.0-41-generic

An operating system is system software that manages computer hardware, software resources, and provides common services for computer programs.

  • Oracle Virtual Box: Version 5.2.42_Ubuntu r137960

          Oracle VM VirtualBox is cross-platform virtualization software.

          and

  • RPI: 3B

Source code setup and Run application

Follow below steps to run application on host pc and create installer package

  • step 1 Use node version v14.18.1 or above

          $ nvm use v14.18.1 

  • step 2 - get the RDK-V Virtual Remote src code (link will be added soon) then run below command

$ npm install

  • step 3 - run below command

$ npm run start     

Create installer package

Follow below steps to create installer package for linux 

  • Need to install electron-packager and electron-installer-debian globally if not installed in your PC

           $ sudo npm install -g electron-packager
           $ sudo npm install -g electron-installer-debian

  • Run below commands to make deb file for linux installer

$ electron-packager .  --platform linux --arch x64 --out dist --overwrite
$ electron-installer-debian --src dist/rdkv-virtual-remote-linux-x64/ --arch amd64 --config config.json

  • Installer package will be created and stored inside the dist folder.

For the complete documentation on electronjs refer link: https://www.electronjs.org/.

Installation

  • Find the installer package created inside the dist folder for the RDKV virtual remote: rdkv-virtual-remote-linux-x64.deb
  • Double click on installer deb package, default linux software install window will appear and progress bar will be displayed
  • On successful installation user/developer will be able to launch RDK-V Virtual Remote by selecting the RDK-V Virtual Remote icon from apps 

Features

Target Device IP Address Configuration

  • Developer has to configure the rpi device/emulator ip address, after device ip configuration virtual remote will be able to communicate with rpi/emulator.


  • On focus button is highlighted as shown in below image.