EBF Setup and Admin Guide

Table of Contents

Supported Operating Systems:

  • Debian 8/9
  • Ubuntu 16.04/16.04.6/18.04.5/20.04.2

Installation Procedure for Debian

Debian download link: Then follow the steps below to install Debian on the target machine.
  1. Allocate at least 60GB of hard disk space.
  2. Leave blank for the domain name.
  3. For partitioning options, we have taken all in a single partition.
  4. Finish partitioning and write changes to disk
  5. Select the debian archive mirror and configure the package manager

    Note: Make sure your machine has a working internet connection.
  6. Select following Software Packages
    1. Debian desktop Environment
    2. GNOME
    3. Print server
    4. SSH server
    5. Standard system utilities
  7. Install Grub bootloader to hard disk
    This completes Debian installation.

Installation Procedure for Ubuntu 16.04/16.04.6

Ubuntu download link:
  1. Allocate at least 2048 Mb system memory and allocate at least 60GB space of hard disk for installation so that OS + Jenkins will work properly.
  2. Select the “Download updates while installing Ubuntu” option to start the installation of Ubuntu and click on the Continue button.
  3. On the next page, select the “Erase disk and install ubuntu” option as Installation type and click on Install Now button.
  4. A dialog box will appear on the screen asking for writing changes to disk, select Continue button.
  5. On the next page, the user will be asked for providing a username and password. Fill in all the required fields and click on the Continue button.

This completes Ubuntu 16.04 OS installation. After installation, the user will be asked to Restart the computer as per instructions.

Installation Procedure for Ubuntu 18.04.5

Ubuntu download link:
  1. Allocate at least 2048 Mb system memory and allocate at least 60GB space of hard disk for installation so that OS + Jenkins will work properly.
  2. Select the "Install Ubuntu" option from the page.
  3. Select Keyboard Layout as per your preference and click on the continue button.
  4. Select the "Minimal Installation" & “Download updates while installing Ubuntu” option to start the installation of Ubuntu and click on the Continue button.
  5. On the next page, select the “Erase disk and install ubuntu” option as Installation type and click on Install Now button.
  6. A dialog box will appear on the screen asking for writing changes to disk, select Continue button.
  7. On the next page, the user will be asked for providing a username and password. Fill in all the required fields and click on the Continue button.

This completes Ubuntu 18.04 OS installation. After installation, the user will be asked to Restart the computer as per instructions.

Installation Procedure for Ubuntu 20.04.2

Ubuntu download link:
  1. Allocate at least 2048 Mb system memory and allocate at least 60GB of space of hard disk for installation so that OS + Jenkins will work properly.
  2. Select the "Install Ubuntu" option from the page.
  3. Select Keyboard Layout as per your preference and click on the continue button.
  4. Select the "Minimal Installation" & “Download updates while installing Ubuntu” options to start the installation of Ubuntu and click on the Continue button.
  5. On the next page, select the “Erase disk and install ubuntu” option as Installation type and click on Install Now button.
  6. A dialog box will appear on the screen asking for writing changes to disk, select Continue button.
  7. On the next page, the user will be asked for providing a username and password. Fill in all the required fields and click on the Continue button.

This completes Ubuntu 20.04 OS installation. After installation, the user will be asked to Restart the computer as per instructions.

EBF Installation Steps

  1. Installer is compressed with 7z compression tool. Follow the below steps to install the 7z tool used to extract the installer files on a Linux machine.
    • sudo apt-get install p7zip-full
  2. Download the latest EBF installer from the download link mentioned below and extract it to the target machine(ubuntu/Debian).
    https://linuxlink.timesys.com/bfc/download/bfc/EBF-Installer-V2.2.2.7z (for EBF)
    https://linuxlink.timesys.com/bfc/download/bfctas/EBF-TAS-Installer-V2.2.2.7z (for EBF-TAS)
  • 7z x EBF-Installer.7z
  1. After extracting the downloaded folder, run the below command:
    • cd EBF-Installer (for EBF)
    • cd EBF-TAS-Installer (for EBF-TAS)
    • ./EBF-Installer.sh (for EBF)
    • ./EBF-TAS-Installer.sh (for EBF-TAS)
      It will ask the user for New Installation or an Upgrade. Choose the New Installation option.
  2. Press ENTER to read the EULA.
  3. To accept the EULA terms, type yes or hit ENTER.
    • Do you accept the EULA terms [yes/no]? [yes] >>>
  4. Hit Enter to disable the HTTPS support.

    OR
    If you want to enable the https support, enter 'Y'.
    • Hit 'Enter' to generate default certificate for 'https' support.
      OR
    • Open a new terminal window and run the following commands to generate the certificate:
      • $ cd /home/
      • $ openssl req -newkey rsa:2048 -nodes -keyout key.pem -x509 -days 365 -out certificate.pem
        Input all the details as asked.
      • When asked for input: 'Common Name (e.g. server FQDN or YOUR name) []:' , enter the IP Address of the current machine (on which EBF is being installed).
      • $ cat certificate.pem key.pem > combined.pem
      • Copy the path of this 'combined.pem' file (/home/combined.pem) and paste it on the ongoing installation terminal window.
  5. Select your current TimeZone.
  6. Installation will start.

