Skip to content

Commit e0f35b4

Browse files
author
Amanda Butler
authored
Merge pull request #969 from artokin/wisun_introduction
Add Wi-SUN introduction
2 parents 4c5ddbb + aa40f23 commit e0f35b4

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
#### Wi-SUN
2+
3+
The Wi-SUN Field Area Network (FAN) is based on open standards from IEEE802, IETF, ANSI/TIA and ETSI.
4+
5+
Wi-SUN FAN operates on license-exempt sub-GHz RF band and uses frequency hopping to lower interference. Therefore, Wi-SUN is well suited for outdoor installations and dense urban neighborhoods.
6+
7+
The Mbed OS 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.
8+
9+
You can find more details about Wi-SUN at the [Wi-SUN Alliance site](https://www.wi-sun.org).
10+
11+
#### Mbed Wi-SUN API
12+
13+
Mbed OS provides the [Mesh C++ API](../apis/mesh-api.html) for building Wi-SUN applications.
14+
15+
- 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).
16+
- For the socket communication over the Wi-SUN network, use the [Mbed sockets API](../apis/network-socket.html).
17+
18+
##### Nanostack Wi-SUN API
19+
20+
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:
21+
22+
- `net_interface.h` for initializing, starting and stopping a Wi-SUN interface.
23+
- `ws_management_api.h` for configuring device behavior.
24+
- `ws_bbr_api.h` for Wi-SUN backbone border router application interface.
25+
26+
#### Mbed Wi-SUN examples
27+
28+
Mbed Wi-SUN network consists of routers and border router(s). Mbed OS provides example applications to build Wi-SUN application.
29+
30+
##### Router
31+
32+
You can find an example using the [Mesh C++ API](../apis/mesh-api.html) for building a Wi-SUN router device in the [mesh minimal example](https://github.com/ARMmbed/mbed-os-example-mesh-minimal).
33+
34+
##### Border router
35+
36+
You can find an example using the [Nanostack API](https://github.com/ARMmbed/mbed-os/tree/master/features/nanostack/sal-stack-nanostack/nanostack) to biuld a Wi-SUN border router at [nanostack border router](https://github.com/ARMmbed/nanostack-border-router).

0 commit comments

Comments
 (0)