# Parameters

## `modems` (string)

Define and configure one or more GSM modems.

    modems_value     = modem_definition *( ";" modem_definition )
    modem_definition = modem_name "[" list_of_params "]"
    list_of_params   = modem_param *( ";" modem_param )
    modem_param      = name "=" value

The following parameters can be used:

- d=device (mandatory) - Device associated with modem (/dev/ttyS0, /dev/modem, etc.).

- p=pin (optional) - SIM PIN - default is NULL.

- m=mode (optional) - Modem working mode ("ASCII","OLD","DIGICOM","NEW"). Default value is "NEW".

- c=SMS_Center (optional) - SMS center number for that modem. Default is the SMS center set on the SIM card.

- b=baudrate (optional) - Default is 19600.

- r=retry (optional) - How many times to try to re-send an SMS that reported error. Default is twice.

- l=looping (optional) - Time for modem to wait before performing a new check for incoming/outgoing SMS/SIP_MSG. Default is 20.

- t=to (optional) - uri for sip header TO. Default is NULL.

- s=scan (optional) - Values: 0: NOT SCAN uri from body sms, use URI in t=to. 1: SCAN uri from body sms (normal mode, default mode, classic mode) 2: SCAN MIX (both modes), First SCAN Default is 1 (SCAN).

No default value, the parameter is mandatory.

### Set `modems` parameter

    ...
    modparam("sms", "modems", "Nokia[d=/dev/ttyS1;s=0;t=sip:p-cscf@cidra.com.ar]")
    modparam("sms", "modems", "Nokia [d=/dev/ttyS1;b=9600;m=new;l=30] ")
    modparam("sms", "modems", "Nokia[d=/dev/ttyS1];Siemens[d=/dev/ttyS2]")
    ...

## `networks` (string)

Define and configure used GSM networks.

    networks_value = net_definition *( ";" net_definition )
    net_definition = net_name "[" list_of_params "]"
    list_of_params = set_param *( ";" set_param )
    set_param      = name "=" value

The following parameters can be used:

- m=msx_sms_per_call (optional) - Maximum number of SMS send / received from that net in one modem loop. Default is 10. This parameter was introduced to avoid starvation.

  Example of the starvation--a modem can send SMS for more than 1 networks. If you have a huge number of SMS for the first network and the number of incoming SIP messages is equal to the sent SMS per same unit of time, the modem will never get to send SMS for the next networks.

No default value, the parameter is mandatory.

### Set `networks` parameter

    ...
    modparam("sms", "networks", "D1 [m=10] ;d2[ m=20]")
    ...

## `links` (string)

Define from which network each modem should send SMS.

    links_value = modem_assoc *( ";" modem_assoc )
    modem_assoc = modem_name "[" list_of_networks "]"
    list_of_networks = network *( ";" network )

No default value, the parameter is mandatory.

### Set `links` parameter

    ...
    modparam("sms", "links", "NOKIA[D1;d2]")
    ...

The modem NOKIA will send SMS from D1 and D2 net (in this order !). If in a net queue are more than max_sms_per_call SMS the modem will not sleep before starting the next loop ! Shortly, if messages are waiting to be sent, the modem will not go in sleep.

## `default_net` (string)

The default network to use. If no one specified, the first defined network is used. This parameter is useful only if the "sms_send_msg" exported function is used (see sms.functions).

### Set `default_net` parameter

    ...
    modparam("sms", "default_net", "D1")
    ...

## `max_sms_parts` (integer)

Shows in how many parts (SMS messages) a SIP message can be split. If exceeded, the SIP message will be sent truncated and the SIP user will get back another message containing the unsent part.

Default value is 4.

### Set `max_sms_parts` parameter

    ...
    modparam("sms", "max_sms_parts", 10)
    ...

## `domain` (string)

Specify a fake domain name to be used by the gateway. The Contact headers and the From header from the request will be constructed based on this fake domain name. It's useful when the gateway is transparently hidden behind a proxy/register (located on different machines).

Default is the name of the machine the gateway is running on.

### Set `domain` parameter

    ...
    modparam("sms", "domain", "foo.bar")
    ...

## `use_contact` (integer)

If a contact header should be added to the outgoing SIP messages. Even if the SIP draft forbids this, some UAS require it.

Default is 0 (no).

### Set `use_contact` parameter

    ...
    modparam("sms", "use_contact", 1)
    ...

## `sms_report_type` (integer)

If the modem should ask for SMS confirmation from the SMS Center. If the SMSC reply with an error code, the gateway will send back to SIP user a SIP message containing the text (or part of it) that couldn't be sent. Two report mechanisms are implemented:

- 1 - the reports are delivered by the GSM device as SMS reports (so far supported only by Nokia modems);

- 2 - the reports are delivered as async. CDS responses (supported by almost all modems, except Ericsson).

Default is 0 (no report).

### Set `sms_report_type` parameter

    ...
    modparam("sms", "sms_report_type", 1)
    ...