Chapter 8 - Configuration - Revision history

MartinMueller2003 at 04:04, 26 July 2026

2026-07-26T04:04:33Z

MartinMueller2003 at 04:02, 26 July 2026

2026-07-26T04:02:36Z

MartinMueller2003 at 03:59, 26 July 2026

2026-07-26T03:59:49Z

MartinMueller2003 at 03:58, 26 July 2026

2026-07-26T03:58:11Z

MartinMueller2003: Corrected input protocols

2026-07-23T02:04:46Z

Corrected input protocols

ErnieHorning at 12:07, 18 July 2026

2026-07-18T12:07:31Z

ErnieHorning at 11:00, 18 July 2026

2026-07-18T11:00:49Z

ErnieHorning at 22:40, 17 July 2026

2026-07-17T22:40:17Z

ErnieHorning: Created page with "'''Chapter 8 – Configuration''' '''Version:''' 0.5 (Draft) '''Written for:''' ESPPixelStick Version 4.x '''Last Updated:''' July 2026 '''Author:''' Ernest Horning '''Re..."

2026-07-17T22:25:04Z

Created page with "'''Chapter 8 – Configuration''' '''Version:''' 0.5 (Draft) '''Written for:''' ESPPixelStick Version 4.x '''Last Updated:''' July 2026 '''Author:''' Ernest Horning '''Re..."

New page

'''Chapter 8 – Configuration'''

'''Version:''' 0.5 (Draft)

'''Written for:''' ESPPixelStick Version 4.x

'''Last Updated:''' July 2026

'''Author:''' Ernest Horning

'''Research & Technical Editing:''' ChatGPT

'''Chapter Summary'''

'''Purpose'''

This chapter explains how to configure ESPPixelStick 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

[[File:vertopal_7840a49f0d5c4f6a9c9462e0ebe297f5/media/image1.png|624x349px]]'''Figure 8-1-1 – Configuration Workflow'''

'''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 ESPPixelStick configuration page should appear.

[[File:vertopal_7840a49f0d5c4f6a9c9462e0ebe297f5/media/image3.png|624x349px]]'''Figure 8-2-1 – Accessing the Configuration Interface'''

'''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 ESPPixelStick web interface is organized into logical sections.

Typical configuration areas include:

* Home
* Network
* Outputs
* Effects
* Input
* System
* Diagnostics

[[File:vertopal_7840a49f0d5c4f6a9c9462e0ebe297f5/media/image5.png|624x349px]]'''Figure 8-3-1 – Typical Configuration Layout'''

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

[[File:vertopal_7840a49f0d5c4f6a9c9462e0ebe297f5/media/image7.png|624x349px]]'''Figure 8-5-1 – Pixel Output Configuration'''

'''Engineering Note'''

Configure and verify one output before configuring additional outputs.

This simplifies troubleshooting.

'''8.6 Protocol Configuration'''

ESPPixelStick supports multiple input protocols depending on platform and firmware version.

Examples include:

* DDP
* E1.31 (sACN)
* Art-Net
* DMX
* Renard

[[File:vertopal_7840a49f0d5c4f6a9c9462e0ebe297f5/media/image9.png|624x349px]]'''Figure 8-6-1 – Protocol Selection'''

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

[[File:vertopal_7840a49f0d5c4f6a9c9462e0ebe297f5/media/image11.png|624x349px]]'''Figure 8-8-1 – Saving Configuration'''

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

[[File:vertopal_7840a49f0d5c4f6a9c9462e0ebe297f5/media/image13.png|624x349px]]'''Figure 8-10-1 – Configuration Troubleshooting'''

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

