Merge pull request #12 from hkfuertes/cosmetics

- Added LuCI RPC Api
- Changed `eth0` for `br-lan` in overview page.
- Removed `eth0` from `br-lan` as its not present in this device.
- Fixed `usb0` being multiple added to `br-lan`.

Author: hkfuertes

diffconfig

@@ -30,7 +30,9 @@ CONFIG_PACKAGE_libfdisk=y
 CONFIG_PACKAGE_libffi=y
 CONFIG_PACKAGE_libiwinfo=y
 CONFIG_PACKAGE_libiwinfo-data=y
+CONFIG_PACKAGE_liblua=y
 CONFIG_PACKAGE_liblucihttp=y
+CONFIG_PACKAGE_liblucihttp-lua=y
 CONFIG_PACKAGE_liblucihttp-ucode=y
 CONFIG_PACKAGE_libmbim=y
 CONFIG_PACKAGE_libmount=y
@@ -39,16 +41,25 @@ CONFIG_PACKAGE_libpcre2=y
 CONFIG_PACKAGE_libqmi=y
 CONFIG_PACKAGE_libqrtr-glib=y
 CONFIG_PACKAGE_libreadline=y
+CONFIG_PACKAGE_libubus-lua=y
 CONFIG_PACKAGE_lsblk=y
+CONFIG_PACKAGE_lua=y
 CONFIG_PACKAGE_luci=y
 CONFIG_PACKAGE_luci-app-firewall=y
 CONFIG_PACKAGE_luci-app-package-manager=y
 CONFIG_PACKAGE_luci-app-usb-gadget=y
 CONFIG_PACKAGE_luci-base=y
+CONFIG_PACKAGE_luci-lib-base=y
+CONFIG_PACKAGE_luci-lib-ip=y
+CONFIG_PACKAGE_luci-lib-json=y
+CONFIG_PACKAGE_luci-lib-jsonc=y
+CONFIG_PACKAGE_luci-lib-nixio=y
 CONFIG_PACKAGE_luci-lib-uqr=y
 CONFIG_PACKAGE_luci-light=y
+CONFIG_PACKAGE_luci-lua-runtime=y
 CONFIG_PACKAGE_luci-mod-admin-full=y
 CONFIG_PACKAGE_luci-mod-network=y
+CONFIG_PACKAGE_luci-mod-rpc=y
 CONFIG_PACKAGE_luci-mod-status=y
 CONFIG_PACKAGE_luci-mod-system=y
 CONFIG_PACKAGE_luci-proto-ipv6=y
@@ -73,6 +84,7 @@ CONFIG_PACKAGE_terminfo=y
 CONFIG_PACKAGE_tune2fs=y
 CONFIG_PACKAGE_ucode-mod-html=y
 CONFIG_PACKAGE_ucode-mod-log=y
+CONFIG_PACKAGE_ucode-mod-lua=y
 CONFIG_PACKAGE_ucode-mod-math=y
 CONFIG_PACKAGE_uhttpd=y
 CONFIG_PACKAGE_uhttpd-mod-ubus=y

packages/uci-usb-gadget/files/usb-gadget.sh

@@ -246,7 +246,8 @@ add_to_bridge() {
     local iface="$(cat "$ifname_file")"
     log "Adding $iface to bridge"
 
-    uci -q delete "network.@device[0].ports=$iface" 2>/dev/null || true
+    # Add the inteface to bridge
+    uci -q del_list "network.@device[0].ports=$iface" 2>/dev/null || true
     uci add_list "network.@device[0].ports=$iface"
 }
 
