Differences

This shows you the differences between two versions of the page.

--- software:oowow:user-manual [2022/09/26 04:03]
hyphop [Filename for Latest OOWOW Version]
+++ software:oowow:user-manual [2024/11/06 21:03] (current)
hyphop [Dump eMMC by LAN network]
@@ Line 17: / Line 17: @@
 ===== Hardware =====
+Supported devices: [[.devices:start]]
 ==== Hardware Buttons ====
@@ Line 22: / Line 23: @@
 {{:products:sbc:vim4:hardware:vim4-buttons.webp?400|}}
-You can use the three [[/products/sbc/vim4/hardware/interfaces#hardware-buttons]] on your device to interact directly with the [[:OOWOW:]] system, we will describe them in more detail within the next section.
+You can use the three [[/products/sbc/vim4/hardware/interfaces#hardware-buttons]] on your device to interact directly with the [[oowow:]] system, we will describe them in more detail within the next section.
   * **RESET** - reset device
@@ Line 31: / Line 32: @@
   * Boot OOWOW - hold **FUNCTION** and short press **RESET** then release **FUNCTION**
-  * Toggle Easy Wi-Fi - short press **POWER** button
+  * Toggle [[#easy-wi-fi|Easy Wi-Fi]] - short press **POWER** button
-  * Toggle Hotspot -  short press **FUNCTION** button
+  * Toggle [[#hotspot|Hotspot]] -  short press **FUNCTION** button
   * Accept Hotspot client  - short press **POWER** button
   * Power off - Long press the **POWER** button until device shuts down
-  * Enter multifunction mode - press and hold **FUNCTION** button (loop cycle: Hotspot -> Firewall Allow -> Firewall Block -> Cancel, each mode wait 2 sec ), release to activate selected function
+  * Enter multifunction mode - press and hold **FUNCTION** button (loop cycle: [[#hotspot|Hotspot]] -> [[#firewall|Firewall Allow]] -> [[#firewall|Firewall Block]] -> Cancel, each mode wait 2 sec ), release to activate selected function
 <WRAP tip >
@@ Line 91: / Line 92: @@
 === Navigation ===
-  * Keys: 0-9 A-Z ⇦ ⇨ ⇧ ⇩ Space Enter Esc Tab
+  * Keys: ''0-9 A-Z ⇦ ⇨ ⇧ ⇩ Space Enter Esc Tab''
-  * Mouse: select menu items and press buttons
+  * Mouse (for Web Interface only): select menu items and press buttons
 === HDMI + Keyboard ===
@@ Line 109: / Line 110: @@
 <WRAP tip >
-Access can be restricted by the Firewall.
+Access can be restricted by the [[#firewall]]
 </WRAP>
@@ Line 142: / Line 143: @@
 ==== WEB API ====
-For developers and advanced users only.
+For developers and advanced users WIP:
+<WRAP tip >
+Access can be restricted by the [[#firewall]]
+</WRAP>
+==== Dump eMMC by usb network ====
+```
+curl -L 172.22.1.1/api/disk/rdz/mmc.zst -OJ
+```
+==== Dump eMMC by LAN network ====
+```
+curl -L OOWOW_HOST_NAME_OR_IP/api/disk/rdz/mmc.zst -OJ
+```
+==== Write Image to eMMC by LAN network ====
+```sh Write to eMMC
+curl OOWOW_HOST_NAME_OR_IP/shell/write | sh -s - IMAGE
+```
+==== Write Image to SD by LAN network ====
+```sh Write to SD
+curl OOWOW_HOST_NAME_OR_IP/shell/write | sh -s - IMAGE -sd
+```
+==== Write SPI oowow image by LAN network ====
+```sh Write or update SPI-flash firmware by LAN
+curl OOWOW_HOST_NAME_OR_IP/shell/write | sh -s - XXX-oowow-latest-spi.img.gz -spi
+```
+==== Write SPI oowow image by USB-otg network ====
+```sh Write or update SPI-flash firmware by USB-otg network
+curl 172.22.1.1/shell/write | sh -s - XXX-oowow-latest-spi.img.gz -spi
+```
+===== Backup =====
+==== Store backup ====
+  - Navigate to the backup menu: **OOWOW main menu** => **Dump image from eMMC**
+  - Select the backup location:
+    * on OOWOW disk itself: ''location'' > ''../'' > ''dumps'' > ''okay''
+    * on USB disk: ''location'' > ''../'' > ''USB-sdXX....'' > ''okay''
+    * if OOWOW was booted from special oowow disk backup location will selected automaticly
+  - Start backup: **Start**, and wait for few minutes to finish the backup and exit.
+==== Restore backup ====
+  - Navigate to the restore menu: **OOWOW main menu** => **Write image to eMMC**
+  - Select the backup image location:
+     * on OOWOW disk itself: ''vimx-xxxxxx.xxxxxx-.....img.zst'' > ''okay''
+     * on USB disk: ''../'' > ''USB-sdb1....'' > ''vimx-xxxxxx.xxxxxx-.....img.zst'' > ''okay''
+     * if OOWOW was booted from special oowow disk backup location will selected automaticly
+  - Restore the image: **Write**, and wait for few minutes to write the image and exit.
 ===== Networks =====
@@ Line 334: / Line 402: @@
 === Ethernet ===
+WIP:
+===== Device configure KBI =====
+// Main menu => Device configure KBI //
+KBI is an abbreviation for Khadas Bootloader Instructions, which is
+developed to fulfill the following purposes:
+  * Manage the programmable MCU
+  * Carry out low level hardware management
+  * Let developers utilize all the features of SBC device
+====  Reset MCU to factory mode ====
+Reset MCU/KBI configuration to default values
+<WRAP tip >
+This procedure totally safe, and never change eMMC storage content or any other parts.
+</WRAP>
+====  Boot-mode ====
+Setup device boot-mode values:
+  * ''emmc'' - boot up device from ''eMMC'' **default**
+  * ''spi'' - boot up device from ''SPI-flash''
+<WRAP important >
+For use Android need setup boot-mode to ''emmc''
+</WRAP>
+WIP:
-TODO.
 ===== Security and Privacy =====
@@ Line 342: / Line 442: @@
   * OOWOW works only by user demand, and never works in the background
   * OOWOW never sends any private data from your device to the internet
-  * By default, remote access to your device is blocked by the firewall
+  * By default, remote access to your device is blocked by the [[#firewall]]
 ===== Limitations =====
@@ Line 390: / Line 490: @@
   * ''wget --content-disposition https://dl.khadas.com/products/oowow/system/vim4-oowow-latest-sd.img.gz''
-===== About OOWOW =====
+===== More information =====
+  * [[.devices:start]]
+  * [[why-oowow]]
+  * [[about-oowow-name]]

Khadas Docs

User Tools

Site Tools

Differences

Page Tools