Drivers

Conductores

Repositorio centralizado para los impulsores de bajo nivel desarrollados por Zenith Aerospace

Objetivo • Entorno • Cómo usar un controlador • Agregar un controlador

Objetivo

Almacenar y administrar controladores desarrollados.

Cómo usar un controlador

Cada controlador está organizado en su propia carpeta, donde encontrará el par .c/.h . Simplemente agregue los archivos a su proyecto, por ejemplo, en un proyecto STM32Cubeide, agregue el archivo .c a la carpeta Core/Src y el .h al Core/Inc . Sin embargo, todos los controladores usan la platform "Framework", por lo que también debe copiar toda la carpeta de platform a su proyecto, en STM32Cubeide, agréguela a la carpeta Core/Inc . Todos los conductores deben tener un ejemplo de cómo usarlo.

Plataforma

El marco de la plataforma es un conjunto de macros y bibliotecas de encabezado que usan los controladores en lugar de funciones específicas de la plataforma. Por ejemplo, una transacción I2C en un proyecto STM32 llama a la biblioteca St Hal, lo que significa que el controlador (como es) solo se puede usar en microcontroladores STM32. El trabajo de la plataforma es detectar en qué microcontrolador se está compilando y luego elegir la biblioteca apropiada, para que un controlador desarrollado a la plataforma pueda usarse en otros microcontroladores/procesadores.

¿Cómo funciona?

Primero, el archivo platform.h establece la interfaz común para el controlador, structs comunes y firmas de funciones. Luego, un montón de directivas preprocesadoras intentan adivinar qué tipo de proyecto es e incluir la implementación correcta de la plataforma (biblioteca solo de encabezado) en la carpeta arch .

Para su información, si la plataforma no puede encontrar una implementación, es predeterminada a un modo de depuración de PC, donde se utiliza una implementación que solo se imprime a STDOUT.

Ambiente

Siendo realistas, utilizamos principalmente el STM32Cubeide, ya que la mayoría de los proyectos que hacemos se basan en esa plataforma. Pero con el marco de la plataforma solo debe necesitar un compilador C.

Agregar un controlador

Directrices para los conductores:

• Debe usar C a menos que sea necesario
  • Por qué: para maximizar la compatibilidad (sí, todavía hay UC que solo pueden usar C)
• Debe agregar algo de documentación con un ejemplo
  • Por qué: la mayoría de los usuarios solo quieren copiar y pegar el código correcto
• Debe usar las funciones de la plataforma para acceder a los recursos de hardware, a menos que sea necesario
  • Por qué: maximizar la compatibilidad, sin embargo, la plataforma no cubre todo, por lo que, por ahora, puede agregar un controlador que sea específico de la plataforma.

Pasos en una lista:

1. Clon este repositorio
2. Crea una carpeta con el nombre del controlador
3. Agregue el .c y .h
4. Agregue un archivo README.md a la carpeta de controladores
   1. En el readme agregue el autor, la fecha y el propósito de la biblioteca
   2. Agregar documentación: parámetros y propósito de cada función
   3. Agregue una sección de notas para cualquier información adicional del IC
5. (Opcional) Agregue una carpeta llamada Docs
   1. Agregue cualquier documentación externa que incluya hojas de datos, notas de aplicación y mapas de registro
6. Si hay un problema de GitHub para el controlador, agregue un mensaje o cierre.

---

[email protected]