Configuring and Managing the FlexNet Components: Performing Meter Firmware Download RNI Release 3.1 SP2

1. Configuring and Managing the FlexNet Components: Performing Meter Firmware Download RNI Release 3.1 SP2 C-PAMRAMI-WG-0143-01

2. Introduce the concepts associated with performing a firmware download over the air to water and gas meters and a procedure for doing so. The goal of this module is to:

3. Firmware Downloads Overview Section One

4. Explain why to use the meter firmware download process. • List the contents of the firmware download package. • Describe the overall download process. Section One Objectives

5. Why Use a Firmware Download? Overview Meter site visit not required • Saves utility significant man hours Access to new features in meter firmware • Ability to use middle of the minute (MOM) communications to ping a meter for current reads and expect a response within a minute Can download firmware to multiple meters simultaneously • Runs as a background process, quietly and non–intrusively on your network

6. Firmware Download Package Contents Overview A .zip file is provided containing the images needed to upgrade the meter components Contains an XML file (.xml) and the firmware file (.upg) • Describes the parameters around the Bootflasher component upgrade • Bootflasher upgrades the boot-loader on the meter • Specifies parameters around the download process • Such as how often to try loading the image blocks before calling it a failure

7. Sensus XML File Example Overview <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <SessionModules> <modules> <modules> <fileType>BootFlasher</fileType> <fileName>blinker_water_2.upg</fileName> <pauseInBetweenPhases>false</pauseInBetweenPhases> <waitBetweenCommands>0</waitBetweenCommands> <version>B0.0.0A</version> <uploadOrder>0</uploadOrder> <nTimesEachLoadBlock>6</nTimesEachLoadBlock> <loadStartType>1</loadStartType> <na2wEarlyStartInSecond>57</na2wEarlyStartInSecond> <na2wUploadInterval>6</na2wUploadInterval> <na2wStartTime>2013-06-08T12:16:00-04:00</na2wStartTime> </modules> </modules> <pauseBetweenSession>false</pauseBetweenSession> <noAckNeeded>true</noAckNeeded> </SessionModules>

8. Water and Gas Firmware Download Process Firmware Download Process

9. 1. Initial Validation Firmware Download Process Download engine verifies the firmware package Queries the RNI to determine which meters are going to participate • Is endpoint operating in two-way mode • Is endpoint firmware a prior version of the firmware to be downloaded • Total number of endpoints that can be included in this job

10. 2. Load Start Firmware Download Process Communicates with each endpoint using unicast messages to determine readiness to receive download and provide a start time for the download Each endpoint that successfully responds within a 24-hour period • Has its state set to SUCCEEDED_LOADSTART , and • Is included in the download Each endpoint that does not successfully respond • Triggers a failure of this phase • Has its state set to FAILED_LOADSTART, and • Is not included in the download, even if met pre-check requirements

11. 3. Load Block Firmware Download Process Schedules the download of the load blocks Each endpoint turns on its receiver at the start time Load block messages are transmitted to the individual endpoint or through the broadcast address to all Base Stations for transmission to multiple endpoints Each load block contains one block of the firmware image Multiple blocks are required to complete an entire firmware image download

12. 3. Load Block (Continued) Firmware Download Process When all blocks have been sent, each endpoint returns a load image check response indicating how many image blocks were missed Endpoint state is set accordingly: • Zero missing blocks = SCHEDULED_LOADFLASH • Less than 10 missing blocks = missing blocks resent • More than 10 missing blocks = FINISHED_CANNOT_CONTINUE • No response = SCHEDULED_LOADIMAGECHECK

13. 4. Load Image Check Firmware Download Process Rechecks endpoints that did not respond during the load image block phase After waiting four hours (configurable) after the last block was sent, the load image check command is sent to all endpoints with the SCHEDULED_LOADIMAGECHECK state Endpoint state is set accordingly: • Zero missing blocks = SCHEDULED_LOADFLASH • Less than 10 missing blocks = missing blocks resent • More than 10 missing blocks = FINISHED_CANNOT_CONTINUE • No response = load image check command is resent

14. 5. Load Flash Firmware Download Process Loads the firmware blocks into the endpoint flash On receipt of a message from endpoints in the SCHEDULED_LOADFLASH state, RNI sends load flash command causing endpoint to overwrite the old firmware with the new firmware Endpoint state is set accordingly: • Successfully loaded new firmware = SUCCEEDED_LOADFLASH • Failed to load new firmware = FAILED_LOADFLASH • No response = load flash command is resent

15. 6. Version Verification Firmware Download Process On successful completion of a FW download, the endpoint does not provide the RNI with the updated version information immediately Version information is sent in the next Binding message, which may take up to two weeks for all meters that were updated To obtain confirmation more quickly, issue a Binding ping from the Reprogramming page at Administration > Meter > Reprogramming

16. Water and Gas Firmware Download Summary Firmware Download Process Initial Validation Load Start ManualRetry Failed Load Start Rebroadcast missing blocks Load Block Finished Cannot Continue Missing MORE than 10 blocks Missing LESS than 10 blocks Load Image Check Load Flash Manual Retry Failed Load Flash Successful Download Version Verification

17. Firmware Download Process Uses Two Message Types Firmware Download Process Unicast Messages • Used to initiate the download and to verify completion • Sent from the RNI to a specific Base Station then on to a specific meter • Uses the routing information stored in the RNI, employing buddies as needed BroadcastMessages • Used to transmit the firmware blocks • Sent from the RNI to all Base Stations and from there on to every meter in range • No routing or meter specific information is required

