User manual

set alarm
70 Chapter 2 Command Descriptions
set alarm
Devices
supported
This command is supported in the following products:
• Connect Family: Digi Connect EM, Digi Connect Wi-EM, Digi Connect
ME, Digi Connect Wi-ME. Setting alarms in GPIO mode is not
supported in the Digi Connect SP device.
• All Digi Cellular Family products. Setting alarms in GPIO mode is not
supported.
• Not supported in ConnectPort Display.
Purpose Configures device alarms and display current alarm settings. Device
alarms are used to send emails or SNMP traps when certain device events
occur. These events include changes in GPIO pin states; data patterns
detected in the serial stream; and, for Digi Cellular Family products, the
average signal strength falling below a specified level for a specified
amount of time, and the amount of cellular traffic for a specified period of
time, mobile temperature exceeding certain thresholds, and configuration
changes to settings associated with the mobile device.
For Digi devices managed by Connectware Manager, the “cwm” option
sends all alarms to a Connectware Manager server.
Up to 32 alarms can be configured in Digi Connect products.
To avoid false errors, configure alarms while alarms are disabled, by
entering a “set alarm state=off” command, then enable alarms after they
are fully configured by entering “set alarm state=on”.
Required
permissions
For Digi Connect products with two or more users, permissions must be set
to “set permissions s-alarm=read” to display current alarm settings, and to
“set permissions s-alarm=rw” to display alarm settings and configure
alarms. See "set permissions" on page 157 for details on setting user
permissions for commands.
Syntax
Configure alarms with general options (applies to all alarms)
set alarm [state={on|off}]
[mailserverip=ipaddress]
[from=string]
[cwm={on|off}]
Configure alarms for a range (set multiple alarms)
set alarm range={1-32}
[active={on|off}|to=string|cc=string|subject=string|
priority={normal|high}|
mode={match|gpio|rssi_gsm|cell_data|mobile_temp|
rssi_1xrtt| rssi_1xevdo|ecio_1xrtt|ecio_1xevdo|
1xevdo_unavail|mobile_unavail}|
type={email|snmptrap|all}]