Guía de usuario de ProffieBoard V2.2

1. Controles de los botones

El comportamiento de los botones depende de la configuración de ProffieOS y del número de botones definidos para el sable. Los controles siguientes parten de una configuración con al menos un botón de activación y pueden incluir un botón AUX.

2. Comandos del monitor serie

ProffieOS proporciona comandos serie que pueden utilizarse para realizar pruebas, diagnósticos, comprobaciones de configuración, pruebas de audio y navegación entre presets.

3. Instalación y configuración del software

Para desarrollar y cargar el firmware en ProffieBoard se necesita Arduino IDE, junto con el plugin de Arduino para ProffieBoard y los controladores USB correspondientes.

3.1 Software necesario

3.2 Instalación de Arduino IDE

Instala la versión estable más reciente de Arduino IDE . No utilices una versión Beta.

En Windows, no se recomienda instalar Arduino IDE como aplicación de Microsoft Store. La aplicación puede instalarse en un directorio protegido que impida instalar correctamente plugins o software adicional.

3.3 Instalar el plugin de ProffieBoard y Zadig

Instala el plugin de Arduino para ProffieBoard y Zadig siguiendo sus respectivas instrucciones de instalación.

3.4 Configuración de la placa en Arduino IDE

En Arduino IDE, selecciona:

Tools → Board → Proffieboard V2

Conecta ProffieBoard al ordenador mediante un cable USB de datos. El puerto COM asignado debería aparecer disponible en el menú Port.

4. Carga y actualización del firmware

Paso 1 — Descargar ProffieOS y los archivos de la tarjeta SD

Descarga el paquete de firmware ProffieOS y los archivos correspondientes para la tarjeta SD.

Para los sables SUPERNEOX con ProffieBoard V2.2, esta guía utiliza ProffieOS 5.9 como versión de referencia.

Extrae:

ProffieOS-v5.9.zip

Extrae el paquete en un directorio de trabajo normal, como Documentos o el Escritorio.

La estructura extraída debería contener:

ProffieOS-v5.9/

└── ProffieOS/

No cambies de nombre ni muevas las carpetas o archivos que se encuentran dentro del directorio ProffieOS.

Paso 2 — Instalar el contenido de la tarjeta SD

Extrae:

ProffieOS_SD_Card.zip

Copia todos los archivos de la carpeta extraída ProffieOS_SD_Card al directorio raíz de la tarjeta microSD de ProffieBoard.

Configuración de las extensiones de archivo en Windows

Activa Extensiones de nombre de archivo en el Explorador de archivos de Windows para que las extensiones como .h sean visibles.

Paso 3 — Crear el archivo de configuración

Abre:

ProffieOS/config/

Crea el archivo de configuración dentro de este directorio.

El flujo de trabajo recomendado consiste en copiar el archivo de configuración predeterminado correspondiente, cambiar el nombre de la copia y, a continuación, sustituir su contenido por la configuración generada para tu sable.

Para ProffieBoard V2.x, utiliza el Configurador oficial de ProffieBoard V2.x .

Paso 4 — Seleccionar el archivo de configuración

Abre:

ProffieOS/ProffieOS.ino

Localiza la definición CONFIG_FILE.

#define CONFIG_FILE "config/my_saber_config.h"

Si existen varios archivos de configuración en el directorio config, solo debe estar activo el archivo que quieras compilar.

Puedes mantener varias configuraciones de sables en el mismo directorio config. Para cambiar entre ellas, modifica el CONFIG_FILE activo.

Paso 5 — Conectar la placa

Conecta ProffieBoard al ordenador mediante un cable Micro-USB con transferencia de datos.

Paso 6 — Compilar y cargar

1. Abre ProffieOS.ino en Arduino IDE.
2. Comprueba que estén seleccionados la placa ProffieBoard V2 y el puerto COM correctos.
3. Confirma que el CONFIG_FILE correcto esté activo.
4. Haz clic en Upload.
5. Espera a que finalicen la compilación y la carga.

Después de una carga correcta, el indicador de progreso debería alcanzar el 100 %.

Si hay un altavoz conectado, ProffieBoard debería reproducir el sonido de inicio después de una carga correcta.

Si está seleccionado Serial + Mass Storage y ProffieBoard aparece como una unidad extraíble, expulsa la unidad de forma segura antes de desconectar el cable USB.

Solución de problemas de carga

Si la carga falla, comprueba las siguientes causas habituales:

1. Puede existir un error de sintaxis o de configuración en el archivo de cabecera de configuración.
2. El nombre de CONFIG_FILE puede ser incorrecto.
3. El archivo de configuración puede no estar ubicado en el directorio ProffieOS/config/.
4. El nombre de usuario de Windows o el directorio de trabajo pueden contener caracteres no latinos que provoquen problemas con la cadena de herramientas.
5. La placa, el tipo de USB, la velocidad de la CPU o el puerto COM seleccionados pueden ser incorrectos.

5. Contenido de la tarjeta SD

ProffieOS utiliza la tarjeta microSD del sable para almacenar sound fonts, archivos relacionados con la configuración y pistas de música.

Sound Fonts

Copia las carpetas de sound fonts compatibles en el directorio raíz de la tarjeta microSD.

La configuración original admite estructuras habituales de sound fonts, entre ellas:

Cuando se utiliza una estructura de sound font compatible, normalmente no es necesario cambiar los nombres de los archivos WAV.

Pistas de música

Coloca las pistas de música dentro de:

