rfWsnNodeExtFlashOadClient Example
Example Summary
The WSN Node example illustrates how to create a Wireless Sensor Network Node device which sends packets to a concentrator. This example is meant to be used with the WSN Concentrator example to form a one-to-many network where the nodes send messages to the concentrator.
This examples showcases the use of several Tasks, Semaphores, and Events to get sensor updates and send packets with acknowledgement from the concentrator. For the radio layer, this example uses the EasyLink API which provides an easy-to-use API for the most frequently used radio operations.
Peripherals Exercised
Board_PIN_LED0- Toggled when the a packet is sentBoard_ADCCHANNEL_A0- Used to measure the Analog Light Sensor by the SCE taskBoard_PIN_BUTTON0- Selects fast report or slow report mode. In slow report mode the sensor data is sent every 5s or as fast as every 1s if there is a significant change in the ADC reading. The fast reporting mode sends the sensor data every 1s regardless of the change in ADC value. The default is slow reporting mode.
Resources & Jumper Settings
If you’re using an IDE (such as CCS or IAR), please refer to Board.html in your project directory for resources used and board-specific jumper settings. Otherwise, you can find Board.html in the directory <SDK_INSTALL_DIR>/source/ti/boards/<BOARD>.
Example Usage
- Run the example. On another board run the WSN Concentrator example. This node should show up on the LCD of the Concentrator.
The example also supports Over The Air Download (OAD), where new FW can be transferred from the concentrator to the node. There must be an OAD Server, which is included in the concentrator project, and an OAD client, which is included in the node project.
Performing an OAD Image Transfer
To be safe the external flash of the Concentrator should be wiped before running the example. To do this, program both LP boards with erase_storage_offchip_cc13x2lp.hex. The program will flash the LEDs while erasing the external flash. Allow the application to run until the LEDs stop flashing indicating the external flash has been erased.
The FW to erase the external flash can be found in below location and should be loaded using Uniflash programmer: <SDK_DIR>/examples/rtos/CC1352R1_LAUNCHXL/easylink/hexfiles/offChipOad/ccs/erase_storage_offchip_cc13x2lp.hex
OAD with Easylink
The Concentrator OAD Server and Node OAD Client FW should each be loaded into a CC1312R1LP/CC1352R1LP using the Uniflash programmer:
- Load rfWsnConcentratorOadServer (.out) project into a CC1312R1LP/CC1352R1LP
- Load
<SDK_DIR>/examples/rtos/CC1352R1_LAUNCHXL/easylink/hexfiles/offChipOad/ccs/rfWsnNodeExtFlashOadClient_CC1352R1_LAUNCHXL_app_v1.hexand<SDK_DIR>/examples/rtos/CC1352R1_LAUNCHXL/easylink/hexfiles/offChipOad/ccs/cc13x2r1lp_bim_offchip.hexinto a CC1312R1LP/CC1352R1LP by selecting multiple files in Uniflash
The Concentrator will display the below on the UART terminal:
Nodes Value SW RSSI
*0x0b 0887 0 -080
0xdb 1036 0 -079
0x91 0940 0 -079
Action: Update available FW
Info: Available FW unknown
Use the node display to identify the corresponding node ID:
Node ID: 0x91
Node ADC Reading: 1196
The node OAD image can be loaded into the external flash of the Concentrator through the UART with the oad_write_bin.py script. The action must first be selected using BTN-2. Press BTN-2 until the Action is set to Update available FW, then press BTN-1 and BTN-2 simultaneously to execute the action.
When “Available FW” is selected the terminal will display:
Waiting for Node FW update...
The UART terminal must be closed to free the COM port before the script is run. Then the python script can be run using the following command:
python <SDK>/tools/easylink/oad/oad_write_bin.py /dev/ttyS28 <SDK_DIR>/examples/rtos/CC1352R1_LAUNCHXL/easylink/hexfiles/offChipOad/ccs/rfWsnNodeExtFlashOadClient_CC1352R1_LAUNCHXL_app_v2.bin
After the download the UART terminal can be re-opened and the “Info” menu line will be updated to reflect the new FW available for OAD to a node.
The current FW version running on the node can be requested using the Send FW Ver Req action. This is done by pressing BTN-1 until the desired node is selected (indicated by the *), then pressing BTN-2 until the Action is set to Send FW Ver Req. To execute the action, press BTN-1 and BTN-2 simultaneously.
The next time the node sends data to the concentrator, the FW version of the selected node will appear in the Info section.
Nodes Value SW RSSI
0x0b 0887 0 -080
0xdb 1036 0 -079
*0x91 0940 0 -079
Action: Send FW Ver Req
Info: Node 0x91 FW sv:0001, bv:01
Where:
svis the FW version numberbvis the version number of the BIM
The node FW can now be updated to the image stored on the external flash of the concentrator. Press BTN-1 until the desired node is selected, then press BTN-2 until the Action is set to Update node FW. To execute the action, press BTN-1 and BTN-2 simultaneously.
The next time the node sends data, the OAD sequence will begin. As the node requests each image block from the concentrator the Concentrator display is updated to show the progress of the image transfer.
Nodes Value SW RSSI
0x0b 0887 0 -080
0xdb 1036 0 -079
*0x91 0940 0 -079
Action: Update node FW
Info: OAD Block 14 of 1089
The node display also updates to show the status of the image transfer.
Node ID: 0x91
Node ADC Reading: 3093
OAD Block: 14 of 1089
OAD Block Retries: 0
Once the OAD has completed, the concentrator will indicate that the transfer has finished with an OAD Complete status. The node will reset itself with a new node ID. If the device does not reset itself a manual reset may be necessary.
Nodes Value SW RSSI
0x0b 0887 0 -080
0xdb 1036 0 -079
*0xe2 0940 0 -079
Action: Update node FW
Info: Node 0xe2 FW Unknown
A firmware version request can then be performed to verify the new image.
OAD with BLE
The BLE Host Apllication and BLE Simple Peripheral with OAD should each be loaded into a CC1312R1LP/CC1352R1LP using the Uniflash programmer:
Load
<SDK_DIR>/examples/rtos/CC1352R1_LAUNCHXL/ble5/hexfiles/ble5_host_test_cc13x2r1lp_app.hexinto a CC1312R1LP/CC1352R1LPLoad
<SDK_DIR>/examples/rtos/CC1352R1_LAUNCHXL/ble5/hexfiles/oad/ble5_simple_peripheral_oad_offchip_cc13x2r1lp_app_FlashROM_Release_oad.binand<SDK_DIR>/examples/rtos/CC1352R1_LAUNCHXL/easylink/hexfiles/offChipOad/ccs/cc13x2r1lp_bim_offchip.hexinto a CC1312R1LP/CC1352R1LP
When BTN-1 Button is held down and the device is reset by pressing the RESET Button or disconnecting/reconnecting the device to a power source the device will boot into the Factory Image located in external flash. If there is no Factory Image, the image stored in internal flash is copied to external flash as the factory image. After loading the BLE Simple Peripheral image on the device, perform a factory reset to copy the BLE Simple Peripheral image as the Factory Image.
- Replace the image on the BLE Simple Peripheral device by loading
<SDK_DIR>/examples/rtos/CC1352R1_LAUNCHXL/easylink/hexfiles/offChipOad/ccs/rfWsnNodeExtFlashOadClient_CC1352R1_LAUNCHXL_app_v1.hexusing Uniflash
A factory reset can be performed at any time to perform an OAD now. Perform a factory reset to continue.
Open up Btool which can be found in
<SDK_DIR>/tools/ble5stack/btool
Select the UART port that corresponds to the device running the BLE Host application. All other Serial Port Settings should be left as the defaults. Select the Scan button in the GUI. When the scan has finished, select the address of the BLE Simple Peripheral device and press the Establish button to connect the two devices.
** Note the BLE Address can be seen by looking at UART output of the device or by using Uniflash and navigating to Settings & Utilities → Read Primary BLE Address **
When the connection has been established, navigate to the Over The Air Download tab in the top left hand corner of the GUI.
Select Read Image File and navigate to the Easylink rfWsnNodeExtFlashOad image created earlier. Make sure to select the OAD To External Flash check box. Start the image transfer by clicking the Send button.
When the OAD has completed, the device will boot up into the new rfWsnNodeExtFlashOad image and native OAD can now be performed as previously described.
Generating OAD Images
For generating the images the following tools are required:
Code Composer Studio– Download the latest version from https://processors.wiki.ti.com/index.php/Download_CCSSimplelink CC13X0 SDK– Download the latest version from https://www.ti.com/tool/simplelink-cc13x0-sdkPython 2.7Python intelhex-2.1Python crcmod-1.7
Creating the Application Hex Image
To generate the application hex file, the project should be imported and built with the desired compiler. To change the FW version, update the following string in oad/native_oad/oad_image_header_app.c
#define SOFTWARE_VER {'0', '2', '0', '1'}
where the above would correspond to v2.01 for the software version.
Creating the Application Binary Image
Add the following post build step. In Code Composer Studio, navigate to Project → Properties → Build, then clicking the Steps tab. In IAR Embedded Workbench, navigate to Options → Build Actions and appending the new step with a semicolon separator.
${COM_TI_SIMPLELINK_CC13X2_SDK_INSTALL_DIR}/tools/common/oad/oad_image_tool --verbose <compiler> ${PROJECT_LOC} 7 -hex1 ${ConfigName}/${ProjName}.hex -o ${ConfigName}/${ProjName}
Make sure to replace <compiler> with the appropriate compiler (ccs, gcc, or iar).
** Note The OAD binary will be generated in the Debug dir in the project. The .out file can be used for debugging through CCS without any changes to the BIM. However, if the .out file is flashed to the device the JTAG_DEBUG compiler flag must be defined in the BIM project. **
Application Design Details
This examples consists of two tasks, one application task and one radio protocol task. It also consists of a Sensor Controller Engine (SCE) Task which samples the ADC.
On initialization the CM3 application sets the minimum report interval and the minimum change value which is used by the SCE task to wake up the CM3. The ADC task on the SCE checks the ADC value once per second. If the ADC value has changed by the minimum change amount since the last time it notified the CM3, it wakes it up again. If the change is less than the masked value, then it does not wake up the CM3 unless the minimum report interval time has expired.
The NodeTask waits to be woken up by the SCE. When it wakes up it toggles
Board_PIN_LED1and sends the new ADC value to the NodeRadioTask.The NodeRadioTask handles the radio protocol. This sets up the EasyLink API and uses it to send new ADC values to the concentrator. After each sent packet it waits for an ACK packet back. If it does not get one, then it retries three times. If it did not receive an ACK by then, then it gives up.
RadioProtocol.h can also be used to configure the PHY settings from the following options: IEEE 802.15.4g 50kbit (default), Long Range Mode or custom settings. In the case of custom settings, the smartrf_settings.c file is used. The configuration can be changed by exporting a new smartrf_settings.c file from Smart RF Studio or modifying the file directly.
References
- For more information on the EasyLink API and usage refer to SimpleLink-EasyLink.