Not logged in - Login
< back

Configuration Settings

{TOC}

DATA_RATE

Description
Only need to set this if you are not using OTA. By defaut 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 configuring 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 

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 3, 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 

LED_BRIGHTNESS

Description
How Bright should our LEDs start during initialization. Only valid for sketches: (TODO)

Valid Values
0-255

Example Usage

 #define LED_BRIGHTNESS                  128 50% 

LISTEN_CHANNEL

Description
RF Channel do you want to listen on? This needs to match the channel you've configured your transmitter for broadcasting it's data. If you're broadcasting multiple universes worth of data, you'll want each transmit/listen channel to be at least (TODO) X 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                  100 

NRF_TYPE

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

Valid Values

  • RF1 - Most RF1 Devices including RF1_12V devices
  • 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

Example Usage

 #define NRF_TYPE                        RF1 

PIXEL_TYPEOVER_THE_AIR_CONFIG_ENABLE

Description
WhatIf typeyou're ofusing pixelsOver-The-Air areconfiguration, 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 tryingcan tomake control?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

  • LPD_88060 - do not use OTA
  • WS_2801
  • SM_16716
  • TM_1809
  • TM_1803
  • UCS_1903
  • WS_2811
  • GECE
  • LPD_6803
  • TODO1 - use OTA

Example Usage

 #define PIXEL_TYPE                      WS_2811 

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                  2OVER_THE_AIR_CONFIG_ENABLE      0 

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: (TODO).

Valid Values

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

Example Usage

 #define PIXEL_COLOR_ORDER               RGB 

OVER_THE_AIR_CONFIG_ENABLEPIXEL_DATA_PIN

Description
IfArduino you're(or usingclone) Over-The-Airoutput configuration,pin setthat thiswill valuego to 1the data line of your pixel strand. The default, and skipbottom the NON-OTAdata CONFIGURATIONpin section below. Otherwise, leave this at 0 and skipfor the OTARF1 CONFIGURATIONdevices sectionis below.2.

OTAValid makesValues
Any itarduino sooutput pin, typically 1-16

Example Usage

 #define PIXEL_DATA_PIN                  2 

PIXEL_TYPE

Description
What type of pixels are you cantrying maketo 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.control?

Valid Values

  • 0 - do not use OTALPD_8806
  • 1 - use OTAWS_2801
  • SM_16716
  • TM_1809
  • TM_1803
  • UCS_1903
  • WS_2811
  • GECE
  • LPD_6803
  • TODO

Example Usage

 #define OVER_THE_AIR_CONFIG_ENABLE      0PIXEL_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 

LISTEN_CHANNELTRANSMIT_CHANNEL

Description
RF Channel do you want to listentransmit on? This needs to match the channel you've configured your transmitterreceiver to listen for broadcasting it's data. If you're broadcasting multiple universes worth of data, you'll want each transmit/listen channel to be at least (TODO) X 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                  100 

DATA_RATE

Description
Only need to set this if you are not using OTA. By defaut 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 configuring that sketch.

Valid Values

  • RF24_250KBPS
  • RF24_1MBPS

Example Usage

 #define DATA_RATE                       RF24_250KBPS 

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 

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 3, one each for Red, Green, and blue.

Valid Values
1-170

Example Usage

 #define HARDCODED_NUM_PIXELS            20 

TODO

Example Usage

 #define DEBUG                         1 

Example Usage
 #define PIXEL_TYPE                      FAST_SPI 

How Bright should our LEDs start at
Example Usage

 #define LED_BRIGHTNESS                  128 50% 

UNIVERSE

Description
The Universe 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-255 (TODO: Double check valid universe values)

Example Usage
ValidValue

 -#define IntegerUNIVERSE                         1 which represents the Universe number to receive data from

TODO

IP_ADDRESS

Description


ValidValue

PIXEL_TYPERGB Pins

BLUE_PIN

Description
Description goes here.

Valid Values
Valid values here

Example Usage

 #define X X 

GREEN_PIN

Description
Description goes here.

Valid Values
Valid values here

Example Usage

 #define X X 

RED_PIN

Description
Description goes here.

Valid Values
Valid values here

Example Usage

 #define X X 

PACKET_SEND_DELAY

Description
Description goes here.

ValidValue

Valid Values
Valid values here

Example Usage

 #define X X 

LED_BRIGHTNESSREFRESH_RATE

Description
Description goes here.

ValidValue

Valid Values
Valid values here

Example Usage

 #define X X 

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
Description goes here.

Valid Values
Valid values here

Example Usage

 #define X X 

RF_WRAPPER

Description
Description goes here.

Valid Values
Valid values here

Example Usage

 #define X X