Library Defines (Options)

Top  Previous  Next

Any of the options below look cryptic? Read Operation Details section.

 

SUPPORTS_GPRS (default= 0)

0- GPRS disabled (library code won't be compiled into the project).

1- GPRS enabled.

 

GPRS_DEBUG_PRINT (default= 0)

0- no debug information.

1- print debug information into the output pane. Debug printing only works when the project is in the debug mode. However, still set this option to 0 for release, as this will save memory and code space.

 

GPRS_SEND_PING (default= 0)

0- suppress pinging.

1- ping GPRS_PING_IP in the end of PPP link establishment (as a proof of success).

 

GPRS_PING_IP (default= 0.0.0.0)

This is the IP address that will be pinged when GPRS_SEND_PING is set.

Only relevant when GPRS_SEND_PING is 1.

 

GPRS_SER_PORT (default= 3)

The serial port to which the GPRS modem is connected.

Like with ser.num, serial ports are numbered from 0. Keep at default value for NB1010 and DS101x devices.

 

GPRS_SER_PORT_RTSMAP (default depends on GPRS_SER_PORT)

The mapping of the RTS line connected to the GPRS modem.

If GPRS_SER_PORT is 0, the default value of GPRS_SER_PORT_RTSMAP is 0.

If GPRS_SER_PORT is 1, the default value of GPRS_SER_PORT_RTSMAP is 1.

If GPRS_SER_PORT is 2, the default value of GPRS_SER_PORT_RTSMAP is 2.

If GPRS_SER_PORT is 3, the default value of GPRS_SER_PORT_RTSMAP is 3.

Keep at default value for NB1010 and DS101x devices.

 

GPRS_SER_PORT_CTSMAP (default depends on GPRS_SER_PORT)

The mapping of the CTS interrupt line connected to the GPRS modem.

If GPRS_SER_PORT is 0, the default value of GPRS_SER_PORT_CTSMAP is 0.

If GPRS_SER_PORT is 1, the default value of GPRS_SER_PORT_CTSMAP is 1.

If GPRS_SER_PORT is 2, the default value of GPRS_SER_PORT_CTSMAP is 2.

If GPRS_SER_PORT is 3, the default value of GPRS_SER_PORT_CTSMAP is 3.

Keep at default value for NB1010 and DS101x devices.

 

GPRS_MODULE_EXTERNAL (default= 0)

0- the GPRS module is internal (like on the NB1010 and DS101x), GPRS_SWITCH and GPRS_RESET lines are used to control the module; there is a proper reset and startup delay when gprs_start() is called.

1- the GPRS module is external, GPRS_SWITCH and GPRS_RESET GPIO lines are not in use, there is no startup delay- the GPRS module is supposed to be up and running by the time gprs_start() is called.

Keep at default value for NB1010 and DS101x devices.

 

GPRS_SWITCH (default= 54)

GPIO line that, when set LOW, diverts traffic on GPRS_SER_PORT to the GPRS module. When the line is HIGH or disabled, serial port traffic goes elsewhere in the device.

Only relevant when GPRS_MODULE_EXTERNAL is 0.

Keep at default value for NB1010 and DS101x devices.

 

GPRS_RESET (default= 55)

GPIO line that, when set HIGH, applies hardware reset to the GPRS module. The line is set to LOW to release the GPRS module from reset.

'Only relevant when GPRS_MODULE_EXTERNAL is 0.

Keep at default value for NB1010 and DS101x devices.

 

GPRS_PAYLOAD_SIZE (default= 4)

Size of TCP and UDP packets that the GPRS interface will be able to carry, expressed in 256-byte units.

'Do not set >4 or <1. Smaller value reduces the total number of buffer pages required by the library (see gprs_get_info()).