Configuration Settings

{TOC}

DATA_RATE

Description
Only need to set this if you are not using OTA. By default, an OTA enabled receiver uses RF24_250KBPS during the configuration period. That is the speed your OTA configuration packets are transmitted at if you didn't customize the OTA configuration sketch. The OTA packets you send from the configuration web page set the data rate for the RF data your RF transmitter is configured for.

If you're not using OTA, set this to whatever your RF transmitter sketch was set to when you downloaded that sketch.

Valid Values

• RF24_250KBPS
• RF24_1MBPS
  

Example Usage

 #define DATA_RATE                       RF24_250KBPS 

DEBUG

Description
This setting enables debug printing for various sketches. That includes a print of radio details upon initialization and potentially a lot of other debugging information. The default baud rate is 115200 and this is likely to cause timing bugs with the RF1 sketches and shouldn't be tried at home.

Valid Values

• 1 - Debugging enabled
  

Example Usage

 #define DEBUG                           1 

DUMB_BLINKER

Description
This setting will turn the RF_In_Strobe_Out sketch into one that simply strobes all outputs of the sketch when power is applied.

Valid Values

• 0 - RF Controlled strobing enabled
  
• 1 - Always (dumb) strobing enabled
  

Example Usage

 #define DUMB_BLINKER                           1 

FCC_RESTRICT

Descripton
The Federal Communications Commission (FCC) has issued letters suggesting that hobbyists not use the nRF channels 83-100; when this item is set to 1, the compiler will determine whether the channel setting interferes with the FCC-restricted channels, generating an error and failing to compile the sketch.

Valid Values

• 0 - Does not check the channel to see if it's set for between 83-100 and sketches compile without a warning.
  
• 1 - Check the channel to see if it's set for between 83-100 and ending the sketches compilation with an error.
  

Example Usage

 #define FCC_RESTRICT 1 

HARDCODED_NUM_CHANNELS

Description
This is the number of channels this device will be reading the data from the stream and controlling. This is NOT the number of pixels you need. The actual number of pixels (if that's what you're controlling) is this value divided by 3, one each for Red, Green, and blue.

Valid Values
1-4584

Example Usage

 #define HARDCODED_NUM_CHANNELS          512 

HARDCODED_NUM_PIXELS

Description
This is the number of pixels this device will be reading the data from the stream and controlling. This is NOT the number of channels you need. The actual number of channels is this value times three, one each for Red, Green and Blue.

Valid Values
1-170

Example Usage

 #define HARDCODED_NUM_PIXELS            50 

HARDCODED_START_CHANNEL

Description
This is the start channel for this controller. If you're transmitting 200 channels worth of wireless data and you'd like for this controller to respond to channels 37-43 (2 pixels worth), you would configure HARDCODED_START_CHANNEL to the value 37, and the HARDCODED_NUM_PIXELS to 2.

Valid Values
1-512

Example Usage

 #define HARDCODED_START_CHANNEL         1 

IP Address

Description
The IP address for your OTA configuration node or E131 transmitter. This setting is only valid for the OTA_Configuration and RF_Out_E131_In sketches. You must set this to be on the proper subnet as well as to a unique value for each device. To avoid IP address conflicts, you must also ensure it is not an IP address that your network's DHCP server might assign to some other device.

Valid Values
See: http://www.dummies.com/how-to/content/what-is-an-ip-address.html

Example Usage

 static uint8_t ip[] =  { 192, 168, 1, 99 }; 

LED_BRIGHTNESS

Description
How Bright should our LEDs start during initialization. Only valid for Pixel sketch when configured to one of the following PIXEL_TYPE values: LPD_8806, SM_16716, TM_1803, TM_1809, UCS_1903, WS_2801 or WS_2811.

Valid Values
0-255

Example Usage

 #define LED_BRIGHTNESS                  128 

LISTEN_CHANNEL

Description
Which RF Channel do you want to listen on? This needs to match the channel you've configured your transmitter for broadcasting its data. If you're broadcasting multiple universes worth of data, you'll want each transmit/listen channel to be at least 5 channels away from each other for best results. There is also a scanner sketch available for your RF1 to log RF activity in the 2.4GHz range to aid in selecting your channels. Keep in mind, regular WiFi and many other devices are in this range and can cause interference.

Valid Values
1-124

Example Usage

 #define LISTEN_CHANNEL                  10 

MAC Address

Description
The media access control (MAC) address that has been assigned to your Ethernet shield. This is only required for the OTA_Configuration and the RF_Out_E131_In sketches. You should ensure that you do not have two devices on your network configured to use the same MAC address. You can either increment the last digit for each additional device or generate new ones using the link below.

Valid Values
See: http://www.miniwebtool.com/mac-address-generator/

Example Usage

 static uint8_t mac[] = { 0x12, 0x34, 0x56, 0xBE, 0xEE, 0xEF }; 

NRF_TYPE

Description
What board are you using to connect your nRF24L01+?

Valid Values

• RF1 - Most RF1 Devices including RF1_12V devices
• RF1_SERIAL - The All in one RF1Serial
• MINIMALIST_SHIELD - Minimalist shield designed to go atop a standard Arduino
• WM_2999_NRF - WM299 specific board
• RFCOLOR_2_4 - RFColor24 device to control GECEs
• KOMBLINKIN - Specific board for strobe lights
• RAPTOR12 - Specific board for AC/DC light control
• KOMBEE - When used with the kombee (both SMD and full size) so that it can blink the status pin on a REN-W adapter
  

Example Usage

 #define NRF_TYPE                        RF1 

OVER_THE_AIR_CONFIG_ENABLE

Description
If you're using Over-The-Air configuration, set this value to 1 and skip the NON-OTA CONFIGURATION section below. Otherwise, leave this at 0 and skip the OTA CONFIGURATION section below.

OTA makes it so you can make an RF node that can re-program your RF1s in the field. This means the RF1s will search for a configuration broadcast for 5 seconds after power-on. If no broadcast is found, it will read it's configuration from EEPROM for the last known working configuration.

Valid Values

• 0 - do not use OTA
• 1 - use OTA
  

Example Usage

 #define OVER_THE_AIR_CONFIG_ENABLE      0 

PACKET_SEND_DELAY

Description
This is a delay in milliseconds that is observed in between sending OTA initialization packet and logical controller packets. Increase this if testing and using debug prints on a development OTA receiver.

Valid Values
1-4294967295

Example Usage

 #define PACKET_SEND_DELAY 1000 

PIXEL_CLOCK_PIN

Description
Arduino (or clone) output pin that drives the clock line of your pixel strand when using 4 pin pixels like WS2801. The default, and bottom clock pin for the RF1 devices is 4.

Valid Values
Any arduino output pin, typically 1-16

Example Usage

 #define PIXEL_CLOCK_PIN                 4 

PIXEL_COLOR_ORDER

Description
This is the order your pixel string expects the data to be sent. This only works for sketches that use the FastLED sketch as a base: LPD_8806, SM_16716, TM_1803, TM_1809, UCS_1903, WS_2801 or WS_2811.

Valid Values

• RGB
• RBG
• GRB
• GBR
• BRG
• BGR
  

Example Usage

 #define PIXEL_COLOR_ORDER               RGB 

PIXEL_DATA_PIN

Description
Arduino (or clone) output pin that will go to the data line of your pixel strand. The default, and bottom data pin for the RF1 devices is 2.

Valid Values
Any arduino output pin, typically 1-16

Example Usage

 #define PIXEL_DATA_PIN                  2 

PIXEL_TYPE

Description
What type of pixels are you trying to control?

Valid Values

• DMX¹
• GECE²
• GWTS_EARS¹
• LPD_6803²
• LPD_8806³
• NONE¹
• RENARD¹
• SM_16716³
• TM_1803³
• TM_1809³
• UCS_1903³
• WM_2999²
• WS_2801³
• WS_2811³
  

¹ - Specially reserved for the DMX sketch, do not use for Pixel sketch
² - Komby custom sketch, doesn't support advanced features like PIXEL_COLOR_ORDER or LED_BRIGHTNESS
³ - Supported by FastLED, has advanced features like PIXEL_COLOR_ORDER and LED_BRIGHTNESS

Example Usage

 #define PIXEL_TYPE                      WS_2811 

RECEIVER_UNIQUE_ID

