Getting Started

Welcome to the Wiki Developer Documentation! This guide is intended to help software and hardware developers quickly understand the content structure of the Wiki and how to use it, making your development work more efficient. Whether you are a beginner or an experienced developer, you can find learning and reference resources suitable for you in the Wiki. If you encounter documentation issues, please provide feedback promptly, and we will handle them in a timely manner.

Intended Wiki Users

The Wiki is an efficient knowledge base, especially suitable for the following developers:

  • Software developers: Provides complete development resources from getting started to advanced topics.

  • Hardware developers: Covers important documents and tools required for hardware design.

Please select the appropriate content for learning and reference according to your needs and development stage.

Content Structure and Usage

1. Getting Started with Software Development

If you are just starting to learn software development, we recommend starting with the following sections:

  • Recommended Reading:

    • SDK Programming Guide

    • FAQ (Frequently Asked Questions)

  • Main Content

    • Suitable for users who want to get started with development quickly.

    • Provides detailed steps for setting up the development environment and implementing basic functions.

    • Covers common sample code and development tips.

    • Helps beginners quickly master development tools and fundamental knowledge.

  • Usage Steps:

    • In the Wiki main directory, find “Software Development > SDK Programming Guide”.

    • Read the chapters in order and complete the sample code exercises with the development board.

    • If you encounter any issues, go to “Software Development > FAQ (Frequently Asked Questions)” to find solutions.

2. Advanced Software Development

Users with some development experience can go directly to more in-depth technical content:

  • Recommended Reading:

    • API Documentation

    • Application Notes

  • Main Content:

    • Provides comprehensive API documentation, including function descriptions, parameter definitions, and usage examples.

    • Helps developers quickly call interfaces and implement complex functions.

    • Covers best practices for common application scenarios.

    Usage Steps:

    • Find the required module or function in “API Documentation”.

    • Locate the specific API interface documentation by module category.

    • Read the relevant sample code as needed and integrate it into your project.

3. Hardware Development

Hardware developers can use the hardware-related documents in the Wiki to better complete design and development work:

  • Hardware Design Guide:

    • Provides technical specifications for hardware design, schematic references, and PCB design recommendations.

    • Includes practical recommendations for design considerations and performance optimization.

    • Helps developers understand how hardware and software work together.

    Usage Steps:

    • Go to “Hardware Design Guide”.

    • Review the design specifications to ensure your design complies with the recommendations in the documentation.

    • Download relevant document templates or reference designs according to project requirements.

Usage Recommendations

  1. Keyword Search:

    • If you are not sure where to find the content you need, use the Wiki’s built-in search function.

    • Enter keywords, such as a feature name, interface name, or hardware module number, to quickly locate related content.

  2. Learn with Sample Code:

    • The Wiki contains a large number of sample code examples. We recommend practicing with actual projects to deepen your understanding of the documentation.

  3. Check for Updates Regularly:

    • The Wiki documentation is updated regularly. Please check the update log on the home page to stay up to date with the latest development support information.

Technical Support

If you encounter any issues while using the Wiki, we recommend that you:

  1. Refer to the FAQ section, which lists common issues and their solutions.

  2. Contact the relevant technical personnel for assistance through the technical support channels provided by the project team.

Thank you for using the Wiki development documentation. We hope it becomes a valuable assistant in your development work, and wish you success in your work and projects.