EBF installation process without HTTPS supports.

EBF installation process with HTTPS supports.

EBF Upgrade Steps

  • Upgrade to the latest build
  1. Installer is compressed with 7z compression tool. Follow the below steps to install the 7z tool used to extract the installer files on a Linux machine.
    • sudo apt-get install p7zip-full
  2. Download the latest EBF installer folder from the download link mentioned below and extract it to the target machine(Ubuntu/Debian).
    https://linuxlink.timesys.com/bfc/download/bfc/EBF-Installer-V2.2.2.7z (for EBF)
    https://linuxlink.timesys.com/bfc/download/bfctas/EBF-TAS-Installer-V2.2.2.7z (for EBF-TAS)
  • 7z x EBF-Installer.7z (for EBF)
  • 7z x EBF-TAS-Installer.7z (for EBF-TAS)
  1. After extracting the downloaded folder, run the below command.
    • cd EBF-Installer (for EBF)
    • cd EBF-TAS-Installer (for EBF-TAS)
    • ./EBF-Installer.sh (for EBF)
    • ./EBF-TAS-Installer.sh (for EBF-TAS)
      It will ask the user for New Installation or an Upgrade. Choose the upgrade option.
  2. Press ENTER to read the EULA.
  3. To accept the EULA terms, type yes or hit ENTER.
    • Do you accept the EULA terms [yes/no]? [yes] >>>
  4. Hit Enter to disable the HTTPS support.

    OR
    If you want to enable the https support, enter 'Y'.
    • Hit 'Enter' to generate default certificate for 'https' support.
      OR
    • Open a new terminal window and run the following commands to generate the certificate:
      • $ cd /home/
      • $ openssl req -newkey rsa:2048 -nodes -keyout key.pem -x509 -days 365 -out certificate.pem
        Input all the details as asked.
      • When asked for input: 'Common Name (e.g. server FQDN or YOUR name) []:' , enter the IP Address of the current machine (on which EBF is being installed).
      • $ cat certificate.pem key.pem > combined.pem
      • Copy the path of this 'combined.pem' file (/home/combined.pem) and paste it on the ongoing installation terminal window.
  5. Select your current TimeZone.
  6. Installation will start.

EBF Upgrade process.

EBF Backup Steps

Backup of current EBF Server data.
  1. Installer is compressed with 7z compression tool. Follow the below steps to install the 7z tool used to extract the installer files on a Linux machine.
    • sudo apt-get install p7zip-full
  2. Download the latest EBF installer folder from the download link mentioned below and extract it to the target machine(Ubuntu/Debian).
    https://linuxlink.timesys.com/bfc/download/bfc/EBF-Installer-V2.2.2.7z (for EBF)
    https://linuxlink.timesys.com/bfc/download/bfctas/EBF-TAS-Installer-V2.2.2.7z (for EBF-TAS)
    • 7z x EBF-Installer.7z (for EBF)
    • 7z x EBF-TAS-Installer.7z (for EBF-TAS)
  3. After extracting the downloaded folder, run the below command.
    • cd EBF-Installer (for EBF)
    • cd EBF-TAS-Installer (for EBF-TAS)
    • ./EBF-Installer.sh (for EBF)
    • ./EBF-TAS-Installer.sh (for EBF-TAS)
  4. Select option 3 from the recommended option in order to back up the current EBF server.
  5. If you do not want to backup rootfs/kernel images, uploaded during image flashing then type [no] other wise hit 'ENTER'.
  6. After successful backup the user will able to see the confirmation message on the screen with backup name.

Note: The user can restore these backup using restore functionality

EBF Restore Backup Steps

Restore the Backup of EBF Server
  1. Installer is compressed with 7z compression tool. Follow the below steps to install the 7z tool used to extract the installer files on a Linux machine.
    • sudo apt-get install p7zip-full
  2. Download the latest EBF installer folder from the download link mentioned below and extract it to the target machine(Ubuntu/Debian).
    https://linuxlink.timesys.com/bfc/download/bfc/EBF-Installer-V2.2.2.7z (for EBF)
    https://linuxlink.timesys.com/bfc/download/bfctas/EBF-TAS-Installer-V2.2.2.7z (for EBF-TAS)
    • 7z x EBF-Installer.7z (for EBF)
    • 7z x EBF-TAS-Installer.7z (for EBF-TAS)
  3. After extracting the downloaded folder, run the below command.
    • cd EBF-Installer (for EBF)
    • cd EBF-TAS-Installer (for EBF-TAS)
    • ./EBF-Installer.sh (for EBF)
    • ./EBF-TAS-Installer.sh (for EBF-TAS)
  4. Select option 4 from the recommended option in order to restore the backup.
  5. Select the backup from the backup list in order to restore the backup.
  6. if you want to backup the current ebf server then hit "Enter" otherwise type no and hit 'Enter'.
    • If you do not want to backup rootfs/kernel images, uploaded during image flashing then type [no] otherwise hit 'ENTER'.
  7. After successful restore the user will able to see the confirmation message on the screen with backup name.

Change EBF IP

