87ty78ot7iyu

Dependencies:   HCSR04

Committer:
mbed_official
Date:
Wed Jan 09 14:30:04 2019 +0000
Revision:
91:dab9882e2b49
Parent:
90:1def9d67d6e4
Child:
93:d2ba18c82ce3
Cleanup and simplify the example (#144)


.
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 91:dab9882e2b49 7 This is an example of a Wi-Fi application using the Wi-Fi APIs that [Mbed OS](https://github.com/ARMmbed/mbed-os) provides.
mbed_official 0:857719181846 8
mbed_official 91:dab9882e2b49 9 The program brings up the Wi-Fi and the underlying network interface and uses it to scan available networks, connects to a network and prints interface and connection details.
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 71:a0fbcc153b55 15 * All Mbed OS boards with build-in Wi-Fi module:
mbed_official 71:a0fbcc153b55 16 * [u-blox ODIN-W2](https://os.mbed.com/platforms/ublox-EVK-ODIN-W2/)
mbed_official 71:a0fbcc153b55 17 * [Realtek RTL8195AM](https://os.mbed.com/platforms/REALTEK-RTL8195AM/)
mbed_official 71:a0fbcc153b55 18 * [ST DISCO IOT board](https://os.mbed.com/platforms/ST-Discovery-L475E-IOT01A/) with integrated [ISM43362 WiFi Inventek module](https://github.com/ARMmbed/wifi-ism43362).
mbed_official 71:a0fbcc153b55 19 * [ST DISCO_F413ZH board](https://os.mbed.com/platforms/ST-Discovery-F413H/) with integrated [ISM43362 WiFi Inventek module](https://github.com/ARMmbed/wifi-ism43362).
mbed_official 71:a0fbcc153b55 20 * [Advantech WISE-150](https://os.mbed.com/modules/advantech-wise-1530/)
mbed_official 71:a0fbcc153b55 21 * USI WM-BN-BM-22
mbed_official 71:a0fbcc153b55 22 * MxChip EMW3166
mbed_official 71:a0fbcc153b55 23 * Boards with external WiFi shields.
mbed_official 71:a0fbcc153b55 24 * [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 71:a0fbcc153b55 25 * [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 71:a0fbcc153b55 26 * [NUCLEO-F429ZI](https://os.mbed.com/platforms/ST-Nucleo-F429ZI/) with ESP8266-01 module using pins D1 and D0.
mbed_official 71:a0fbcc153b55 27 * 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 0:857719181846 28
mbed_official 77:b74ac6641a3e 29 #### Adding connectivity driver
mbed_official 77:b74ac6641a3e 30
mbed_official 77:b74ac6641a3e 31 If the target does not have internal WiFi driver, or Mbed OS does not supply one, you need to add driver to your application and configure it to provide default WiFi interface.
mbed_official 77:b74ac6641a3e 32
mbed_official 77:b74ac6641a3e 33 ```
mbed_official 77:b74ac6641a3e 34 mbed add <driver>
mbed_official 77:b74ac6641a3e 35 ```
mbed_official 77:b74ac6641a3e 36
mbed_official 90:1def9d67d6e4 37 For example adding ISM43362 driver `mbed add wifi-ism43362` or X-Nucleo-IDW01M1 driver `mbed add wifi-x-nucleo-idw01m1`
mbed_official 90:1def9d67d6e4 38 The ESP8266 driver is already suplied by Mbed OS.
mbed_official 77:b74ac6641a3e 39
mbed_official 77:b74ac6641a3e 40 Then pin names need to be configured as instructed in the drivers README file.
mbed_official 77:b74ac6641a3e 41
mbed_official 44:63be19b7a3db 42 ## Getting started ##
mbed_official 0:857719181846 43
mbed_official 49:d44cac40bf15 44 1. Import the example.
mbed_official 0:857719181846 45
mbed_official 32:bca3f5f442b3 46 ```
mbed_official 32:bca3f5f442b3 47 mbed import mbed-os-example-wifi
mbed_official 32:bca3f5f442b3 48 cd mbed-os-example-wifi
mbed_official 32:bca3f5f442b3 49 ```
mbed_official 71:a0fbcc153b55 50
mbed_official 82:122bb3ae6de5 51 1. Configure the Wi-Fi shield and settings.
mbed_official 49:d44cac40bf15 52 Edit ```mbed_app.json``` to include the correct Wi-Fi shield, SSID and password:
mbed_official 0:857719181846 53
mbed_official 86:92e4be20dc8b 54 ```json
mbed_official 82:122bb3ae6de5 55 {
mbed_official 82:122bb3ae6de5 56 "config": {
mbed_official 82:122bb3ae6de5 57 "wifi-ssid": {
mbed_official 82:122bb3ae6de5 58 "help": "WiFi SSID",
mbed_official 82:122bb3ae6de5 59 "value": "\"SSID\""
mbed_official 82:122bb3ae6de5 60 },
mbed_official 82:122bb3ae6de5 61 "wifi-password": {
mbed_official 82:122bb3ae6de5 62 "help": "WiFi Password",
mbed_official 82:122bb3ae6de5 63 "value": "\"PASSWORD\""
mbed_official 82:122bb3ae6de5 64 }
mbed_official 82:122bb3ae6de5 65 },
mbed_official 82:122bb3ae6de5 66 "target_overrides": {
mbed_official 82:122bb3ae6de5 67 "*": {
mbed_official 82:122bb3ae6de5 68 "platform.stdio-convert-newlines": true,
mbed_official 82:122bb3ae6de5 69 "esp8266.provide-default" : false
mbed_official 82:122bb3ae6de5 70 }
mbed_official 82:122bb3ae6de5 71 }
mbed_official 82:122bb3ae6de5 72 }
mbed_official 86:92e4be20dc8b 73 ```
mbed_official 0:857719181846 74
mbed_official 82:122bb3ae6de5 75 For build-in WiFi, you do not need to set any `provide-default` values. Those are required
mbed_official 82:122bb3ae6de5 76 if you use external WiFi shield.
mbed_official 82:122bb3ae6de5 77
mbed_official 49:d44cac40bf15 78 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 71:a0fbcc153b55 79
mbed_official 33:12f0df4d51d7 80
mbed_official 71:a0fbcc153b55 81 1. Compile and generate binary.
mbed_official 71:a0fbcc153b55 82 For example, for `GCC`:
mbed_official 71:a0fbcc153b55 83 ```
mbed_official 71:a0fbcc153b55 84 mbed compile -t GCC_ARM -m UBLOX_EVK_ODIN_W2
mbed_official 71:a0fbcc153b55 85 ```
mbed_official 32:bca3f5f442b3 86
mbed_official 71:a0fbcc153b55 87 1. Open a serial console session with the target platform using the following parameters:
mbed_official 36:aa0b6789bbd2 88 * **Baud rate:** 9600
mbed_official 36:aa0b6789bbd2 89 * **Data bits:** 8
mbed_official 36:aa0b6789bbd2 90 * **Stop bits:** 1
mbed_official 36:aa0b6789bbd2 91 * **Parity:** None
mbed_official 71:a0fbcc153b55 92
mbed_official 71:a0fbcc153b55 93 1. 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 94
mbed_official 71:a0fbcc153b55 95 1. The serial console should display a similar output to below, indicating a successful Wi-Fi connection:
mbed_official 71:a0fbcc153b55 96 ```
mbed_official 71:a0fbcc153b55 97 WiFi example
mbed_official 71:a0fbcc153b55 98
mbed_official 71:a0fbcc153b55 99 Scan:
mbed_official 71:a0fbcc153b55 100 Network: Dave Hot Spot secured: Unknown BSSID: 00:01:02:03:04:05 RSSI: -58 Ch: 1
mbed_official 71:a0fbcc153b55 101 1 network available.
mbed_official 36:aa0b6789bbd2 102
mbed_official 71:a0fbcc153b55 103 Connecting...
mbed_official 71:a0fbcc153b55 104 Success
mbed_official 36:aa0b6789bbd2 105
mbed_official 71:a0fbcc153b55 106 MAC: 00:01:02:03:04:05
mbed_official 71:a0fbcc153b55 107 IP: 192.168.0.5
mbed_official 71:a0fbcc153b55 108 Netmask: 255.255.255.0
mbed_official 71:a0fbcc153b55 109 Gateway: 192.168.0.1
mbed_official 71:a0fbcc153b55 110 RSSI: -27
mbed_official 36:aa0b6789bbd2 111
mbed_official 71:a0fbcc153b55 112 Sending HTTP request to www.arm.com...
mbed_official 71:a0fbcc153b55 113 sent 38 [GET / HTTP/1.1]
mbed_official 71:a0fbcc153b55 114 recv 64 [HTTP/1.1 301 Moved Permanently]
mbed_official 36:aa0b6789bbd2 115
mbed_official 71:a0fbcc153b55 116 Done
mbed_official 71:a0fbcc153b55 117 ```
mbed_official 0:857719181846 118
mbed_official 49:d44cac40bf15 119 ## Troubleshooting
mbed_official 0:857719181846 120
mbed_official 49:d44cac40bf15 121 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.
mbed_official 88:20f23913c4a7 122
mbed_official 88:20f23913c4a7 123 ### License and contributions
mbed_official 88:20f23913c4a7 124
mbed_official 88:20f23913c4a7 125 The software is provided under Apache-2.0 license. Contributions to this project are accepted under the same license. Please see contributing.md for more info.
mbed_official 88:20f23913c4a7 126
mbed_official 88:20f23913c4a7 127 This project contains code from other projects. The original license text is included in those source files. They must comply with our license guide.