Not logged in - Login
< back

Configuration Settings

{TOC}

NRF_TYPE

Description

What board are you using to connect your nRF24L01+?

Valid Value 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                                   RF1NRF_TYPE RF1

PIXEL_PROTOCOL

Description
What type of pixels are you trying to control?

Valid Values

  • WS_2811LPD_8806
  • WS_2801
  • GECE
  • SM_16716
  • TM_1809
  • TM_1803
  • UCS_1903
  • LPD_8806WS_2811
  • GECE
  • LPD_6803
  • TODO

Example Usage
#define PIXEL_PROTOCOL 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 2

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_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

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_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 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.



ValidValue - Integer which represents the Universe number to receive data from

TRANSMIT_CHANNEL

Description


ValidValue

IP_ADDRESS

Description


ValidValue

TOC ENTRY

Description


ValidValue

TOC ENTRY

Description


ValidValue

TOC ENTRY

Description


ValidValue

TOC ENTRY

Description


ValidValue

TOC ENTRY

Description


ValidValue

TOC ENTRY

Description


ValidValue

PIXEL_DATA_PIN

Description



Valid Value

PIXEL_CLOCK_PIN

Description


ValidValue

PIXEL_COLOR_ORDER

Description


ValidValue

OVER_THE_AIR_CONFIG_ENABLE

Description


ValidValue

RECEIVER_UNIQUE_ID

Description


ValidValue

LISTEN_CHANNEL

Description


ValidValue

DATA_RATE

Description


ValidValue

HARDCODED_START_CHANNEL

Description


ValidValue

HARDCODED_NUM_PIXELS

Description


ValidValue

PIXEL_TYPE

Description


ValidValue

LED_BRIGHTNESS

Description


ValidValue