Skip to content

General Commands

All configuration commands follow a simple command structure:

cfg <option> <parameter> [value]

Commands omitting the value parameter return the current configuration setting.

Commands are case-insensitive

Capitalization is used in the documenation to denote device options and parameters.

After changing configuration values, issue a 'cfg apply' command for changes to be permanently stored by the device. Otherwise, changes will be reverted to the last permanently stored values when the device is reset or turned off. See the Configuration File Management Commands section for more details.

When configuring the device using a terminal emulator, it can be helpful to see verbose log output when changing the device configuration. After making a connection using a terminal emulator, issue the commands 'log con on', then 'log i' to turn on verbose output to the terminal. See Logging Commands for more infomation

Main Commands

Select your model to display proper commands

Option Parameter Value Description
MAIN SERIAL 20 Character String Populated with device serial number. Changes will be overwritten. Treat as a read-only field.
MAIN VER_MAJ 0 to 255 User defined major version number for the configuration file.
MAIN VER_MIN 0 to 255 User defined minor version number for the configuration file.
MAIN DATE 12 Character String User defined modified date of the configuration file. Used by Inzwa Cloud to track revisions.
MAIN NUMBER 12 Character String Populated with phone number of installed SIM, if any. Changes may be overwritten. Treat as a read-only field.
MAIN LOCATION 64 Character String If GPS is active, device will populate this field with latitude, longitude and elevation (eg. "40.7484,-73.9857,234"). If GPS is not active, this is a user defined field.
MAIN NTP_URL 64 Character String IP address or domain name of an NTP server. Defaults to Google's Time Server.
MAIN NTP_PORT 0 to 65535 NTP server port. Normally set to 123.
MAIN NTP_TZ -96 to 96 Specifies the timezone of the device's location. Use 1 for every 15 minutes of offset from UTC. Note, this value will be automatically updated to the local timezone when current time is acquired from cellular network.
MAIN NTP_TIME 0 or false
1 or true		 When true, device uses NTP server over the cellular network for time information. NTP_URL nad NTP_PORT should be set. When false, device will attempt to acquire time information from cellular network before the NTP server. Default is false.
MAIN WAIT_FOR_TIME 0 or false
1 or true		 When true, device will wait until it has acquired a valid time within 3 years of the firmware build time before acquiring vibration, tilt or sound data. This is to prevent data files being written with invalid timestamps. Default is false.
MAIN LOG I,W or E Sets the logging filter to (I)nformation, (W)arning or (E)rror. We do not recommend setting this parameter to I in production as it will generate many log messages and result in a shortened battery life. See the logging commands section for more information. Default is W.
MAIN BAT_WARN 1 to 99 Trigger level, as a percentage, for device to send battery warning messages, either by SMS or MQTT. Default is 25.
MAIN SEND_ALERT 0 or false
1 or true		 When true, vibration and tilt alert event summary files are uploaded. False retains alert files on device. Default is true.
MAIN SEND_PEAK 0 or false
1 or true		 When true, vibration histogram files uploaded to FTP server. False retains peak files on device. Default is true.
MAIN SEND_BEAT 0 or false
1 or true		 When true, tilt beat files uploaded to FTP server. False retains files on device. Default is true.
MAIN SEND_DATA 0 or false
1 or true		 When true, vibration waveform files uploaded to FTP server. False retains waveform files on device. Default is true.
MAIN SEND_CFG 0 or false
1 or true		 When true, a copy of the config file is uploaded to FTP server when vibration histogram files are uploaded. False doesn’t send a copy to the FTP server when PPV histogram files are uploaded. Default is false.
MAIN CHECK_CFG 0 or false
1 or true		 When true, the device will check for, and download, a new configuration file when it uploads a vibration histogram file to the FTP server. False doesn’t check for new configuration file. Default is true.
MAIN SEND_LOG 0 or false
1 or true		 When true, log files uploaded to FTP server. False retains log files on the device. Default is false.
MAIN SEND_SMS 0 or false
1 or true		 When true, SMS messages will be sent to all enabled SMS phone numbers. False doesn’t send any SMS messages. This setting doesn't affect the device's response to direct commands. If using Inzwa's SIM or platform services, please be cautious about changing this value. You may affect those system's abilities to control the device or respond to alarm events. Default is false.
MAIN GSM_OFF 0 or false
1 or true		 When true, device will not connect to cellular network. All collected data will be stored on the device until the device is allowed to connect by setting this value to false. This value should only be set to false by using a terminal emulator connected via the USB port. Default is false.
MAIN WIFI_OFF 0 or false
1 or true		 When true, device will not connect to WiFi network. All collected data will be stored on the device until the device is allowed to connect by setting this value to false. This value should only be set to false by using a terminal emulator connected via the USB port. Default is false.
MAIN BT_OFF 0 or false
1 or true		 When true, device will activate Bluetooth networking. Use the BLUE field in the Scheduling Section to control the time-of-day Bluetooth is active. Default is false.
MAIN MIC_OFF 0 or false
1 or true		 When true, device will activate the Microphone, if connected. Default is false.
MAIN MQTT_OFF 0 or false
1 or true		 When true, device will activate the MQTT Communications. See the MQTT Section for futher configuration. Default is false.
MAIN WAIT_FOR_TIME 0 or false
1 or true		 When true, device will wait for a valid time before begining to take measurments. The device checks its internal clock to see if it is within 3 years of the current build time. If not, it waits until it gets a time from the cellular modem, NTP, Wi-Fi, or user command before it begins monitoring. Default is false.
Option Parameter Value Description
MAIN SERIAL 20 Character String Populated with device serial number. Changes will be overwritten. Treat as a read-only field.
MAIN VER_MAJ 0 to 255 User defined major version number for the configuration file.
MAIN VER_MIN 0 to 255 User defined minor version number for the configuration file.
MAIN DATE 12 Character String User defined modified date of the configuration file. Used by Inzwa Cloud to track revisions.
MAIN NUMBER 12 Character String Typcially populated with phone number of installed SIM, if any. The device does not populate this field automatically.
MAIN LOCATION String User defined containing latitude, longitude and elevation in a command delimited string (eg. "40.7484,-73.9857,234").
MAIN NTP_URL 64 Character String IP address or domain name of an NTP server. Defaults to Google's Time Server.
MAIN NTP_PORT 0 to 65535 NTP server port. Normally set to 123.
MAIN NTP_TZ -96 to 96 Specifies the timezone of the device's location. Use 1 for every 15 minutes of offset from UTC. Note, this value will be automatically updated to the local timezone when current time is acquired from cellular network.
MAIN LOG I,W or E Sets the logging filter to (I)nformation, (W)arning or (E)rror. We do not recommend setting this parameter to I in production as it will generate many log messages and result in a shortened battery life. See the logging commands section for more information. Default is W.
MAIN SEND_ALERT 0 or false
1 or true		 When true, vibration alert event summary files uploaded to FTP server. False retains alert files on device. Default is true.
MAIN SEND_PEAK 0 or false
1 or true		 When true, vibration histogram files uploaded to FTP server. False retains peak files on device. Default is true.
MAIN SEND_BEAT 0 or false
1 or true		 When true, tilt beat files uploaded to FTP server. False retains files on device. Default is true.
MAIN SEND_DATA 0 or false
1 or true		 When true, vibration waveform files uploaded to FTP server. False retains waveform files on device. Default is true.
MAIN SEND_CFG 0 or false
1 or true		 When true, a copy of the config file is uploaded to FTP server when vibration histogram files are uploaded. False doesn’t send a copy to the FTP server when PPV histogram files are uploaded. Default is false.
MAIN CHECK_CFG 0 or false
1 or true		 When true, the device will check for, and download, a new configuration file when it uploads a vibration histogram file to the FTP server. False doesn’t check for new configuration file.
MAIN SEND_LOG 0 or false
1 or true		 When true, log files uploaded to FTP server. False retains log files on the device. Default is false.
MAIN SEND_SMS 0 or false
1 or true		 When true, SMS messages will be sent to all enabled SMS phone numbers. False doesn’t send any SMS messages. This setting doesn't affect the device's response to direct commands. If using Inzwa's SIM or platform services, please be cautious about changing this value. You may affect those system's abilities to control the device or respond to alarm events. Default is false.
MAIN GSM_OFF 0 or false
1 or true		 When true, device will not connect to cellular network. All collected data will be stored on the device until the device is allowed to connect by setting this value to false. This value can only be set to false by using a terminal emulator connected via the USB port.

