Skip to content

Contents

For all permission issues

  • For access to developer resources, please contact sales or technical support for approval.

Software Developer Portal News

Roaming test report


NHX-SDK-ODM code repository

Note:

  • For access to code repositories, please contact sales or technical support for approval.
Apply for permission group linkcode repositoryopenwrtDriverKernelSDKSupported ModelsRemarks
FAE-NHX-QSDK-11.5-ODMNHX-QSDK -11.5-ODM15.05qsdk-11.5v4.4Source code for nhxwrt sdk kit excluding vendor-restricted binaries (e.g. the QSDK driver)NHX4019
NHX5018
NHX6018
LTS
Recommended
FAE-NHX-QSDK-12.2-ODMNHX-QSDK-12.2-ODM19.07qsdk-12.2v5.4Source code for nhxwrt sdk kit excluding vendor-restricted binaries (e.g. the QSDK driver)NHX5018
NHX6018
NHX53X2-V01
NHX53X2-V03
LTS
FAE-NHX-QSDK-12.5-ODMNHX-QSDK-12.5-ODM23.05qsdk-12.5v5.4Source code for nhxwrt sdk kit excluding vendor-restricted binaries (e.g. the QSDK driver)NHX5018
NHX6018
NHX53X2
LTS
Requires project permission groupNHX-ATH11K-ODM21.02ath11kv5.4Open-source wireless drivers (ath11k)NHX4019
NHX5018
NHX6018

Software module

Note:

  • Software module permissions inherit repository access permissions.
Project WikiGit Repositorycode deliverysupported modelsremarksPerformance pk advantage level
NHX-STAROAM-BIN NHX-STAROAMpkg-binNHX4019, NHX5018, NHX6018, NHX53X2Wireless roaming applicationA
NHX-API-BIN NHX-APIpkg-binNHX4019, NHX5018, NHX6018, NHX53X2API Application
NHX-IAC-BIN NHX-IACpkg-binNHX4019, NHX5018, NHX6018, NHX53X2Wireless Controller Application
NHX-MESH-BIN NHX-MESHpkg-binNHX4019, NHX5018, NHX6018, NHX53X2Mesh ApplicationA
NHX-VUE-ODMNHX-VUEpkg-srcNHX4019、NHX5018、NHX6018、NHX53X2vue source code
nhxwebnhxwebpkg-binNHX4019、NHX5018、NHX6018、NHX53X2vue binary web file
NHX-PACKAGES-OPENNHX-PACKAGES-OPENpkg-srcNHX4019、NHX5018、NHX6018、NHX53X2Open Source Applications
NHX-DLNHX-DLNHX4019、NHX5018、NHX6018、NHX53X2Compile dependency cache library
NHX__-SDKNHX-SDKsrcNHX4019、NHX5018、NHX6018、NHX53X2Model file; dts file
nhx_longbridgenhx_longbridgenhxwifikoNHX5018、NHX6018、NHX53X2Long distance transmission
NHX-QSDK-12.2-ODM support
A
nhxpcfnhxpcfnhxwifikoNHX4019, NHX5018, NHX6018, NHX53X2802.11 PCFA
nhxhcfnhxhcfnhxwifikoNHX4019, NHX5018, NHX6018, NHX53X2802.11 HCFA
nhxantnhxantnhxwifikoNHX4019、NHX5018、NHX6018、NHX53X2Smart antenna
nhxtdmanhxtdmanhxwifikoNHX5018、NHX6018、NHX53X2TDMAA

NHX SDK software framework

  1. master branch: Source code for qsdk sdk kit excluding vendor-restricted binaries (e.g. the QSDK driver)
  1. nhxwrt branch: Source code for nhxwrt sdk kit excluding vendor-restricted binaries (e.g. the nhxwifiko driver); Deeply optimized driver; supports nhx applications

Framework Process Icon Description

graph LR
1>Project Node]
2[code repository node]
3[[Developer feeds node]]
4{{code repository branch node}}
5((public feeds node))

NHX-PACKAGES-OPEN framework

graph LR
A>NHX-PACKAGES-OPEN]-.Repos..->B[[NHX-PACKAGES-OPEN]]
B ---> B1[network]
B ---> B2[firmware]

B1 ---> B101[iperf]
B1 ---> B102[iperf3]

B101-.ipk..->Z((docs.bitswrt.com))
B102-.ipk..->Z
B2-.ipk..->Z

subgraph all package-open repos
B
end

subgraph all package-open ipk
Z
end

click Z "http://docs.bitswrt.com"
click A "https://dev.azure.com/lede/NHX-PACKAGES-OPEN"

pipelines

NHX-SDK pipelines

  • Publish firmware to docs.bitswrt.com azure-build/NHX6018-Product model.yml azure-build/NHX5018-Product model.yml azure-build/NHX4019-Product model.yml azure-build/CPE7621-Product model.yml

