Skip to content

Latest commit

 

History

History
79 lines (67 loc) · 3.56 KB

README.md

File metadata and controls

79 lines (67 loc) · 3.56 KB

Drivers

Collection of Low-Level Drivers and Documentation

Objective • Environment • Adding a Driver

Objective

Unify all drivers written by the group adding proper documentation.

Environment

All our functions are based on the STM32's HAL drivers. The use of the STM32CubeIDE is highly recommended because it easies the process of peripheral configuration, code generation, code compilation, and debug.

We prefer to develop drivers in C, although the STM32CubeIDE supports C++ projects.

Adding a Driver

  1. Clone this repository
  2. Create a folder with the Driver name
  3. Add the Src and Inc with the .c and .h
  4. Add a README.md file to the Driver folder
    1. On the README add the Author, Date, and purpose of the library
    2. Add Documentation: Parameters and purpose of each function
    3. Add a Notes Section for any extra information of the IC
  5. Add a folder called Docs
    1. Add any External Documentation including Datasheets, Application Notes, and Register Maps
  6. If there is a GitHub Issue for the Driver add a message or close it.

[email protected]