User`s guide

MASSA PRODUCTS CORPORATION
Product Manual- April 24, 2012 11 M3 Wireless Ultrasonic Level Sensor
3.0 Operating Modes for Gateway and Sensor
3.1.23 Dia.yml Settings Description – Program Sensor Firmware
The setting “program_m3_firmware_file” in the dia.yml file is used upload sensor firmware. The firmware will need to
be loaded into the Python manage files memory prior to activation. Leaving this control line out of the dia.yml, blank
value, or incorrectly typed filename or incorrect model number within filename will not perform this function. Values:
firmware bin files, see www.massa.com. Enclose with quotes.
program_m3_firmware_file: 'M3-150V31-21.bin' (example)
NOTE: If the sleep setting is not enabled, the gateway will restore the previously stored sleep setting after firmware programming.
If a gateway power cycle were to occur during programming, the sleep setting will be set to zero. It is recommended that if this
setting is enabled, the 'sleep_interval_sec' also be enabled and value set to your application so it is properly restored.
3.1.24 Dia.yml Settings Description – Sensor XBee Keep Awake command
The setting “keep_xbee_awake” in the dia.yml file will keep the sensor’s XBee awake for 5 minutes so that XBee
firmware can be uploaded. User must first go to Digi’s “XBee Configuration - OTA Firmware Update Setup” UI and
load the XBee firmware (ebl file). See section 3.2.6 for XBee firmware upload procedure. Leaving this control line out
of the dia.yml, blank value, or incorrectly typed setting value will not perform this function. Select 'true' or 'false'.
Enclose with quotes. NOTE: If this setting is enabled, then ALL OTHER settings within the yml are disabled for the
sensor.
keep_xbee_awake: 'false'
3.1.25 Dia.yml Settings Description – Clear Sensor Errors
The setting “clear_errors” in the dia.yml file will clear the sensor’s error register. Select 'true' to clear all errors. Error
codes are: bit0 = sensor configuration register replaced with default, bit1 = sensor detection fault, bit2 = temperature
probe fault, bit3 = brown out fault, and bit4 = power supply low. Select 'true' or 'false'. Enclose with quotes.
clear_errors: 'false'
3.1.26 Dia.yml Settings Description – Reboot Sensor
The setting “reboot_sensor” in the dia.yml file will restart sensor including resetting its XBee radio. This setting needs
to be enabled Xbee firmware programming and should the only setting enabled. It is not necessary to reboot the sensor
with any other sensor setting change. Select 'true' to enable this feature. Select 'true' or 'false'. Enclose with quotes.
reboot_sensor: 'false'
3.1.27 Dia.yml Settings Description – Status Output Logging of Sensor’s Automated Messages
The setting “log_status” in the dia.yml file will create a log file stored in the gateway’s python files named
“status_log.txt” that will record the sensor’s automated status messages. Only the most recent record in the automated
message will be recorded in this file. The file will append each new message. Use this feature for initial evaluation and
disable it once the application has been validated since memory space is limited. Select 'true' to enable this feature.
Enclose with quotes.
log_status: 'false'
Sample output:
Sensor 00:13:a2:00:40:54:da:6a!: Dist=26.5" Temp=-3.6C Batt=4.8V UltrasonicStrength=75% RadioSignal=VeryStrong Event=377 2012-02-13 09:41:16
3.1.28 Dia.yml Settings Description – Dia Log for Sensor Settings
The setting “log_dia” in the dia.yml file will create a log file stored in the gateway’s python files named “dia_log.txt”
that will report the sensor’s settings. Sleeping sensors will respond upon awake. This file will include the python
driver version. Select 'true' to enable this feature. Enclose with quotes.
log_dia: 'false'
NOTE: This feature will temporarily set sensor’s sleep setting (sleep_interval_sec) to zero and then restore it to the value previously
set in the sensor or if the sleep setting is enabled in the dia.yml, it will update to the new setting.