Reference   Language | Libraries | Comparison | Changes

GSM : GSM class

begin()

Description

Connects to the GSM network identified on the SIM card.

Syntax

gsm.begin()
gsm.begin(pin)
gsm.begin(pin, restart)
gsm.begin(pin, restart, sync)

Parameters

  • pin : character array with the PIN to access a SIM card (default = 0)
  • restart : boolean, determines whether to restart modem or not (default= true)
  • sync : boolean, synchronous (true, default) or asynchronous (false) mode

Returns

0 if asynchronous. If synchronous, returns status : ERROR, IDLE, CONNECTING, GSM_READY, GPRS_READY, TRANSPARENT_CONNECTED

Example

#include <GSM.h>

#define PINNUMBER ""

GSM gsm; // include a 'true' parameter for debug enabled

void setup()
{
  // initialize serial communications
  Serial.begin(9600);

  // connection state
  boolean notConnected = true;

  // Start GSM shield
  // If your SIM has PIN, pass it as a parameter of begin() in quotes
  while(notConnected)
  {
    if(gsm.begin(PINNUMBER)==GSM_READY)
      notConnected = false;
    else
    {
      Serial.println("Not connected");
      delay(1000);
    }
  }

  Serial.println("GSM initialized");
}

void loop()
{
// once connected do something interesting
}
[Get Code]

See Also

Reference Home

Corrections, suggestions, and new documentation should be posted to the Forum.

The text of the Arduino reference is licensed under a Creative Commons Attribution-ShareAlike 3.0 License. Code samples in the reference are released into the public domain.