The CONFIG_TOP section is primarily used to set up defines which enable and disable features in the code. However, it is also used to include a board specific config file. Let's start with the required parts:
First, we must include a board config file, basically, we have to pick one of these lines:
#include "v1_config.h" // TeensySaber V1
#include "v2_config.h" // TeensySaber V2
#include "v3_config.h" // TeensySaber V3
#include "proffieboard_v1_config.h" // Proffieboard V1
#include "proffieboard_v2_config.h" // Proffieboard V2
#include "proffieboard_v3_config.h" // Proffieboard V3
Note that if you include the proffieboard_config.h file (no version in the filename), the appropriate board version will be chosen for you based on which board is being programmed. This allows you to use your config on multiple versions of Proffieboards without needing to change this line to match.
Next we must defines how many blades there are. Note that accent LEDs, crystal chambers and light-up buttons also counts as blades.
#define NUM_BLADES 1
And we must also specify how many buttons we have. Note that this is just used to change how some of the buttons behave, and nothing will actually break if you specify a number different from your actual number of buttons.
#define NUM_BUTTONS 2
Then we specify the volumes. Generally values between 0 and 3000 are useful, but it may depend on what kind of board you have.
#define VOLUME 1000
I don't remember why, but this next number is a constant instead of a define. It specifies how many pixels we can have in a single strip. Note that if you use RGBW pixels, this number needs to be 25% bigger than your actual number of pixels. There is no need to make this smaller if your strips are not 144 pixels long, but you do need to make it bigger if they are more than 144 pixels long.
const unsigned int maxLedsPerStrip = 144;
Next, we have the clash threshold. When two consecutive accelerometer readings differ by this much, a clash is triggered. The unit is in Gs. (About 9.81 newtons.) Larger values will make clashes harder to trigger, smaller values will make clashes easier to trigger.
#define CLASH_THRESHOLD_G 1.0
Please note that in ProffieOS 6.x, some changes were made to the motion detection system. This tended to make clash detection more sensetive, so it's not uncommon to have to increase the clash threshold when upgrading from 5.x to 6.x.
In ProffieOS 7.x, the clash detection was modified in ways that makes it less sensetive to false clashes. This change also means that the CLASH_THRESHOLD_G might have to be changed when upgrading from 6.x to 7.x. However, in this case you will probably be adjusting the clash threshold downwards rather than upwards.
Finally, we have a set of defines that enable standard features. It's on my TODO list to make these not required:
This define enables the OLED display code.
This code will flip the OLED displayed content 180 degrees.
This code makes it possible to use the same power pins for multiple blades.
If your board is installed in a different orientation than normal, you may need to add one of the following lines to make ProffieOS behave properly:
#define ORIENTATION ORIENTATION_NORMAL // USB connector points away from blade
#define ORIENTATION ORIENTATION_FETS_TOWARDS_BLADE
#define ORIENTATION ORIENTATION_USB_TOWARDS_BLADE
#define ORIENTATION ORIENTATION_USB_CCW_FROM_BLADE
#define ORIENTATION ORIENTATION_USB_CW_FROM_BLADE
#define ORIENTATION ORIENTATION_TOP_TOWARDS_BLADE
#define ORIENTATION ORIENTATION_BOTTOM_TOWARDS_BLADE
For a visual reference for these, see board_orientations.png
For Curved hilts, or where the board is not parallel with the blade (for Twist on/off particularly) This will rotate the orientation of the board 20 degrees around the Y axis. Depending on the orientation of the board, you might need -20 degrees instead. (Or 15 degrees? or 30?)
#define ORIENTATION_ROTATION 0,20,0
This one means that clicking the AUX will also turn the saber on. If not defined, AUX will go to next preset when off.
This enables the serial port, which can be used to talk to a BLE chip.
If you have a redbear BLE nano bluetooth chip, you'll need the following three defines to configure it:
#define BLE_PASSWORD "password"
#define BLE_NAME "saber"
#define BLE_SHORTNAME "saber"
The BLE_PASSWORD must be 20 characters or less. BLE_SHORTNAME must be 8 characters or less.
This is only for TeensySaber V1 and enables the serialflash chip on the PJRC prop board
This enables the FastLED blade driver, which can be used to drive dotstar blades. This is experimental and may not work properly.
To use blade ID in a 3-pin connector, the GND leg of the resistor has to be hooked up to the part that is controlled by FETs. That means that those FETs has to be powered on in order for blade ID to work. This define lets you do that by specifying which FETs needs to be powered while the blade is identified.
#define ENABLE_POWER_FOR_ID PowerPINS<bladePowerPin1,bladePowerPin2,bladePowerPin3>
See the blade ID page for more information.
By default, some commands which are only useful for developers are normally not compiled into the final binary to save memory, if you want them, add this define to enable them.
Plase beware that this turns off some useful commands, like "sdtest" and "monitor".
To save even more memory, you can disable some diagnostic commands like "monitor", "top" and "sdtest" using this define:
Proffieboards have some challenges when it comes to BladeID, but it's possible to work around them by adding a bridge to another pin, or by adding a pullup resistor. However, when you do so, you have to use the BLADE_ID_CLASS to specify how the OS should calculate the Blade ID. Chose one of:
#define BLADE_ID_CLASS BridgedPullupBladeID<bladeIdentifyPin, BRIDGED_PIN>
#define BLADE_ID_CLASS ExternalPullupBladeID<bladeIdentifyPin, PULLUP_RESISTANCE>
See the blade ID page for more information.
ProffieOS has pretty good standby idle time, but if you have accent LEDs that glow even when the saber is off, that will make your saber run out of batteries pretty fast. This define lets you specify a timeout for such accent LEDs (in milliseconds), this example would set it to 10 minutes:
#define IDLE_OFF_TIME 60 * 10 * 1000
If you think color change is annoying, or you just need to save some memory, you can disable the color change feature with this define:
This define lets you use a pin to detect when a blade is present or not. The pin will work kind of like a latching button which is pressed when there is a blade in the saber. When there is no blade in the saber, NO_BLADE (one billion) will be added to the blade ID.
#define BLADE_DETECT_PIN PIN
See the Blade Detect page for more information.
On-the-fly color changing is new in 3.x. If you want it to save the color change state, add this define to your config file:
Start with the volume used last
Start at the last preset when you turn the saber on:
Save state is one define to encompass SAVE_COLOR_CHANGE, SAVE_VOLUME and SAVE_PRESET. (From ProffieOS 7.8 onward, this also encompasses SAVE_BLADE_DIMMING)
From OS4.7 onward: After uploading, all .INI file will be deleted from the SD card. These files may contain modifications to your uploaded config file such as saved colorcahngemode info, volume etc. To retain this additional information even after re-flashing ProffieOS to the board, use:
Please use this define with caution. If you leave this define in your config file when you are tring to make changes to your saber, weird things tends to happen.
See this page for further information.
If your board is not mounted at 90 degree angles to the hilt, you can use this define:
#define ORIENTATION_ROTATION X,Y,Z
The X, Y and Z are floating point numbers which specify how many degrees to rotate all measurements.
Add an RFID reader. To configure the RFID reader, you will need an RFID_Commands array in the CONFIG_PRESETS section.
#define RFID_SERIAL Serial3
To calibrate your touch buttons, you can temporarily add this to your config to have ProffieOS say the touch values out loud. Can be confusing if you have more than one touch button. If you have more than one, calibrate one at a time and comment out the rest temporarily.
This enables I2S output, Data3 is SCK, Data4 is FS and Button2/aux is DATA
This enables SPDIF output. The SPDIF signal will come out at 3.3 volts on Button2/AUX.
If you use ENABLE_I2S_OUT or ENABLE_SPDIF_OUT, you can control the volume with this define:
#define LINE_OUT_VOLUME 2000
The default is 2000. If you want the line out volume to follow the master volume, you do:
#define LINE_OUT_VOLUME dynamic_mixer.get_volume()
Enables dynamic blade dimming / blade length / clash threshold, controllable from ProffieOS Workbench or some props.
Enable storing the dynamic dimming / clash threshold. Doesn't do anything unless the corresponding DYNAMIC_* define is also used.
Includes support for ssd1306 displays, but does not automatically enable it. This lets you declare your own display and set the size and controller for the display.
If present, these defines enable a butterworth highpass filter with the given order and cutoff frequency. The idea is to remove frequencies that your speaker can't reproduce anyways to put less stress on the speaker. The filter order defaults to 8. A reasonable cutoff frequncy might be 100Hz. The filter does not affect I2C or S/PDIF output if enabled.
This define will make ProffieOS remember which file (of each effect) was played last and avoid playing it again next time. If there are only 2 of a particular sound, there is still a chance that the same sound is played to avoid simply flipping between them in a predictable pattern.
Uses a female talkie voice, only affects built-in error messages, for other sounds, go check out the Sound Library.
Saves memory by disabling old-fashioned styles. With this define, these styles will not be available in the ProffieOS Workbench.
The following "umbrella" define is equivalent to separately defining:
#define SAVE_STATE is different, as that encompasses:
SAVE_BLADE_DIMMING (From ProffieOS 7.9 onward)
Let's you specify what volume should be used at boot.
Note that if
#define SAVE_VOLUME is active (or SAVE_STATE or ENABLE_ALL_EDIT_OPTIONS since they also encompass SAVE_VOLUME), BOOT_VOLUME wil be overridden by your saved value.
#define BOOT_VOLUME 300
When playing overlapping effects, you can sometimes run out of available wav players. When this define is enabled, ProffieOS will find the oldest playing overlapping effect and stop that sound to make room for the new sound to play. The result is that the new sound always plays.
Saves 7.5kB of flash memory by disabling the spoken error codes that ProffieOS uses. The spoken error codes will be replaced with beeps, and you can use the ("What is it beeping?" page)[/troubleshooting/beep_codes.html] to figure out what the sounds mean. You can also see the errors in the (serial monitor)[/tools/serial-monitor.html].
This define tells ProffieOS to run the blade ID multiple times and then average the results. This is particularly helpful when using BLADE_ID_SCAN_MILLIS, as the results tends to be very noisy otherwise.
#define BLADE_ID_TIMES 10
With this define, blade ID will run all the time, even when the blade is on. The define specifies how many milliseconds in between each blade ID scan. Reasonable values might be 100 to 5000 ms. If the computed blade ID is different from the previous ones, then the saber will re-load blade definitions and presets, as if a Blade Detect event had occured.
#define BLADE_ID_SCAN_MILLIS 500
Please note, you will most likely need BLADE_ID_TIMES and SHARED_POWER_PINS to use this define. Also, it currently only works with pixel blades.
This define lets you adjust how much harder it is to do a clash when the audio is loud. The useful range is roughly 1 to 50, and the default is 10.
#define AUDIO_CLASH_SUPPRESSION_LEVEL 20
This define allows you to use only Accelerometer for Clash Detection (OS6 or earlier algorithm), instead of Accelerometer and Gyro combined (OS7 algorithm).
This define lets you include some other POV data instead of the default star wars logo. To learn how to generate pov data, go check out the POV tools
#define POV_INCLUDE_FILE "jedi_logo.h"