Guide d’utilisation du ProffieBoard V2.2

Centre d’aide développeurs SUPERNEOX

Guide d’utilisation du ProffieBoard V2.2

Découvrez comment utiliser, configurer et personnaliser votre sabre laser SUPERNEOX équipé d’un ProffieBoard V2.2 et de ProffieOS 5.9. Ce guide présente les principaux réglages ainsi que les possibilités de personnalisation destinées aux propriétaires de sabres laser.
Pour la programmation avancée, la configuration du firmware et les personnalisations destinées aux développeurs, consultez le Guide développeur du ProffieBoard V2.2.

ProffieBoard V2.2 ProffieOS 5.9 Firmware Configuration Styles de lame
Informations sur la version : Ce guide concerne principalement ProffieOS 5.9 et le ProffieBoard V2.x. La syntaxe de configuration et les fonctionnalités disponibles peuvent varier selon les versions de ProffieOS. Vérifiez toujours le comportement spécifique à votre version dans la documentation officielle de ProffieOS et dans le code source.

1. Commandes par bouton

Le comportement des boutons dépend de la configuration de ProffieOS et du nombre de boutons définis pour le sabre. Les commandes ci-dessous supposent la présence d’au moins un bouton d’activation et peuvent inclure un bouton AUX.

Fonction Commande
Allumer / éteindre la lame Appuyez brièvement sur le bouton d’alimentation pour allumer ou éteindre le sabre.
Allumer en mode silencieux Appuyez deux fois rapidement sur le bouton d’alimentation.
Preset suivant Lorsque la lame est éteinte, appuyez brièvement sur le bouton AUX.
Preset précédent Maintenez le bouton AUX enfoncé, puis appuyez sur le bouton d’activation.
Clash Lorsque la lame est allumée, frappez la lame pour déclencher l’effet.
Lockup Lorsque la lame est allumée, maintenez le bouton d’activation enfoncé et déclenchez un Clash. Relâchez le bouton d’activation pour arrêter le Lockup.
Drag Le fonctionnement est similaire à celui du Lockup. Orientez principalement le sabre vers le bas avant de maintenir le bouton d’activation enfoncé et de déclencher l’effet.
Force Maintenez le bouton AUX enfoncé.
Démarrer la bande-son Maintenez le bouton d’activation enfoncé.
Blaster Block Lorsque la lame est allumée, appuyez brièvement sur le bouton AUX.
Mode changement de couleur Lorsque la lame est allumée, maintenez le bouton AUX enfoncé, puis appuyez rapidement sur le bouton d’activation. Après le signal sonore de confirmation, faites pivoter le manche pour changer de couleur. Pour quitter le mode changement de couleur, maintenez le bouton d’activation enfoncé jusqu’à entendre le signal sonore de confirmation.
Remarque pour les développeurs : Le comportement des boutons dépend de leur définition dans la configuration ainsi que de la configuration des Props et des boutons dans ProffieOS. Si vous développez une disposition de boutons personnalisée, vérifiez la configuration active avant de rechercher l’origine d’un problème.

2. Commandes du moniteur série

ProffieOS propose des commandes série permettant d’effectuer des tests, des diagnostics, des vérifications de configuration, des tests audio et de naviguer entre les Presets.

Commande Description
battery_voltage Affiche la tension actuelle de la batterie.
get_volume Affiche la valeur actuelle du volume.
pow Allume ou éteint le sabre.
on Allume le sabre.
off Éteint le sabre.
set_volume <0-3000> Définit la valeur du volume.
Exemple : set_volume 500
play Lit la bande-son par défaut du Preset. Si la piste est déjà en cours de lecture, cette commande arrête la lecture.
play_track tracks/<track name>.wav Lit une piste spécifique depuis le dossier tracks.
Exemple : play_track tracks/venus.wav
stop_track tracks/<track name>.wav Arrête la lecture d’une piste spécifique.
force Lit l’effet sonore Force.
drag Lit l’effet sonore Drag.
blast Lit l’effet sonore Blaster.
lock Lit l’effet sonore Lockup.
clash Lit l’effet sonore Clash.
reset Redémarre le ProffieBoard.
n Passe au Preset suivant.
p Revient au Preset précédent.
list_presets Affiche la liste de tous les Presets disponibles.
sdtest Teste la vitesse de la carte SD.
scanid Indique la résistance Blade ID détectée.

3. Installation et configuration des logiciels

Le développement et le téléversement du firmware sur le ProffieBoard nécessitent Arduino IDE, le plugin Arduino pour ProffieBoard ainsi que les pilotes USB appropriés.