Change EBF IP Steps
  1. Installer is compressed with 7z compression tool. Follow the below steps to install the 7z tool used to extract the installer files on a Linux machine.
    • sudo apt-get install p7zip-full
  2. Download the latest EBF installer folder from the download link mentioned below and extract it to the target machine(Ubuntu/Debian).
    https://linuxlink.timesys.com/bfc/download/bfc/EBF-Installer-V2.2.2.7z (for EBF)
    https://linuxlink.timesys.com/bfc/download/bfctas/EBF-TAS-Installer-V2.2.2.7z (for EBF-TAS)
    • 7z x EBF-Installer.7z (for EBF)
    • 7z x EBF-TAS-Installer.7z (for EBF-TAS)
  3. After extracting the downloaded folder, run the below command.
    • cd EBF-Installer (for EBF)
    • cd EBF-TAS-Installer (for EBF-TAS)
    • ./EBF-Installer.sh (for EBF)
    • ./EBF-TAS-Installer.sh (for EBF-TAS)
  4. Select option 5 from the recommended option to change EBF IP.
  5. After Selection of option no. 5 it will show you EBF current running IP/Domain name on the screen and asks for the new IP/Domain Name.
  6. Provide a New IP/Domain name and wait for confirmation.
  7. After successful IP change a confirmation message will appear on the screen with a new IP address.

Glossary

Embedded Board Farm (EBF): EBF is a tool for Embedded Hardware and/or Software Engineering teams for sharing hardware devices during a product development, maintenance or support cycle.

Basic Architecture

The main components of Timesys EBF are a centrally located Master with the necessary software that forms the core of EBF connected to various Zombies that are placed at various locations around the corporation, as long as the Zombie has network connectivity to the Master.

A Master supports multiple Zombies and each Zombie can support upto four independent Devices (under development/test).

Master: Master presents a web interface to corporate users for connecting to the remote device of their choice, presenting a device console locally on the users machine giving them full access and an experience as if the device is right next to them.

Zombie: This is a timesys supplied hardware. It is placed in remote locations, and comes to life when addressed by the Master. Zombie, normally will execute commands from the Master.

-Each Zombie can support four devices(DUT) that can be allocated to users for a particular duration of use.

IOCX - IO Controller and Expander is a hardware supplied by Timesys. It connects DUT to Zombie for providing SDMUX, Hotplug Ethernet and USB, user controlled GPIO pins and I2C bus.

Device (DUT): It is any physical hardware board, a device or system that a user needs to work on or test.

Device Boot:
The following boot methods are supported:
  • Netboot: This feature, when enabled, allows a device to boot itself from an image stored at a network location. The kernel,rfs and dtb files are files are downloaded to Zombie’s DUT folder by the user and DUT will boot using NFS mount. The kernel and DTB files are loaded using tftp and rfs is loaded using NFS mount.
    Please Note: For network boot, the root file system(rfs) must be on the network which is accessible from the device.
  • SD Card: To boot a board remotely thru SD Card to test new images without human intervention, Timesys has developed an IO Controller and Expander (IOCX) with SDMUX capability.It allows the user to switch the SD Card between Zombie and device through a toggle button available for SDMux. This allows the operation of uploading the images from the user to Zombie when sd card is connected to Zombie side through SDMux.
  • eMMC boot: Many devices support on board NAND and MMC interface.Either interface can be used for booting a system. NAND boot is raw boot, as it reads raw data and manipulate it. MMC boot is FAT boot, as it reads file from mmc sector and manipulated it. eMMC boot can be FAT boot or raw boot.

How to setup EBF

Hardware Connections

  1. Connect device with zombie.
    1. The 2 yellow dots are at ground in Timesys Zombie.
    2. The connections shown in upper image are for 1st DUT. Similar will be the connections for rest of the DUTs and IOCXs.

How to add new device type

Refer Link

How to add a new device

Refer Link

How to edit details of an available device

Refer Link

How to set device-dictionary fields

  1. How to Edit device dictionary
    Refer Link
  2. How to view device-dictionary field
    Refer Link

Manage Power Switch

Refer Link

How to add a Pseudo(Docker) Device

Follow this link to add a Pseudo(Docker) Device using Zombie
Follow this link add a Pseudo(Docker) Device using New Device

Add a Pseudo(Docker) Device using New Zombie

Whenever you add a new zombie on EBF server a pseudo device will automatically be added to the EBF.
  1. How to Add New Zombie on EBF Server.follow this section
  2. Select ‘All Device’ option from ‘Devices’ drop down list to view Automatically added Pseudo Device on EBF server.

Add a Pseudo(Docker) Device using New Device

Following are the steps to add more pseudo-device to the EBF-TAS server:
  1. Login to EBF home page/dashboard (find your URL from the administrator) through a web browser with your credentials
    Username : <username>
    Password : <password>
  2. This would open up EBF Dashboard.
  3. Select the ‘New Device’ option from the ‘Devices’ drop-down list.
  4. ‘Add New Device’ page will appear on the screen.

    Fill in the necessary fields available on the screen:

    A Newly added Pseudo/Docker Device will appear after submitting the data.

