Skip to content
Snippets Groups Projects
Commit ce166e6b authored by Mike Causer's avatar Mike Causer Committed by Paul Sokolovsky
Browse files

docs: Spelling mistakes

parent 3eb532e9
Branches
No related tags found
No related merge requests found
Showing
with 34 additions and 34 deletions
...@@ -35,6 +35,6 @@ This can be achieved with: ...@@ -35,6 +35,6 @@ This can be achieved with:
make MICROPY_PORT=<port_name> latexpdf make MICROPY_PORT=<port_name> latexpdf
but require rather complete install of LaTeX with various extensions. On but require rather complete install of LaTeX with various extensions. On
Debiab/Ubuntu, try (500MB+ download): Debian/Ubuntu, try (500MB+ download):
apt-get install texlive-latex-recommended texlive-latex-extra apt-get install texlive-latex-recommended texlive-latex-extra
...@@ -52,7 +52,7 @@ For your convenience, some of technical specifications are provided below: ...@@ -52,7 +52,7 @@ For your convenience, some of technical specifications are provided below:
external FlashROM, UART, deep sleep wake-up, etc.) external FlashROM, UART, deep sleep wake-up, etc.)
* UART: One RX/TX UART (no hardware handshaking), one TX-only UART. * UART: One RX/TX UART (no hardware handshaking), one TX-only UART.
* SPI: 2 SPI interfaces (one used for FlashROM). * SPI: 2 SPI interfaces (one used for FlashROM).
* I2C: No native extenal I2C (bitbang implementation available on any pins). * I2C: No native external I2C (bitbang implementation available on any pins).
* I2S: 1. * I2S: 1.
* Programming: using BootROM bootloader from UART. Due to external FlashROM * Programming: using BootROM bootloader from UART. Due to external FlashROM
and always-available BootROM bootloader, ESP8266 is not brickable. and always-available BootROM bootloader, ESP8266 is not brickable.
......
...@@ -36,7 +36,7 @@ WebREPL - a prompt over WiFi ...@@ -36,7 +36,7 @@ WebREPL - a prompt over WiFi
WebREPL allows you to use the Python prompt over WiFi, connecting through a WebREPL allows you to use the Python prompt over WiFi, connecting through a
browser. The latest versions of Firefox and Chrome are supported. browser. The latest versions of Firefox and Chrome are supported.
For your convinience, WebREPL client is hosted at For your convenience, WebREPL client is hosted at
`<http://micropython.org/webrepl>`__ . Alternatively, you can install it `<http://micropython.org/webrepl>`__ . Alternatively, you can install it
locally from the the GitHub repository locally from the the GitHub repository
`<https://github.com/micropython/webrepl>`__ . `<https://github.com/micropython/webrepl>`__ .
......
Builtin Functions Builtin Functions
================= =================
All builtin functions are described here. They are alse available via All builtin functions are described here. They are also available via
``builtins`` module. ``builtins`` module.
.. function:: abs() .. function:: abs()
......
...@@ -15,7 +15,7 @@ Functions ...@@ -15,7 +15,7 @@ Functions
Get or set the sleep type. Get or set the sleep type.
If the ``sleep_type`` parameter is provided, sets the sleep type to its If the ``sleep_type`` parameter is provided, sets the sleep type to its
value. If the function is called wihout parameters, returns the current value. If the function is called without parameters, returns the current
sleep type. sleep type.
The possible sleep types are defined as constants: The possible sleep types are defined as constants:
......
...@@ -84,7 +84,7 @@ Methods ...@@ -84,7 +84,7 @@ Methods
- ``None`` - no pull up or down resistor. - ``None`` - no pull up or down resistor.
- ``Pin.PULL_UP`` - pull up resistor enabled. - ``Pin.PULL_UP`` - pull up resistor enabled.
- ``Pin.PULL_DOWN`` - pull down resitor enabled. - ``Pin.PULL_DOWN`` - pull down resistor enabled.
- ``drive`` can be one of: - ``drive`` can be one of:
......
...@@ -39,7 +39,7 @@ Methods ...@@ -39,7 +39,7 @@ Methods
.. method:: RTC.alarm(id, time, /*, repeat=False) .. method:: RTC.alarm(id, time, /*, repeat=False)
Set the RTC alarm. Time might be either a milllisecond value to program the alarm to Set the RTC alarm. Time might be either a millisecond value to program the alarm to
current time + time_in_ms in the future, or a datetimetuple. If the time passed is in current time + time_in_ms in the future, or a datetimetuple. If the time passed is in
milliseconds, repeat can be set to ``True`` to make the alarm periodic. milliseconds, repeat can be set to ``True`` to make the alarm periodic.
......
...@@ -45,7 +45,7 @@ Methods ...@@ -45,7 +45,7 @@ Methods
respectively. respectively.
- ``bits`` is the width of each transfer, accepted values are 8, 16 and 32. - ``bits`` is the width of each transfer, accepted values are 8, 16 and 32.
- ``firstbit`` can be ``SPI.MSB`` only. - ``firstbit`` can be ``SPI.MSB`` only.
- ``pins`` is an optional tupple with the pins to assign to the SPI bus. - ``pins`` is an optional tuple with the pins to assign to the SPI bus.
.. method:: SPI.deinit() .. method:: SPI.deinit()
......
...@@ -104,7 +104,7 @@ Methods ...@@ -104,7 +104,7 @@ Methods
If only a channel identifier passed, then a previously initialized channel If only a channel identifier passed, then a previously initialized channel
object is returned (or ``None`` if there is no previous channel). object is returned (or ``None`` if there is no previous channel).
Othwerwise, a TimerChannel object is initialized and returned. Otherwise, a TimerChannel object is initialized and returned.
The operating mode is is the one configured to the Timer object that was used to The operating mode is is the one configured to the Timer object that was used to
create the channel. create the channel.
...@@ -152,7 +152,7 @@ Methods ...@@ -152,7 +152,7 @@ Methods
.. method:: timerchannel.irq(\*, trigger, priority=1, handler=None) .. method:: timerchannel.irq(\*, trigger, priority=1, handler=None)
The behavior of this callback is heaviliy dependent on the operating The behavior of this callback is heavily dependent on the operating
mode of the timer channel: mode of the timer channel:
- If mode is ``Timer.PERIODIC`` the callback is executed periodically - If mode is ``Timer.PERIODIC`` the callback is executed periodically
......
...@@ -167,7 +167,7 @@ Methods ...@@ -167,7 +167,7 @@ Methods
.. data:: UART.EVEN .. data:: UART.EVEN
.. data:: UART.ODD .. data:: UART.ODD
parity types (anlong with ``None``) parity types (along with ``None``)
.. data:: UART.RX_ANY .. data:: UART.RX_ANY
......
...@@ -57,7 +57,7 @@ Power related functions ...@@ -57,7 +57,7 @@ Power related functions
Gates the clock to the CPU, useful to reduce power consumption at any time during Gates the clock to the CPU, useful to reduce power consumption at any time during
short or long periods. Peripherals continue working and execution resumes as soon short or long periods. Peripherals continue working and execution resumes as soon
as any interrupt is triggered (on many ports this includes system timer as any interrupt is triggered (on many ports this includes system timer
interrupt occuring at regular intervals on the order of millisecond). interrupt occurring at regular intervals on the order of millisecond).
.. function:: sleep() .. function:: sleep()
...@@ -96,7 +96,7 @@ Miscellaneous functions ...@@ -96,7 +96,7 @@ Miscellaneous functions
.. function:: unique_id() .. function:: unique_id()
Returns a byte string with a unique idenifier of a board/SoC. It will vary Returns a byte string with a unique identifier of a board/SoC. It will vary
from a board/SoC instance to another, if underlying hardware allows. Length from a board/SoC instance to another, if underlying hardware allows. Length
varies by hardware (so use substring of a full value if you expect a short varies by hardware (so use substring of a full value if you expect a short
ID). In some MicroPython ports, ID corresponds to the network MAC address. ID). In some MicroPython ports, ID corresponds to the network MAC address.
......
...@@ -237,7 +237,7 @@ For example:: ...@@ -237,7 +237,7 @@ For example::
Get or set the PHY mode. Get or set the PHY mode.
If the ``mode`` parameter is provided, sets the mode to its value. If If the ``mode`` parameter is provided, sets the mode to its value. If
the function is called wihout parameters, returns the current mode. the function is called without parameters, returns the current mode.
The possible modes are defined as constants: The possible modes are defined as constants:
* ``MODE_11B`` -- IEEE 802.11b, * ``MODE_11B`` -- IEEE 802.11b,
...@@ -319,7 +319,7 @@ For example:: ...@@ -319,7 +319,7 @@ For example::
* ``STAT_WRONG_PASSWORD`` -- failed due to incorrect password, * ``STAT_WRONG_PASSWORD`` -- failed due to incorrect password,
* ``STAT_NO_AP_FOUND`` -- failed because no access point replied, * ``STAT_NO_AP_FOUND`` -- failed because no access point replied,
* ``STAT_CONNECT_FAIL`` -- failed due to other problems, * ``STAT_CONNECT_FAIL`` -- failed due to other problems,
* ``STAT_GOT_IP`` -- connection susccessful. * ``STAT_GOT_IP`` -- connection successful.
.. method:: wlan.isconnected() .. method:: wlan.isconnected()
...@@ -329,7 +329,7 @@ For example:: ...@@ -329,7 +329,7 @@ For example::
.. method:: wlan.ifconfig([(ip, subnet, gateway, dns)]) .. method:: wlan.ifconfig([(ip, subnet, gateway, dns)])
Get/set IP-level network interface paremeters: IP address, subnet mask, Get/set IP-level network interface parameters: IP address, subnet mask,
gateway and DNS server. When called with no arguments, this method returns gateway and DNS server. When called with no arguments, this method returns
a 4-tuple with the above information. To set the above values, pass a a 4-tuple with the above information. To set the above values, pass a
4-tuple with the required information. For example:: 4-tuple with the required information. For example::
...@@ -343,8 +343,8 @@ For example:: ...@@ -343,8 +343,8 @@ For example::
with additional parameters beyond standard IP configuration (as dealt with by with additional parameters beyond standard IP configuration (as dealt with by
``wlan.ifconfig()``). These include network-specific and hardware-specific ``wlan.ifconfig()``). These include network-specific and hardware-specific
parameters. For setting parameters, keyword argument syntax should be used, parameters. For setting parameters, keyword argument syntax should be used,
multiple parameters can be set at once. For querying, paremeters name should multiple parameters can be set at once. For querying, parameters name should
be quoted as a string, and only one paramter can be queries at time:: be quoted as a string, and only one parameter can be queries at time::
# Set WiFi access point name (formally known as ESSID) and WiFi channel # Set WiFi access point name (formally known as ESSID) and WiFi channel
ap.config(essid='My AP', channel=11) ap.config(essid='My AP', channel=11)
...@@ -397,7 +397,7 @@ For example:: ...@@ -397,7 +397,7 @@ For example::
.. note:: .. note::
The ``WLAN`` constructor is special in the sense that if no arguments besides the id are given, The ``WLAN`` constructor is special in the sense that if no arguments besides the id are given,
it will return the already exisiting ``WLAN`` instance without re-configuring it. This is it will return the already existing ``WLAN`` instance without re-configuring it. This is
because ``WLAN`` is a system feature of the WiPy. If the already existing instance is not because ``WLAN`` is a system feature of the WiPy. If the already existing instance is not
initialized it will do the same as the other constructors an will initialize it with default initialized it will do the same as the other constructors an will initialize it with default
values. values.
......
...@@ -13,7 +13,7 @@ class ADC -- analog to digital conversion ...@@ -13,7 +13,7 @@ class ADC -- analog to digital conversion
adc = pyb.ADC(pin) # create an analog object from a pin adc = pyb.ADC(pin) # create an analog object from a pin
val = adc.read() # read an analog value val = adc.read() # read an analog value
adc = pyb.ADCAll(resolution) # creale an ADCAll object adc = pyb.ADCAll(resolution) # create an ADCAll object
val = adc.read_channel(channel) # read the given channel val = adc.read_channel(channel) # read the given channel
val = adc.read_core_temp() # read MCU temperature val = adc.read_core_temp() # read MCU temperature
val = adc.read_core_vbat() # read MCU VBAT val = adc.read_core_vbat() # read MCU VBAT
......
...@@ -79,7 +79,7 @@ Methods ...@@ -79,7 +79,7 @@ Methods
.. method:: DAC.triangle(freq) .. method:: DAC.triangle(freq)
Generate a triangle wave. The value on the DAC output changes at Generate a triangle wave. The value on the DAC output changes at
the given frequency, and the frequence of the repeating triangle wave the given frequency, and the frequency of the repeating triangle wave
itself is 2048 times smaller. itself is 2048 times smaller.
.. method:: DAC.write(value) .. method:: DAC.write(value)
......
...@@ -7,7 +7,7 @@ class ExtInt -- configure I/O pins to interrupt on external events ...@@ -7,7 +7,7 @@ class ExtInt -- configure I/O pins to interrupt on external events
There are a total of 22 interrupt lines. 16 of these can come from GPIO pins There are a total of 22 interrupt lines. 16 of these can come from GPIO pins
and the remaining 6 are from internal sources. and the remaining 6 are from internal sources.
For lines 0 thru 15, a given line can map to the corresponding line from an For lines 0 through 15, a given line can map to the corresponding line from an
arbitrary port. So line 0 can map to Px0 where x is A, B, C, ... and arbitrary port. So line 0 can map to Px0 where x is A, B, C, ... and
line 1 can map to Px1 where x is A, B, C, ... :: line 1 can map to Px1 where x is A, B, C, ... ::
...@@ -27,7 +27,7 @@ explanation, along with various techniques for debouncing. ...@@ -27,7 +27,7 @@ explanation, along with various techniques for debouncing.
Trying to register 2 callbacks onto the same pin will throw an exception. Trying to register 2 callbacks onto the same pin will throw an exception.
If pin is passed as an integer, then it is assumed to map to one of the If pin is passed as an integer, then it is assumed to map to one of the
internal interrupt sources, and must be in the range 16 thru 22. internal interrupt sources, and must be in the range 16 through 22.
All other pin objects go through the pin mapper to come up with one of the All other pin objects go through the pin mapper to come up with one of the
gpio pins. :: gpio pins. ::
......
...@@ -39,7 +39,7 @@ Printing the i2c object gives you information about its configuration. ...@@ -39,7 +39,7 @@ Printing the i2c object gives you information about its configuration.
You can specify a timeout (in ms):: You can specify a timeout (in ms)::
i2c.send(b'123', timeout=2000) # timout after 2 seconds i2c.send(b'123', timeout=2000) # timeout after 2 seconds
A master must specify the recipient's address:: A master must specify the recipient's address::
......
...@@ -231,7 +231,7 @@ Constants ...@@ -231,7 +231,7 @@ Constants
class PinAF -- Pin Alternate Functions class PinAF -- Pin Alternate Functions
====================================== ======================================
A Pin represents a physical pin on the microcprocessor. Each pin A Pin represents a physical pin on the microprocessor. Each pin
can have a variety of functions (GPIO, I2C SDA, etc). Each PinAF can have a variety of functions (GPIO, I2C SDA, etc). Each PinAF
object represents a particular function for a pin. object represents a particular function for a pin.
...@@ -240,7 +240,7 @@ Constants ...@@ -240,7 +240,7 @@ Constants
x3 = pyb.Pin.board.X3 x3 = pyb.Pin.board.X3
x3_af = x3.af_list() x3_af = x3.af_list()
x3_af will now contain an array of PinAF objects which are availble on x3_af will now contain an array of PinAF objects which are available on
pin X3. pin X3.
For the pyboard, x3_af would contain: For the pyboard, x3_af would contain:
......
...@@ -73,7 +73,7 @@ Methods ...@@ -73,7 +73,7 @@ Methods
value, which is an integer in the range [-511 : 512]. With one value, which is an integer in the range [-511 : 512]. With one
argument it sets the RTC calibration. argument it sets the RTC calibration.
The RTC Smooth Calibration mechanism addjusts the RTC clock rate by The RTC Smooth Calibration mechanism adjusts the RTC clock rate by
adding or subtracting the given number of ticks from the 32768 Hz adding or subtracting the given number of ticks from the 32768 Hz
clock over a 32 second period (corresponding to 2^20 clock ticks.) clock over a 32 second period (corresponding to 2^20 clock ticks.)
Each tick added will speed up the clock by 1 part in 2^20, or 0.954 Each tick added will speed up the clock by 1 part in 2^20, or 0.954
......
...@@ -78,7 +78,7 @@ Methods ...@@ -78,7 +78,7 @@ Methods
Keyword arguments: Keyword arguments:
- ``freq`` --- specifies the periodic frequency of the timer. You migh also - ``freq`` --- specifies the periodic frequency of the timer. You might also
view this as the frequency with which the timer goes through one complete cycle. view this as the frequency with which the timer goes through one complete cycle.
- ``prescaler`` [0-0xffff] - specifies the value to be loaded into the - ``prescaler`` [0-0xffff] - specifies the value to be loaded into the
...@@ -97,7 +97,7 @@ Methods ...@@ -97,7 +97,7 @@ Methods
- ``Timer.UP`` - configures the timer to count from 0 to ARR (default) - ``Timer.UP`` - configures the timer to count from 0 to ARR (default)
- ``Timer.DOWN`` - configures the timer to count from ARR down to 0. - ``Timer.DOWN`` - configures the timer to count from ARR down to 0.
- ``Timer.CENTER`` - confgures the timer to count from 0 to ARR and - ``Timer.CENTER`` - configures the timer to count from 0 to ARR and
then back down to 0. then back down to 0.
- ``div`` can be one of 1, 2, or 4. Divides the timer clock to determine - ``div`` can be one of 1, 2, or 4. Divides the timer clock to determine
...@@ -109,7 +109,7 @@ Methods ...@@ -109,7 +109,7 @@ Methods
transitions on complimentary channels (both channels will be inactive) transitions on complimentary channels (both channels will be inactive)
for this time). ``deadtime`` may be an integer between 0 and 1008, with for this time). ``deadtime`` may be an integer between 0 and 1008, with
the following restrictions: 0-128 in steps of 1. 128-256 in steps of the following restrictions: 0-128 in steps of 1. 128-256 in steps of
2, 256-512 in steps of 8, and 512-1008 in steps of 16. ``deadime`` 2, 256-512 in steps of 8, and 512-1008 in steps of 16. ``deadtime``
measures ticks of ``source_freq`` divided by ``div`` clock ticks. measures ticks of ``source_freq`` divided by ``div`` clock ticks.
``deadtime`` is only available on timers 1 and 8. ``deadtime`` is only available on timers 1 and 8.
...@@ -141,7 +141,7 @@ Methods ...@@ -141,7 +141,7 @@ Methods
If only a channel number is passed, then a previously initialized channel If only a channel number is passed, then a previously initialized channel
object is returned (or ``None`` if there is no previous channel). object is returned (or ``None`` if there is no previous channel).
Othwerwise, a TimerChannel object is initialized and returned. Otherwise, a TimerChannel object is initialized and returned.
Each channel can be configured to perform pwm, output compare, or Each channel can be configured to perform pwm, output compare, or
input capture. All channels share the same underlying timer, which means input capture. All channels share the same underlying timer, which means
...@@ -183,7 +183,7 @@ Methods ...@@ -183,7 +183,7 @@ Methods
- ``polarity`` can be one of: - ``polarity`` can be one of:
- ``Timer.HIGH`` - output is active high - ``Timer.HIGH`` - output is active high
- ``Timer.LOW`` - output is acive low - ``Timer.LOW`` - output is active low
Optional keyword arguments for Timer.IC modes: Optional keyword arguments for Timer.IC modes:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment