fxSDK, un SDK alternatif pour écrire des add-ins
Posté le 29/08/2014 22:00
Cette page sert d'index pour la série de topics du fxSDK.
Le fxSDK est une collection d'outils permettant de développer des add-ins pour les calculatrices Casio des séries Graph. C'est une alternative au
fx-9860G SDK et
PrizmSDK qui ne sont plus activement maintenus, et le compagnon classique de mon noyau
gint.
Index des topics
Ce projet existe depuis 2015, alors il y a pas mal de topics liés. En voici une liste complète !
Topics principaux
Installation du fxSDK
Tutoriels
Compatibilité sur calculatrice et PC
Côté PC, le fxSDK est compatible avec
Linux, Mac OS, et WSL pour Windows ; normalement tout le monde peut l'utiliser. Je teste constamment sous Linux, et WSL est un Linux donc c'est testé aussi. Je n'ai pas de Mac OS donc il peut y avoir quelques surprises, mais en général c'est l'affaire de corriger un bug ou deux.
En termes de calculatrices, le fxSDK supporte :
Calculatrices monochromes
Graph 35+E II
Graph 35+ USB / Graph 35+E (SH3/SH4)
Graph 75/75+/75+E
Graph 85/85 SD/95 (SD) (pas activement testé)
Calculatrices couleurs
Graph 90+E / fx-CG 50
Prizm fx-CG 10/20
Comment installer le fxSDK et coder des add-ins
Le fxSDK s'installe à partir de dépôts Git sur la
forge de Planète Casio (par exemple
Lephenixnoir/fxsdk). Il y en a un peu beaucoup, donc manuellement c'est assez long. Pour que ça aille plus vite et pour simplifier le travail des débutants, il y a un outil appelé
GiteaPC qui peut faire ça pour vous.
Si vous utilisez Windows, vous aurez besoin de WSL pour accéder à un système Linux dans Windows. Heureusement, Microsoft a fait ça bien et c'est facile à faire. Voyez le
tutoriel d'installation de WSL 2 (et l'explication rapide de
ce que WSL 2 est).
Si vous utilisez Mac OS, ouvrez l’œil en lisant les topics pour ne pas manquer les informations supplémentaires et éventuelles déviations par rapport à la procédure normale sous Linux.
Méthode automatique avec GiteaPC (plus rapide / recommandée pour les débutants)
- Suivez le tutoriel d'utilisation de GiteaPC, qui explique comment obtenir le fxSDK.
Méthode automatique avec plugin VS Code
- Yannis300307 a créé un plugin VS Code Casio Dev Tools qui fonctionne sous Windows (avec WSL) et Debian (probablement les dérivés aussi).
Méthode AUR pour les utilisateurs Arch/Manjaro/dérivés (ils se reconnaîtront)
- Dark Storm maintient MiddleArch, un dépôt de paquets précompilés qui a entre autres le fxSDK.
Méthode manuelle (plus fine / classique pour les habitués)
- Compilez et installez le cross-compilateur GCC pour SuperH.
- installez (dans cet ordre) les dépôts fxSDK, OpenLibm, fxlibc, gint ; en option, Slyvtt/µSTL_2.3.
Description sommaire du fxSDK
Pour une introduction à l'utilisation du fxSDK qui montre comment utiliser les outils pour développer un add-in, lisez plutôt les
tutoriels d'utilisation de gint. Cette section est juste une description sommaire.
Le cœur du fxSDK est un cross-compilateur GCC pour SuperH, habituellement nommé
sh-elf-gcc. Bien sûr on a avec toute la suite d'outils, dont
as,
ld,
objdump,
objcopy (entre autres). Contrairement au vieux compilateur du SDK, GCC est un compilateur moderne avec beaucoup d'options et capable de très solides optimisations.
Sur la calculatrice, c'est
le noyau gint qui fait la majorité du travail. Il remplace fxlib/libfxcg et une partie de l'OS pour vous offrir des fonctionnalités plus cool et plus rapides. Les add-ins développés avec le fxSDK utilisent gint toutes les trois lignes !
Il y a enfin plusieurs outils utiles sur le PC qui sont utilisés durant le développement ou l'utilisation des add-ins :
- fxsdk est un script shell qui permet de créer et compiler les projets sans se prendre trop la tête. Le système de compilation officiel pour les add-ins est CMake, mais un système plus ancien de Makefile est encore supporté.
- fxconv est un outil très polyvalent qui convertit à la compilation les assets (images, polices, maps....). Il permet de travailler avec des logiciels et formats de fichiers normaux sur le PC et d'avoir automatiquement un format optimisé sur la calculatrice. fxconv est extrêmement extensible et chaque projet peut ajouter des conversions personnalisées.
- fxgxa crée les fichiers g1a (format des add-ins pour Graph monochromes) et g3a (format des add-ins pour Graph couleurs) à partir des programmes compilés.
- fxlink est un outil de communication qui peut transférer des fichiers vers les Graph 35+E II et Graph 90+E en ligne de commande, mais aussi échanger interactivement avec les add-ins gint par le câble USB, et est couramment utilisé pour réaliser des captures d'écran ou captures vidéo des add-ins.
Changelog et informations techniques
Ci-dessous se trouve la liste des posts annonçant les nouvelles versions du fxSDK, ainsi que des liens vers les instructions/tutoriels supplémentaires publiés avec.
Citer : Posté le 30/03/2023 21:34 | #
That worked, thanks!
Citer : Posté le 30/03/2023 21:43 | #
you are very welcome
Citer : Posté le 30/03/2023 21:50 | #
Now comes the quick explanation :
the first option in the first line tell the compiler that you are using the C++ (version 2020) langage.
the second option -lstdc++ tells the linker that you are using some parts of the libstdc++ (vectors, strings in particular from the STL). So you need to tell the linker to actually link the library to be able to build the final addin.
you can see in your error message : /home/ethanho47/.local/share/fxsdk/sysroot/lib/gcc/sh3eb-elf/11.1.0/../../../../sh3eb-elf/bin/ld:
--> this means it is a linkage error cause ld is the linker
all the occurences : undefined reference to __ZdlPvj just tells that the code corresponding to a function is missing (cause the library which contain the code is missing).
Citer : Posté le 01/04/2023 22:56 | # |
Fichier joint
Ce tutoriel sera ajouté aux notes de publication du fxSDK 2.10.
Tutoriel rapide d'utilisation de libfxlink
libfxlink est une bibliothèque contenant les fonctions de communication principales de fxlink. Elle permet de trouver les calculatrices connectées sur les ports USB et de communiquer avec. libfxlink utilise libusb et ne fonctionne donc pas sous Windows/WSL pour l'instant (comme fxlink).
Attention : Tous les liens de ce tutoriel pointent vers les versions d'Avril 2023 pour rester cohérents avec le texte du tutoriel. La bibliothèque a pu changer depuis.
Exemples de référence
Il y a quatre exemples d'utilisation différents dont vous pouvez vous inspirer.
Utilisation de libfxlink dans un projet
libfxlink expose une interface CMake, comme les autres outils du fxSDK. Du coup, en théorie il suffit d'un appel à find_package() pour la trouver. Cependant, comme le fxSDK ne s'installe pas dans les dossiers système, CMake ne trouvera pas le bon dossier tout seul. Il faut rajouter le bon chemin à la variable CMAKE_MODULE_PATH dans votre CMakeLists.txt :
if(DEFINED "$ENV{FXSDK_PATH}")
list(APPEND CMAKE_MODULE_PATH "$ENV{FXSDK_PATH}/lib/cmake")
endif()
Le code ci-dessous ajoute $HOME/.local (le dossier d'installation par défaut du fxSDK) au dossier de recherche. Ce sera suffisant pour presque tout le monde. Pour les utilisateurs qui installent le fxSDK à la main dans un autre dossier, le chemin $FXSDK_PATH est aussi ajouté, et donc il suffit de fournir la variable d'environnement FXSDK_PATH avec comme valeur le chemin indiqué dans -DCMAKE_INSTALL_PREFIX lors de l'installation du fxSDK.
Ensuite ça se fait comme d'habitude :
# ...
target_link_libraries(<TARGET> PRIVATE LibFxlink::LibFxlink)
Et vous pouvez maintenant coder avec la bibliothèque.
Le type struct fxlink_device des périphériques
Dans <fxlink/devices.h> vous trouverez la majorité des fonctions intéressantes. Crucialement, vous y trouverez le type struct fxlink_device représentant les périphériques USB vus par fxlink. Le diagramme ci-dessous résume comment on utilise cet objet :
Trouver les calculatrices : API simplifiée
Le plus simple pour trouver une calculatrice est d'appeler fxlink_device_find() après avoir intialisé libusb. Les paramètres sont le contexte libusb et un filtre servant à spécifier vaguement la calculatrice qu'on veut. Le filtre peut être NULL pour accepter n'importe quelle calculatrice.
Les détails du filtre sont dans <fxlink/filter.h> ; essentiellement il suffit de créer une struct fxlink_filter avec les critères qu'on veut. Les fonctions de ce header ont rarement besoin d'être appelées à la main.
Si une calculatrice est trouvée, une structure de périphérique est renvoyée ; elle vous appartient, donc il faudra la libérer avec fxlink_device_cleanup() et free() à la fin de l'exécution.
Trouver les calculatrices : API complète
L'API complète permet d'être réactif et de gérer proprement les connexions et déconnexions. L'idée principale c'est que fxlink va traquer et vous montrer la liste des calculatrices connectées ; les fonctions concernées sont détaillées dans cette section de <fxlink/devices.h>.
Pour utiliser cette API, créez une struct fxlink_device_list list et démarrez le suivi des périphériques connectés avec fxlink_device_list_track(). Ensuite, appelez fxlink_device_list_refresh() après chaque traitement des événéments de libusb. De cette façon, vous pouvez à tout moment consulter le tableau list.devices (de taille list.count) des périphériques connectés. La liste se chargera de les libérer à la fin donc ne le faites pas vous-mêmes.
Typiquement, une application qui utilise cette API traitera les événements libusb dans sa boucle principale et consultera ensuite la liste pour voir s'il y a de nouvelles calculatrices auxquelles se connecter et si les anciennes ont été déconnectées. La fonction monitor_update de CG-Virtual-Monitor fait ça d'une façon très typique.
Au moment de détruire la liste, appelez fxlink_device_list_interrupt() en boucle (sans oublier de traiter les événements libusb) pour interrompre les transferts en cours et s'assurer que toutes les ressources sont libérées correctement. Ensuite arrêtez le suivi avec fxlink_device_list_stop().
Communiquer avec l'interface fxlink
Le cas d'usage le plus simple est pour communiquer avec gint utilisant usb_ff_bulk. Dans ce cas l'API de transfert de messages de libfxlink peut être utilisée. Pour ça, il faut d'abord revendiquer l'interface USB en question pour éviter que quelqu'un d'autre ne s'en serve en même temps ; ça se fait avec fxlink_device_claim_fxlink(). Avant ça il est opportun de vérifier que le périphérique est prêt à se connecter et offre bien une interface fxlink ; voir un exemple complet ici.
Pour recevoir des messages, appelez fxlink_device_start_bulk_IN() dès que vous êtes prêts à recevoir. Vous devez appeler cette fonction avant que la calculatrice ne commence à envoyer. En général un logiciel en mode "écoute" aura un transfert IN actif en permanence sur toutes les calculatrices.
Vous pouvez ensuite appeler fxlink_device_finish_bulk_IN() à chaque tour après avoir traité les événements libusb. Si le transfert est fini vous récupérerez le message complet (sinon NULL). Vous pourrez alors traiter le message (voir ci-dessous) ; n'oubliez pas de relancer ensuite un transfert.
Pour envoyer des messages, utilisez fxlink_device_start_bulk_OUT(). Les paramètres app et type sont détaillés dans le format des messages ci-dessous. data et size indiquent le contenu du message. Si own_data est spécifié, le bloc de données sera free() automatiquement à la fin du transfert. Notez que la fonction échouera (et ne fera rien) si un transfert est déjà en cours.
Créer et récupérer des messages avec l'interface fxlink
Le format des messages est détaillé dans <fxlink/protocol.h>. Essentiellement les messages sont des données brutes avec une taille annoncée à l'avance et une paire de chaînes de caractères, application/type, pour identifier le message.
Vous pouvez utiliser les champs de la structure directement. Comme application et type n'ont pas forcément de \0 final il est conseillé d'utiliser fxlink_message_is_apptype() pour tester le genre de message. Un message lu depuis une calculatrice doit être libéré avec fxlink_message_free().
<fxlink/protocol.h> contient aussi une section pour gérer des transferts de messages manuellement avec les struct fxlink_transfer. C'est ce qui est caché derrière les APIs de la section précédentes. Vous pouvez les utiliser directement si vous souhaitez utiliser l'API fxlink sans inversion de contrôle. (Exemple : fxlink -i)
Communiquer avec d'autres interfacs
Pour communiquer avec d'autres interfaces, une fois la calculatrice détectée utilisez l'API libusb directement sur fdev->dh, le handle libusb associé à la calculatrice. Le code de fxlink -p (qui communique avec Add-In Push, un add-in utilisant les syscalls USB) est un très bon exemple de cette méthode.
Dans ce cas, fxlink est utilisé uniquement pour trouver les calculatrices et gérer les connexions/déconnexions.
Conclusion
Enjoy les nouvelles possibilités de l'USB !
Citer : Posté le 02/04/2023 00:16 | #
Release associée de gint : gint 2.10.0
Release associée de la fxlibc : fxlibc 1.4.5
Plusieurs points importants dans cette mise à jour.
Post lié : Tutoriel de personnalisation de l'icône d'add-in Graph 90+E
Donc gint 2.10 ajoute le support de la lecture dans le driver USB. Du coup, la communication avec le PC devient beaucoup plus flexible et le vieux mode interactif fxlink -i ne suffit plus. Pour faciliter le développement de programmes communiquant avec la calculatrice sur l'ordinateur, j'ai étendu fxlink de deux façons :
Post lié : Tutoriel rapide d'utilisation de libfxlink
Citer : Posté le 06/05/2023 11:07 | #
Bonjour, j'ai essayé d'installer fxSDK a travers Ubuntu WSL, et tout c'est bien passé jusqu'a "% giteapc install Lephenixnoir/fxsdk:noudisks2 Lephenixnoir/sh-elf-binutils Lephenixnoir/sh-elf-gcc" ou j'ai un message d'erreur me disant qu'il manque "libpng16" et donc l'installation est interompue, je ne peux pas aller plus loin. J'ai essayé d'utiliser "/fxsdk" au lieu de "/fxsdk:noudisks2", d'installer qu'un des packages a la fois mais toujours ce même problème.
Est ce que ce serait moi qui aurait mal fait quelquechose ?
Caltos : G35+EII, G90+E (briquée
Citer : Posté le 06/05/2023 11:09 | #
sudo apt-get install libpng16-16 libpng-dev
et ensuite tu refais
Citer : Posté le 06/05/2023 11:15 | #
Merci, ça a résolu ce problème mais maintenant j'ai "ncurses" qui manque. C'est embêtant.
Est ce que je fais une commande similaire (du genre sudo apt-get install ncurses) ?
Edit : cette commande ne marche pas, je m'en doutait un peu quand même
Caltos : G35+EII, G90+E (briquée
Citer : Posté le 06/05/2023 11:16 | #
sudo apt-get install libncurses libncurses-dev
Citer : Posté le 06/05/2023 11:20 | #
Désolé mais ça renvoie "Unable to locate package libncurses"
Caltos : G35+EII, G90+E (briquée
Citer : Posté le 06/05/2023 11:20 | #
sudo apt-get update
sudo apt-get upgrade
puis tu refais
Citer : Posté le 06/05/2023 11:22 | #
Les commandes se sont bien exécutées mais que j'ai rententé ça me renvoie le même message d'erreur
Caltos : G35+EII, G90+E (briquée
Citer : Posté le 06/05/2023 11:24 | #
ok, essaye alors
sudo apt install ncurses
puis
sudo apt install libncurses-dev
Citer : Posté le 06/05/2023 11:27 | #
Libncurses a marché mais pas ncurses, mais c'est bon maintenant fxsdk est en train de s'installer, merci de ton aide !
Caltos : G35+EII, G90+E (briquée
Citer : Posté le 06/05/2023 12:52 | #
bon OK, tant mieux.
Y'a pas une distribution pareil avec les noms des librairies. Le principal est que cela fonctionne.
Citer : Posté le 15/08/2023 22:05 | #
Petit changement dans fxconv qui apparaîtra à la prochaine mise à jour. J'ai ajouté une fonction fxconv.elf_multi() à usage des convertisseurs personnalisés qui voudraient produire plusieurs variables indépendantes lors d'une conversion.
À titre d'exemple, voyons comment on pourrait écrire un convertisseur personnalisé de type doublevar qui produit deux chaînes de caractères, une égale à "Hello", l'autre égale à "world". Je vais mettre les noms de variables désirés dans les métadonnées :
custom-type: doublevar
name: X
var1: hello
var2: world
Le name ne sera plus utilisé mais il est obligatoire par défaut ; je mets une valeur bidon.
Dans le convertisseur, je crée deux fxconv.Structure (une par variable), et au lieu de générer le fichier final avec fxconv.elf() j'utilise fxconv.elf_multi() :
def convert(input, output, params, target):
if params["custom-type"] == "doublevar":
convert_doublevar(input, output, params, target)
return 0
return 1
def convert_doublevar(input, output, params, target):
o_hello = fxconv.Structure()
o_hello += fxconv.string("Hello")
o_world = fxconv.Structure()
o_world += fxconv.string("world")
fxconv.elf_multi(
[("_" + params["var1"], o_hello),
("_" + params["var2"], o_world)],
output, **target)
elf_multi() prend trois paramètres :
Je vous passe l'ajout de assets-cg/test.txt et la déclaration du convertisseur dans CMakeLists.txt. À la fin, je récupère dans main() une paire de variables :
#include <gint/keyboard.h>
extern char const *hello;
extern char const *world;
int main(void)
{
dclear(C_WHITE);
dprint(1, 1, C_BLACK, "%s, %s!", hello, world);
dupdate();
getkey();
return 1;
}
Et voilà, le tour est joué.
Citer : Posté le 15/08/2023 22:09 | #
Magnifique
Y'avait juste à demander
Juste ce dont j'avais besoin. Nickel.
Merci beaucoup
Citer : Posté le 24/09/2023 15:58 | #
J'ai ajouté dans le topic une nouvelle méthode d'installation semi-officielle : le plugin Casio Dev Tools de Yannis300307 pour VS Code. C'est sympa parce que ça a le potentiel de marcher complètement automatiquement et d'être l'option la plus accessible
Citer : Posté le 05/11/2023 15:34 | #
Salut je viens de voir dans un autre topic que fxlink n'est pas disponible sous Wsl...
Pourtant quand j'ai tout installé (avec fxlink du coup) je n'ai eu aucune erreur... Je ne peux pas tester maintenant si ça fonctionne bien mais du coup pourquoi cela ne marcherait pas ?
Citer : Posté le 05/11/2023 15:36 | #
Coucou, effectivement ça compile, le problème c'est que WSL n'a (en gros) pas accès aux périphériques USB de Windows. Donc le système Linux dans WSL ne trouve jamais la calto.
Citer : Posté le 05/11/2023 15:39 | #
Ah d'accord, et donc pour faire passer les addins faut utiliser l'explorateur de fichier...
Il n'y a aucun moyen que Wsl puisse accéder au périphériques USB, genre en lançant en admin ?