![](/media/cache/img/default_profile.jpg.50x50_q85.jpg)
1
README.md@0:857719181846, 2016-10-26 (annotated)
- Committer:
- mbed_official
- Date:
- Wed Oct 26 12:00:05 2016 +0100
- Revision:
- 0:857719181846
- Child:
- 6:9944c5308062
Initial commit
Commit copied from https://github.com/ARMmbed/mbed-os-example-wifi
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
mbed_official | 0:857719181846 | 1 | # mbed-os-example-wifi # |
mbed_official | 0:857719181846 | 2 | |
mbed_official | 0:857719181846 | 3 | WiFi example for mbed OS |
mbed_official | 0:857719181846 | 4 | |
mbed_official | 0:857719181846 | 5 | ## Getting started with the WiFi API ## |
mbed_official | 0:857719181846 | 6 | |
mbed_official | 0:857719181846 | 7 | This is a quick example of a simple WiFi application using the WiFi and network-socket APIs that is provided as a part of [mbed-os](github.com/armmbed/mbed-os). |
mbed_official | 0:857719181846 | 8 | |
mbed_official | 0:857719181846 | 9 | The program brings up the WiFi and the underlying network interface, and uses it to scans available networks, connects to a network, prints interface and connection details and performs simple HTTP operation. |
mbed_official | 0:857719181846 | 10 | |
mbed_official | 0:857719181846 | 11 | ### Supported hardware ### |
mbed_official | 0:857719181846 | 12 | |
mbed_official | 0:857719181846 | 13 | * [UBLOX Odin board](https://developer.mbed.org/platforms/ublox-EVK-ODIN-W2/) (`UBLOX_EVK_ODIN_W2` target when using mbed CLI) |
mbed_official | 0:857719181846 | 14 | * Other mbed target with ESP2866 module (Board it's connected to shouldn't have other network interface eg. Ethernet) |
mbed_official | 0:857719181846 | 15 | |
mbed_official | 0:857719181846 | 16 | ESP2866 is a fallback option and will be used if the build is for unsupported platform. |
mbed_official | 0:857719181846 | 17 | |
mbed_official | 0:857719181846 | 18 | ## Getting started |
mbed_official | 0:857719181846 | 19 | |
mbed_official | 0:857719181846 | 20 | 1. Import the example |
mbed_official | 0:857719181846 | 21 | |
mbed_official | 0:857719181846 | 22 | ``` |
mbed_official | 0:857719181846 | 23 | mbed import mbed-os-example-wifi |
mbed_official | 0:857719181846 | 24 | cd mbed-os-example-wifi |
mbed_official | 0:857719181846 | 25 | ``` |
mbed_official | 0:857719181846 | 26 | 2. Configure the WiFi credentials |
mbed_official | 0:857719181846 | 27 | |
mbed_official | 0:857719181846 | 28 | Edit ```mbed_app.json``` to include correct SSID and Password: |
mbed_official | 0:857719181846 | 29 | |
mbed_official | 0:857719181846 | 30 | ``` |
mbed_official | 0:857719181846 | 31 | "config": { |
mbed_official | 0:857719181846 | 32 | "wifi-ssid": { |
mbed_official | 0:857719181846 | 33 | "help": "WiFi SSID", |
mbed_official | 0:857719181846 | 34 | "value": "\"SSID\"" |
mbed_official | 0:857719181846 | 35 | }, |
mbed_official | 0:857719181846 | 36 | "wifi-password": { |
mbed_official | 0:857719181846 | 37 | "help": "WiFi Password", |
mbed_official | 0:857719181846 | 38 | "value": "\"Password\"" |
mbed_official | 0:857719181846 | 39 | } |
mbed_official | 0:857719181846 | 40 | }, |
mbed_official | 0:857719181846 | 41 | ``` |
mbed_official | 0:857719181846 | 42 | |
mbed_official | 0:857719181846 | 43 | 3. Compile and generate binary |
mbed_official | 0:857719181846 | 44 | |
mbed_official | 0:857719181846 | 45 | For example, for `GCC`: |
mbed_official | 0:857719181846 | 46 | |
mbed_official | 0:857719181846 | 47 | ``` |
mbed_official | 0:857719181846 | 48 | mbed compile -t GCC_ARM -m UBLOX_EVK_ODIN_W2 |
mbed_official | 0:857719181846 | 49 | ``` |
mbed_official | 0:857719181846 | 50 | |
mbed_official | 0:857719181846 | 51 | ## Documentation ## |
mbed_official | 0:857719181846 | 52 | |
mbed_official | 0:857719181846 | 53 | More information on the network-socket API can be found in the [mbed handbook](https://docs.mbed.com/docs/mbed-os-api-reference/en/5.2/APIs/communication/network_sockets/). |