The commands and queries noted throughout this section are valid via the "command console" (see section 6.3), and in most cases via SMS. Commands not valid via SMS are noted as such, but otherwise you can use these commands remotely. In most cases, you will need to "unlock" your session before you can use the commands remotely (see section 9.2).
sys site=”Site Name”
Sets site name that may optionally be included in SMS messages. The name must be a quoted string.
show
Show summary of device configuration
show cell
Show information and status about the cellular connection, including CCID of the SIM card, phone number, signal strength, and last received SMS message if any. Signal strength will be indicated as a number in the range of -51 dBm to -113 dBm with -51 being a perfect signal and -113 being call-dropping bad.
show uptime
Shows the time in seconds since the last restart, and also shows the restart reason code.
send sms=6514264410,message=”Test SMS message”
Will send the given quote delimited message to the SMS number provided. Used as a diagnostic to test whether the modem is sending text messages.
sys run
Will exit configuration mode and begin operation according to whatever device has been configured to do. For Modbus RTU, the serial port will begin running the RTU protocol. For Modbus TCP, protocol operation will begin via the TCP connection, but the console will remain open to commands via the serial port, except that API mode is disabled. Note that the run command is assumed and executed automatically within 10 seconds of startup if no other valid command is received. (Note: This is the command sent to the VP3-TM by the configuration tool when you click the Run Device button. This also happens automatically after 10 seconds if you do not go into configuration mode on the device.)
sys reboot=server
sys reboot=all
Restarts iReport’s IP server if applicable when “server” is indicated. Restarts entire device if “all” is given. Note that any open or active sessions are terminated.
sys resync
Resets the 24-hour timer for daily reporting of objects whose reportdaily option has been enabled. (see “obj n,reportdaily=…”)
sys clear=objects
sys clear=users
sys clear=groups
sys clear=protocol
sys clear=all
sys clear=confirm (NOT valid via SMS)
Used in sequence to clear some or all parts of the device configuration. If “clear=objects”, then all object configuration will be cleared, but not users or groups (unless they are also selected). If “clear=all”, then everything will be cleared. Note, however, that the clear operation does not actually take place until a second command, “clear=confirm”, is sent. If any command other than another “sys clear” is sent before the “clear=confirm”, then the clear is entirely cancelled. This is to avoid accidentally wiping out the entire device with one errant command. The clear command is not available via SMS. The entire device can only be cleared via the console (or configuration tool).
sys scanning=stop
sys scanning=start (NOT valid via SMS)
The alarm scanner must be stopped before entering API mode. Use this command to stop and restart alarm scanning. The alarm scanner will default to being stopped while in configuration mode (using command console) and will automatically start when config mode is exited. In addition, protocol scanning is automatically stopped while in config mode, and automatically started when config mode is exited. It is not possible to have the protocol handler and command console running at the same time since they operate via the same communication port.
sys apimode (NOT valid via SMS)
Will enter API mode allowing console interaction directly with the cellular modem. Must exit API mode before console returns to recognizing normal console commands. API mode is not available via SMS. API mode is also not available once the “sys run” command has been issued. Note: This command should only be used upon advice from Control Solutions technical support.
obj 1,parameter=?
Will look up the value of the “parameter” given, e.g. alarm, and return the value via SMS. The session must be unlocked before the “obj” command is accessible.
query 1,parameter=?
Will look up the value of the “parameter” given, e.g. alarm, and return the value via SMS. The query command is available to recognized users who are not authorized for command access, and/or without unlocking the session.
ack 1/14
Will acknowledge alarm for object 1, sequence number 14.
obj 1,value=n.nnn
Will set the present value of the given object number to the value given. As with configuration changes, only users authorized to send commands, and who have unlocked their SMS session, may use this command via SMS. If the object is mapped for reading from Modbus or BACnet, then the value set by this command will most often be overwritten soon, but can be used to exercise alarms as a test while Modbus is not connected. If the object is mapped for writing to Modbus or BACnet, then using this command will result in a register being written in the Modbus device, or object written in the BACnet device. This provides the ability to remotely control Modbus or BACnet devices.
obj 1,relinquish=yes
Will result in the VP3-TM30 or VP3-TM70 sending a relinquish to the commandable object previously written at its configured command priority (as result of obj 1,value=n). This is only valid for BACnet objects, and only if configured to write to a commandable object. Issuing a relinquish to an object that is not writing to a commandable object will result in that object returning an error.
obj 1,value=?
obj 1,fault=?
Will display value or fault code for object specified, provided session is unlocked.
query 1,value=?
query 1,fault=?
Will display value or fault code for object specified even if user is locked out of command mode.
show obj 1
show obj first
show obj next 5
Will return an object’s name, present value, and alarm state. If only a number is given, then that object is returned. If “first” is given, then the first configured object will be returned, which would most often be object 1. If “next N” is given, the first configured object after object N is returned. The “next N” will most often simply return object N+1, but can be useful in searching for objects beyond some that may have been unconfigured.
show objconfig 1 (NOT valid via SMS)
Will return summary of object configuration listing all currently set parameters for that object. NOT valid via SMS since the reply would exceed SMS message length. Use individual parameter query to retrieve configuration via SMS.
show objlist
Will return the list of objects as known to BACnet. They will be either AV or BV, or not included in the list because they are unconfigured. NOT valid via SMS. Valid only via the console (BACnet versions only).
show alarms first
show alarms next 5
show alarms all (NOT valid via SMS)
Will produce an single-line summary of active alarms. When “first” is specified, the first object having an alarm is provided. When “next N” is given, the first object in alarm after object N is provided. The combination of first/next allows effectively scanning through the alarm list via SMS. For example, if “first” provided an alarm message about object 5, then the next query would be “next 5” to start checking for more alarms starting at object 6. If “all” is specified, a multi-line list of all active alarms is generated - the "all" option is valid only via the console, NOT valid via SMS.
report Fuel tank
Will search objects for an object named “Fuel tank” and return that object as if “show obj n” had been sent, except object number will also be included for reference. This name search will be case insensitive, therefore objects should not use the same name with variations on capital versus lower case (e.g. FUEL TANK, Fuel Tank, and fuel tank are all the same name).
show objerrors first
show objerrors next 4
Show next object having a non-zero reliability code starting at first, or in second example, first object after object 4. Defaults to first if no parameter given.
obj 1,unconfigure=yes
Will mean clear all configuration for object number 1.
obj 1,reset=yes
Will cause object to get reinitialized, zero out data, reset any active alarms, and so forth.
show user 1
show user 1 10 (NOT valid via SMS)
show user (NOT valid via SMS)
Will show phone book entries for a single user, a range of users, or all users with valid entries in the phone book. Only the single user instance is valid via SMS, other variations are for console use only. With no user number specified, all users will be listed (not valid via SMS).
show usererrors first
show usererrors next 2
Will return a message indicating error information by user number pertaining to failure to send SMS messages to that user.
user 1,unconfigure=yes
Will mean clear all configuration for user number 1 effectively removing them from the phonebook. User number may be 1 to 50.
show group 1
show group (NOT valid via SMS)
Will show parameters for given group, or all groups. Only the single group instance is valid via SMS. With no group number specified, all groups will be listed.
group 1,unconfigure=yes
Will mean clear all configuration for group number 1. Group number may be 1 to 8. This does not eliminate the group, it only clears all of its special qualifications and resets timers to zero. An "unconfigured" group will still send alarm messages.
show modbus
Displays Modbus port parameters. Not valid via SMS - query individual parameters, e.g. "mod baud=?".
show tcplist (NOT valid via SMS)
Displays Modbus TCP device list as set using tcpdev commands (Modbus TCP only, multi-line response not available via SMS).
show tcpdev 1
Displays single Modbus TCP device as set using tcpdev command (Modbus TCP only).
show server
Displays the firmware version in the server module, which will be different than the primary device firmware version indicated by the “show” command without any parameters. (Modbus TCP only)
show rtuerrors first
show rtuerrors next 3
show tcperrors first
show tcperrors next 2
show tcperrors server
Show first/next device having error counts. The TCP device will refer to TCP client. Use “server” to obtain counts for the TCP server. RTU can only be master or slave, not both (like TCP). If RTU is slave, then only “first” is valid and this will refer to the slave counts. (TCP is only valid for the TCP version of the device.)
mod rtuclear=1
mod tcpclear=2
mod tcpclear=server
Clear counts for RTU/TCP device number given, or for the TCP server. If RTU is slave, then “1” refers to the slave. (TCP is only valid for the TCP version of the device.) The clear command with no parameters will clear all counts. Counts include total message counts and all types of error counts.
show rtucounts 3
show tcpcounts 2
show tcpcounts server
Show message counts for RTU/TCP device number given, or for the TCP server. If RTU is slave, then “1” is the slave.(TCP is only valid for the TCP version of the device.)
mod macaddr=?
mod macaddr=00:40:9D:12:34:56
The macaddr=? may be used to see what the server’s MAC address is. It may be set using this command, but DO NOT USE THIS COMMAND without guidance from tech support. In rare cases, the MAC address can get reset to a default 00:40:9D:00:00:00. If this happens, you will need to recover the original MAC address from the bar code label on the server module and re-enter it. The first 3 fields must always be 00:40:9D and the remaining 3 fields should be restored to what is on the label.
mod rootpass=”buster”
Sets the server’s root password (only applicable to IP version). The only use for this password, which defaults to “buster”, is to update firmware in the server module.
show bacnet
Displays BACnet port parameters. Not valid via SMS - query individual parameters.
show server
Displays the firmware version in the server module, which will be different than the primary device firmware version indicated by the “show” command without any parameters. (Applies to IP only)
show objerrors first
show objerrors next 4
Show next object having a non-zero reliability code starting at first, or in second example, first object after object 4. Defaults to first if no parameter given.
bac macaddr=?
bac macaddr=00:40:9D:12:34:56
The macaddr=? may be used to see what the server’s MAC address is. It may be set using this command, but DO NOT USE THIS COMMAND without guidance from tech support. In rare cases, the MAC address can get reset to a default 00:40:9D:00:00:00. If this happens, you will need to recover the original MAC address from the bar code label on the server module and re-enter it. The first 3 fields must always be 00:40:9D and the remaining 3 fields should be restored to what is on the label.
bac rootpass=”buster”
Sets the server’s root password (only applicable to IP version). The only use for this password, which defaults to “buster”, is to update firmware in the server module.
Copyright © 2019 Control Solutions Minnesota, Inc.