SDK Feedback Guide_Rev1.1

Chinese

1 Revision History

Version

Date

Author

Changes

Rev1.1

2026-06-05

MBB

Improved the issue report template and contact information

Rev1.0

2026-04-22

MBB

Created document

2 Introduction

This document describes the recommended way to report issues and the required information for faster problem diagnosis.

3 Project Overview

Lierda LTE-EC71X OpenCPU SDK is an OpenCPU development kit for the EC71X module series. The SDK allows developers to run custom applications directly on the module without an external MCU.

Key features:

Feature

Description

Module platform

EC71X series

Supported modem packages

F6B_A, F6D_A, F7B_A, K2B_A, K2F_A, etc.

OS

FreeRTOS real-time operating system

API interface

Based on CMSIS-OS2 at the lower layer, with Lierda OpenCPU API / OSAL mainly used on the user side

Middleware

MQTT, HTTP, LwIP, mbedTLS, LittleFS, etc.

Toolchains

GCC, Keil

System interfaces

Filesystem, GPIO, UART, low-power management, etc.

4 Issue Reporting

4.1 Types of Feedback

Type

Description

Example

Bug report

Functional exception, crash, error

Build failure, flashing or boot issue, runtime crash, peripheral or network issue

Feature request

New feature or improvement

Request support for protocol X, optimize interface Y

Documentation issue

Errors, omissions, unclear explanations

Incorrect API doc, missing usage example

Usage question

Questions during usage

How to implement feature X, meaning of parameter Y

For bug reports, it is recommended to include the issue category in the title, for example: build issue, flashing/boot issue, runtime crash, peripheral driver, network protocol, low power, or FOTA.

4.2 Report Template

Please use the following template as much as possible to help speed up diagnosis:

### Issue Type
Bug report / Feature request / Documentation issue / Usage question

### Issue Category (recommended for bug reports)
Build issue / Flashing or boot issue / Runtime crash / Peripheral driver / Network protocol / Low power / FOTA / Other

### Description
Clearly describe the issue, error messages, and impact.

### Environment
- SDK version: version / tag / commit
- PROJECT:
- Module model (MODEM):
- Modem package (MODEMPKG):
- Chip platform: EC71X
- Toolchain version:
- Build command:
- Operating system:

### Hardware Information (recommended for hardware-related issues)
- Board type: EVB / customer board
- Power supply:
- Key connections and peripherals: UART / GPIO / SPI / I2C / USB, etc.
- Peripheral model:

### Reproduction Steps
1. ...
2. ...
3. ...

### Reproduction Details
- Always reproducible:
- Reproduction probability:
- Trigger condition:
- Approximate time from power-on to issue occurrence:

### Logs and Attachments
- Log type: build log / runtime log / dump / packet capture / waveform screenshot
- Log source: Debug UART / USB / other
- Please provide the complete log from power-on to issue occurrence whenever possible
- If available, attach a minimal reproducible project or key code snippets

### Expected Behavior
Describe the expected correct behavior.

4.3 Additional Notes for Feature Requests

When submitting feature requests, please additionally provide:

  • Use-case scenarios

  • Expected implementation approach

  • Compatibility considerations with other features

4.4 Submission Notes

  • For build failures, runtime crashes, or peripheral issues, a minimal reproducible project or key code snippets are strongly recommended.

  • Logs should cover the complete process from power-on to issue occurrence whenever possible, and the log source should be specified.

  • Please mask sensitive information such as IMEI, SIM card numbers, server addresses, keys, and account information before submission.

5 Contact

Channel

Use Case

Description

GitHub repositories

Public issue reporting, documentation issues, feature requests

https://github.com/orgs/lierda-iot/repositories

Technical discussion

General technical communication

Scan the QR code below to join the discussion group

Email

Private issues or issues not suitable for public posting

yumx@lierda.com, liangj@lierda.com

6 Acknowledgements

Thanks to all contributors to this project.