set mobile

Purpose

Configures mobile (cellular) settings. The purpose of set mobile command and its settings differ for Digi cellular-enabled device with a CDMA or GSM cellular module.

Digi cellular-enabled devices with CDMA

For Digi cellular-enabled devices with CDMA modules, set mobile allows you to lock down on a specific technology, either 1xRTT, or EvDO, or allow the device to automatically select the technology.

For applications that require EvDO speeds to work properly, the set mobile command can lock down on EvDO, and will not make use of 1xRTT, even if it is available and EvDO is not.

For areas with spotty EvDO coverage, modules can be locked down to 1xRTT, to avoid the module trying to lock in on an EvDO signal.

Digi cellular-enabled devices with GSM

The Digi device may be equipped with one or two Subscriber Identity Module (SIM) cards. A SIM card contains the account information associated with a particular mobile service provider. All of the SIM card configuration options are stored individually for each SIM card.

The device uses the primary SIM first to try to establish a connection. If the connection is unsuccessful, it uses the secondary SIM instead. If it is also unsuccessful, the device tries the primary and then secondary SIMs again repeatedly. Several command options allow selection of which SIM is primary, and control over when to switch between SIMs.

For Digi cellular-enabled devices with GSM modules, set mobile allows you to select a specific band or technology. By specifying 3G bands, the module is effectively locked into high speed 3G bands, which is useful for applications that require higher speeds. For areas that have spotty 3G coverage, but good 2G coverage, 2G bands may be set to ensure that unit has optimal signal in this environment.

The GSM set mobile command also allows you to lock in a carrier by entering the mobile country code (MCC), and mobile network code (MNC). The module makes a best effort attempt to lock into the carrier. This helps prevent roaming charges.

Status and statistics for mobile communications

To display information and statistics for mobile/cellular communications, issue a display mobile command. To display SureLink statistics, issue a display pppstats command (see display pppstats

Required permissions

For Digi products with two or more users, to use this command, permissions must be set to set permissions s‑ppp=read to display settings, and set permissions s‑ppp=rw to display and configure settings. See set permissions for details on setting user permissions for commands.

Syntax

Configure a Digi cellular-enabled device with a CDMA module

set mobile [provider=provider_name]
  [technology={automatic|1xrtt|evdo}]

Configure a Digi cellular-enabled device with a GSM module and one or two SIMs

set mobile [provider=provider_name]
  [carrier={automatic|mobile country code+mobile network code] 
  [band={automatic|band[,band...]}
  where: 
  band={850|900|1800|1900|3g_850|3g_900|3g_1900|3g_2100}|2g_only|3g_only]
  [sim_pin=string]

Note Gobi (aka Huawei EM680) can be either CDMA or GSM, depending on which provider is set.

Configure a Digi cellular-enabled device with a GSM module and two SIMs

set mobile index=1-2
  [set_primary]
  [register_time={1-65535 seconds|0=disable}]
  [connect_attempts={1-255|0=disable}]
  [switch_roaming={no|yes}]
  [switch_dropped={no|yes}]
  [switch_idle_time={1-65535 seconds|0=disable}]
  [switch_max_time={1-65535 seconds, 0=disable}]

Configure the integrated GPS receiver for any Digi cellular-enabled device

set mobile [gps_state={disabled|enabled_always|enabled_connected}]
  [gps_method={standalone|mobile_based|mobile_assisted}]
  [gps_count={1-999)|continuous}] 
  [gps_time={1-255 seconds}] 
  [gps_interval=1-65535 seconds]**
  [gps_accuracy=1-65535 meters]

** For Verizon service, this option value depends on the gps_method value. See the gps_method description.

Options

CDMA module-specific mobile settings

For CDMA modules (on the ConnectPort WAN only—Sierra Wireless 572X modules), options are:

provider=provider_name

The mobile service provider for the cellular modem. To display a list of supported providers, enter the help set mobile command.

technology={automatic|1xrtt|evdo}

The type of cellular technology used by the CDMA module.

automatic

The CDMA module can select the type of technology to use.

1xRTT

The CDMA uses 1xRTT technology (a 2G technology; slower),

evdo

The CDMA uses EvDO (a 3G technology; faster).

Configure this setting depending on applications that run in the Digi device and the type of mobile coverage in the area. For example, if an application streams video, and will only work at EvDO speeds, locking down on EvDO is desired. On the other hand, if EvDO coverage is spotty, the technology should be set to 1xRTT.

GSM module-specific mobile settings

provider=provider_name

The mobile service provider for the cellular modem. To display a list of supported providers, enter help set mobile.

index=1-2

The slot number of the SIM card. The Quick Start Guide for your product shows the default designations for primary and secondary SIM cards.

set_primary

Sets the SIM card specified on the index option to be the primary or preferred SIM to use to establish mobile connections.

SIM configuration options

Options to stop using one SIM card and switch to the next

These next options determine when a connection attempt is unsuccessful, at which point the Digi device should switch to the next SIM card to establish mobile connections.

register_time={1-65535 seconds|0=disable}

Causes the Digi device to switch from one SIM card to the other if the SIM has not registered with the mobile service provider after the specified number of seconds.

connect_attempts={1-255|0=disable}

Causes the Digi device to switch from one SIM card to the other if a connection could not be established after the specified number of connection attempts.

switch_roaming={no|yes}

Causes the Digi device to switch from one SIM card to the other if the SIM card is registered, but is roaming to another mobile service provider. Note that your mobile service provider may apply additional connection charges when roaming.

Options to disconnect a SIM card and return to primary SIM card

Once a connection has been successfully established with this SIM, these options determine when to end the connection and return to using the primary SIM.

switch_dropped={no|yes}]

