Difference between revisions of "Chapter 8 - Configuration"
ErnieHorning (talk | contribs) |
(Corrected input protocols) |
||
| Line 152: | Line 152: | ||
* E1.31 (sACN) | * E1.31 (sACN) | ||
* Art-Net | * Art-Net | ||
| − | * | + | * FPP Remote Sync |
| − | |||
[[File:Figure_08-06-01_Protocol_Selection.png|thumb|none|600px|'''Figure 8-6-1 – Protocol Selection''']] | [[File:Figure_08-06-01_Protocol_Selection.png|thumb|none|600px|'''Figure 8-6-1 – Protocol Selection''']] | ||
Latest revision as of 19:04, 22 July 2026
Chapter 8 – Configuration
Version: 0.1 (Draft)
Written for: ESPixelStick Version 4.x
Last Updated: July 2026
Author: Ernest Horning
Research & Technical Editing: ChatGPT
Chapter Summary
Purpose
This chapter explains how to configure ESPixelStick after firmware installation. It introduces the web-based configuration interface, network settings, pixel outputs, protocols, system settings, and methods for saving and verifying configuration changes.
Although individual menu layouts may change between firmware releases, the underlying concepts remain the same.
Prerequisites
- Chapter 2 – Hardware Overview
- Chapter 3 – ESP8266 Hardware Guide
- Chapter 4 – ESP32 Hardware Guide
- Chapter 5 – Firmware Installation
Related Chapters
- Chapter 9 – Pixel Outputs and Wiring
- Appendix A – GPIO Reference Tables
8.1 Introduction
Once firmware has been installed and the controller has joined the local network, nearly all controller operation is managed through the built-in web configuration interface.
The configuration pages allow the user to customize controller behavior without modifying firmware.
Typical configuration tasks include:
- Network settings
- Pixel outputs
- Protocol selection
- GPIO assignments
- Brightness
- System information
Why This Matters
Understanding the configuration interface allows one controller design to be reused for many different projects.
8.2 Accessing the Configuration Interface
After connecting the controller to the local network:
- Determine the controller's IP address.
- Open a web browser.
- Enter the controller's IP address.
- The ESPixelStick configuration page should appear.
Engineering Note
Assigning a DHCP reservation in the router keeps the controller at the same IP address.
This makes future maintenance much easier.
Community Experience
Many users assign meaningful host names based on the prop being controlled.
Examples:
- GarageMatrix
- RoofPixels
- MegaTree
- CandyCane01
Source: DoItYourselfChristmas.com community discussions
8.3 Configuration Pages
The ESPixelStick web interface is organized into logical sections.
Typical configuration areas include:
- Home
- Network
- Outputs
- Effects
- Input
- System
- Diagnostics
Research Note
Individual menu names and layouts may change between firmware releases.
This chapter focuses on concepts rather than specific screen layouts.
8.4 Network Configuration
Network configuration includes:
- Wi-Fi SSID
- Password
- Host name
- IP addressing
- Ethernet (where applicable)
Changes generally require the controller to reconnect to the network.
Why This Matters
Incorrect network settings are among the most common causes of "missing" controllers.
8.5 Pixel Output Configuration
Each output may be configured independently.
Typical settings include:
- GPIO assignment
- Pixel type
- Pixel count
- Color order
- Brightness
- Grouping
- Reversing
- Start channel
Engineering Note
Configure and verify one output before configuring additional outputs.
This simplifies troubleshooting.
8.6 Protocol Configuration
ESPixelStick supports multiple input protocols depending on platform and firmware version.
Examples include:
- DDP
- E1.31 (sACN)
- Art-Net
- FPP Remote Sync
Research Note
Protocol availability varies by firmware build and hardware platform.
8.7 GPIO Configuration
Advanced Mode allows supported GPIO pins to be assigned to controller functions.
Configuration should only use GPIO known to be compatible with the selected hardware.
Refer to Appendix A for verified GPIO assignments.
Why This Matters
Improper GPIO selection may prevent the controller from starting correctly.
8.8 Saving Configuration
Configuration changes remain temporary until saved.
Typical workflow:
Modify Settings
↓
Save Configuration
↓
Controller Reboots
↓
Verify Operation
Engineering Note
Avoid changing several unrelated settings simultaneously.
Making one change at a time greatly simplifies troubleshooting.
8.9 Backup and Restore
Before making major changes:
✔ Save the current configuration.
✔ Record firmware version.
✔ Record controller IP address.
✔ Label the controller if multiple units are in use.
Community Experience
Keeping a spreadsheet of controller names, IP addresses, firmware versions, and prop assignments makes large displays much easier to maintain.
Contributor: Ernest Horning
Source: Practical engineering practice
8.10 Diagnostics
If the controller does not operate as expected:
Verify:
- Firmware version
- Network connection
- Protocol selection
- GPIO assignment
- Pixel count
- Controller reboot
8.11 Engineering Recommendations
✔ Configure one controller completely before cloning additional controllers.
✔ Label controllers.
✔ Document IP addresses.
✔ Keep firmware versions consistent across the display.
✔ Test outputs immediately after configuration.
8.12 Open Research Items
| Status | Item |
|---|---|
| 🟨 | Current menu layout |
| 🟨 | Advanced Mode options |
| 🟨 | Configuration export/import |
| 🟨 | User account features (if added in future releases) |
| 🟨 | Platform-specific configuration differences |
References
This chapter is based upon:
- ESPixelStick project documentation
- ESPixelStick firmware interface
- Espressif networking documentation
- Community experience documented on DoItYourselfChristmas.com
Revision History
| Version | Date | Description |
|---|---|---|
| 0.1 | July 2026 | Initial draft |