Saltar al contenido principal

Tutorial de desarrollo del código fuente de MeshCore

Requisitos previos​

Herramienta necesaria​

Antes de comenzar, prepara las siguientes herramientas:

  1. Git
  2. Python 3
  3. VS Code

Instalar PlatformIO​

Busca PlatformIO en el marketplace de Extensiones de VS Code e instálalo.

img

Después de la instalación, normalmente aparecerá un icono con forma de hormiga en la barra de herramientas izquierda.

img

Preparación del proyecto​

Abre una carpeta en la que quieras tu proyecto. Abre la carpeta en la terminal. Haz clic aquí para hacer git clone del proyecto.

Abre VSCode, luego haz clic en el icono de PlatformIO y elige select a folder. Elige la carpeta donde clonaste el proyecto.

img

PlatformIO instalará automáticamente las dependencias necesarias. Después de que la instalación se complete correctamente, podrás ver Project has been successfully updated

img

Desarrollo de firmware​

Tutorial de desarrollo​

Encuentra el entorno para tu placa de destino. Toma el repetidor de nodo solar como ejemplo:

img

Entonces PlatformIO preparará las dependencias necesarias para la placa.

Modifica tu código. Se recomienda cambiar el archivo variant.h para tu placa.

Después de completar la programación, ejecuta el siguiente comando para compilar el código y convertirlo en un archivo uf2.

pio run -e SenseCap_Solar_repeater
pio run -e SenseCap_Solar_repeater -t create_uf2

Luego haz doble clic en el botón RST para entrar en modo DFU. Arrastra el archivo uf2 al disco emergente. El archivo uf2 se puede encontrar en .pio\build\SenseCap_Solar_repeater

Ejemplo​

Control de luz de usuario​

Este ejemplo muestra cómo escribir un bucle intermitente para la luz de usuario. Copia el siguiente código a /examples/simple_repeater/main.cpp

#endif
#ifdef LED_WHITE
static void updateUserLightBlink() {
  static unsigned long lastLedPhaseChangeAt = 0;
  static bool lightIsOn = true;

  const unsigned long now = millis();
  if ((unsigned long)(now - lastLedPhaseChangeAt) >= 5000) {
    lightIsOn = !lightIsOn;
    lastLedPhaseChangeAt = now;
  }

  digitalWrite(LED_WHITE, lightIsOn ? LED_STATE_ON : !LED_STATE_ON);
}

y escribe el bucle:

#ifdef LED_WHITE
  updateUserLightBlink();
#endif

Compílalo y graba el archivo uf2 en tu nodo solar.

(Avanzado) Envío de PR​

Gracias por considerar contribuir al proyecto MeshCore. ¿Cómo puedes contribuir? 1. Informar errores

  • Usa el rastreador de Issues
  • Usa un título claro (por ejemplo, "Crash when calling begin() with invalid pin")
  • Describe los pasos exactos para reproducirlo
  • Incluye tu placa, versión del IDE, versión de la biblioteca y fragmento de código relevante
  • Adjunta, si es posible, un ejemplo mínimo y completo

2. Sugerir mejoras / nuevas funciones

  • Abre un issue con el prefijo [Feature request]
  • Explica el caso de uso → ¿qué problema resolvería esto?
  • Describe tu API / comportamiento ideal (los ejemplos de código son muy útiles) 3. Enviar cambios de código (Pull Requests)

Pequeñas correcciones​

(errores tipográficos, comentarios, ejemplos, pequeñas correcciones de errores) → Simplemente abre un pull request — no es necesario un issue previo

Cambios más grandes / nuevas funciones​

  1. Abre primero un issue para discutir la idea
  2. Obtén un visto bueno general del/de los mantenedor(es)
  3. Haz fork del repositorio desde la rama 'dev' y crea tu rama (fix/xxx, feature/yyy, docs/loquesea)
  4. Realiza tus cambios
  5. Actualiza o añade ejemplos cuando sea apropiado
  6. Añade/actualiza comentarios en el código
  7. Envía el pull request

Directrices para Pull Requests​

  • Una función / corrección = un pull request (los PR pequeños son más fáciles y rápidos de revisar)
  • Usa mensajes de commit descriptivos Bueno: Fix I2C timeout handling on ESP32 Malo: update
  • Haz referencia a cualquier issue relacionado (Fixes #123, Closes #89, etc.)
  • Si cambias la API pública, actualiza README.md y library.properties
  • Las nuevas funciones deben incluir un ejemplo en examples/

Estilo de código​

Por favor, sigue el estilo de C++ existente (según .clang-format)

  • Sangría de 2 espacios (sin tabs)
  • camelCase para funciones y variables
  • UpperCamelCase / PascalCase para nombres de clases
  • Constantes #define en MAYÚSCULAS
  • Mantén las líneas < ~100 caracteres cuando sea razonable (Pero la coherencia con el código existente es más importante que las reglas estrictas)
Loading Comments...