docs: Add initial draft documentation for the WiPy.

This makes all common files "port-aware" using the .. only directive.

1 files changed, 67 insertions, 28 deletions

diff --git a/docs/library/pyb.ADC.rst b/docs/library/pyb.ADC.rst
index cc0934427f..64848d5779 100644
--- a/docs/library/pyb.ADC.rst
+++ b/docs/library/pyb.ADC.rst
@@ -3,28 +3,55 @@
 class ADC -- analog to digital conversion: read analog values on a pin
 ======================================================================
 
-Usage::
+.. only:: port_pyboard
 
-    import pyb
+    Usage::
+    
+        import pyb
+    
+        adc = pyb.ADC(pin)              # create an analog object from a pin
+        val = adc.read()                # read an analog value
+    
+        adc = pyb.ADCAll(resolution)    # creale an ADCAll object
+        val = adc.read_channel(channel) # read the given channel
+        val = adc.read_core_temp()      # read MCU temperature
+        val = adc.read_core_vbat()      # read MCU VBAT
+        val = adc.read_core_vref()      # read MCU VREF
 
-    adc = pyb.ADC(pin)              # create an analog object from a pin
-    val = adc.read()                # read an analog value
+.. only:: port_wipy
 
-    adc = pyb.ADCAll(resolution)    # creale an ADCAll object
-    val = adc.read_channel(channel) # read the given channel
-    val = adc.read_core_temp()      # read MCU temperature
-    val = adc.read_core_vbat()      # read MCU VBAT
-    val = adc.read_core_vref()      # read MCU VREF
+    Usage::
+    
+       import pyb
 
+       adc = pyb.ADC(channel)          # create an analog object on one of the 4 ADC channels
+       val = adc.read()                # read an analog value
 
 Constructors
 ------------
 
-.. class:: pyb.ADC(pin)
+.. only:: port_pyboard
 
-   Create an ADC object associated with the given pin.
-   This allows you to then read analog values on that pin.
+    .. class:: pyb.ADC(pin)
+    
+       Create an ADC object associated with the given pin.
+       This allows you to then read analog values on that pin.
 
+.. only:: port_wipy
+
+    .. class:: pyb.ADC(channel)
+    
+       Create an ADC object on the given channel. Each channel is associated
+       to a specific pin. For more info check the `pinout and alternate functions
+       table. <https://raw.githubusercontent.com/wipy/wipy/master/docs/PinOUT.png>`_ 
+       This allows you to then read analog values on that pin.
+       
+       .. warning:: 
+       
+          ADC pin input range is 0-1.4V (being 1.8V the absolute maximum that it 
+          can withstand). When GPIO2, GPIO3, GPIO4 or GPIO5 are remapped to the 
+          ADC block, 1.8 V is the maximum. If these pins are used in digital mode, 
+          then the maximum allowed input is 3.6V.
 
 Methods
 -------
@@ -34,19 +61,31 @@ Methods
    Read the value on the analog pin and return it.  The returned value
    will be between 0 and 4095.
 
-.. method:: adc.read_timed(buf, freq)
-
-   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::
-   
-       adc = pyb.ADC(pyb.Pin.board.X19)    # create an ADC on pin X19
-       buf = bytearray(100)                # create a buffer of 100 bytes
-       adc.read_timed(buf, 10)             # read analog values into buf at 10Hz
-                                           #   this will take 10 seconds to finish
-       for val in buf:                     # loop over all values
-           print(val)                      # print the value out
-   
-   This function does not allocate any memory.
+.. only:: port_pyboard
+
+    .. method:: adc.read_timed(buf, freq)
+    
+       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::
+       
+           adc = pyb.ADC(pyb.Pin.board.X19)    # create an ADC on pin X19
+           buf = bytearray(100)                # create a buffer of 100 bytes
+           adc.read_timed(buf, 10)             # read analog values into buf at 10Hz
+                                               #   this will take 10 seconds to finish
+           for val in buf:                     # loop over all values
+               print(val)                      # print the value out
+       
+       This function does not allocate any memory.
+
+.. only:: port_wipy
+
+   .. method:: adc.enable()
+
+      Enable the ADC channel.
+
+   .. method:: adc.disable()
+
+      Disable the ADC channel.