rfWsnNodeOad_internalFlash 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 together 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. in fast reporting mode the sensor data is sent 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 support Over The Air Update (OAD), where new FW can be loaded over OAD. The must be an OAD Server, which is included in the concentrator, and an OAD client which is included in the sensor.
Generating the required binary images
For generating the images the following tools are required:
CCSv7
https://processors.wiki.ti.com/index.php/Download_CCSsimplelink_cc13x0_sdk_1_31_00_xx
https://www.ti.com/tool/simplelink-cc13x0-sdkPython 2.7
Python intelhex-2.1
Python crcmod-1.7
To build a project for On-Chip OAD, the following settings must be configured:
The following symbols must be defined for the compiler and linker: FEATURE_OAD_ONCHIP HAL_IMAGE_A or HAL_IMAGE_B
In release_oad.cfg, the reset vector addresses for TIRTOS must be configured: /*
- Assign an address for the reset vector.
- Default is 0x0, which is the start of Flash. Ordinarily this setting should
- not be changed. */ // Image A Reset Vector Address m3Hwi.resetVectorAddress = 0x1010;
// Image B Reset Vector Address //m3Hwi.resetVectorAddress = 0x10010;
Comment out the appropriate resetVectorAddress for the image you are not building. Hexfile generation must be enabled. ``The prebuilt BIM binary is generated from the BLE SDK projects: - CCS:
- IAR:
The python intelhex merge utility is used to combine the BIM and App into one hex file that can be downloaded with SmartRF Studio:
cd <SDK_DIR>/examples/rtos/CC1310_LAUNCHXL/easylink/hexfiles/oad/<int_flash/ext_flash>/
python /usr/bin/hexmerge.py -o rfWsnNodeOad_CC1310LP_all.hex "--overlap=error" rfWsnNodeOad_CC1310LP_app.hex bim_extflash_cc1350lp_bim.hex
Note: Select the relevant int_flash/ext_flash files.
An OAD image can then be created from the application image with the oad_image_tool.py:
python ../../../../../../tools/easylink/oad_image_tool.py -v 0x[major version:minor version] -i app rfWsnNodeOad_CC1310LP_app.hex -ob rfWsnNodeOad_CC1310LP_app.bin -m 0x1000
Where major version (XX) and minor version (YY) must be of the format 0xXXYY, for example 2.3 would be 0x0203.
Creating the OAD Binary: To flash an image to the device with the On-Chip BIM, you must first create an OAD binary of the image before flashing it to the device. This is required since the BIM verifies the CRC value of any image before it is executed. The tool used to create an On-Chip OAD is oad_image_tool.py. The following command-line arguments can be must be used to build the image: -t onchip -i app -m 0x1000 (for image A) or -m 0x10000 (for image B) A version number that is newer than the current image residing on the device
An example of building a binary for each case is shown below. If you are directly flashing the image to the device with the BIM, please see the next section. OAD Image A: python oad_image_tool.py -t onchip -i app -v 0x0100 -m 0x1000 -ob app_v1.bin app_v1.hex
OAD Image B: python oad_image_tool.py -t onchip -i app -v 0x0200 -m 0x10000 -ob app_v2.bin app_v2.hex
Flashing an OAD binary The BIM uses a CRC check to validate any image before it is executed, so it must have an OAD header. Because the BIM is merged with the initial application image, the ‘production’ image type must be used when building the OAD binary. python oad_image_tool.py -t onchip -i production -v 0x0100 -m 0x1000 -ob app_v1.bin app_v1.hex
Using the on-chip OAD example
To be safe when using for the first time the external flash of the Concentrator should be wiped. Program both LP boards with bin/CC1350LaunchPad_ExtFlashErase.hex. The program will flash the LED’s while erasing and once finished the LED’s will stop flashing. Allow the application to run until the external flash has been erased and the LED’s stop flashing.
The wipe flash FW can be found in below lacation and should be downloaded with Uniflash programmer: <SDK_DIR>/hexfiles/native_oad/CC1350LaunchPad_ExtFlashErase.hex
The Concetrator OAD Server and Node OAD Client FW must then be loaded in to the LP’s using the Uniflash programmer:
- Load
\examples\rtos\CC1310_LAUNCHXL\easylink\hexfiles\oad\rfWsnConcentratorOad_CC1310LP_all.hex into a CC1310LP/CC1350LP - Load
\examples\rtos\CC1310_LAUNCHXL\easylink\hexfiles\oad\rfWsnNodeOad_CC1310LP_all.hex into a CC1310LP/CC1350LP
The Concetrator 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
cmd:
The node OAD image can be loaded into the external flash of the Concentrator over the UART with the oad_wrtie_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 Press BTN-2 to execute the action.
When “Available FW” is selected and BTN-2 is pressed the terminal will display:
Waiting for Node FW update...
The UART terminal must first be closed to free the com port. Then the python script run:
python ../../../../../../tools/easylink/oad/oad_write_bin.py /dev/ttyS28 rfWsnNodeOad_CC1310LP_app.bin
After the download the UART terminal can be re-opened and the “Available FW” will be updated to reflect the new FW.
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 Action
is selected. Then press BTN-2 until the Action is set to Update available FW
, The Press BTN-1 until intended device is selected. Press BTN-2 to execture the action.
The next time the node sends data it will respond and the FW version will be displayed:
Nodes Value SW RSSI
0x0b 0887 0 -080
0xdb 1036 0 -079
*0x91 0940 0 -079
Action: Update available FW
Info: Node 0x91 FW v1.0
The FW running on the nodes can now be updated to the available fw on the concentrator. The Action
must first be selected using BTN-1. The Press BTN-2 until the Action is set to Update node FW
, and Press BTN-1 until the intended device is selected. Press BTN-2 to execture the action.
The next time the node sends data it will respond and the FW update request and start requesting OAD blocks, which will be displayed:
Nodes Value SW RSSI
0x0b 0887 0 -080
0xdb 1036 0 -079
*0x91 0940 0 -079
Action: Update available FW
Info: OAD Block 14 of 1089
Once the OAD has completed the node will reset (if not yo may need to do a manual reset).
Building an OAD hex
The following steps talk through how to use CCS or IAR to create an OAD hex file which can be used to create the OAD biniaries as described in previous sections
Building the hex file in CCS
- Import the CCS porject into CCS(for more information conslt the Examples Users Guide in the proprietary-rf documentation)
- Exclude the ccfg.c file from the project.
- Enable hex file conversion in Project->Properties Arm Hex Utility
- Set memory width to 8 in General options
- Set output format to intel hex.
- Make a code change, for testing this can just be updating the nodeFwVersion string in NodeTask.c
- build
- copy hex from the projects Debug dir to the bin folder
Application Design Details
This examples consists of two tasks, one application task and one radio protocol task. It also consists of an Sensor Controller Engine, SCE, Task which samples the ADC.
On initialisation 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_LED1
and 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 change the PHY settings to be either the default IEEE 802.15.4g 50kbit, Long Range Mode or custom settings. In the case of custom settings, the smartrf_settings.c file is used. This can be changed either by exporting from Smart RF Studio or directly in the file.
References
- For more information on the EasyLink API and usage refer to SimpleLink-EasyLink.