Causes the Digi device to disconnect a SIM card when the connection is dropped or ended for any reason.

switch_idle_time={1-65535 seconds|0=disable}

Causes the Digi device to disconnect a SIM card if the connection is idle or no data has been received over the mobile link for the specified number of seconds.

switch_max_time={1-65535 seconds, 0=disable}

Connection timeout. Causes the Digi device to disconnect a SIM card if the connection has been established for the specified number of seconds. This option can be used to switch back to the primary SIM if the secondary SIM costs too much to use.

Options for carrier and band selection

carrier={automatic|mobile country code+mobile network code}

Specifies how the GSM module selects the mobile carrier, either automatically, or a particular carrier.

Mobile carrier selection allows the mobile device to be configured to use a specific mobile service only. The recommended and normal operation is for the mobile device to automatically find service with an available carrier. However, a manual selection can be configured to force the use of a particular carrier. Please be aware that use of a manual carrier selection can result in a significantly longer time interval for the unit to find service on the specified network. Both the mobile network and the mobile device (modem) may influence this behavior. Therefore it is recommended that the automatic selection be used wherever possible.

To scan for available carriers, enter a display carriers command.

WARNING! The scan for available carriers requires that the mobile PPP connection be terminated to perform the scan. A successful scan cannot be performed and completed if it is initiated over the mobile connection, since the scan procedure requires user interaction that is not possible after the mobile PPP connection has been terminated.

Note The mobile PPP connection is not automatically restarted when a carrier selection is configured. The configuration change will take effect when you restart the mobile connection or reboot the Digi device.

automatic

Configures the GSM module to select the carrier automatically.

mobile country code+mobile network code

The numeric concatenation of a country code and network code. This setting forces the radio to use a particular carrier. Setting the carrier to avoid roaming, or when coverage by a provider is spotty.

For example, this command locks down the carrier to T-Mobile using country code 310 (USA), and network code 26 (T-Mobile): 

#> set mobile carrier=31026

Additional information regarding manual carrier selection

A specific carrier selection may be requested by entering it manually or selecting it from the carrier scan results list. However, the subsequent success of using that carrier depends on a number of factors that are outside the control of the Digi device server. These factors include, but are not limited to: the configuration stored in the SIM, your individual service agreement with your provider, and roaming agreements among service providers in your area. These factors are subject to change by the service providers, and you must configure the carrier selection accordingly. Please consult your service provider with questions or issues regarding your service.

Although multiple providers may offer service in your area, there may be agreements between them that disallow a mobile device using one provider's SIM, from connecting to and using another service provider's network. If you manually configure your carrier selection to use another provider's network, the connection attempts may either time out (because they are ignored by the provider's network) or you may notice that the connection attempts are actively rejected or disconnected due to authentication failures. In either case, the mobile connection will not be established successfully. To correct this problem, reconfigure the carrier selection as either Automatic or try another manual carrier selection that is compatible with your SIM's service account.

Note that the available carrier scan will identify all the service providers that are found in your area. However, that list may include service providers that will not allow access by your device, due to the factors stated above.

