hmathieu31 / JammerBox-System

PIR Project
GNU General Public License v3.0
1 stars 0 forks source link

Translate code from Microchip to STM32 #21

Open hmathieu31 opened 2 years ago

hmathieu31 commented 2 years ago

Précisions supplémentaires

A voir si ça fonctionnera concrètement vu la complexité du code et des dépendencies imbriquées mais la meilleure manière de commencer je pense que c'est :

remplacer directement

sinon si c'est donc une fonction applicative f qui se trouve dans le main.c

explorer la fonction en profondeur pour trouver les fonctions systèmes hard à remplacer et la traduire

sinon (c'est donc une fonction applicative f qui se trouve dans un module autre que le main

ajouter une issue sur Github indiquant que la fonction f est en court d'être portée Ouvrir une branche (création via github) correspondant à cette issue Traduire la fonction f sur cette branche Une fois f traduite, soumettre une Pull Request pour intégrer la traduction de la fonction à la branche #6 **

Principe

L'idée comme ça c'est qu'on puisse commencer à se répartir le main tout en évitant de se retrouver à être plusieurs à porter la même fonction en même temps. D'où l'idée et la contrainte de lever une issue Github à chaque fois qu'on commence à travailler sur une fonction qui n'est pas dans le main (pour indiquer aux autres qu'on est en train de travailler dessus). Et l'idée de soumettre des Pull Requests dès que le portage de ces fonctions est terminé pour ne pas avoir un nombre énorme de branches, et pour que ces fonctions puissent être rapidement utilisées par les autres.

Ressources basiques

https://code.visualstudio.com/blogs/2020/05/06/github-issues-integration

https://github.blog/2019-01-07-create-pull-requests-in-vscode/

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests

Schéma général du portage

image

Répartition du main

J'ai pas cherché à trop faire en fonction de la difficulté ou autre, j'ai fait simple :

Ressource sur la STM32

https://moodle.insa-toulouse.fr/course/view.php?id=79

Les 3 premiers PDFs sont super importants. Les autres ressources peuvent être interessantes mais pas indispensables.

hmathieu31 commented 2 years ago

Doc de la Microchip

https://ww1.microchip.com/downloads/en/DeviceDoc/70287C.pdf

hmathieu31 commented 2 years ago

PIR Auriol (Super useful)

https://moodle.insa-toulouse.fr/course/view.php?id=1612

emmanuel-pastor commented 2 years ago

Timers equivalence and config spreadsheet

https://docs.google.com/spreadsheets/d/1Oq7Hu4aGx7lSYo2BfrlU1t7bDO-qvOBSLxXd9N2k5LY/edit#gid=0

Ger0th commented 2 years ago

port_mapping.xlsx

Ger0th commented 2 years ago

Port_Mapping

https://docs.google.com/spreadsheets/d/1bUvto4pdkghTvD5kUYgrD0QGLQ5KlH1Ijyf4cs5j7HE/edit?usp=sharing