This application is the simplest one to utilize our mesh networking stack. It just joins your device to the unsecure 6LoWPAN-ND network. The canonical source for this example lives at https://github.com/ARMmbed/mbed-os-example-mesh-minimal

Example mesh application for Mbed OS

With this application, you can use our mesh networking stack. This application joins your device to the unsecure 6LoWPAN-ND network.

Setup

Building with Mbed CLI

If you'd like to use Mbed CLI to build this offline, then you should refer to the Mbed CLI documentation. The instructions here relate to using the Mbed Online Compiler

  1. Click `Import this application` button.
  2. Change the channel settings: See the file `mbed_app.json` for an example of defining an IEEE 802.15.4 channel to use.
  3. Compile the application

A binary is generated at the end of the build process.

Connect the RF shield to the board

By default, we are using the Atmel AT86RF233, which you can purchase. Place the shield on top of your board, and power it on.

Program the target

Drag and drop the binary to the target to program the application.

Update the firmware of the border router.

You can read the instructions on updating the firmware of your board working as 6LoWPAN border router here.

Please remember to connect the Ethernet cable between the border router and your router. Then, power up the board.

Testing

As soon as both the border router and the target are up and running, you can verify the correct behavior. Open a serial console, and see the IP address obtained by the device.

Note: This application uses a baud rate of 115200.

Quote:

connected. IP = 2001:db8:a0b:12f0::1

You can use this IP address to ping from your PC and verify that the connection is working correctly.

Changing the radio driver (optional)

To run a 6LoWPAN-ND network, you need a working RF driver for Nanostack. This example uses the Atmel AT86RF233 by default.

To change the RF driver:

  1. Uninstall the Atmel RF driver.
  2. Install the new driver. (For example, for the FRDM-CR20A radio shield based on the MCR20A device.)
  3. Recompile your application.
Committer:
mbed_official
Date:
Tue Jan 02 10:15:07 2018 +0000
Revision:
69:c76b3887071b
Parent:
68:2330fbeb4926
Child:
79:4425f61286a3
Enable NUCLEO_F401RE IAR builds

