diff options
author | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2014-06-29 21:33:01 +0300 |
---|---|---|
committer | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2014-06-29 21:34:58 +0300 |
commit | 5813efd634a282caea3cca6e8448bda253f21c35 (patch) | |
tree | eb13fb30e842260fcd903b0371a35dba9fe94989 /stmhal | |
parent | bb35f425f9db5896fe31e2213cb819998816ade6 (diff) | |
download | micropython-5813efd634a282caea3cca6e8448bda253f21c35.tar.gz micropython-5813efd634a282caea3cca6e8448bda253f21c35.zip |
stmhal: pyb.adc: Clarify that buffer with elements of any size can be used.
Based on forum post: http://forum.micropython.org/viewtopic.php?f=6&t=193
Diffstat (limited to 'stmhal')
-rw-r--r-- | stmhal/adc.c | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/stmhal/adc.c b/stmhal/adc.c index c2419d543f..817b32ea89 100644 --- a/stmhal/adc.c +++ b/stmhal/adc.c @@ -202,7 +202,9 @@ STATIC mp_obj_t adc_read(mp_obj_t self_in) { STATIC MP_DEFINE_CONST_FUN_OBJ_1(adc_read_obj, adc_read); /// \method read_timed(buf, freq) -/// Read analog values into the given buffer at the given frequency. +/// Read analog values into the given buffer at the given frequency. Buffer +/// can be bytearray or array.array for example. If a buffer with 8-bit elements +/// is used, sample resolution will be reduced to 8 bits. /// /// Example: /// |