Skip to content

Commit c6a03e9

Browse files
committed
Update comments of product template header
1 parent 83e5a51 commit c6a03e9

File tree

1 file changed

+23
-26
lines changed

1 file changed

+23
-26
lines changed

esp8266-fastled-webserver/include/configs/product/product_template.h

Lines changed: 23 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -39,22 +39,31 @@
3939
#define COLOR_ORDER RGB
4040
#endif
4141

42-
// NUM_PIXELS is the number of pixels to be
42+
// NUM_PIXELS is the total number of pixels to be generated / output
4343
#if !defined(NUM_PIXELS)
4444
#define NUM_PIXELS 200
4545
#endif
46+
// AVAILABLE_MILLI_AMPS is based on the power supply. Recommended to use no more than 80% of actual rated maximum.
4647
#if !defined(AVAILABLE_MILLI_AMPS)
4748
#error #define AVAILABLE_MILLI_AMPS x2000x // IMPORTANT: set the max milli-Amps of your power supply (4A = 4000mA)
4849
#endif
50+
51+
// MAX_MILLI_AMPS_PER_PIXEL is used by FastLED to reduce change of exceeding total available milliamps.
4952
#if !defined(MAX_MILLI_AMPS_PER_PIXEL)
5053
#define MAX_MILLI_AMPS_PER_PIXEL 60 // IMPORTANT: set to larger value if necessary
5154
#endif
55+
56+
// FRAMES_PER_SECOND is a frame LIMIT per second. This is approximate.
5257
#if !defined(FRAMES_PER_SECOND)
5358
#define FRAMES_PER_SECOND 120
5459
#endif
60+
61+
// DEFAULT_PATTERN_INDEX allows different products to default to different patterns
5562
#if !defined(DEFAULT_PATTERN_INDEX)
5663
#define DEFAULT_PATTERN_INDEX 0
5764
#endif
65+
66+
// DEFAULT_BRIGHTNESS_INDEX allows different products to default to different brightness (e.g., from brightness[5] array)
5867
#if !defined(DEFAULT_BRIGHTNESS_INDEX)
5968
#define DEFAULT_BRIGHTNESS_INDEX 3
6069
#endif
@@ -134,42 +143,30 @@
134143
// ...
135144
// #define PIXELS_ON_DATA_PIN_n zc
136145
//
137-
// Up to the number of parallel outputs,
138-
// *AND* the board file must support the required number of channels
139-
// by defining the corresponding pins as follows:
146+
// *AND* the controller must support the required number of channels.
147+
//
148+
// The controller header file will define default values for the data pins,
149+
// by defining the following symbols:
140150
//
141151
// #define DATA_PIN w
142152
// #define DATA_PIN_2 x
143153
// #define DATA_PIN_3 y
144154
// ...
145155
// #define DATA_PIN_n z
146156
//
147-
157+
// These can be overridden from the board-default values by defining these
158+
// values in the product header template.
159+
//
160+
// See Fibonacci512 and ESPTHING as examples of multi-channel outputs.
161+
//
148162
#if !defined(PARALLEL_OUTPUT_CHANNELS)
149163
#define PARALLEL_OUTPUT_CHANNELS 1
150164
#endif
151-
// Example from Fibonacci512:
152-
//
153-
// #if !defined(PARALLEL_OUTPUT_CHANNELS)
154-
// #define PARALLEL_OUTPUT_CHANNELS 4
155-
// #endif
156-
// #if !defined(PIXELS_ON_DATA_PIN_1)
157-
// #define PIXELS_ON_DATA_PIN_1 121
158-
// #endif
159-
// #if !defined(PIXELS_ON_DATA_PIN_2)
160-
// #define PIXELS_ON_DATA_PIN_2 120
161-
// #endif
162-
// #if !defined(PIXELS_ON_DATA_PIN_3)
163-
// #define PIXELS_ON_DATA_PIN_3 121
164-
// #endif
165-
// #if !defined(PIXELS_ON_DATA_PIN_4)
166-
// #define PIXELS_ON_DATA_PIN_4 150
167-
// #endif
168-
169-
// By default, no IR support is included. Define ENABLE_IR to enable IR support.
165+
166+
// // By default, no IR support is included. Define ENABLE_IR to enable IR support.
170167
// #define ENABLE_IR
171-
// NOTE: When ENABLE_IR is defined, can also override controller-specific default:
172-
// #define IR_RECV_PIN D99
168+
// // When ENABLE_IR is defined, can also override controller-specific default:
169+
// // #define IR_RECV_PIN D99
173170

174171

175172

0 commit comments

Comments
 (0)