mimxrt: Some refinements to the docs.

robert-hh · robert-hh · commit 3a11cfe766e3 · 2021-07-12T11:50:17.000+02:00
- fix spelling errors
- add a subtitle for transferring files
diff --git a/docs/mimxrt/general.rst b/docs/mimxrt/general.rst
@@ -49,7 +49,7 @@ Supported MCUs
 
 Note
     Most of the controllers do not have internal flash memory. Therefore
-    their flash capacity is dependant on an external flash chip!
+    their flash capacity is dependent on an external flash chip!
 
 To make a generic MIMXRT port and support as many boards as possible the
 following design and implementation decision were made:
@@ -91,5 +91,5 @@ For your convenience, a few technical specifications are provided below:
 The lower numbers for UART, SPI and I2C apply to the i.MXRT 101x MCU.
 
 For more information see the i.MXRT datasheets or reference manuals. NXP provides
-excellent software support trough  it's SDK packages.
+excellent software support trough it's SDK packages.
 
diff --git a/docs/mimxrt/quickref.rst b/docs/mimxrt/quickref.rst
@@ -128,7 +128,7 @@ See :ref:`machine.UART <machine.UART>`. ::
     uart1.read(5)         # read up to 5 bytes
 
 The i.MXRT has up to eight hardware UARTs, but not every board exposes all
-TX and RX pins for users. The pin assignment of uarts to pins is fixed.
+TX and RX pins for users. The pin assignment of UARTs to pins is fixed.
 The UARTs are numbered 1..8. The rx/tx pins are assigned according to the
 table below:
 
@@ -147,7 +147,7 @@ MIXMXRT1064-EVK   D0/D1    D7/D6    D8/D9    A1/A0      -        -        -
 ADC (analog to digital conversion)
 ----------------------------------
 
-On the i.MXRT ADC functionality is available on Pins labelled 'Ann'.
+On the i.MXRT ADC functionality is available on Pins labeled 'Ann'.
 
 Use the :ref:`machine.ADC <machine.ADC>` class::
 
@@ -188,7 +188,7 @@ Software SPI (using bit-banging) works on all pins, and is accessed via the
     spi.write_readinto(b'1234', buf) # write to MOSI and read from MISO into the buffer
     spi.write_readinto(buf, buf) # write buf to MOSI and read MISO back into buf
 
-The highest supported baudrate is 500000.
+The highest supported baud rate is 500000.
 
 .. Warning::
    Currently *all* of ``sck``, ``mosi`` and ``miso`` *must* be specified when
@@ -227,8 +227,8 @@ has the same methods as software SPI above::
 Notes:
 
 1. Even if the highest supported baud rate at the moment is 90 Mhz,
-setting a baudrate will not always result in exactly that
-frequency, especially at high baudrates.
+setting a baud rate will not always result in exactly that
+frequency, especially at high baud rates.
 
 2. Sending at 90 MHz is possible, but in the tests receiving
 only worked up to 45 MHz.
@@ -281,7 +281,7 @@ has the same methods as software SPI above::
 
     from machine import I2C
 
-    i2c = I"C(0, 400_000)
+    i2c = I2C(0, 400_000)
     i2c.writeto(0x76, b"Hello World")
 
 Real time clock (RTC)
@@ -296,9 +296,9 @@ See :ref:`machine.RTC <machine.RTC>` ::
     rtc.datetime() # get date and time
     rtc.now() # return date and time in CPython format.
 
-The i.MXRT mcu supports battery backup of the RTC. By connecting a battery of 1.5-3.6V,
+The i.MXRT MCU supports battery backup of the RTC. By connecting a battery of 1.5-3.6V,
 time and date are maintained in the absence of the main power. The current drawn
-from the battery is ~20µA, which is rather high. A CR2032 coin cell would
+from the battery is ~20µA, which is rather high. A CR2032 coin cell will
 last for about one year.
 
 
@@ -366,6 +366,13 @@ The DHT driver is implemented in software and works on all pins::
     d.temperature() # eg. 23.6 (°C)
     d.humidity()    # eg. 41.3 (% RH)
 
+Be sure to have a 4.7k pull-up resistor on the data line. Some
+DHT module have that alreayd on their board.
 
-See the MicroPython forum for other community-supported alternatives
-to transfer files to an i.MXRT board.
+Transferring files
+------------------
+
+Files can be transferred to the i.MXRT for instance with the mpremote
+tool or using an SD card. See the MicroPython forum for other
+community-supported alternatives to transfer files to an i.MXRT board,
+like rshell or Thonny.
diff --git a/docs/mimxrt/tutorial/intro.rst b/docs/mimxrt/tutorial/intro.rst
@@ -16,7 +16,7 @@ Requirements
 The first thing you need is a board with an i.MXRT chip.  The MicroPython
 software supports the i.MXRT chip itself and any board should work.  The main
 characteristic of a board is how the GPIO pins are connected to the outside
-world, and whether it includes a built-in USB-serial convertor to make the
+world, and whether it includes a built-in USB-serial converter to make the
 UART available to your PC.
 
 Names of pins will be given in this tutorial using the chip names (eg GPIO2)
@@ -35,7 +35,7 @@ Getting the firmware
 
 At the moment the MicroPython web site does not offer pre-built packages. So
 you have to build the firmware from the sources, as detailed in the README.md
-files of MicroPyton. The make procedure for the respecitive board will create
+files of MicroPyton. The make procedure for the respective board will create
 the firmware.bin or firmware.hex file.
 
 Once firmware versions are provided by MicroPyhgton, you can download the
@@ -55,25 +55,25 @@ features, there are daily builds.
 Deploying the firmware
 ----------------------
 
-Once you have the MicroPython firmware you need to load it onto your i.MXRT device.
-The exact procedure for these steps is highly dependent on the particular board
-and you will need to refer to its documentation for details.
+Once you have the MicroPython firmware you need to load it onto your
+i.MXRT device. The exact procedure for these steps is highly dependent
+on the particular board and you will need to refer to its documentation
+for details.
 
 For Teensy 4.0 and 4.1 you have to use the built-in loader together with the PC
 loader provided by PJRC. The built-in loader will be activated by pushing the
-button on the board. Then you can uload the firmware with the command:
+button on the board. Then you can upload the firmware with the command:
 
 teensy_loader_cli --mcu=imxrt1062 -v -w firmware.hex
 
-The IMXRT10xx-EVK have a second USB port connectted to a support MCU.
+The IMXRT10xx-EVK have a second USB port connected to a support MCU.
 Connecting that USB port to your PC will register
 a disk drive with the name of the board. Just copy the firmware.bin file to this
 drive. That will start the flashing procedure. You will know that the flash
 was complete, if that drive disappears and reappears.
 If you decided to install the very useful Segger open-SDA firmware on that
-sidekick MCU, then you have to use the debugger software to upload the IMXRT firmware.
-
-
+sidekick MCU, then you have to use the debugger software
+to upload the IMXRT firmware.
 
 Serial prompt
 -------------
