Installing and Compiling
Introduction
MoonModules introduces a new naming convention for bin(ary) files which contains configs and presets for used hardware. It also shows the used hardware in the bin name including shield esp flash memory size, audio input.
Naming convention
- WLEDMM_ (to differentiate between WLEDSR and WLEDAC)
- Version used. First 3 numbers are WLEDAC numbering, last is subnumbering within fork e.g. 0.14.0-b27.31
- Hardware config / presets e.g. wemos_shield_esp32_4MB_ICS4343x
- S, M or XL config, use M where possible, XL if needed (Previously _min, _max and _all where used)
Configurations
S:
- USERMOD_AUDIOREACTIVE
- FASTPATH mode, and optimizations for speed
M:
- S, except for FASTPATH mode
- USERMOD_ARTIFX
- USERMOD_ANIMARTRIX ;; CC BY-NC 3.0 licensed effects by Stefan Petrick
- USERMOD_DALLASTEMPERATURE
- USERMOD_FOUR_LINE_DISPLAY USE_ALT_DISPLAY
- USERMOD_ROTARY_ENCODER_UI
- USERMOD_AUTO_SAVE
XL:
- M
- WLED_ENABLE_PIXART
- USERMOD_WEATHER
- USERMOD_MPU6050_IMU
- USERMOD_GAMES
- USERMOD_BATTERY ;; enable Battery usermod
- USERMOD_BATTERY_USE_LIPO ;; use new "decharging curve" for LiPo cells
- USERMOD_BH1750
- USERMOD_ANIMATED_STAIRCASE
- USERMOD_RTC ;; experimental
- ; -D USERMOD_SENSORSTOMQTT ;; experimental ewowi causes error: fatal error: Adafruit_Sensor.h: No such file or directory
- USERMOD_ANALOG_CLOCK
- USERMOD_MULTI_RELAY
- USERMOD_PIRSWITCH
- USERMOD_PWM_FAN
- ; -D USERMOD_PING_PONG_CLOCK //Removed as dots is confusing
- USERMOD_BUZZER
- USERMOD_SN_PHOTORESISTOR
- USERMOD_BME280
- USERMOD_DHT
- USERMOD_VL53L0X_GESTURES
Examples
- WLEDMM_0.14.0-b27.31_esp32_4MB_M.bin (generic, for ESP32)
- WLEDMM_0.14.0-b27.31_wemos_shield_esp32_16MB_M.bin
- WLEDMM_0.14.0-b27.31_wemos_shield_esp32_4MB_ICS4343x_M.bin
- WLEDMM_0.14.0-b27.31_wemos_shield_esp32_4MB_LineIn_M.bin
- WLEDMM_0.14.0-b27.31_wemos_shield_esp32_4MB_SPM1423_M.bin
- WLEDMM_0.14.0-b27.31_wemos_shield_esp32_4MB_M.bin
Bin awareness
Binaries can be downloaded or compiled yourself. See below.
When uploading binaries in Manual OTA update , MoonModules support bin awareness: the UI shows which binary is installed and this is a recommendation for the binary to upload (should support the same hardware).
Installing or Compiling
Installing a bin
There are currently 4 locations where bins can be downloaded.
They can be installed using Manual OTA update from within the WLED UI or use Sergs ESP_Flasher to directly upload a bin using USB to a board.
Serg74
https://github.com/srg74/WLED-wemos-shield/tree/master/resources/Firmware/%40MoonModules
Updated frequently with dev versions. Go here for latest features
Wladi
https://wled-install.github.io/
Updated periodically with release and dev versions
wled.me
Releases only
MoonModules release page
https://github.com/MoonModules/WLED/releases
Releases only
Compiling from MS Code / Platform IO
PlatformIO Environments
- Hardware: Choose the right environment depending on Shield, ESP32 flash size and mic type. Name of the environment reflects this e.g. wemos_shield_esp32_4MB_ICS4343x_M
- Bin aware: name of the binary contains fork (WLED, WLEDSR, WLEDMM), version and environment e.g WLEDMM_0.14.0.10_wemos_shield_esp32_4MB_ICS4343x_M.bin. This name is shown in the UI when oploading via OTA
- Build or upload: Build only creates the bin (to be uploaded via OTA or ESPTOOL), upload directly loads it into an USB connected ESP32 board.
- Shield environments: Pins for Shield are already preconfigured
- For developers: See platformio-entries
- In case of brownouts, file system issues etc: erase flash from the PlatformIO Core CLU (find in platformio quick access on the left pane of Code) pio run --target erase
Fork specific info
WLED SR
- Also bin aware
- Bins
Serg74: https://github.com/srg74/WLED-wemos-shield/tree/master/resources/Firmware/%40Atuline. Choose latest version. Or https://wled-install.github.io/. For Wemos Shield choose WLEDSR_0.13.3.4_wemos_shield_esp32_16MB_max.bin or WLEDSR_0.13.3.4_wemos_shield_esp32_4MB_M.bin (Pins pre-configured)
- To do: add microphones
WLED AC
- Not bin aware
- Bins
Serg74 https://github.com/srg74/WLED-wemos-shield/tree/master/resources/Firmware/%40Aircoookie or. Select folder for WLED AC 0.13.3 or 0.14 beta (preferred) or https://wled-install.github.io/
- For Shields choose wemos_shield_esp32 environment (Pins not pre-configured, not available as bin)