u-blox / easy-connect

Version of easy-connect with the u-blox cellular platforms C027 and C030 added.

Dependents:   HelloMQTT

esp8266-driver/README.md@0:19aa55d66228, 2017-08-10 (annotated)

Committer:
group-ublox
Date:
Thu Aug 10 14:33:05 2017 +0000
Revision:
0:19aa55d66228
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
group-ublox 0:19aa55d66228 1 # The ESP8266 WiFi driver for mbed-os
group-ublox 0:19aa55d66228 2 The mbed OS driver for the ESP8266 WiFi module
group-ublox 0:19aa55d66228 3
group-ublox 0:19aa55d66228 4 ## Firmware version
group-ublox 0:19aa55d66228 5 ESP8266 modules come in different shapes and forms, but most important difference is which firmware version it is programmed with. To make sure that your module has mbed-os compatible firmware follow update guide: https://developer.mbed.org/teams/ESP8266/wiki/Firmware-Update
group-ublox 0:19aa55d66228 6
group-ublox 0:19aa55d66228 7 ## Testing
group-ublox 0:19aa55d66228 8 The ESP8266 library contains the core network tests taken from mbed OS. To run the tests you will need mbed CLI and mbed OS.
group-ublox 0:19aa55d66228 9
group-ublox 0:19aa55d66228 10 First, setup the the esp8266-driver and mbed-os repositories for testing:
group-ublox 0:19aa55d66228 11 ``` bash
group-ublox 0:19aa55d66228 12 # Sets up the ESP8266 for testing
group-ublox 0:19aa55d66228 13 mbed import esp8266-driver
group-ublox 0:19aa55d66228 14 cd esp8266-driver
group-ublox 0:19aa55d66228 15 mbed add mbed-os
group-ublox 0:19aa55d66228 16 ```
group-ublox 0:19aa55d66228 17
group-ublox 0:19aa55d66228 18 Now you should be able to run the network tests with `mbed test`:
group-ublox 0:19aa55d66228 19 ``` bash
group-ublox 0:19aa55d66228 20 # Runs the ESP8266 network tests, requires a wifi access point
group-ublox 0:19aa55d66228 21 mbed test -t <COMPILER HERE> -m <BOARD HERE> -n tests-net* --compile -DMBED_CFG_ESP8266_SSID=<SSID HERE> -DMBED_CFG_ESP8266_PASS=<PASS HERE>
group-ublox 0:19aa55d66228 22 mbed test -t <COMPILER HERE> -m <BOARD HERE> -n tests-net* --run --verbose
group-ublox 0:19aa55d66228 23 ```
group-ublox 0:19aa55d66228 24
group-ublox 0:19aa55d66228 25 There are a couple other options that can be used during testing:
group-ublox 0:19aa55d66228 26 - MBED_CFG_ESP8266_SSID - SSID of the wifi access point to connect to
group-ublox 0:19aa55d66228 27 - MBED_CFG_ESP8266_SSID - Passphrase of the wifi access point to connect to
group-ublox 0:19aa55d66228 28 - MBED_CFG_ESP8266_TX - TX pin for the ESP8266 serial connection (defaults to D1)
group-ublox 0:19aa55d66228 29 - MBED_CFG_ESP8266_RX - TX pin for the ESP8266 serial connection (defaults to D0)
group-ublox 0:19aa55d66228 30 - MBED_CFG_ESP8266_DEBUG - Enabled debug output from the ESP8266
group-ublox 0:19aa55d66228 31
group-ublox 0:19aa55d66228 32 For example, here is how to enabled the debug output from the ESP8266:
group-ublox 0:19aa55d66228 33 ``` bash
group-ublox 0:19aa55d66228 34 # Run the ESP8266 network tests with debug output, requires a wifi access point
group-ublox 0:19aa55d66228 35 mbed test -t <COMPILER HERE> -m <BOARD HERE> -n tests-net* --compile -DMBED_CFG_ESP8266_SSID=<SSID HERE> -DMBED_CFG_ESP8266_PASS=<PASS HERE> -DMBED_CFG_ESP8266_DEBUG=true
group-ublox 0:19aa55d66228 36 mbed test -t <COMPILER HERE> -m <BOARD HERE> -n tests-net* --run --verbose
group-ublox 0:19aa55d66228 37 ```