How to Configure E-mail for Test Job

  1. Go to the terminal of the machine on which EBF is running.
  2. Add below settings to /data/timesys/bfc-tas/setup/settings.conf (for EBF-TAS) file:
    "SERVER_EMAIL": <Timesys Server Email>,
    "EMAIL_HOST": "smtp.gmail.com",
    "EMAIL_PORT": 587,
    "EMAIL_USE_TLS": true,
    "EMAIL_HOST_USER": <Timesys Server Email>,
    "EMAIL_HOST_PASSWORD": <Timesys SMTP Email A/c password>
  3. Reboot the machine
    OR
    Restart the docker-container to implement these changes.
    $ cd /data/timesys/bfc/ (for EBF)
    $ cd /data/timesys/bfc-tas/ (for EBF-TAS)
    $ docker-compose down
    $ docker-compose up

How to Add Users

Following are the steps to add users:
  1. Sign in to EBF homepage/dashboard using your credentials.
  2. Select the ‘Administration’ option from the ‘admin’ drop-down list.
  3. ‘Users‘ option is available under the Authentication and Authorization section on the Administration page.
  4. Select the ‘+Add’ option for adding a new user.
  5. Add user page will appear on the screen.
  6. Enter username and password details of a new user.
    Username:<Username Required>
    Password:<password for new user>
  7. After filling in all the details, click on the 'Save and continue editing' button.
  8. Provide privileges to the new user from the given Permissions section.
  9. After entering all the details, click on the 'Save' button.
  10. The newly added user will be shown on the screen.

User Permissions

The following are the permissions w.r.t different user types:

Permissions Anonymous(Non-logged users) Developer Admin
View Home screen
View Zombies
View DUTs
View Test Jobs (TAS only)
View Test Job Results & Job definition YAML (TAS only)
View Test Job execution Logs (TAS only)
View Charts & Graphical Reports (TAS only)
Launch DUT Console of allocated DUT
Power control (On/Off/Reboot) of allocated DUT
Upload SD card image on allocated DUT
Allocate free DUT
Release allocated DUT
View all own allocated DUTs
View all DUTs and current allocations
Submit & Re-submit Test Job (TAS only)
Download Test Results (TAS only)
Add/Edit/Delete Charts (TAS only)
Forced Release of allocated DUTs
Add DUT
View/Add/Edit/Delete Authorization tokens*
Add Zombie
Add Users
Access to Admin interface
Edit Zombie Description on Home screen
Edit/Delete chart(s) created by any user

There are three types of users with respect to their roles and permission. The admin has the access to add all types of users according to their respective permissions.

  1. Anonymous user is a non-logged user.
  2. Admin User
    For admin user, select the following options:
  3. Developer
    For selecting a user as Developer, go to the Group section and select the ‘Developer’ option from the available user and move to chosen groups.

After selecting the user as per the permission, select the Save button available at the bottom of the page.

The new user is added and the new user can sign in to the EBF server with their respective credentials

Change user's permissions

Following are the steps to change user privileges assigned to any user:
  1. Sign in to EBF homepage/dashboard using admin credentials.
  2. Select the ‘Administration’ option from the ‘admin’ drop-down list.
  3. ‘Users‘ option is available under the Authentication and Authorization section on the Administration page.
  4. Select the ‘Change’ option for editing details of an available user.
  5. List of available users will be shown on the screen. Click on the name of the user whose details are to be edited.
  6. Change privileges of the user from the given Permissions section.
  7. Then click on the 'Save' button to save the changes.

How to Delete a user.

Following are the steps to delete an available user:
  1. Sign in to EBF homepage/dashboard using admin credentials.
  2. Select the ‘Administration’ option from the ‘admin’ drop-down list.
  3. ‘Users‘ option is available under the Authentication and Authorization section on the Administration page.
  4. Select the ‘Change’ option for editing details of an available user.
  5. List of available users will be shown on the screen. Click on the name of the user whom you want to delete.
  6. At the bottom of the page, click on the 'Delete' button.
  7. Confirm the delete.
  8. Selected user will be deleted.

How to change any user's password in EBF

Following are the steps to change the password of any available user:
  1. Sign in to EBF homepage/dashboard using admin credentials.
  2. Select ‘Administration’ option from ‘admin’ drop down list.
  3. ‘Users‘ option is available under Authentication and Authorization section on Administration page.
  4. Select ‘Change’ option for editing details of an available user.
  5. List of available users will be shown on the screen. Click on the name of the user whose password you want to change.
  6. On this page, click on 'this form' link in the Password section.
  7. Input the new password details and click on 'Change Password' button.
  8. A 'Password changed successfully' notification message will be shown on the screen.

How to Retire and Activate Device

To Retire a device
  1. In order to retire an active device, the target device must not be allocated to anyone.
  2. Click on the 'Retire' icon present in the 'Actions' column adjacent to the target device that you want to retire.
  3. After the device is retired successfully, the 'Device Status' is changed to 'Retired' as shown in the below image.
To Activate a retired device
  1. Click on the 'Activate' icon present in the 'Actions' column adjacent to the target device that you want to activate.
  2. The activated device is now ready to be assigned to any user.

