Differences

This shows you the differences between two versions of the page.

--- uphp:functions:adc_read [2017/03/31 12:38]
jeff
+++ uphp:functions:adc_read [2021/09/13 05:57] (current)
@@ Line 1: / Line 1: @@
 ======adc_read======
 <badge>WMPRO FW >= 1.0</badge> <badge>WMMEGA FW >= 2.0</badge>
@@ Line 5: / Line 6: @@
 ====Description====
-<well size="sm"><html><span style="font-size:125%;color:green">int
-<span style="color:black"></html>[[adc_read]]
+<well size="sm"><html>
-<html>(
+<span style="font-size:125%;color:green">int
+<span style="color:black">adc_read (
 <span style="color:green">int
 <span style="color:blue">$channel
 <span style="color:black">)
 </html></well>
 Return the raw <tooltip title="Analog to Digital Converter">ADC</tooltip> value of a channel
 ====Parameter====
-<html><span style="color:blue"><b>$channel</b><span style="color:black"></html>:  Value between 0 and 2
+<html><b><span style="color:blue">$channel<span style="color:black"></b></html>:  Value between 0 and 2
 Channel 0 is attached to pin <tooltip title="VIN">A1</tooltip>, which is the voltage divider to measure battery voltage and can measure up to 60V DC.
@@ Line 23: / Line 27: @@
 Channel 2 is connected to pin A3, which reads 0-5V DC.
-====Return Value====
+====Return Values====
-<badge>WMPRO</badge> ADC value (10-bit), 0-1023
-<badge>WMMEGA</badge> ADC value (12-bit), 0-4095
+<html><b><span style="color:green">Integer<span style="color:black"></b></html> ADC value:
+<badge>WMPRO</badge> 10-bit, 0-1023
+<badge>WMMEGA</badge> 12-bit, 0-4095
 ====Examples====
-**Example #1** - Read Channel 0 and use the constants v_adc_offset and v_adc_mul to obtain a calibrated voltage((**Example #1** demonstrates a legacy method to obtain a calibrated voltage, which was the primary method in early Wattmon releases, and has not yet been removed from the OS. The calibration constants are loaded automatically into [[uphp:uphp_special_variables|$_GLOBALS]] from the SD Card [[os:config:battery.ini|/config/battery.ini]]. These constants can be calculated and set using Control Panel > Voltage Calibration (Calibrate Voltage Sensor). However, that Control Panel interface does not produce or set calibration constants for Channels 1 and 2, and as mentioned, it stores the constants on the SD Card. This "old method" has been superseded by "a new method" that stores the calibration constants for A1, A2 and A3 in NVRAM. The new calibration method is accessed in Control Panel > Devices. There it is possible to calibrate any device on the Wattmon or attached by ModBus, and the constants are then stored in NVRAM on the device itself, instead of on the SD Card. See [[#Additional Information]] for how to obtain calibrated values using the new method.)):
+===Example #1===
+Read Channel 0 and use the constants v_adc_offset and v_adc_mul to obtain a calibrated voltage((**Example #1** demonstrates a legacy method to obtain a calibrated voltage, which was the primary method in early [[hardware:wattmons|Wattmon]] releases, and has not yet been removed from the OS. The calibration constants are loaded automatically into [[uphp:uphp_special_variables|$_GLOBALS]] from the SD Card [[software:os:config:battery.ini|/config/battery.ini]]. These constants can be calculated and set using Control Panel > Voltage Calibration (Calibrate Voltage Sensor). However, that Control Panel interface does not produce or set calibration constants for Channels 1 and 2, and as mentioned, it stores the constants on the SD Card. This "old method" has been superseded by "a new method" that stores the calibration constants for A1, A2 and A3 in <tooltip title="Non-Volatile RAM">NVRAM</tooltip>. The new calibration method is accessed in Control Panel > Devices. There it is possible to calibrate any device on the [[hardware:wattmons|Wattmon]] or attached by ModBus, and the constants are then stored in <tooltip title="Non-Volatile RAM">NVRAM</tooltip> on the device itself, instead of on the SD Card. See [[#Additional Information]] for how to obtain calibrated values using the new method.)):
 <code php>
@@ Line 51: / Line 61: @@
 ====Additional Information====
-The raw ADC values can be accessed using [[adc_read()]], but it is recommended to use the functions [[mb_get_val_by_role()]] or [[mb_get_dev_by_id()]] in order to obtain calculated values for A1, A2 and A3 that are adjusted by the calibration values stored in //NVRAM//.
-**Example #2** - Use [[mb_get_dev_by_id()]] to obtain calibrated values for A1, A2 and A3:
+The raw ADC values can be accessed using [[adc_read()]], but it is recommended to use the functions [[mb_get_val_by_role()]] or [[mb_get_dev_by_id()]] in order to obtain calculated values for A1, A2 and A3 that are adjusted by the calibration values stored in //<tooltip title="Non-Volatile RAM">NVRAM</tooltip>//.
+===Example #2===
+Use [[mb_get_dev_by_id()]] to obtain calibrated values for A1, A2 and A3:
 <code php>
@@ Line 75: / Line 88: @@
 ====See Also====
 [[uphp:uphp_special_variables]] - Special arrays that are populated automatically (including ''$_GLOBALS'')
-[[floatval()]] - Return the floating point value of a number or string
+[[pin_configure()]] - Configure an <tooltip title="Input/Output">I/O</tooltip> pin as a digital input, output, or analog input [for more information on Channel numbers which are also known as Pin Indexes]
+[[floatval()]] - <html>Return the <b><span style="color:green">float<span style="color:black"></b> value of a <b><span style="color:green">number<span style="color:black"></b> or <b><span style="color:green">string<span style="color:black"></b></html>

Wattmon Documentation Wiki

User Tools

Site Tools

Differences

Page Tools