docs: Fix spelling in various parts of the docs.
This commit is contained in:
parent
5a8f392f09
commit
a2c4cb484d
@ -77,7 +77,7 @@ The :mod:`network` module::
|
|||||||
wlan.scan() # scan for access points
|
wlan.scan() # scan for access points
|
||||||
wlan.isconnected() # check if the station is connected to an AP
|
wlan.isconnected() # check if the station is connected to an AP
|
||||||
wlan.connect('essid', 'password') # connect to an AP
|
wlan.connect('essid', 'password') # connect to an AP
|
||||||
wlan.config('mac') # get the interface's MAC adddress
|
wlan.config('mac') # get the interface's MAC address
|
||||||
wlan.ifconfig() # get the interface's IP/netmask/gw/DNS addresses
|
wlan.ifconfig() # get the interface's IP/netmask/gw/DNS addresses
|
||||||
|
|
||||||
ap = network.WLAN(network.AP_IF) # create access-point interface
|
ap = network.WLAN(network.AP_IF) # create access-point interface
|
||||||
@ -203,7 +203,7 @@ Use the :ref:`machine.ADC <machine.ADC>` class::
|
|||||||
adc = ADC(Pin(32)) # create ADC object on ADC pin
|
adc = ADC(Pin(32)) # create ADC object on ADC pin
|
||||||
adc.read() # read value, 0-4095 across voltage range 0.0v - 1.0v
|
adc.read() # read value, 0-4095 across voltage range 0.0v - 1.0v
|
||||||
|
|
||||||
adc.atten(ADC.ATTN_11DB) # set 11dB input attentuation (voltage range roughly 0.0v - 3.6v)
|
adc.atten(ADC.ATTN_11DB) # set 11dB input attenuation (voltage range roughly 0.0v - 3.6v)
|
||||||
adc.width(ADC.WIDTH_9BIT) # set 9 bit return values (returned range 0-511)
|
adc.width(ADC.WIDTH_9BIT) # set 9 bit return values (returned range 0-511)
|
||||||
adc.read() # read value using the newly configured attenuation and width
|
adc.read() # read value using the newly configured attenuation and width
|
||||||
|
|
||||||
@ -257,7 +257,7 @@ class::
|
|||||||
spi.init(baudrate=200000) # set the baudrate
|
spi.init(baudrate=200000) # set the baudrate
|
||||||
|
|
||||||
spi.read(10) # read 10 bytes on MISO
|
spi.read(10) # read 10 bytes on MISO
|
||||||
spi.read(10, 0xff) # read 10 bytes while outputing 0xff on MOSI
|
spi.read(10, 0xff) # read 10 bytes while outputting 0xff on MOSI
|
||||||
|
|
||||||
buf = bytearray(50) # create a buffer
|
buf = bytearray(50) # create a buffer
|
||||||
spi.readinto(buf) # read into the given buffer (reads 50 bytes in this case)
|
spi.readinto(buf) # read into the given buffer (reads 50 bytes in this case)
|
||||||
|
@ -140,7 +140,7 @@ The above may also happen after an application terminates and quits to the REPL
|
|||||||
for any reason including an exception. Subsequent arrival of data provokes the
|
for any reason including an exception. Subsequent arrival of data provokes the
|
||||||
failure with the above error message repeatedly issued. So, sockets should be
|
failure with the above error message repeatedly issued. So, sockets should be
|
||||||
closed in any case, regardless whether an application terminates successfully
|
closed in any case, regardless whether an application terminates successfully
|
||||||
or by an exeption, for example using try/finally::
|
or by an exception, for example using try/finally::
|
||||||
|
|
||||||
sock = socket(...)
|
sock = socket(...)
|
||||||
try:
|
try:
|
||||||
|
@ -188,7 +188,7 @@ class::
|
|||||||
spi.init(baudrate=200000) # set the baudrate
|
spi.init(baudrate=200000) # set the baudrate
|
||||||
|
|
||||||
spi.read(10) # read 10 bytes on MISO
|
spi.read(10) # read 10 bytes on MISO
|
||||||
spi.read(10, 0xff) # read 10 bytes while outputing 0xff on MOSI
|
spi.read(10, 0xff) # read 10 bytes while outputting 0xff on MOSI
|
||||||
|
|
||||||
buf = bytearray(50) # create a buffer
|
buf = bytearray(50) # create a buffer
|
||||||
spi.readinto(buf) # read into the given buffer (reads 50 bytes in this case)
|
spi.readinto(buf) # read into the given buffer (reads 50 bytes in this case)
|
||||||
|
@ -68,7 +68,7 @@ parameter should be `id`.
|
|||||||
(password) required to access said service. There can be further
|
(password) required to access said service. There can be further
|
||||||
arbitrary keyword-only parameters, depending on the networking medium
|
arbitrary keyword-only parameters, depending on the networking medium
|
||||||
type and/or particular device. Parameters can be used to: a)
|
type and/or particular device. Parameters can be used to: a)
|
||||||
specify alternative service identifer types; b) provide additional
|
specify alternative service identifier types; b) provide additional
|
||||||
connection parameters. For various medium types, there are different
|
connection parameters. For various medium types, there are different
|
||||||
sets of predefined/recommended parameters, among them:
|
sets of predefined/recommended parameters, among them:
|
||||||
|
|
||||||
|
@ -18,10 +18,10 @@ be implemented:
|
|||||||
* SHA1 - A previous generation algorithm. Not recommended for new usages,
|
* SHA1 - A previous generation algorithm. Not recommended for new usages,
|
||||||
but SHA1 is a part of number of Internet standards and existing
|
but SHA1 is a part of number of Internet standards and existing
|
||||||
applications, so boards targeting network connectivity and
|
applications, so boards targeting network connectivity and
|
||||||
interoperatiability will try to provide this.
|
interoperability will try to provide this.
|
||||||
|
|
||||||
* MD5 - A legacy algorithm, not considered cryptographically secure. Only
|
* MD5 - A legacy algorithm, not considered cryptographically secure. Only
|
||||||
selected boards, targeting interoperatibility with legacy applications,
|
selected boards, targeting interoperability with legacy applications,
|
||||||
will offer this.
|
will offer this.
|
||||||
|
|
||||||
Constructors
|
Constructors
|
||||||
|
@ -94,10 +94,10 @@ Filesystem access
|
|||||||
* ``f_frsize`` -- fragment size
|
* ``f_frsize`` -- fragment size
|
||||||
* ``f_blocks`` -- size of fs in f_frsize units
|
* ``f_blocks`` -- size of fs in f_frsize units
|
||||||
* ``f_bfree`` -- number of free blocks
|
* ``f_bfree`` -- number of free blocks
|
||||||
* ``f_bavail`` -- number of free blocks for unpriviliged users
|
* ``f_bavail`` -- number of free blocks for unprivileged users
|
||||||
* ``f_files`` -- number of inodes
|
* ``f_files`` -- number of inodes
|
||||||
* ``f_ffree`` -- number of free inodes
|
* ``f_ffree`` -- number of free inodes
|
||||||
* ``f_favail`` -- number of free inodes for unpriviliged users
|
* ``f_favail`` -- number of free inodes for unprivileged users
|
||||||
* ``f_flag`` -- mount flags
|
* ``f_flag`` -- mount flags
|
||||||
* ``f_namemax`` -- maximum filename length
|
* ``f_namemax`` -- maximum filename length
|
||||||
|
|
||||||
|
@ -20,7 +20,7 @@ When you save, the red light on the pyboard should turn on for about a second. T
|
|||||||
|
|
||||||
So what does this code do? First we need some terminology. Python is an object-oriented language, almost everything in python is a *class* and when you create an instance of a class you get an *object*. Classes have *methods* associated to them. A method (also called a member function) is used to interact with or control the object.
|
So what does this code do? First we need some terminology. Python is an object-oriented language, almost everything in python is a *class* and when you create an instance of a class you get an *object*. Classes have *methods* associated to them. A method (also called a member function) is used to interact with or control the object.
|
||||||
|
|
||||||
The first line of code creates an LED object which we have then called led. When we create the object, it takes a single parameter which must be between 1 and 4, corresponding to the 4 LEDs on the board. The pyb.LED class has three important member functions that we will use: on(), off() and toggle(). The other function that we use is pyb.delay() this simply waits for a given time in miliseconds. Once we have created the LED object, the statement while True: creates an infinite loop which toggles the led between on and off and waits for 1 second.
|
The first line of code creates an LED object which we have then called led. When we create the object, it takes a single parameter which must be between 1 and 4, corresponding to the 4 LEDs on the board. The pyb.LED class has three important member functions that we will use: on(), off() and toggle(). The other function that we use is pyb.delay() this simply waits for a given time in milliseconds. Once we have created the LED object, the statement while True: creates an infinite loop which toggles the led between on and off and waits for 1 second.
|
||||||
|
|
||||||
**Exercise: Try changing the time between toggling the led and turning on a different LED.**
|
**Exercise: Try changing the time between toggling the led and turning on a different LED.**
|
||||||
|
|
||||||
|
@ -39,7 +39,7 @@ The MicroPython distribution package format is a well-known tar.gz
|
|||||||
format, with some adaptations however. The Gzip compressor, used as
|
format, with some adaptations however. The Gzip compressor, used as
|
||||||
an external wrapper for TAR archives, by default uses 32KB dictionary
|
an external wrapper for TAR archives, by default uses 32KB dictionary
|
||||||
size, which means that to uncompress a compressed stream, 32KB of
|
size, which means that to uncompress a compressed stream, 32KB of
|
||||||
contguous memory needs to be allocated. This requirement may be not
|
contiguous memory needs to be allocated. This requirement may be not
|
||||||
satisfiable on low-memory devices, which may have total memory available
|
satisfiable on low-memory devices, which may have total memory available
|
||||||
less than that amount, and even if not, a contiguous block like that
|
less than that amount, and even if not, a contiguous block like that
|
||||||
may be hard to allocate due to memory fragmentation. To accommodate
|
may be hard to allocate due to memory fragmentation. To accommodate
|
||||||
@ -132,7 +132,7 @@ Installing to a directory image involves using ``-p`` switch to `upip`::
|
|||||||
|
|
||||||
micropython -m upip install -p install_dir micropython-pystone_lowmem
|
micropython -m upip install -p install_dir micropython-pystone_lowmem
|
||||||
|
|
||||||
After this command, the package content (and contents of every depenency
|
After this command, the package content (and contents of every dependency
|
||||||
packages) will be available in the ``install_dir/`` subdirectory. You
|
packages) will be available in the ``install_dir/`` subdirectory. You
|
||||||
would need to transfer contents of this directory (without the
|
would need to transfer contents of this directory (without the
|
||||||
``install_dir/`` prefix) to the device, at the suitable location, where
|
``install_dir/`` prefix) to the device, at the suitable location, where
|
||||||
|
@ -214,7 +214,7 @@ There are certain limitations in the current implementation of the native code e
|
|||||||
* Generators are not supported.
|
* Generators are not supported.
|
||||||
* If ``raise`` is used an argument must be supplied.
|
* If ``raise`` is used an argument must be supplied.
|
||||||
|
|
||||||
The trade-off for the improved performance (roughly twices as fast as bytecode) is an
|
The trade-off for the improved performance (roughly twice as fast as bytecode) is an
|
||||||
increase in compiled code size.
|
increase in compiled code size.
|
||||||
|
|
||||||
The Viper code emitter
|
The Viper code emitter
|
||||||
|
Loading…
x
Reference in New Issue
Block a user