How to Install Zombie

  1. Zombie image is compressed with 7z compression tool, follow the below steps to install and extract installer files on Linux machine.
    • sudo apt-get install p7zip-full
  2. Download the latest Zombie image from the link mentioned below:
    https://linuxlink.timesys.com/bfc/download/zombie/Zombie_V2.2.2.img.7z
  3. Extract the image from the downloaded files by running the below command:
    • 7z x <file_name>.7z
  4. Flash the extracted image into a 32GB sd card.
    • dd if=./<file_name>.img of=/dev/sdX bs=4M status=progress conv=fsync

After flashing image into SD Card, boot the board using this newly created sd-card and login into Zombie E-Z Config with the default username and password to reconfigure the Zombie.

How to Upgrade Zombie

  1. To Upgrade Zombie to a newer version, prefer to take the backup of current settings. Refer Link
  2. Zombie image is compressed with 7z compression tool, follow the below steps to install and extract installer files on Linux machine.
    • sudo apt-get install p7zip-full
  3. Download the latest Zombie image from the link mentioned below:
    https://linuxlink.timesys.com/bfc/download/zombie/Zombie_V2.2.2.img.7z
  4. Extract the image from the downloaded files by running the below command:
    • 7z x <file_name>.7z
  5. Flash the extracted image into a 32GB sd card.
    • dd if=./<file_name>.img of=/dev/sdX bs=4M status=progress conv=fsync
  6. After flashing image into SD Card, boot the board using this newly created sd-card and login into Zombie E-Z Config with the default username and password to reconfigure the Zombie.
  7. To restore Zombie settings to the last saved configuration, Refer Link

How to configure Zombie through Zombie E-Z Config

Following are the steps to start Hotspot part for Zombie E-Z Config application:
  1. Connect to wireless hotspot as set initially.
    Host id: TimesysZombie-Wifi
    Password: admin123
  2. Launch Zombie E-Z Config UI with URL 10.10.10.10
  3. If logging in for the first time, the default credentials are:
    Username: admin
    Password: admin123

    NOTE: Non-admin user can only view details of the page by selecting View Status option
  4. Zombie Network Settings page will appear on the screen. Also, the user can change the Zombie Timezone from this page.
  5. On Zombie Network Settings page, change 'Zombie Hostname', set 'Zombie IP Address' to any available IP Address and input all the other details.
  6. Then click on 'Save' button.
  7. Also from the left navigation, select the page in which the user wants to make any changes.
  8. Reboot the Zombie to apply all the changes.
    1. Zombie Status: Displays status of Zombie and connected devices.
    2. Zombie Network Settings: To configure a new Zombie with hostname, Zombie IP address, Gateway IP, Master IP address, follow these steps to update Network Settings page.
    3. Device Under Test (DUT): To change the serial settings of a page, follow these steps
    4. Advanced Settings: To change the path for TFTP, NFS directory, udev entries for serial port follow these steps.
    5. Create New User: Admin user can create a new user by following these steps.
    6. Maintenance: Backup/Import Zombie settings.
    7. Default Settings: Reset Zombie settings to initial shipped-in state.
    8. Reset Password: Admin user can change the password by following these steps.

How to Install APP Zombie

  1. APP Zombie image is compressed with 7z compression tool, follow the below steps to install and extract installer files on Linux machine.
    • sudo apt-get install p7zip-full
  2. Download the latest App-Zombie image from the link mentioned below:
    https://linuxlink.timesys.com/bfc/download/appzombie/APP-Zombie_V2.2.2.img.7z
  3. Extract the image from the downloaded files by running the below command:
    • 7z x <file_name>.img
  4. Flash the extraced image into a 32GB sd card.
    • dd if=./<file_name>.img of=/dev/sdX bs=4M status=progress conv=fsync

After flashing image into the SD Card, boot the board using this newly created sd-card and login into APP Zombie E-Z Config with the default username and password to reconfigure the Zombie.

How to Upgrade APP Zombie.

Same steps as installation.

How to configure APP Zombie through APP-Zombie E-Z Config

Following are the steps to start the Hotspot part for the APP-Zombie E-Z Config application:
  1. Connect to wireless hotspot as it set initially.
    Host id: TimesysAPP-Wifi
    Password: admin123
  2. Launch Zombie E-Z Config UI with URL 10.10.10.10
  3. If logging in for the first time, the default credentials are:
    Username: admin
    Password: admin123

    NOTE: Non-admin user can only view details of the page by selecting the View Status option
  4. APP Network Settings page will appear on the screen. Also, the user can change the APP-Zombie Timezone from this page.
  5. On the App Network Settings page, change 'APP Hostname' and set 'APP IP Address' to any available IP Address, and input all the other details.
  6. Then click on the 'Save' button.
  7. From the left navigation, select the page in which the user wants to make any changes.
  8. Reboot APP Zombie to apply all the changes.
    1. App Zombie Status: Displays status of App-Zombie and connected devices.
    2. APP Network Settings: To configure a new APP Zombie with hostname, IP address, Gateway IP, Netmask, APP WiFi channel and Timezone.
    3. Live Streaming Settings: Here you can provide the resolution for streaming, the port number on which video will stream and the quality percentage.
    4. Image Capture Settings: Here you can provide the resolution of the image to be captured.
    5. Audio Settings: You can set the port on which the mic is connected.
    6. USB Device Sharing Settings: Here you can switch the USB device sharing tool between USB/IP and USB network gate.
    7. Create New User: Admin user can create a new user.
    8. Maintenance: Backup/Import Zombie settings.
    9. Default Settings: Reset Zombie settings to initial shipped-in state.
    10. Reset Password: Admin users can change the password.

