Skip to content

Commit e87929e

Browse files
committed
Refactor documentation for consistency and clarity across multiple files
1 parent 48d401e commit e87929e

8 files changed

Lines changed: 78 additions & 52 deletions

File tree

pages/Debian.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
 
1+
# Debian Installation Guide
22

3-
Based on Debian 6.7 with MSM8916 mainline support
3+
> Based on Debian 6.7 with MSM8916 mainline support
44
55
## Prerequisites
66

@@ -23,13 +23,13 @@ unzip openstick-uz801-v3.0.zip
2323
cd openstick-uz801
2424
```
2525

26-
3. Boot into fastboot mode:
26+
1. Boot into fastboot mode:
2727

2828
```bash
29-
adb reboot-bootloader
29+
adb reboot bootloader
3030
```
3131

32-
4. Flash the firmware:
32+
1. Flash the firmware:
3333

3434
- **Windows**:
3535

pages/Firmware(Dump_and_Restore).md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
1-
 
1+
# Firmware Dump and Restore
22

33
## Entering EDL Mode
44

55
There are two methods to enable Emergency Download (EDL) mode:
66

77
### Method 1: Using ADB
88

9-
For Stock firmware:
9+
**For Stock firmware:**
1010

1111
```bash
1212
adb reboot edl
1313
```
1414

15-
For OpenWRT:
15+
**For OpenWRT:**
1616

1717
```bash
1818
adb reboot bootloader
19-
2019
fastboot oem reboot edl
2120
```
2221

@@ -42,6 +41,12 @@ python3 edl rf backup_filename.bin
4241
python3 edl wf backup_filename.bin
4342
```
4443

44+
### Creating Individual Partition Backups
45+
46+
```bash
47+
python3 edl rl output_folder --genxml
48+
```
49+
4550
## Analyzing the Firmware
4651

4752
You can examine the partition structure of your backup using these tools:
@@ -50,7 +55,9 @@ You can examine the partition structure of your backup using these tools:
5055
- 7-Zip
5156
- HxD (Hex Editor)
5257

53-
> [!NOTE]
58+
## Important Notes
59+
60+
> [!IMPORTANT]
5461
>
5562
> - Always keep a backup of your original firmware
5663
> - Ensure stable USB connection during operations
@@ -62,7 +69,9 @@ You can examine the partition structure of your backup using these tools:
6269

6370
If the device is not detected in EDL mode:
6471

65-
1. Check USB drivers
72+
1. Check USB drivers are properly installed
6673
2. Try different USB ports
6774
3. Verify cable connection
6875
4. Ensure proper EDL mode entry
76+
77+
For Windows users: Install the QDLoader 9008 driver if not automatically detected.

pages/Home.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
 
1+
# UZ801 v3.2 Documentation
22

33
## Welcome to the UZ801-USB_MODEM repository Wiki!
44

@@ -13,20 +13,23 @@ This Wiki contains extensive information and research findings about the UZ801 v
1313
- [Debian](https://github.com/AlienWolfX/UZ801-USB_MODEM/wiki/Debian)
1414
- [Troubleshooting](https://github.com/AlienWolfX/UZ801-USB_MODEM/wiki/Troubleshooting)
1515

16-
## Required Tools
16+
## Prerequisites
1717

18-
Before proceeding with any instructions in this guide, please ensure you have the following tools:
18+
Before proceeding with any instructions in this guide, ensure you have the following tools installed:
1919

2020
- [edl](https://github.com/bkerler/edl)
2121

22-
If you are using Windows, you must install the following:
22+
### Windows Users
23+
24+
If you are using Windows, you must also install:
2325

2426
- [Universal ADB Driver](https://adb.clockworkmod.com/)
2527
- [QDLoader 9008 Driver](https://qdloader9008.com/)
2628
- [ADB Platform Tools](https://gist.github.com/ifiokjr/b70882d3f1182ed48ec7eefa5c93a740)
2729
- [Zadig](https://zadig.akeo.ie/)
2830

29-
On Windows, If you intend to use edl you might encounter this error: `NotImplementedError: Operation not supported or unimplemented on this platform`. One way to fix this is by uninstalling the QDLoader 9008 Driver and replacing it with Zadig WinUSB[⁽¹⁾](https://github.com/bkerler/edl/issues/349#issuecomment-2060152724).
31+
> [!NOTE]
32+
> If you encounter the error `NotImplementedError: Operation not supported or unimplemented on this platform` while using edl, uninstall the QDLoader 9008 Driver and replace it with Zadig WinUSB[⁽¹⁾](https://github.com/bkerler/edl/issues/349#issuecomment-2060152724).
3033
3134
## Contributing
3235

pages/Modifications.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
 
1+
# Modifications
22

33
## Root Access Setup
44

@@ -43,13 +43,13 @@ The default BusyBox installation lacks several commands (like `vi`). Here's how
4343

4444
1. Download [BusyBox APK](https://github.com/AlienWolfX/UZ801-USB_MODEM/releases/download/rev1/busybox.apk)
4545

46-
2. Install the APK:
46+
1. Install the APK:
4747

4848
```bash
4949
adb install busybox.apk
5050
```
5151

52-
3. Launch BusyBox:
52+
1. Launch BusyBox:
5353
- Follow the [View Display Guide](https://github.com/AlienWolfX/UZ801-USB_MODEM?tab=readme-ov-file#view-device-display)
5454
- Open BusyBox application
5555
- Tap "Install"
@@ -101,22 +101,22 @@ mv platform.keystore {YOUR_WORK_DIR}
101101
java -jar apktool.jar d MifiService.apk -o MifiService
102102
```
103103

104-
2. Make modifications in the `assets` folder or any part of the APK that you need to modify
104+
1. Make modifications in the `assets` folder or any part of the APK that you need to modify
105105

106-
3. Recompile (use `android` as passphrase when prompted):
106+
1. Recompile (use `android` as passphrase when prompted):
107107

108108
```bash
109109
java -jar apktool.jar b -o unsigned.apk MifiService
110110
```
111111

112-
4. Sign and align:
112+
1. Sign and align:
113113

114114
```bash
115115
zipalign -v 4 unsigned.apk aligned.apk
116116
jarsigner -verbose -sigalg SHA1withRSA -digestalg SHA1 -keystore ./platform.keystore aligned.apk testkey
117117
```
118118

119-
5. Install modified APK:
119+
1. Install modified APK:
120120

121121
```bash
122122
adb install -r aligned.apk

pages/OpenWRT.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
1-
 
1+
# OpenWRT Installation Guide
22

33
## Important Notes
44

55
> [!WARNING]
66
> The OpenWRT build is based on an older version of OpenWRT. While some packages and applications may have limited functionality, the build remains usable. This guide is intended for users with OpenWRT experience.
77
8+
> [!IMPORTANT]
9+
> If you cannot get a signal after installation, please refer to the [Region Change Guide](Troubleshooting.md#changing-modem-region).
10+
811
## Installation Steps
912

1013
### Prerequisites
1114

1215
- Download [`openwrt-UZ801.tar.xz`](https://github.com/AlienWolfX/UZ801-USB_MODEM/releases) from releases
13-
- Ensure device is in fastboot mode
16+
- Ensure device is in EDL mode
1417
- Backup your current firmware (recommended)
1518

1619
### Installation Process
@@ -22,7 +25,7 @@ tar xf openwrt-UZ801.tar.xz
2225
cd OpenWRT-UZ801
2326
```
2427

25-
2. Run the appropriate flash script:
28+
1. Run the appropriate flash script:
2629

2730
- **Windows**:
2831

pages/Overview.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
 
1+
# Overview
22

33
A couple of months ago, I purchased this 4G LTE USB dongle from Shopee for around 300+ PHP. Out of curiosity, I searched the internet to see if there was a way to modify the horrible web UI of the device. Here are some images of the device along with the board and its chips.
44

@@ -9,13 +9,11 @@ A couple of months ago, I purchased this 4G LTE USB dongle from Shopee for aroun
99
| ![board1](https://i.ibb.co/jTwXYQ8/soc1.jpg "board1") | ![board2](https://i.ibb.co/GWfPq4M/soc2.jpg "board2") |
1010
| ![front](https://i.ibb.co/dQ82vyz/soc3.jpg "front") | |
1111

12-
## Device
12+
## Device Specifications
1313

14-
The heart of the dongle is an MSM8916, running a stripped-down version of Android 4.4.4 KitKat. Interestingly, **the setup restricts the use of two other CPU cores, likely to prevent the device from overheating**.
14+
The heart of the dongle is an MSM8916, running a stripped-down version of Android 4.4.4 KitKat. Interestingly, **the setup restricts the use of two CPU cores, likely to prevent the device from overheating**.
1515

16-
### Device Specs
17-
18-
Processor:
16+
### Processor Information
1917

2018
```bash
2119
root@msm8916_32_512:/ $ cat /proc/cpuinfo
@@ -46,7 +44,7 @@ Serial : 0000000000000000
4644
Processor : ARMv7 Processor rev 0 (v7l)
4745
```
4846

49-
Ram:
47+
### Memory Information
5048

5149
```bash
5250
root@msm8916_32_512:/ $ cat /proc/meminfo

pages/References.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
 
1+
# References
22

33
This project references the following resources:
44

pages/Troubleshooting.md

Lines changed: 31 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,42 @@
1-
 
1+
# Troubleshooting
22

3-
## OpenWRT
3+
## OpenWRT Issues
44

5-
### No network/Modem stuck at searching
5+
### No Network/Modem Stuck at Searching
66

7-
First step is to extract the contents of modem.bin from your firmware dump if you use edl without `--genxml` flag you need to open the bin file with PowerISO or another software and extract the partition having type of `GPT FAT16`
7+
First, extract the contents of `modem.bin` from your firmware dump. If you used `edl` without the `--genxml` flag, you need to open the bin file with PowerISO or another software and extract the partition with type `GPT FAT16`.
88

9-
Once you have the `IMAGE` folder then go to this directory `IMAGE\MODEM_PR\MCFG\CONFIGS\MCFG_SW\GENERIC\` choose the folder according to your region:
9+
Once you have the `IMAGE` folder, navigate to this directory: `IMAGE\MODEM_PR\MCFG\CONFIGS\MCFG_SW\GENERIC\` and choose the folder according to your region:
1010

11-
- APAC - Asia Pacific
12-
- CHINA - China
13-
- COMMON - (You can use this if your region is not in the folders list)
14-
- EU - Europe
15-
- NA - North America
16-
- SA - South America
17-
- SEA - South East Asia
11+
- **APAC** - Asia Pacific
12+
- **CHINA** - China
13+
- **COMMON** - Use this if your region is not listed
14+
- **EU** - Europe
15+
- **NA** - North America
16+
- **SA** - South America
17+
- **SEA** - South East Asia
1818

19-
Once you have selected your region, you'll find a group of folders typically representing Telcos in your area. Click on the appropriate one until you locate `MCFG_SW.MBN`. Once found, proceed to transfer the file to your dongle by executing `adb push MCFG_SW.MBN /lib/firmware`. After the transfer is complete, execute `adb reboot`. You can now access the internet with your modem.
19+
Once you have selected your region, you'll find folders typically representing Telcos in your area. Navigate through the appropriate folder until you locate `MCFG_SW.MBN`.
20+
21+
**To apply the fix:**
22+
23+
1. Transfer the file to your dongle: `adb push MCFG_SW.MBN /lib/firmware`
24+
2. Reboot the device: `adb reboot`
25+
3. Your modem should now have internet access
2026

2127
> [!NOTE]
22-
> There are instances that the modem doesn't automatically work, If you encounter this issue you need to execute `adb shell` and `mmcli -m 0 -e` to enable your modem.
28+
> If the modem doesn't automatically work, you may need to execute:
29+
>
30+
> ```bash
31+
> adb shell
32+
> mmcli -m 0 -e
33+
> ```
34+
>
35+
> This will manually enable your modem.
2336
24-
### Connection Refuse
37+
### Connection Refused
2538
26-
If you encounter this problem simply set this on your OpenWRT dashboard
39+
If you encounter this problem, configure the following settings in your OpenWRT dashboard:
2740
2841
```bash
2942
Name
@@ -45,9 +58,9 @@ Action
4558
MASQUERADE - Automatically rewrite to outbound interface IP
4659
```
4760
48-
### Can't use RNDIS after Installation
61+
### Can't Use RNDIS After Installation
4962

50-
Download [RNDIS Driver](https://github.com/milkv-duo/duo-files/raw/main/common/RNDIS_drivers_20231018.zip) and add it your device manager
63+
Download the [RNDIS Driver](https://github.com/milkv-duo/duo-files/raw/main/common/RNDIS_drivers_20231018.zip) and add it to your device manager.
5164

5265
Alternatively you can use `Microsoft USB RNDIS` driver.
5366

0 commit comments

Comments
 (0)