.
Commit copied from https://github.com/ARMmbed/mbed-os-example-mesh-minimal

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 26:b28ab71ff595 1 properties ([[$class: 'ParametersDefinitionProperty', parameterDefinitions: [
mbed_official 52:27692043e962 2 [$class: 'StringParameterDefinition', name: 'mbed_os_revision', defaultValue: '', description: 'Revision of mbed-os to build. Use format "pull/PR-NUMBER/head" to access mbed-os PR'],
mbed_official 26:b28ab71ff595 3 [$class: 'BooleanParameterDefinition', name: 'smoke_test', defaultValue: false, description: 'Enable to run HW smoke test after building']
mbed_official 26:b28ab71ff595 4 ]]])
mbed_official 26:b28ab71ff595 5
mbed_official 52:27692043e962 6 if (params.mbed_os_revision == '') {
mbed_official 52:27692043e962 7 echo 'Use mbed OS revision from mbed-os.lib'
mbed_official 52:27692043e962 8 } else {
mbed_official 52:27692043e962 9 echo "Use mbed OS revisiong ${params.mbed_os_revision}"
mbed_official 52:27692043e962 10 if (params.mbed_os_revision.matches('pull/\\d+/head')) {
mbed_official 52:27692043e962 11 echo "Revision is a Pull Request"
mbed_official 52:27692043e962 12 }
mbed_official 52:27692043e962 13 }
mbed_official 32:8b28e79d2ed0 14 echo "Run smoke tests: ${params.smoke_test}"
mbed_official 26:b28ab71ff595 15
mbed_official 26:b28ab71ff595 16
mbed_official 26:b28ab71ff595 17 // Map RaaS instances to corresponding test suites
mbed_official 52:27692043e962 18 // Run only selected set of tests.
mbed_official 52:27692043e962 19 // Board: K64F
mbed_official 52:27692043e962 20 // Radios: Atmel & MCR20A
mbed_official 52:27692043e962 21 // configurations: 6LP + Thread
mbed_official 26:b28ab71ff595 22 def raas = [
mbed_official 26:b28ab71ff595 23 "lowpan_mesh_minimal_smoke_k64f_atmel.json": "8001",
mbed_official 52:27692043e962 24 // "lowpan_mesh_minimal_smoke_k64f_mcr20.json": "8034",
mbed_official 52:27692043e962 25 // "lowpan_mesh_minimal_smoke_429zi_atmel.json": "8030",
mbed_official 52:27692043e962 26 // "lowpan_mesh_minimal_smoke_429zi_mcr20.json": "8033",
mbed_official 52:27692043e962 27 // "lowpan_mesh_minimal_smoke_ublox_atmel.json": "8031",
mbed_official 52:27692043e962 28 // "thread_mesh_minimal_smoke_k64f_atmel.json": "8007"
mbed_official 26:b28ab71ff595 29 "thread_mesh_minimal_smoke_k64f_mcr20.json": "8034",
mbed_official 52:27692043e962 30 // "thread_mesh_minimal_smoke_429zi_atmel.json": "8030",
mbed_official 52:27692043e962 31 // "thread_mesh_minimal_smoke_429zi_mcr20.json": "8033",
mbed_official 52:27692043e962 32 // "thread_mesh_minimal_smoke_ublox_atmel.json": "8031"
mbed_official 26:b28ab71ff595 33 ]
mbed_official 26:b28ab71ff595 34
mbed_official 21:6c1e9147037c 35 // List of targets with supported RF shields to compile
mbed_official 21:6c1e9147037c 36 def targets = [
mbed_official 21:6c1e9147037c 37 "K64F": ["ATMEL", "MCR20"],
mbed_official 27:2b3fc6ca5872 38 "NUCLEO_F401RE": ["ATMEL", "MCR20"],
mbed_official 21:6c1e9147037c 39 "NUCLEO_F429ZI": ["ATMEL", "MCR20"],
mbed_official 21:6c1e9147037c 40 //"NCS36510": ["NCS36510"],
mbed_official 52:27692043e962 41 "UBLOX_EVK_ODIN_W2": ["ATMEL"],
mbed_official 52:27692043e962 42 "KW24D": ["MCR20"]
mbed_official 21:6c1e9147037c 43 ]
mbed_official 34:bc1827b97c5e 44
mbed_official 21:6c1e9147037c 45 // Map toolchains to compilers
mbed_official 21:6c1e9147037c 46 def toolchains = [
mbed_official 21:6c1e9147037c 47 ARM: "armcc",
mbed_official 21:6c1e9147037c 48 GCC_ARM: "arm-none-eabi-gcc",
mbed_official 58:e0f2bf24e6db 49 IAR: "IAR-linux"
mbed_official 21:6c1e9147037c 50 ]
mbed_official 21:6c1e9147037c 51
mbed_official 21:6c1e9147037c 52 // Supported RF shields
mbed_official 21:6c1e9147037c 53 def radioshields = [
mbed_official 21:6c1e9147037c 54 "ATMEL",
mbed_official 21:6c1e9147037c 55 "MCR20",
mbed_official 21:6c1e9147037c 56 "NCS36510"
mbed_official 21:6c1e9147037c 57 ]
mbed_official 21:6c1e9147037c 58
mbed_official 21:6c1e9147037c 59 // Mesh interfaces: 6LoWPAN and Thread
mbed_official 21:6c1e9147037c 60 def meshinterfaces = [
mbed_official 21:6c1e9147037c 61 "6lp",
mbed_official 21:6c1e9147037c 62 "thd"
mbed_official 21:6c1e9147037c 63 ]
mbed_official 34:bc1827b97c5e 64
mbed_official 21:6c1e9147037c 65 def stepsForParallel = [:]
mbed_official 21:6c1e9147037c 66
mbed_official 21:6c1e9147037c 67 // Jenkins pipeline does not support map.each, we need to use oldschool for loop
mbed_official 21:6c1e9147037c 68 for (int i = 0; i < targets.size(); i++) {
mbed_official 21:6c1e9147037c 69 for(int j = 0; j < toolchains.size(); j++) {
mbed_official 21:6c1e9147037c 70 for(int k = 0; k < radioshields.size(); k++) {
mbed_official 21:6c1e9147037c 71 for(int l = 0; l < meshinterfaces.size(); l++) {
mbed_official 21:6c1e9147037c 72 def target = targets.keySet().asList().get(i)
mbed_official 21:6c1e9147037c 73 def allowed_shields = targets.get(target)
mbed_official 21:6c1e9147037c 74 def toolchain = toolchains.keySet().asList().get(j)
mbed_official 21:6c1e9147037c 75 def compilerLabel = toolchains.get(toolchain)
mbed_official 21:6c1e9147037c 76 def radioshield = radioshields.get(k)
mbed_official 21:6c1e9147037c 77 def meshInterface = meshinterfaces.get(l)
mbed_official 27:2b3fc6ca5872 78
mbed_official 21:6c1e9147037c 79 def stepName = "${target} ${toolchain} ${radioshield} ${meshInterface}"
mbed_official 21:6c1e9147037c 80 if(allowed_shields.contains(radioshield)) {
mbed_official 21:6c1e9147037c 81 stepsForParallel[stepName] = buildStep(target, compilerLabel, toolchain, radioshield, meshInterface)
mbed_official 21:6c1e9147037c 82 }
mbed_official 21:6c1e9147037c 83 }
mbed_official 21:6c1e9147037c 84 }
mbed_official 21:6c1e9147037c 85 }
mbed_official 21:6c1e9147037c 86 }
mbed_official 21:6c1e9147037c 87
mbed_official 26:b28ab71ff595 88 def parallelRunSmoke = [:]
mbed_official 26:b28ab71ff595 89
mbed_official 26:b28ab71ff595 90 // Need to compare boolean against string value
mbed_official 34:bc1827b97c5e 91 if ( params.smoke_test == true ) {
mbed_official 26:b28ab71ff595 92 // Generate smoke tests based on suite amount
mbed_official 26:b28ab71ff595 93 for(int i = 0; i < raas.size(); i++) {
mbed_official 26:b28ab71ff595 94 def suite_to_run = raas.keySet().asList().get(i)
mbed_official 26:b28ab71ff595 95 def raasPort = raas.get(suite_to_run)
mbed_official 26:b28ab71ff595 96 // Parallel execution needs unique step names. Remove .json file ending.
mbed_official 26:b28ab71ff595 97 def smokeStep = "${raasPort} ${suite_to_run.substring(0, suite_to_run.indexOf('.'))}"
mbed_official 26:b28ab71ff595 98 parallelRunSmoke[smokeStep] = run_smoke(targets, toolchains, radioshields, meshinterfaces, raasPort, suite_to_run)
mbed_official 26:b28ab71ff595 99 }
mbed_official 26:b28ab71ff595 100 }
mbed_official 26:b28ab71ff595 101
mbed_official 21:6c1e9147037c 102 timestamps {
mbed_official 21:6c1e9147037c 103 parallel stepsForParallel
mbed_official 26:b28ab71ff595 104 parallel parallelRunSmoke
mbed_official 21:6c1e9147037c 105 }
mbed_official 21:6c1e9147037c 106
mbed_official 21:6c1e9147037c 107 def buildStep(target, compilerLabel, toolchain, radioShield, meshInterface) {
mbed_official 21:6c1e9147037c 108 return {
mbed_official 21:6c1e9147037c 109 stage ("${target}_${compilerLabel}_${radioShield}_${meshInterface}") {
mbed_official 21:6c1e9147037c 110 node ("${compilerLabel}") {
mbed_official 21:6c1e9147037c 111 deleteDir()
mbed_official 21:6c1e9147037c 112 dir("mbed-os-example-mesh-minimal") {
mbed_official 21:6c1e9147037c 113 checkout scm
mbed_official 50:5d4045379c2f 114 def config_file = "mbed_app.json"
mbed_official 21:6c1e9147037c 115
mbed_official 21:6c1e9147037c 116 if ("${meshInterface}" == "thd") {
mbed_official 50:5d4045379c2f 117 config_file = "./configs/mesh_thread.json"
mbed_official 51:de6c96c52689 118 // Use systest Thread Border Router for testing (CH=18, PANID=BAAB)
mbed_official 51:de6c96c52689 119 execute("sed -i '/mbed-mesh-api.thread-device-type\":/a \"mbed-mesh-api.thread-config-channel\": 18,' ${config_file}")
mbed_official 51:de6c96c52689 120 execute("sed -i '/mbed-mesh-api.thread-device-type\":/a \"mbed-mesh-api.thread-config-panid\": \"0xBAAB\",' ${config_file}")
mbed_official 68:2330fbeb4926 121 execute("sed -i 's/\"nanostack.configuration\": \"thread_router\"/\"nanostack.configuration\": \"thread_end_device\"/' ${config_file}")
mbed_official 52:27692043e962 122 execute("sed -i 's/\"mbed-mesh-api.thread-device-type\": \"MESH_DEVICE_TYPE_THREAD_ROUTER\"/\"mbed-mesh-api.thread-device-type\": \"MESH_DEVICE_TYPE_THREAD_MINIMAL_END_DEVICE\"/' ${config_file}")
mbed_official 53:82a191e2c133 123 }
mbed_official 21:6c1e9147037c 124
mbed_official 21:6c1e9147037c 125 if ("${meshInterface}" == "6lp") {
mbed_official 50:5d4045379c2f 126 config_file = "./configs/mesh_6lowpan.json"
mbed_official 51:de6c96c52689 127 // Use systest 6LoWPAN Border Router for testing (CH=17, PANID=ABBA)
mbed_official 51:de6c96c52689 128 execute("sed -i 's/\"mbed-mesh-api.6lowpan-nd-channel\": 12/\"mbed-mesh-api.6lowpan-nd-channel\": 17/' ${config_file}")
mbed_official 51:de6c96c52689 129 execute("sed -i 's/\"mbed-mesh-api.6lowpan-nd-panid-filter\": \"0xffff\"/\"mbed-mesh-api.6lowpan-nd-panid-filter\": \"0xABBA\"/' ${config_file}")
mbed_official 21:6c1e9147037c 130 }
mbed_official 26:b28ab71ff595 131
mbed_official 52:27692043e962 132 if ("${radioShield}" == "MCR20") {
mbed_official 52:27692043e962 133 // Replace default rf shield
mbed_official 52:27692043e962 134 execute("sed -i 's/\"value\": \"ATMEL\"/\"value\": \"MCR20\"/' ${config_file}")
mbed_official 52:27692043e962 135 }
mbed_official 52:27692043e962 136
mbed_official 52:27692043e962 137 if ("${radioShield}" == "NCS36510") {
mbed_official 52:27692043e962 138 // Replace default rf shield
mbed_official 52:27692043e962 139 execute("sed -i 's/\"value\": \"ATMEL\"/\"value\": \"NCS36510\"/' ${config_file}")
mbed_official 52:27692043e962 140 }
mbed_official 52:27692043e962 141
mbed_official 52:27692043e962 142 // For KW24D, we need to optimize for low memory
mbed_official 52:27692043e962 143 if ("${target}" == "KW24D") {
mbed_official 52:27692043e962 144 // Use optimal mbed TLS config file, need double escaping of '\' characters, first ones to escape Grooy, second ones to escape shell
mbed_official 52:27692043e962 145 // Need to use SH shells
mbed_official 52:27692043e962 146 sh("sed -i '/\"target_overrides\"/ i \"macros\": [\"MBEDTLS_USER_CONFIG_FILE=\\\\\"mbedtls_config.h\\\\\"\"],' ${config_file}")
mbed_official 52:27692043e962 147 // Limit mesh heap size to 11kB
mbed_official 52:27692043e962 148 execute("sed -i 's/mbed-mesh-api.heap-size\": .*,/mbed-mesh-api.heap-size\": 11000,/' ${config_file}")
mbed_official 52:27692043e962 149 // Limit event loop heap size
mbed_official 52:27692043e962 150 execute("sed -i '/target.features_add/ i \"nanostack-hal.event_loop_thread_stack_size\": 2048,' ${config_file}")
mbed_official 53:82a191e2c133 151 if ("${toolchain}" == "GCC_ARM" && "${meshInterface}" == "thd") {
mbed_official 53:82a191e2c133 152 execute("sed -i 's/mbed-mesh-api.heap-size\": .*,/mbed-mesh-api.heap-size\": 15000,/' ${config_file}")
mbed_official 53:82a191e2c133 153 execute("sed -i '/mbed-mesh-api.thread-device-type\":/a \"mbed-mesh-api.use-malloc-for-heap\": true,' ${config_file}")
mbed_official 53:82a191e2c133 154 }
mbed_official 52:27692043e962 155 }
mbed_official 52:27692043e962 156
mbed_official 51:de6c96c52689 157 // Activate traces
mbed_official 51:de6c96c52689 158 execute("sed -i 's/\"mbed-trace.enable\": false/\"mbed-trace.enable\": true/' ${config_file}")
mbed_official 51:de6c96c52689 159
mbed_official 26:b28ab71ff595 160 // Set mbed-os to revision received as parameter
mbed_official 21:6c1e9147037c 161 execute ("mbed deploy --protocol ssh")
mbed_official 52:27692043e962 162 if (params.mbed_os_revision != '') {
mbed_official 52:27692043e962 163 dir ("mbed-os") {
mbed_official 52:27692043e962 164 if (params.mbed_os_revision.matches('pull/\\d+/head')) {
mbed_official 52:27692043e962 165 execute("git fetch origin ${params.mbed_os_revision}:PR")
mbed_official 52:27692043e962 166 execute("git checkout PR")
mbed_official 52:27692043e962 167 } else {
mbed_official 52:27692043e962 168 execute ("git checkout ${params.mbed_os_revision}")
mbed_official 52:27692043e962 169 }
mbed_official 52:27692043e962 170 }
mbed_official 21:6c1e9147037c 171 }
mbed_official 26:b28ab71ff595 172
mbed_official 50:5d4045379c2f 173 execute ("mbed compile --build out/${target}_${toolchain}_${radioShield}_${meshInterface}/ -m ${target} -t ${toolchain} -c --app-config ${config_file}")
mbed_official 21:6c1e9147037c 174 }
mbed_official 26:b28ab71ff595 175 stash name: "${target}_${toolchain}_${radioShield}_${meshInterface}", includes: '**/mbed-os-example-mesh-minimal.bin'
mbed_official 21:6c1e9147037c 176 archive '**/mbed-os-example-mesh-minimal.bin'
mbed_official 26:b28ab71ff595 177 step([$class: 'WsCleanup'])
mbed_official 21:6c1e9147037c 178 }
mbed_official 21:6c1e9147037c 179 }
mbed_official 21:6c1e9147037c 180 }
mbed_official 21:6c1e9147037c 181 }
mbed_official 26:b28ab71ff595 182
mbed_official 26:b28ab71ff595 183 def run_smoke(targets, toolchains, radioshields, meshinterfaces, raasPort, suite_to_run) {
mbed_official 26:b28ab71ff595 184 return {
mbed_official 26:b28ab71ff595 185 // Remove .json from suite name
mbed_official 26:b28ab71ff595 186 def suiteName = suite_to_run.substring(0, suite_to_run.indexOf('.'))
mbed_official 26:b28ab71ff595 187 stage ("smoke_${raasPort}_${suiteName}") {
mbed_official 30:81d713ba997d 188 node ("mesh-test") {
mbed_official 26:b28ab71ff595 189 deleteDir()
mbed_official 26:b28ab71ff595 190 dir("mbed-clitest") {
mbed_official 26:b28ab71ff595 191 git "git@github.com:ARMmbed/mbed-clitest.git"
mbed_official 65:cb583d690d43 192 execute("git checkout ${env.LATEST_CLITEST_STABLE_REL}")
mbed_official 52:27692043e962 193 }
mbed_official 52:27692043e962 194 dir("testcases") {
mbed_official 52:27692043e962 195 git "git@github.com:ARMmbed/mbed-clitest-suites.git"
mbed_official 52:27692043e962 196 execute("git checkout master")
mbed_official 52:27692043e962 197 execute("git submodule update --init --recursive")
mbed_official 52:27692043e962 198 dir("6lowpan") {
mbed_official 26:b28ab71ff595 199 execute("git checkout master")
mbed_official 26:b28ab71ff595 200 }
mbed_official 52:27692043e962 201 dir("thread-tests") {
mbed_official 52:27692043e962 202 execute("git checkout master")
mbed_official 52:27692043e962 203 }
mbed_official 52:27692043e962 204 }
mbed_official 26:b28ab71ff595 205
mbed_official 52:27692043e962 206 for (int i = 0; i < targets.size(); i++) {
mbed_official 52:27692043e962 207 for(int j = 0; j < toolchains.size(); j++) {
mbed_official 52:27692043e962 208 for(int k = 0; k < radioshields.size(); k++) {
mbed_official 52:27692043e962 209 for(int l = 0; l < meshinterfaces.size(); l++) {
mbed_official 52:27692043e962 210 def target = targets.keySet().asList().get(i)
mbed_official 52:27692043e962 211 def allowed_shields = targets.get(target)
mbed_official 52:27692043e962 212 def toolchain = toolchains.keySet().asList().get(j)
mbed_official 52:27692043e962 213 def radioshield = radioshields.get(k)
mbed_official 52:27692043e962 214 def meshInterface = meshinterfaces.get(l)
mbed_official 52:27692043e962 215 // Skip unwanted combination
mbed_official 52:27692043e962 216 if (target == "NUCLEO_F401RE" && toolchain == "IAR") {
mbed_official 52:27692043e962 217 continue
mbed_official 52:27692043e962 218 }
mbed_official 52:27692043e962 219 if(allowed_shields.contains(radioshield)) {
mbed_official 52:27692043e962 220 unstash "${target}_${toolchain}_${radioshield}_${meshInterface}"
mbed_official 26:b28ab71ff595 221 }
mbed_official 26:b28ab71ff595 222 }
mbed_official 26:b28ab71ff595 223 }
mbed_official 26:b28ab71ff595 224 }
mbed_official 26:b28ab71ff595 225 }
mbed_official 52:27692043e962 226 env.RAAS_USERNAME = "user"
mbed_official 52:27692043e962 227 env.RAAS_PASSWORD = "user"
mbed_official 52:27692043e962 228 execute("./mbed-clitest/clitest.py --tcdir testcases --suitedir testcases/suites/ --suite ${suite_to_run} --type hardware --reset --raas 62.44.193.186:${raasPort} --raas_share_allocs --failure_return_value -vvv -w --log log_${raasPort}_${suiteName}")
mbed_official 52:27692043e962 229 archive "log_${raasPort}_${suiteName}/**/*"
mbed_official 26:b28ab71ff595 230 }
mbed_official 26:b28ab71ff595 231 }
mbed_official 26:b28ab71ff595 232 }
mbed_official 26:b28ab71ff595 233 }