APP-Zombie Security

Enable HTTPS

Following are the steps to enable HTTPS on APP-Zombie for Secure Video Streaming access:

If you are using EBF over HTTPS, Please upload the SSL key and certificate files here and reboot APP-Zombie to use the USB WebCam Video Streaming feature.

  • From the local machine terminal, run the following command:
    • $ sudo openssl req -newkey rsa:2048 -new -nodes -x509 -days 3650 -keyout pad.js.key -out pad.js.crt
    • Input all the details as asked.
    • In the field: 'Common Name (e.g. server FQDN or YOUR name) []:' ,enter the IP Address of the Zombie set in the previous step.
    • Now 2 files are generated, namely 'pad.js.crt' and 'pad.js.key'.
    • Rename the 'pad.js.crt' file for Example <file_name>.crt.
    • Rename the 'pad.js.key' file for Example <file_name>.key.
  • From the left navigation, click on 'Security' option.
  • The APP-Zombie Security page will be shown on the screen.
  • In the 'SSL Key File' section, click on the 'Choose file' button and upload '<file_name>.key' file.
  • In the 'SSL Certificate File' section, click on the 'Choose file' button and upload '<file_name>.crt' file.
  • After Successful file upload reboot APP-Zombie to use the USB WebCam Video Streaming feature.

How to add a new Zombie on EBF Server

Following are the steps to add a new Zombie on the EBF server:
  1. Login to EBF dashboard through web browser using admin credentials.
    Username : <username>
    Password : <password>
  2. EBF Dashboard will appear on the screen.
    1. Select the ‘New Zombie’ option from the ‘Zombies’ drop-down list.
  3. ‘Add New Zombie’ page will appear on the screen.
  4. Fill the necessary fields available on the screen.
    • Zombie IP : <Zombie Corporate IP>
    • App Zombie IP : <App Zombie Corporate IP>
  5. After entering the details, click on 'Submit' button.
    NOTE: Tick the web-cam checkbox, if a camera is connected to the AppZombie (Optional).
  6. A confirmation message will be displayed on the screen to confirm that new Zombie has been added.

How to edit details of an existing Zombie

Following are the steps to edit the details of added Zombie on EBF server:
  1. Click on the ‘Edit Zombie’ option from the ‘Zombies’ drop-down list on EBF Dashboard to edit Zombie details.
  2. Select the Zombie from drop-down list on the ‘Select Zombie’ page to edit Zombie details.
  3. ‘Manage Zombie’ page will appear on the screen. Edit the Zombie details and click on the 'Submit' button.
    NOTE: Tick the web-cam checkbox, if a camera is connected to the AppZombie (Optional).
  4. A confirmation message of updated Zombie details will be displayed on the screen.

Launch Zombie E-Z Config application

The following are the ways to launch Zombie E-Z Config application:

  1. Click on ‘Edit Zombie’ option from ‘Zombies’ drop down list on EBF Dashboard to edit Zombie details.
  2. Select the Zombie from drop down list on ‘Select Zombie’ page to launch Zombie E-Z config application of that Zombie.
  3. ‘Manage Zombie’ page will appear on the screen.
  4. Select 'Launch Zombie E-Z Config' button. In the new tab, the user is directed to Zombie E-Z Config application of the selected Zombie.
  5. Enter Username and password and select Login button to login to Zombie E-Z Config application.

How to add a New Device Type

A device type is a generic description of a device and identifies different qualities of that device.
In EBF, a particular DUT is an instance of a device type. For example, if beaglebone-black is a device type, then it can have many device instances like bbb01, bbb02, BBB, etc that share the same device type with the same set of commands.

When adding a device, a device type needs to be added corresponding to the device to be added. The device type can be added only by the admin.

For example:
Following are the steps to add a new Device type on the EBF server:

  1. Login to EBF homepage/Dashboard through a web browser with credentials.
    Username : <Username>
    Password : <Password>
  2. This would open EBF home page. Select ‘New Device type’ option from ‘Devices’ drop down list.
  3. ‘Add New Device Type’ page will appear on the screen.
  4. Fill all the fields available on the screen.
    1. Name:<Device type name>
    2. Device Type Template: Valid definition for device type.

Must Parameters in Device type template

{% extends 'base-uboot.jinja2' %}
{% set device_type = "" %}

Specifications:

extends 'base-uboot.jinja2' - The device type extends base-uboot.jinja2 available in device-type folder.

set device_type = "" - Provide a unique name for device type in this section

After filling in all the fields click on the ‘Submit button.

The device type will be added to the EBF server.

How to edit details of a Device type

Following are the steps to edit the details of added Device type on the EBF server:
  1. Select the ‘Edit Device Type’ option from the ‘Devices’ drop-down list on the EBF dashboard to edit Device type details.
  2. Select Device type from the drop-down list on the ‘Select Device type’ page to edit Device type details.
  3. ‘Manage Device Type’ page will appear on the screen. Edit the Device type details.
  4. Click on the ‘Submit’ button and details of Device type is edited and saved.
  5. Device type details are saved and updated.

