Stan-Robotix-Source

Dépôt officiel de l'équipe Stan Robotix 6622 participant à la compétition FIRST

2019-2024

Structure

• Activités : tout ce qui n'est pas relié aux compétitions
• Compets : l'intégralité du code source des compétitions (BetaBots et FRC)
• Doc : documentation créée par l'équipe pour la communauté
  • Manuel sur les bases C++ et l'utilisation de WPILIB V1.1 DISPONIBLE
  • Liste d'exercices V1.3 DISPONIBLE
  • Corrections de la liste d'exercices V1.3 DISPONIBLE
  • Aide rapide sur Git et Github V1.0 DISPONIBLE
  • Aide sur la structuration d'un programme C++ V1.0 DISPONIBLE

Exécuter un programme

• Code de compétition : chaque projet possède dans son nom l'année de création. Pour utiliser en 2024 un projet de 2023 il faut s'assurer de :
  • Mettre à jour WPILIB et VS Code
  • Mettre à jour les dépendances supplémentaires
  • Importer le projet
• Code des activités : il est nécessaire de compiler chaque programme en utilisant un compilateur. GCC est recommandé.

Conventions de structure

• Branches :Année-StanRobotix-Compétition-SousSytème/Commande
• Répertoires : Année_StanRobotix_Compétition/Projet

Les conventions de code

• Programmer en anglais
• Variables dans les méthodes :
  • Préfixe i (input) pour les variables d'entrée (e.g. iMotor)
  • Préfixe o (output) pour les variables de sorties (e.g. oAngle)
• Variables locales :
  • Préfixe w (work) (e.g. wSpeed)
• Dans une classe :
  • Préfixe m (my) pour les attributs (e.g. mAccelerometer)
  • Le nom des méthodes commence par une minuscule puis on utilise des majuscules pour les autres mots (e.g. setVoltage())
• Préfixe k (constant) pour les variables constantes (e.g. kPi)
• Mettre des commentaires mais ne pas en abuser

Rappel des commandes de base de Git

git clone
git status
git add *
git add "NomDuFichier"
git rm "NomDuFichier"
git commit -m "MessageQuiADuSens"
git push
git checkout NomDeLaBranche
git branch NomDeLaBranche
git pull
git fetch
gitk

Gestion

La gestion du dépôt (modification du README ou modifications majeures) est laissée au chef de l'équipe et aux mentors.

Chef d'équipe : André Wojcik
Mentors : Raphaël Pothier et Clément Jevardat-de-Fombelle

Contacts :
andre.wojcik@stanislas.qc.ca
raphael.pothier@umontreal.ca