diff options
| author | Damien George <damien.p.george@gmail.com> | 2019-09-04 15:05:03 +1000 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2019-09-04 15:05:03 +1000 |
| commit | 8a237237a3889036e1a612237b0e585fa0713a66 (patch) | |
| tree | 3a926cf33f3c18053fd26757ae7dafae4028fd16 | |
| parent | 06661890de479ac1846772567f341f0707b339a7 (diff) | |
docs: Rename machine.ADC docs to machine.ADCWiPy.
To signify that this ADC documentation is specific to the WiPy, and to make
way for a standardised ADC documentation.
| -rw-r--r-- | docs/library/index.rst | 1 | ||||
| -rw-r--r-- | docs/library/machine.ADCWiPy.rst (renamed from docs/library/machine.ADC.rst) | 21 | ||||
| -rw-r--r-- | docs/wipy/quickref.rst | 2 |
3 files changed, 16 insertions, 8 deletions
diff --git a/docs/library/index.rst b/docs/library/index.rst index b464e85fa..4e23e6e01 100644 --- a/docs/library/index.rst +++ b/docs/library/index.rst @@ -136,6 +136,7 @@ The following libraries and classes are specific to the WiPy. :maxdepth: 2 wipy.rst + machine.ADCWiPy.rst machine.TimerWiPy.rst diff --git a/docs/library/machine.ADC.rst b/docs/library/machine.ADCWiPy.rst index 4c7a04d74..4a4f0524c 100644 --- a/docs/library/machine.ADC.rst +++ b/docs/library/machine.ADCWiPy.rst @@ -1,8 +1,15 @@ .. currentmodule:: machine -.. _machine.ADC: +.. _machine.ADCWiPy: -class ADC -- analog to digital conversion -========================================= +class ADCWiPy -- analog to digital conversion +============================================= + +.. note:: + + This class is a non-standard ADC implementation for the WiPy. + It is available simply as ``machine.ADC`` on the WiPy but is named in the + documentation below as ``machine.ADCWiPy`` to distinguish it from the + more general :ref:`machine.ADC <machine.ADC>` class. Usage:: @@ -15,7 +22,7 @@ Usage:: Constructors ------------ -.. class:: ADC(id=0, \*, bits=12) +.. class:: ADCWiPy(id=0, \*, bits=12) Create an ADC object associated with the given pin. This allows you to then read analog values on that pin. @@ -32,7 +39,7 @@ Constructors Methods ------- -.. method:: ADC.channel(id, \*, pin) +.. method:: ADCWiPy.channel(id, \*, pin) Create an analog pin. If only channel ID is given, the correct pin will be selected. Alternatively, only the pin can be passed and the correct @@ -43,11 +50,11 @@ Methods apin = adc.channel(pin='GP3') apin = adc.channel(id=1, pin='GP3') -.. method:: ADC.init() +.. method:: ADCWiPy.init() Enable the ADC block. -.. method:: ADC.deinit() +.. method:: ADCWiPy.deinit() Disable the ADC block. diff --git a/docs/wipy/quickref.rst b/docs/wipy/quickref.rst index 7aa832fd2..6349676cf 100644 --- a/docs/wipy/quickref.rst +++ b/docs/wipy/quickref.rst @@ -82,7 +82,7 @@ See :ref:`machine.Pin <machine.Pin>` and :ref:`machine.Timer <machine.Timer>`. : ADC (analog to digital conversion) ---------------------------------- -See :ref:`machine.ADC <machine.ADC>`. :: +See :ref:`machine.ADCWiPy <machine.ADCWiPy>`. :: from machine import ADC |