diff options
Diffstat (limited to 'docs/library')
| -rw-r--r-- | docs/library/pyb.ADC.rst | 2 | ||||
| -rw-r--r-- | docs/library/pyb.HeartBeat.rst | 8 | ||||
| -rw-r--r-- | docs/library/pyb.Pin.rst | 12 | ||||
| -rw-r--r-- | docs/library/pyb.SD.rst | 2 |
4 files changed, 12 insertions, 12 deletions
diff --git a/docs/library/pyb.ADC.rst b/docs/library/pyb.ADC.rst index 36c376d375..02734e72f9 100644 --- a/docs/library/pyb.ADC.rst +++ b/docs/library/pyb.ADC.rst @@ -49,7 +49,7 @@ Constructors .. 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 + can withstand). When GP2, GP3, GP4 or GP5 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. diff --git a/docs/library/pyb.HeartBeat.rst b/docs/library/pyb.HeartBeat.rst index 971f2e93ec..a50fc8a23e 100644 --- a/docs/library/pyb.HeartBeat.rst +++ b/docs/library/pyb.HeartBeat.rst @@ -5,8 +5,8 @@ class HeartBeat -- heart beat LED The HeartBeat class controls the heart beat led which by default flashes once every 5s. The user can disable the HeartBeat and then -is free to control this LED manually through GPIO25 using the Pin -class. The GPIO25 can also be remapped as a PWM output, an this +is free to control this LED manually through GP25 using the Pin +class. The GP25 can also be remapped as a PWM output, an this can be used to control the light intesity of the heart beat LED. Example usage:: @@ -39,8 +39,8 @@ Methods # disable the heart beat pyb.HeartBeat().disable() - # get the GPIO25 pin object - hbl = pyb.Pin('GPIO25') + # get the GP25 pin object + hbl = pyb.Pin('GP25') # toggle the led hbl.toggle() ... diff --git a/docs/library/pyb.Pin.rst b/docs/library/pyb.Pin.rst index 092af11c7a..00a65126d9 100644 --- a/docs/library/pyb.Pin.rst +++ b/docs/library/pyb.Pin.rst @@ -67,14 +67,14 @@ Usage Model: Board pins are identified by their string name:: - g = pyb.Pin('GPIO9', af=0, mode=pyb.Pin.IN, type=pyb.Pin.STD, strength=pyb.Pin.S2MA) + g = pyb.Pin('GP9', af=0, mode=pyb.Pin.IN, type=pyb.Pin.STD, strength=pyb.Pin.S2MA) You can also configure the Pin to generate interrupts. For instance:: def pincb(pin): print(pin.name()) - pin_int = pyb.Pin('GPIO10', af=0, mode=Pin.IN, type=pyb.Pin.STD_PD, strength=pyb.Pin.S2MA) + pin_int = pyb.Pin('GP10', af=0, mode=Pin.IN, type=pyb.Pin.STD_PD, strength=pyb.Pin.S2MA) pin_int.callback (mode=pyb.Pin.INT_RISING, handler=pincb) # the callback can be triggered manually pin_int.callback()() @@ -288,12 +288,12 @@ Methods board. Please note: - If ``wakes=pyb.Sleep.ACTIVE`` any pin can wake the board. - - If ``wakes=pyb.Sleep.SUSPENDED`` pins ``GPIO2``, ``GPIO4``, ``GPIO10``, - ``GPIO11``, GPIO17`` or ``GPIO24`` can wake the board. Note that only 1 + - If ``wakes=pyb.Sleep.SUSPENDED`` pins ``GP2``, ``GP4``, ``GP10``, + ``GP11``, GP17`` or ``GP24`` can wake the board. Note that only 1 of this pins can be enabled as a wake source at the same time, so, only the last enabled pin as a ``pyb.Sleep.SUSPENDED`` wake source will have effect. - - If ``wakes=pyb.Sleep.SUSPENDED`` pins ``GPIO2``, ``GPIO4``, ``GPIO10``, - ``GPIO11``, ``GPIO17`` and ``GPIO24`` can wake the board. In this case all of the + - If ``wakes=pyb.Sleep.SUSPENDED`` pins ``GP2``, ``GP4``, ``GP10``, + ``GP11``, ``GP17`` and ``GP24`` can wake the board. In this case all of the 6 pins can be enabled as a ``pyb.Sleep.HIBERNATE`` wake source at the same time. - Values can be ORed to make a pin generate interrupts in more than one power mode. diff --git a/docs/library/pyb.SD.rst b/docs/library/pyb.SD.rst index cbdfdfd04a..0746b435bf 100644 --- a/docs/library/pyb.SD.rst +++ b/docs/library/pyb.SD.rst @@ -15,7 +15,7 @@ Example usage:: # data, clk and cmd pins must be passed along with # their respective alternate functions - sd = pyb.SD('GPIO15', 8, 'GPIO10', 6, 'GPIO11', 6) + sd = pyb.SD('GP15', 8, 'GP10', 6, 'GP11', 6) sd.enable() # enable and mount the SD card sd.disable() # disable and unmount it |