Firmware educativo para Kits Robóticos – PUCP

Este repositorio contiene el firmware base desarrollado en MicroPython para kits robóticos educativos utilizados en la carrera de Ingeniería Mecatrónica en la Pontificia Universidad católica del Perú. El proyecto está diseñado para facilitar el aprendizaje práctico de temas fundamentales en robótica móvil y robótica de manipuladores.

Objetivos del proyecto

Desarrollar una plataforma de firmware modular y educativa que permita a los estudiantes:

Plataformas soportadas

• Robot con ruedas mecanum
• Brazos robóticos
• (Futuro) Vehiculo diferencial, ackerman, Robots con patas, LIDAR, otros sensores

Estructura del repositorio

Software_Pico/
│
├── firmware/              ← Código fuente principal del firmware
│   ├── config/            ← Archivos de configuración (hardware, estudiantes)
│   ├── robot/             ← Implementaciones de los distintos robots
│   ├── sensors/           ← Interfaces para sensores (IMU, encoder, ultrasónicos)
│   ├── utils/             ← Utilidades compartidas (PID, secuencias, jacobianos)
│   └── libraries/         ← Librerías externas o wrappers (MQTT, IMU)
│
├── student_examples/      ← Ejemplos de código para uso en laboratorios
├── labs/                  ← Prácticas guiadas por tema o curso
├── tests/                 ← Scripts internos para pruebas de hardware/software
│   └── helpers/           ← Utilidades para pruebas
├── docs/                  ← Documentación técnica y guías de uso
│   └── hardware           ← Diagramas de conexiones y specificaciones
│   └── modules            ← Documentacion de modulos para uso de estudiantes
└── dev_tools/             ← Scripts para compilación, flasheo, etc.

Guía de Inicio para Estudiantes

Sigue estos pasos en orden para configurar tu robot desde cero y dejarlo listo para los laboratorios.

Parte 1: Preparación del Entorno

En esta parte, instalarás todo el software necesario en tu computadora y en la placa Pico W.

• Paso 1: Instalar el Firmware en la Pico W

  • Sigue las instrucciones de la Guía 1: Instalación del Firmware para preparar tu placa.

• Paso 2: Ejecutar tu Primer Programa

  • Aprende a usar Thonny con la Guía 2: Tu primer programa con Thonny.

• Paso 3: Cargar los Archivos del Robot

  • Transfiere las librerías a tu placa siguiendo la Guía 3: Carga de archivos base.

Parte 2: Configuración y Verificación del Robot

Una vez finalizada la configuración del entorno, el siguiente paso es la calibración de los motores para asegurar su correcto funcionamiento.

• Paso 4: Verificación y Ajuste de la Dirección de los Motores

  Se debe seguir un proceso iterativo de prueba y ajuste para cada motor del robot.

  1. Abrir el script de diagnóstico: Mediante Thonny, abra el archivo 1_test_wheel_direction.py, ubicado en el directorio student_examples/ de su proyecto local.

  2. Seleccionar el motor a probar: En el código fuente del script, modifique el valor del parámetro motor_id en la llamada a la función test_wheel_direction(). Asigne el índice del motor que desea verificar (p. ej., motor_id=0 para el primer motor).

      # En el archivo 1_test_wheel_direction.py
      ROBOT_TYPE = 'test'
      # Inicializa la instancia del robot con los parámetros correspondientes
      robot = get_robot(ROBOT_TYPE, CONFIG[ROBOT_TYPE])
  
      # Ejecuta la prueba en el motor con índice 1
      # Realizar la prueba con cada motor y modificar la configuración
      # en config.py según corresponda
      test_wheel_direction(robot, motor_id=1)
  

  1. Ejecutar la prueba: Ejecute el script en Thonny (▶). Observe el comportamiento físico de la rueda seleccionada y la información de diagnóstico que se imprime en la consola.

  2. Aplicar correcciones (si es necesario): Si el comportamiento observado no es el esperado, abra el archivo de configuración /config/student_config.py ubicado en la memoria de la Raspberry Pi Pico.

     Advertencia Importante

     No modifiques config.mpy — este archivo está protegido y contiene la configuración base. Modifica únicamente student_config.py.

     Aplique los siguientes ajustes según el caso: * Rotación del motor invertida: Si el motor gira en la dirección opuesta a la esperada, añada el parámetro "inverted": True al diccionario del motor correspondiente. * Lectura del encoder invertida: Si la consola indica que la lectura del encoder es incorrecta, añada el parámetro "encoder_inverted": True. * Operación correcta: Si el motor funciona correctamente, el diccionario correspondiente debe permanecer vacío ({}).

     # Ejemplo de aplicación de correcciones en /config/student_config.py
     MOTOR_DIRECTION = [
         {"inverted": True},          # Motor 0: requería inversión de giro.
         {},                          # Motor 1: operaba correctamente.
         {"encoder_inverted": True},  # Motor 2: requería inversión de la lectura del encoder.
         # ... y así sucesivamente.
     ]
     

  3. Guardar y repetir el proceso: Guarde los cambios en el archivo student_config.py y repita los pasos 2 a 4 para cada uno de los motores del robot.

Laboratorios incluidos

Versionado

Cada semestre académico se etiqueta una versión estable del repositorio.

Para ver y utilizar una versión anterior, puedes usar los siguientes comandos:

git tag                
git checkout v2024-2-labkit

1. Listar versiones: El comando git tag te mostrará todas las etiquetas disponibles en el historial del proyecto.
2. Cambiar de versión: Una vez que identifiques la etiqueta que necesitas, git checkout te permite "viajar en el tiempo" a ese punto exacto del código.

Organización del Desarrollo

Las contribuciones del equipo se organizan a través de las siguientes ramas principales:

Licencia

Este proyecto es de uso académico exclusivo para cursos dictados en la PUCP.
Para solicitudes de uso externo, contactar con el equipo docente o coordinador del proyecto.

Contacto

Para dudas, soporte o sugerencias:

• Coordinador técnico: [dequiroz@pucp.edu.pe]
• Repositorio oficial: https://github.com/PUCP-Robotica-IA/Software_Pico