Guia do Usuário ProffieBoard V2.2

1. Controles dos Botões

O comportamento dos botões é determinado pela configuração do ProffieOS e pela quantidade de botões definidos para o sabre. Os controles abaixo consideram uma configuração com pelo menos um botão de ativação e podem incluir um botão AUX.

2. Comandos do Monitor Serial

O ProffieOS disponibiliza comandos seriais que podem ser utilizados para testes, diagnóstico, verificação da configuração, testes de áudio e navegação entre presets.

3. Instalação e Configuração do Software

O desenvolvimento e o upload de firmware para o ProffieBoard exigem o Arduino IDE, o plugin Arduino para ProffieBoard e os drivers USB apropriados.

3.1 Software Necessário

3.2 Instalação do Arduino IDE

Instale a versão estável mais recente do Arduino IDE . Não utilize uma versão Beta.

No Windows, não é recomendado instalar o Arduino IDE como aplicativo da Microsoft Store. O aplicativo pode ser instalado em um diretório protegido, o que pode impedir a instalação correta de plugins ou de outros softwares necessários.

3.3 Instalação do Plugin ProffieBoard e do Zadig

Instale o plugin Arduino para ProffieBoard e o Zadig de acordo com as respectivas instruções de instalação.

3.4 Configurações da Placa no Arduino IDE

No Arduino IDE, selecione:

Tools → Board → Proffieboard V2

Conecte o ProffieBoard ao computador usando um cabo USB compatível com transferência de dados. A porta COM atribuída à placa deverá ficar disponível no menu Port.

4. Upload e Atualização do Firmware

Etapa 1 — Baixar o ProffieOS e os Arquivos do Cartão SD

Baixe o pacote de firmware do ProffieOS e os arquivos correspondentes do cartão SD.

Para os sabres SUPERNEOX equipados com ProffieBoard V2.2, este guia utiliza o ProffieOS 5.9 como versão de referência.

Extraia:

ProffieOS-v5.9.zip

Extraia o pacote para um diretório de trabalho normal, como Documentos ou Área de Trabalho.

A estrutura extraída deverá conter:

ProffieOS-v5.9/

└── ProffieOS/

Não renomeie nem mova as pastas ou arquivos dentro do diretório ProffieOS.

Etapa 2 — Instalar o Conteúdo do Cartão SD

Extraia:

ProffieOS_SD_Card.zip

Copie todos os arquivos da pasta extraída ProffieOS_SD_Card para o diretório raiz do cartão microSD do ProffieBoard.

Configurações de Extensão de Arquivos no Windows

Ative a opção Extensões de nomes de arquivos no Explorador de Arquivos do Windows para que extensões como .h fiquem visíveis.

Etapa 3 — Criar o Arquivo de Configuração

Abra:

ProffieOS/config/

Crie seu arquivo de configuração dentro desse diretório.

O fluxo de trabalho recomendado é copiar o arquivo de configuração padrão apropriado, renomear a cópia e substituir seu conteúdo pela configuração gerada para o seu sabre.

Para o ProffieBoard V2.x, utilize o Configurador oficial do ProffieBoard V2.x .

Etapa 4 — Selecionar o Arquivo de Configuração

Abra:

ProffieOS/ProffieOS.ino

Localize a definição CONFIG_FILE.

#define CONFIG_FILE "config/my_saber_config.h"

Se houver vários arquivos de configuração no diretório config, somente o arquivo que você deseja compilar deverá estar ativo.

Várias configurações de sabres podem permanecer no mesmo diretório config. Para alternar entre elas, altere o CONFIG_FILE ativo.

Etapa 5 — Conectar a Placa

Conecte o ProffieBoard ao computador usando um cabo Micro-USB com transferência de dados.

Etapa 6 — Compilar e Fazer Upload

1. Abra ProffieOS.ino no Arduino IDE.
2. Verifique se a placa ProffieBoard V2 correta e a porta COM correta estão selecionadas.
3. Confirme se o CONFIG_FILE correto está ativo.
4. Clique em Upload.
5. Aguarde a conclusão da compilação e do upload.

Após um upload bem-sucedido, o indicador de progresso deverá atingir 100%.

Se houver um alto-falante conectado, o ProffieBoard deverá reproduzir o som de inicialização após um upload concluído com sucesso.

Se a opção Serial + Mass Storage estiver selecionada e o ProffieBoard aparecer como uma unidade removível, ejete a unidade com segurança antes de desconectar o cabo USB.

Solução de Problemas de Upload

Se o upload falhar, verifique as causas mais comuns abaixo:

1. Pode haver um erro de sintaxe ou de configuração no arquivo de cabeçalho da configuração.
2. O nome definido em CONFIG_FILE pode estar incorreto.
3. O arquivo de configuração pode não estar localizado no diretório ProffieOS/config/.
4. O nome de usuário do Windows ou o diretório de trabalho pode conter caracteres não latinos que provoquem problemas na toolchain.
5. A placa, o tipo de USB, a velocidade da CPU ou a porta COM selecionada podem estar incorretos.

5. Conteúdo do Cartão SD

O ProffieOS utiliza o cartão microSD do sabre para armazenar fontes sonoras, arquivos relacionados à configuração e trilhas musicais.

Sound Fonts

Copie as pastas de Sound Fonts compatíveis para o diretório raiz do cartão microSD.

A configuração original oferece suporte a estruturas comuns de Sound Fonts, incluindo:

Ao utilizar uma estrutura de Sound Font compatível, normalmente não é necessário alterar os nomes dos arquivos WAV.

