From 7ac25f537bb7684be136e0168bbad2a85922b3fc Mon Sep 17 00:00:00 2001 From: Diego Barrios Romero Date: Sat, 17 Nov 2018 14:24:13 +0100 Subject: Improve documentation of values --- src/devices/mode/oneshot.rs | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'src/devices/mode') diff --git a/src/devices/mode/oneshot.rs b/src/devices/mode/oneshot.rs index 9563286..fc4a5ed 100644 --- a/src/devices/mode/oneshot.rs +++ b/src/devices/mode/oneshot.rs @@ -49,6 +49,12 @@ where /// Request that the ADC begin a conversion on the specified channel. /// + /// The output value will be within `[2047..-2048]` for 12-bit devices + /// (`ADS101x`) and within `[32767..-32768]` for 16-bit devices (`ADS111x`). + /// The voltage that these values correspond to must be calculated using + /// the full-scale range selected. + /// See [`FullScaleRange`](enum.FullScaleRange.html). + /// /// Returns `nb::Error::WouldBlock` while a measurement is in progress. /// /// In case a measurement was requested and after is it is finished a -- cgit v1.2.3-54-g00ecf