Environnement recommandé : Utilisez une version stable d’Arduino IDE. Pour les sabres laser SUPERNEOX équipés d’un ProffieBoard V2.2, ce guide s’appuie sur un environnement ProffieOS 5.9.

3.1 Logiciels requis

Arduino IDE

Permet de modifier, compiler et téléverser le firmware ProffieOS.

Plugin ProffieBoard

Ajoute la prise en charge du ProffieBoard ainsi que les options de téléversement spécifiques à la carte dans Arduino IDE.

Zadig

Permet de configurer le pilote USB requis pour la programmation du firmware lorsque cela est nécessaire.

Câble USB de données

Un câble Micro-USB prenant en charge le transfert de données est indispensable. Les câbles conçus uniquement pour la recharge ne peuvent pas être utilisés pour programmer le firmware.

3.2 Installation d’Arduino IDE

Installez la dernière version stable d’ Arduino IDE . N’utilisez pas de version bêta.

Arduino IDE

Sous Windows, l’installation d’Arduino IDE via le Microsoft Store n’est pas recommandée. L’application peut être installée dans un répertoire protégé, ce qui peut empêcher l’installation correcte de plugins ou de logiciels supplémentaires.

Problème de port COM : Si le ProffieBoard n’apparaît pas comme port COM disponible, essayez un autre port USB, vérifiez que le câble prend en charge le transfert de données et, si nécessaire, testez une version stable antérieure d’Arduino IDE.

3.3 Installer le plugin ProffieBoard et Zadig

Installez le plugin Arduino pour ProffieBoard et Zadig en suivant leurs instructions d’installation respectives.

Plugin Arduino ProffieBoard

3.4 Paramètres de la carte dans Arduino IDE

Dans Arduino IDE, sélectionnez :

Tools → Board → Proffieboard V2
Paramètre Valeur recommandée
Board Proffieboard V2
USB Type Serial + Mass Storage (ou + WebUSB)
CPU Speed 80 MHz
Optimize Smallest Code
ou Fast / Faster / Fastest
DOSFS SDCARD (SPI)
Port Le port COM attribué au ProffieBoard connecté

Connectez le ProffieBoard à votre ordinateur à l’aide d’un câble USB prenant en charge les données. Le port COM attribué devrait alors apparaître dans le menu Port.

4. Téléversement et mise à jour du firmware

Étape 1 – Télécharger ProffieOS et les fichiers de la carte SD

Téléchargez le package firmware ProffieOS ainsi que les fichiers correspondants pour la carte SD.

Pour les sabres laser SUPERNEOX équipés d’un ProffieBoard V2.2, ce guide utilise ProffieOS 5.9 comme version de référence.

ProffieOS 5.9

Décompressez :

ProffieOS-v5.9.zip

Extrayez le package dans un répertoire de travail classique, par exemple dans le dossier Documents ou sur le Bureau.

Important : N’extrayez pas ProffieOS dans le répertoire d’installation d’Arduino ni dans un répertoire Windows situé sous Program Files.

La structure obtenue doit contenir :

ProffieOS-v5.9/

└── ProffieOS/

Ne renommez pas et ne déplacez pas les dossiers ou fichiers situés dans le répertoire ProffieOS.

Étape 2 – Copier le contenu sur la carte SD

Contenu de la carte SD ProffieOS

Décompressez :

ProffieOS_SD_Card.zip

Copiez tous les fichiers du dossier ProffieOS_SD_Card extrait à la racine de la carte microSD du ProffieBoard.

Afficher les extensions de fichiers sous Windows

Activez l’affichage des extensions de noms de fichiers dans l’Explorateur de fichiers Windows afin de pouvoir voir les extensions telles que .h.

Ne créez pas de double extension. Si Windows masque l’extension existante, n’ajoutez pas manuellement une seconde extension .h au fichier de configuration.

Étape 3 – Créer le fichier de configuration

Ouvrez :

ProffieOS/config/

Créez votre fichier de configuration dans ce répertoire.

La méthode recommandée consiste à copier le fichier de configuration par défaut approprié, à renommer la copie, puis à remplacer son contenu par la configuration générée pour votre sabre.

Pour le ProffieBoard V2.x, utilisez le Configurator officiel ProffieBoard V2.x .

Étape 4 – Sélectionner le fichier de configuration

Ouvrez :

ProffieOS/ProffieOS.ino

Recherchez la définition CONFIG_FILE.

