Khadas Docs

Amazing Khadas, always amazes you!

User Tools

Site Tools

Home / software / oowow / user-manual
software:oowow:user-manual

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
software:oowow:user-manual [2022/09/23 22:59]
nick [Main Menu] 		software:oowow:user-manual [2023/02/27 01:37] (current)
hyphop ↷ Links adapted because of a move operation
Line 1: Line 1:
 ====== OOWOW User Manual ====== ====== OOWOW User Manual ======
  
-===== What is OOWOW? ===== +Short introduction: [[getting-started]]
- +
-OOWOW is an embedded service (integrated into your device) - it can be run at any time if you need to perform essential maintenance services on your device. +
- +
-===== About VIM4 ===== +
- +
- +
-VIM4 is the first device from Khadas that includes the OOWOW embedded service. Since VIM4 comes without any pre-installed OS, users can use OOWOW to select and install their preferred OS. +
- +
-===== OS Delivery ===== +
- +
- +
-OOWOW provides rapid online OS download and installation, which will improve quality of life for single board computer users - with OOWOW, you can install / reinstall your preferred OS in just 2-3 minutes. +
- +
-===== OOWOW Wizard ===== +
- +
- +
-The OOWOW wizard will guide you to install a new OS in just 4 steps, and it automatically starts if your device storage is empty. +
- +
-  * Connect to internet over Wi-Fi or Ethernet +
-  * Display OS images for your device +
-  * Select OS installation image +
-  * Download and install OS into your device +
- +
-Wizard Usage Example: +
-https://dl.khadas.com/.temp/oowow/screencast/quick-start/-gallery?play=loop +
- +
-<WRAP tip > +
-If you need other features, exit from the wizard to the main menu. +
-</WRAP> +
  
 ===== Main Features ===== ===== Main Features =====
- 
  
   * Install / reinstall OS   * Install / reinstall OS
Line 48: Line 17:
 ===== Hardware ===== ===== Hardware =====
  
 +Supported devices: [[.devices:start]]
  
 ==== Hardware Buttons ==== ==== Hardware Buttons ====
  
 +{{:products:sbc:vim4:hardware:vim4-buttons.webp?400|}}
  
-You can use the three physical 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 +  * **RESET** - reset device 
-  * FUNCTION - multi functions +  * **FUNCTION** - multi functions 
-  * POWER - multi functions+  * **POWER** - multi functions
  
-==== VIM4 Button Shortcuts ====+==== Common Button Shortcuts ====
  
   * Boot OOWOW - hold **FUNCTION** and short press **RESET** then release **FUNCTION**   * 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   * Accept Hotspot client  - short press **POWER** button
   * Power off - Long press the **POWER** button until device shuts down   * 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 > <WRAP tip >
-Tip: All shortcut events will be displayed on OOWOW status bar and indicated by LEDs.+All shortcut events will be displayed on OOWOW status bar and indicated by LEDs.
 </WRAP> </WRAP>
  
Line 75: Line 46:
  
  
-  * Eject your TF card before booting OOWOW (TF card has highest priority)+  * Eject your micro SD-card before booting OOWOW (micro SD-card has highest priority)
   * Boot OOWOW from sleep: hold **FUNCTION** button + short press **RESET** button + release **FUNCTION** button   * Boot OOWOW from sleep: hold **FUNCTION** button + short press **RESET** button + release **FUNCTION** button
   * Boot OOWOW with power cable: hold **FUNCTION** button + plug power cable   * Boot OOWOW with power cable: hold **FUNCTION** button + plug power cable
Line 84: Line 55:
 Most system events have corresponding LED indications: Most system events have corresponding LED indications:
  
