Skip to content

Commit 1e57175

Browse files
JakubVanekdlech
authored andcommitted
sensors: document the EV3 color's REF-RAW mode
More info: simonedegiacomi/EV3-API@20a57f7#r37442226 Signed-off-by: Jakub Vanek <linuxtardis@gmail.com>
1 parent 4cddeee commit 1e57175

1 file changed

Lines changed: 29 additions & 3 deletions

File tree

sensors/ev3_uart_sensor_defs.c

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,9 +86,35 @@ const struct ev3_uart_sensor_info ev3_uart_sensor_defs[] = {
8686
},
8787
[3] = {
8888
/**
89-
* @description: Raw Reflected - sets LED color to red
90-
* @value0: ??? (0 to 1020???)
91-
* @value1: ??? (0 to 1020???)
89+
* .. [#lego-ev3-color-mode3-values] This mode
90+
* provides direct access to the measurements
91+
* done by the ADC inside the sensor. It
92+
* works by continuously flashing the red LED
93+
* on and off and measuring the current
94+
* flowing through a bypass capacitor. It is
95+
* not possible to measure true ambient light
96+
* this way, but the LED off measurement
97+
* works as a reference for the LED on
98+
* measurement. Higher photodiode
99+
* illumination will cause lower ADC
100+
* measurements, so to obtain reflected light
101+
* intensity similar to ``COL-REFLECT``, it
102+
* is necessary to do
103+
* ``reflect = value1 - value0``.
104+
*
105+
* .. [#lego-ev3-color-mode3-value1] While
106+
* this value cannot be used to measure
107+
* still ambient light, it can be used to
108+
* measure *changes* in external
109+
* illumination. When it increases, the
110+
* this value goes below its baseline and
111+
* vice versa.
112+
*
113+
* @description: Raw Reflected Light - sets LED color to red
114+
* @value0: ADC reading for LED on (reflection) (0 to 1023)
115+
* @value0_footnote: [#lego-ev3-color-mode3-values]_
116+
* @value1: ADC reading for LED off (reference) (0 to 1023)
117+
* @value1_footnote: [#lego-ev3-color-mode3-values]_ [#lego-ev3-color-mode3-value1]_
92118
*/
93119
.name = "REF-RAW",
94120
.data_sets = 2,

0 commit comments

Comments
 (0)