In summary, although you may request the use of a specific carrier, the decision to allow or deny access to that carrier's network is enforced by the network. That decision cannot be overridden by the carrier selection configuration of the Digi device server.

sim_pin=string

The PIN code for the SIM card. This option is applicable only for certain mobile service providers and does not need to be set if your SIM card does not have a PIN.

If your Digi device has dual SIM cards, each SIM may have its own PIN.  Set it with this command:

set mobile index=n sim_pin=xxxx

band={automatic|band[,band...]}

Specifies mobile service frequency bands to be configured in the GSM cellular modem. Use the default selection, automatic, unless there is a reason to configure specific bands only.

The band selection can be done automatically by the GSM module, or can be locked down to a single band, 3G, or 2G (slower).

Note The mobile PPP connection is not automatically restarted when a band selection is configured. The configuration change will take effect will take effect on the next connection.

automatic

Enables automatic service band selection by the modem.

band={850|900|1800|1900|3g_850|3g_900|3g_1900|3g_2100|
2g_only|3g_only}

Selects the individual service bands to be configured. Improper selection or combinations may result in a failure to establish a mobile connection. The bands are in MHz. Select one or more of the values shown above.

Band selection allows selecting a subset of the supported bands. Use this option to restrict bands to those that get the best signal. For example, a carrier could have both 850 and 1900 coverage, but if 1900 is better, the GSM module could be restricted to 1900. Or, if a lower frequency has better penetration into the a wiring closet, the band can be restricted to that frequency.

3g_850, 3g_900, 3g_1900, and 3g_2100 are for UMTS/HSDPA (3G cellular) bands, and are supported on ConnectPort WAN models only.

On 3G-capable modules, band selection allows for specifying whether 2G or 3G only is desired. The choices 2g_only and 3g_only select only 2G service or 3G service. Since not all cell modems support selection of specific bands, but they do support broader selection of 2G service only or 3G service only, these choices are available. For example, if you get better 2G coverage, and wish to restrict the module to 2G to get the best signal, select 2g_only. Or, if application requirements dictate the use of 3G (for example, streaming video), select 3g_only. Sometimes a 2G signal will be very good, and a bad 3G signal will be present. In this case, the cellular modem may attempt to use the 3G signal, because it is faster, even though it is poor. Being able to specify that the 2G signal should be used exclusively alleviates that issue.

Options for integrated GPS receiver

The following options configure the Global Positioning System (GPS) receiver that is integrated into the mobile module of the Digi device. These settings do not affect dedicated or external GPS devices.

gps_state={disabled|enabled_always|enabled_connected}

Enables or disables the GPS receiver.

disabled

The GPS receiver is not active.

enabled_always

The GPS receiver is always active.

enabled_connected

The GPS receiver is active while a mobile data connection is established. Use this setting if the GPS receiver is interfering with making data connections.

gps_method={standalone|mobile_based|mobile_assisted}

The method used to determine a position fix.

standalone

The GPS receiver determines a position without any assistance from the mobile network. It must obtain all necessary information from GPS satellites.

mobile_based (network assisted)

The GPS receiver obtains satellite almanac and ephemeris data from the mobile network. This may reduce the time to determine the first position fix.

mobile_assisted (network calculated)

The GPS receiver may send raw satellite data to the mobile network. The network calculates the position of the mobile device, using additional information available to the base station. This may increase the accuracy of position fixes.

Note Your provider may apply additional connection charges when network assistance or calculation is used.

gps_count={1-999)|continuous}

The number of position fixes. The GPS receiver can provide continuous position fixes, or stop after the specified number of fixes.

gps_time={1-255 seconds}

The maximum amount of time allowed to determine a position fix.

gps_interval=1-65535 seconds]

Interval between fixes; that is, the time between the start of one position fix to the start of the subsequent fix.

For Verizon service, the minimum value for the gps_interval option depends upon the selected value for the gps_method option:

gps_method:

gps_interval minimum:

standalone

1

mobile_based

30

mobile_assisted

1800

gps_accuracy=1-65535 meters

The preferred accuracy of a position fix. If this accuracy is not available in the time allowed, the best available position is provided.

Examples

#> set mobile provider=sprint_pcs technology=evdo
#> set mobile index=1 provider=cingular_orange register_time=60
#> set mobile gps_state=enabled_connected gps_method=standalone

See also