Trilhas Musicais

Coloque as trilhas musicais dentro de:

tracks/

Exemplo:

tracks/venus.wav

tracks/mars.wav
tracks/mercury.wav

Nomes de Arquivos e Pastas

Para obter a melhor compatibilidade, utilize caracteres latinos e nomes de arquivos simples para as pastas de Sound Fonts e as trilhas musicais.

Evite caracteres especiais desnecessários, como:

? , . | \ } { [ / -

Cada pasta de Sound Font deve conter os arquivos de configuração necessários, como:

config.ini

smoothsw.ini

6. Configuração e Parâmetros

A configuração do ProffieBoard é controlada principalmente por meio de um arquivo de cabeçalho de configuração C++ localizado em:

ProffieOS/config/

A configuração define o hardware da placa, a quantidade de lâminas, os botões, as configurações de áudio, os recursos de movimento, a configuração dos LEDs, a sensibilidade a Clash, os presets e os Blade Styles.

Configuração Básica do 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

Referência de Parâmetros

Sensibilidade de Clash

Um valor inicial documentado é:

#define CLASH_THRESHOLD_G 1.0

Valores mais baixos geralmente produzem uma detecção de Clash mais sensível, enquanto valores mais altos geralmente tornam a detecção menos sensível.

Editar a Configuração

Utilize um editor de texto simples ou um editor de código para modificar os arquivos de configuração C++.

Após alterar a configuração:

1. Salve o arquivo de configuração.
2. Abra ProffieOS.ino.
3. Verifique se o CONFIG_FILE correto está ativo.
4. Compile o firmware.
5. Faça o upload do firmware para o ProffieBoard.

7. Configuração de Presets

Os presets definem a Sound Font, a trilha sonora, o Blade Style e o nome legível utilizado pelo sabre.

Estrutura Básica de um Preset

Um preset típico é definido dentro da seção CONFIG_PRESETS:

#ifdef CONFIG_PRESETS

Preset presets[] = {

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

};

#endif

Componentes do Preset

Configuração da Lâmina

A configuração física da lâmina é declarada por meio de um array BladeConfig blades[].

Essa configuração associa o hardware físico de LED/lâmina à configuração dos presets.

BladeConfig blades[] = {

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

};

8. Blade Styles

O ProffieOS utiliza Blade Styles para definir o comportamento visual da lâmina principal e de outros LEDs configurados.

Recursos dos Blade Styles

• Cor base
• Alteração de cor
• Efeito de cintilação
• Flash de Clash
• Efeitos de Blaster
• Efeitos de Lockup
• Efeitos de Drag
• Efeitos de acendimento
• Efeitos de apagamento
• Temporização
• Comportamento das transições

Editor de Blade Style

A documentação original para desenvolvedores recomenda utilizar um Blade Style Editor para criar e modificar Blade Styles.

Recursos de referência úteis incluem:

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

Estrutura de um Blade Style

Um Blade Style normalmente é incluído dentro de uma expressão StylePtr<...>.

Os efeitos podem ser aninhados, permitindo que cada camada modifique ou transforme o resultado do efeito subjacente.

InOutHelper

InOutHelper<base color, 200, 300, Black>

Definições de Cores

Constantes de cores predefinidas podem ser utilizadas para cores comuns da lâmina:

WHITE
 

RED
GREEN
BLUE
PURPLE
CYAN
YELLOW
MAGENTA

Cores RGB personalizadas podem ser definidas usando:

Rgb<R, G, B>

Exemplo:

Rgb<255, 50, 0>

Cada canal RGB utiliza um valor entre 0 e 255:

• 0 = nenhuma saída desse canal
• 255 = saída máxima desse canal

AudioFlicker

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

AudioFlicker cria um efeito de cintilação na lâmina que responde ao áudio ou ao som de hum do sabre.

Uma diferença maior entre as duas cores geralmente produz uma variação visual mais intensa.

OnSpark

OnSpark<base color, spark color, duration>

OnSpark adiciona um efeito de faísca durante o acendimento da lâmina. O valor de duração é especificado em milissegundos.

SimpleClash

SimpleClash<base color, clash color, 40>

Adiciona um efeito de flash de Clash. O último parâmetro define a duração do efeito em milissegundos.

Lockup

Lockup<base color, lockup color>

Adiciona o efeito Lockup e define o comportamento da cor utilizada durante o efeito.

Blast

Blast<base color, blast color>

Adiciona o efeito Blaster e define a cor utilizada pelo efeito.

Exemplo de Blade Style Combinado

Um Blade Style mais avançado pode combinar vários efeitos em uma única expressão aninhada.

Um Blade Style combinado típico pode incluir:

• Cor base verde
• Audio flicker
• Faísca durante o acendimento
• Efeito de Clash
• Efeito de Blaster
• Efeito de Lockup
• Efeito de Drag
• Temporização do acendimento
• Temporização do apagamento

O Blade Style concluído deve ser inserido no StylePtr<...> correspondente dentro do preset.

9. Referências para Desenvolvedores

Para obter informações atuais sobre desenvolvimento, configuração e recursos específicos do ProffieOS e da placa, utilize os recursos oficiais abaixo em conjunto com este guia para desenvolvedores da SUPERNEOX.

10. Escopo da Documentação

O ProffieOS é mantido e atualizado continuamente. A sintaxe de configuração, os recursos disponíveis, o hardware compatível e o comportamento do sistema podem variar entre diferentes versões.