summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDiego Barrios Romero <eldruin@gmail.com>2019-03-30 12:00:09 +0200
committerDiego Barrios Romero <eldruin@gmail.com>2019-03-31 13:41:26 +0200
commitb226a3605f3b83f88581111723f527aae30fa34c (patch)
tree81089526c0802cec3a7591fd1b86cae8279bd6c1
parent6d954cbf43445b0b55065eb279beee53120d87ce (diff)
downloadads1x1x-async-b226a3605f3b83f88581111723f527aae30fa34c.tar.gz
ads1x1x-async-b226a3605f3b83f88581111723f527aae30fa34c.tar.xz
ads1x1x-async-b226a3605f3b83f88581111723f527aae30fa34c.zip
Improve documentation of changing channel in continuous conversion mode.
-rw-r--r--src/devices/mode/continuous.rs4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/devices/mode/continuous.rs b/src/devices/mode/continuous.rs
index cb4757c..66951dd 100644
--- a/src/devices/mode/continuous.rs
+++ b/src/devices/mode/continuous.rs
@@ -56,6 +56,10 @@ where
CONV: conversion::ConvertMeasurement,
{
/// Select the channel for measurements.
+ ///
+ /// Note that when changing the channel in continuous conversion mode, the
+ /// ongoing conversion will be completed.
+ /// The following conversions will use the new channel configuration.
pub fn select_channel<CH>(&mut self, _channel: &mut CH) -> Result<(), Error<E>>
where
CH: hal::adc::Channel<Ads1x1x<DI, IC, CONV, mode::OneShot>, ID = ChannelSelection>,