How to edit Device type Template

  1. Log into EBF server using a web browser through web credentials.
    Username: <admin username>
    Password:<password>
  2. Go to Devices -> Edit Device Type. Select the device type for which device type template needs to be edited. The device type page will appear on the screen.
  3. The device type template has the following parameters by default while adding a new device type.

    Must Parameters in Device type template
    {% extends 'base-uboot.jinja2' %}
    {% set device_type = "am335x" %}
    

    Specifications:
    extends 'base-uboot.jinja2' - The device type extends base-uboot.jinja2 available in device-type folder.
    set device_type = "" - Provide a unique name for device type in this section
    Other optional parameters with example for reference
    {% set console_device = console_device|default('ttyS0') %}
    {% set baud_rate = baud_rate|default(115200) %}
    {% set bootloader_prompt = bootloader_prompt|default('U-Boot') %}
    {% set bootm_kernel_addr = '0x82000000' %}
    {% set bootm_ramdisk_addr = '0x81600000' %}
    {% set bootm_dtb_addr = '0x88000000' %}
    {% set bootz_kernel_addr = '0x82000000' %}
    {% set bootz_ramdisk_addr = '0x83000000' %}
    {% set bootz_dtb_addr = '0x88000000' %}
    {% set uboot_mkimage_arch = 'arm' %}
    

    Specifications:
    Console device: The device serial port is defined in this console device section. For reference “ttyS0” is taken as console port in this example.
    set console_device = console_device|default('ttyS0')
    Baud Rate: Baud rate depends on the device used.For reference in this example, baud rate is set to 115200. Other “standard” baud are 1200, 2400, 4800, 9600, 19200, 38400 and 57600.
    set baud_rate = baud_rate|default(115200)
    Bootloader Prompt: The user can set bootloader prompt when board first boots up. What prompt does device gets bootloader, that needs to be mentioned here. Example: In this case, “U-boot” is used as bootloader prompt.
    set bootloader_prompt = bootloader_prompt|default('U-Boot')
    Bootm kernel address, ramdisk address, dtb address: Set device kernel address, dtb address and ramdisk address.
    Here Kernel file address needs to be mentioned for the device. bootm_kernel_addr is used when the kernel image type is uImage. This can be checked from the artifacts of the device build.
    set bootm_kernel_addr = '0x82000000'
    Here dtb file address needs to be mentioned for the device. bootm_dtb_addr is used when the kernel image type is uImage. This can be checked from the artifacts of the device build.
    set bootm_ramdisk_addr = '0x81600000'
    set bootm_dtb_addr = '0x88000000'
    Bootz kernel address, ramdisk address, dtb address: Set device kernel address, dtb address and ramdisk address.Here kernel file address needs to be mentioned for the device. bootz_dtb_addr is used when the kernel image type is zImage. This can be checked from the artifacts of the device build.
    set bootz_kernel_addr = '0x82000000'
    Here dtb file address needs to be mentioned for the device. bootz_dtb_addr is used when the kernel image type is zImage. This can be checked from the artifacts of the device build.
    set bootz_ramdisk_addr = '0x83000000'
    set bootz_dtb_addr = '0x88000000'
    Uboot_mkimage_arch: The uboot_mkimage_arch value will need to be set according to the requirements of the device.
    Most ARMv7 devices will use arm as the architecture and most ARMv8 devices will use arm64, but this is not always the case. For example, the APM Mustang is an arm64 device but the U-Boot build on the Mustang pre-dates arm64 support in mainline U-Boot. It uses:
    set uboot_mkimage_arch = 'arm'

How to create a new user in Zombie E-Z Config

A new user can be created by an Admin user. The admin user can create a new user using the following steps:

  1. Login to Zombie E-Z config using admin credentials.
    Username: <admin name>
    Password:<Admin Password>
  2. In the left navigation pane, select the 'Create New User' option to register a new user.
  3. Register New User page will appear on the screen. Provide Username and password for registering a new user. The username must be unique.
  4. After providing Username and password, click on the Register button. The new user is created successfully.
  5. After selecting the Register button, a message that the new User created successfully appears on the screen.

    NOTE: If a username already exists, then on selecting the Register button a message will appear on the screen.
  6. Re verify by logging in using new user credentials.

Reset Password of existing User in Zombie E-Z Config

The user can reset the password of their own or another user using the following steps:

  1. Login to Zombie E-Z config using user credentials.
    Username: <Username>
    Password:<User Password>
  2. In the left navigation pane, select Create New User option to Reset the password of an existing user.
  3. Select Reset Password radio button available on Register New User page.
  4. Enter existing Username and enter new password.
  5. A confirmation message of password changed will appear on the screen.
  6. Re verify the new password by logging in to the Zombie E-Z Config application.

How to Backup/Import Zombie Settings

When Zombie SD card is re-flashed Zombie settings are lost. To preserve and import them again, you can use this Backup and Import feature.

