mbed-os-examples / Mbed OS nanostack-border-router-mbed5

Nanostack Border Router is a generic mbed border router implementation that provides the 6LoWPAN ND or Thread border router initialization logic.

README.md@85:7f1b82a282d7, 2018-12-20 (annotated)

Committer:
mbed_official
Date:
Thu Dec 20 13:15:35 2018 +0000
Revision:
85:7f1b82a282d7
Parent:
75:ed8b10db9b5a
Child:
90:74901a61be61
Merge pull request #150 from ARMmbed/mbed-os-5.11.0-oob



Mbed OS 5.11.0

.

Commit copied from https://github.com/ARMmbed/nanostack-border-router

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 0:85f4174a8e29 1 # Nanostack Border Router
mbed_official 0:85f4174a8e29 2
mbed_official 0:85f4174a8e29 3 Nanostack Border Router is a generic mbed border router implementation that provides the 6LoWPAN ND or Thread border router initialization logic.
mbed_official 0:85f4174a8e29 4
mbed_official 0:85f4174a8e29 5 Border router is a network gateway between a wireless 6LoWPAN mesh network and a backhaul network. It controls and relays traffic between the two networks. In a typical setup, a 6LoWPAN border router is connected to another router in the backhaul network (over Ethernet or a serial line) which in turn forwards traffic to/from the internet or a private company LAN, for instance.
mbed_official 0:85f4174a8e29 6
mbed_official 0:85f4174a8e29 7 ![](images/br_role.png)
mbed_official 0:85f4174a8e29 8
mbed_official 0:85f4174a8e29 9 ## Structure
mbed_official 0:85f4174a8e29 10
mbed_official 0:85f4174a8e29 11 This application runs on mbed OS and utilizes PHY drivers and Nanostack to form a border router.
mbed_official 0:85f4174a8e29 12
mbed_official 0:85f4174a8e29 13 ![](images/structure.png)
mbed_official 0:85f4174a8e29 14
mbed_official 0:85f4174a8e29 15 The code layout is organized like this:
mbed_official 0:85f4174a8e29 16
mbed_official 0:85f4174a8e29 17 ```
mbed_official 0:85f4174a8e29 18 configs/ Contains example configuration files
mbed_official 0:85f4174a8e29 19 drivers/ Contains PHY drivers
mbed_official 0:85f4174a8e29 20 mbed-os/ Contains mbed OS itself
mbed_official 0:85f4174a8e29 21 source/ Contains the application code
mbed_official 0:85f4174a8e29 22 mbed_app.json Build time configuration file
mbed_official 0:85f4174a8e29 23 ```
mbed_official 0:85f4174a8e29 24
mbed_official 0:85f4174a8e29 25 ## Building
mbed_official 0:85f4174a8e29 26
mbed_official 0:85f4174a8e29 27 1. Clone this repository.
mbed_official 0:85f4174a8e29 28 1. Run `mbed deploy`.
mbed_official 75:ed8b10db9b5a 29 1. Add connectivity driver, if not provided by Mbed OS
mbed_official 0:85f4174a8e29 30 1. Select target platform.
mbed_official 0:85f4174a8e29 31 1. Select toolchain.
mbed_official 0:85f4174a8e29 32 1. Configure.
mbed_official 0:85f4174a8e29 33 1. Build.
mbed_official 0:85f4174a8e29 34
mbed_official 0:85f4174a8e29 35 For example:
mbed_official 0:85f4174a8e29 36
mbed_official 0:85f4174a8e29 37 ```
mbed_official 0:85f4174a8e29 38 $ mbed deploy
mbed_official 0:85f4174a8e29 39
mbed_official 0:85f4174a8e29 40 $ mbed target K64F
mbed_official 0:85f4174a8e29 41 OR
mbed_official 0:85f4174a8e29 42 $ mbed target NUCLEO_F429ZI
mbed_official 0:85f4174a8e29 43
mbed_official 0:85f4174a8e29 44 $ mbed toolchain GCC_ARM
mbed_official 0:85f4174a8e29 45
mbed_official 0:85f4174a8e29 46 $ mbed compile
mbed_official 0:85f4174a8e29 47 ```
mbed_official 0:85f4174a8e29 48
mbed_official 75:ed8b10db9b5a 49 ### Adding connectivity driver
mbed_official 75:ed8b10db9b5a 50
mbed_official 75:ed8b10db9b5a 51 This application requires 802.15.4 RF driver to be provided for the networking stack. Driver can be either external, or provided by the Mbed OS.
mbed_official 75:ed8b10db9b5a 52
mbed_official 75:ed8b10db9b5a 53 External driver can be added by calling
mbed_official 75:ed8b10db9b5a 54
mbed_official 75:ed8b10db9b5a 55 ```
mbed_official 75:ed8b10db9b5a 56 mbed add <driver>
mbed_official 75:ed8b10db9b5a 57 ```
mbed_official 85:7f1b82a282d7 58 For example STM Spirit1 RF driver is added by calling `mbed add stm-spirit1-rf-driver`
mbed_official 75:ed8b10db9b5a 59
mbed_official 0:85f4174a8e29 60 ## Selecting the target platform
mbed_official 0:85f4174a8e29 61
mbed_official 44:261a58f0aba0 62 The target platform is the hardware on which the border router runs. There are number of target platforms already available for you in the mbed OS.
mbed_official 0:85f4174a8e29 63
mbed_official 18:704c4307eb78 64 If you wish to write your own target, follow the instructions in [Adding target support to mbed OS 5](https://docs.mbed.com/docs/mbed-os-handbook/en/latest/advanced/porting_guide/).
mbed_official 0:85f4174a8e29 65
mbed_official 85:7f1b82a282d7 66 The border router requires an RF driver to be provided for Nanostack. Currently, there are the following drivers available in the Mbed OS:
mbed_official 0:85f4174a8e29 67
mbed_official 0:85f4174a8e29 68 * [Atmel AT86RF233](https://github.com/ARMmbed/atmel-rf-driver)
mbed_official 0:85f4174a8e29 69 * [Atmel AT86RF212B](https://github.com/ARMmbed/atmel-rf-driver)
mbed_official 85:7f1b82a282d7 70 * [NXP MCR20A](https://github.com/ARMmbed/mcr20a-rf-driver)
mbed_official 85:7f1b82a282d7 71 * [STM-s2lp](https://github.com/ARMmbed/mbed-os/tree/master/components/802.15.4_RF)
mbed_official 85:7f1b82a282d7 72
mbed_official 85:7f1b82a282d7 73 Following external driver can be added as described [above](#adding-connectivity-driver):
mbed_official 85:7f1b82a282d7 74
mbed_official 0:85f4174a8e29 75 * [STM Spirit1](https://github.com/ARMmbed/stm-spirit1-rf-driver)
mbed_official 0:85f4174a8e29 76
mbed_official 65:92e581c01e8c 77 The backhaul is either SLIP or Ethernet. For Ethernet either an mbed OS "EMAC"
mbed_official 85:7f1b82a282d7 78 driver can be used, or a native Nanostack driver. Currently, native Nanostack drivers exists for the following backhauls:
mbed_official 65:92e581c01e8c 79
mbed_official 65:92e581c01e8c 80 * [K64F Ethernet](https://github.com/ARMmbed/sal-nanostack-driver-k64f-eth)
mbed_official 65:92e581c01e8c 81 * [SLIP driver](https://github.com/ARMmbed/sal-stack-nanostack-slip)
mbed_official 65:92e581c01e8c 82
mbed_official 0:85f4174a8e29 83 The existing drivers are found in the `drivers/` folder. More drivers can be linked in.
mbed_official 0:85f4174a8e29 84
mbed_official 0:85f4174a8e29 85 See [Notes on different hardware](https://github.com/ARMmbed/mbed-os-example-mesh-minimal/blob/master/Hardware.md) to see known combinations that work.
mbed_official 0:85f4174a8e29 86
mbed_official 0:85f4174a8e29 87 ## Configuring Nanostack Border Router
mbed_official 0:85f4174a8e29 88
mbed_official 0:85f4174a8e29 89 Applications using Nanostack Border Router need to use a `.json` file for the configuration. The example configurations can be found in the `configs/` folder.
mbed_official 0:85f4174a8e29 90
mbed_official 0:85f4174a8e29 91 ### The backhaul configuration options
mbed_official 0:85f4174a8e29 92
mbed_official 0:85f4174a8e29 93 | Field | Description |
mbed_official 0:85f4174a8e29 94 |-------------------------------------|---------------------------------------------------------------|
mbed_official 0:85f4174a8e29 95 | `backhaul-dynamic-bootstrap` | Defines whether the manually configured backhaul prefix and default route are used, or whether they are learnt automatically via the IPv6 neighbor discovery. False means static and true means automatic configuration. |
mbed_official 0:85f4174a8e29 96 | `backhaul-prefix` | The IPv6 prefix (64 bits) assigned to and advertised on the backhaul interface. Example format: `fd00:1:2::` |
mbed_official 0:85f4174a8e29 97 | `backhaul-default-route` | The default route (prefix and prefix length) where packets should be forwarded on the backhaul device, default: `::/0`. Example format: `fd00:a1::/10` |
mbed_official 0:85f4174a8e29 98 | `backhaul-next-hop` | The next-hop value for the backhaul default route; should be a link-local address of a neighboring router, default: empty (on-link prefix). Example format: `fe80::1` |
mbed_official 22:8740285d8f09 99 | `backhaul-mld` | Enable sending Multicast Listener Discovery reports to backhaul network when a new multicast listener is registered in mesh network. Values: true or false |
mbed_official 0:85f4174a8e29 100
mbed_official 0:85f4174a8e29 101 ### 6LoWPAN ND border router options
mbed_official 0:85f4174a8e29 102
mbed_official 0:85f4174a8e29 103 | Field | Description |
mbed_official 0:85f4174a8e29 104 |-------------------------------------|---------------------------------------------------------------|
mbed_official 0:85f4174a8e29 105 | `security-mode` | The 6LoWPAN mesh network traffic (link layer) can be protected with the Private Shared Key (PSK) security mode, allowed values: `NONE` and `PSK`. |
mbed_official 0:85f4174a8e29 106 | `psk-key` | A 16-bytes long private shared key to be used when the security mode is PSK. Example format (hexadecimal byte values separated by commas inside brackets): `{0x00, ..., 0x0f}` |
mbed_official 0:85f4174a8e29 107 | `multicast-addr` | Multicast forwarding is supported by default. This defines the multicast address to which the border router application forwards multicast packets (on the backhaul and RF interface). Example format: `ff05::5` |
mbed_official 0:85f4174a8e29 108 |`ra-router-lifetime`|Defines the router advertisement interval in seconds (default 1024 if left out).|
mbed_official 0:85f4174a8e29 109 |`beacon-protocol-id`|Is used to identify beacons. This should not be changed (default 4 if left out).|
mbed_official 0:85f4174a8e29 110
mbed_official 85:7f1b82a282d7 111 To learn more about 6LoWPAN and the configuration parameters, read the [6LoWPAN overview](https://os.mbed.com/docs/latest/reference/mesh-tech.html).
mbed_official 0:85f4174a8e29 112
mbed_official 0:85f4174a8e29 113 See [configs/6lowpan_Atmel_RF.json](configs/6lowpan_Atmel_RF.json) for an example configuration file.
mbed_official 0:85f4174a8e29 114
mbed_official 0:85f4174a8e29 115 #### The routing protocol RPL (6LoWPAN ND)
mbed_official 0:85f4174a8e29 116
mbed_official 0:85f4174a8e29 117 Nanostack Border Router uses [RPL](https://tools.ietf.org/html/rfc6550) as the routing protocol on the mesh network side (RF interface) when in 6LoWPAN-ND mode. Currently, only the `grounded/non-storing` operation mode is supported.
mbed_official 0:85f4174a8e29 118
mbed_official 0:85f4174a8e29 119 Nanostack Border Router offers the following configuration options for RPL:
mbed_official 0:85f4174a8e29 120
mbed_official 0:85f4174a8e29 121 | Field | Description |
mbed_official 0:85f4174a8e29 122 |-------------------------------------|---------------------------------------------------------------|
mbed_official 0:85f4174a8e29 123 | rpl-instance-id | The RPL instance ID value that identifies the RPL instance, default: 1 |
mbed_official 0:85f4174a8e29 124 | rpl-idoublings | RPL Trickle parameter: DIOIntervalDoublings value, default: 12 |
mbed_official 0:85f4174a8e29 125 | rpl-imin | RPL Trickle parameter: DIOIntervalMin value, default: 9 |
mbed_official 0:85f4174a8e29 126 | rpl-k | RPL Trickle parameter: the redundacy constant k, default: 10 |
mbed_official 0:85f4174a8e29 127 | rpl-max-rank-inc | Maximum rank increase value, default: 2048|
mbed_official 0:85f4174a8e29 128 | rpl-min-hop-rank-inc | Minimum rank increase value, default: 128 |
mbed_official 0:85f4174a8e29 129 | rpl-default-lifetime | Default lifetime for the RPL routes, default: 64 |
mbed_official 0:85f4174a8e29 130 | rpl-lifetime-unit | The value of the unit that describes the lifetime (in seconds), default: 60 |
mbed_official 0:85f4174a8e29 131 | rpl-pcs | The number of bits that may be allocated to the path control field. |
mbed_official 0:85f4174a8e29 132 | rpl-ocp | The Objective Function (OF) to use, values: 1=OF0 (default), 2=MRHOF |
mbed_official 0:85f4174a8e29 133
mbed_official 0:85f4174a8e29 134 ### Thread configuration
mbed_official 0:85f4174a8e29 135
mbed_official 0:85f4174a8e29 136 The Thread-specific parameters are listed below.
mbed_official 0:85f4174a8e29 137
mbed_official 0:85f4174a8e29 138 | Field | Description |
mbed_official 0:85f4174a8e29 139 |-------------------------------------|---------------------------------------------------------------|
mbed_official 0:85f4174a8e29 140 | `commissioning-dataset-timestamp` | Used for updating the Thread network parameters. The device with the highest value propagates the parameters to the network (in the same Realm-Local scope). |
mbed_official 0:85f4174a8e29 141 | `pan-id` | 2-byte Personal Area Network ID. |
mbed_official 0:85f4174a8e29 142 | `extended-pan-id` | 8-byte value used to identify Thread networks in range. |
mbed_official 0:85f4174a8e29 143 | `mesh-local-prefix` | ULA prefix used for communication within the Thread network. |
mbed_official 0:85f4174a8e29 144 | `network-name` | A human-readable name for the network. |
mbed_official 0:85f4174a8e29 145 | `pskc` | Pre-Shared Key for the Commissioner. |
mbed_official 0:85f4174a8e29 146 | `pskd` | Pre-Shared Key for the device. |
mbed_official 0:85f4174a8e29 147 | `thread-master-key` | A key used to derive security material for MAC and MLE protection. |
mbed_official 0:85f4174a8e29 148
mbed_official 0:85f4174a8e29 149
mbed_official 0:85f4174a8e29 150 For the Thread Border Router, there are example configuration files for `SLIP` and `ETH` backhaul connectivity:
mbed_official 0:85f4174a8e29 151
mbed_official 0:85f4174a8e29 152 * [configs/Thread_Atmel_RF.json](configs/Thread_Atmel_RF.json)
mbed_official 0:85f4174a8e29 153 * [configs/Thread_SLIP_Atmel_RF.json](configs/Thread_SLIP_Atmel_RF.json)
mbed_official 0:85f4174a8e29 154
mbed_official 0:85f4174a8e29 155 The [mbedtls_thread_config.h](source/mbedtls_thread_config.h) file configures mbed TLS for Thread use.
mbed_official 0:85f4174a8e29 156
mbed_official 0:85f4174a8e29 157 <span class="notes">**Note:** The configuration examples are for testing purposes only; do not use them for production or expose them.</span>
mbed_official 0:85f4174a8e29 158
mbed_official 0:85f4174a8e29 159
mbed_official 0:85f4174a8e29 160 #### Backhaul connectivity
mbed_official 0:85f4174a8e29 161
mbed_official 0:85f4174a8e29 162 The Nanostack border router application can be connected to a backhaul network. This enables you to connect the devices in a 6LoWPAN mesh network to the internet or a private LAN. Currently, the application supports SLIP (IPv6 encapsulation over a serial line) and Ethernet backhaul connectivity.
mbed_official 0:85f4174a8e29 163
mbed_official 0:85f4174a8e29 164 ```
mbed_official 0:85f4174a8e29 165 "config": {
mbed_official 0:85f4174a8e29 166 "backhaul-driver": {
mbed_official 65:92e581c01e8c 167 "help": "options are ETH, SLIP, EMAC",
mbed_official 85:7f1b82a282d7 168 "value": "EMAC"
mbed_official 0:85f4174a8e29 169 },
mbed_official 0:85f4174a8e29 170 "backhaul-mac-src": {
mbed_official 0:85f4174a8e29 171 "help": "Where to get EUI48 address. Options are BOARD, CONFIG",
mbed_official 0:85f4174a8e29 172 "value": "BOARD"
mbed_official 0:85f4174a8e29 173 },
mbed_official 0:85f4174a8e29 174 "backhaul-mac": "{0x02, 0x00, 0x00, 0x00, 0x00, 0x01}",
mbed_official 0:85f4174a8e29 175 "backhaul-dynamic-bootstrap": true,
mbed_official 0:85f4174a8e29 176 "backhaul-prefix": "\"fd00:300::\"",
mbed_official 0:85f4174a8e29 177 "backhaul-next-hop": "\"fe80::1\"",
mbed_official 0:85f4174a8e29 178 "backhaul-default-route": "\"::/0\"",
mbed_official 0:85f4174a8e29 179 .............
mbed_official 0:85f4174a8e29 180 }
mbed_official 0:85f4174a8e29 181 ```
mbed_official 0:85f4174a8e29 182
mbed_official 65:92e581c01e8c 183 You can select your preferred option through the configuration file (field `backhaul-driver` in the `config` section). The value `SLIP` includes the SLIP driver, while the value `ETH` compiles the border router application with Nanostack native Ethernet backhaul support. `EMAC` uses the board's default mbed OS network driver, which must be EMAC-based (derived from EMACInterface).
mbed_official 65:92e581c01e8c 184
mbed_official 85:7f1b82a282d7 185 You can define the MAC address on the backhaul interface manually (field `backhaul-mac-src` value `CONFIG`). Alternatively, you can use the MAC address provided by the development board (field `backhaul-mac-src` value `BOARD`). By default, the backhaul driver is set to `EMAC` and the MAC address source is `BOARD`.
mbed_official 0:85f4174a8e29 186
mbed_official 0:85f4174a8e29 187 You can also set the backhaul bootstrap mode (field `backhaul-dynamic-bootstrap`). By default, the bootstrap mode is set to true, which means the autonomous mode. With the autonomous mode, the border router learns the prefix information automatically from an IPv6 gateway in the Ethernet/SLIP segment. When the parameter is set to false, it enables you to set up a manual configuration of `backhaul-prefix` and `backhaul-default-route`.
mbed_official 0:85f4174a8e29 188
mbed_official 0:85f4174a8e29 189 If you use the static bootstrap mode, you need to configure a default route on the backhaul interface to properly forward packets between the backhaul and the 6LoWPAN mesh network. In addition to this, you need to set a backhaul prefix. The static mode creates a site-local IPv6 network from which packets cannot be routed outside.
mbed_official 0:85f4174a8e29 190
mbed_official 0:85f4174a8e29 191 When using the autonomous mode in the 6LoWPAN ND configuration, you can set the `prefix-from-backhaul` option to `true` to use the same backhaul prefix on the mesh network side as well. This allows the mesh nodes to be directly connectable from the outside of the mesh network. In the Thread network, it is enough that `backhaul-dynamic-bootstrap` is set to true.
mbed_official 0:85f4174a8e29 192
mbed_official 0:85f4174a8e29 193
mbed_official 0:85f4174a8e29 194 #### Note on the SLIP backhaul driver
mbed_official 0:85f4174a8e29 195
mbed_official 0:85f4174a8e29 196 If you are using a K64F board, you need to use the UART1 serial line of the board with the SLIP driver. See the `pins` section in the [mbed_app.json](./mbed_app.json) configuration file. To use a different UART line, replace the `SERIAL_TX` and `SERIAL_RX` values with correct TX/RX pin names.
mbed_official 0:85f4174a8e29 197
mbed_official 0:85f4174a8e29 198 If you wish to use the hardware flow control, set the configuration field `slip_hw_flow_control` to true. By default, it is set to false. Before using hardware flow control, make sure that the other end of your SLIP interface can handle the flow control.
mbed_official 0:85f4174a8e29 199
mbed_official 0:85f4174a8e29 200 For the pin names of your desired UART line, refer to your development board's documentation.
mbed_official 0:85f4174a8e29 201
mbed_official 0:85f4174a8e29 202 An example configuration for the SLIP driver:
mbed_official 0:85f4174a8e29 203
mbed_official 0:85f4174a8e29 204 ```
mbed_official 0:85f4174a8e29 205 "target_overrides": {
mbed_official 0:85f4174a8e29 206 "K64F": {
mbed_official 0:85f4174a8e29 207 "SERIAL_TX": "PTE0",
mbed_official 0:85f4174a8e29 208 "SERIAL_RX": "PTE1",
mbed_official 0:85f4174a8e29 209 "SERIAL_CTS": "PTE2",
mbed_official 0:85f4174a8e29 210 "SERIAL_RTS": "PTE3"
mbed_official 0:85f4174a8e29 211 }
mbed_official 0:85f4174a8e29 212 ```
mbed_official 0:85f4174a8e29 213
mbed_official 65:92e581c01e8c 214 #### Note on EMAC backhaul
mbed_official 65:92e581c01e8c 215
mbed_official 85:7f1b82a282d7 216 When `backhaul_driver` is set to `EMAC`, the border router will use the target's default network driver, as supplied by `NetworkInterface::get_default_instance`. This must be EMAC-based, derived from EMACInterface. If it is the same driver that a default-constructed `EthernetInterface` would use, so in principle it should work on any board where `EthernetInterface` works.
mbed_official 65:92e581c01e8c 217
mbed_official 65:92e581c01e8c 218 To use a different interface, change the setting of `target.default-network-interface-type` in `mbed_app.json` to point to a different interface type, or add an overriding definition of `NetworkInterface::get_default_instance` to the application - this will override any default supplied by the target board.
mbed_official 65:92e581c01e8c 219
mbed_official 65:92e581c01e8c 220 To use Wi-Fi or other more complex EMAC drivers, necessary configuration parameters must be supplied, either via `mbed_app.json` or configuration in the `NetworkInterface::get_default_instance` override. Also, the driver must follow the guidelines of `EMACInterface` - the border router does not call the `EMACInterface`'s `connect` method, so the driver must work with only a `powerup` call to the `EMAC`.
mbed_official 65:92e581c01e8c 221
mbed_official 0:85f4174a8e29 222 ### Switching the RF shield
mbed_official 0:85f4174a8e29 223
mbed_official 0:85f4174a8e29 224 By default, the application uses an Atmel AT86RF233/212B RF driver. You can alternatively use any RF driver provided in the `drivers/` folder or link in your own driver. You can set the configuration for the RF driver in the `json` file.
mbed_official 0:85f4174a8e29 225
mbed_official 0:85f4174a8e29 226 To select the Atmel radio shield, use the following:
mbed_official 0:85f4174a8e29 227
mbed_official 0:85f4174a8e29 228 ```
mbed_official 0:85f4174a8e29 229 "radio-type":{
mbed_official 0:85f4174a8e29 230 "help": "options are ATMEL, MCR20, SPIRIT1",
mbed_official 0:85f4174a8e29 231 "value": "ATMEL"
mbed_official 0:85f4174a8e29 232 },
mbed_official 0:85f4174a8e29 233 ```
mbed_official 0:85f4174a8e29 234
mbed_official 0:85f4174a8e29 235 To select the NXP radio shield, use the following:
mbed_official 0:85f4174a8e29 236
mbed_official 0:85f4174a8e29 237 ```
mbed_official 0:85f4174a8e29 238 "radio-type":{
mbed_official 0:85f4174a8e29 239 "help": "options are ATMEL, MCR20, SPIRIT1",
mbed_official 0:85f4174a8e29 240 "value": "MCR20"
mbed_official 0:85f4174a8e29 241 },
mbed_official 0:85f4174a8e29 242 ```
mbed_official 0:85f4174a8e29 243
mbed_official 0:85f4174a8e29 244 To select the STM Spirit1 radio shield, use the following:
mbed_official 0:85f4174a8e29 245
mbed_official 0:85f4174a8e29 246 ```
mbed_official 0:85f4174a8e29 247 "radio-type":{
mbed_official 0:85f4174a8e29 248 "help": "options are ATMEL, MCR20, SPIRIT1",
mbed_official 0:85f4174a8e29 249 "value": "SPIRIT1"
mbed_official 0:85f4174a8e29 250 },
mbed_official 0:85f4174a8e29 251 ```
mbed_official 0:85f4174a8e29 252
mbed_official 0:85f4174a8e29 253 In case you have choosen the STM Spirit1 Sub-1 GHz RF expansion board [X-NUCLEO-IDS01A4](https://github.com/ARMmbed/stm-spirit1-rf-driver), you need also to configure its MAC address in the `mbed_app.json` file, for example:
mbed_official 0:85f4174a8e29 254
mbed_official 0:85f4174a8e29 255 ```json
mbed_official 0:85f4174a8e29 256 "target_overrides": {
mbed_official 0:85f4174a8e29 257 "*": {
mbed_official 0:85f4174a8e29 258 "spirit1.mac-address": "{0xf0, 0xf1, 0xf2, 0xf3, 0xf4, 0xf5, 0xf6, 0xf7}"
mbed_official 0:85f4174a8e29 259 },
mbed_official 0:85f4174a8e29 260 }
mbed_official 0:85f4174a8e29 261 ```
mbed_official 0:85f4174a8e29 262
mbed_official 85:7f1b82a282d7 263 <span class="notes">**Note**: This MAC address must be unique within the 6LoWPAN mesh network.</span>
mbed_official 0:85f4174a8e29 264
mbed_official 0:85f4174a8e29 265 After changing the radio shield, you need to recompile the application.
mbed_official 0:85f4174a8e29 266
mbed_official 65:92e581c01e8c 267 ## File system support
mbed_official 65:92e581c01e8c 268
mbed_official 65:92e581c01e8c 269 The Application can enable use of file system as instructed in [mbed OS storage documentation](https://os.mbed.com/docs/latest/reference/storage.html). File system is not enabled by default due variety of possible configurations.
mbed_official 65:92e581c01e8c 270
mbed_official 85:7f1b82a282d7 271 Thread network stack is able to write/read network configuration settings to/from file system once the feature is activated. Activation happens by telling file system root path to Nanostack. To set the root-path, use function:
mbed_official 65:92e581c01e8c 272
mbed_official 65:92e581c01e8c 273 `ns_file_system_set_root_path(root-path)`
mbed_official 65:92e581c01e8c 274
mbed_official 65:92e581c01e8c 275 Once the root-path is set, Thread stack will read configuration settings from the file system and write configuration back to file system once configuration is changed.
mbed_official 65:92e581c01e8c 276
mbed_official 65:92e581c01e8c 277
mbed_official 0:85f4174a8e29 278 ## Running the border router application
mbed_official 0:85f4174a8e29 279
mbed_official 0:85f4174a8e29 280 1. Find the binary file `nanostack-border-router.bin` in the `BUILD` folder.
mbed_official 0:85f4174a8e29 281 2. Copy the binary to the USB mass storage root of the development board. It is automatically flashed to the target MCU. When the flashing is complete, the board restarts itself. Press the **Reset** button of the development board if it does not restart automatically.
mbed_official 0:85f4174a8e29 282 3. The program begins execution.
mbed_official 0:85f4174a8e29 283 4. Open the [serial connection](#serial-connection-settings), for example PuTTY.
mbed_official 0:85f4174a8e29 284
mbed_official 0:85f4174a8e29 285 ## Serial connection settings
mbed_official 0:85f4174a8e29 286
mbed_official 0:85f4174a8e29 287 Serial connection settings for the Nanorouter are as follows:
mbed_official 0:85f4174a8e29 288
mbed_official 0:85f4174a8e29 289 * Baud-rate = 115200
mbed_official 0:85f4174a8e29 290 * Data bits = 8
mbed_official 0:85f4174a8e29 291 * Stop bits = 1
mbed_official 0:85f4174a8e29 292
mbed_official 0:85f4174a8e29 293 If there is no input from the serial terminal, press the **Reset** button of the development board.
mbed_official 0:85f4174a8e29 294
mbed_official 0:85f4174a8e29 295 In the PuTTY main screen, save the session and click **Open**. This opens a console window showing debug messages from the application. If the console screen is blank, you may need to press the **Reset** button of the board to see the debug information. The serial output from the 6LoWPAN border router looks something like this in the console:
mbed_official 0:85f4174a8e29 296
mbed_official 0:85f4174a8e29 297 ```
mbed_official 0:85f4174a8e29 298 [INFO][app ]: Starting Nanostack border router...
mbed_official 0:85f4174a8e29 299 [INFO][brro]: NET_IPV6_BOOTSTRAP_AUTONOMOUS
mbed_official 0:85f4174a8e29 300 [INFO][app ]: Using ETH backhaul driver...
mbed_official 0:85f4174a8e29 301 [INFO][Eth ]: Ethernet cable is connected.
mbed_official 0:85f4174a8e29 302 [INFO][addr]: Tentative Address added to IF 1: fe80::ac41:dcff:fe37:72c4
mbed_official 0:85f4174a8e29 303 [INFO][addr]: DAD passed on IF 1: fe80::ac41:dcff:fe37:72c4
mbed_official 0:85f4174a8e29 304 [INFO][addr]: Tentative Address added to IF 1: 2001:999:21:9ce:ac41:dcff:fe37:72c4
mbed_official 0:85f4174a8e29 305 [INFO][addr]: DAD passed on IF 1: 2001:999:21:9ce:ac41:dcff:fe37:72c4
mbed_official 0:85f4174a8e29 306 [INFO][brro]: Backhaul bootstrap ready, IPv6 = 2001:999:21:9ce:ac41:dcff:fe37:72c4
mbed_official 0:85f4174a8e29 307 [INFO][brro]: Backhaul interface addresses:
mbed_official 0:85f4174a8e29 308 [INFO][brro]: [0] fe80::ac41:dcff:fe37:72c4
mbed_official 0:85f4174a8e29 309 [INFO][brro]: [1] 2001:999:21:9ce:ac41:dcff:fe37:72c4
mbed_official 0:85f4174a8e29 310 [INFO][addr]: Address added to IF 0: fe80::ff:fe00:face
mbed_official 0:85f4174a8e29 311 [INFO][br ]: BR nwk base ready for start
mbed_official 0:85f4174a8e29 312 [INFO][br ]: Refresh Contexts
mbed_official 0:85f4174a8e29 313 [INFO][br ]: Refresh Prefixs
mbed_official 0:85f4174a8e29 314 [INFO][addr]: Address added to IF 0: 2001:999:21:9ce:0:ff:fe00:face
mbed_official 0:85f4174a8e29 315 [INFO][addr]: Address added to IF 0: fe80::fec2:3d00:4:a0cd
mbed_official 0:85f4174a8e29 316 [INFO][brro]: RF bootstrap ready, IPv6 = 2001:999:21:9ce:0:ff:fe00:face
mbed_official 0:85f4174a8e29 317 [INFO][brro]: RF interface addresses:
mbed_official 0:85f4174a8e29 318 [INFO][brro]: [0] fe80::ff:fe00:face
mbed_official 0:85f4174a8e29 319 [INFO][brro]: [1] fe80::fec2:3d00:4:a0cd
mbed_official 0:85f4174a8e29 320 [INFO][brro]: [2] 2001:999:21:9ce:0:ff:fe00:face
mbed_official 0:85f4174a8e29 321 [INFO][brro]: 6LoWPAN Border Router Bootstrap Complete.
mbed_official 0:85f4174a8e29 322 ```
mbed_official 65:92e581c01e8c 323