Versions Compared

Key

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

...

The contents of this document are RDK Management, LLC Proprietary and Confidential and may not be distributed or otherwise disclosed without prior written permission of RDK Management, LLC.

Document Status 

...


Document Title

RDK Emulator Users Guide

Version


Date

18/11/2021

Table of Contents

...

Table of Contents

...

The RDK emulator is an x86 based implementation of the RDK software stack. It is primarily targeted towards the RDK development community (integrators, component developers and application developers) that attempts to simplify the process of working with the RDK software stack without the need for a reference hardware platform.  The key applications in the RDK Emulator are the rmfApp, Media streamer and the RDK-Browser. As RDK emulator runs on desktop computers, applications can be tested and debugged before trying to deploy them to real devices.

Purpose of this Document

...

The purpose of this document is to enable RDK users and developers to be able to bring up the RDK stack and emulator on the PC platform. The document also includes step-by-step procedures to setup & build RDK Emulator

...

The following table describes the acronyms and abbreviations used in this document

Abbreviation/Acronym

Description

RDK

Reference Development Kit

VM

Virtual Machine

VBox

Virtual Box

QAM

Quadrature Amplitude Modulation

STB

Set Top Box

XRE

Cross-Platform Runtime Environment

HDD

Hard Disk Drive

EOS

End of Stream

SPTS

Single Program Transport Stream

MPTS

Multi-Program Transport Stream

UPNP

Universal Plug and Play

Overview of RDK Emulator

...

  • Executes on x86-based platforms including virtualization environments such as Virtual Box and QEMU.
  • Built using Yocto and RDK build frameworks
  • RDK-B Emulator runs RDK-B stack on PC platform, validated through the virtual box based virtualization platform  .

  • Hardware Abstraction Layer supporting Ethernet and Wi-Fi functionalities are introduced to adopt the PC platform.

  • Wi-Fi Hotspot support through external wireless adapter.USB to Ethernet Adapter is used for Ethernet LAN connections.

  • Support of advance configurations like firewall, parental control, WAN Manager and remote management etc ...

Supported Build Types

...


Build Types

RDK Components Involved

Features/Applications Supported

Final Image Name

Startup Application

RDK Emulator Dunfell
rdk-generic-broadband-image
  1. rdklogger
  2. utopia
  3. ccsp components
  1. Wan Manager 
rdkbrowser
  1. parental control
  2. firewall
  3. Remote Managment
  4. yocto 3.1, dunfell

rdk-generic-broadband-image-qemux86broadband.wic.vmdk 

RDK-Browser

WebUI configuration

Build Setup Instructions

...

Setting up the Host Environment

...

Downloading Source Code & Building

...

RDK-B Emulator Dunfell Build Instructions

Bringing up the Emulator on Virtual Box

...

Host Requirements

RequirementRemarks
Linux                           32/64 bit Ubuntu 16.04 operating system
Free HDD SpaceMinimum 100GB Free Memory
Oracle Virtual Box4.3.18 or higher

Install Virtual Box and follow the following steps to bring up RDK Emulator on Virtual Box:

...

  • Open Virtualbox

  • Select New [A popup will come up]

  • Select Type as ‘Linux’

  • Select Version as ‘Other Linux (32 Bit)’

  • Click on “Next”

...

  • Image Added


  • Choose a Memory Size of 512 MB

           Image AddedImage Removed

  • Use an existing virtual hard drive file which would be your newly built image in *.vmdk format and create your VM:

Image Removed           Image Added

STEP 2: Configure your new VM Instance:

  • Click on “Settings” tab to configure your new VM instance

Image Removed          Image Added

  • Configure your VMs network settings
  • Choose “Bridged Adapter” mode as shown in the screenshot below

Image Removed        Image Added

STEP 3: Run Emulator in Vbox :

  • Boot up your VM by clicking on start
  • Once you have the IP address you may SSH into your VM from your linux shell console. Use root as the ssh user.

Usage Instructions

...

Logging into your VM

...

As described in the previous section, you can log in to your emulator VM from your Host Machine using the ssh command.

$ ssh root@x.x.x.x

Note: In order to learn the IP address of your VM, use the RDK Browser application “tab” key to navigate to "Device Info" which will provide you the IP address. Press "Enter" key to enter Device Info

...

1        Once VMware Player is installed, open the VMWare Player  using the command

vmplayer &  or open using GUI

2       Click File --> Create a New Virtual Machine --> Select  'i will install my operating system later' --> click Next

...