18. Firmware Download Impact on the RF Network Firmware Download Tips Setting your Base Stations to sync transmit mode before attempting firmware download greatly reduces the run duration • Sync mode supports 3600 msgs/hour • Dither mode supports 1800 msgs/hour Using the Tower Graphs, and viewing all outbound traffic aids in determining the percentage of bandwidth available for FWDL • By default, 180 unicast/broadcast messages can be sent per hour using ~5% of a synchronized system versus ~10% of a dithered system Base Stations must have functional GPS devices to use sync transmit mode

19. Network Utilization for Base Station in Sync Transmit Mode Firmware Download Tips

20. Performing Water/Gas Firmware Downloads Section Two

21. List the tasks to be performed prior to beginning the download process. • Indicate where to follow the download process as it runs. • Determine which meters have failed to update their firmware. Section Two Objectives

22. Three-Step Firmware Download Process Electric Meter Firmware Download 1 3 2

23. Firmware Download Preparation 1 Firmware Download Preparation Acquire FWDL file Meters must be in installed state and have been heard at least once Temporarily disable the water/gas migration flags Understand the priority of FWDL versus other processes running • Know your network usage

24. Firmware Download Preparation (Continued) 1 Firmware Download Preparation Verify: • Base Stations are in sync mode for faster download speeds • All FlexNet components are time-synced • NA2W endpoints are operating in Fixed Based Listen after Transmit (FB LAT) mode and communicating in two-way mode Be aware: • Cannot rollback to prior firmware version, must re-download older firmware • Cannot pause or restart process • Manual retry is required when failures occur

25. Initiating a Water/Gas Firmware Download: Steps 1-3 Initiate Download Click Tools > NA2W Firmware Download 2 2. Select the firmware package (.zip file) to be distributed, or enter the filename directly 3. Enter a text string that briefly describes or otherwise identifies this firmware upgrade

26. Initiating a Water/Gas Firmware Download: Steps 4-5 Initiate Download 2 4. Select Single Meter or Broadcast (all meters) 5. If you chose Single Meter, enter the FlexNet ID of that meter; otherwise leave blank

27. Initiating a Water/Gas Firmware Download: Steps 6-7 Initiate Download 2 6. Select Automatic to use RNI routing information 7. Select 1 for new downloads and 0 if this is a retry from a prior download

28. Initiating a Water/Gas Firmware Download: Steps 8-9 Initiate Download 2 8. Enter date and time to start the download 9. Click Download

29. Recommended Setting for NA2W Load Block Start Time 2 For Broadcast to large number of meters: • Set start time to 48 hours or greater to allow the meters to receive the required firmware package before they perform the load and attempt to save to flash For Broadcast to small number of meters or for download to single meters: • Set start time to be no less than the Supervisory Transmit Rate to be sure that the firmware is sent during the next scheduled supervisory message (since meters in LAT mode only respond to remote requests during this time) Initiate Download

30. Monitoring the Firmware Download: Step 1 3 Monitor Download Click Pending Sessions to display the upload sessions that are either in process or have been stopped without completion • For in-process downloads, you can click Cancel to cancel the session • For sessions that have failed, you can click the Resume button to resume the process or Cancel to cancel the session

31. Monitoring the Firmware Download: Step 2 3 Monitor Download Click the text link in the Description column to view the session details

32. Monitoring the Firmware Download: Step 2 (Cont’d) 3 Monitor Download Retry the session, if needed, by selecting the state at which to reenter the process from the Resubmit State drop-down • Previous State, Load Start, Load Block, Load Image Check, Load Flash, Version Verify Click the Retry button to restart the session at the selected state

33. Monitoring the Firmware Download: Step 3 3 Monitor Download Click Finished Sessions to view which sessions have passed or failed the download process • DONE = Unable to complete download process; • SWITCHED = Completed download process for at least a portion of the designated devices

34. Monitoring the Firmware Download: Step 4 3 Monitor Download Click the text link in the Description column to view the session details

35. Monitoring the Firmware Download: Step 4 (Cont’d) 3 Monitor Download

36. Research and Retry Failed Meters 3 Monitor Download FWDL specific: /var/log/flexnet/firmwaredownload.log Other helpful logs: /var/log/flexnet/twoway.log /var/log/flexnet/error-warnings.log /var/log/flexnet/debug.log • Create a new firmware download job with the list of failed endpoints and modify the advanced options by choosing more iterations for the phase that failed

38. After a FWDL job completes, where is the best place to get a job report that includes a downloadable list of meters that failed to upgrade? • Check in the master FlexNet database • Call 1-800-GIVE2ME • Manually sending a ping to all of your meters • Navigate to the FWDL Finished Sessions page in the FlexWare interface

39. Identify a reason a meter could fail to upgrade during a firmware download. • Meter was not installed in RNI • Migration flags were not disabled • Meter was already upgraded and wasn’t included in the job • All of the above

40. Which of the following are components of the firmware download package: • Bootflasher firmware file and the .zip file • Firmware upgrade file and the .xml file • Bootflasher .zip file and the .xml file • Firmware upgrade file and the Bootflasher file

41. Which phase of the download process is responsible for sending the image blocks to the meter(s)? • Load Start • Load Block • Load Image • Verify Version

42. Before broadcasting blocks of firmware to water meters, it is best to set a significant delay to the NA2W load block start time. Doing so allows water meters a chance to check in and inform the FWDL engine of their next listen after talk time. • True • False