Difference between revisions of "APITestPage"

From FriendlyELEC WiKi
Jump to: navigation, search
(updated by API)
(updated by API)
 
(101 intermediate revisions by the same user not shown)
Line 1: Line 1:
====Install OS to eMMC====
+
 
=====Option 1: Install OS on Web Page=====
+
{{RockchipUnbrick|NanoPC-T4}}
Get a TF card which has been installed with FriendlyWrt, log in FriendlyWrt on the web page, click on “System” ->”eMMC Tools”. Click on “Select file” to select your wanted image file, either an official image (the name might start with “rk3399-sd”) or a third party image. The file should be a “.gz” or “.img” file.<br/>
+
After a file is selected, click on “Upload and Write” to start installing an OS.<br/>
+
[[File:Friendlywrt-emmctools2-en.png|frameless|600px]]<br/>
+
After installation is done, eject the SD card, the system will automatically reboot and load the OS from eMMC. After the OS begins to load, if the system LED is flashing and the network LED is on, it means the the OS has loaded successfully. If the OS is FriendlyWrt, you can click on “Go to Homepage” to enter the homepage. <br/>
+
Note that if you are burning the FriendlyElec firmware, you need to use an image file with the "-sd-" file name, similar to the one below:
+
{| class="wikitable"
+
|-
+
  | rk3399-sd-friendlywrt-21.02-YYYYMMDD.img.gz
+
|-
+
  | rk3399-sd-friendlywrt-21.02-docker-YYYYMMDD.img.gz
+
|}
+
If the file is in 7z, zip or rar format, you will need to extract it first. If the file is too large to write, you can compress it into .gz format and try again.
+
=====Option 2: Install OS via TF Card=====
+
======Install OS to eMMC======
+
* This method firstly boots a mini Linux from a TF card and then automatically runs an EFlasher utility to install the OS to eMMC.<br />
+
* You can watch its progress by observing its LEDs as well.<br />
+
Visit [http://download.friendlyelec.com/{{#replace:{{#replace:{{BASEPAGENAME}}| |}}|/zh|}} download link] to download the needed utilities and image file:<br />
+
{| class="wikitable"
+
|-
+
  | colspan=2 | '''Image File'''
+
|-
+
  | rk3399-eflasher-friendlywrt-21.02-YYYYMMDD.img.gz
+
  | '''[[How to Build FriendlyWrt|FriendlyWrt]]'''<br/>Based on OpenWrt 21.02.3<br />Kernel version 5.15.y
+
|-
+
  | rk3399-eflasher-friendlywrt-21.02-docker-YYYYMMDD.img.gz
+
  | '''[[How to Build FriendlyWrt|FriendlyWrt]]'''<br/>Pre-installed Docker<br />Based on OpenWrt 21.02.3<br />Kernel version 5.15.y
+
|-
+
  | rk3399-eflasher-debian-buster-desktop-arm64-YYYYMMDD.img.gz
+
  | '''Debian 10(buster) Desktop'''<br />Uses LXDE as default desktop<br />Pre-installed mpv, smplayer and chromium brower<br />Supports hardware acceleration<br >Kernel version 5.15.y
+
|-
+
  | rk3399-eflasher-friendlycore-lite-focal-5.15-arm64-YYYYMMDD.img.gz
+
  | '''FriendlyCore'''<br />Minimal system<br />Based on Ubuntu core 20.04<br />kernel version 5.15.y
+
|-
+
  | colspan=2 | '''Flash Utility:'''
+
|-
+
  | win32diskimager.rar
+
  | Windows utility. Under Linux users can use "dd"
+
|}
+
Here are the steps:<br />
+
* Get an SDHC card with a minimum capacity of 8G
+
* Download a rk3399-eflasher-OSNAME-YYYYMMDD.img.gz image file and a win32diskimager;
+
* Under Windows, run win32diskimager as administrator, select your SD card and extracted [[EFlasher/zh|EFlasher]] image file, and click on “Write” to write image file on the SD card; or under Linux, you use the dd command to write the rk3399-eflasher-OSNAME-YYYYMMDD.img file to the SD card. 
+
* Eject your SD card and insert it to {{{1}}}’s microSD card slot.
+
* Turn on {{{1}}}, it will boot from the SD card and automatically run [[EFlasher/zh|EFlasher]] to install the OS to the board’s eMMC. You can observer the board’s LEDs to watch its installation progress 
+
{| class="wikitable"
+
|-
+
! Progress
+
! SYS LED(Red)
+
! LAN LED(Green)
+
! WAN LED(Green)
+
|-
+
| Power On
+
| Solid On
+
| Off
+
| Off
+
|-
+
| System Boot
+
| Slow Flashing
+
| Off
+
| Off
+
|-
+
| Installation in Progress
+
| Fast Flashing
+
| Off
+
| Off
+
|-
+
| Installation Done
+
| Slow Flashing
+
| Solid On
+
| Solid On
+
|}
+
* After installation is done, power off the board, eject the SD card from {{{1}}}, power on the board again, {{{1}}} will load the OS from its eMMC
+
======Install Flash Image File to eMMC======
+
* Auto Install (Default Behavior)
+
1) Download an “eflasher” firmware from [http://download.friendlyelec.com/{{#replace:{{#replace:{{BASEPAGENAME}}| |}}|/zh|}} network drive], extract it and install it to a TF card ;<br />
+
2) Eject and insert the TF card to your PC, after a “FriendlyARM” device shows up(Under Linux, it is a “FriendlyARM” directory), copy an .img or .gz file to the TF card.<br />
+
3) Open the eflasher.conf file on the TF card, set “autoStart=” to the name of your image file, such as:<br />
+
<syntaxhighlight lang="bash">
+
autoStart=openwrt-rockchip-armv8_nanopi-ext4-sysupgrade.img.gz
+
</syntaxhighlight>
+
Anyone of the files that contain “-sd-” will work. Here is a list:
+
{| class="wikitable"
+
|-
+
  | rk3399-sd-friendlywrt-21.02-YYYYMMDD.img.gz
+
|-
+
  | rk3399-sd-friendlywrt-21.02-docker-YYYYMMDD.img.gz
+
|-
+
  | rk3399-sd-friendlywrt-22.03-YYYYMMDD.img.gz
+
|-
+
  | rk3399-sd-friendlywrt-22.03-docker-YYYYMMDD.img.gz
+
|}
+
4) Eject the TF card, insert the TF card to {{{1}}}, power it on it will automatically install your firmware. You can watch the installation progress by observing the LEDs’ status.<br />
+
=====Option 3: Install OS via USB=====
+
======Step 1: Install USB Driver and Tools/Utilities======
+
Download a driver file DriverAssitant_v5.1.1.zip under the “tools” directory from [http://download.friendlyelec.com/{{#replace:{{#replace:{{BASEPAGENAME}}| |}}|/zh|}} network drive], extract and install it. <br />
+
Under the same directory, download a utility RKDevTool_Release_v2.84.zip and extract it. <br />
+
======Step 2: Connect {{{1}}} to PC and Enter Installation Mode======
+
1) Disconnect the connected USB cable and the power cord from {{{1}}}, eject the TF card;<br />
+
2) Press and hold the “Mask” key, power on the board. After the status LED has been on for at least 3 seconds, release the Mask key.<br />
+
3) Use a USB A-to-A cable, connect {{{1}}} to a PC as follows. Note: please pay attention to the USB port the USB cable is connected to in the screenshot. <br />
+
[[File:Nanopir4se-usba-to-usba.jpg|frameless|400px]]<br />
+
======Step 3: Install image to eMMC======
+
A firmware in general is packaged in either of the two options: the first is an whole image (ie, update.img) which is often offered by third party developers, the second is that an image is packaged and placed in multiple partition images. FriendlyElec offers an image in the latter option.
+
* Option 1: Install whole image (ie, update.img)<br />
+
On a PC which has the extracted RKDevTool_Release_v2.84 utility, go to the RKDevTool_Release_v2.84 directory, run the RKDevTool.exe file. If everything works, you will see a “Found a new Maskrom device” message on the utility;<br />
+
Go to “Upgrade Firmware(升级固件)”, click on “Firmware(固件)”, select your wanted image file, and click on “Upgrade(升级)” to install. After installation is done, your board will reboot automatically and load the system from eMMC;<br />
+
* Option 2: Install OS that is packaged & placed in multiple partition images<br />
+
Go to [http://download.friendlyelec.com/{{#replace:{{#replace:{{BASEPAGENAME}}| |}}|/zh|}} network drive] to download your needed package and extract it.
+
{| class="wikitable"
+
|-
+
  | colspan=2 | '''Image File'''
+
|-
+
  | rk3399-usb-friendlywrt-21.02-YYYYMMDD.img.gz
+
  | '''[[How to Build FriendlyWrt|FriendlyWrt]]'''<br/>Based on OpenWrt 21.02.3<br />Kernel version 5.15.y
+
|-
+
  | rk3399-usb-friendlywrt-21.02-docker-YYYYMMDD.img.gz
+
  | '''[[How to Build FriendlyWrt|FriendlyWrt]]'''<br/>Pre-installed Docker<br />Based on OpenWrt 21.02.3<br />Kernel version 5.15.y
+
|-
+
  | rk3399-usb-debian-buster-desktop-arm64-YYYYMMDD.img.gz
+
  | '''Debian 10(buster) Desktop'''<br />Uses LXDE as default desktop<br />Pre-installed mpv, smplayer and chromium brower<br />Supports hardware acceleration<br >Kernel version 5.15.y
+
|-
+
  | rk3399-usb-friendlycore-lite-focal-5.10-arm64-YYYYMMDD.img.gz
+
  | '''FriendlyCore'''<br />Minimal system<br />Based on Ubuntu core 20.04<br />kernel version 5.15.y
+
|}
+
After it is extracted, you will see some utilities and a configuration file under the directory. double click on RKDevTool.exe, you will see a “Found a new Maskrom device” message on the utility. Click on the “Execute”, wait a moment and it will be installed. After installation is done your system will automatically reboot and load the system from eMMC.<br />
+

Latest revision as of 09:23, 4 June 2024

1 Unbricking Method

If the ROM is not installed correctly, causing the development board to become bricked, and you might not have the opportunity to reinstall the ROM via an SD card, you need to enter Maskrom mode to unbrick it by erasing the storage device.

1.1 Windows Users

1.1.1 Download Required Files

  • Get the necessary tools: Visit here, find RKDevTool_v3.19_for_window.zip and DriverAssitant_v5.12.zip in the 05_Tools directory, and download them to your local machine.
  • Install Rockchip USB driver and RKDevTool: Extract DriverAssitant_v5.12.zip to install the Rockchip USB driver, and extract RKDevTool_v3.19_for_window.zip to obtain the Rockchip flashing tool RKDevTool.
  • Get the loader: Visit here, enter the tools directory corresponding to your CPU model, and download MiniLoaderAll.bin.

1.1.2 Enter Maskrom Mode to Erase the Storage Device

  • Connect NanoPC-T4 to your computer using a USB data cable.
  • Start RKDevTool on your computer.
  • Disconnect the power from NanoPC-T4, hold down the MASK button, connect the power, and release the button when you see Found One MASKROM Device displayed at the bottom of the interface, as shown below:

Rkdevtool found one maskrom device.png

  • Click the Advanced Function tab in the RKDevTool interface.
  • In the Boot text box, select MiniLoaderAll.bin, then click the Download button.
  • Select EMMC, click Switch Storage, then click the EraseAll button to erase the eMMC.

Rkdevtool erase emmc.png

  • At this point, NanoPC-T4 is restored to its initial state and can be normally booted via SD card or eMMC.

1.2 Linux/Mac Users

1.2.1 Download the Required Files

  • Get the necessary tools: Visit here and find upgrade_tool_v2.30_for_linux.tgz (or for Mac users, select upgrade_tool_v2.25_for_mac.tgz) in the 05_Tools directory and download it locally.
  • Get the loader: Visit here, enter the tools directory corresponding to your CPU model, and download MiniLoaderAll.bin.

1.2.2 Installation for upgrade_tool

The following commands are for Linux, with only slight differences in file and directory names for Mac users:

tar xzf upgrade_tool_v2.30_for_linux.tgz
cd upgrade_tool_v2.30_for_linux
sudo cp upgrade_tool /usr/local/sbin/
sudo chmod 755 /usr/local/sbin/upgrade_tool

1.2.3 Enter Maskrom Mode to Erase the Storage Device

  • Connect NanoPC-T4 to the computer using a USB data cable.
  • Disconnect the power from NanoPC-T4, hold down the MASK button, connect the power, and release the button after 4 seconds.
  • Check the connection with the following command:
upgrade_tool LD

A result similar to "DevNo=1 Vid=0x2207,Pid=0x350b,LocationID=13 Mode=Maskrom SerialNo=" indicates that the device has been detected.

  • Erase the eMMC with the following command:
upgrade_tool EF MiniLoaderAll.bin
  • At this point, NanoPC-T4 has been restored to its initial state and can boot the system normally via SD card or eMMC.