#define CONFIG_FILE "config/my_saber_config.h"

Si plusieurs fichiers de configuration se trouvent dans le répertoire config, seul celui que vous souhaitez compiler doit être actif.

Important : Une seule définition CONFIG_FILE doit être active à la fois.

Plusieurs configurations de sabres peuvent être conservées dans le même répertoire config. Pour passer de l’une à l’autre, modifiez la définition CONFIG_FILE active.

Étape 5 – Connecter la carte

Connectez le ProffieBoard à l’ordinateur à l’aide d’un câble Micro-USB avec transfert de données.

Attention au câble USB : Un câble USB destiné uniquement à la recharge ne peut pas être utilisé pour programmer le firmware.

Étape 6 – Compiler et téléverser

  1. Ouvrez ProffieOS.ino dans Arduino IDE.
  2. Vérifiez que le bon ProffieBoard V2 et le bon port COM sont sélectionnés.
  3. Vérifiez que le bon CONFIG_FILE est actif.
  4. Cliquez sur Upload.
  5. Attendez la fin de la compilation et du téléversement.

Une fois le téléversement terminé, l’indicateur de progression doit atteindre 100 %.

Si un haut-parleur est connecté, le ProffieBoard doit émettre le son de démarrage après un téléversement réussi.

Si Serial + Mass Storage est sélectionné et que le ProffieBoard apparaît comme un lecteur amovible, éjectez-le correctement avant de débrancher le câble USB.

Téléversement du firmware terminé : La nouvelle version de ProffieOS est maintenant installée sur le ProffieBoard.

Résolution des problèmes de téléversement

Si le téléversement échoue, vérifiez les causes courantes suivantes :

  1. Une erreur de syntaxe ou de configuration peut être présente dans votre fichier d’en-tête de configuration.
  2. Le nom de CONFIG_FILE peut être incorrect.
  3. Le fichier de configuration peut ne pas se trouver dans le répertoire ProffieOS/config/.
  4. Le nom d’utilisateur Windows ou le répertoire de travail peut contenir des caractères non latins susceptibles de provoquer des problèmes avec la chaîne d’outils.
  5. La carte, le type d’USB, la fréquence du processeur ou le port COM sélectionné peuvent être incorrects.

5. Contenu de la carte SD

ProffieOS utilise la carte microSD du sabre pour stocker les Soundfonts, les fichiers liés à la configuration et les pistes musicales.

Soundfonts

Copiez les dossiers de Soundfonts compatibles à la racine de la carte microSD.

La configuration d’origine prend notamment en charge les structures de Soundfonts suivantes :

Plecter

Structures de Soundfonts compatibles avec Plecter.

NEC

Structures de Soundfonts compatibles avec NEC.

SmoothSwing

Structures de Soundfonts compatibles avec SmoothSwing.

Lorsque vous utilisez une structure de Soundfont compatible, il n’est généralement pas nécessaire de modifier les noms des fichiers WAV.

Pistes musicales

Placez les pistes musicales dans :

tracks/

Exemple :

tracks/venus.wav

tracks/mars.wav
tracks/mercury.wav

Noms des fichiers et des dossiers

Pour garantir une compatibilité optimale, utilisez des caractères latins et des noms de fichiers simples pour les dossiers de Soundfonts et les pistes musicales.

Évitez les caractères spéciaux inutiles tels que :