Scheduling Commands

Option Parameter Value Description
SCHED STATUS DD:HH:MM:SS Sets the polling interval for checking the status of the sensor module. Default is “00:00:05:00” We recommend setting this to 5 minutes or more to avoid excessive activity.
SCHED RESET DD:HH:MM:SS Sets the interval at which the cellular modem will be reinitialized. This can help recover a lost connection in case the network operator forces periodic disconnects. Default is “00:08:00:00” Minimum value is 30 minutes. We recommend setting to more than eight hours to reduce power consumption from network activity.
SCHED PEAK DD:HH:MM:SS Sets the interval between peak histogram buffer uploads to the FTP server. Default is “00:04:00:00” Minimum value is 30 minutes. We recommended setting to more than four hours to reduce power consumption from network activity.
SCHED BEAT DD:HH:MM:SS Sets the interval between tilt heartbeat file buffer uploads to the FTP server. Default “00:04:00:00” Minimum value is 30 minutes. We recommended setting to more than four hours to reduce power consumption from network activity.
SCHED ACTIVE HH:MM,HH:MM Start and end time device should be actively monitoring. When device is operating on external power, this setting is ignored. Default “00:00,00:00” (disabled)

For Veva III - E01 and W01 models, the scheduler uploads PEAK and BEAT files beginning at midnight. Therefore, a four hour schedule will upload files at 4 a.m., 8 a.m., etc.

Last update: July 26, 2024