Difference between revisions of "EFlasher"

From FriendlyARM WiKi
Jump to: navigation, search
(updated by API)
(updated by API)
Line 42: Line 42:
==Commandline Based eFlasher==
==Commandline Based eFlasher==
If your board is not connected to any display device you can login your board via SSH and start the eflahser by running "eflasher". Here is what you expect to observe:<br />
If your board is not connected to any display device you can login your board via SSH and start the eflahser by running "eflasher". Here is what you expect to observe:<br />
<br />
<br />

Revision as of 07:57, 14 January 2019


1 Introduction to eFlasher

The eFlasher (eMMC-flasher) utility is released by FriendlyElec for users to install an OS image on a FriendlyElec board's eMMC easily.
The eFlasher utility provides users with a GUI with multiple OS options.
The eFlasher utility has two versions: eflasher-gui and eflasher-console:
1) eflasher-gui: a GUI based eFlasher utility. When a board is connected to an LCD or HDMI monitor users can use this utility to install an OS easily;
2) eflasher-console: a commandline based eFlasher utility. When a board is connected to a serial terminal or logged in with SSH users can use it to install an OS;

In addition to the above, eFlasher also supports the 4-line Matrix - LCD2USB module, which can be operated by the K1 and K2 buttons on the module, as shown below: Eflahser-lcd2usb.jpg

2 Install eFlasher

  • Step 1: download an eflasher installation package

Go to the wiki page of the nano board you bought and download an eflasher file named as :XXXX-eflasher-YYYYMMDD-full.img.7z(the "XXXX" is the board type for the board you bought and "YYYYMMDD" is the release date of that eflasher file)
This package contains all the image files released by FriendlyElec such as Debian, Android5, Android4.4 and Ubuntu core(different boards may be provided with different OS image files)
Download a XXXX-eflasher-YYYYMMDD-full.img.7z file to a PC host and make an installation SD card with a windows utility: win32diskimager.rar

  • Step 2: make an installation SD card with eflasher

Extract the eflasher file and you will get an ".img" file.Insert an SD card(at least 8G) into a Windows PC and run the win32diskimager utility as administrator. On the utility's main window select your SD card's drive, the wanted image file and click on "write" to start flashing the SD card.
You can use "dd" under a Linux PC to flash this ".img" to your SD card too

  • Step 3: Start eFlasher

Insert this SD card to your board, press and hold the "BOOT" button, power on your board.

3 Update eflasher to the latest version

Execute the following command on the development board:

git clone https://github.com/friendlyarm/eflasher-updater
cd eflasher-updater/

4 Login to the eFlasher system

Log in with the following account in command line:
User Name: root
Password: fa

5 GUI Based eFlasher

By default after eFlash is started the GUI based version will be started. If your board is connected to an LCD or HDMI monitor you will see the following screen:


Select your wanted OS to start installation.

6 Commandline Based eFlasher

If your board is not connected to any display device you can login your board via SSH and start the eflahser by running "eflasher". Here is what you expect to observe:

7 Automate OS Installation at System Startup

You can automate OS installation with eFlasher at system startup in three ways:

  • No.1:on the GUI based eFlasher select your wanted OS and check the "Start automatically at startup" option on the "Ready to Go" window.
  • No.2:mount an SD card to a Windows PC and create an "eflasher.conf" file with notepad on the FAT section of your SD card(or open an existing "eflasher.conf") and type the following lines if you want to install a Debian OS:

The "autoStart" field specifies the path to your ROM. In this example the ROM is a Debian OS image file.

  • No.3:after your board starts open a terminal and create or edit "/mnt/sdcard/eflasher.conf" and type the lines presented in No.2 .

8 Do something else after burning or restoring the system

You may want to do something extra after the installing system is finished, such as lighting up an LED, you can modify the /opt/run-eflasher.sh script in the beginning of the line "./eflasher-gui" to add code, such as the following example, after the installing is completed, set a GPIO pin:

./eflasher-gui -qws >/dev/null 2>&1
echo 13 > /sys/class/gpio/export 
echo out > /sys/class/gpio/gpio13/direction 
echo 0 > /sys/class/gpio/gpio13/value
echo 13 > /sys/class/gpio/unexport

In order for the above script to work properly, we also need to set the eflasher-gui to automatically exit after the installing is completed. The following settings are required:
Edit and create a new file called eflasher.conf with the notepad+ text editor on the Fat partition of the SD card, set the autoExit field to True:


9 Backup & Restore Data on eMMC Flash

This is pretty much like what the GHOST does with Windows. This function can either back up all the data on eMMC to an external storage device or copy all data from an external storage device to eMMC.

For mass production:
This is especially useful for a case in which you have made a system on a board and want to install this system to massive boards. This works for both Android and Linux images.

You need to have an external storage device whose storage is greater than the eMMC Flash. The external storage device should be formatted to exFat or ntfs. In some case eflasher may re-partition your external storage device.

9.1 Backup & Restore Data with GUI Utility

On eflasher's main window click on "Backup and Restore" and proceed with prompts:


9.2 Backup & Restore Data with Commandline Utility

Type the following command to start eflasher on an SSH or serial terminal:

# eflasher

You will see the following menu:

  EFlasher v1.2 b190111 running on NanoPC-T4
    Doc: http://wiki.friendlyarm.com/wiki/index.php/EFlasher
    eMMC: 14.56 GB
  # Select an OS to install:
    1) Android 8
  # Select your backup target device:
     tf) [*] TF card  (/dev/mmcblk0p1 - 4.27 GB free - 5.67 GB total - fuseblk)
    usb) [ ] USB disk  (<none>)
  # Backup eMMC flash to TF card:
    Not enough free disk space on your TF card
  # Restore eMMC flash from backup file:
    No backup files found
  # Configure automatic job:
    aui) Automatic installing (Curr:Off)
    aur) Automatic restoring (Curr:Off)
  # Format drive
    ftf) Format TF card back to original size
>>> Enter an option (1/tf/usb/aui/aur/ftf) :

9.3 Select the storage location of the backup file

You can place the backup file on a TF card, or a USB storage device, using the tf and usb commands to switch.

9.3.1 Backup to TF card

Your TF card size should be greater than or equal to twice the eMMC size. For example, if eMMC is 8G, you should prepare a 16G TF card.
By default, TF cards above 8G do not use all the space in the eFlasher system. You need to do a format once, use the ftf command on the menu.

9.3.2 Backup to USB storage device

The USB storage device is preferably in ext4/exfat/ntfs format. If not, you can use the fud on the menu to format the USB storage device once. Note that this operation will lose all data.

9.3.3 Start backup

Type "bk" and enter to start data backup. All data will be saved in a file with the "raw" extension.

  Backing up eMMC to /mnt/udisk/nanopc-t3-emmc.raw
  Speed: 15.01 MB/s
  Remaining Time: 00:12:53
  [===========_______________________________________]  22%
  >>>If you want to cancel, input "c" then press <Enter> key.

9.4 Additional Functions

EFlasher allows users to write Linux shell scripts to make changes to eMMC's boot partition and file systems. For instance:
1) Add a customized startup LOGO
2) Allocate a static IP or MAC for board
3) Update system with the internet
4) More...
If you have such a script it will be executed after EFlasher backs up eMMC's data.
Your scripts need to be put in a separate directory which should be under the same directory with the backup file. This separate directory should be named as "backup file's name + .d". For instance if the backup file's name is "xxxx.raw" this directory's name should be "xxxx.raw.d".
By default EFlasher will generate a script which will do clearance work such as removing temporary files under the tmp directory and log files under the var directory after backup is done.
You can learn how to access eMMC's boot and root partitions by studying this script.

root@NanoPC-T3:/mnt/udisk/nanopc-t3-emmc.raw.d# tree
|-- cleanup.sh
`-- README.txt
0 directories, 2 files

(Note that this feature does not work when using the auto-restoring feature)

10 Make Your Own eFlasher

10.1 Manage Multiple OS Images with eFlasher

The eFlasher utility reads image files from the FAT section of an SD card. After an SD card is inserted to a Windows PC you can manage multiple OS images that exist in the SD card with eFlasher.
Under the FAT section of an SD card with multiple OS images each directory under the root directory contains an OS image. The name of such a directory should be named with letters or numbers
If the FAT section is not big enough to hold your multiple OS images you can store them in a USB drive with the same structure
For example there are four directories under the FAT section:
They stand for four OS:

Files under an OS directory:
Configuration File:

env.conf environmental variables for setting up uboot and kernel parameters
info.conf system information:

title=Android 5 ---> OS name: Android 5
require-board=s5p4418 ---> SoC: S5P4418, options including S5P6818, H3, A64 etc
version=2016-11-17 ---> ROM's version number(or release date)
icon=androidos.png ---> icon
Here is a screenshot:

Image File:

2ndboot.bin Second Boot
boot.img image file for boot section
bootloader U-Boot
cache.img image file for Android Cache section
system.img image file for system section
userdata.img image file for user data section
partmap.txt description file for partition map

These image files by default are included in an eFlasher file. These files can be downloaded from a board's corresponding wiki site. Usually an image file is located at the images-for-eflasher directory of a server. Here is how a S5P6818's directory looks like:


You can download its image file and extract it to the FAT section of an SD card.

10.2 Make eflasher File with Your OS

Refer to Editing How to make your own SD-bootable ROM

10.3 Connect WiKi in the EFlasher system

Write the following to the configuration file: /etc/wpa_supplicant/wpa_supplicant.conf, where SSID and PASSWORD should be replaced with the router's SSID and password:

ctrl_interface=DIR=/var/run/wpa_supplicant GROUP=netdev

If the WiFi route does not set a password, set key_mgmt to NONE, delete this line: psk=.

11 Update Log

11.1 July-26-2017

  • Released English Version

11.2 August-22-2017

  • Added section 6.2

11.3 March-10-2018

  • Updated sections 6.2 and 6.3

11.4 July-26-2018

  • Added sections 6 and 7.3.2