Description
This id should be unique for each receiver in your setup. This value determines how you will target this node for configuration using the OTA transmit sketch. You should write this somewhere on the RF1 after programming so in case you need to reprogram the settings, you know which device you're targeting.

Valid Values
1-255

Example Usage

 #define RECEIVER_UNIQUE_ID              33 

REFRESH_RATE

Description
Rate in milliseconds which the transmitter will resend all the data if no new data is received within this duration. A value of 0 disables the resend feature.

Valid Values
1-4294967295

Example Usage

 #define REFRESH_RATE 0 

RENARD_BAUD_RATE

Description
Baud rate that your Renard controllers are programmed for. This must match the input or output of the Renard controller connected to this particular Komby device.

Valid Values

• 460800
• 230400
• 115200
• 57600
• 38400
• 19200
  

Example Usage

 #define RENARD_BAUD_RATE                57600 

RF_DELAY

Description
How long to wait between sending RF packets in the test debug sketch. It is an forced delay between each individual 30-byte payload packet, not between all channels.

Valid Values
1-65536

Example Usage

 #define RF_DELAY                        2000 

RGB Pins

RED_PIN

Description
Pin for the RED output for a Komby device that's doing simple RGB control. If you made a custom RGB shield that uses different pins than the Komby version, you may need to tweak this. Most likely, this does not need to be changed.

Valid Values
If using a Komby device Pin 3 is valid for Red, If another Arduino device set this to the PWM pin you are connecting to.

Example Usage

 #define RED_PIN                         3 

GREEN_PIN

Description
Pin for the GREEN output for a Komby device that's doing simple RGB control. If you made a custom RGB shield that uses different pins than the Komby version, you may need to tweak this. Most likely, this does not need to be changed.

Valid Values
If using a RF1 device 5 is the only valid value, If using another Arduino use only PWM enabled pins.

Example Usage

 #define GREEN_PIN                       5 

BLUE_PIN

Description
Pin for the BLUE output for a Komby device that's doing simple RGB control. If you made a custom RGB shield that uses different pins than the Komby version, you may need to tweak this. Most likely, this does not need to be changed.

Valid Values
If using a RF1 device 9 is the only valid value, If using another Arduino use only PWM enabled pins.

Example Usage

 #define BLUE_PIN                        9 

WHITE_PIN

Description
Pin for the White output for a device that's doing simple RGBW control. Currently no Komby Shields support RGBW options, so use this option only If you made a custom RGBW shield.

Valid Values
Any Arduino PWM pin.

Example Usage

 #define WHITE_PIN                        5 

TRANSMIT_CHANNEL

Description
What nRF channel do you want to transmit on? This needs to match the channel you've configured your receiver to listen for its data. If you're broadcasting multiple universes worth of data, you'll want each transmit/listen channel to be at least five channels away from each other for best results. There is also a scanner sketch available for your RF1 to log RF activity in the 2.4GHz range to aid in selecting your channels. Keep in mind, regular WiFi and many other devices are in this range and can cause interference, The FCC restricts the usage of channels 84-100 so don't try those unless you want to have issues. You will receive a compiler error if you attempt to use an invalid channel.

Valid Values
0-83, 101-127 (Note: use of channels 84-100 is not allowed in the US)

Example Usage

 #define TRANSMIT_CHANNEL                10 

UNIVERSE

Description
This setting needs to be set to the DMX universe you are listening to from your sequencer. If you are setting your E1.31 transmitter to receive Universe 1 you would set this option to 1.

Valid Values
1-65536

Example Usage

 #define UNIVERSE                        1 

USE_DHCP

Description
In the OTA and E1.31 sketches, this setting will tell the sketch to use DHCP to find an IP address instead of one hard-coded into the sketch. If you want to use DHCP instead of manually assigning a static IP address, set this value to 1.

Valid Values
0 - Use the static IP address in the sketch configuration 1 - Use DHCP to automatically assign an IP address

Example Usage

 #define USE_DHCP                        1 

KÖMBLINKIN

STROBE_DURATION

Description
Lights the LED for the amount of time (in miliseconds) as specified. (There are 1000 milliseconds in a second.)

Example Usage

 #define STROBE_DURATION 75 

STROBE_MODE

Description
Turns strobing on (1) or off (0).

Example Usage

 #define STROBE_MODE 1