www.beck-ipc.com

GMLib - Network


Network

Functions for retrieving network data

  • gmReadNetworkRSSI
  • gmReadNetworkBER
  • gmReadNetworkRegistrationStatus
  • gmReadGSMNetworkRegistration
  • gmReadGPRSNetworkRegistration
  • gmReadEPSNetworkRegistration
  • gmReadPacketDataService
  • gmReadNetworkOperators
  • gmSetNetworkOperator
  • gmSetModemFirmware


  • int gmReadNetworkRSSI(int * rssi)

    This function delivers the received signal strength indication RSSI from the GM0x.

    Parameters

    rssi

    Output parameter:
    0 through 31 - covers the range of -113 dbm (or less) to -51dbm (or greater)
    99 meaning that signal strength is unknown or not detectable

        0 = -113 dbm or less
        1 = -111 dbm
        2 = -109 dbm
        ...
        29 = -55 dbm
        30 = -53 dbm
        31 = -51 dbm or greater

    Return Value

    Return values are described here: Return values


    Top
    Index page


    int gmReadNetworkBER(int * ber)

    This function delivers the bit error rate BER from the GM0x.

    Parameters

    ber

    Output parameter:
        0 less than 0.2%
        1 0.2% to 0.4%
        2 0.4% to 0.8%
        3 0.8% to 1.6%
        4 1.6% to 3.2%
        5 3.2% to 6.4%
        6 6.4% to 12.8%
        7 more than 12.8%
        99 meaning that error rate is unknown or not detectable

    Return Value

    Return values are described here: Return values


    Top
    Index page


    int gmReadNetworkRegistrationStatus(int * status)

    This function determines the GSM/EPS network registration status. Internally gmReadGSMNetworkRegistration() and gmReadEPSNetworkRegistration() are called.

    Parameters

    status

    Output parameter: Network registration status:
        0 - Not registered, and the GM0x is not currently searching for a new operator to which to register.
        1 - Registered, home network.
        2 - Not registered, but the GM0x is currently searching for a new operator to which to register.
        3 - Registration denied.
        4 - Unknown.
        5 - Registered, roaming.

    Return Value

    Return values are described here: Return values


    Top
    Index page


    int gmReadGSMNetworkRegistration(int * status)

    This function determines the GSM network registration status.

    Parameters

    status

    Output parameter: Network registration status:
        0 - Not registered, and the GM0x is not currently searching for a new operator to which to register.
        1 - Registered, home network.
        2 - Not registered, but the GM0x is currently searching for a new operator to which to register.
        3 - Registration denied.
        4 - Unknown.
        5 - Registered, roaming.

    Return Value

    Return values are described here: Return values


    Top
    Index page


    int gmReadGPRSNetworkRegistration(int * status)

    This function shows whether the network has currently indicated the GPRS registration of the GM0x.

    Parameters

    status

    Output parameter: GPRS Network registration status:
        0 - Not registered, and the GM0x is not currently searching for a new operator to which to register.
        1 - Registered, home network.
        2 - Not registered, but the GM0x is currently searching for a new operator to which to register.
        3 - Registration denied.
        4 - Unknown.
        5 - Registered, roaming.

    Return Value

    Return values are described here: Return values


    Top
    Index page


    int gmReadEPSNetworkRegistration(int * status)

    This function shows whether the network has currently indicated the EPS registration of the GM0x.

    Parameters

    status

    Output parameter: EPS Network registration status:
        0 - Not registered, and the GM0x is not currently searching for a new operator to which to register.
        1 - Registered, home network.
        2 - Not registered, but the GM0x is currently searching for a new operator to which to register.
        3 - Registration denied.
        4 - Unknown.
        5 - Registered, roaming.

    Return Value

    Return values are described here: Return values


    Top
    Index page


    int gmReadPacketDataService(int * status)

    This function indicates the current available type of Packet Data Service. The GM01/GM03/GM04 modules do not implement this command and will always return GM_EXIT_FAILURE.

    Parameters

    status

    Output parameter: Packet Data Service status:
        0 - No data packet service
        1 - GPRS
        2 - EGPRS (EDGE)
        3 - UMTS
        4 - UMTS with HSDPA
        5 - UMTS with HSUPA
        6 - UMTS with HSDPA and HSUPA
        7 - LTE

    Return Value

    Return values are described here: Return values


    Top
    Index page


    int gmReadNetworkOperators(gmOperators * netOperators, int maxEntries)

    This function returns a list of available GSM/UMTS/LTE network operators.

    Parameters

    netOperators

    Output parameter: Pointer to array of gmOperators structure.

    maxEntries

    Maximum number of entries that can be stored in the operators structure array.

    Return Value

    Returns the number of entries stored in the operators array.


    Top
    Index page


    int gmSetNetworkOperator(gmOperators * netOperators, int mode)

    This function can be used to select a GSM/UMTS/LTE network operator.

    Parameters

    netOperators

    Input parameter: Pointer to a element of gmOperators structure.

    mode

    Mode to set network operator:
        0 - Automatic (operator parameter is ignored)
        1 - Manual (operator must point to a element that was queried with gmReadOperators().
        4 - Manual/Automatic (if manual selection fails, use the automatic mode)

    Return Value

    Return values are described here: Return values


    Top
    Index page


    int gmSetModemFirmware(int mode)

    This function can be used to switch the modem firmware of some LTE modem.

    Parameters

    mode

    Firmware Mode to set:

         Not supported by all modems:
             -1 - Automatic firmware selection by SIM

         For ME910C1-WW (GM07):
             0 - AT&T
             1 - Verizon
             2 - Global
             3 - AU

         For LE910C1-NF:
             0 - AT&T
             1 - Verizon
             2 - T-Mobile

         For LE910C1-AP:
             10 - NTT Docomo
             11 - Telstra
             12 - KDDI
             13 - Softbank

    Return Value

    GM_EXIT_SUCCESS if settings are already valid.
    GM_EXIT_REQUIRE_REBOOT if new firmware requires reboot of the modem
    Return values are described here: Return values


    Top
    Index page


    End of document