? , . | \ } { [ / -

Chaque dossier de Soundfont doit contenir les fichiers de configuration requis, notamment :

config.ini

smoothsw.ini
Fichiers manquants : Si certains fichiers requis sont absents, copiez les fichiers correspondants depuis un Soundfont ProffieBoard par défaut dont le fonctionnement est vérifié, plutôt que de créer des fichiers de remplacement arbitraires.

6. Configuration et paramètres

La configuration du ProffieBoard est principalement définie dans un fichier d’en-tête de configuration C++ situé dans :

ProffieOS/config/

Cette configuration définit notamment les paramètres de la carte, le nombre de lames, les boutons, les réglages audio, les fonctions de mouvement, la configuration des LED, la sensibilité des Clash, les Presets et les Styles de lame.

Configuration du ProffieBoard V2

Configuration de base du ProffieBoard V2

#ifdef CONFIG_TOP

#include "proffieboard_v2_config.h"

#define NUM_BLADES 1
#define NUM_BUTTONS 2
#define VOLUME 1000

const unsigned int maxLedsPerStrip = 144;

#define CLASH_THRESHOLD_G 1.0

#define ENABLE_AUDIO
#define ENABLE_MOTION
#define ENABLE_WS2811
#define ENABLE_SD
#define SAVE_STATE

#endif

Référence des paramètres

Paramètre Fonction
NUM_BLADES Définit le nombre de configurations de lames utilisées.
NUM_BUTTONS Définit le nombre de boutons configurés. La configuration de référence prend en charge 1 à 3 boutons.
VOLUME Définit le niveau de volume initial. La plage documentée va de 0 à 3000.
maxLedsPerStrip Définit le nombre maximal de LED configurées pour le ruban de LED adressables.
CLASH_THRESHOLD_G Définit la sensibilité de détection des Clash. Des valeurs plus faibles rendent généralement la détection plus sensible, tandis que des valeurs plus élevées la rendent moins sensible.
ENABLE_AUDIO Active les fonctions audio.
ENABLE_MOTION Active la détection des mouvements.
ENABLE_WS2811 Active les fonctions WS2811 / LED adressables.
ENABLE_SD Active les fonctions liées à la carte SD.
SAVE_STATE Permet à la carte d’enregistrer des informations d’état telles que le volume sélectionné, le Preset actif et la couleur de la lame.

Sensibilité des Clash

Une valeur de départ documentée est :

#define CLASH_THRESHOLD_G 1.0

Des valeurs plus faibles rendent généralement la détection des Clash plus sensible, tandis que des valeurs plus élevées réduisent cette sensibilité.

Conseil de réglage : Ajustez la sensibilité des Clash progressivement. Un réglage trop sensible peut provoquer des déclenchements intempestifs lors des mouvements normaux, tandis qu’un réglage trop peu sensible peut empêcher la détection de véritables impacts.

Modifier la configuration

Utilisez un éditeur de texte brut ou un éditeur de code adapté pour modifier les fichiers de configuration C++.

N’utilisez pas Microsoft Word. Les logiciels de traitement de texte peuvent insérer des caractères de mise en forme ou modifier la structure des fichiers source.

Après avoir modifié la configuration :

  1. Enregistrez le fichier de configuration.
  2. Ouvrez ProffieOS.ino.
  3. Vérifiez que le bon CONFIG_FILE est actif.
  4. Compilez le firmware.
  5. Téléversez le firmware sur le ProffieBoard.

7. Configuration des Presets

Les Presets définissent le Soundfont, la bande-son, le Style de lame et le nom lisible utilisés par le sabre.

Structure de base d’un Preset

Un Preset standard est défini dans la section CONFIG_PRESETS :

#ifdef CONFIG_PRESETS

Preset presets[] = {

{
"TeensySF",
"tracks/venus.wav",
StyleNormalPtr(),
"cyan"
}

};

#endif

Éléments d’un Preset

Élément Description
Dossier du Soundfont Nom du dossier Soundfont stocké sur la carte SD.
Nom de la piste Chemin de la piste musicale, généralement situé dans le répertoire tracks.
Style de lame Définit le comportement visuel et les effets de la lame.
Nom du Preset Nom lisible utilisé par le système de Presets.

Configuration de la lame

La configuration physique de la lame est déclarée dans un tableau BladeConfig blades[].

Cette configuration associe le matériel physique de la lame et des LED à la configuration des Presets.

BladeConfig blades[] = {

{
0,
WS281XBladePtr<
144,
bladePin,
Color8::GRB,
PowerPINS
>(),
CONFIGARRAY(presets)
},

};

8. Styles de lame

ProffieOS utilise les Blade Styles pour définir le comportement visuel de la lame principale et des autres LED configurées.

Couleur

Définit la couleur de base et les couleurs personnalisées de la lame.

Effets de mouvement

Réagissent aux mouvements, aux swings et aux autres entrées liées au mouvement.

Effets d’impact

Contrôlent les effets Clash, Blaster, Lockup et Drag.

Transitions

Contrôlent l’allumage, l’extinction, les temporisations et le comportement des transitions.

Fonctionnalités des Blade Styles

  • Couleur de base
  • Changements de couleur
  • Effets de scintillement
  • Flashs de Clash
  • Effets Blaster
  • Effets Lockup
  • Effets Drag
  • Effets d’allumage
  • Effets d’extinction
  • Temporisation
  • Comportement des transitions

Blade Style Editor

La documentation développeur d’origine recommande l’utilisation d’un Blade Style Editor pour créer et modifier les Blade Styles.

Ressources de référence utiles :

Structure d’un Blade Style

Un Blade Style est généralement contenu dans une expression StylePtr<...>.

Les effets peuvent être imbriqués, chaque niveau modifiant ou transformant le résultat de l’effet sous-jacent.

InOutHelper

InOutHelper<base color, 200, 300, Black>
Paramètre Signification
base color Couleur principale de la lame.
200 Durée du déploiement / de l’allumage en millisecondes.
300 Durée de l’extinction en millisecondes.
Black Couleur de la lame lorsqu’elle est éteinte.

Définition des couleurs

Des constantes de couleur prédéfinies peuvent être utilisées pour les couleurs de lame courantes :

WHITE

RED
GREEN
BLUE
PURPLE
CYAN
YELLOW
MAGENTA

Les couleurs RGB personnalisées peuvent être définies avec :

Rgb<R, G, B>

Exemple :

Rgb<255, 50, 0>

Chaque canal RGB utilise une valeur comprise entre 0 et 255 :

  • 0 = aucune sortie pour ce canal
  • 255 = sortie maximale pour ce canal

AudioFlicker

AudioFlicker<"A" color, "B" color>

AudioFlicker crée un effet de scintillement de la lame qui réagit au signal audio ou au son de bourdonnement du sabre.

Plus l’écart entre les deux couleurs est important, plus la variation visuelle est généralement prononcée.

OnSpark

OnSpark<base color, spark color, duration>

OnSpark ajoute un effet d’étincelles pendant l’allumage de la lame. La durée est exprimée en millisecondes.

SimpleClash

SimpleClash<base color, clash color, 40>

Ajoute un flash de Clash. Le dernier paramètre définit la durée de l’effet en millisecondes.

Lockup

Lockup<base color, lockup color>

Ajoute l’effet Lockup et définit le comportement de la couleur pendant l’effet.

Blast

Blast<base color, blast color>

Ajoute l’effet Blaster et définit la couleur utilisée pour cet effet.

Exemple de Blade Style combiné

Un Blade Style avancé peut combiner plusieurs effets dans une seule expression imbriquée.

Un Style combiné peut notamment inclure :

  • Couleur de base verte
  • AudioFlicker
  • Étincelles lors de l’allumage
  • Effet Clash
  • Effet Blaster
  • Effet Lockup
  • Effet Drag
  • Temporisation de l’allumage
  • Temporisation de l’extinction
Remarque pour les développeurs : Les expressions de Blade Style peuvent devenir très longues et comporter plusieurs niveaux d’imbrication. Pour diagnostiquer un Style complexe, testez d’abord chaque effet séparément, puis combinez-les progressivement.

Le Blade Style final est inséré dans le conteneur StylePtr<...> approprié au sein du Preset.

9. Ressources pour développeurs

Pour obtenir les informations les plus récentes sur le développement ProffieOS, la configuration et les cartes compatibles, utilisez les ressources officielles ci-dessous en complément de ce guide développeur SUPERNEOX.

Fichiers de configuration SD SUPERNEOX

Fichiers de configuration par défaut pour SUPERNEOX Proffie V2.2.

Ouvrir Google Drive →

Documentation ProffieOS

Documentation officielle consacrée aux fonctionnalités, à la configuration et aux concepts de développement de ProffieOS.

Ouvrir la documentation →

ProffieOS sur GitHub

Code source, versions publiées, exemples de configuration et ressources de développement.

Ouvrir GitHub →

ProffieBoard V2.x Configurator

Outil de configuration accessible depuis un navigateur pour les ProffieBoard V2.x.

Ouvrir le Configurator →

Forum d’assistance ProffieOS

Discussions de la communauté et ressources de dépannage pour ProffieOS et ProffieBoard.

Ouvrir le forum →

10. Champ d’application de la documentation

Champ d’application : Ce guide développeur s’appuie sur le manuel technique ProffieBoard V2 fourni et reprend ses principaux concepts de configuration, références de commandes, procédure de mise à jour du firmware, structure des Presets et terminologie des Blade Styles.

ProffieOS fait l’objet d’un développement continu. La syntaxe de configuration, les fonctionnalités disponibles, le matériel pris en charge et le comportement du système peuvent varier selon les versions.

Vérifiez toujours le comportement propre à votre version. Avant d’appliquer une configuration ou un exemple de code à un sabre destiné à être utilisé, comparez-le avec la documentation et le code source correspondant exactement à la version de ProffieOS installée sur la carte.

Centre d’aide développeurs SUPERNEOX

ProffieBoard V2.2 · ProffieOS 5.9 · Référence firmware et configuration