Action Commands
The Veva III supports several action commands to trigger file uploads, reset the device, or update device firmware.
Configuration File Management Commands¶
| Command | Option | Value | Description |
|---|---|---|---|
| CFG | APPLY | When changing settings using indivdual commands via a terminal emulator or sendCommand API method, settings take immediate affect but are not permanently written to the master configuration file. In the event the device is reset or power cycled, those changes will be lost. Use this command to make those changes permanent. | |
| CFG | DOWNLOAD | Triggers the device to download the full configuration file from the FTP server. This command is useful after modifying the configuration file using a text editor. Configuration changes made in this manner are permanent and do not require a CFG APPLY command. | |
| CFG | SNAP | Trigger the device to upload the full configuration file to the FTP server. This command is useful if you wish to modify the configuration file using a text editor. | |
| CFG | SAVE | {name} | Creates a saved configuration based on the current settings (eg. cfg save test). |
| CFG | SWITCH | {name} | Loads and activates a saved configuration file (eg. cfg switch test). |
Perform a reset when using SAVE and SWITCH optoins
Issue a reset sensor command after switching to a saved configuration.
File Management Commands¶
| Command | Option | Value | Description |
|---|---|---|---|
| PEAK | SNAP | Dumps the PPV histogram buffer to file and uploads to the http or ftp server. | |
| BEAT | SNAP | Dumps the tilt heartbeat buffer to file and uploads to the http or ftp server. | |
| LOG | SNAP | Dumps the log buffer to file and uploads to the http or ftp server. | |
| FILES | PEAK | Returns the number of PPV histogram files awaiting upload to the http or ftp server. | |
| FILES | VIBR | Returns the number of vibration alarm event and waveform files awaiting upload to the http or ftp server. | |
| FILES | TILT | Returns the number of tilt alarm event and data files awaiting upload to the http or ftp server. | |
| FILES | BEAT | Returns the number of tilt heartbeat files awaiting upload to the http or ftp server. | |
| FILES | LOG | Returns the number of log files awaiting upload to the http or ftp server. | |
| SEND | PEAK | {n} | Queues awaiting PPV histogram files for upload to the http or ftp server. n is an optional number where a negative value (eg. -2) will send the most recent n files. A positive number will send the oldest n files.eg. send peak -2 |
| SEND | PEAK | yy[mm[dd]] | Queues awaiting PPV histogram files for upload to the http or ftp server optionally using a date with these parameters: yy = year (00 = all years) mm = month (00 = all months within specified year) dd = mday (00 = all days within specified month) eg. send peak 230916 sends all log files for Sept. 16, 2023 |
| SEND | VIBR | {n} | Queues awaiting vibration or audio alarm event and waveform files for upload to the http or ftp server. n is an optional number where a negative value (eg. -2) will send the most recent n files. A positive number will send the oldest n files.eg. send vibr -2 |
| SEND | VIBR | yy[mm[dd]] | Queues awaiting vibration or audio alarm event and waveform files for upload to the http or ftp server optionally using a date with these parameters: yy = year (00 = all years) mm = month (00 = all months within specified year) dd = mday (00 = all days within specified month) eg. send vibr 230916 sends all log files for Sept. 16, 2023 |
| SEND | TILT | {n} | Queues awaiting tilt alarm event and data files for upload to the http or ftp server. n is an optional number where a negative value (eg. -2) will send the most recent n files. A positive number will send the oldest n files.eg. send tilt -2 |
| SEND | TILT | yy[mm[dd]] | Queues awaiting tilt alarm event and data files for upload to the http or ftp server optionally using a date with these parameters: yy = year (00 = all years) mm = month (00 = all months within specified year) dd = mday (00 = all days within specified month) eg. send tilt 230916 sends all log files for Sept. 16, 2023 |
| SEND | BEAT | {n} | Queues awaiting tilt heartbeat files for upload to the http or ftp server. n is an optional number where a negative value (eg. -2) will send the most recent n files. A positive number will send the oldest n files.eg. send beat -2 |
| SEND | BEAT | yy[mm[dd]] | Queues awaiting tilt heartbeat files for upload to the http or ftp server optionally using a date with these parameters: yy = year (00 = all years) mm = month (00 = all months within specified year) dd = mday (00 = all days within specified month) eg. send beat 230916 sends all log files for Sept. 16, 2023 |
| SEND | LOG | {n} | Queues awaiting log files for upload to the http or ftp server. n is an optional number where a negative value (eg. -2) will send the most recent n files. A positive number will send the oldest n files.eg. send log -2 |
| SEND | LOG | yy[mm[dd]] | Queues awaiting log files for upload to the http or ftp server optionally using a date with these parameters: yy = year (00 = all years) mm = month (00 = all months within specified year) dd = mday (00 = all days within specified month) eg. send log 230916 sends all log files for Sept. 16, 2023 |
| CLEAN | PEAK | Removes any PPV histogram files from device. | |
| CLEAN | VIBR | Removes any vibration alarm event files from device. | |
| CLEAN | TILT | Removes any tilt alarm event files from device. | |
| CLEAN | BEAT | Removes any pending tilt heartbeat files from device. | |
| CLEAN | LOG | Removes any log files from device. | |
| CLEAN | MICROSD | Reformats the microSD card. Useful when deploying device on a new project to remove any remaining files from the previous project. This command should be used with caution when connecting the sensor to Inzwa's cloud services | |
| CULL | LOG | yy[mm[dd]] | Removes log files from the device using a date with these parameters: yy = year (00 = all years) mm = month (00 = all months within specified year) dd = mday (00 = all days within specified month) eg. cull log 230916 removes all log files for Sept. 16, 2023 |
Over-The-Air-Programming (OTAP) Commands¶
The Veva III has the ability to update its firmware remotely using these commands.
| Command | Option | Value | Description |
|---|---|---|---|
| OTAP | MAIN | Number | Download device's main module firmware from the FTP server, specifying the version number. For example, issue OTAP MAIN 50056 to upgrade to version 5.0.56. After the device downloads the new firmware, it will automatically restart the device. |
| OTAP | MIC | Number | Download microphone firmware from the FTP server, specifying the version number. For example, issue OTAP MIC 20108 to upgrade to version 2.1.8. |
| Command | Option | Value | Description |
|---|---|---|---|
| OTAP | MAIN | Number | Download device's main module firmware from the FTP server, specifying the version number. For example, issue OTAP MAIN 40408 to upgrade to version 4.4.8. After the device downloads the new firmware, it will ask you to reset the device using RESET {MAC} command. |
| OTAP | SENSOR | Number | Download device's sensor module firmware from the FTP server, specifying the version number. For example, issue OTAP SENSOR 40408 to upgrade to version 4.4.8. After the device downloads the new firmware, it will ask you to download the main firmware with a OTAP MAIN command. |
Power and Battery Commands¶
| Command | Option | Description |
|---|---|---|
| NEWBAT | {mAh} | Resets the battery capacity in mAh. Reset this value after chaning device batteries. e.g. NEWBAT 52000 |
| CFG PWRSAVE | on or off | Some network providers or even certain bands continually communicate with the device causing unecessary power drain. The power save command turns off the radio completely and wakes up every five minutes to check if there are any SMS or MQTT COMMAND queue messages awaiting repsponse. |
| PWROFF | Powers down the device remotely | |
| POWER CYCLE | Power cycle remotely powers down, then restarts the device. A power cycle is different from a reset in that the device is completely turned off before it is restarted. The reset command is a warm reset, while the power cycle is a cold reset. This feature is not available on all Veva III E01 or W01 devices |
| Command | Option | Description |
|---|---|---|
| NEWBAT | {mAh} | Resets the battery capacity in mAh. Reset this value after chaning device batteries. e.g. NEWBAT 52000 |
| CFG PWRSAVE | on or off | Some network providers or even certain bands continually communicate with the device causing unecessary power drain. The power save command turns off the radio completely and wakes up every five minutes to check if there are any SMS or MQTT COMMAND queue messages awaiting repsponse. |
| PWROFF | Powers down the device remotely |
Reset Commands¶
| Command | Option | Description |
|---|---|---|
| RESET | SENSOR | Resets the device's sensor module. |
| RESET | {MAC} | Resets the device's main module as well as the sensor module. MAC is the device's serial number. e.g. RESET abc123 |
| RESET | SEQ | Resets sequence numbering used in histogram and alarm event file names to zero. |
| RESET | Modem | Resets the modem. Use after changing modem configuration properties. |
Time Synchronization Commands¶
The Veva III synchronizes it's clock to the cellular network each time it boots. You can force a time update by issuing a time command.
Last update: November 1, 2024