diff options
Diffstat (limited to 'docs/esp8266')
-rw-r--r-- | docs/esp8266/general.rst | 2 | ||||
-rw-r--r-- | docs/esp8266/quickref.rst | 24 | ||||
-rw-r--r-- | docs/esp8266/tutorial/dht.rst | 65 | ||||
-rw-r--r-- | docs/esp8266/tutorial/index.rst | 1 | ||||
-rw-r--r-- | docs/esp8266/tutorial/intro.rst | 68 | ||||
-rw-r--r-- | docs/esp8266/tutorial/repl.rst | 2 |
6 files changed, 156 insertions, 6 deletions
diff --git a/docs/esp8266/general.rst b/docs/esp8266/general.rst index 313e6074c1..3ffb2ff339 100644 --- a/docs/esp8266/general.rst +++ b/docs/esp8266/general.rst @@ -52,7 +52,7 @@ For your convenience, some of technical specifications are provided below: external FlashROM, UART, deep sleep wake-up, etc.) * UART: One RX/TX UART (no hardware handshaking), one TX-only UART. * 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. * Programming: using BootROM bootloader from UART. Due to external FlashROM and always-available BootROM bootloader, ESP8266 is not brickable. diff --git a/docs/esp8266/quickref.rst b/docs/esp8266/quickref.rst index 779248369f..48543dfab6 100644 --- a/docs/esp8266/quickref.rst +++ b/docs/esp8266/quickref.rst @@ -9,6 +9,12 @@ Quick reference for the ESP8266 The Adafruit Feather HUZZAH board (image attribution: Adafruit). +Installing MicroPython +---------------------- + +See the corresponding section of tutorial: :ref:`intro`. It also includes +a troubleshooting subsection. + General board control --------------------- @@ -291,6 +297,24 @@ For low-level driving of an APA102:: import esp esp.apa102_write(clock_pin, data_pin, rgbi_buf) +DHT driver +---------- + +The DHT driver is implemented in software and works on all pins:: + + import dht + import machine + + d = dht.DHT11(machine.Pin(4)) + d.measure() + d.temperature() # eg. 23 (°C) + d.humidity() # eg. 41 (% RH) + + d = dht.DHT22(machine.Pin(4)) + d.measure() + d.temperature() # eg. 23.6 (°C) + d.humidity() # eg. 41.3 (% RH) + WebREPL (web browser interactive prompt) ---------------------------------------- diff --git a/docs/esp8266/tutorial/dht.rst b/docs/esp8266/tutorial/dht.rst new file mode 100644 index 0000000000..1602e8a337 --- /dev/null +++ b/docs/esp8266/tutorial/dht.rst @@ -0,0 +1,65 @@ +Temperature and Humidity +======================== + +DHT (Digital Humidity & Temperature) sensors are low cost digital sensors with +capacitive humidity sensors and thermistors to measure the surrounding air. +They feature a chip that handles analog to digital conversion and provide a +1-wire interface. Newer sensors additionally provide an I2C interface. + +The DHT11 (blue) and DHT22 (white) sensors provide the same 1-wire interface, +however, the DHT22 requires a separate object as it has more complex +calculation. DHT22 have 1 decimal place resolution for both humidity and +temperature readings. DHT11 have whole number for both. + +A custom 1-wire protocol, which is different to Dallas 1-wire, is used to get +the measurements from the sensor. The payload consists of a humidity value, +a temperature value and a checksum. + +To use the 1-wire interface, construct the objects referring to their data pin:: + + >>> import dht + >>> import machine + >>> d = dht.DHT11(machine.Pin(4)) + + >>> import dht + >>> import machine + >>> d = dht.DHT22(machine.Pin(4)) + +Then measure and read their values with:: + + >>> d.measure() + >>> d.temperature() + >>> d.humidity() + +Values returned from ``temperature()`` are in degrees Celsius and values +returned from ``humidity()`` are a percentage of relative humidity. + +The DHT11 can be called no more than once per second and the DHT22 once every +two seconds for most accurate results. Sensor accuracy will degrade over time. +Each sensor supports a different operating range. Refer to the product +datasheets for specifics. + +In 1-wire mode, only three of the four pins are used and in I2C mode, all four +pins are used. Older sensors may still have 4 pins even though they do not +support I2C. The 3rd pin is simply not connected. + +Pin configurations: + +Sensor without I2C in 1-wire mode (eg. DHT11, DHT22, AM2301, AM2302): + + 1=VDD, 2=Data, 3=NC, 4=GND + +Sensor with I2C in 1-wire mode (eg. DHT12, AM2320, AM2321, AM2322): + + 1=VDD, 2=Data, 3=GND, 4=GND + +Sensor with I2C in I2C mode (eg. DHT12, AM2320, AM2321, AM2322): + + 1=VDD, 2=SDA, 3=GND, 4=SCL + +You should use pull-up resistors for the Data, SDA and SCL pins. + +To make newer I2C sensors work in backwards compatible 1-wire mode, you must +connect both pins 3 and 4 to GND. This disables the I2C interface. + +DHT22 sensors are now sold under the name AM2302 and are otherwise identical. diff --git a/docs/esp8266/tutorial/index.rst b/docs/esp8266/tutorial/index.rst index 1a00afd853..39b4592600 100644 --- a/docs/esp8266/tutorial/index.rst +++ b/docs/esp8266/tutorial/index.rst @@ -29,4 +29,5 @@ to `<https://www.python.org>`__. powerctrl.rst onewire.rst neopixel.rst + dht.rst nextsteps.rst diff --git a/docs/esp8266/tutorial/intro.rst b/docs/esp8266/tutorial/intro.rst index a2c5d1838e..8c356b913f 100644 --- a/docs/esp8266/tutorial/intro.rst +++ b/docs/esp8266/tutorial/intro.rst @@ -1,5 +1,7 @@ -Introduction to MicroPython on the ESP8266 -========================================== +.. _intro: + +Getting started with MicroPython on the ESP8266 +=============================================== Using MicroPython is a great way to get the most of your ESP8266 board. And vice versa, the ESP8266 chip is a great platform for using MicroPython. This @@ -74,8 +76,9 @@ PC. You may also need to reduce the baudrate if you get errors when flashing (eg down to 115200). The filename of the firmware should also match the file that you have. -If you have a NodeMCU board, you may need to use the following command to deploy -the firmware (note the "-fm dio" option):: +For some boards with a particular FlashROM configuration (e.g. some variants of +a NodeMCU board) you may need to use the following command to deploy +the firmware (note the ``-fm dio`` option):: esptool.py --port /dev/ttyUSB0 --baud 460800 write_flash --flash_size=8m -fm dio 0 esp8266-2016-05-03-v1.8.bin @@ -100,3 +103,60 @@ be the same everytime, and most likely different for all ESP8266 chips). The password for the WiFi is micropythoN (note the upper-case N). Its IP address will be 192.168.4.1 once you connect to its network. WiFi configuration will be discussed in more detail later in the tutorial. + +Troubleshooting installation problems +------------------------------------- + +If you experience problems during flashing or with running firmware immediately +after it, here are troubleshooting recommendations: + +* Be aware of and try to exclude hardware problems. There are 2 common problems: + bad power source quality and worn-out/defective FlashROM. Speaking of power + source, not just raw amperage is important, but also low ripple and noise/EMI + in general. If you experience issues with self-made or wall-wart style power + supply, try USB power from a computer. Unearthed power supplies are also known + to cause problems as they source of increased EMI (electromagnetic interference) + - at the very least, and may lead to electrical devices breakdown. So, you are + advised to avoid using unearthed power connections when working with ESP8266 + and other boards. In regard to FlashROM hardware problems, there are independent + (not related to MicroPython in any way) reports + `(e.g.) <http://internetofhomethings.com/homethings/?p=538>`_ + that on some ESP8266 modules, FlashROM can be programmed as little as 20 times + before programming errors occur. This is *much* less than 100,000 programming + cycles cited for FlashROM chips of a type used with ESP8266 by reputable + vendors, which points to either production rejects, or second-hand worn-out + flash chips to be used on some (apparently cheap) modules/boards. You may want + to use your best judgement about source, price, documentation, warranty, + post-sales support for the modules/boards you purchase. + +* The flashing instructions above use flashing speed of 460800 baud, which is + good compromise between speed and stability. However, depending on your + module/board, USB-UART convertor, cables, host OS, etc., the above baud + rate may be too high and lead to errors. Try a more common 115200 baud + rate instead in such cases. + +* The ``--flash_size`` option in the commands above is mandatory. Omitting + it will lead to a corrupted firmware. + +* To catch incorrect flash content (e.g. from a defective sector on a chip), + add ``--verify`` switch to the commands above. + +* Additionally, you can check the firmware integrity from a MicroPython REPL + prompt (assuming you were able to flash it and ``--verify`` option doesn't + report errors):: + import esp + esp.check_fw() + If the last output value is True, the firmware is OK. Otherwise, it's + corrupted and need to be reflashed correctly. + +* If you experience any issues with another flashing application (not + esptool.py), try esptool.py, it is a generally accepted flashing + application in the ESP8266 community. + +* If you still experience problems with even flashing the firmware, please + refer to esptool.py project page, https://github.com/themadinventor/esptool + for additional documentation and bug tracker where you can report problems. + +* If you are able to flash firmware, but ``--verify`` option or + ``esp.check_fw()`` return errors even after multiple retries, you + may have a defective FlashROM chip, as explained above. diff --git a/docs/esp8266/tutorial/repl.rst b/docs/esp8266/tutorial/repl.rst index 078f31357c..338e9fdd8f 100644 --- a/docs/esp8266/tutorial/repl.rst +++ b/docs/esp8266/tutorial/repl.rst @@ -36,7 +36,7 @@ WebREPL - a prompt over WiFi WebREPL allows you to use the Python prompt over WiFi, connecting through a 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 locally from the the GitHub repository `<https://github.com/micropython/webrepl>`__ . |