@@ -407,7 +408,7 @@ teardown_gadget() {
     for ifname in functions/*/ifname; do
         if [ -f "$ifname" ]; then
             local iface="$(cat "$ifname")"
-            uci -q delete "network.@device[0].ports=$iface" 2>/dev/null || true
+            uci -q del_list "network.@device[0].ports=$iface" 2>/dev/null || true
         fi
     done
     uci commit network

packages/uz801-tweaks/files/uci_defaults

@@ -16,6 +16,10 @@ uci set network.modem.ifname='wwan0'
 uci del_list firewall.@zone[1].network='modem'
 uci add_list firewall.@zone[1].network='modem'
 
+# We don't have eth0
+uci -q del_list "network.@device[0].ports=eth0" 2>/dev/null || true
+sed -i 's/"device": "eth0"/"device": "br-lan"/g' /etc/board.json
+
 # Commit all changes
 uci commit
 

readme.md

@@ -1,85 +1,76 @@
 ![OpenWrt logo](https://raw.githubusercontent.com/openwrt/openwrt/refs/heads/main/include/logo.png)
 
-OpenWrt Project is a Linux operating system targeting embedded devices. Instead
-of trying to create a single, static firmware, OpenWrt provides a fully
-writable filesystem with package management. This frees you from the
-application selection and configuration provided by the vendor and allows you
-to customize the device through the use of packages to suit any application.
-For developers, OpenWrt is the framework to build an application without having
-to build a complete firmware around it; for users this means the ability for
-full customization, to use the device in ways never envisioned.
-
-### This repository
-Modern version of OpenWrt working on UZ801v3:
-- Modem Working
-  - ModemManager not showing Rx/Tx in Luci
-- Wifi Working
-- USB gadget (NCM, RNDIS, MASS, ACM Shell)
-  - Configure via [uci](packages/uci-usb-gadget/readme.md) or `luci` app.
-- TUN installed
-- Wireguard Installed
-- `hotplug.d` scripts to manage leds, only on/off if iface, no blinking:
-  - On default Linux Kernel `dts`, leds are swapped!
-  - Wifi Led: [packages/ledcontrol/files/99-modem-led](packages/ledcontrol/files/99-modem-led)
-  - Modem Led: [packages/ledcontrol/files/99-wifi-led](packages/ledcontrol/files/99-wifi-led)
-- ~~Firmware is dumped on first boot from modem/persist partition:~~
-  - ~~Uses the binaries/firmware from the own device.~~
-  - __*This will return eventually...*__
-- Leaves the `luci-app-tailscale` package in `/root` ready to be installed:
-  - It is not auto installed as it will install `tailscale` that is a heavy package and not everyone is using tailscale.
-  - `apk add --allow-untrusted /root/luci-app-tailscale*.apk`
-- **SquashFS and OverlayFS**:
-  - The image no longer uses `ext4` for rootfs, instead it uses `squashfs`.
-  - This allows for an overlay `ext4` partition to be used and enables `firstboot` (factory reset) mechanism.
-
-
-### How to build OpenWrt
-Docker is required!
-```bash
+Modern OpenWrt build targeting the UZ801v3 LTE dongle with full modem and USB gadget support.
+
+## Table of Contents
+
+- [About OpenWrt](#about-openwrt)
+- [Features](#features)
+- [Prerequisites](#prerequisites)
+- [Building](#building)
+- [Installation](#installation)
+  - [Flashing from OEM Firmware](#flashing-from-oem-firmware)
+  - [Accessing Boot Modes](#accessing-boot-modes)
+- [Troubleshooting](#troubleshooting)
+  - [No Network / Modem Stuck at Searching](#no-network--modem-stuck-at-searching)
+- [Roadmap](#roadmap)
+- [Credits](#credits)
+
+---
+
+## About OpenWrt
+
+OpenWrt Project is a Linux operating system targeting embedded devices. Instead of trying to create a single, static firmware, OpenWrt provides a fully writable filesystem with package management. This frees you from the application selection and configuration provided by the vendor and allows you to customize the device through the use of packages to suit any application.
+
+## Features
+
+### Working Components
+- **Modem**: Fully functional with cellular connectivity
+  - ModemManager Rx/Tx stats not displayed in LuCI (known issue)
+- **WiFi**: Complete wireless support
+- **USB Gadget Modes**: NCM, RNDIS, Mass Storage, ACM Shell
+  - Configure via [UCI](packages/uci-usb-gadget/readme.md) or LuCI app
+- **VPN Ready**: TUN driver and WireGuard pre-installed
+- **LED Control**: Managed via `hotplug.d` scripts
+  - Note: LEDs are swapped in default kernel DTS
+  - WiFi LED: [99-modem-led](packages/ledcontrol/files/99-modem-led)
+  - Modem LED: [99-wifi-led](packages/ledcontrol/files/99-wifi-led)
+
+### Storage & Recovery
+- **SquashFS Root**: Compressed root filesystem
+- **OverlayFS**: ext4 overlay partition for user data
+- **Factory Reset**: `firstboot` mechanism enabled
+
+### Additional Packages
+- **Tailscale**: LuCI app included in `/root` (manual installation required)
+  - Install with: `apk add --allow-untrusted /root/luci-app-tailscale*.apk`
+  - Not auto-installed to save space
+
+## Prerequisites
+
+- Docker installed on your system
+- Basic knowledge of Linux command line
+- For flashing: [edl tool](https://github.com/bkerler/edl)
+
+## Building
+
+1. Enter the build environment:
+```
 cd devenv
-docker compose run --rm builder # This will open bash inside a build environment
-cp /repo/diffconfig .config # Copies the config on to the working folder
-echo "# CONFIG_SIGNED_PACKAGES is not set" >> .config # Optional: Disable APK signature verification
+docker compose run --rm builder
+```
+
+2. Configure and build:
+```
+cp /repo/diffconfig .config
+echo "# CONFIG_SIGNED_PACKAGES is not set" >> .config  # Optional: disable signature verification
 make defconfig
 make -j$(nproc)
 ```
 
-### How to flash from OEM
-- Install `edl`: https://github.com/bkerler/edl
-- Put the device in `edl` mode: https://wiki.postmarketos.org/wiki/Zhihe_series_LTE_dongles_(generic-zhihe)#How_to_enter_flash_mode
-- Do a full backup: `edl rf backup.bin`
-- Run `./openwrt-msm89xx-msm8916-yiming-uz801v3-flash.sh`: The script will backup the important partitions specific for your device, will flash everything and will restore de previously saved partitions.
-
-After the succesful flash if you:
-- Want to enter `fastboot`, just insert the device with the button pressed.
-- Want to enter `edl`, boot into fastboot and execute: `fastboot oem reboot-edl`.
-
-### No Network/Modem Stuck at Searching
-
-First, extract the contents of `modem.bin` from your firmware dump. You can do `eld r modem modem.bin`. In linux, its a simple image, you can mount it. Once you have it mounted, navigate to this directory: `image/modem_pr/mcfg/configs/mcfg_sw/generic/` and choose the folder according to your region:
-
-- **APAC** - Asia Pacific
-- **CHINA** - China
-- **COMMON** - Use this if your region is not listed
-- **EU** - Europe
-- **NA** - North America
-- **SA** - South America
-- **SEA** - South East Asia
-
-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`. If your telco is not listed, just grab a generic as it is done in this project for europe:
-```makefile
-  # packages/msm8916-firmware/Makefile
-  define Build/Compile
-      ...
-  		::image/modem_pr/mcfg/configs/mcfg_sw/generic/common/default/default/mcfg_sw.mbn $(PKG_BUILD_DIR)
-      ...
-  endef
-```
+## Installation
 
-#### To apply the fix:
-1. Transfer the file to your dongle: `scp -O mcfg_sw.mbn root@192.168.1.1:/lib/firmware/MCFG_SW.MBN`
-   - **Capitalization matters!** Modem expects it to be all caps.
-3. Reboot the device.
+### Flashing from OEM Firmware
 
 ### Future:
 - Recover `msm-firmware-dumper`.
@@ -90,13 +81,9 @@ Once you have selected your region, you'll find folders typically representing T
   - Feed:  `https://downloads.openwrt.org/snapshots/targets/msm89xx/msm8916/packages/packages.adb` has been removed from distfeeds file.
 
 ## Credits
-- @ghosthgy https://github.com/ghosthgy/openwrt-msm8916
-  - Starting point for this project.
-- @lkiuyu https://github.com/lkiuyu/immortalwrt
-  - Almost all the msm8916 folder + patches + openstick feeds.
-- @Mio-sha512 https://github.com/Mio-sha512/OpenStick-Builder
-  - `usb-gadget` and `msm-firmware-loader` idea (now `msm-firmware-dumper`).
-- @AlienWolfX https://github.com/AlienWolfX/UZ801-USB_MODEM/wiki/Troubleshooting
-  - For the carriers policy troubleshooting.
-- @gw826943555 and @asvow https://github.com/gw826943555/luci-app-tailscale
-  - Application for controlling tailscale from luci.
+
+- **[@ghosthgy](https://github.com/ghosthgy/openwrt-msm8916)** - Initial project foundation
+- **[@lkiuyu](https://github.com/lkiuyu/immortalwrt)** - MSM8916 support, patches, and OpenStick feeds
+- **[@Mio-sha512](https://github.com/Mio-sha512/OpenStick-Builder)** - USB gadget and firmware loader concepts
+- **[@AlienWolfX](https://github.com/AlienWolfX/UZ801-USB_MODEM/wiki/Troubleshooting)** - Carrier policy troubleshooting guide
+- **[@gw826943555](https://github.com/gw826943555/luci-app-tailscale) & [@asvow](https://github.com/asvow)** - Tailscale LuCI application