mirrors/micropython
1
0
Fork 0
mirror of https://github.com/licsber/micropython.git synced 2024-09-20 00:50:24 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs/samd: Make use of pin names more consistent in examples.

Browse Source 
This keeps up with the changed Pin naming scheme.
This commit is contained in:
robert-hh 2023-02-25 10:51:56 +01:00 committed by Damien George
parent 38243cd8e0
commit 786013d467
2 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/samd/pinout.rst
View File

@ -105,7 +105,7 @@ or other combinations.
SAMD21 SPI assignments SAMD21 SPI assignments
`````````````````````` ``````````````````````
The I2C devices and signals must be chosen according to the following rules: The SPI devices and signals must be chosen according to the following rules:
- The following pad number pairs are suitable for MOSI/SCK: 0/1, 2/3, 3/1, and 0/3. - The following pad number pairs are suitable for MOSI/SCK: 0/1, 2/3, 3/1, and 0/3.
- The MISO signal must be at a Pin with a different pad number than MOSI or SCK. - The MISO signal must be at a Pin with a different pad number than MOSI or SCK.

22
docs/samd/quickref.rst
View File

@ -132,7 +132,7 @@ Use the :ref:`machine.Pin <machine.Pin>` class::
print(p2.value()) # get value, 0 or 1 print(p2.value()) # get value, 0 or 1
p4 = Pin('D4', Pin.IN, Pin.PULL_UP) # enable internal pull-up resistor p4 = Pin('D4', Pin.IN, Pin.PULL_UP) # enable internal pull-up resistor
p7 = Pin("PA07", Pin.OUT, value=1) # set pin high on creation p7 = Pin('PA07', Pin.OUT, value=1) # set pin high on creation
Pins can be denoted by a string or a number. The string is either the Pins can be denoted by a string or a number. The string is either the
pin label of the respective board, like "D0" or "SDA", or in the form pin label of the respective board, like "D0" or "SDA", or in the form
@ -157,7 +157,7 @@ See :ref:`machine.UART <machine.UART>`. ::
# Use UART 3 on a ItsyBitsy M4 board # Use UART 3 on a ItsyBitsy M4 board
from machine import UART from machine import UART
uart3 = UART(3, tx=Pin(1), rx=Pin(0), baudrate=115200) uart3 = UART(3, tx=Pin('D1'), rx=Pin('D0'), baudrate=115200)
uart3.write('hello') # write 5 bytes uart3.write('hello') # write 5 bytes
uart3.read(5) # read up to 5 bytes uart3.read(5) # read up to 5 bytes
@ -243,9 +243,9 @@ Use the :ref:`machine.ADC <machine.ADC>` class::
from machine import ADC from machine import ADC
adc0 = ADC(Pin("A0")) # create ADC object on ADC pin, average=16 adc0 = ADC(Pin('A0')) # create ADC object on ADC pin, average=16
adc0.read_u16() # read value, 0-65536 across voltage range 0.0v - 3.3v adc0.read_u16() # read value, 0-65536 across voltage range 0.0v - 3.3v
adc1 = ADC(Pin("A1"), average=1) # create ADC object on ADC pin, average=1 adc1 = ADC(Pin('A1'), average=1) # create ADC object on ADC pin, average=1
The resolution of the ADC is 12 bit with 12 bit accuracy, irrespective of the The resolution of the ADC is 12 bit with 12 bit accuracy, irrespective of the
value returned by read_u16(). If you need a higher resolution or better accuracy, use value returned by read_u16(). If you need a higher resolution or better accuracy, use
@ -339,7 +339,7 @@ Software SPI (using bit-banging) works on all pins, and is accessed via the
# construct a SoftSPI bus on the given pins # construct a SoftSPI bus on the given pins
# polarity is the idle state of SCK # polarity is the idle state of SCK
# phase=0 means sample on the first edge of SCK, phase=1 means the second # phase=0 means sample on the first edge of SCK, phase=1 means the second
spi = SoftSPI(baudrate=100000, polarity=1, phase=0, sck=Pin(7), mosi=Pin(9), miso=Pin(10)) spi = SoftSPI(baudrate=100000, polarity=1, phase=0, sck=Pin('D7'), mosi=Pin('D9'), miso=Pin('D10'))
spi.init(baudrate=200000) # set the baud rate spi.init(baudrate=200000) # set the baud rate
@ -386,7 +386,7 @@ accessed via the :ref:`machine.SoftI2C <machine.SoftI2C>` class::
from machine import Pin, SoftI2C from machine import Pin, SoftI2C
i2c = SoftI2C(scl=Pin(10), sda=Pin(11), freq=100000) i2c = SoftI2C(scl=Pin('D10'), sda=Pin('D11'), freq=100000)
i2c.scan() # scan for devices i2c.scan() # scan for devices
@ -422,7 +422,7 @@ The OneWire driver is implemented in software and works on all pins::
from machine import Pin from machine import Pin
import onewire import onewire
ow = onewire.OneWire(Pin(12)) # create a OneWire bus on GPIO12 ow = onewire.OneWire(Pin('D12')) # create a OneWire bus on GPIO12
ow.scan() # return a list of devices on the bus ow.scan() # return a list of devices on the bus
ow.reset() # reset the bus ow.reset() # reset the bus
ow.readbyte() # read a byte ow.readbyte() # read a byte
@ -452,12 +452,12 @@ The DHT driver is implemented in software and works on all pins::
import dht import dht
import machine import machine
d = dht.DHT11(machine.Pin(4)) d = dht.DHT11(machine.Pin('D4'))
d.measure() d.measure()
d.temperature() # eg. 23 (°C) d.temperature() # eg. 23 (°C)
d.humidity() # eg. 41 (% RH) d.humidity() # eg. 41 (% RH)
d = dht.DHT22(machine.Pin(4)) d = dht.DHT22(machine.Pin('D4'))
d.measure() d.measure()
d.temperature() # eg. 23.6 (°C) d.temperature() # eg. 23.6 (°C)
d.humidity() # eg. 41.3 (% RH) d.humidity() # eg. 41.3 (% RH)
@ -472,7 +472,7 @@ The APA102 on some Adafruit boards can be controlled using SoftSPI::
from machine import SoftSPI, Pin from machine import SoftSPI, Pin
# create the SPI object. miso can be any unused pin. # create the SPI object. miso can be any unused pin.
spi=SoftSPI(sck=Pin(25), mosi=Pin(26), miso=Pin(14)) spi=SoftSPI(sck=Pin('D25'), mosi=Pin('D26'), miso=Pin('D14'))
# define a little function that writes the data with # define a little function that writes the data with
# preamble and postfix # preamble and postfix
@ -497,7 +497,7 @@ with the Neopixel driver from the MicroPython driver library::
import machine import machine
# 1 LED connected to Pin D8 on Adafruit Feather boards # 1 LED connected to Pin D8 on Adafruit Feather boards
p = machine.Pin(8, machine.Pin.OUT) p = machine.Pin('D8', machine.Pin.OUT)
n = neopixel.NeoPixel(p, 1) n = neopixel.NeoPixel(p, 1)
# set the led to red. # set the led to red.