XXX
(The following is a general template for drivers. Specific modules can add sections for further explanation.)
Introduction
Function List
Feature Overview
(This can include principles, communication processes, etc. Basic circuit diagrams are recommended to be drawn using draw.io, with the original file (e.g., draw.io file) placed in docs/original (this directory will be deleted when the SDK is released).)
Feature Configuration
(This section can be named according to the module’s specifics.)
XX1 Configuration
(e.g., pin configuration)
XX2 Configuration
Main Features/ Application Examples
XX Function 1
(1. Clearly describe the starting conditions for using the function, 2. The timing of other interrelated modules or other APIs of this module, 3. Clear explanation of the results.)
XX Function 2
XX Function 3
Cautions
(Points to note for users when using the feature.)
Application Examples
(Link examples from the examples directory below. Other necessary examples should be placed in “Main Features/XX Function.”)
API Reference
Provide links.