{|
!width="13%"| '''Status'''
!width="86%"| '''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:

* ESPPixelStick project documentation
* ESPPixelStick firmware interface
* Espressif networking documentation
* Community experience documented on DoItYourselfChristmas.com

'''Revision History'''

{|
!width="8%"| '''Version'''
!width="7%"| '''Date'''
!width="83%"| '''Description'''
|-
| 0.1
| July 2026
| Initial draft
|-
| 0.5
| July 2026
| Standardized chapter format with Engineering Notes, Why This Matters, Community Experience, Research Notes, Open Research Items, and SVG figure references.
|}

@@ Line 149: / Line 149: @@
 '''8.6 Protocol Configuration'''
-ESPixelStick supports multiple input protocols depending on platform and firmware version.
+ESPixelStick supports multiple input protocols.
 Examples include:
@@ Line 157: / Line 157: @@
 * Art-Net
 * FPP Remote Sync
 [[File:Figure_08-06-01_Protocol_Selection.png|thumb|none|600px|'''Figure 8-6-1 – Protocol Selection''']]

@@ Line 152: / Line 152: @@
 * E1.31 (sACN)
 * Art-Net
-* DMX
+* FPP Remote Sync
 [[File:Figure_08-06-01_Protocol_Selection.png|thumb|none|600px|'''Figure 8-6-1 – Protocol Selection''']]

@@ Line 134: / Line 134: @@
 * Brightness
 * Grouping
-* Reversing
+* ZigZag
-* Start channel
+* Start / End NUL pixel count
 [[File:Figure_08-05-01_Output_Configuration.png|thumb|none|600px|'''Figure 8-5-1 – Pixel Output Configuration''']]

@@ Line 114: / Line 114: @@
 * IP addressing
 * Ethernet (where applicable)
 Changes generally require the controller to reconnect to the network.

@@ Line 92: / Line 92: @@
 * Outputs
 * Effects
-* Input
+* Inputs
 * System
 * Diagnostics
 [[File:Figure_08-03-01_Configuration_Overview.png|thumb|none|600px|'''Figure 8-3-1 – Typical Configuration Layout''']]

@@ Line 3: / Line 3: @@
 '''Version:''' 0.1 (Draft)
-'''Written for:''' ESPPixelStick Version 4.x
+'''Written for:''' ESPixelStick Version 4.x
 '''Last Updated:''' July 2026
@@ Line 15: / Line 15: @@
 '''Purpose'''
-This chapter explains how to configure ESPPixelStick 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.
+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.
@@ Line 59: / Line 59: @@
 # Open a web browser.
 # Enter the controller's IP address.
-# The ESPPixelStick configuration page should appear.
+# The ESPixelStick configuration page should appear.
 [[File:Figure_08-02-01_Accessing_Web_Interface.png|thumb|none|600px|'''Figure 8-2-1 – Accessing the Configuration Interface''']]
@@ Line 84: / Line 84: @@
 '''8.3 Configuration Pages'''
-The ESPPixelStick web interface is organized into logical sections.
+The ESPixelStick web interface is organized into logical sections.
 Typical configuration areas include:
@@ Line 145: / Line 145: @@
 '''8.6 Protocol Configuration'''
-ESPPixelStick supports multiple input protocols depending on platform and firmware version.
+ESPixelStick supports multiple input protocols depending on platform and firmware version.
 Examples include:
@@ Line 274: / Line 274: @@
 This chapter is based upon:
-* ESPPixelStick project documentation
+* ESPixelStick project documentation
-* ESPPixelStick firmware interface
+* ESPixelStick firmware interface
 * Espressif networking documentation
 * Community experience documented on DoItYourselfChristmas.com

@@ Line 46: / Line 46: @@
 * System information
-[[File:vertopal_7840a49f0d5c4f6a9c9462e0ebe297f5/media/image1.png|624x349px]]'''Figure 8-1-1 – Configuration Workflow'''
+[[File:Figure_08-01-01_Configuration_Workflow.png|thumb|none|600px|'''Figure 8-1-1 – Configuration Workflow''']]
 '''Why This Matters'''
@@ Line 61: / Line 61: @@
 # The ESPPixelStick configuration page should appear.
-[[File:vertopal_7840a49f0d5c4f6a9c9462e0ebe297f5/media/image3.png|624x349px]]'''Figure 8-2-1 – Accessing the Configuration Interface'''
+[[File:Figure_08-02-01_Accessing_Web_Interface.png|thumb|none|600px|'''Figure 8-2-1 – Accessing the Configuration Interface''']]
 '''Engineering Note'''
@@ Line 96: / Line 96: @@
 * Diagnostics
-[[File:vertopal_7840a49f0d5c4f6a9c9462e0ebe297f5/media/image5.png|624x349px]]'''Figure 8-3-1 – Typical Configuration Layout'''
+[[File:Figure_08-03-01_Configuration_Overview.png|thumb|none|600px|'''Figure 8-3-1 – Typical Configuration Layout''']]
 '''Research Note'''
@@ Line 135: / Line 135: @@
 * Start channel
-[[File:vertopal_7840a49f0d5c4f6a9c9462e0ebe297f5/media/image7.png|624x349px]]'''Figure 8-5-1 – Pixel Output Configuration'''
+[[File:Figure_08-05-01_Output_Configuration.png|thumb|none|600px|'''Figure 8-5-1 – Pixel Output Configuration''']]
 '''Engineering Note'''
@@ Line 155: / Line 155: @@
 * Renard
-[[File:vertopal_7840a49f0d5c4f6a9c9462e0ebe297f5/media/image9.png|624x349px]]'''Figure 8-6-1 – Protocol Selection'''
+[[File:Figure_08-06-01_Protocol_Selection.png|thumb|none|600px|'''Figure 8-6-1 – Protocol Selection''']]
 '''Research Note'''
@@ Line 193: / Line 193: @@
 Verify Operation
-[[File:vertopal_7840a49f0d5c4f6a9c9462e0ebe297f5/media/image11.png|624x349px]]'''Figure 8-8-1 – Saving Configuration'''
+[[File:Figure_08-08-01_Save_Configuration.png|thumb|none|600px|'''Figure 8-8-1 – Saving Configuration''']]
 '''Engineering Note'''
@@ Line 234: / Line 234: @@
 * Controller reboot
-[[File:vertopal_7840a49f0d5c4f6a9c9462e0ebe297f5/media/image13.png|624x349px]]'''Figure 8-10-1 – Configuration Troubleshooting'''
+[[File:Figure_08-10-01_Configuration_Troubleshooting.png|thumb|none|600px|'''Figure 8-10-1 – Configuration Troubleshooting''']]
 '''8.11 Engineering Recommendations'''
@@ Line 290: / Line 290: @@
 | Initial draft
 |-
 |}

@@ Line 1: / Line 1: @@
 '''Chapter 8 – Configuration'''
-'''Version:''' 0.5 (Draft)
+'''Version:''' 0.1 (Draft)
 '''Written for:''' ESPPixelStick Version 4.x