-  * Device starts or reboots: **White solid** +^ Events ^ Indications | 
-  * Device power off: **Red solid** +| Device starts or reboots | White solid | 
-  * System start in default mode: **White heartbeat** +| Device power off | Red solid |  
-  * Network connected: **White solid** +| System start in default mode | White heartbeat| 
-  * Hotspot mode activated: **White fast blinking** +| Network connected | White solid| 
-  * Hotspot mode ready: **White solid** +| HotSpot mode activated | White fast blinking| 
-  * Hotspot client pending: **White and red blinking** +| HotSpot mode ready | White solid| 
-  * Hotspot client accepted: **White slow blinking** +| HotSpot client pending | White and red blinking| 
-  * Hotspot mode deactivated: **White heartbeat** +| HotSpot client accepted | White slow blinking| 
-  * Easy Wi-Fi activated: **White blinking** +| HotSpot mode deactivated | White heartbeat| 
-  * Easy Wi-Fi awaits connection: **White slow blinking** +| Easy Wi-Fi activated | White blinking| 
-  * Easy Wi-Fi deactivated: **White heartbeat** +| Easy Wi-Fi awaits connection | White slow blinking| 
-  * Firewall block incoming: **Red breathing** +| Easy Wi-Fi deactivated | White heartbeat| 
-  * Firewall allow incoming: **White solid, red off** +| Firewall block incoming | Red breathing| 
-  * Firewall disabled: **Red blinking** +| Firewall allow incoming | White solid, red off | 
-  * Image installation progress: **Red & white blinking** +| Firewall disabled | Red blinking | 
-  * Image installation done: **White solid, red off**+| Image installation progress | Red & white blinking | 
 +| Image installation done | White solid, red off |
  
 Multifunctional modes: Multifunctional modes:
  
-  * Hotspot: **White off** +^ Events ^ Indications ^ 
-  * Firewall block incoming: **White solid, red off** +|Hotspot | White off | 
-  * Firewall allow incoming: **White & red solid** +|Firewall block incoming | White solid, red off |  
-  * Cancel: **White blinking**+|Firewall allow incoming | White & red solid | 
 +|Cancel | White blinking |
  
 ===== Interfaces ===== ===== Interfaces =====
Line 119: Line 92:
 === Navigation === === Navigation ===
  
- +  * Keys: ''0-9 A-Z ⇦ ⇨ ⇧ ⇩ Space Enter Esc Tab'' 
-  * Keys: 0-9 A-Z ⇦ ⇨ ⇧ ⇩ Space Enter Esc Tab +  * Mouse (for Web Interface only): select menu items and press buttons
-  * Mouse: select menu items and press buttons+
  
 === HDMI + Keyboard === === HDMI + Keyboard ===
Line 138: Line 110:
  
 <WRAP tip > <WRAP tip >
