Reference Language (//wn arduino.cc/en/Reference/HomePage) ILibrares (//www arduino.ccfen/Reference/tibraies)|
Comparison (//#nv-arduino.cc/en/Reference/Comparson) | Changes (//wwrw arduino.c/en/Reference/Changes)
GSM library‘he Cs brary (er atl cfen/Reference/CSM) includes with
‘Arduino OE 0-4 and ae (wwwaruinece/ervMain Softwar)
Withee ain GSM shill
(Gh arcin celen/Man/ArdunGSMShied, this bray enables an
Arduino board vo do most ofthe operations you can do with a CSM phone:
Place ana receive vic cals and receive SMS, ane connect tte
Gsinetnork. The modem executes operations via sete of AT
commands. The tary abstais low evel communications between the
‘modem ana’ card Tereles onthe Software Serial rary
(Cran acc e/en/Reference/SfewareSeral for communication
“ype, ea indi command i pat of alarger series necessary
return to you when necessary
Library structure
‘the ibrar enables multiple types af functionality there area number ef
unas the connect aspects of the shies an esters your
systemin the CSM infrastructure lof your GSM/GPRS programs wil
need ince an abject of ticle to handle te necessary ow
oie callnanding manage by the GSMVoiceCal cas
Sendreceve SMS messages, managed bythe CSM_S¥S as
‘The GORSCas for connecting tothe internet
‘csMClent includes implementations fra cent, sina to the
Ethemet and Wi anes,
server incudes implementations ora serve, solar tothe
Ethemet and WiFibares. NB: Anumber of network operators go
rnotallow for incoming connection frm he publicinteret, but wl
slow them rom inside their own, Check with your operator to see
what esticon there are on data use,
number of tity clases uch as CSUScanner and ShModer
Ethernet library compatibility
“he ibrary tiesto be as compatbe as pose with the curen Ethernet
[ovary Porsing a program fam an edu Ethernet or Wi ibrar toa"
Deduno ith tne GSM Shield shou be fait easy Wheat posse
{esiply un Eteret-compatible code on Use GSM shld sis some
minor ibrar specif moafetons willbe necessary, ke ncuaing Ne
{GSW and GPRS specific braves and getting network conguration setngs|
fremyour cella network prover
Examples
‘here are tao groupe cf examples forthe GSM shield, There ae exampes
tellustrate the posites of te eld ike Mow to end MS messages
Sndeanneet to the internet There ras sto example oa that you Sa
feted te tuneanay fear ene ana oer
‘Gam We Chant /en/Tutoral/GstExarplesebcen) Download
the content ofa website to you Arduino board trough GPRS.
Can We Server (/en/Tutrl/GSMExamplestebervet):Ceste a
wireless web server through GPRS,
Make Voice Cal (/en/Tutorial/ GSMExarplesMakevicell Get yout
shield to rake phone cal fom the Srl Mont.
sat class
‘Ts cls prepares the functions tha will ommunicste withthe
mocem
= GSM (fo ara e/an/Rafrence/OSMConstocte)
= begin ew arduno ce/enReferece/sMegn}O
+ shutdown (wow ardine clen/Reference/CSMShutsown)Q)
‘GsMVolcecall lass
Enables vice communication trough the modem. Aimierephone and
Speaker need tobe added for fulse
(fain c/en/Reference/GSMIeSConstucter)
= getvoiecalstaus)
(Uf arin c/en/Reference/GsMescetvoiceCalsttus)
+ randy (Un ardineceen/Reference/CSMUCSReaGy)
= veiceCalo (fom arin cefen/Reference/CSMVCSVeiceCl)
= answer)
(ify arina cefen/Refrence/GSMVESAnswerCal)
= hangCall) mn ardunac/en/Reference/CSMUCSHengCa)
= revievecasingNumber
(Uf arin elen/Refrence/GSMVCSRetreveCslingNumber)
(GsM_SMS class
Facitates sending and receiving sort Message Service SMS)
messages.
= GSM_SMS (tn ardunocc/enReference/CSMSMSConstuctr)
= _beginss0 (ihwwardunoce/n/Reterence/GSMSMSBeginsMs)
= retdy (Un ardinecen/Releence/CSMSMSRe8dy)
= endSMS0 i arduino ce/en/Reference/CSSMSEnaSMS)
= avaableg (oe arduno ce/en/eferenceGSMSMSAvaiabe)
= remoteNumberd
(ifr arin elen/Refrence/GSMSMSRemateNumber)
= rend Uh arsine cc/n/Reference/GSMSMSRead)
= pte (we arcu cc/eneference/GSMSMSWEe)
= pant (me arin cfen/Refeence/CSMSMSPHne)
= pak (foo adn cfen/Reference/CSNSMSPeek)
= 8s) Uf ardincen/Reference/CSMSMSFIush)
RS cass
This ls is responsbe fr inclucing the les that are part ofthe brary
that involve TCP communieavon
= GPRS wa arin cleniRefeence/GPRSConsrveot)
= attachoPis (“ornare cfen/Reference/tachCPRSI)
GSMClent class
“Te lent cls creates cant that can comet to servers and end and
(Wf arin c/en/Reference/GSMChentConstuctr)
= randy Vn ardineceen/Reterence/GSMChantReady)
= connet) Vn arduino cen Reterence/GSMClentConnec)
= boginwriteo
(ify arin cfen/Reference/GSMClentSegite)Send ts (/en/Tuoia CSMExamesSendSMS) Use te Sera
Monitor to type in SMS messages to citferent phone numbers.
Receive Voce Call /en/Turtl/CSMExamplesReceveVoiecat)
‘hack he status ofthe modem while geting voice cals
Receive SMS /en/Tutoral/GSMExarplesteceivesMS) Read SMS
‘messages and prompt them tthe Serial Monitor.
Tools
Sand Management /en/Tutthl/CSMTeelBandManagement)
Manage the band the CSM shi connects ta
CSM San Networks (/en/Tutrl/GSMToolsGsmScantetwors}:
Check fren avalable networks
Pin Managernent (/en Tutorial CSMToolPaManagement) Manage
te PIN number of your SIM card
“Test. GPRS (/en/Tutoil GSMTocleTstGPRS) Tex th proper
funesonaty ofthe CPRSnetwerk sing your SIM card
“est Magen (/en/TtorilSMTooeTestModer)- eae the IME of
‘yourmodem,
Test Web Sever /en/Tutoral/GstToolsTestWebserve) Creates
webserver with your GSM shel
For adsonal information one SM shi ee the Getting Started page
(itu aracin ef en/Guie/BrduinoG Sse) andthe CSM shied
hardware page /um adi cefen/Main/AedinaCSUShes).
= eed (arcu ce/en/ference/GSMClent ite)
= endwrteg mon atdune ce/en/Relerence/MCientEndWs)
= conectea)
(farina cfen/Reference/GSMChen\ Connected)
= ret Uv arin ce/en/Reference/GSMClen Read)
= ausinbieg (se ado ce/en/ference/OSMCtienteible)
= peek ¢Hon.arduin.cfen/Reference/GSMClentPeee)
= fusho U/waarduinecen/Reference/GSMClentF lush)
= stop) (ww arduino ce/n/Reterence/GsMClenstop)
asMServer class
‘Te Server clas cents servers which can see data to and recive data
From connected cents prorams ransingan other computers
devices)
(farina c/en/Reference/GSMSererConstuctr)
+ randy (wm ardinece/e/Reference/GsMServeReady)
= beginwtteg
(for arina.cfen/Reterence/CSMServerdegiiite)
= sete) (ae ard een Reference/GSMSereeNte)
= endiiteg Un ardunace/er/Refernce/GSMServerEndWrte)
= reac rw ardsnocc/n/Reference/CSMServereas)
= evalebleg) (Pe arduino cc/eneference/sMServervaiable)
= stop) (fwarduino ce/an/Relerence/sMServestee)
[GsMModem class
‘Toe GShModer clas factates agrostc communion with the
(farina cfen/Refrence/GSMModemConstvcter)
= begin Ue arduinece/er/Relerence/GsMMedemsepinX)
= eUMEl warding c/en/Refeence/CSMModemGetIVE0
Gseiscanner cass
‘The GshScanner clas provides diagnostic information about he
reswork and cree
= siscenner
(ifr aravin eclen/Refrence/OSMScannerConstictor)
= begin ew anduno ce/enReference/ GsMScannerBeginX)
= getcurentcavier
(Ufo arduin c/en/Refrence/GsMSeannerGerCurentrier)
°
= getsgnastrength
(Uf arin elen/Reference/GSMScannerGeSignalstrengt)
°
= rendNetwores
(Ufo aruina.cfen/Reference/GsMScannerResdNetworts})
[GSMPIN class
‘Toe GSMPIN classhas uti For communicting with the SIM ar
= GSMPIN(/ fw ard ef en/ReFerence/CSMPINConstactr)
= begin (ew arduinoce/en/Reference/GSMPingegnX)
(i aroun cc /enReference/GSMPIISPINI
= hekP N/m ard len eference/ESMPINCreCPIN})Reference Home (//wwwarduino.ce/en/Reference/HomePage)
= eekP UK (fa auin cefen/Reerence/GSMPcheckPUK))
= hangin U//atduinac/en/Relerence/CSMPinCrangePINX)
= switchIN fr ardineceen/Reference/GSMPinSvitehPIN}O
= heck arin ce/en/Reference/6SMPincnacReRND
= getPINUsed (mm arduin clen/Reference/GSMPinGePinused)
°
= setNUsed (nw arduie clenieference/GSMPinsetPinUsed)
°
CsMtBan class
The GshBand css provides infomation
dem connects to There are alo methods fost
= oshand
(ifort eclen/Refrence/GSM BandConstructn)
the frequency bs
gthe bane
= begin Pi arduno cc/eneference/sMBand8eginX)
= gettand (vv arduinec/en/Reterence/GSMBandCetsand\)
= setaand(//won arduin.cefen/Refeence/CSMBandsetaand))
Corrections, suggestions, ané new documentation should be posted tothe Forum
(http: /arduino.ce/forurn/inéex php/board23.0 htm).
‘The text ofthe Arduino reference i licensed under a Creative Commons Attibution-ShareAlke 30 License
(http /ereativecommons.orgicenses/by-a/3.0/), Cade samples in
Share
e0oe
NEWSLETTER
‘Abt {lyon arin ce e/Min/Abot
‘owt Nate {Hy arin /r/ Man / Cao Notis
(ama ne asda / Cares
reference are released into the public domain,
Contact us /wney ain cx /n/ain/Cotact
iipsuiwitersomiarduins) — Cotps/fana taeboskcom/ofillardins) hts oi gant com!)
(om fiche com/shatsfasdng
(to: vob co adnate