This page is meant as a consolidation of Proffieboard information, such as update, wiring example, etc...

Soundboard DIY Instructions – Proffieboard

Table of contents:

Introduction

  • Disclainer:

    GOTH-3Designs cannot be held responsible for any user mistake, accident, etc that could occur while installing the soundboard.

  • Warranty:

    All soundboard are tested prior to be shipped, using a custom test rig that doesn’t require any soldering but can still perform all functionality tests.
    Please note that Particleboard install is at your own risk and responsibility (or the one of your installer).
    Considering the install relies on the user experience in soldering, install skils.. etc, there is no warranty of the soundboard itself once installed.

  • Support:

    While we cannot offer warranty on these soundboards, we do offer support to the extend of our knowledge, or will rely on Proffieboard groups and forums to find proper answers.
    In case of issue, please reach out to our order support email.

  • Sources:

    https://fredrik.hubbe.net/lightsaber/
    https://crucible.hubbe.net/
    ProffieBoard 2 Manual

Requirements

    • A minimum of technical knowledge and soldering skills is required to install a Proffieboard. However, updating the setup on an already installed Proffie is instead a rather easy task.
      Check our Padawan Tutorial for recommended tools required for soundboard installs, … etc.
      This chapter will cover only the tools required for updating the soundboard

      Tools for updating the Proffieboard setup are:

      • A USB micro SD-card reader – The SD card can also be updated connecting the proffie to the computer, but will be much slower. We recommend instead to take out the SD card and use a reader (unless the SD card isn’t accessible).
      • A Micro USB data transfer cable – warning: many cable support only charging and won’t work.
        Additionally, in many install cases, the soundboard will have limited room to connect any cable to it. It is recommended to use a 90° angled cable.
        Example of cable here
        You can also build your own cable, like USB-C female to Mirco USB male and use any mobile phone data transfer USB-C cable.
      • A computer running Windows, Linux or Mac OS with internet access

      Next, to the software part:

      • Download Arduino IDE software. If using windows, version 1.8.3 is recommended (here)
      • Arduino IDE will need the Arduino-Proffieboard plugin 
        • Start the Arduino IDE
        • Go into File -> Preferences
        • In “Additional Board Manager URL”, enter the following text:
          https://profezzorn.github.io/arduino-proffieboard/package_proffieboard_index.json
      • Open Arduino menu Tools->Board->Boards Manager and type “Proffie” in the search box. Select and install the latest version “Proffieboard Plugin”.
      • You can now select either Proffieboard v2 or Proffieboard v3 from the menu Tools->Board
        You can also select the USB type and DOSFS accordingly, as shown below for Proffie 2 or 3 (:

      There can be some specific steps to be done depending on your computer OS.
      Note that we didn’t need any of these in our latest computer install using Windows 11.

      OS Specific Setup (nothing for MAC)

      Windows 

      Download proffie-dfu-setup and run it.

      If you’re using Windows 7 or earlier, you also need to install a USB ACM serial driver:

      1. Go to ~/AppData/Local/Arduino15/packages/profezzorn/hardware/stm32l4/<VERSION>/drivers/windows
      2. Right-click on dpinst_x86.exe (32 bit Windows) or dpinst_amd64.exe (64 bit Windows) and select Run as administrator
      3. Click on Install this driver software anyway at the Windows Security popup as the driver is unsigned

      Linux 

      1. Go to ~/.arduino15/packages/profezzorn/hardware/stm32l4/<VERSION>/drivers/linux/
      2. sudo cp *.rules /etc/udev/rules.d
      3. reboot

      If you have no 32-bit support, you will get this error:
      dfu-suffix: no such file or directory

      On debian-like systems, this can be fixed with the following commands:
      sudo dpkg –add-architecture i386
      sudo apt-get update
      sudo apt-get install libc6:i386 libncurses5:i386 libstdc++6:i386

      Your computer is now ready to connect to the Proffieboard through Arduino IDE.

    Proffieboard Setup Upldate – Basics

    • Understanding Proffieboard

      As a basic, you should know 2 things:

      • A Proffieboard run on ProffieOS (the same way a computer runs on Windows or alse oparating sytem).
        Current OS version is ProffieOS 7.15
        Some of our Lightsaber projects already run on an ProffieOS 8 Beta version that have advanced BladeID functionalities (see our Advanced section), like our Rising Star saber.
      • The sabers or props needs a specific config file to be uploaded through the USB / Ardiuno IDE.
        The Config file end with .h file format and is located in the “Config” folder of ProffieOS root directory

      To make things easier, all props purchased through The Kyber Temple will included both ProffieOD and Config file on the SD card.

      Proffie OS directory can be unzipped anywhere on your computer.

      And look like this. The only repertory that will then be updated is the “Config” folder, where all your props specific setup will be located

      For a better understanding of .h config files, see the Advanced section.

      Updating Proffieboard

      Updating Proffieboard will upload both the OS and specific config file into the board.
      The OS version will thus depend from the folder from which is launched Arduino IDE.
      Go to your ProffieOS folder and launch ProffieOS.ino

      Select the Proffieboard version (as seen before, V2 or V3)
      Then, copy paste the config file name into this space.
      For example:
      #define CONFIG_FILE “config/proffieboard_v2_Savii-Upgrade-Kit-V2.h”

      Connect the soundboard with the USB cable.
      Under Tools > Ports, the Proffieboard should appear. Select it.

      You can first verify if the config file will compile correctly before actually uploading it using the check button.
      Or you can upload the config directly to the Proffieboard using the Arrow buttons

      Once the config is uploaded successfully, the soundboard will restart and emit the boot sound of the first soundfont on the config.

      This concludes the section for basics.

    Proffieboard Setup – Advanced

    • Coming soon – stay tuned!

    Proffieboard V2 Wiring

    • Coming soon – stay tuned!

    Proffieboard V3 Wiring

    • Coming soon – stay tuned!

    Button Controls Summary

    • Terminology:

      Click = do short click (so Double Click is two short clicks in quick succession)
      Long Click = hold button for 1 second and release
      Hold = hold button down
      Click and Hold = hold on Xth click (so Double Click and Hold would be click twice and hold on second click)
      Click + Long Click = do X clicks then do long click (so Double Click + Long Click would be click twice then do a long click)
      Clash = hit the saber
      Hold + Clash = hit the saber while holding the main button 

      1 Button Controls

      Standard Controls While Blade is OFF

      • Turn On / Ignite Saber* = Click
        *If the saber has not been used for a while (asleep) first Click will Wake up motion detection and boot sound will play
      • Turn On / Ignite Saber (Muted) = Click + Long Click
      • Start / Stop Music Tracks = Double Click (pointing straight up)
      • Track Player = Double Click (parallel or down)
        Turn Right (Stepped) = Next Track
        Turn Left (Stepped) = Previous Track
        Click button = Play Current Track Once
        Hold button = Random (will play current track and then randomly select next tracks)
        Hold button + Turn Right = Rotate (will play current track and then next sequential tracks)
        Hold button + Turn Left = Loop Current Track
      • Force/Quote Player – Triple Click
        If quotes exist in current font pointing straight down will toggle between Force/Quote and play
        *Quotes play sequentially 1,2,3…
        If parallel will do Force/Quote based on current mode
        Special Abilities (Style Controlled) (requires FETT263_SPECIAL_ABILITIES)
        Hold PWR + Turn Right (parallel or up) = Special Ability 5 (USER5)
        Hold PWR + Turn Left (parallel or up) = Special Ability 6 (USER6)
        Hold PWR + Turn Right (pointing down) = Special Ability 7 (USER7)
        Hold PWR + Turn Left (pointing down) = Special Ability 8 (USER8)
      • Next Preset = Long Click  (parallel or up)
      • Previous Preset = Long Click  (pointing down)
      • Scroll Presets (using twist menu) = Hold
        Turn Right (Stepped) = Next Preset
        Turn Left (Stepped) = Previous Preset
        Click button = Select Preset
        Hold button = Select and Ignite Preset
        Long Click button = First Preset
      • Volume Menu = Hold + Clash (parallel or up)
        Turn Right (Stepped) = Increase Volume (to max)
        Turn Left (Stepped) = Decrease Volume (to min)
        Click button = Exit
      • Battery Level* = Double Click + Long Click
        Point down for volts, parallel or up for percent

      Standard Controls While Blade is ON

      • Turn Off / Retract Blade = Hold
      • Clash Effect = Clash Saber
      • Lockup Effect = Hold + Clash
      • Lightning Block = Double Click and Hold
      • Blast Effect = Click / Double Click / Triple Click
      • Multi-Blast Mode = Hold + Swing
        Each Swing in Multi-Blast Mode will deflect Blast effect
        To exit, click PWR or do Clash
      • Force/Quote = Long Click 
        If pointing down will toggle Force/Quote mode and do Force Effect or play Quote accordingly
        *Quote plays sequentially
        If parallel will do Force/Quote
      • Stop Track* – Double Click 
        *if track is playing while ON
        To start/select track saber must be OFF
      • Color Change = 4 Clicks (parallel or down)
      • Color Zoom* = Double Click and Hol, Release to Save
        *For Color List or ColorWheel you can Hold PWR down to zoom in color for easier selection
        Release PWR to save

      Edit Mode (for information)

      Enter Edit Mode = While Off, Double Click and Hold
      While in Edit Mode controls are as follows:
      Rotate Forward, Increase Value, Confirm “Yes” = Turn Right (Stepped)
      Increment by 5 (Fonts, Tracks, Blade Length) = Hold PWR + Turn Right
      Increment by 500 (Ignition Time, Ignition Delay, Retraction Time, Retraction Delay) = Hold PWR + Turn Right
      Increment by 5000 (Ignition Option2, Retraction Option2) = Hold PWR + Turn Right
      Rotate Back, Decrease Value, Confirm “No” = Turn Left (Stepped)
      Increment by 5 (Fonts, Tracks, Blade Length) = Hold PWR + Turn Left
      Increment by 500 (Ignition Time, Ignition Delay, Retraction Time, Retraction Delay) = Hold PWR + Turn Left
      Increment by 5000 (Ignition Option2, Retraction Option2) = Hold PWR + Turn Left
      Select, Save, Enter = Click button
      Cancel, Revert, Go Back = Long Click button
      Go to Main Menu (from sub-menu) – Hold button
      Exit Edit Mode – Hold button (or rotate to “Exit”) while in Main Menu

      2 Button Controls

      Work in progress

    Recommendations and Troubleshooting

    • Battery handling
      – Make sure to always insert the battery in the right way with the positive (button) toward the positive battery pad (also button).
      – Switch the soundboard off (kill switch) while operating the battery.
      – In the event the battery is inserted backwards and the soundboard is started, a protection component will fry on the soundboard which will make it inoperative. The soundboard will then have to be replaced.
      – Neopixel blade are bright and also power angry. That’s why it is essential to use only protected Li-ion 3.7v batteries with 10A to 15A discharge protection circuit.
      We recommend the brand Keepower.

      Battery charge
      – If the saber sound starts crackling, this means the battery is running out of power.
      – If the blade color hue starts to lean toward redish, this also means the battery is running out of power.
      – Recharge the battery with a 18650 Li-ion charger. They are easy to find and usually cheap (example)

      Known Issues

      – Sound freeze, blade effect freeze…: Like any electronic device, bug can happen during usage, but a simple reboot (on/off switch) usually fixes it. 
      – “Font directory not found. SD card not found” spoken error…: Check if sound fonts folders names on SD card exactly match the font names in each Preset in your config.h file. Reformat SD card in FAT32 and try again.
      Proffieboard is not recognized by computer (nothing under Port selection in Arduino IDE)…: Make sure a charged 3.7V battery is connected to the board, micro-USB cable is a data transfer cable, all plugins and drivers are installed as per this page requirements. Try a different cable and USB port on your computer.
      Alternatively, the proffieboard could be in delivered in Bootloader mode, try uploading a config without selecting a port. If the config uploaded successfully, the board should now be recognized.
      Sketch (code) compile error in Arduino IDE: … sketch\config/proffiev2config.h:42:1: error: cannot convert ‘StyleFactory*’ to ‘const char*’ in initialization …: Missing blade style in one of the Presets: NUM_BLADES set to 2 or more, but Presets have less blade styles.
      Sketch (code) compile error in Arduino IDE: … sketch\config/proffiev2config.h:42:1: error: too many initializers for ‘Preset’ …:  Check if #define NUM_BLADES value matches the number of your blade styles in each Preset. Some of the Presets have more blade styles than needed.
      Sound doesn’t play…: Remove SD card and insert again, check speaker wiring. Make sure all sound files on SD card are correctly named. Re-format SD card in FAT32, load sound files and try again.
      If the SD Card doesn’t show up on the computer, it could be dead. try another SD card.

      Customer Support
      If you have any issues with your build or parts, please contact this email