tracks/

Ejemplo:

tracks/venus.wav

tracks/mars.wav

tracks/mercury.wav

Nombres de archivos y carpetas

Para obtener la mejor compatibilidad, utiliza caracteres latinos y nombres de archivo sencillos para las carpetas de sound fonts y las pistas de música.

Evita caracteres especiales innecesarios, como:

? , . | \ } { [ / -

Cada carpeta de sound font debe contener los archivos de configuración necesarios, como:

config.ini

smoothsw.ini

6. Configuración y parámetros

La configuración de ProffieBoard se controla principalmente mediante un archivo de cabecera de configuración C++ ubicado en:

ProffieOS/config/

La configuración define los ajustes de la placa, el número de hojas, los botones, los parámetros de audio, las funciones de movimiento, la configuración de los LED, la sensibilidad al Clash, los presets y los estilos de hoja.

Configuración básica de 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

Referencia de parámetros

Sensibilidad del Clash

Un valor inicial documentado es:

#define CLASH_THRESHOLD_G 1.0

Los valores más bajos suelen proporcionar una detección del Clash más sensible, mientras que los valores más altos suelen reducir la sensibilidad.

Editar la configuración

Utiliza un editor de texto sin formato o un editor de código para modificar los archivos de configuración C++.

Después de modificar la configuración:

1. Guarda el archivo de configuración.
2. Abre ProffieOS.ino.
3. Comprueba que el CONFIG_FILE correcto esté activo.
4. Compila el firmware.
5. Carga el firmware en ProffieBoard.

7. Configuración de presets

Los presets definen el sound font, la banda sonora, el estilo de hoja y el nombre legible del preset utilizados por el sable.

Estructura básica de un preset

Un preset típico se define dentro de la sección CONFIG_PRESETS:

#ifdef CONFIG_PRESETS

Preset presets[] = {

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

};

#endif

Componentes de un preset

Configuración de la hoja

La configuración física de la hoja se declara mediante un array BladeConfig blades[].

Esta configuración asocia el hardware físico de los LED/la hoja con la configuración de los presets.

BladeConfig blades[] = {

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

};

8. Estilos de hoja

ProffieOS utiliza Blade Styles para definir el comportamiento visual de la hoja principal y de otros LED configurados.

Funciones de los Blade Styles

• Color base
• Cambios de color
• Parpadeo
• Destellos de Clash
• Efectos Blaster
• Efectos Lockup
• Efectos Drag
• Efectos de encendido
• Efectos de retracción
• Temporización
• Comportamiento de las transiciones

Editor de Blade Styles

La documentación original para desarrolladores recomienda utilizar un Blade Style Editor para crear y modificar Blade Styles.

Entre los recursos de referencia más útiles se incluyen:

• Editor de Blade Styles de ProffieOS
• Tutorial de Megtooth Sith Sabers
• Recursos de Blade Styles de TRA
• Biblioteca de Blade Styles de Fett263

Estructura de un Blade Style

Un Blade Style normalmente se encuentra dentro de una expresión StylePtr<...>.

Los efectos pueden anidarse entre sí, de modo que cada capa modifica o transforma el resultado del efecto subyacente.

InOutHelper

InOutHelper<base color, 200, 300, Black>

Definiciones de color

Se pueden utilizar constantes de color predefinidas para los colores habituales de la hoja:

WHITE
 

RED
GREEN
BLUE
PURPLE
CYAN
YELLOW
MAGENTA

Los colores RGB personalizados pueden definirse mediante:

Rgb<R, G, B>

Ejemplo:

Rgb<255, 50, 0>

Cada canal RGB utiliza un valor de 0 a 255:

• 0 = sin salida de ese canal
• 255 = salida máxima de ese canal

AudioFlicker

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

AudioFlicker crea un efecto de parpadeo de la hoja que responde al audio o al sonido de funcionamiento del sable.

Una mayor diferencia entre los dos colores suele producir una variación visual más intensa.

OnSpark

OnSpark<base color, spark color, duration>

OnSpark añade un efecto de chispa durante el encendido de la hoja. El valor de duración se expresa en milisegundos.

SimpleClash

SimpleClash<base color, clash color, 40>

Añade un efecto de destello de Clash. El último parámetro define la duración del efecto en milisegundos.

Lockup

Lockup<base color, lockup color>

Añade el efecto Lockup y define el comportamiento del color utilizado durante el efecto.

Blast

Blast<base color, blast color>

Añade el efecto Blaster y define el color utilizado durante el efecto.

Ejemplo de Blade Style combinado

Un Blade Style más avanzado puede combinar varios efectos dentro de una única expresión anidada.

Un estilo combinado típico puede incluir:

• Color base verde
• Audio flicker
• Chispa durante el encendido
• Efecto Clash
• Efecto Blaster
• Efecto Lockup
• Efecto Drag
• Temporización del encendido
• Temporización de la retracción

El Blade Style terminado se inserta en el contenedor StylePtr<...> correspondiente dentro del preset.

9. Referencias para desarrolladores

Para obtener información actualizada sobre desarrollo, configuración y aspectos específicos de la placa ProffieOS, utiliza los recursos oficiales siguientes junto con esta guía para desarrolladores de SUPERNEOX.

10. Alcance de la documentación

ProffieOS recibe mantenimiento y actualizaciones de forma activa. La sintaxis de configuración, las funciones disponibles, el hardware compatible y el comportamiento pueden variar entre versiones.