How to Backup Zombie Settings

  1. Login to Zombie E-Z config using user credentials.
    Username: <Username>
    Password:<User Password>
  2. Click on the 'Maintenance' link on the left navigation panel.
  3. Click on 'Backup Current Settings' button to preserve current Zombie EZ-config settings.
  4. A confirmation message of successful backup will be shown on the screen.

How to Import Zombie Settings

  1. Login to Zombie E-Z config using user credentials.
    Username: <Username>
    Password:<User Password>
  2. Click on the 'Maintenance' link on the left navigation panel
  3. Click on the 'Import Backedup Settings' button to load the historically preserved setting into Zombie EZ-config.
  4. Importing of settings will begin and a message is shown on the screen as follows:
  5. A confirmation message of successful import will be shown on the screen.
  6. You will be redirected to the 'Zombie Status' screen.
  7. Click on the 'Reboot' link on the left navigation panel for the imported settings to take effect.

How To setup Live Streaming

Hardware Connection

  1. Connect Local Lan of Zombie and APP-Zombie using an ethernet cable.
  2. Connect NC-450 Webcam LAN to local LAN of APP-Zombie.
  3. Connect Power Supply to NC-450 cam.
  4. After successfully getting the DHCP IP through local LAN NC450's LED light would turn “Green”.

How to Configure NC-450 for Live Streaming

  1. If the NC-450 webcam is connected successfully you will see its entry in the APP-Zombie status page as below.
  2. Click on the settings icon of the newly added NC450 device.
  3. Use default credentials, admin/admin, to login into the NC450 configuration portal.
  4. Immediately on login you will be prompted to change the password. Change admin password to admin123
  5. After password change either log out of the NC-450 portal or close the browser tab running it.

How to Connect a USB webcam for live streaming

  1. Connect Local Lan of Zombie and APP-Zombie using an ethernet cable.
  2. Connect USB Webcam to USB port of APP-Zombie for live streaming.

How to Configure USB webcam for live streaming

Following are the steps to configure USB webcam on the EBF server:
  1. Login to EBF dashboard through a web browser using admin credentials.
    Username : <username>
    Password : <password>
  2. Click on the ‘Edit Zombie’ option from the ‘Zombies’ drop-down list on EBF Dashboard to edit Zombie details.
  3. Select the Zombie from the drop-down list on the ‘Select Zombie’ page to edit Zombie details.
  4. Tick the USB webcam checkbox if a camera is connected to the APP Zombie.
  5. A confirmation message of updated Zombie details will be displayed on the screen.
  6. Follow: How to access USB webcam Live Streaming.

How to Connect a USB webcam for Image Capture

  1. Connect Local Lan of Zombie and APP-Zombie using an ethernet cable.
  2. Connect USB Webcam to USB port of APP-Zombie for image capture.

How to Configure USB webcam for Image Capture

Following are the steps to configure a USB webcam on the EBF server:
  1. Login to EBF dashboard through a web browser using admin credentials.
    Username : <username>
    Password : <password>
  2. Click on the ‘Edit Zombie’ option from the ‘Zombies’ drop-down list on EBF Dashboard to edit Zombie details.
  3. Select the Zombie from the drop-down list on the ‘Select Zombie’ page to edit Zombie details.
  4. Tick the USB webcam checkbox for image capture, if a camera is connected to the APP Zombie then click on submit button.
  5. A confirmation message of updated Zombie details will be displayed on the screen.
  6. Follow: How to capture image from USB webcam

How To Setup USB Network Gate

Setup Network Gate on Zombie E-Z Config

  1. Launch the Zombie E-Z Config on any web browser(CHROME, FIREFOX, INTERNET EXPLORER) to do this and navigate to the following URL.
  2. Login to the Zombie E-Z Config application with the credentials:
    Username:<Admin Username>(admin)
    Password:<Password for Admin>(admin123)
  3. Now from the left navigation panel click on advance settings.
  4. On Next age click on the 'Edit' check box to edit detail on Zombie E-Z Config.
  5. Now change the USB share tool from USB/IP to USB Network Gate and then after that save the settings.
  6. From the left navigation panel click on zombie status.
  7. On the status page go to the USB device section and click on the Un-Licensed.
  8. Now provide the registration name and activation code then click on activate button to activate the USB Network Gate licensed.
  9. After successful code activation you will able to share and un-share the USB device.

**NOTE only one device can be shared at a time.

Setup Network gate on APP-Zombie

  1. Launch the APP-Zombie E-Z Config on any web browser(CHROME, FIREFOX, INTERNET EXPLORER) to do this and navigate to the following URL.
  2. Login to the APP-Zombie E-Z application with the credentials:
    Username:<Admin Username>(admin)
    Password:<Password for Admin>(admin123)
  3. Now from the left navigation panel click on the 'USB Device Sharing Settings'.
  4. Now change the USB share tool from USB/IP to USB Network Gate and then after that save the settings.
  5. From the left navigation panel click on APP-Zombie status.
  6. On the status page go to the USB device section and click on the Un-Licensed.
  7. Now provide the registration name and activation code then click on activate button to activate the USB Network Gate licensed.
  8. After successful code activation you will able to share and un-share the USB device.

**NOTE only one device can be shared at a time.