Parameters for GSM-AT-IP

Top  Previous  Next

These variables control how PageGate interacts with cellular routers and gateways accessed by TCP or SSH. It is recommended that you configure these variables on either the Carrier or Connector level.

 

Click here for more information on how PageGate uses cellular gateways and routers.

 

Variable

Possible Values

Description

BodyMaxChars

Numeric

Example: BodyMaxChars = 200

 

This parameter limits the length of the %Message% macro and does not override the carrier "Max Chars" setting.

Filter

File path to and file name of the filter to run

Note: pgfilter.exe and pgfilter.dll must reside in the PageGate program directory to use this parameter.

 

Example:  Filter = c:\PageGateData\Filters\yourcarrierfilter.xml

 

This parameter calls on PageGate's filtering system when sending and receiving SMS through this carrier. This allows for the sorting and modification of both outbound messages and replies and is an integral part of two-way messaging.

FilterDebugFile

File path to and file name of the log to write

Example: FilterDebugFile = c:\PageGateData\Filters\outboundfilter1.log

 

When using a filter, you can use this variable to output this specific filter's log to the specific location and file name.

From

Text

Example: From = ALERTS

 

This parameter overrides any sender information passed in by the interfaces and APIs.

 

By specifying this variable, you're telling PageGate to use a single, standardized sender's name for messages delivered through this carrier.

GsmCmglDelay

Number of Milliseconds

Example: GsmCmglDelay = 1000

 

This parameter increases the amount of time PageGate will wait on a response from cellular hardware when checking for messages.

GsmCmglString

Text

Example: GsmCmglString = AT+CMGL=UREAD

 

This parameter overrides the normal 'check for messages' command. PageGate will use whatever AT command is supplied in this statement instead.

GsmSetTextModeOnce

True

False

Example: GsmSetTextModeOnce = True

 

This parameter specifies that PageGate should only send the command to enter text delivery mode once until Connector is restarted.

 

This parameter should not be used with cellular modems that require the "Enter Text Delivery Mode" command be issued in each session.

GsmUseCmgf

True

False

Example: GsmUseCmgf = True

 

This parameter specifies that the AT+CMGF=1 command should be used to enter text delivery mode.

 

If your modem supports AT+CMGF=1, set this variable to true for the carrier or connector using the IP capable cellular modem, router or gateway.

GsmUseCmgs

True

False

Example: GsmUseCmgs = True

 

This variable specifies that the AT+CMGS command should be used to deliver text messages.

GsmUseCpoint

True

False

Example: GsmUseCpoint = True

 

This parameter tells PageGate to use the CradlePoint command set to interact with the device.

GsmUseGT

True

False

Example: GsmUseGT = False

 

This parameter tells PageGate to wait for a '>' character after using the CMGS command. By default, this is true but to disable it, set the variable above.

GsmUseMmmg

True

False

Example: GsmUseMmmg = True

 

This variable specifies that the AT+MMMGS command should be used to deliver text messages.

GsmUseSmsm2m

True

False

Example: GsmUseSmsm2m = True

 

This variable specifies that the AT*SMSM2M command should be used to deliver text messages.

 

This is usually used with Sierra Wireless/Airlink hardware.

GsmUseWscl

True

False

Example: GsmUseWscl = True

 

This variable specifies that the AT+WSCL=1,2 command should be used to enter text delivery mode.

 

If your modem uses AT+WSCL=1,2 to enter SMS delivery mode, set this variable to true.

InterCommandDelay

Milliseconds

Example: InterCommandDelay = 500

 

This variable inserts a pause, in milliseconds, in between each command used in the protocol negotiation with the hardware. This is used to make sure PageGate doesn't send commands faster than the device's command shell can receive them and is not required for all devices.

InterMessageDelay

Number of Milliseconds

Example: InterMessageDelay = 1500

 

This variable inserts a pause, in milliseconds, in between each message that is delivered.

 

It is entirely possible for PageGate to overload the cellular radio in your device by sending information too quickly. By default, PageGate inserts a 1.5 second pause between messages to ensure this doesn't happen but this variable may need to be adjusted for specific hardware requirements.

ModemHangupCommand

Command Set String

Example: ModemHangupCommand = AT0

 

If your cellular modem, router or gateway requires a special parameter for disconnect/hang-up, use this cariable to specify the necessary command. Default if not set: ATH0

ModemWakeupCommand

Command Set String

Example: ModemWakeupCommand = \013

 

If your cellular modem, router or gateway requires something other than AT<CR> to wake up, use this variable to specify the necessary command.

ReplyFilter

File path to and file name of the filter to run

Note: pgfilter.exe and pgfilter.dll must reside in the PageGate program directory to use this parameter.

 

Example:  Filter = c:\PageGateData\Filters\replyfilter.xml

 

This parameter calls on PageGate's filtering system using the "Check for Messages" routine to retrieve SMS from the device. This allows for the sorting and modification of both outbound messages and replies and is an integral part of two-way messaging.

ReplyFilterDebugFile

File path to and file name of the log to write

Example: FilterDebugFile = c:\PageGateData\Filters\replyfilterlog1.log

 

When using a filter, you can use this variable to output this specific filter's log to the specific location and file name.

StripAlpha

True

False

Example: StripAlpha = True

 

Setting this value to true will remove any alphabetical character from messages delivered through this carrier. For example, if you tried to send the message 'Alert on node 127.0.0.1', the only thing delivered would be '127.0.0.1'

StripCharacters

See description

Example: StripCharacters = |\~

 

This parameter will remove all instance of any character(s) entered. In the above example, that would strip out all pipes (|), backslashes (\) and tildes (~).

StripNonPrintable

True

False

Example: StripNonPrintable = True

 

Settings this value to true will remove any non-printable ASCII characters, like carriage returns, line feeds, horizontal tabs and similar, from messages delivered through this carrier.

TcpProtocol

SSH

TCP

Example: TcpProtocol = SSH

 

This parameter configures what protocol negotiation method should be used. By default, PageGate uses TCP but to connect with SSH instead, specify the above variable.

To

A Phone Number

Example: To = 7818290500

 

This parameter forces all traffic to go to the specified phone number, overriding any interface or recipient values.

UseFilterDll

True

False

Note: pgfilter.exe and pgfilter.dll must reside in the PageGate program directory to use this parameter.

 

Example: UseFilterDll = True

 

Setting this parameter to true tells PageGate to use the filter dll, which is a more efficient method of running the filter.

UseTelnet

True

False

Example: UseTelnet = True

 

This variable tells PageGate to negotiate telnet terminal capabilities upon connection