Communications 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
Cellular Commands¶
Care should be taken when modifying a device's cellular configuration and should only be done by a techniciation famliar with cellular communications. Cellular commands should only be modified using a terminal session. Please contact support if you have specific cellular connectivity needs.
| Option | Parameter | Value | Description |
|---|---|---|---|
| GSM | APN | 32 Character String | Access Point Name associated with SIM provider. Do not change this value when using an Inzwa provided SIM. |
| GSM | APN_USR | 20 Character String | APN Login ID (if required). Do not change this value when using an Inzwa provided SIM. |
| GSM | APN_PWD | 20 Character String | APN Password (if required). Do not change this value when using an Inzwa provided SIM. |
| GSM | SCANSEQ | 10 Character String | Network Scan Sequence. Please refer to the SCANSEQ section for more details. Default is 0405030201. Do not change this value when using an Inzwa provided SIM. |
| GSM | SCANBAND | 32 Character String | Network Band Scan. The scanband command value comprises a three stanza, command separated value specifying bands to scan for the cellular technologies supported by the device. Please refer to the SCANBAND section for more details on specifying bands. The default value is 3ff,1E00B0E18DF,3f which selects all bands. Do not change this value when using an Inzwa provided SIM. |
| GSM | COPS | Character String | Network Device Register. The cops command directs the modem to specific carriers and access technology. Please refer to the COPS section for more details. The default value is 0. Do not change this value when using an Inzwa provided SIM. |
| GSM | IOTOPMODE | Integer value of 0, 1, or 2 | LTE Network Technology 0 - LTE Cat M1 1 - LTE Cat NB1 2 - LTE Cat M1 and M2 Do not change this value when using an Inzwa provided SIM. |
| GSM | SERVICE | Integer value of 0, 1, or 2 | Network Service 0 - Circuit Switched (2G and some 3G) 1 - Packet Switched (most 3G and LTE) 2 - Circuit and Packet Switched (default) Do not change this value when using an Inzwa provided SIM. |
| GSM | ROAMING | Integer value of 1, 2, or 255 | Roaming Type 1 - Off 2 - On 255 - Auto Do not change this value when using an Inzwa provided SIM. |
| Option | Parameter | Value | Description |
|---|---|---|---|
| MAIN | APN | String | Access Point Name associated with SIM provider. Do not change this value when using an Inzwa provided SIM. |
| MAIN | APN_USR | String | APN Login ID (if required). Do not change this value when using an Inzwa provided SIM. |
| MAIN | APN_PWD | String | APN Password (if required). Do not change this value when using an Inzwa provided SIM. |
| MAIN | SCANSEQ | 10 Character String | Network Scan Sequence. Please refer to the SCANSEQ section for more details. Default is 000000. Do not change this value when using an Inzwa provided SIM. |
| MAIN | SCANBAND | 32 Character String | Network Band Scan. The scanband command value comprises a three stanza, command separated value specifying bands to scan for the cellular technologies supported by the device. Please refer to the SCANBAND section for more details on specifying bands. The default value is f,400a0e189f,a0e189f which selects all bands. Do not change this value when using an Inzwa provided SIM. |
| MAIN | COPS | Character String | Network Device Register. The cops command directs the modem to specific carriers and access technology. Please refer to the COPS section for more details. The default value is 0. Do not change this value when using an Inzwa provided SIM. |
| MAIN | IOTOPMODE | Integer value of 0, 1, or 2 | LTE Network Technology 0 - LTE Cat M1 1 - LTE Cat NB1 2 - LTE Cat M1 and M2 Do not change this value when using an Inzwa provided SIM. |
M2M (SMS) Notification Commands¶
| Option | Parameter | Value | Description |
|---|---|---|---|
| SMS | 1 to 5 | 20 Character String | Sets the cell number for SMS notifications of alarm events. Phone numbers must begin with a '+' and country code. Up to 5 numbers can be managed. |
| SMS | ENx, where x is 1 to 5 | 0 or false 1 or true | The corresponding cellular number with an enable state of true will receive alerts from this device as they occur. Setting the enable state to false will disable alerts. |
| Option | Parameter | Value | Description |
|---|---|---|---|
| SMS | 1 to 5 | String,T/F | Sets the cell number and enable state for SMS notifications of alarm events. Phone numbers must begin with a '+' and country code. Up to 5 numbers can be managed. A cell number with an enable state of T will receive alerts from this device when they occur. Setting the enable state to F will disable alerts. |
M2M (SMS) notifications and Inzwa's platform services
- Inzwa's SIM service does not utilize cellular phone numbers so SMS messages can't be sent directly to cellular numbers from the device. A cellular number can be activated on your SIM if you wish to have this capability. Contact Inzwa for more information.
- You may notice a cellular number of 2936 configured on your device. Changing this value will affect the Inzwa platform's ability to notify users of alarm events. This cellular number should only be removed when not utilizing Inzwa's platform services.
Message Routing¶
Defines the message routing used to send messages to the end users or external systems. The default value is 'None' in all cases.
Do not change these parameters when using a device with Inzwa Cloud.
| Option | Parameter | Value | Description |
|---|---|---|---|
| ROUTE_MSG | IND | None, SMS or MQTT | Routing for informational messages. |
| ROUTE_MSG | EVENT | None, SMS or MQTT | Routing for vibrationm and tilt event messages. |
| ROUTE_MSG | ALARM | None, SMS or MQTT | Routing for other types of alarm messages. |
| ROUTE_MSG | PEAK | None or MQTT | Routing for periodic vibration readings. |
| ROUTE_MSG | BEAT | None or MQTT | Routing for periodic tilt readings. |
Message routing is not available for these models of the Veva III.
Notes on selecting the appropriate routing method
- SMS can only be used with the cellular communications module.
- MQTT can be used with either the cellular or WiFi communications modules.
- The MQTT_OFF configuration property in the Main Commands configuration must be set to
falsefor MQTT messages to be sent. - The SEND_SMS configuration property in the Main Commands configuration must be set
truefor SMS messages to be sent. - It's best to set the PEAK and BEAT parameters to MQTT when using external powwer with the Veva III otherwise battery life will be reduced.
- Setting PEAK and BEAT to MQTT will consume more cellular data especially if data is also uploaded via FTP or HTTP.
MQTT Commands¶
Do not change these parameters when using a device with Inzwa Cloud.
| Option | Parameter | Value | Description |
|---|---|---|---|
| MQTT | HOST | 128 Character domain name or IP address | Specifies the MQTT Broker Domain Name or IP Address. |
| MQTT | PORT | 0 to 65535 | Specifies the port used by the MQTT Broker. Default is 1883. |
| MQTT | QOS | 0, 1 or 2 | Specifies the Quality of Service. 0 = QoS 0 1 = QoS 2 2 = QoS 3 QoS must be set to 1 or 2 for COMMANDS to function properly. |
| MQTT | USER | String | Specifies the user name of the MQTT account. |
| MQTT | PWD | String | Specifies the password for the MQTT account. |
| MQTT | PUB_SAMP | String | The MQTT topic where the device publishes periodic vibration and tilt readings. |
| MQTT | PUB_ALERT | String | The MQTT topic where the device publishes alert messages. |
| MQTT | PUB_NOTIFY | String | The MQTT topic where the device publishes informational messages. |
| MQTT | PUB_REPLY | String | The MQTT topic where the device publishes responses to command messages recieved on the SUB_COMMAND topic. |
| MQTT | SUB_COMMAND | String | The MQTT topic where the device receivces command messages. |
MQTT is not available for these models of the Veva III.
WiFi Commands¶
The most convienient method to configure WiFi settings is to use a terminal emulator on your PC while the Veva III is connected using the USB cable. If you haven't installed a terminal emulator on your PC, please follow these instructions.
Once connected to the Veva III using the terminal emulator on your PC, use the appropriate commands below to configure for either personal or enterprise WiFi networks. Personal WiFi is the most comman and found in most homes and small businesses. Enterprise WiFi differs by authenticating a connection using a separate identity server on the enterprise network with the WPA2-Enterprise network protocol.
Use the 'net scanssid' command to view a list of available networks (SSID), security protocols and the received signal strength (RSSI) for each network. This command is effective when the wifi modem settings are incorrect.
After configuring the appropriate WiFi parameters, issue a 'cfg apply' command to permaently save your settings. Then issue a 'reset wifi' command to attempt a connection."
Personal WiFi Network Commands¶
| Option | Parameter | Value | Description |
|---|---|---|---|
| WIFI | SSID | 32 character string | Specifies the service set identifier (SSID) or network name that uniquely names a Wi-Fi network. The SSID is case sensitive. Required |
| WIFI | PWD | 32 character string | Specifies the password associated with the SSID. The password is case sensitive. Required |
| WIFI | SEC_PROT | open wep wpa wpa2 (default) wpa+wpa2 | Specifies the security protocol for WiFi connections. |
| WIFI | SEC_ENCR | tkip aes (default) tkip+aes | Specifies the security encryption type. |
| WIFI | NTP_RATE | 60 to 129600 | The SNTP client update interval, in seconds. Device requests the time from the Wi-Fi modem at start-up. The modem synchs the time at the specified interval. Default is 86400 (1 day). |
| WIFI | CC | Country Code as defined by ISO 3166-1 alpha-2 standard. | Examples US = United States CA = Canada View all country codes. |
Wifi communications is not available for these models of the Veva III.
Enterprise WiFi Netowork Commands¶
| Option | Parameter | Value | Description |
|---|---|---|---|
| WIFI | ENT_MODE | 0 or false 1 or true | Enable or disable enterprise authentication mode. |
| WIFI | ENT_SSID | 32 character string | Specifies the case-sensitive service set identifier (SSID) or network name that uniquely names a Wi-Fi network. Required for enterprise mode. |
| WIFI | ENT_AUTH | epa+eap wpa2+eap (default) wpa+eap | Specifies authentication protocol type. Required for enterprise mode. |
| WIFI | ENT_ENCR | tkip aes (default) tkip+aes | Specified encryption protocol type. Required for enterprise mode. |
| WIFI | ENT_AEP1 | mixed (default) peap0 peap1 fast ttls tls | Specifies phase 1, tunnel establishment protocol. |
| WIFI | ENT_AEP2 | mixed (default) mschapv2 gtc | Specifies phase 2, authentication protocol. |
| WIFI | ENT_USR | character string | Specifies case-sensitive login name for enterprise authentication. Required for enterprise mode. |
| WIFI | ENT_PWD | 8 - 32 character string | Specifies case-sensitive password for enterprise authentication. Required for enterprise mode. |
| WIFI | NTP_RATE | 60 to 129600 | The SNTP client update interval, in seconds. Device requests the time from the Wi-Fi modem at start-up. The modem synchs the time at the specified interval. Default is 86400 (1 day). |
| WIFI | CC | Country Code as defined by ISO 3166-1 alpha-2 standard. | Examples US = United States CA = Canada View all country codes. |
Enterprise Wifi communications is not available for these models of the Veva III.