1
0
Fork 0
Projet_Barbapapa_Firmware/Utils/README.md
Teo-CD e21123538b Utils: Introduce utils and animation helpers
The next commit implements the LCD and animation support. To enable an easy
way to create animations for it, add details in the README regarding the way
the SD card is used and how the files need to be formatted.

Create the Utils directory and add a Rust project to do the bit flipping and
a script that automates all the steps described in the README.
Add a README for Utils explaining how to use them.
2023-10-21 21:59:54 +01:00

1.9 KiB

Utilitaires

Ce sous-dossier rassemble divers utilitaires liés au projet.

Conversion des animations

Deux outils sont disponnibles pour aider à la conversion : un pour faire l'inversion de bit nécessaire, et un script pour automatiser tout le protocole.

Pour des détails sur le format de sortie, référez-vous au README principal.

bitmap_helper

Un projet Rust a été créé pour permettre la conversion d'une bitmap MONO gérée par ImageMagick en une bitmap correcte pour le LCD, en inversant les bits de chaque octet.

Il est possible qu'une version compilée soit disponible dans les versions sur Github.

Compilation

Pour le compiler, il suffit d'utiliser Cargo, qui peut être installé via rustup par exemple.
Une fois Rust et Cargo disponibles, la compilation peut être faite depuis le dossier bitmap_helper avec la commande suivante :

cargo build

L'exécutable produit est alors bitmap_helper/target/debug/bitmap_helper.

Utilisation

L'utilitaire peut convertir plusieurs fichiers .mono à la fois, passés directement sur la ligne de commande.

bitmap_helper/target/debug/bitmap_helper <frame00>.mono <frame01>.mono ...

Tout autre format de fichier ne sera pas traité.
⚠️ La détection du format n'est basée que sur les extensions !

convertAnimGif.sh

Ce script permet d'automatiser tout le protocole de conversion d'un ou plusieurs gifs en suites de bitmaps utilisables par le projet.

Il prend en argument un ou plusieurs fichier(s) .gif et produit les bitmap individuelles correctement numérotées dans un dossier portant le nom du fichier original.

./convertAnimGif.sh <animation1>.gif <animation2>.gif ...

Il suffit ensuite de déposer les dossiers sur la carte SD, sous les dossiers correspondants (voir noms dans src/IDs.cpp) et les renommer pour ne laisser que ANIM.