Skip to content

Configuration

Jenny edited this page Oct 14, 2019 · 6 revisions

The following options need to be set in the config.h file For more information on recommended pins for different boards, see: Pin Recommendations

Option info example
WIFI_SSID Your WiFi SSID #define WIFI_SSID "myWifi"
WIFI_PASSWORD Your WiFi Password #define WIFI_PASSWORD "yourWiFiPassword"
MQTT_BROKER Your MQTT Broker's IP Address #define MQTT_BROKER "192.168.1.10"
MQTT_PORT Your MQTT port (usually 1883 for unencrypted connection) #define MQTT_PORT 1883
MQTT_USERNAME Your MQTT username `#define MQTT_USERNAME "MQTTuser"
MQTT_PASSWORD Your MQTT password #define MQTT_PASSWORD "MQTTpassword"
DEVICE_NAME The Unique name for this device #define DEVICE_NAME "myPinkyLED1"
LED_TYPE Your LED type WS2812 / WS2811 #define LED_TYPE WS2812
COLOR_ORDER your color order (normally: RGB for WS2811 or GRB for WS2812) #define COLOR_ORDER GRB
NUM_LEDS The number of LEDs you are connecting #define NUM_LEDS 150
DATA_PIN The Pin the LEDs are connected to #define DATA_PIN 23
OTA_PASSWORD the password for remote uploads via the ArduinoIDE #define OTA_PASSWORD "myOTApassword"
USE_DISCOVERY Sets remote discovery for home assistant. Remove if you do not want to use discovery
USE_WHITE_BALANCE_FOR_SPEED Uses Home Assistant's built in White Value slider for animation speed. Remove if you do not want to use the white value slider for animation speed
MQTT_GROUP_TOPIC MQTT group topic of your own choice. Useful for controlling a group of PinkyLEDs with one MQTT command. Remove if not wanted #define MQTT_GROUP_TOPIC "cmnd/outsidePinkyLEDs"
ENABLE_E131 Enables E1.31 Remove if you do not want to use E1.31
UNIVERSE_START The first universe to listen for on E1.31 Remove if not using E1.31 #define UNIVERSE_START 1
POWER_BUTTON_PIN The pin your power button (or rotary encoder push) is connected to (Remove if not using power button) #define POWER_BUTTON_PIN 18
COLOR_BUTTON_PIN The pin your color button (or rotary encoder push) is connected to (Remove if not using color button) #define COLOR_BUTTON_PIN 19
EFFECT_BUTTON_PIN The pin your effect button (or rotary encoder push) is connected to (Remove if not effect power button) #define EFFECT_BUTTON_PIN 21
BRIGHTNESS_ENCODER_DT The pin your Brightness encoder DT is connected to (Remove if not using brightness encoder) #define BRIGHTNESS_ENCODER_DT 25
BRIGHTNESS_ENCODER_CLK The pin your Brightness encoder CLK is connected to (Remove if not using brightness encoder) #define BRIGHTNESS_ENCODER_CLK 26
SPEED_ENCODER_DT The pin your Speed encoder DT is connected to (Remove if not using Speed encoder) #define SPEED_ENCODER_DT 32
SPEED_ENCODER_CLK The pin your Speed encoder CLK is connected to (Remove if not using Speed encoder) #define SPEED_ENCODER_CLK 33
BRIGHTNESS_ENCODER_LESS_STEPS reduces the steps needed for the brightness encoder (remove if encoder is too responsive)
SPEED_ENCODER_LESS_STEPS reduces the steps needed for the speed encoder (remove if encoder is too responsive)
AUDIO_REACTIVE_PIN The analog pin that the analog input from the microphone module is connected to (remove if not using microphone module) #define AUDIO_REACTIVE_PIN A0
AUDIO_HIGH_LEVEL Audio High level sensitivity adjustment (Remove if not using audio input) #define AUDIO_HIGH_LEVEL 50
AUDIO_LOW_LEVEL Audio low level sensitivity adjustment(Remove if not using audio input) #define AUDIO_LOW_LEVEL 0

Note that the sensitivity of the microphone module can be adjusted using the pot on the board. I found it best to adjust so that any sound starts to illuminate the LED2 on the microphone module. The AUDIO_HIGH_LEVEL and AUDIO_LOW_LEVEL are limiting ranges and may be adjusted to suit.

Clone this wiki locally