Khadas Docs

Amazing Khadas, always amazes you!

User Tools

Site Tools


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/27 23:59]
hyphop [WEB API]
software:oowow:user-manual [2023/02/27 01:37] (current)
hyphop ↷ Links adapted because of a move operation
Line 17: Line 17:
 ===== Hardware ===== ===== Hardware =====
  
-Supported devices: [[devices]]+Supported devices: [[.devices:start]]
  
 ==== Hardware Buttons ==== ==== Hardware Buttons ====
Line 23: Line 23:
 {{:products:sbc:vim4:hardware:vim4-buttons.webp?400|}} {{: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   * **RESET** - reset device
Line 32: Line 32:
  
   * 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 >
Line 110: Line 110:
  
 <WRAP tip > <WRAP tip >
-Access can be restricted by the Firewall.+Access can be restricted by the [[#firewall]]
 </WRAP> </WRAP>
  
Line 143: Line 143:
 ==== WEB API ==== ==== WEB API ====
  
-For developers and advanced users only. WIP:+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 335: 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 343: 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 393: Line 456:
 ===== More information ===== ===== More information =====
  
-  * [[devices]]+  * [[.devices:start]]
   * [[why-oowow]]   * [[why-oowow]]
   * [[about-oowow-name]]   * [[about-oowow-name]]
  
  
Last modified: 2022/09/27 23:59 by hyphop