|
| 1 | +### Introduction to Wi-SUN networking stack |
| 2 | +Initial version of Mbed Wi-SUN networking stack was introduced in Mbed OS release 5.12. |
| 3 | + |
| 4 | +More details about Wi-SUN can be found from [Wi-SUN Alliance site](https://www.wi-sun.org). |
| 5 | + |
| 6 | +#### Why to use Wi-SUN Alliance FAN (Field Area Network) profile |
| 7 | +Wi-SUN FAN is based on open standards from IEEE802, IETF, ANSI/TIA and ETSI. |
| 8 | + |
| 9 | +Wi-SUN FAN operates on license-exempt sub-GHz RF band and is using frequency hopping to lower interference. Therefore Wi-SUN is well suited for outdoor installations and dense urban neighborhoods. |
| 10 | + |
| 11 | +The Mbed Wi-SUN stack is built on IPv6 over Low power Wireless Personal Area Networks (6LoWPAN), which itself builds on IEEE 802.15.4 to offer IP-based networking. Internet Protocol (IP) provides the core mechanism for relaying datagrams across IP networks, and its routing capabilities enable internetworking. |
| 12 | + |
| 13 | +#### Mbed Wi-SUN API |
| 14 | + |
| 15 | +Mbed OS provides the [Mesh C++ API](../apis/mesh-api.html) for building Wi-SUN applications. |
| 16 | + |
| 17 | +- To connect to the Wi-SUN network, use the [Wi-SUN interface API](https://github.com/ARMmbed/mbed-os/blob/master/features/nanostack/mbed-mesh-api/mbed-mesh-api/WisunInterface.h). |
| 18 | +- For the socket communication over the Wi-SUN network, use the [Mbed sockets API](../apis/network-socket.html). |
| 19 | + |
| 20 | +##### Nanostack Wi-SUN API |
| 21 | +Mbed Wi-SUN is implemented in the Nanostack library that provides a set of C API headers with more functionalities. The [nanostack folder](https://github.com/ARMmbed/mbed-os/tree/master/features/nanostack/sal-stack-nanostack/nanostack) has the following header files that can be used with Wi-SUN: |
| 22 | +- `net_interface.h` for initializing, starting and stopping a Wi-SUN interface. |
| 23 | +- `ws_management_api.h` for configuring device behaviour. |
| 24 | +- `ws_bbr_api.h` for Wi-SUN backbone border router application interface. |
| 25 | + |
| 26 | +#### Mbed Wi-SUN examples |
| 27 | +Mbed Wi-SUN network consists of routers and border router(s). Mbed OS provides example applications to build Wi-SUN application. |
| 28 | + |
| 29 | +##### Router |
| 30 | + |
| 31 | +- An example using the [Mesh C++ API](../apis/mesh-api.html) for building a Wi-SUN router device can be found from [mesh minimal example](https://github.com/ARMmbed/mbed-os-example-mesh-minimal). |
| 32 | + |
| 33 | +#####Border router |
| 34 | + |
| 35 | +- An example using the [Nanostack API](https://github.com/ARMmbed/mbed-os/tree/master/features/nanostack/sal-stack-nanostack/nanostack) for building a Wi-SUN border router can be found from [nanostack border router](https://github.com/ARMmbed/nanostack-border-router). |
0 commit comments