-Tip: Access can be restricted by the Firewall.+Access can be restricted by the [[#firewall]]
 </WRAP> </WRAP>
  
Line 157: Line 129:
  
 <WRAP tip > <WRAP tip >
-Tip: Access can be restricted by the Firewall.+Access can be restricted by the Firewall.
 </WRAP> </WRAP>
  
Line 163: Line 135:
 === Serial UART Access === === Serial UART Access ===
  
 +For developers and advanced users.
  
-For developers and advanced users only. +  * Check how-to [[products:sbc:common:development:setup-serial-tool]] 
- +  * Root access works by default without password 
-  * Check [documentation](setup_serial_tool.html) to setup the serial debug tool +  * Type ''system'' to enter to main menu, or use other shell commands 
-  * root access works by default without password +
-  * ''system'' - main menu+
  
 ==== WEB API ==== ==== 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 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 
 +```
  
 ===== Networks ===== ===== Networks =====
Line 210: Line 212:
  
 <WRAP tip > <WRAP tip >
-Tips: 
  
-  * *Use device ip address if name resolution doesn't work.* +  * Use device ip address if name resolution doesn't work. 
-  * *OOWOW uses the DHCP hostname.* +  * OOWOW uses the DHCP hostname. 
-  * *OOWOW uses the MDNS hostname announcement.*+  * OOWOW uses the MDNS hostname announcement.
  
 </WRAP> </WRAP>
Line 222: Line 223:
  
 ```shell ```shell
-# ping vim4-05690+~$ ping vim4-05690
 PING vim4-05690 (192.168.30.203) 56(84) bytes of data. PING vim4-05690 (192.168.30.203) 56(84) bytes of data.
 64 bytes from 192.168.30.203 (192.168.30.203): icmp_seq=1 ttl=64 time=37.3 ms 64 bytes from 192.168.30.203 (192.168.30.203): icmp_seq=1 ttl=64 time=37.3 ms
  
-# ping -c1 vim4-05690.local+~$ ping -c1 vim4-05690.local
 PING vim4-05690.local (192.168.30.203) 56(84) bytes of data. PING vim4-05690.local (192.168.30.203) 56(84) bytes of data.
 64 bytes from 192.168.30.203 (192.168.30.203): icmp_seq=1 ttl=64 time=37.3 ms 64 bytes from 192.168.30.203 (192.168.30.203): icmp_seq=1 ttl=64 time=37.3 ms
  
-# curl http://vim4-05690.local +~$ curl http://vim4-05690.local 
-# curl http://192.168.30.203 +~$ curl http://192.168.30.203 
-# curl 192.168.30.203 +~$ curl 192.168.30.203 
-# ssh root@vim4-05690 +~$ ssh root@vim4-05690 
-# ssh root@vim4-05690.local+~$ ssh root@vim4-05690.local
 ``` ```
  
Line 249: Line 250:
  
 <WRAP tip > <WRAP tip >
-Tips: 
  
-  * *Wi-Fi configurations are automatically saved and will persist after rebooting.* + 
-  * *All system configurations will be saved only after a planned shutdown. Check [[dl>.temp/oowow/screencast/howto-save-setting/-gallery?play=auto&delay=2|animation]].*+  * Wi-Fi configurations are automatically saved and will persist after rebooting. 
 +  * All system configurations will be saved only after a planned shutdown. Check [[dl>.temp/oowow/screencast/howto-save-setting/-gallery?play=auto&delay=2|animation]].
  
 </WRAP> </WRAP>
Line 264: Line 265:
  
   * Toggle Easy Wi-Fi - short press **POWER** button   * Toggle Easy Wi-Fi - short press **POWER** button
-  * ***Network -> Wi-Fi -> Easy Wi-Fi oowow > Enable / Disable***+  * **Network => Wi-Fi => Easy Wi-Fi oowow => Enable / Disable**
  
 Setup a new hotspot from your mobile device with the following configuration: Setup a new hotspot from your mobile device with the following configuration:
Line 276: Line 277:
  
  
-You can enable the OOWOW hotspot feature in two ways:+You can enable the OOWOW hot-spot feature in two ways:
  
   * Toggle hotspot - short press **FUNCTION** button   * Toggle hotspot - short press **FUNCTION** button
-  * ***Network -> Hotspot -> Hotspot Enable / Disable***+  * **Network => Hotspot => Hotspot Enable / Disable**
  
-The OOWOW hotspot will have the following configuration:+The OOWOW hot-spot will have the following configuration:
  
   * SSID: **vim4-xxxxx** ( xxxxx - last 5 digits from device serial number )   * SSID: **vim4-xxxxx** ( xxxxx - last 5 digits from device serial number )
   * Password: **12345678**   * Password: **12345678**
  
-These hostnames can be used for device access via the hotspot:+These host names can be used for device access via the hotspot:
  
   * http://172.23.0.1   * http://172.23.0.1
Line 300: Line 301:
  
  
-***Network -> Hotspot -> Hotspot QR code.***+Network -> Hotspot -> Hotspot QR code.
  
 ### Web access QR code ### Web access QR code
  
-  * ***Network -> Hotspot -> Device Web Access QR code*** +  * Network => Hotspot => Device Web Access QR code 
-  * ***Network -> Wi-Fi -> Device Web Access QR code***+  * Network => Wi-Fi => Device Web Access QR code
  
 ==== USB-OTG Network ==== ==== USB-OTG Network ====
Line 314: Line 315:
 ==== Firewall ==== ==== Firewall ====
  
- +**Network -> Firewall Mode:**
-***Network -> Firewall Mode:***+
  
   * block - Block all incoming connections **SECURE**   * block - Block all incoming connections **SECURE**
Line 322: Line 322:
  
 <WRAP tip > <WRAP tip >
-Tips: 
  
-  * *By default, remote access is blocked by the firewall* +  * By default, remote access is blocked by the firewall 
-  * *Easily configure the firewall with the hardware button shortcuts* +  * Easily configure the firewall with the hardware button shortcuts 
-  * *ICMP pings are always allowed, irrespective of firewall mode* +  * ICMP pings are always allowed, irrespective of firewall mode 
-  * *Hotspot mode allows incoming connections only after pressing the POWER button (device access: 172.23.0.1 or http://172.23.0.1)* +  * Hotspot mode allows incoming connections only after pressing the POWER button (device access: 172.23.0.1 or http://172.23.0.1) 
-  * *USB-OTG connection is always allowed*+  * USB-OTG connection is always allowed
  
 </WRAP> </WRAP>
Line 338: Line 337:
  
  
-Check [[http://dl.khadas.com/.temp/oowow/screencast/wizard-wifi-usage/-gallery?play=loop|here]].+Check [[dl>.temp/oowow/screencast/wizard-wifi-usage/-gallery?play=loop|here]].
  
 === Wi-Fi Connection === === Wi-Fi Connection ===
  
  
-Check [[http://dl.khadas.com/.temp/oowow/screencast/network-wifi-setup/-gallery?play=loop|here]].+Check [[dl>.temp/oowow/screencast/network-wifi-setup/-gallery?play=loop|here]].
  
 === Easy Wi-Fi Connection === === Easy Wi-Fi Connection ===
  
  
-Check [[http://dl.khadas.com/.temp/oowow/screencast/easy-wifi-mode/-gallery|here]].+Check [[dl>.temp/oowow/screencast/easy-wifi-mode/-gallery|here]].
  
 === Hotspot Mode === === Hotspot Mode ===
  
  
-Check [here](http://dl.khadas.com/.temp/oowow/screencast/hotspot-mode/-gallery).+Check [[dl>.temp/oowow/screencast/hotspot-mode/-gallery|here]].
  
 === Hotspot Mode + Ethernet LAN === === Hotspot Mode + Ethernet LAN ===
Line 367: Line 366:
 === Ethernet === === 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 ===== ===== Security and Privacy =====
Line 375: Line 406:
   * OOWOW works only by user demand, and never works in the background   * OOWOW works only by user demand, and never works in the background
   * OOWOW never sends any private data from your device to the internet   * 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 ===== ===== Limitations =====
Line 392: Line 423:
 ===== Download OOWOW ===== ===== Download OOWOW =====
  
- +  * [[dl>products/oowow/| OOWOW main download page ]] 
-Check [[dl>products/vim4/firmware/oowow/system/|here]] for oowow system images.+  * [[dl>products/oowow/system/| Latest OOWOW system/firmware images]] 
 +  * [[dl>products/oowow/system/versions/| Full OOWOW versions images]]
  
 ==== Image Types ==== ==== Image Types ====
  
- +  * BOARD-oowow-latest-sd.img.gz - latest oowow image for SD-card or USB-thumb drive 
-  * vim4-oowow-latest-sd.img.gz - latest oowow image for SD-card or USB-thumb drive +  * BOARD-oowow-latest-spi.img.gz - latest oowow image for SPI-flash 
-  * vim4-oowow-latest-spi.img.gz - latest oowow image for SPI-flash +  * BOARD-oowow-latest-spi-upgrade-sd.img.gz - upgrade oowow SPI-flash firmware from SD-card
-  * vim4-oowow-latest-spi-upgrade-sd.img.gz - upgrade oowow SPI-flash firmware from SD-card+
  
 ==== Filename for Latest OOWOW Version ==== ==== Filename for Latest OOWOW Version ====
  
-  * vim4-oowow-latest-sd.img.gz -> versions/vim4/vim4-oowow-VERSION-sd.img.gz+  * BOARD-oowow-latest-sd.img.gz -> versions/BOARD/BOARD-oowow-VERSION-sd.img.gz
  
 <WRAP tip > <WRAP tip >
-Tip: Download the latest OOWOW image file with this link: https://dl.khadas.com/products/vim4/firmware/oowow/system/vim4-oowow-latest-sd.img.gz. +Download the latest OOWOW SD images: 
 +  * https://dl.khadas.com/products/oowow/system/vim4-oowow-latest-sd.img.gz 
 +  * https://dl.khadas.com/products/oowow/system/vim3-oowow-latest-sd.img.gz 
 +  * https://dl.khadas.com/products/oowow/system/vim3l-oowow-latest-sd.img.gz 
 +  * https://dl.khadas.com/products/oowow/system/vim2-oowow-latest-sd.img.gz 
 +  * https://dl.khadas.com/products/oowow/system/vim1-oowow-latest-sd.img.gz 
 +  * https://dl.khadas.com/products/oowow/system/vim1s-oowow-latest-sd.img.gz 
 +  * https://dl.khadas.com/products/oowow/system/edge2-oowow-latest-sd.img.gz 
 +  * https://dl.khadas.com/products/oowow/system/edge-oowow-latest-sd.img.gz
 </WRAP> </WRAP>
  
-Download images using command line:+Download images command line examples:
  
-  * ''curl -JOL https://dl.khadas.com/products/vim4/firmware/oowow/system/vim4-oowow-latest-sd.img.gz'' +  * ''curl -JOL https://dl.khadas.com/products/oowow/system/vim4-oowow-latest-sd.img.gz'' 
-  * ''wget --content-disposition https://dl.khadas.com/products/vim4/firmware/oowow/system/vim4-oowow-latest-sd.img.gz''+  * ''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]]
  
-==== Why Create OOWOW? ==== 
- 
- 
-The process of new OS Installation is the biggest headache for users of single board computers (SBC); before installing an OS, users must read tons of manuals, trawl through online forums, learn how to install/reinstall using their desktop/laptop PC, learn where to find proper images etc…If something goes wrong it is possible to “BRICK” (destroy) your device(even through we can use TST mode to recovery rhe device).  
- 
-In other words, any form of device upgrade, maintenance, or OS reinstallation requires advanced skills and external hardware, and this is out of reach for the average user, or users in regions without desktop/laptop PCs. With OOWOW your SBC becomes a standalone device; perform all maintenance functions and OS installation directly from the device itself. 
- 
-OOWOW understands the end user deeply; it provides an out-of the-box, universal OS delivery and device configuration solution for all SBCs in the market today and into the future. 
- 
-Live life easily with OOWOW! 
- 
-==== What is the meaning of 'OOWOW'? ==== 
- 
- 
-oowow - infinity level wow (will be a new 77th word in the English dictionary). 
- 
-  * Pronunciation: /uː/  +  /wau/ = /u:wau/ 
-  * Variations: ∞wow, infinity wow, endless wow 
- 
-<WRAP tip > 
-Tips: 
-  * https://en.wiktionary.org/wiki/wow 
-  * https://www.crosswordsolver.org/words-starting-with-oo 
-</WRAP> 
  
Last modified: 2022/09/23 22:59 by nick

Page Tools

Khadas Site

Khadas Community

Khadas GitHub

Khadas Downloads