Le manuel du Red Blade se compose en deux parties, la première partie couvrira une utilisation basique du clavier, la seconde partie couvrira une utilisation approfondie, pour les utilisateurs les plus avancées.
I. Utilisation basique
1. Le câble
Le câble utilisé par le clavier, est un câble USB C standard. Vous pouvez utiliser n’importe quel câble USB C pour brancher le clavier.
2. Changer un switch
Les switches du clavier ne sont pas exclusifs, ce qui vous permet de les remplacer librement par d’autres switches compatibles avec le format Cherry MX ou ayant les mêmes dimensions physiques.
Pour enlever un switch, il faut pincer le haut et le bas avec la pince fourni et déverrouiller les loquets, ensuite, vous pourrez l’enlever simplement en tirant.
Vous pourrez alors installer un switch simplement en insérant une nouvelle. Attention : vérifiez que les pattes métalliques du nouveau switch sont bien droites.
3. Les switches compatibles
Les switches ne sont pas au format propriétaires, tous les switches respectant le format suivant sont compatibles :
4. Le logiciel
Le software pour piloter le clavier se trouve dans l’onglet “Drivers” du site.
Le software présente 4 onglets.
La premier onglet comporte le réglage de l’éclairage, vous pourrez choisir aussi bien des effets RGB, que des effets fixe. Il est possible de régler la couleur touche par touche grâce au dernier mode “Personnalisé”.
Le second onglet, contient le réglage des touches, vous pouvez sélectionner une touche et lui réassigner une autre fonction. Vous pourrez librement choisir des fonctions telles qu’augmenter / réduire le volume, piste suivante, piste précédente, mettre en pause, etc. Vous pourrez aussi assigner des macros aux touches.
Le troisième onglet permet la création de macros. En cliquant sur ” + ” vous pourrez créer un nouveau macro. Ensuite, en cliquant sur “Rec”, vous pourrez enregistrer votre macro. Une fois les macros créés, vous pouvez les assigner à des touches spécifiques dans l’onglet “Réglages touches”.
Enfin, sur le dernier onglet, vous avez le réglage de la fréquence USB du clavier, ainsi que du temps de debounce. Le debounce sur un clavier est un délai qui permet d’éviter que les rebonds mécaniques des touches n’enregistrent plusieurs frappes au lieu d’une seule. Ce délai assure qu’un seul signal est pris en compte lorsque vous appuyez sur une touche.
Plus la valeur est élevée, plus le risque de double frappe est faible, mais plus l’input lag est forte.
5. Raccourcis utiles
Par défaut, le clavier embarque des raccourcis permettant de modifier le rétroéclairage. Ils sont appelés avec les raccourcis :
Fn + les 6 touches au dessus des touches fléchées : ces raccourcis permettent de changer le mode d’éclairage sur le clavier.
Fn + Flèche haut et bas : ces raccourcis permettent d’augmenter et de diminuer la luminosité
Fn + Flèche gauche : ce raccourci permet de modifier le sens de l’animation.
Fn + Flèche droite : ce raccourci permet de modifier la couleur
Fn + Windows : Verrouillage Windows, cette fonctionnalité permet de désactiver la touche Windows.
II. Utilisation avancée
L’utilisation avancée du clavier s’adresse avant tout aux personnes ayant un minimum d’expérience en développement informatique.
Compiler son firmware
QMK, un firmware open source
Si vous êtes passionné de claviers mécaniques et intéressé par la personnalisation à un niveau avancé, vous êtes au bon endroit. QMK (Quantum Mechanical Keyboard) est un firmware open-source qui permet aux utilisateurs de transformer leurs claviers en un appareil hautement personnalisé, capable de répondre exactement à leurs besoins.
Ce guide se destine avant tout aux utilisateurs avancés, si vous avez une utilisation basique du clavier, l’application que nous proposons suffira à vos besoins.
Ce guide est conçu pour vous introduire aux bases de l’univers de QMK, en expliquant l’installation des bases, la compilation du code, mais aussi l’installation du firmware sur votre clavier.
Veuillez noter : QMK est un projet communautaire, et en tant que tel, il encourage ses utilisateurs à explorer, expérimenter et résoudre les défis par eux-mêmes. Bien que ce guide vise à vous fournir une compréhension solide et une base robuste, nous vous encourageons à vous plonger dans la documentation disponible et à participer aux forums de la communauté pour toute question ou problème rencontré.
Instructions d'installation
Avant de commencer l’installation de QMK sur votre clavier, il est important de noter la présence d’un bouton d’urgence qui permet de forcer le démarrage du clavier en mode bootloader. Ce bouton est caché sous la barre espace et vous permet de basculer votre clavier en mode bootloader, un état nécessaire pour flasher le firmware, même si vous avez installé un firmware défectueux.
Le code permettant de basculer le clavier en mode bootloader est stocké sur une partition protégé de la mémoire du contrôleur. Ainsi, indépendamment du code installé sur le clavier, basculer le bouton sur la droite forcera systématiquement le redémarrage en mode bootloader.
Cette fonctionnalité vous permet de retourner sur une version stable si besoin.
Avant de pouvoir compiler le firmware, vous devez installer les outils et l’environnement logiciel nécessaires à sa construction. La compilation manuelle du firmware vous permettra de modifier divers aspects de celui-ci.
Veuillez suivre les instructions de cette page, arrêtez vous juste après le point 2, et revenez sur cette page avant de rentrer la commande “setup qmk”. Nous utilisons un fork et nous devrons donc modifier la commande pour les fichiers du fork.
Une fois installé, vous devriez avoir l’écran suivant :
Rentrez la commande suivante :
qmk setup SonixQMK/qmk_firmware -b sn32_develop
Et répondez “y” :
Compiler le firmware
Maintenant que l’environnement d’installation est prêt, il est temps de compiler notre premier firmware. La syntaxe des commandes se structure comme ceci :
Vous pouvez remplacer “default” par “via” si vous souhaitez compiler la version compatible avec via.
Une fois la compilation terminée, vous trouverez le fichier dans le dossier :
C:/Users/[user]/qmk_firmware/.build
C’est un fichier binaire, dont l’extension se termine par .bin.
Nous pouvons passer à l’étape suivante : flasher le clavier avec notre firmware nouvellement compilé.
Flasher le clavier
Notre clavier se base sur une puce Sonix SN32F248B, nous avons mis en place un flasher fonctionnant sur Windows, Mac et Linux. Il permet de flasher, et donc d’installer votre firmware sur le clavier.
Le Sonix flasher est un logiciel léger et multiplateforme permettant d’installer le firmware sur votre clavier. Il est conçu pour détecter les claviers qui sont en mode bootloader.
Il ne détectera pas votre clavier s’il n’est pas en mode bootloader.
Nous allons maintenant expliquer la procédure pour basculer votre clavier en mode bootloader et flasher le firmware.
Basculer le clavier en mode bootloader
Comme indiqué dès le début de ce tutoriel, il existe un bouton permettant de basculer le clavier en mode bootloader.
Ce bouton servira de bouton de sécurité, si vous installez un firmware défectueux sur le clavier, vous pourrez toujours revenir sur une version stable.
Voici les étapes:
Enlever la barre d’espace
Pour commencer, vous devez enlever la barre d’espace avec les outils fournis. Vous trouverez alors un petit bouton caché sous le PCB.
C’est un bouton qui possède deux position. Sur la position gauche, le clavier exécutera le firmware à chaque démarrage, sur la position droite, le clavier démarrera systématiquement en mode bootloader.
Vous devez prendre un cure dent ou une trombone pour pousser le bouton sur la position droite.
Vous devrez ensuite débrancher et rebrancher le clavier, ce qui force le démarrage en mode bootloader.
Installer le firmware
Une fois que votre clavier est en mode bootloader, vous devrez sélectionner dans le logiciel Sonix Flash les options suivantes :
Cliquez sur “Refresh”, votre clavier en mode bootloader apparaîtra dans la liste.
Sélectionnez “SN32F24X”, qui est notre microcontrôleur.
Choisissez “qmk offset 0x00”.
Enfin, cliquez sur “Flash QMK”, vous verrez apparaître une fenêtre.
Dans cette fenêtre, rendez vous dans :
C:/Users/[user]/qmk_firmware/.build
Vous trouverez alors le binaire du firmware. Vous sélectionnez “Open” et l’installation du firmware se fera sur votre clavier.
Une fois l’installation effectuée, le clavier met en général 10 secondes à redémarrer.
Une fois l’installation terminée, vérifiez que toutes les fonctions du clavier marchent.
Si tout s’est passé comme prévu, vous devez remettre le bouton du bootloader en position gauche.
De cette manière, au prochain redémarrage, votre clavier exécutera le firmware nouvellement installé. Si vous ne le faites pas, il redémarrera sur le bootloader.
Maintenant que la première partie du tutorial est terminé, nous allons désormais expliquer quelques modifications que vous pouvez faire au niveau du code.
Modifier le firmware
Nous ne couvrirons pas toutes les modifications possibles, vous trouverez l’intégralité des fonctionnalités disponibles dans la documentation de QMK. Le but de ce tutorial est de vous donner quelques exemples concrets.
Nous couvrirons quelques cas que nous trouvons utile :
Modification du temps de debounce et de l’algorithme de debounce
Modification de la keymap
Utiliser les LED des touches Capslock, scroll lock et numlock comme indicateur de leur états
Les fichiers se trouvent par défaut dans le répertoire :
C:Users[user]qmk_firmware
Les fichiers concernant nos claviers se situent dans le dossier suivant :
Le temps de debounce est le temps que nous laissons au switch pour se stabiliser. Avec un temps plus court, nous laissons moins de temps au switch pour se stabiliser, et donc nous avons plus de risque d’avoir des doubles frappes, c’est ce que nous appelons “key chattering”.
La plupart des switches ont besoins de 10 à 15 millisecondes pour se stabiliser. Certains fabricants indiquent un temps de 1 milliseconde lorsque le switch est neuf, en sortie d’usine, mais ces caractéristiques ne sont pas toujours maintenus sur la durée.
La possibilité de modifier la valeur du debounce nous permet de continuer à utiliser des switches vieillissant, réduisant ainsi la fréquence à laquelle nous avons besoin de changer les switches.
Pour modifier le temps de debounce, nous avons juste besoin de modifier la valeur à la ligne 8, en passant la valeur de “debounce”:10, à la valeur de votre choix.
Modifier l’algorithme de debounce
Il existe différents algorithmes de debounce, mais nous avons deux algorithmes qui sont particulièrement intéressants pour notre utilisation :
Le debounce eager
Le debounce defer
Le debounce eager envoie le signal à l’ordinateur dès la détection d’un signal, et ignorera les rebonds des contacteurs pendant une période prédéterminée. Le debounce defer détecte une frappe, attendra la période spécifié dans le debounce et enverra le signal à l’ordinateur.
Le debounce eager a moins d’input lag, mais est plus susceptible d’envoyer des doubles frappes et nécessite un temps de debounce plus important.
Le debounce defer a plus d’input lag, mais est plus fiable et a tendance à ne pratiquement jamais faire de double frappe.
Par défaut, nous utilisons l’algorithme eager. Si vous souhaitez utiliser l’algorithme defer, vous pouvez remplacer à la ligne 10 :
“debounce_type”: “sym_defer_pk”,
Sauvegarder la modification
Vous sauvegardez ensuite le fichier modifié et vous pouvez compiler le firmware, en suivant les étapes précédemment expliqué dans le tutoriel.
Les différentes pattes du microcontrôleur sont branchés à des lignes et des colonnes, qui forment un tableau.
C’est ce que nous appelons une matrice. Cette matrice forme l’ensemble des touches du clavier. Ensuite, à chacune de ces croisements, nous donnons une valeur, par exemple, la touche F1, la touche F2, la touche A, etc etc.
Dans notre exemple, nous avons donc la keymap du Berserker, notre clavier TKL. La couche de base, le layer[0] correspond aux touches directement accessibles lorsque vous écrivez sur votre clavier.
La touche Fn, permet alors d’accéder au layer[1], qui contient des raccourcis. Vous pouvez voir sur la zone surlignée, nous avons QK_BOOT qui permet de basculer le clavier en mode bootloader sans avoir à utiliser le bouton sous la barre espace.
Sur les touches fléchées, nous avons les différentes options permettant de modifier les effets du rétroéclairage. Ainsi en faisant Fn + les touches, nous pouvons passer au mode suivant, augmenter la vitesse, modifier la couleur etc.
En faisant Fn + Shift + les touches, nous pouvons repasser à l’option précédente.
Nous allons rajouter la fonction “éteindre l’éclairage”, en faisant Fn + F1.
En suivant la documentation que vous trouverez sur cette page, le code pour allumer ou éteindre l’éclairage est : BL_TOGG
En remplaçant ligne 46, l’emplacement vide par BL_TOGG, le raccourci Fn + F1 est désormais lié à la fonction “éteindre ou allumer l’éclairage”.
Nous pouvons désormais sauvegarder le raccourcis nouvellement ajouté et compiler, puis flasher le firmware.
