Skip to content
NearLink ToolBox

Help Us

Thank you for considering contributing to the NearLink ToolBox!

How to Contribute

Submit Firmware

  1. Fork this repository
  2. Create your firmware directory under the firmwares directory
    • Directory naming is recommended to be in English
    • Avoid using manufacturer names such as BearPi, HiHope, etc.
    • Keep it concise and understandable
  3. Add the following files:
    • Firmware file in .fwpkg format
    • readme.md project introduction
    • metadata.json metadata file
    • Optional .pdf user manual
  4. Submit a Pull Request

metadata.json Specification

{
    "online": true,                                     // Whether to display online
    "imageUrl": "Firmware introduction image URL",      // Optional, for showcasing firmware features
    "packageName": "AT Command Firmware",               // Firmware name
    "description": "Basic communication firmware supporting AT command set", // Brief introduction
    "author": "Author Name",                            // Author information
    "authorAvatar": "Author avatar URL",                // Github avatar, etc.
    "needCode": false,                                 // Whether an invitation code/in-app purchase is needed
    "categories": [
        "Communication Function"                       // Only options: Communication Function/Mobile Terminal/Domestic Replacement/IoT/Smart Home/Entertainment Function/Experience Trial/Physical Product/Physical AT/Physical Product
    ],
    "chips": [
        "Hi2821",                                      // Supported chip models: Hi2821/Hi2825/Hi3863/Hi3873
        "Hi3863"
    ],
    "brands": [
        "HiHope",                                      // Supported brands: HiHope/BearPi/OpenHarmony/Chenmai Tech/Huawei HiSilicon/Lierda/Ai-Thinker/Tiangonix/Haohanyh
        "BearPi"                                       // Personal/manufacturer brands need to contact maintainers for addition
    ],
    "files": [
        {
            "name": "Firmware Documentation",           // File description
            "filename": "User Manual.pdf"               // File name
        }
    ],
    "serialcuts": [                                    // Accompanying serial command sets
        {
            "name": "Command Set Name",                // e.g., "Multi-Command Set Professional Edition"
            "filename": "commands.json"                // Command set file name
        }
    ]
}

Share Serial Commands

  1. Use the software’s graphical interface to edit the command set
  2. Export the command set JSON file
  3. Add the serialcuts field in the metadata.json of the firmware directory:
{
    // ... Other firmware metadata fields
    "serialcuts": [
        {
            "name": "Command Set Name",                // e.g., "HH-D03 Multi-Command Set Professional Edition"
            "filename": "Command Set File Name.json"   // Corresponding JSON file in the firmware directory
        }
    ]
}
  1. Place the command set JSON file in the corresponding firmware directory

Note: The command set should be used in conjunction with the firmware, it is recommended to:

  • Provide clear command classifications
  • Include necessary usage instructions
  • Ensure command accuracy
  • Optionally provide a PDF format command manual

Submit Issue

  1. Use the appropriate Issue template
  2. Provide a detailed problem description
  3. If it is a bug, please provide:
    • Reproduction steps
    • Environment information
    • Relevant logs
    • Screenshots

Submit Pull Request

  1. Ensure the PR title format is correct:
    • New firmware: feat: Create XXX New Firmware
    • Serial commands: feat: Create XXX New Serial Shortcuts
  2. PR description should include:
    • Explanation of changes
    • Reference to related issues
    • Test result description
  3. Select the correct reviewer (@Hny0305Lin)
  4. Ensure all checks pass

Notes

  1. All content must comply with the laws and regulations of Mainland China
  2. Firmware must not contain:
    • Code that damages others’ devices
    • Functions that interfere with communication
    • Illegal or non-compliant content
  3. Documentation should be in Simplified Chinese, code comments are recommended to be bilingual in Chinese and English

Code of Conduct

Please read our Code of Conduct.

License

By contributing your code, you agree to license it under the project’s MIT License.