Peng Jing Xuan / Mbed OS mbed_wifi_MQTT_PM25

mbed_wifi_MQTT_PM25

Dependencies:   mbed-os-example-wifi-DISCO_IOTBOARD_MQTT MQTT

README.md@49:d44cac40bf15, 2017-12-20 (annotated)

Committer:
mbed_official
Date:
Wed Dec 20 14:30:03 2017 +0000
Revision:
49:d44cac40bf15
Parent:
44:63be19b7a3db
Child:
55:23a0d1e8270a
Merge branch 'mbed-os-5.7.0-oob'



* mbed-os-5.7.0-oob:

  Updating mbed-os to mbed-os-5.7.0-rc3

  Updating mbed-os to mbed-os-5.7.0-rc2

  Copy edit README.md

  Update README.md

  Updating mbed-os to mbed-os-5.7.0-rc1



.

Commit copied from https://github.com/ARMmbed/mbed-os-example-wifi

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 0:857719181846 1 # mbed-os-example-wifi #
mbed_official 0:857719181846 2
mbed_official 49:d44cac40bf15 3 Wi-Fi example for Mbed OS
mbed_official 0:857719181846 4
mbed_official 49:d44cac40bf15 5 ## Getting started with the Wi-Fi API ##
mbed_official 0:857719181846 6
mbed_official 49:d44cac40bf15 7 This is an example of a Wi-Fi application using the Wi-Fi and network socket APIs that [Mbed OS](https://github.com/ARMmbed/mbed-os) provides.
mbed_official 0:857719181846 8
mbed_official 49:d44cac40bf15 9 The program brings up the Wi-Fi and the underlying network interface and uses it to scan available networks, connects to a network, prints interface and connection details and performs an HTTP operation.
mbed_official 49:d44cac40bf15 10
mbed_official 49:d44cac40bf15 11 For more information about Wi-Fi APIs, please visit the [Mbed OS Wi-Fi](https://os.mbed.com/docs/latest/reference/wi-fi.html) documentation.
mbed_official 0:857719181846 12
mbed_official 0:857719181846 13 ### Supported hardware ###
mbed_official 0:857719181846 14
mbed_official 49:d44cac40bf15 15 * [u-blox Odin board](https://os.mbed.com/platforms/ublox-EVK-ODIN-W2/) built-in Wi-Fi module.
mbed_official 49:d44cac40bf15 16 * [Realtek RTL8195AM](https://os.mbed.com/platforms/REALTEK-RTL8195AM/) built-in Wi-Fi module.
mbed_official 49:d44cac40bf15 17 * [NUCLEO-F401RE](https://os.mbed.com/platforms/ST-Nucleo-F401RE/) with [X-NUCLEO-IDW04A1](http://www.st.com/content/st_com/en/products/ecosystems/stm32-open-development-environment/stm32-nucleo-expansion-boards/stm32-ode-connect-hw/x-nucleo-idw04a1.html) Wi-Fi expansion board using pins D8 and D2 _(of the Arduino connector)_.
mbed_official 49:d44cac40bf15 18 * [NUCLEO-F401RE](https://os.mbed.com/platforms/ST-Nucleo-F401RE/) with [X-NUCLEO-IDW01M1](https://os.mbed.com/components/X-NUCLEO-IDW01M1/) Wi-Fi expansion board using pins PA_9 and PA_10 _(of the Morpho connector)_.
mbed_official 49:d44cac40bf15 19 * [NUCLEO-F429ZI](https://os.mbed.com/platforms/ST-Nucleo-F429ZI/) with ESP8266-01 module using pins D1 and D0.
mbed_official 49:d44cac40bf15 20 * [NUCLEO-L476RG](https://os.mbed.com/platforms/ST-Nucleo-L476RG/) with ESP8266-01 module using pins D8 and D2.
mbed_official 49:d44cac40bf15 21 * Other Mbed targets with an ESP8266 module, [X-NUCLEO-IDW04A1](http://www.st.com/content/st_com/en/products/ecosystems/stm32-open-development-environment/stm32-nucleo-expansion-boards/stm32-ode-connect-hw/x-nucleo-idw04a1.html) or [X-NUCLEO-IDW01M1](https://os.mbed.com/components/X-NUCLEO-IDW01M1/) expansion board.
mbed_official 49:d44cac40bf15 22 *(The Mbed target board the Wi-Fi shield connects to shouldn't have any other network interface, for example Ethernet.)*
mbed_official 0:857719181846 23
mbed_official 49:d44cac40bf15 24 ESP8266 is a fallback option if the build is for unsupported platform.
mbed_official 0:857719181846 25
mbed_official 32:bca3f5f442b3 26 #### Connecting the ESP8266 ####
mbed_official 49:d44cac40bf15 27
mbed_official 27:b3c6dba3b6e9 28 To connect the ESP8266 module to your development board, look at the [ESP8266 Cookbook page](https://developer.mbed.org/users/4180_1/notebook/using-the-esp8266-with-the-mbed-lpc1768/). In general, this means hooking up the ESP8266 TX pin to `D0` and the ESP8266 RX pin to `D1` on your development board.
mbed_official 6:9944c5308062 29
mbed_official 49:d44cac40bf15 30 **Note:** On NUCLEO development boards, pins `D0` and `D1` are used for serial communication with the computer. Use pins `D8` (to ESP8266 TX) and `D2` (to ESP8266 RX) instead.
mbed_official 32:bca3f5f442b3 31
mbed_official 44:63be19b7a3db 32 #### Connecting the X-NUCLEO-IDW0XX1 ####
mbed_official 49:d44cac40bf15 33
mbed_official 49:d44cac40bf15 34 To connect the [X-NUCLEO-IDW04A1](http://www.st.com/content/st_com/en/products/ecosystems/stm32-open-development-environment/stm32-nucleo-expansion-boards/stm32-ode-connect-hw/x-nucleo-idw04a1.html) or [X-NUCLEO-IDW01M1](https://developer.mbed.org/components/X-NUCLEO-IDW01M1/) expansion board to your NUCLEO development board, plug the expansion board on top of the NUCLEO board using the Arduino or Morpho connector.
mbed_official 6:9944c5308062 35
mbed_official 44:63be19b7a3db 36 ## Getting started ##
mbed_official 0:857719181846 37
mbed_official 49:d44cac40bf15 38 1. Import the example.
mbed_official 0:857719181846 39
mbed_official 32:bca3f5f442b3 40 ```
mbed_official 32:bca3f5f442b3 41 mbed import mbed-os-example-wifi
mbed_official 32:bca3f5f442b3 42 cd mbed-os-example-wifi
mbed_official 32:bca3f5f442b3 43 ```
mbed_official 49:d44cac40bf15 44
mbed_official 49:d44cac40bf15 45 2. Configure the Wi-Fi shield to use.
mbed_official 0:857719181846 46
mbed_official 49:d44cac40bf15 47 Edit ```mbed_app.json``` to include the correct Wi-Fi shield, SSID and password:
mbed_official 0:857719181846 48
mbed_official 32:bca3f5f442b3 49 ```
mbed_official 33:12f0df4d51d7 50 "config": {
mbed_official 32:bca3f5f442b3 51 "wifi-shield": {
mbed_official 44:63be19b7a3db 52 "help": "Options are WIFI_ESP8266, WIFI_IDW0XX1",
mbed_official 44:63be19b7a3db 53 "value": "WIFI_ESP8266"
mbed_official 32:bca3f5f442b3 54 },
mbed_official 32:bca3f5f442b3 55 "wifi-ssid": {
mbed_official 32:bca3f5f442b3 56 "help": "WiFi SSID",
mbed_official 32:bca3f5f442b3 57 "value": "\"SSID\""
mbed_official 32:bca3f5f442b3 58 },
mbed_official 32:bca3f5f442b3 59 "wifi-password": {
mbed_official 32:bca3f5f442b3 60 "help": "WiFi Password",
mbed_official 32:bca3f5f442b3 61 "value": "\"Password\""
mbed_official 32:bca3f5f442b3 62 }
mbed_official 32:bca3f5f442b3 63 },
mbed_official 32:bca3f5f442b3 64 ```
mbed_official 0:857719181846 65
mbed_official 49:d44cac40bf15 66 Sample ```mbed_app.json``` files are provided for ESP8266 (```mbed_app_esp8266.json```), X-NUCLEO-IDW04A1 (```mbed_app_idw04a1.json```) and X-NUCLEO-IDW01M1 (```mbed_app_idw01m1```).
mbed_official 44:63be19b7a3db 67
mbed_official 49:d44cac40bf15 68 For built-in Wi-Fi, ignore the value of `wifi-shield`.
mbed_official 33:12f0df4d51d7 69
mbed_official 49:d44cac40bf15 70 3. Compile and generate binary.
mbed_official 0:857719181846 71
mbed_official 32:bca3f5f442b3 72 For example, for `GCC`:
mbed_official 32:bca3f5f442b3 73
mbed_official 32:bca3f5f442b3 74 ```
mbed_official 32:bca3f5f442b3 75 mbed compile -t GCC_ARM -m UBLOX_EVK_ODIN_W2
mbed_official 32:bca3f5f442b3 76 ```
mbed_official 36:aa0b6789bbd2 77
mbed_official 44:63be19b7a3db 78 4. Open a serial console session with the target platform using the following parameters:
mbed_official 49:d44cac40bf15 79
mbed_official 36:aa0b6789bbd2 80 * **Baud rate:** 9600
mbed_official 36:aa0b6789bbd2 81 * **Data bits:** 8
mbed_official 36:aa0b6789bbd2 82 * **Stop bits:** 1
mbed_official 36:aa0b6789bbd2 83 * **Parity:** None
mbed_official 36:aa0b6789bbd2 84
mbed_official 44:63be19b7a3db 85 5. Copy or drag the application `mbed-os-example-wifi.bin` in the folder `mbed-os-example-wifi/BUILD/<TARGET NAME>/<PLATFORM NAME>` onto the target board.
mbed_official 36:aa0b6789bbd2 86
mbed_official 49:d44cac40bf15 87 6. The serial console should display a similar output to below, indicating a successful Wi-Fi connection:
mbed_official 49:d44cac40bf15 88
mbed_official 36:aa0b6789bbd2 89 ```
mbed_official 36:aa0b6789bbd2 90 WiFi example
mbed_official 36:aa0b6789bbd2 91
mbed_official 36:aa0b6789bbd2 92 Scan:
mbed_official 36:aa0b6789bbd2 93 Network: Dave Hot Spot secured: Unknown BSSID: 00:01:02:03:04:05 RSSI: -58 Ch: 1
mbed_official 36:aa0b6789bbd2 94 1 network available.
mbed_official 36:aa0b6789bbd2 95
mbed_official 36:aa0b6789bbd2 96 Connecting...
mbed_official 36:aa0b6789bbd2 97 Success
mbed_official 36:aa0b6789bbd2 98
mbed_official 36:aa0b6789bbd2 99 MAC: 00:01:02:03:04:05
mbed_official 36:aa0b6789bbd2 100 IP: 192.168.0.5
mbed_official 36:aa0b6789bbd2 101 Netmask: 255.255.255.0
mbed_official 36:aa0b6789bbd2 102 Gateway: 192.168.0.1
mbed_official 36:aa0b6789bbd2 103 RSSI: -27
mbed_official 36:aa0b6789bbd2 104
mbed_official 36:aa0b6789bbd2 105 Sending HTTP request to www.arm.com...
mbed_official 36:aa0b6789bbd2 106 sent 38 [GET / HTTP/1.1]
mbed_official 36:aa0b6789bbd2 107 recv 64 [HTTP/1.1 301 Moved Permanently]
mbed_official 36:aa0b6789bbd2 108
mbed_official 36:aa0b6789bbd2 109 Done
mbed_official 36:aa0b6789bbd2 110 ```
mbed_official 0:857719181846 111
mbed_official 49:d44cac40bf15 112 ## Troubleshooting
mbed_official 0:857719181846 113
mbed_official 49:d44cac40bf15 114 If you have problems, you can review the [documentation](https://os.mbed.com/docs/latest/tutorials/debugging.html) for suggestions on what could be wrong and how to fix it.