NHX-PACKAGES-BIN pipelines

  • Publish to Repos [packages name] Naming rules for pipelines:qca-packages name-bin.yml mtk-packages name-bin.yml PKG naming rules:qca-packages name-bin mtk-packages name-bin Note: each private PKG corresponds to a PKG feed warehouse

NHX-PACKAGES-OPEN pipelines

  • Publish to docs.bitswrt.com (ipk file) Naming rules for pipelines:mtk-package-bin.yml mtk-package-bin.yml PKG naming rules:packages name

Git Repositories

Usage:

Git Credential Helper Configuration (Recommended, only for bitswrt-clients repositories):

  1. Install Git Credential Manager

    • macOS:
      Terminal window
      brew install git-credential-manager
    • Windows: Included with Git for Windows, no separate installation required.
    • Linux (Debian/Ubuntu):
      Terminal window
      sudo apt-get update
      sudo apt-get install git-credential-manager
    • Linux (CentOS/RHEL):
      Terminal window
      sudo yum install git-credential-manager
  2. Configure credential helper only for bitswrt-clients repositories

    Execute in terminal:

    Terminal window
    git config --global credential.https://github.com/bitswrt-clients.helper manager
  3. Verify configuration

    Execute:

    Terminal window
    git config --global --list | grep credential

    You should see:

    credential.https://github.com/bitswrt-clients.helper=manager
  4. Automatic effect when cloning repositories

    When you clone or operate any repository under https://github.com/bitswrt-clients/, Git Credential Manager will be used automatically, and you do not need to enter your username and token every time.

  5. Remove/reset configuration (if needed)

    Terminal window
    git config --global --unset credential.https://github.com/bitswrt-clients.helper

Git Usage Examples

After configuration, you can perform the following Git operations:

1. Clone Main Repository

Terminal window
# Clone NHX-QSDK-11.5-ODM main repository
# Username: bitswrt
# Project link already contains repository token and git link, copy and use directly
git clone https://github.com/bitswrt-clients/NHX-QSDK-11.5-ODM.git
# Use complete link format (recommended)
git clone https://bitswrt:[email protected]/bitswrt-clients/NHX-QSDK-11.5-ODM.git
# Clone to specified directory
git clone https://bitswrt:[email protected]/bitswrt-clients/NHX-QSDK-11.5-ODM.git nhx-sdk-project

Get Complete Clone Link:

  1. Visit project page: https://dev.bitswrt.com/devs/projects/NHX-QSDK-11.5-ODM
  2. Click “Copy Clone Link” button
  3. The copied link already contains username(bitswrt), token and repository address, can be used directly

2. Pull Latest Code

Terminal window
# Enter project directory
cd NHX-QSDK-11.5-ODM
# Pull latest code
git pull origin master
# Or specify branch
git pull origin nhxwrt

3. View Repository Status

Terminal window
# View current status
git status
# View branch information
git branch -a
# View commit history
git log --oneline -10

4. Switch Branches

Terminal window
# Switch to nhxwrt branch
git checkout nhxwrt
# Create and switch to new branch
git checkout -b feature/new-feature
# Switch to specific model branch
git checkout nhxwrt_nhx6018

5. View Remote Repository Information

Terminal window
# View remote repositories
git remote -v
# Add remote repository
git remote add upstream https://github.com/bitswrt-clients/NHX-QSDK-11.5-ODM.git

6. Common Problem Resolution

Terminal window
# If authentication issues occur, clear credentials
git credential-manager reject https://github.com/bitswrt-clients/NHX-QSDK-11.5-ODM.git
# Force pull (overwrite local changes)
git fetch origin
git reset --hard origin/master
# View Git configuration
git config --list | grep credential

Note: On first operation, Git Credential Manager will pop up an authentication window. Enter your username and access token. After successful authentication, subsequent operations will automatically use saved credentials.


Token Expiration: Update and Handling

If your access token has a limited validity period due to security policies, please follow these steps after expiration:

  1. Obtain a new access token
    Go to the project page (e.g., https://dev.bitswrt.com/devs/projects/project-name ) to generate and copy a new access token.

  2. Clear locally saved old credentials
    It is recommended to use Git Credential Manager to clear credentials for the specific repository:

    Terminal window
    git credential-manager reject https://github.com/bitswrt-clients/NHX-QSDK-11.5-ODM.git

    Or use the following command to clear all credentials for the bitswrt-clients organization:

    Terminal window
    printf "protocol=https\nhost=github.com\npath=bitswrt-clients\n" | git credential-manager erase

    To erase credentials for a specific repository (optional):

    Terminal window
    printf "protocol=https\nhost=github.com\npath=bitswrt-clients/NHX-QSDK-11.5-ODM.git\n" | git credential-manager erase

    Note: protocol specifies the protocol, host specifies the host, and path specifies the bitswrt-clients organization or specific repository.

  3. Re-authenticate
    When you perform git pull, git push, or git clone, the system will prompt for your username (e.g., bitswrt) and the new access token.
    After successful authentication, Git Credential Manager will automatically save the new credentials until the token expires again.

For automated credential cleanup and update, you may write scripts as needed.


Firmware Release