Xbee/Xbee-Pro S2C 802.15.4: User Guide
Xbee/Xbee-Pro S2C 802.15.4: User Guide
4
Radio Frequency (RF) Module
User Guide
Revision history—90001500
Disclaimers
Information in this document is subject to change without notice and does not represent a
commitment on the part of Digi International. Digi provides this document “as is,” without warranty of
any kind, expressed or implied, including, but not limited to, the implied warranties of fitness or
merchantability for a particular purpose. Digi may make improvements and/or changes in this manual
or in the product(s) and/or the program(s) described in this manual at any time.
Warranty
To view product warranty information, go to the following website:
www.digi.com/howtobuy/terms
Customer support
Gather support information: Before contacting Digi technical support for help, gather the following
information:
Product name and model
Product serial number (s)
Firmware version
Operating system/browser (if applicable)
Logs (from time of reported issue)
Trace (if possible)
Description of issue
Steps to reproduce
Feedback
To provide feedback on this document, email your comments to
techcomm@digi.com
Include the document title and part number (XBee/XBee-PRO S2C 802.15.4 RF Module User Guide,
90001500 P) in the subject line of your email.
Safety instructions
Safety instructions 14
XBee modules 14
Инструкции за безопасност 14
XBee модули 14
Sigurnosne upute 15
XBee moduli 15
Bezpečnostní instrukce 15
moduly XBee 15
Sikkerhedsinstruktioner 16
XBee moduler 16
Veiligheidsinstructies 16
XBee-modules 16
Ohutusjuhised 17
XBee moodulid 17
Turvallisuusohjeet 17
XBee moduulit 17
Consignes de sécurité 18
Modules XBee 18
Sicherheitshinweise 19
XBee-Module 19
Οδηγίες ασφ αλείας 19
Biztonsági utasítások 20
XBee modulok 20
Istruzioni di sicurezza 20
Drošības instrukcijas 21
Saugos instrukcijos 21
XBee moduliai 21
Sikkerhetsinstruksjoner 22
XBee-moduler 22
Instrukcje bezpieczeństwa 22
Moduły XBee 22
Instruções de segurança 23
Módulos XBee 23
Instructiuni de siguranta 24
module XBee 24
Technical specifications
Performance specifications 28
Power requirements 28
General specifications 29
Regulatory conformity summary 29
Serial communication specifications 30
UART pin assignments 30
SPI pin assignments 30
GPIO specifications 31
Hardware
Antenna options 33
Mechanical drawings 33
Mounting considerations 34
Pin signals 35
Notes 38
Design notes 38
Power supply design 38
Board layout 38
Antenna performance 39
Keepout area 39
RF pad version 41
Modes
Serial modes 48
Transparent operating mode 48
API operating mode 48
Command mode 49
Transceiver modes 51
Idle mode 51
Transmit mode 51
Receive mode 51
Regulatory information
United States (FCC) 159
OEM labeling requirements 159
FCC notices 159
FCC-approved antennas (2.4 GHz) 161
RF exposure 173
FCC publication 996369 related information 173
Europe (CE) 174
Maximum power and frequency specifications 174
CE and UKCA OEM labeling requirements 174
Listen Before Talk requirement 176
Declarations of conformity 176
Antennas 176
ISED (Innovation, Science and Economic Development Canada) 176
Labeling requirements 176
For XBee/XBee-PRO S2C 802.15.4 RF Module 177
For XBee S2C surface-mount 177
For XBee-PRO S2C surface-mount 177
For XBee S2C through-hole 177
For XBee-PRO S2C through-hole 177
Transmitters for detachable antennas 177
Detachable antenna 177
Firmware Version Identification number (FVIN) 178
Australia (RCM) 178
South Korea 178
IFETEL (Mexico) 182
OEM labeling requirements 183
Safety instructions 14
Инструкции за безопасност 14
Sigurnosne upute 15
Bezpečnostní instrukce 15
Sikkerhedsinstruktioner 16
Veiligheidsinstructies 16
Ohutusjuhised 17
Turvallisuusohjeet 17
Consignes de sécurité 18
Sicherheitshinweise 19
Οδηγίες ασφ αλείας 19
Biztonsági utasítások 20
Istruzioni di sicurezza 20
Drošības instrukcijas 21
Saugos instrukcijos 21
Sikkerhetsinstruksjoner 22
Instrukcje bezpieczeństwa 22
Instruções de segurança 23
Instructiuni de siguranta 24
Bezpečnostné inštrukcie 24
Varnostna navodila 25
Módulos XBee 25
Säkerhets instruktioner 26
Safety instructions
XBee modules
n The XBee radio module cannot be guaranteed operation due to the radio link and so should
not be used for interlocks in safety critical devices such as machines or automotive
applications.
n The XBee radio module have not been approved for use in (this list is not exhaustive):
l medical devices
l nuclear applications
l explosive or flammable atmospheres
n There are no user serviceable components inside the XBee radio module. Do not remove the
shield or modify the XBee in any way. Modifications may exclude the module from any
warranty and can cause the XBee radio to operate outside of regulatory compliance for a given
country, leading to the possible illegal operation of the radio.
n Use industry standard ESD protection when handling the XBee module.
n Take care while handling to avoid electrical damage to the PCB and components.
n Do not expose XBee radio modules to water or moisture.
n Use this product with the antennas specified in the XBee module user guides.
n The end user must be told how to remove power from the XBee radio module or to locate the
antennas 20 cm from humans or animals.
Инструкции за безопасност
XBee модули
n Радио модулът XBee не може да бъде гарантиран за работа поради радиовръзката и
затова не трябва да се използва за блокировки в критични за безопасността устройства
като машини или автомобилни приложения.
n Радио модулът XBee не е одобрен за използване в (този списък не е изчерпателен):
l медицински изделия
l ядрени приложения
l експлозивна или запалима атмосфера
n В радиомодула XBee няма компоненти, които могат да се обслужват от потребителя. Не
премахвайте щита и не модифицирайте XBee по никакъв начин. Модификациите могат
да изключат модула от всякаква гаранция и да накарат радиото XBee да работи извън
регулаторното съответствие за дадена държава, което води до възможна незаконна
работа на радиото.
n Използвайте стандартна ESD защита при работа с XBee модула.
n Внимавайте, докато боравите, за да избегнете електрически повреди на печатната
платка и компонентите.
n Не излагайте радиомодулите XBee на вода или влага.
Sigurnosne upute
XBee moduli
n Radio modulu XBee ne može se jamčiti rad zbog radio veze i stoga se ne smije koristiti za
blokade u sigurnosnim kritičnim uređajima kao što su strojevi ili automobilske aplikacije.
n XBee radio modul nije odobren za upotrebu u (ovaj popis nije konačan):
l medicinskih uređaja
l nuklearne primjene
l eksplozivne ili zapaljive atmosfere
n Unutar XBee radio modula nema komponenti koje može servisirati korisnik. Nemojte uklanjati
štit i ni na koji način modificirati XBee. Izmjene mogu isključiti modul iz bilo kakvog jamstva i
mogu uzrokovati rad XBee radija izvan usklađenosti s propisima za određenu zemlju, što može
dovesti do mogućeg nezakonitog rada radija.
n Koristite standardnu ESD zaštitu pri rukovanju XBee modulom.
n Budite oprezni tijekom rukovanja kako biste izbjegli električna oštećenja PCB-a i komponenti.
n Ne izlažite XBee radio module vodi ili vlazi.
n Koristite ovaj proizvod s antenama navedenim u korisničkim vodičima za XBee modul.
n Krajnjem korisniku se mora reći kako da isključi napajanje iz XBee radio modula ili da locira
antene 20 cm od ljudi ili životinja.
Bezpečnostní instrukce
moduly XBee
n Rádiový modul XBee nemůže zaručit provoz kvůli rádiovému spojení, a proto by neměl být
používán pro blokování v zařízeních kritických z hlediska bezpečnosti, jako jsou stroje nebo
automobilové aplikace.
n Rádiový modul XBee nebyl schválen pro použití v (tento seznam není vyčerpávající):
l zdravotnické prostředky
l jaderné aplikace
l výbušné nebo hořlavé atmosféry
n Uvnitř rádiového modulu XBee nejsou žádné uživatelsky opravitelné součásti. Neodstraňujte
štít ani nijak neupravujte XBee. Úpravy mohou vyjmout modul z jakékoli záruky a mohou
způsobit, že rádio XBee bude fungovat mimo zákonnou shodu pro danou zemi, což povede k
možnému nezákonnému provozu rádia.
n Při manipulaci s modulem XBee používejte standardní ochranu ESD.
n Při manipulaci buďte opatrní, aby nedošlo k elektrickému poškození desky plošných spojů a
součástí.
n Nevystavujte rádiové moduly XBee vodě nebo vlhkosti.
n Používejte tento produkt s anténami uvedenými v uživatelských příručkách modulu XBee.
n Koncový uživatel musí být informován, jak odpojit napájení rádiového modulu XBee nebo jak
umístit antény 20 cm od lidí nebo zvířat.
Sikkerhedsinstruktioner
XBee moduler
n XBee-radiomodulet kan ikke garanteres drift på grund af radioforbindelsen og bør derfor ikke
bruges til aflåsninger i sikkerhedskritiske enheder såsom maskiner eller bilapplikationer.
n XBee-radiomodulet er ikke godkendt til brug i (denne liste er ikke udtømmende):
l medicinsk udstyr
l nukleare applikationer
l eksplosive eller brandfarlige atmosfærer
n Der er ingen komponenter, der kan repareres af brugeren, inde i XBee-radiomodulet. Fjern ikke
skjoldet eller modificer XBee på nogen måde. Ændringer kan udelukke modulet fra enhver
garanti og kan få XBee-radioen til at fungere uden for lovgivningsoverholdelse for et givet land,
hvilket kan føre til den mulige ulovlige drift af radioen.
n Brug industristandard ESD-beskyttelse, når du håndterer XBee-modulet.
n Vær forsigtig under håndteringen for at undgå elektrisk beskadigelse af printet og
komponenterne.
n Udsæt ikke XBee-radiomoduler for vand eller fugt.
n Brug dette produkt med de antenner, der er specificeret i XBee-modulets brugervejledninger.
n Slutbrugeren skal fortælles, hvordan man fjerner strømmen fra XBee-radiomodulet eller
placerer antennerne 20 cm fra mennesker eller dyr.
Veiligheidsinstructies
XBee-modules
n De werking van de XBee-radiomodule kan niet worden gegarandeerd vanwege de
radioverbinding en mag daarom niet worden gebruikt voor vergrendelingen in
veiligheidskritieke apparaten zoals machines of autotoepassingen.
n De XBee-radiomodule is niet goedgekeurd voor gebruik in (deze lijst is niet uitputtend):
l o medische apparaten
l o nucleaire toepassingen
l o explosieve of ontvlambare atmosferen
Ohutusjuhised
XBee moodulid
n XBee raadiomooduli tööd ei saa raadiolingi tõttu garanteerida ja seetõttu ei tohiks seda
kasutada ohutuse seisukohalt oluliste seadmete (nt masinad või autorakendused)
blokeerimiseks.
n XBee raadiomoodulit ei ole heaks kiidetud kasutamiseks (see loetelu ei ole ammendav):
l meditsiiniseadmed
l tuumarakendused
l plahvatusohtlik või tuleohtlik keskkond
n XBee raadiomoodulis ei ole kasutaja poolt hooldatavaid komponente. Ärge eemaldage kaitset
ega muutke XBee mingil viisil. Muudatused võivad mooduli garantiist välja jätta ja XBee raadio
töötab väljaspool antud riigi regulatiivseid vastavusi, põhjustades raadio võimaliku
ebaseadusliku kasutamise.
n Kasutage XBee mooduli käsitsemisel tööstusharu standardset ESD-kaitset.
n Olge käsitsemisel ettevaatlik, et vältida PCB ja komponentide elektrikahjustusi.
n Ärge jätke XBee raadiomooduleid vee või niiskuse kätte.
n Kasutage seda toodet XBee mooduli kasutusjuhendis kirjeldatud antennidega.
n Lõppkasutajale tuleb öelda, kuidas XBee raadiomoodulilt toide eemaldada või antennid
inimestest või loomadest 20 cm kaugusele paigutada.
Turvallisuusohjeet
XBee moduulit
n XBee-radiomoduulin toimintaa ei voida taata radiolinkin vuoksi, joten sitä ei tule käyttää
turvallisuuden kannalta kriittisten laitteiden, kuten koneiden tai autosovellusten,
lukitsemiseen.
n XBee-radiomoduulia ei ole hyväksytty käytettäväksi (tämä luettelo ei ole tyhjentävä):
l lääketieteelliset laitteet
l ydinvoimasovellukset
l räjähdysvaarallisiin tai syttyviin tiloihin
n XBee-radiomoduulin sisällä ei ole käyttäjän huollettavia osia. Älä poista suojusta tai muokkaa
XBeetä millään tavalla. Muutokset voivat sulkea moduulin takuun ulkopuolelle ja aiheuttaa
sen, että XBee-radio toimii tietyn maan säädöstenmukaisuuden ulkopuolella, mikä johtaa
radion mahdolliseen laittomaan käyttöön.
n Käytä alan standardia ESD-suojausta käsitellessäsi XBee-moduulia.
n Ole varovainen käsitellessäsi, jotta vältät piirilevyn ja komponenttien sähkövauriot.
n Älä altista XBee-radiomoduuleja vedelle tai kosteudelle.
n Käytä tätä tuotetta XBee-moduulin käyttöoppaissa määriteltyjen antennien kanssa.
n Loppukäyttäjälle on kerrottava, kuinka XBee-radiomoduulin virta katkaistaan tai antennit
sijoitetaan 20 cm:n etäisyydelle ihmisistä tai eläimistä.
Consignes de sécurité
Modules XBee
n Le fonctionnement du module radio XBee ne peut pas être garanti en raison de la liaison radio
et ne doit donc pas être utilisé pour les verrouillages dans des dispositifs critiques pour la
sécurité tels que des machines ou des applications automobiles.
n Le module radio XBee n'a pas été approuvé pour une utilisation dans (cette liste n'est pas
exhaustive) :
l dispositifs médicaux
l applications nucléaires
l atmosphères explosives ou inflammables
n Il n'y a aucun composant réparable par l'utilisateur à l'intérieur du module radio XBee. Ne
retirez pas la protection et ne modifiez en aucune façon le XBee. Les modifications peuvent
exclure le module de toute garantie et peuvent entraîner le fonctionnement de la radio XBee
en dehors de la conformité réglementaire pour un pays donné, ce qui peut entraîner un
fonctionnement illégal de la radio.
n Utilisez la protection ESD standard de l'industrie lors de la manipulation du module XBee.
n Soyez prudent lors de la manipulation afin d'éviter des dommages électriques au circuit
imprimé et aux composants.
n N'exposez pas les modules radio XBee à l'eau ou à l'humidité.
n Utilisez ce produit avec les antennes spécifiées dans les guides d'utilisation du module XBee.
n L'utilisateur final doit savoir comment couper l'alimentation du module radio XBee ou placer
les antennes à 20 cm des humains ou des animaux.
Sicherheitshinweise
XBee-Module
n Der Betrieb des XBee-Funkmoduls kann aufgrund der Funkverbindung nicht garantiert werden
und sollte daher nicht für Verriegelungen in sicherheitskritischen Geräten wie Maschinen oder
Automobilanwendungen verwendet werden.
n Das XBee-Funkmodul ist nicht zugelassen für den Einsatz in (diese Liste ist nicht vollständig):
l Medizinprodukte
l nukleare Anwendungen
l explosive oder brennbare Atmosphären
n Das XBee-Funkmodul enthält keine vom Benutzer zu wartenden Komponenten. Entfernen Sie
nicht die Abschirmung oder modifizieren Sie das XBee in irgendeiner Weise. Modifikationen
können das Modul von jeglicher Garantie ausschließen und dazu führen, dass das XBee-
Funkgerät außerhalb der gesetzlichen Vorschriften für ein bestimmtes Land betrieben wird,
was zu einem möglichen illegalen Betrieb des Funkgeräts führen kann.
n Verwenden Sie beim Umgang mit dem XBee-Modul ESD-Schutz nach Industriestandard.
n Seien Sie vorsichtig bei der Handhabung, um elektrische Schäden an der Leiterplatte und den
Komponenten zu vermeiden.
n XBee-Funkmodule nicht Wasser oder Feuchtigkeit aussetzen.
n Verwenden Sie dieses Produkt mit den in den Benutzerhandbüchern des XBee-Moduls
angegebenen Antennen.
n Dem Endbenutzer muss mitgeteilt werden, wie er das XBee-Funkmodul von der
Stromversorgung trennt oder die Antennen 20 cm von Menschen oder Tieren entfernt aufstellt.
n Προσέχετε κατά το χειρισμό για να αποφ ύγετε ηλεκτρική βλάβη στο PCB και στα εξαρτήματα.
n Μην εκθέτετε τις μονάδες ραδιοφ ώνου XBee σε νερό ή υγρασία.
n Χρησιμοποιήστε αυτό το προϊόν με τις κεραίες που καθορίζονται στους οδηγούς χρήσης της
μονάδας XBee.
n Πρέπει να ενημερωθεί ο τελικός χρήστης πώς να αφ αιρέσει την τροφ οδοσία από τη μονάδα
ραδιοφ ώνου XBee ή να εντοπίσει τις κεραίες σε απόσταση 20 cm από ανθρώπους ή ζώα.
Biztonsági utasítások
XBee modulok
• Az XBee rádiómodul működése nem garantálható a rádiókapcsolat miatt, ezért nem használható
biztonsági szempontból kritikus eszközök, például gépek vagy autóipari alkalmazások reteszelésére.
• Az XBee rádiómodul nem engedélyezett a következő területeken való használatra (ez a lista nem
teljes):
o orvosi eszközök
o nukleáris alkalmazások
o robbanásveszélyes vagy gyúlékony légkör
• Az XBee rádiómodulban nincsenek felhasználó által javítható alkatrészek. Ne távolítsa el a pajzsot, és
semmilyen módon ne módosítsa az XBee-t. A módosítások kizárhatják a modult a jótállásból, és az
XBee rádió működését az adott ország jogszabályi előírásaitól eltérően okozhatják, ami a rádió
esetleges illegális működéséhez vezethet.
• Az XBee modul kezelésekor használjon ipari szabványos ESD védelmet.
• A kezelés során ügyeljen arra, hogy elkerülje a PCB és az alkatrészek elektromos károsodását.
• Ne tegye ki az XBee rádiómodulokat víznek vagy nedvességnek.
• Használja ezt a terméket az XBee modul használati útmutatójában meghatározott antennákkal.
• A végfelhasználót tájékoztatni kell arról, hogyan távolítsa el az XBee rádiómodul áramellátását, vagy
hogyan helyezze el az antennákat az emberektől vagy állatoktól 20 cm-re.
Istruzioni di sicurezza
Moduli XBee
n Il funzionamento del modulo radio XBee non può essere garantito a causa del collegamento
radio e quindi non deve essere utilizzato per gli interblocchi in dispositivi critici per la sicurezza
come macchine o applicazioni automobilistiche.
n Il modulo radio XBee non è stato approvato per l'uso in (questo elenco non è esaustivo):
l dispositivi medici
l applicazioni nucleari
l atmosfere esplosive o infiammabili
n Non ci sono componenti riparabili dall'utente all'interno del modulo radio XBee. Non
rimuovere lo scudo o modificare in alcun modo l'XBee. Le modifiche possono escludere il
modulo da qualsiasi garanzia e possono causare il funzionamento della radio XBee al di fuori
della conformità normativa per un determinato paese, portando al possibile funzionamento
Drošības instrukcijas
XBee moduļi
n Radio moduļa XBee darbība nevar tikt garantēta radio savienojuma dēļ, tāpēc to nevajadzētu
izmantot bloķēšanai drošības ziņā kritiskās ierīcēs, piemēram, mašīnās vai automobiļos.
n XBee radio modulis nav apstiprināts lietošanai (šis saraksts nav pilnīgs):
l medicīniskās ierīces
l kodolprogrammas
l sprādzienbīstamā vai uzliesmojošā vidē
n XBee radio moduļa iekšpusē nav neviena komponenta, ko lietotājs varētu apkopt. Nenoņemiet
vairogu un nekādā veidā nepārveidojiet XBee. Modifikācijas rezultātā modulis var tikt izslēgts
no jebkādas garantijas un var izraisīt XBee radio darbību, kas neatbilst noteiktās valsts
normatīvajiem aktiem, izraisot iespējamu nelegālu radio darbību.
n Strādājot ar XBee moduli, izmantojiet nozares standarta ESD aizsardzību.
n Rīkojoties, rīkojieties uzmanīgi, lai izvairītos no PCB un komponentu elektriskiem bojājumiem.
n Nepakļaujiet XBee radio moduļus ūdens vai mitruma iedarbībai.
n Izmantojiet šo izstrādājumu ar antenām, kas norādītas XBee moduļa lietotāja rokasgrāmatās.
n Galalietotājam ir jāpaskaidro, kā atvienot XBee radio moduļa strāvu vai novietot antenas 20 cm
attālumā no cilvēkiem vai dzīvniekiem.
Saugos instrukcijos
XBee moduliai
n Negalima garantuoti, kad „XBee“ radijo modulis veiks dėl radijo ryšio, todėl jo neturėtų būti
naudojamas blokuoti saugai svarbiuose įrenginiuose, pvz., mašinose ar automobiliuose.
n XBee radijo modulis nebuvo patvirtintas naudoti (šis sąrašas nėra baigtinis):
l medicinos prietaisai
l branduolinės programos
l sprogioje ar degioje aplinkoje
n XBee radijo modulio viduje nėra komponentų, kuriuos vartotojas galėtų prižiūrėti. Jokiu būdu
nenuimkite skydo ir nekeiskite XBee. Dėl modifikacijų moduliui gali būti netaikoma jokia
garantija, o „XBee“ radijas gali veikti ne pagal tam tikros šalies norminius reikalavimus, o tai
gali sukelti neteisėtą radijo naudojimą.
n Dirbdami su XBee moduliu naudokite pramonės standartinę ESD apsaugą.
n Dirbdami būkite atsargūs, kad nepažeistumėte PCB ir komponentų.
n Saugokite XBee radijo modulius nuo vandens ar drėgmės.
n Naudokite šį gaminį su antenomis, nurodytomis XBee modulio vartotojo vadove.
n Galutiniam vartotojui turi būti paaiškinta, kaip atjungti XBee radijo modulio maitinimą arba
nustatyti antenas 20 cm atstumu nuo žmonių ar gyvūnų.
Sikkerhetsinstruksjoner
XBee-moduler
n XBee-radiomodulen kan ikke garanteres drift på grunn av radiolinken, og bør derfor ikke
brukes til forriglinger i sikkerhetskritiske enheter som maskiner eller bilapplikasjoner.
n XBee-radiomodulen er ikke godkjent for bruk i (denne listen er ikke uttømmende):
l medisinsk utstyr
l kjernefysiske applikasjoner
l eksplosive eller brennbare atmosfærer
n Det er ingen komponenter som kan repareres av brukeren inne i XBee-radiomodulen. Ikke fjern
skjoldet eller modifiser XBee på noen måte. Endringer kan ekskludere modulen fra enhver
garanti og kan føre til at XBee-radioen fungerer utenfor regelverket for et gitt land, noe som
kan føre til ulovlig drift av radioen.
n Bruk industristandard ESD-beskyttelse når du håndterer XBee-modulen.
n Vær forsiktig ved håndtering for å unngå elektrisk skade på PCB og komponenter.
n Ikke utsett XBee radiomoduler for vann eller fuktighet.
n Bruk dette produktet med antennene spesifisert i XBee-modulens brukerveiledninger.
n Sluttbrukeren må bli fortalt hvordan man fjerner strømmen fra XBee-radiomodulen eller
plasserer antennene 20 cm fra mennesker eller dyr.
Instrukcje bezpieczeństwa
Moduły XBee
n Moduł radiowy XBee nie może zagwarantować działania ze względu na łącze radiowe, dlatego
nie należy go używać do blokad w urządzeniach o krytycznym znaczeniu dla bezpieczeństwa,
takich jak maszyny lub aplikacje motoryzacyjne.
n Moduł radiowy XBee nie został dopuszczony do użytku w (lista ta nie jest wyczerpująca):
l wyroby medyczne
l zastosowania nuklearne
l atmosferach wybuchowych lub łatwopalnych
n Wewnątrz modułu radiowego XBee nie ma żadnych elementów, które mogłyby być
serwisowane przez użytkownika. Nie zdejmuj osłony ani nie modyfikuj XBee w żaden sposób.
Modyfikacje mogą wykluczyć moduł z jakiejkolwiek gwarancji i spowodować, że radio XBee
będzie działać niezgodnie z przepisami obowiązującymi w danym kraju, co może prowadzić do
nielegalnego działania radia.
n Podczas obsługi modułu XBee należy stosować standardową ochronę ESD.
n Podczas obsługi należy zachować ostrożność, aby uniknąć uszkodzeń elektrycznych PCB i
komponentów.
n Nie wystawiaj modułów radiowych XBee na działanie wody lub wilgoci.
n Używaj tego produktu z antenami określonymi w podręcznikach użytkownika modułu XBee.
n Użytkownik końcowy musi zostać poinformowany, jak odłączyć zasilanie modułu radiowego
XBee lub zlokalizować anteny w odległości 20 cm od ludzi lub zwierząt.
Instruções de segurança
Módulos XBee
n • O módulo de rádio XBee não pode ter operação garantida devido ao link de rádio e, portanto,
não deve ser usado para intertravamentos em dispositivos críticos de segurança, como
máquinas ou aplicações automotivas.
n • O módulo de rádio XBee não foi aprovado para uso em (esta lista não é exaustiva):
l o dispositivos médicos
l o aplicações nucleares
l o atmosferas explosivas ou inflamáveis
n • Não há componentes que possam ser reparados pelo usuário dentro do módulo de rádio
XBee. Não remova a blindagem nem modifique o XBee de forma alguma. As modificações
podem excluir o módulo de qualquer garantia e fazer com que o rádio XBee opere fora da
conformidade regulatória de um determinado país, levando à possível operação ilegal do
rádio.
n • Use proteção ESD padrão da indústria ao manusear o módulo XBee.
n • Tome cuidado ao manusear para evitar danos elétricos à PCB e aos componentes.
n • Não exponha os módulos de rádio XBee à água ou umidade.
n • Use este produto com as antenas especificadas nos guias do usuário do módulo XBee.
n • O usuário final deve ser informado sobre como remover a energia do módulo de rádio XBee
ou localizar as antenas a 20 cm de humanos ou animais.
Instructiuni de siguranta
module XBee
n Nu se poate garanta funcționarea modulului radio XBee din cauza conexiunii radio și, prin
urmare, nu trebuie utilizat pentru interblocări în dispozitive critice pentru siguranță, cum ar fi
mașini sau aplicații auto.
n Modulul radio XBee nu a fost aprobat pentru utilizare în (această listă nu este exhaustivă):
l dispozitive medicale
l aplicații nucleare
l atmosfere explozive sau inflamabile
n Nu există componente care să poată fi reparate de utilizator în interiorul modulului radio XBee.
Nu îndepărtați scutul și nu modificați XBee în niciun fel. Modificările pot exclude modulul din
orice garanție și pot face ca radioul XBee să funcționeze în afara conformității cu
reglementările pentru o anumită țară, ceea ce duce la o posibilă funcționare ilegală a radioului.
n Folosiți protecția ESD standard în industrie când manipulați modulul XBee.
n Aveți grijă în timpul manipulării pentru a evita deteriorarea electrică a PCB-ului și a
componentelor.
n Nu expuneți modulele radio XBee la apă sau umezeală.
n Utilizați acest produs cu antenele specificate în ghidurile utilizatorului modulului XBee.
n Utilizatorului final trebuie să i se spună cum să scoată alimentarea de la modulul radio XBee
sau să găsească antenele la 20 cm de oameni sau animale.
Bezpečnostné inštrukcie
moduly XBee
n Rádiový modul XBee nemôže byť zaručený kvôli rádiovému spojeniu, a preto by sa nemal
používať na blokovanie v zariadeniach kritických z hľadiska bezpečnosti, ako sú stroje alebo
automobilové aplikácie.
n Rádiový modul XBee nebol schválený na použitie v (tento zoznam nie je úplný):
l zdravotnícke pomôcky
l jadrové aplikácie
l výbušné alebo horľavé atmosféry
n Vo vnútri rádiového modulu XBee sa nenachádzajú žiadne používateľsky opraviteľné
komponenty. Neodstraňujte štít ani žiadnym spôsobom neupravujte XBee. Úpravy môžu vyňať
modul zo záruky a môžu spôsobiť, že rádio XBee bude fungovať mimo zhody s predpismi pre
danú krajinu, čo vedie k možnej nezákonnej prevádzke rádia.
n Pri manipulácii s modulom XBee používajte štandardnú ochranu pred ESD.
n Pri manipulácii buďte opatrní, aby ste predišli elektrickému poškodeniu dosky plošných spojov
a komponentov.
n Rádiové moduly XBee nevystavujte vode ani vlhkosti.
Varnostna navodila
XBee moduli
n Radijskega modula XBee ni mogoče zagotoviti delovanja zaradi radijske povezave in ga zato ne
smete uporabljati za zaklepanje v varnostno kritičnih napravah, kot so stroji ali avtomobilske
aplikacije.
n Radijski modul XBee ni bil odobren za uporabo v (ta seznam ni izčrpen):
l medicinskih pripomočkov
l jedrske aplikacije
l eksplozivne ali vnetljive atmosfere
n V radijskem modulu XBee ni komponent, ki bi jih lahko popravil uporabnik. Ne odstranjujte
ščita in na noben način ne spreminjajte XBee. Spremembe lahko modul izključijo iz kakršne
koli garancije in lahko povzročijo, da radio XBee deluje zunaj zakonske skladnosti za dano
državo, kar vodi do možnega nezakonitega delovanja radia.
n Pri ravnanju z modulom XBee uporabite standardno industrijsko zaščito pred ESD.
n Pri rokovanju pazite, da se izognete električnim poškodbam tiskanega vezja in komponent.
n Radijskih modulov XBee ne izpostavljajte vodi ali vlagi.
n Ta izdelek uporabljajte z antenami, navedenimi v uporabniških priročnikih modula XBee.
n Končnemu uporabniku je treba povedati, kako odstraniti napajanje z radijskega modula XBee
ali naj locira antene 20 cm od ljudi ali živali.
Módulos XBee
n No se puede garantizar el funcionamiento del módulo de radio XBee debido al enlace de radio
y, por lo tanto, no debe usarse para enclavamientos en dispositivos críticos para la seguridad,
como máquinas o aplicaciones automotrices.
n El módulo de radio XBee no ha sido aprobado para su uso en (esta lista no es exhaustiva):
l dispositivos médicos
l aplicaciones nucleares
l atmósferas explosivas o inflamables
n No hay componentes reparables por el usuario dentro del módulo de radio XBee. No quite el
escudo ni modifique el XBee de ninguna manera. Las modificaciones pueden excluir el módulo
de cualquier garantía y pueden hacer que la radio XBee funcione fuera del cumplimiento
normativo de un país determinado, lo que puede provocar una operación ilegal de la radio.
n Utilice la protección ESD estándar de la industria al manipular el módulo XBee.
n Tenga cuidado al manipularlo para evitar daños eléctricos en la PCB y los componentes.
Säkerhets instruktioner
XBee-moduler
n XBee-radiomodulen kan inte garanteras funktion på grund av radiolänken och bör därför inte
användas för förreglingar i säkerhetskritiska enheter som maskiner eller biltillämpningar.
n XBee-radiomodulen har inte godkänts för användning i (denna lista är inte uttömmande):
l medicinsk utrustning
l kärnkraftstillämpningar
l explosiv eller brandfarlig atmosfär
n Det finns inga komponenter som användaren kan reparera inuti XBee-radiomodulen. Ta inte
bort skölden eller modifiera XBee på något sätt. Ändringar kan utesluta modulen från alla
garantier och kan göra att XBee-radion fungerar utanför bestämmelserna för ett visst land,
vilket kan leda till att radion kan användas olagligt.
n Använd industristandard ESD-skydd när du hanterar XBee-modulen.
n Var försiktig vid hanteringen för att undvika elektriska skador på kretskortet och
komponenterna.
n Utsätt inte XBee radiomoduler för vatten eller fukt.
n Använd den här produkten med antennerna som specificeras i XBee-modulens
användarguider.
n Slutanvändaren måste informeras om hur man kopplar bort strömmen från XBee-
radiomodulen eller för att placera antennerna 20 cm från människor eller djur.
Performance specifications 28
Power requirements 28
General specifications 29
Regulatory conformity summary 29
Serial communication specifications 30
GPIO specifications 31
Performance specifications
The following table describes the performance specifications for the devices.
Note Range figure estimates are based on free-air terrain with limited sources of interference. Actual
range will vary based on transmitting power, orientation of transmitter and receiver, height of
transmitting antenna, height of receiving antenna, weather conditions, interference sources in the
area, and terrain between receiver and transmitter, including indoor and outdoor structures such as
walls, trees, buildings, hills, and mountains.
Power requirements
The following table describes the power requirements for the XBee/XBee-PRO S2C 802.15.4 RF Module.
General specifications
The following table describes the general specifications for the devices.
Specification XBee-PRO
Operating frequency ISM 2.4 GHz
Supported channels 12 - 23
Form factor TH: 2.438 x 3.294 cm (0.960 x 1.297 in)
SMT: 2.199 x 3.4 x 0.305 cm (0.866 x 1.33 x 0.120 in)
FCC/IC test transmit power output -26 to +8 dBm -0.7 to -26 to +8 dBm +1 to +19
range +19.4 dBm dBm
GPIO specifications
XBee/XBee-PRO S2C 802.15.4 RF Modules have 15 General Purpose Input / Output (GPIO) ports
available. The exact list depends on the device configuration, as some GPIO pads are used for
purposes such as serial communication.
Antenna options 33
Mechanical drawings 33
Mounting considerations 34
Pin signals 35
Design notes 38
Antenna options
The ranges specified are typical for the integrated whip—1.5 dBi—and dipole—2.1 dBi—antennas. The
printed circuit board (PCB) antenna option provides advantages in its form factor; however, it typically
yields shorter range than the whip and dipole antenna options when transmitting outdoors. For more
information, see XBee and XBee-PRO OEM RF Module Antenna Considerations Application Note.
Mechanical drawings
The following mechanical drawings of the XBee/XBee-PRO S2C 802.15.4 RF Module show all
dimensions in inches. The first drawing shows the surface-mount device (antenna options not shown).
Mounting considerations
We design the through-hole module to mount into a receptacle so that you do not have to solder the
module when you mount it to a board. The development kits may contain RS-232 and USB interface
boards that use two 20-pin receptacles to receive modules.
The following illustration shows the module mounting into the receptacle on the RS-232 interface
board.
Century Interconnect and Samtec manufacture the 2 x 10 pin 2 mm spacing receptacles on Digi
development boards. Several other manufacturers provide comparable mounting solutions; we
currently use the following receptacles:
n Through-hole single-row receptacles: Samtec part number: MMS-110-01-L-SV (or equivalent)
n Surface-mount double-row receptacles: Century Interconnect part number: CPRMSL20-D-0-1
(or equivalent)
n Surface-mount single-row receptacles: Samtec part number: SMM-110-02-SM-S
Note We recommend that you print an outline of the module on the board to indicate the
correct orientation for mounting the module.
Pin signals
The following image shows the pin numbers; it shows the device's top sides, the shields are on the
bottom.
The following table shows the pin assignments for the through-hole device. In the table, low-asserted
signals have a horizontal line above signal name.
The following table shows the pin assignments for the surface-mount device.
Notes
Minimum connections: VCC, GND, DOUT and DIN.
Minimum connections for updating firmware: VCC, GND, DIN, DOUT, RTS and DTR.
The table specifies signal direction with respect to the device.
The device includes a 50 kΩ pull-up resistor attached to RESET.
Use the PR (Pull-up/Down Resistor Enable) command to configure several of the input pull-ups.
You can connect other pins to external circuitry for convenience of operation including the Associate
LED pin (pin 15). The Associate LED flashes differently depending on the state of the device.
Leave any unused pins disconnected.
Design notes
The following guidelines help to ensure a robust design.
The XBee modules do not specifically require any external circuitry specific connections for proper
operation. However, there are some general design guidelines that we recommend for help in
troubleshooting and building a robust design.
Board layout
We design XBee devices to be self sufficient and have minimal sensitivity to nearby processors,
crystals or other printed circuit board (PCB) components. Keep power and ground traces thicker than
signal traces and make sure that they are able to comfortably support the maximum current
specifications. There are no other special PCB design considerations to integrate XBee devices, with
the exception of antennas.
Antenna performance
Antenna location is important for optimal performance. The following suggestions help you achieve
optimal antenna performance. Point the antenna up vertically (upright). Antennas radiate and receive
the best signal perpendicular to the direction they point, so a vertical antenna's omnidirectional
radiation pattern is strongest across the horizon.
Position the antennas away from metal objects whenever possible. Metal objects between the
transmitter and receiver can block the radiation path or reduce the transmission distance. Objects
that are often overlooked include:
n metal poles
n metal studs
n structure beams
n concrete, which is usually reinforced with metal rods
If you place the device inside a metal enclosure, use an external antenna. Common objects that have
metal enclosures include:
n vehicles
n elevators
n ventilation ducts
n refrigerators
n microwave ovens
n batteries
n tall electrolytic capacitors
Do not place XBee devices with the chip or integrated PCB antenna inside a metal enclosure.
Do not place any ground planes or metal objects above or below the antenna.
For the best results, mount the device at the edge of the host PCB. Ensure that the ground, power,
and signal planes are vacant immediately below the antenna section.
Keepout area
We recommend that you allow a “keepout” area, which the following drawings show.
Through-hole keepout
Notes
Surface-mount keepout
RF pad version
The RF pad is a soldered antenna connection on the surface-mount device. The RF signal travels from
pin 36 on the module to the antenna through a single ended RF transmission line on the PCB. This line
should have a controlled impedance of 50 Ω.
For the transmission line, we recommend either a microstrip or coplanar waveguide trace on the PCB.
We provide a microstrip example below, because it is simpler to design and generally requires less
area on the host PCB than coplanar waveguide.
We do not recommend using a stripline RF trace because that requires routing the RF trace to an inner
PCB layer, and via transitions can introduce matching and performance problems.
The following figure shows a layout example of a microstrip connecting an RF pad module to a
through-hole RPSMA RF connector.
n The top two layers of the PCB have a controlled thickness dielectric material in between. The
second layer has a ground plane which runs underneath the entire RF pad area. This ground
plane is a distance d, the thickness of the dielectric, below the top layer.
n The top layer has an RF trace running from pin 36 of the device to the RF pin of the RPSMA
connector. The RF trace's width determines the impedance of the transmission line with
relation to the ground plane. Many online tools can estimate this value, although you should
consult the PCB manufacturer for the exact width. Assuming d = 0.025 in, and that the
dielectric has a relative permittivity of 4.4, the width in this example will be approximately
0.045 in for a 50 Ω trace. This trace width is a good fit with the module footprint's 0.060 in pad
width.
We do not recommend using a trace wider than the pad width, and using a very narrow trace can
cause unwanted RF loss. You can minimize the length of the trace by placing the RPSMA jack close to
the module. All of the grounds on the jack and the module are connected to the ground planes
directly or through closely placed vias. Space any ground fill on the top layer at least twice the
distance d (in this case, at least 0.050 in) from the microstrip to minimize their interaction.
Number Description
1 XBee surface-mount pin 36
2 50 Ω microstrip trace
3 Back off ground fill at least twice the distance between layers 1 and 2
4 RF connector
5 Stitch vias near the edges of the ground plane
6 Pour a solid ground plane under the RF trace on the reference layer
Implementing these design suggestions helps ensure that the RF pad device performs to
specifications.
Software libraries 45
Configure the device using XCTU 45
Over-the-air (OTA) firmware update 45
XBee Network Assistant 45
XBee Multi Programmer 46
Software libraries
One way to communicate with the XBee/XBee-PRO S2C 802.15.4 RF Module is by using a software
library. The libraries available for use with the XBee/XBee-PRO S2C 802.15.4 RF Module include:
n XBee Java library
n XBee Python library
The XBee Java Library is a Java API. The package includes the XBee library, its source code and a
collection of samples that help you develop Java applications to communicate with your XBee
devices.
The XBee Python Library is a Python API that dramatically reduces the time to market of XBee projects
developed in Python and facilitates the development of these types of applications, making it an easy
process.
1. Navigate to digi.com/xbeenetworkassistant.
2. Click General Diagnostics, Utilities and MIBs.
3. Click the XBee Network Assistant - Windows x86 link.
4. When the file finishes downloading, run the executable file and follow the steps in the XBee
Network Assistant Setup Wizard.
Serial modes 48
Transceiver modes 51
Serial modes
The firmware operates in several different modes. Two top-level modes establish how the device
communicates with other devices through its serial interface: Transparent operating mode and API
operating mode. Use the AP command to choose Serial mode. XBee/XBee-PRO S2C 802.15.4 RF
Modules use Transparent operation as the default serial mode.
The following modes describe how the serial port sends and receives data.
Note Transparent operating mode is not available when using the SPI interface; see SPI operation.
Serial-to-RF packetization
The device buffers data in the serial receive buffer until one of the following causes the data to be
packetized and transmitted:
n The device receives no serial characters for the amount of time determined by RO
(Packetization Timeout). If RO = 0, packetization begins when a character is received.
n The device receives the Command Mode Sequence (GT + CC + GT). Any character buffered in
the serial receive buffer before the sequence is transmitted.
n The device receives the maximum number of characters that fits in an RF packet (100 bytes).
Serial-to-RF packetization
Data is buffered in the DI buffer until one of the following causes the data to be packetized and
transmitted:
1. No serial characters are received for the amount of time determined by the RO (Packetization
Timeout) parameter. If RO = 0, packetization begins when a character is received.
2. The maximum number of characters that will fit in an RF packet (100) is received. The
maximum payload depends on whether you use Compatibility mode or not. If you use it, the
maximum payload is 100 characters, but if you do not use it, depending on encryption, the App
header and addressing, the payload can be larger.
3. The Command Mode Sequence (GT + CC + GT) is received. Any character buffered in the DI
buffer before the sequence is transmitted.
If the device cannot immediately transmit (for instance, if it is already receiving RF data), the serial
data is stored in the DI Buffer. The data is packetized and sent at any RO timeout or when 100 bytes
(maximum packet size without Compatibility mode) are received.
If the DI buffer becomes full, hardware flow control must be implemented in order to prevent overflow
(loss of data between the host and device).
data from multiple locations or controlling multiple devices remotely. API mode is a frame-based
protocol that allows you to direct data on a packet basis. It can be particularly useful in large
networks where you need control over the operation of the radio network or when you need to know
which node a data packet is from. The device communicates UART or SPI data in packets, also known
as API frames. This mode allows for structured communications with serial devices.
For more information, see API mode overview.
Command mode
Command mode is a state in which the firmware interprets incoming characters as commands. It
allows you to modify the device’s configuration using parameters you can set using AT
commands. When you want to read or set any parameter of the XBee/XBee-PRO S2C 802.15.4 RF
Module using this mode, you have to send an AT command. Every AT command starts with the
letters AT followed by the two characters that identify the command and then by some optional
configuration values.
The operating modes of the XBee/XBee-PRO S2C 802.15.4 RF Module are controlled by the AP (API
Enable) setting, but Command mode is always available as a mode the device can enter while
configured for any of the operating modes.
Command mode is available on the UART interface for all operating modes. You cannot use the SPI
interface to enter Command mode.
Note Do not press Return or Enter after typing +++ because it interrupts the guard time silence and
prevents you from entering Command mode.
When the device is in Command mode, it listens for user input and is able to receive AT commands on
the UART. If CT time (default is 10 seconds) passes without any user input, the device drops out of
Command mode and returns to the previous operating mode. You can force the device to leave
Command mode by sending CN (Exit Command mode).
You can customize the command character, the guard times and the timeout in the device’s
configuration settings. For more information, see CC (Command Character), CT (Command mode
Timeout) and GT (Guard Times).
Troubleshooting
Failure to enter Command mode is often due to baud rate mismatch. Ensure that the baud rate of the
connection matches the baud rate of the device. By default, BD (Interface Data Rate) = 3 (9600 b/s).
There are two alternative ways to enter Command mode:
n A serial break for six seconds enters Command mode. You can issue the "break" command
from a serial console, it is often a button or menu item.
n Asserting DIN (serial break) upon power up or reset enters Command mode. XCTU guides you
through a reset and automatically issues the break when needed.
Both of these methods temporarily set the device's baud rate to 9600 and return an OK on the UART
to indicate that Command mode is active. When Command mode exits, the device returns to normal
operation at the baud rate that BD is set to.
Send AT commands
Once the device enters Command mode, use the syntax in the following figure to send AT commands.
Every AT command starts with the letters AT, which stands for "attention." The AT is followed by two
characters that indicate which command is being issued, then by some optional configuration values.
To read a parameter value stored in the device’s register, omit the parameter field.
Multiple AT commands
You can send multiple AT commands at a time when they are separated by a comma in Command
mode; for example, ATNIMy XBee,AC<cr>.
The preceding example changes the NI (Node Identifier) to My XBee and makes the setting active
through AC (Apply Changes).
Parameter format
Refer to the list of AT commands for the format of individual AT command parameters. Valid formats
for hexidecimal values include with or without a leading 0x for example FFFF or 0xFFFF.
Response to AT commands
When using AT commands to set parameters the XBee/XBee-PRO S2C 802.15.4 RF Module responds
with OK<cr> if successful and ERROR<cr> if not.
Send as RE (Restore Defaults) to wipe settings saved using WR back to their factory defaults.
Note You still have to use WR to save the changes enacted with RE.
Transceiver modes
The following modes describe how the transceiver sends and receives over-the-air (OTA) data.
Idle mode
When not receiving or transmitting data, the device is in Idle mode. During Idle mode, the device
listens for valid data on both the RF and serial ports.
Transmit mode
Transmit mode is the mode in which the device is transmitting data. This typically happens when data
is received from the serial port.
Receive mode
This is the default mode for the XBee/XBee-PRO S2C 802.15.4 RF Module. The device is in Receive
mode when it is not transmitting data. If a destination node receives a valid RF packet, the destination
node transfers the data to its serial transmit buffer.
Addressing 53
Encryption 53
Maximum payload 55
Networking 57
Clear Channel Assessment (CCA) 63
Serial interface 64
SPI operation 67
I/O support 69
Sleep support 75
Node discovery 78
Remote configuration commands 80
Addressing
Every RF data packet sent over-the-air contains a Source Address and Destination Address field in its
header. The XBee/XBee-PRO S2C 802.15.4 RF Module conforms to the 802.15.4 specification and
supports both short 16-bit addresses and long 64-bit addresses. A unique 64-bit IEEE source address is
assigned at the factory and can be read with the SL (Serial Number Low) and SH (Serial Number High)
commands. You must manually configure short addressing. A device uses its unique 64-bit address as
its Source Address if its MY (16-bit Source Address) value is 0xFFFF or 0xFFFE.
1. Set the DL parameter to equal the MY parameter of the intended destination device.
2. Set the DH parameter to 0.
Addressing modes
802.15.4 frames have a source address, a destination address, and a destination PAN ID in the over-
the-air (OTA) frame. The source and destination addresses may be either long or short and the
destination address may be either a unicast or a broadcast. The destination PAN ID is short and it may
also be the broadcast PAN ID.
In Transparent mode, the destination address is set by the DH and DL parameters, but, in API mode, it
is set by the TX Request: 64-bit address (0x00) or TX Request: 16-bit Address (0x01) frames. In either
Transparent mode or API mode, the destination PAN ID is set with the ID parameter, and the source
address is set with the MY parameter.
Broadcast PAN ID
The Broadcast PAN ID is also 0xFFFF. Its effect is to traverse all PANs in the vicinity. Typically, this only
makes sense during association time when sending beacon requests to find PAN IDs.
Note When an end device associates to a coordinator, it is assigned the short address of 0xFFFE.
Encryption
The XBee/XBee-PRO S2C 802.15.4 RF Module supports AES 128-bit encryption. 128-bit encryption
refers to the length of the encryption key entered with the KY command (128 bits = 16 bytes). The
802.15.4 protocol specifies eight security modes, enumerated as shown in the following table.
The XBee/XBee-PRO S2C 802.15.4 RF Module only supports security levels 0 and 4. It does not support
message integrity checks. EE 0 selects security level 0 and EE 1 selects security level 4. When using
encryption, all devices in the network must use the same 16-byte encryption key for valid data to get
through. Mismatched keys will corrupt the data output on the receiving device. Mismatched EE
parameters will prevent the receiving device from outputting received data.
Working from a maximum packet size of 116 bytes, encryption affects the maximum payload as shown
in the following table.
Effect on
maximum
Factor payload Comment
Compatibility Force to 95 If C8 bit 0 is set, all packets are limited to 95 bytes, regardless of
mode other factors listed below. This is how the Legacy 802.15.4 module
(S1 hardware) functions.
Packet Reduce by 5 This penalty for enabling encryption is unavoidable due to the
overhead 802.15.4 protocol.
Source address Reduce by 6 This penalty is unavoidable because the 802.15.4 requires encrypted
packets to be sent with a long source address, even if a short
address would otherwise be used.
Destination Reduce by 6 This penalty only applies if sending to a long address rather than a
address short address.
App header Reduce by 4 The app header for encryption is 4 bytes long. This penalty only
applies if MM = 0 or 3.
Because of the two mandatory reductions when using encryption, no packet can exceed 116 - (5+6)
=105 bytes. The other options may further reduce the maximum payload to 101 bytes, 99 bytes, or 95
bytes.
When operating in API mode and not using encryption, if the source address is long, the receiving
device outputs an RX Indicator (0x80) frame for received data. But, if the source address is short, the
receiving device outputs a Receive Packet (0x81) frame for received data. These same rules apply for
encryption if MM is 0 or 3. This is possible because the four-byte encryption App header includes the
short address of the sender and the long received address is not used for API output. If encryption is
enabled with MM of 1 or 2, then no App header exists, the source address is always long, and the
receiving device in API mode always outputs a 64-bit Receive Packet - 0x80.
Maximum payload
There is a maximum payload that you can send at one time, depending on the device's configuration.
These maximums only apply in API mode. If you attempt to send an API packet with a larger payload
than specified, the device responds with a Transmit Status frame (0x89) with the Status field set to 74
(Data payload too large).
In Transparent mode, the firmware splits the data as necessary to cope with maximum payloads.
1. If you enable transmit compatibility with the Legacy 802.15.4 module (S1 hardware):
l There is a fixed maximum payload of 100 bytes if not using encryption
l There is a fixed maximum payload of 95 bytes if using encryption
l The rest of the rules do not apply. They apply only when you disable transmit
compatibility with the Legacy 802.15.4 module.
2. The maximum achievable payload is 116 bytes. This is achieved when:
n Not using encryption.
n Not using the application header.
n Using the short source address.
n Using the short destination address.
3. If you are using the application header—MM (MAC Mode) set to 0 or 3—the maximum
achievable payload is reduced by:
n 2 bytes if not using encryption.
n 4 bytes if using encryption.
4. If you are using the long source address, the maximum achievable payload is reduced by 6
bytes (size of long address (8) - size of short address (2) = 6).
5. If you are using encryption, the short source addresses are promoted to long source addresses,
so the maximum achievable payload is reduced by 6 bytes.
6. If you are using the long destination address, the maximum achievable payload is reduced by 6
bytes (the difference between the 8 bytes required for a long address and the 2 bytes required
for a short address).
7. if you are using encryption, the maximum achievable payload is reduced by 5 bytes.
Encryption
Enabled Disabled
95 B 100 B
The following table indicates the maximum payload when using the application header and not using
encryption. Increment the maximum payload in 2 bytes if you are not using the application header.
Destination Address
Source Address Short Long
Short 114 B 108 B
Long 108 B 102 B
The following table indicates the maximum payload when using the application header and using
encryption. Increment the maximum payload in 4 bytes if you are not using the application header.
Destination Address
Source Address Short Long
Short 101 B 95 B
Long 101 B 95 B
Networking
The following table describes some common terms we use when discussing networks.
Term Definition
Association Establishing membership between end devices and a coordinator.
Coordinator A full-function device (FFD) that provides network synchronization by polling nodes.
End device When in the same network as a coordinator. Devices that rely on a coordinator for
synchronization and can be put into states of sleep for low-power applications.
PAN Personal Area Network. A data communication network that includes one or more
end devices and optionally a coordinator.
The default value for the MM configuration parameter is 0 which enables both the Digi header and the
MAC acknowledgment.
Peer-to-peer networks
By default, XBee/XBee-PRO S2C 802.15.4 RF Module modules are configured to operate within a peer-
to-peer network topology and therefore are not dependent upon master/slave relationships. This
means that devices remain synchronized without the use of master/server configurations and each
device in the network shares both roles of master and slave. Our peer-to-peer architecture features
fast synchronization times and fast cold start times. This default configuration accommodates a wide
range of RF data applications.
Master/slave networks
In a Master Slave network, there is a coordinator and one or more end devices. When end devices
associate to the coordinator, they become members of that Personal Area Network (PAN). As such,
they share the same channel and PAN ID. PAN IDs must be unique to prevent miscommunication
between PANs. Depending on the A1 and A2 parameters, association may assist in automatically
assigning the PAN ID and the channel. These parameters are specified below based on the network
role (end device or coordinator).
By default, A1 is 0, which disables association and effectively causes an end device to operate in peer-
to-peer mode. When bit 2 is set, the end device associates to a coordinator. This is done by sending
out an active scan to detect beacons from nearby networks. The active scan selects one channel and
transmits a Beacon Request command to the broadcast address and the broadcast PAN ID. It then
listens on that channel for beacons from any coordinator operating on that channel. The listen time
on each channel is determined by the SD parameter. Once that time expires, the active scan selects
the next channel, repeating until all channels have been scanned.
If A1 is 0x04 (bit 0 clear, bit 1 clear, and bit 2 set), then the active scan will reject all beacons that do
not match both the configured PAN ID and the configured channel. This is the best way to join a
particular coordinator.
If A1 is 0x05 (bit 0 set, bit 1 clear, and bit 2 set), then the active scan will accept a beacon from any
PAN ID, providing the channel matches. This is useful if the channel is known, but not the PAN ID.
If A1 is 0x06 (bit 0 clear, bit 1 set, and bit 2 set), then the active scan will accept a beacon from any
channel, providing the PAN ID matches. This is useful if the PAN ID is known, but not the channel.
If A1 is 0x07 (bit 0 set, bit 1 set, and bit 2 set), then the active scan will accept a beacon from any PAN
ID and from any channel. This is useful when the network does not matter, but the one with the best
signal is desired.
Whenever multiple beacons are received that meet the criteria of the active scan, then the beacon
with the best link quality is selected. This applies whether A1 is 0x04, 0x05, 0x06, or 0x07.
Before the End Device joins a network, the Associate LED will be on solid. After it joins a network, the
Associate LED will blink twice per second.
In the event that association parameters are changed after the end device is associated, the end
device will leave the network and re-join in accordance with the new configuration parameters.
Coordinator association
Coordinator association occurs if CE is 1 and A2 has bit 2 set. See the following table.
By default, A2 is 0, which prevents devices from associating to the coordinator. So, if CE is 1 and A2 bit
2 is 0, the device still creates a network, but end devices are unable to associate to it.
If A2 bit 2 is set, then joining is allowed after the coordinator forms a network.
If A2 bit 0 is set, the coordinator issues an active scan. This means it will send out beacon requests to
the broadcast address (0xFFFF) and the broadcast PAN ID (0xFFFF). Then, it will listen for beacons. The
listen time is determined by the SD parameter. Then the same beacon request is sent out on the next
channel and the device listens for beacon responses on that channel. This process repeats until each
channel in the channel mask (SC) is scanned for SD time. If none of the beacons on any of the
channels return a PAN ID equivalent with the ID parameter, then the coordinator will use the ID
parameter for the PAN ID of the new network it forms. But, if a beacon response matches the PAN ID
of the coordinator, the coordinator will form a PAN on a unique PAN ID.
If A2 bit 0 is clear, then the coordinator will form a network on the PAN ID identified by the ID
parameter, without regard to another network that might have the same PAN ID.
If A2 bit 1 is set, the coordinator will issue an energy scan, similar to the active scan. It will listen on
each channel specified in the SC parameter for the time indicated by the SD parameter. After the scan
is complete, the channel with the least energy is selected to form the new network.
If A2 bit 1 is clear, then no energy scan is performed and the CH parameter is used to select the
channel of the new network.
If bits 0 and 1 of A2 are both set, then an active scan is done followed by an energy scan. However, the
channels on which the active scan finds a coordinator are eliminated as possible channels for the
energy scan, unless such an action would eliminate all channels. If beacons are found on all channels
in the channel mask, then then the energy scan behaves the same as it would if beacons are not found
on any of those channels. Therefore, the active scan will be performed on all channels in the channel
mask. Then, an energy scan will be performed on the channels in the channel mask that did not find a
coordinator.
Depending on the result of the active scan, the set of channels for the energy scan varies. If a PAN ID is
found on all the channels in the channel mask, then the energy scan operates on all the channels in
the channel mask. If at least one of the channels in the channel mask did not find a PAN ID, then the
channels with PAN IDs are eliminated from consideration for the energy scan. After the energy scan
completes, the channel with the least energy is selected for forming the new network.
Whenever CE, ID, A2, or MY changes, the network will leave and association will recur with the new
parameters. Any end devices associated to the coordinator prior to changing one of these parameters
will lose association. For this reason, it is important not to change these parameters on a coordinator
unless needed.
Before the Coordinator forms a network, the Associate LED will be on solid. After it forms a network,
the Associate LED will blink once per second.
Indirect addressing
The XBee/XBee-PRO S2C 802.15.4 RF Module may hold indirect messages until it runs out of buffers
and the size of those messages does not matter. A brief summary follows:
A coordinator (CE = 1) must have SP set to a non-zero value to use indirect addressing. Otherwise, all
frames will be sent directly, assuming the target device is awake. For best operation, SP and ST
should be set to match the SP and ST values of the end nodes. The coordinator will hold onto an
indirect message until it receives a poll from the device to which the message is addressed, or until a
timeout, whichever occurs first. The timeout is 2.5 times the value of SP.
After an indirect message is sent, subsequent messages to the same address will be sent directly for a
period of time equal to the ST parameter. The assumption is that the end device will remain awake
for ST time after the last transmission or reception. Therefore, after a poll, every transmission and
reception involving that address restart the ST timer. After the ST timer expires, the coordinator will
again use indirect messaging (i.e it will hold messages awaiting a poll.)
End devices using cyclic sleep send a poll to the coordinator when they wake up unless SO bit 0 is
set. End devices using pin sleep may be configured to send a poll on a pin wakeup by setting bit 3 of
A1. Also the FP command can be used to send a poll upon exiting command mode. However, the poll
is not sent while in command mode. Rather the poll is sent after changes are applied so that the
module is ready to receive data after the poll is sent.
It is more difficult to use indirect addressing with pin sleep than with cyclic sleep because the end
device must wake up periodically to poll for the data from the coordinator. Otherwise, the coordinator
will discard the data. Therefore, cyclic sleep is the only recommended sleep mode for indirect
addressing.
Association indicators
There are two types of association indicators: Asynchronous device status messages, and on demand
queries. Asynchronous device status messages occur whenever a change occurs and API mode is
enabled. On demand queries occur when the AI command is issued, which can occur in Command
mode, in API mode, or as a remote command.
Type Meaning
0x00 Hardware reset.
0x01 Watchdog reset.
0x02 End device successfully associated with a coordinator.
0x03 End device disassociated from coordinator or coordinator failed to form a new network.
0x06 Coordinator formed a new network.
0x0D Input voltage on the XBee-PRO device is too high, which prevents transmissions.
Code Meaning
0x00 Coordinator successfully started, End device successfully associated, or operating in peer
to peer mode where no association is needed.
0x03 Active Scan found a PAN coordinator, but it is not currently accepting associations.
0x04 Active Scan found a PAN coordinator in a beacon-enabled network, which is not a
supported feature.
0x05 Active Scan found a PAN, but the PAN ID does not match the configured PAN ID on the
requesting end device and bit 0 of A1 is not set to allow reassignment of PAN ID.
0x06 Active Scan found a PAN on a channel does not match the configured channel on the
requesting end device and bit 1 of A1 is not set to allow reassignment of the channel.
0x0C Association request failed to get a response.
0x13 End device is disassociated or is in the process of disassociating.
0xFF Initialization time; no association status has been determined yet.
Sleep
Sleep is implemented to support installations where a mains power source is not available and a
battery is required. In order to increase battery life, the device sleeps, which means it stops operating.
It can be woken by a timer expiration or a pin.
For more information about sleep modes, see Sleep modes.
Sleep conditions
Since instructions stop executing while the device is sleeping, it is important to avoid sleeping when
the device has work to do. For example, the device will not sleep if any of the following are true:
1. The device is operating in command mode, or in the process of getting into command mode
with the +++ sequence.
2. The device is processing AT commands from API mode
3. The device is processing remote AT commands
4. Something is queued to the serial port and that data is not blocked by RTS flow control
If each of the above conditions are false, then sleep may still be blocked in these cases:
1. Enough time has not expired since the device has awakened.
a. If the device is operating in pin sleep, the amount of time needed for one character to be
received on the UART is enough time.
b. If the device is operating in cyclic sleep, enough time is defined by a timer. The duration of
that timer is:
i. defined by ST if in SM 5 mode and it is awakened by a pin
ii. 30 ms to allow enough time for a poll and a poll response
iii. 750 ms to allow enough time for association, in case that needs to happen
c. In addition, the wake time is extended by an additional ST time when new OTA data or
serial data is received.
2. Sleep Request pin is not asserted when operating in pin sleep mode
3. Data is waiting to be sent OTA.
Note Customers in Europe who have the XBee 802.15.4 module must manage their CCA settings. See
CA (CCA Threshold) for CA values.
CCA operations
CCA is a method of collision avoidance that is implemented by detecting the energy level on the
transmission channel before starting the transmission. The CCA threshold (defined by the CA
parameter) defines the energy level that it takes to block a transmission attempt. For example, if CCA
is set to the default value of 0x2C (which is interpreted as -44 dBm) then energy detected above the -
44 dBm level (for example -40 dBm) temporarily blocks a transmission attempt. But if the energy level
is less than that (for example -50 dBm), the transmission is not blocked. The intent of this feature is to
prevent simultaneous transmissions on the same channel.
CCA can be set down to 0x50 (or -80 dBm), which approaches the sensitivity level. Setting such a
threshold may not work in a noisy environment.
In the event that the energy level exceeds the threshold, the transmission is blocked some random
number of backoff periods. The number of backoff periods is defined by random(2^n - 1) where the
initial value of n is defined by the RN parameter and it increments after each failure. When RN is set to
its default value of 0, then 2^n -1 is 0, preventing any delay before the first energy detection on a new
frame. However, n increments after each CCA failure, giving a greater range for the number of backoff
periods between each energy detection cycle.
In the event that five energy detection cycles occur and each one detects too much energy, the
application tries again 1 to 48 ms later. After the application retries are exhausted, then the
transmission fails with a CCA error.
Whenever the MAC code reports a CCA failure, meaning that it performed five energy detection cycles
with exponential random back-offs, and each one failed, the EC parameter is incremented. The EC
parameter can be read at any time to find out how noisy the operating channel is. It continues to
increment until it reaches its maximum value of 0xFFFF. To get new statistics, you can always set EC
back to 0.
Serial interface
The XBee/XBee-PRO S2C 802.15.4 RF Module interfaces to a host device through a serial port. The
device can communicate through its serial port with:
n Through logic and voltage compatible universal asynchronous receiver/transmitter (UART).
n Through a level translator to any serial device, for example, through an RS-232 or USB interface
board.
n Through a SPI, as described in SPI signals.
Serial data
A device sends data to the XBee/XBee-PRO S2C 802.15.4 RF Module's UART through TH pin 3/SMT pin
4 DIN as an asynchronous serial signal. When the device is not transmitting data, the signals should
idle high.
For serial communication to occur, you must configure the UART of both devices (the microcontroller
and the XBee/XBee-PRO S2C 802.15.4 RF Module) with compatible settings for the baud rate, parity,
start bits, stop bits, and data bits.
Each data byte consists of a start bit (low), 8 data bits (least significant bit first) and a stop bit (high).
The following diagram illustrates the serial bit pattern of data passing through the device. The
diagram shows UART data packet 0x1F (decimal number 31) as transmitted through the device.
Flow control
The XBee/XBee-PRO S2C 802.15.4 RF Module maintains buffers to collect serial and RF data that it
receives. The serial receive buffer collects incoming serial characters and holds them until the device
can process them. The serial transmit buffer collects the data it receives via the RF link until it
transmits that data out the serial port. The following figure shows the process of device buffers
collecting received serial data.
1. If the RF data rate is set higher than the interface data rate of the device, the device may
receive data faster than it can send the data to the host. Even occasional transmissions from a
large number of devices can quickly accumulate and overflow the transmit buffer.
2. If the host does not allow the device to transmit data out from the serial transmit buffer due to
being held off by hardware flow control.
Asynchronous Parameters
Asynchronous communication over a UART is configured with a start bit, data bits, parity, stop bits,
and baud rate. Out of these, only parity and baud rate are configurable on the device for 802.15.4. This
means that the connecting micro-controller must match the the start bits (1), the data bits (8), and the
stop bits (1) of the device for proper communication.
Parity
Use the NB command to configure parity; see NB (Parity).
SPI operation
This section specifies how SPI is implemented on the device, what the SPI signals are, and how full
duplex operations work.
SPI signals
The XBee/XBee-PRO S2C 802.15.4 RF Module supports SPI communications in slave mode. Slave mode
receives the clock signal and data from the master and returns data to the master. The SPI port uses
the following signals on the device:
By default, the inputs have pull-up resistors enabled. Use the PR command to disable the pull-up
resistors. When the SPI pins are not connected but the pins are configured for SPI operation, then the
device requires the pull-ups for proper UART operation.
Signal description
SPI_MISO: When SPI_CLK is active, the device outputs the data on SPI_MISO at the SPI_CLK rate. If
there are other SPI slave devices connected to the same SPI master, then the SPI_MISO output from
XBee device must be externally tri-stated when SPI_SSEL is de-asserted to prevent multiple devices
from driving SPI_MISO.
SPI_MOSI: The SPI master outputs data on this line at the SPI_CLK rate after it selects the desired
slave. When you configure the device for SPI operations, this pin is an input.
SPI_SCLK: The SPI master outputs a clock on this pin, and the rate must not exceed the maximum
allowed, 5 Mb/s. This signal clocks data transfers on MOSI and MISO.
SPI_SSEL: The SPI master outputs a low signal on this pin to select the device as an SPI slave. When
you configure the device for SPI operations, this pin is an input. This signal enables serial
communication with the slave.
SPI_ATTN: The device asserts this pin low when it has data to send to the SPI master. When you
configure this pin for SPI operations, it is an output (not tri-stated). This signal alerts the master that
the slave has data queued to send. The device asserts this pin as soon as data is available to send to
the SPI master and it remains asserted until the SPI master has clocked out all available data.
SPI parameters
Most host processors with SPI hardware allow you to set the bit order, clock phase and polarity. For
communication with all XBee/XBee-PRO S2C 802.15.4 RF Modules, the host processor must set these
options as follows:
n Bit order: send MSB first
n Clock phase (CPHA): sample data on first (leading) edge
n Clock polarity (CPOL): first (leading) edge rises
All XBee/XBee-PRO S2C 802.15.4 RF Modules use SPI mode 0 and MSB first. Mode 0 means that data is
sampled on the leading edge and that the leading edge rises. MSB first means that bit 7 is the first bit
of a byte sent over the interface.
I/O support
The following topics describe analog and digital I/O line support, line passing and output control.
DIO1 32 19 D1 (DIO1/AD1)
DIO2 31 18 D2 (DIO2/AD2)
DIO3 30 17 D3 (DIO3/AD3)
DIO4 24 11 D4 (DIO4)
DIO5 28 15 D5 (DIO5/ASSOCIATED_INDICATOR)
DIO6 29 16 D6 (DIO6/RTS)
DIO7 25 12 D7 (DIO7/CTS)
DIO8 10 9 D8 (DIO8/SLEEP_REQUEST)
Analog input
Analog input is available on D0 through D3 by configuring these parameters to 2. Analog input is not
available on D4 and D5.
Output Description
01 Indicates one sample. That is the only possibility for Command mode.
20E Mask to indicate which lines are sampled (A0, D3, D2, and D1).
00A Digital sample indicates D3 high, D2 low, and D1 high.
3FF Analog sample for A0 indicates that A0 is reading maximum voltage of 1.2 V.
Sample data follows the header and the channel indicator frame determines how to read the sample
data. If any of the DIO lines are enabled, the first two bytes are the DIO sample. The ADC data follows.
ADC channel data is represented as an unsigned 10-bit value right-justified on a 16- bit boundary. The
following figure illustrates the sample data bits.
API support
I/O data is sent out the UART using an API frame. All other data can be sent and received using
Transparent Operation or API frames if API mode is enabled (AP > 0).
API Operations support two RX (Receive) frame identifiers for I/O data (set 16-bit address to 0xFFFE
and the device does 64-bit addressing):
n 0x82 for RX Packet: 64-bit Address I/O
n 0x83 for RX Packet: 16-bit Address I/O
The API command header is the same as shown in 64-bit Receive Packet - 0x80 and 16-bit I/O Sample
Indicator - 0x83. RX data follows the format described in I/O data format.
Source node
On the source node, the IR parameter specifies how many milliseconds between samples. The IT
parameter specifies how many samples will be sent OTA in a single packet, and the DH/DL parameters
designate the node that will receive the samples. In addition MM must be 0 or 3 for I/O samples to be
sent.
The maximum value of IR is 0xFFFF. If IR is 0, periodic I/O sampling is disabled. Otherwise, IR specifies
the number of milliseconds between samples.
If IT is 0, than an I/O sample is sent every IR milliseconds. If IR is greater than 0, then an I/O sample is
sent every IR*IT milliseconds. Any single-byte value (0 - 0xFF) is accepted for input. However, the
value is adjusted downward based on how many I/O samples can fit into a maximum size packet. A
query of the IT parameter after changes are applied tells how many I/O samples will actually occur.
Since MM must be 0 or 3 to send I/O samples, the maximum payload in the best of conditions (short
source address, short destination address, and no encryption) is 114 bytes. Seven of those bytes are
used by the command header and the I/O header, leaving 107 bytes for I/O samples. The minimum I/O
sample is 2 bytes. Therefore the maximum possible usable value for IT is 53 (or 0x35).
Although samples may be taken every millisecond, IR*IT should be at least 20 milliseconds. This
allows time for OTA transmission and output on the serial port of the receiving module.
Destination node
On the destination node, the IU parameter enables the serial port to output I/O samples it receives. IU
is set to 1 by default. If IU is set and the destination node is not in Command mode, it displays
samples it receives on its serial port in API format. The AP parameter is ignored in this case.
Data format
The I/O sample is formatted as follows:
IT Mask Samples
1 byte 2 bytes 2 * number of samples
Reserved A3 - A0 D8 - D0
3 bits 4 analog bits 9 digital bits
If you set any of the digital bits, then a digital sample follows the Mask.
For every analog bit that is set, there is a 10-bit sample using two bytes where A0 is included first and
A3 is included last.
The number of samples indicated by the mask is repeated IT times. The mask is not repeated.
The sending node sends I/O samples to the address specified by DH/DL. The receiving node displays
the samples as described above, providing API mode is enabled, the node is not in Command mode,
and the IU parameter is 1 (IU is 1 by default). If any of these are false, the I/O sample is discarded
without being displayed.
1. This packet does not contain DIO8 and does not contain any analog samples. However, it does
contain a digital reading of the D0 - D7 pins configured for input or output, whether or not all
those bits are set in IC.
2. Any queued samples are transmitted before the change detect data. This may result in
receiving a packet with less than IT (Samples before TX) samples.
Change detect does not affect Pin Sleep wake-up. The D8 pin (DI8/SLEEP_RQ/DTR ) is the only line
that wakes a device from Pin Sleep. If not all samples are collected, the device still enters Sleep mode
after a change detect packet is sent.
Change detect is only supported when the Dx (DIOx Configuration) parameter equals 3, 4 or 5.
Output control
The IO (Digital Output Level) command controls the output levels of D0 through D7 that are
configured as output pins (either 4 or 5). These values override the configured output levels of the
pins until they are changed again (the pins do not automatically revert to their configured values after
a timeout.) You can use the IO command to trigger a sample on change detect.
Sleep support
Set SO (Sleep Options) bit 1 to suppress automatic wake-up sampling.
When a device wakes, it always performs a sample based on any active ADC or DIO lines. This allows
sampling based on the sleep cycle whether it be Cyclic Sleep (SM = 4 or 5) or Pin Sleep (SM = 1). Set
the IR (Sample Rate) parameter to gather more samples when awake.
For Cyclic Sleep modes: If the IR parameter is set, the device stays awake until the IT (Samples before
TX) parameter is met. The device stays awake for ST (Time before Sleep).
Sleep modes
Sleep modes enable the device to enter states of low-power consumption when not in use. In order to
enter Sleep mode, one of the following conditions must be met (in addition to the device having a
non-zero SM parameter value):
n SLEEP_RQ/DTR (TH pin 9/SMT pin 10) is asserted and the device is in a pin sleep mode (SM = 1,
or 5)
n The device is idle (no data transmission or reception) for the amount of time defined by the ST
(Time before Sleep) parameter.
Sleep parameters
The following AT commands are associated with the sleep modes. See the linked commands for the
parameter's description, range and default values.
n SM (Sleep Mode)
n SO (Sleep Options)
n A1 (End Device Association)
n ST (Time before Sleep)
Sleep current
The following table shows the sleep current during the XBee/XBee-PRO S2C 802.15.4 RF Module sleep
modes.
You can make devices use low sleep current by driving PWM outputs high during sleep and by using
internal pull-ups/pull-downs on disabled/unused pins. The sleep pins are set up for sleeping as
specified in Sleep pins. Additionally, pins that are outputs (other than PWM outputs) continue to
output the same levels during sleep. Normally, this means that pins configured for output high or low
will output high or low accordingly. However, if the output is overridden by I/O line passing, then the
overridden output level is maintained during the sleep time.
Sleep pins
The following table describes the three external device pins associated with sleep. For more details
about the pins, see Pin signals.
Pin
Pin name number Description
SLEEP_RQ TH pin For SM = 1, high puts the device to sleep and low wakes it up. For SM = 5,
9/SMT pin a high to low transition wakes the device up for ST time. The device
10 ignores a low to high transition in SM = 5.
CTS TH pin If D7 = 1, high indicates that the device is asleep and low indicates that it
12/SMT is awake and ready to receive serial data.
pin 25
ON_SLEEP TH pin Low indicates that the device is asleep and high indicates that it is awake
13/SMT and ready to receive serial data. For the XBee/XBee-PRO S2C 802.15.4 RF
pin 26 Module, this pin cannot be configured to anything different.
Indirect transmissions can only occur on a Coordinator. Thus, if all nodes in a network are End
Devices, only direct transmissions occurs. Indirect transmissions are useful to ensure packet delivery
to a sleeping node. The Coordinator currently is able to retain up to five two indirect messages.
Direct transmission
A Coordinator can be configured to use only direct transmission by setting the SP (Cyclic Sleep Period)
parameter to 0. Also, a Coordinator using indirect transmissions reverts to direct transmission if it
knows the destination device is awake.
To enable this behavior, the ST (Time before Sleep) value of the Coordinator must be set to match the
ST value of the End Device. Once the End Device either transmits data to the Coordinator or polls the
Coordinator for data, the Coordinator uses direct transmission for all subsequent data transmissions
to that device address until ST time occurs with no activity (at which point it reverts to using indirect
transmissions for that device address). "No activity" means no transmission or reception of messages
with a specific address. Broadcast messages do not reset the ST timer.
Indirect transmission
To configure Indirect Transmissions in a Personal Area Network (PAN), the SP (Cyclic Sleep Period)
parameter value on the Coordinator must be set to match the longest sleep value of any End Device.
The sleep period value on the Coordinator determines how long (time or number of beacons) the
Coordinator retains an indirect message before discarding it.
An End Device must poll the Coordinator once it wakes from Sleep to determine if the Coordinator has
an indirect message for it. For Cyclic Sleep Modes, this is done automatically every time the device
wakes (after SP time). For Pin Sleep Modes, the A1 (End Device Association) parameter value must be
set to enable Coordinator polling on pin wake-up (set in bit 3). Alternatively, an End Device can use
the FP (Force Poll) command to poll the Coordinator as needed.
Acknowledgment
If the transmission is not a broadcast message, the device expects to receive an acknowledgment
from the destination node. If an acknowledgment is not received, the packet is resent up to three
more times. If the acknowledgment is not received after all transmissions, an ACK failure is recorded.
Node discovery
Node discovery has three variations as shown in the following table:
Node discovery
The node discovery command (without an NI string designated) sends out a broadcast to every node
in the PAN ID. Each node in the PAN sends a response back to the requesting node.
When the node discovery command is issued in AT command mode, all other AT commands are
inhibited until the node discovery command times out, as specified by the NT parameter. After the
timeout, an extra CRLF is output to the terminal window, indicating that new AT commands can be
entered. This is the behavior whether or not there were any nodes that responded to the broadcast.
When the node discovery command is issued in API mode, the behavior is the same except that the
response is output in API mode. If no nodes respond, there will be no responses at all to the node
discover command. The requesting node is not able to process a new AT command until NT times out.
Destination Node
The Destination Node command (DN with an NI string parameter) sends out a broadcast containing
the NI string being requested. The responding node with a matching NI string sends its information
back to the requesting node. The local node then sets DH/DL to match the address of the responding
node. As soon as this response occurs, the command terminates successfully. If operating in AT
command mode, an OK string is output and command mode exits. In API mode another AT command
may be entered.
If an NI string parameter is not provided, the DN command terminates immediately with an error. If a
node with the given NI string doesn't respond, the DN command terminates with an error after NT
times out.
Unlike ND (with or without an NI string), DN does not cause the information from the responding
node to be output; rather it simply sets DH/DL to the address of the responding node. If the
responding node has a short address, then DH/DL is set to that short address (with DH at 0 and the
ms 16 bits of DL at 0). If the responding node has a long address (MY is FFFE), then DH/DL are set to
the SH/SL of the responding node.
CAUTION! It is important to set the short address to 0xFFFE when sending to a long address.
Any other value causes the long address to be ignored. This is particularly problematic in the
case where nodes are set up with default addresses of 0 and the 16-bit address is erroneously
left at 0. In that case, even with a correct long address the remote command goes out to all
devices with the default short address of 0, potentially resulting in harmful consequences,
depending on the command.
1. Set the Apply Changes option bit in the Remote AT Command Request frame (0x17).
2. Issue an AC (Apply Changes) command to the remote device.
3. Issue a WR + FR command to the remote device to save changes and reset the device.
Special commands 82
Networking and security commands 82
RF interfacing commands 98
Sleep commands 100
Serial interfacing commands 102
I/O settings commands 105
I/O line passing commands 116
Diagnostic commands 119
Command mode options 121
Special commands
The following commands are special commands.
WR (Write)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Writes parameter values to non-volatile memory so that parameter modifications persist through
subsequent resets.
Writing parameters to non-volatile memory does not apply the changes immediately. However, since
the device uses non-volatile memory to determine initial configuration following reset, the written
parameters are applied following a reset.
Note Once you issue a WR command, do not send any additional characters to the device until after
you receive the OK response.
Parameter range
N/A
Default
N/A
RE (Restore Defaults)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Restore device parameters to factory defaults. Does not exit out of Command mode.
Parameter range
N/A
Default
N/A
FR (Software Reset)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Resets the device. The device responds immediately with an OK and performs a reset 100 ms later.
If you issue FR while the device is in Command Mode, the reset effectively exits Command mode.
Parameter range
N/A
Default
N/A
C8 (802.15.4 Compatibility)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Sets or displays the operational compatibility with the Legacy 802.15.4 module (S1 hardware).
Parameter range
0-3
Bit field:
1 Node 0 Node discovery operates like other XBee devices and not like the
Discovery Legacy 802.15.4 module. This means the following:
compatibility
1. A directed ND request terminates after the single
response arrives. This allows the device to process other
commands without waiting for the NT to time out.
2. The device outputs an error response to the directed ND
request if no response occurs within the time out.
1 The module operates like the Legacy 802.15.4 module, which has
the following effect:
1This bit does not normally need to be set. However, when the XBee/XBee-PRO S2C 802.15.4 RF Module is
streaming broadcasts in transparent mode to a Legacy 802.15.4 module (S1 hardware), and RR > 0, then this bit
does need to be set to avoid a watchdog reset on the Legacy 802.15.4 module.
Default
0
CH (Operating Channel)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Set or read the operating channel devices used to transmit and receive data. The channel is one of
three addressing configurations available to the device. The other configurations are the PAN ID (ID
command) and destination addresses (DL and DH commands).
In order for devices to communicate with each other, they must share the same channel number. A
network can use different channels to prevent devices in one network from listening to the
transmissions of another. Adjacent channel rejection is 23 dB.
The command uses 802.15.4 channel numbers. Center frequency = 2405 MHz + (CH - 11 decimal) * 5
MHz.
Parameter range
0xB - 0x1A (XBee)
0x0C - 0x17 (XBee-PRO)
Default
0xC (12 decimal)
ID (Network ID)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Set or read the user network identifier.
Devices must have the same network identifier to communicate with each other.
Devices can only communicate with other devices that have the same network identifier and channel
configured.
Setting the ID parameter to 0xFFFF indicates a global transmission for all PANs. It does not indicate a
global receive.
Parameter range
0 - 0xFFFF
Default
0x3332 (13106 decimal)
Parameter range
0 - 0xFFFFFFFF
Default
0
Parameter range
0 - 0xFFFFFFFF
Default
0
MY (Source Address)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Sets or displays the device's 16-bit source address. Set MY = 0xFFFF to disable reception of packets
with 16-bit addresses. Regardless of MY, messages addressed to the 64-bit long address of the device
are always delivered.
Parameter range
0 - 0xFFFF
Default
0
The 64-bit source address is always enabled. This value is read-only and it never changes.
Parameter range
0 - 0xFFFFFFFF [read-only]
Default
Set in the factory
Parameter range
0 - 0xFFFFFFFF [read-only]
Default
Set in the factory
MM (MAC Mode)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
The MM command is used to set and read the MAC Mode value. The MM command disables/enables
the use of a Digi header contained in the 802.15.4 RF packet. By default (MM = 0), Digi Mode is enabled
and the module adds an extra header to the data portion of the 802.15.4 packet. This enables the
following features:
n ND and DN command support
n Duplicate packet detection when using ACKs
n Remote command support
n RR command
n DIO/AIO sampling support
n OTA firmware updates
The MM command allows users to turn off the use of the extra header. Modes 1 and 2 are strict
802.15.4 modes. If the Digi header is disabled, the features above are also disabled.
When MM = 1 or 3, MAC retries are not supported.
When the Digi header is disabled, encrypted data that is not valid will be sent out of the UART and not
filtered out.
Parameter range
0-3
Parameter Configuration
0 Digi Mode (802.15.4 + Digi header)
1 802.15.4 (no ACKs)
2 802.15.4 (with ACKs)
3 Digi Mode (no ACKs)
Default
0
RR (XBee Retries)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Set or reads the maximum number of retries the device executes in addition to the three retries
provided by the 802.15.4 MAC. For each device retry, the 802.15.4 MAC can execute up to three retries.
The following applies for broadcast messages: If RR = 0, only one packet is broadcast. If RR is > 0, RR
+ 2 packets are sent on each broadcast. No acknowledgments are returned on a broadcast.
This value does not need to be set on all devices for retries to work. If retries are enabled, the
transmitting device sets a bit in the Digi RF Packet header that requests the receiving device to send
an ACK. If the transmitting device does not receive an ACK within 200 ms, it re-sends the packet within
a random period up to 48 ms. Each device retry can potentially result in the MAC sending the packet
four times (one try plus three retries). Retries are not attempted for indirect messages that are purged.
Parameter range
0-6
Default
0
Parameter range
0 - 3 (exponent)
Default
0
ND (Network Discovery)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Discovers and reports all devices found in the network. For each discovered device, the following
information is returned after a jittered time delay:
Node discover response when issued in Command mode:
MY<CR> (2 bytes) (always 0xFFFE)
SH<CR> (4 bytes)
SL<CR> (4 bytes)
DB<CR> (Contains the detected signal strength of the response in negative dBm units)
NI <CR> (variable, 0-20 bytes plus 0x00 character)
PARENT_NETWORK ADDRESS<CR> (2 bytes)
DEVICE_TYPE<CR> (1 byte: 0 = Coordinator, 1 = Router, 2 = End Device)
STATUS<CR> (1 byte: reserved)
PROFILE_ID<CR> (2 bytes)
MANUFACTURER_ID<CR> (2 bytes)
DIGI DEVICE TYPE<CR> (4 bytes. Optionally included based on NO settings.)
RSSI OF LAST HOP<CR> (1 byte. Optionally included based on NO settings.)
A second carriage return will indicate the network discovery timeout (NT) has expired.
When operating in API mode and a Network Discovery is issued as a 0x08 or 0x09 frame, the response
will contain binary data except for the NI string in the following format:
2 bytes for Short Source Address
4 bytes for Upper Long Address
4 bytes for Lower Long Address
1 byte for the signal strength in -dBm (two's compliment representation)
NULL-terminated string for NI (Node Identifier) value (maximum 20 bytes without NULL
terminator)
Each device that responds to the request will generate a separate Local AT Command Response -
0x88.
Broadcast an ND command to the network. If the command includes an optional node identifier string
parameter, only those devices with a matching NI string respond without a random offset delay. If the
command does not include a node identifier string parameter, all devices respond with a random
offset delay.
The NT setting determines the maximum timeout (13 seconds by default), this value is sent along with
the discovery broadcast and determines the random delay the remote nodes use to prevent the
responses from colliding.
For more information about options that affect the behavior of the ND command Refer to the
description of the NO command for options which affect the behavior of the ND command.
WARNING! If the NT setting is small relative to the number of devices on the network,
responses may be lost due to channel congestion. Regardless of the NT setting, because
the random offset only mitigates transmission collisions, getting responses from all devices
in the network is not guaranteed.
Parameter range
20-byte printable ASCII string
Default
N/A
Parameter range
0x1 - 0xFC (x 100 ms)
Default
0x19 (2.5 decimal seconds)
Parameter range
0-1
Default
0x0
DN (Discover Node)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Resolves an NI (Node identifier) string to a physical address (case sensitive).
The following events occur after DN discovers the destination node:
When DN is sent in Command mode :
1. The device sets DL and DH to the address of the device with the matching NI string.
The address selected (either 16-bit short address or 64-bit extended address) is chosen based
on the destination device's MY command configuration.
2. The receiving device returns OK (or ERROR).
3. The device exits Command mode to allow for immediate communication. If an ERROR is
received, then Command mode does not exit.
When DN is sent as a local AT Command API frame:
1. The receiving device returns the 16-bit network and 64-bit extended addresses in an API
Command Response frame.
2. If there is no response from a module within (NT* 100) milliseconds or you do not specify a
parameter (by leaving it blank), the receiving device returns an ERROR message. In the case of
an ERROR, the device does not exit command mode. Set the radius of the DN command using
the BH command.
When DN is sent as a local Local AT Command Request - 0x08:
1. The receiving device returns a success response in a Local AT Command Response - 0x88.
2. If there is no response from a module within (NT * 100) milliseconds or you do not specify a
parameter (by leaving it blank), the receiving device returns an ERROR message.
Parameter range
20-byte ASCII string
Default
N/A
CE (Coordinator Enable)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
The routing and messaging mode of the device.
Parameter range
0-1
Parameter Description
0 End Device
1 Coordinator
Default
0
SC (Scan Channels)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Sets or displays the list of channels to scan for all Active and Energy Scans as a bit field. This affects
scans initiated in the AS (Active Scan) and ED (Energy Scan) commands in Command mode and
during End Device Association and Coordinator startup.
Parameter range
0 - 0xFFFF (bit field)
Bit Parameter
0 0x0B (not available on XBee-PRO)
1 0x0C
2 0x0D
3 0x0E
4 0x0F
5 0x10
6 0x11
7 0x12
8 0x13
9 0x14
10 0x15
11 0x16
12 0x17
13 0x18 (not available on XBee-PRO)
14 0x19 (not available on XBee-PRO)
15 0x1A (not available on XBee-PRO)
Default
0x1FFE
SD (Scan Duration)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Sets or displays the scan duration exponent.
Coordinator: If you set the ReassignPANID option on the coordinator (refer to A2 (Coordinator
Association)), SD determines the length of time the coordinator scans channels to locate existing
PANs. If you set the ReassignChannel option, SD determines how long the coordinator performs an
Energy Scan to determine which channel it will operate on.
End Device: Duration of Active Scan during Association. In a Beacon system, set SD=BE of the
coordinator. SD must be set at least to the highest BE parameter of any Beaconing Coordinator with
which an end device or coordinator wants to discover.
Scan Time is measured as:
([# of channels to scan] * (2 ^SD) * 15.36 ms) + (38 ms * [# of channels to scan]) + 20 ms
Use the SC (Scan Channels) command to set the number of channels to scan. The XBee can scan up to
16 channels (SC = 0xFFFF). The XBee-PRO can scan up to 13 channels (SC= 0x1FFE).
SD influences the time the MAC listens for beacons or runs an energy scan on a given channel.
Example
The following table shows the results for a thirteen channel scan.
SD setting Time
0 0.18 s
2 0.74 s
4 2.95 s
6 11.80 s
8 47.19 s
10 3.15 min
12 12.58 min
14 50.33 min
Parameter range
0 - 0x0F (exponent)
Default
4
Parameter range
0 - 0x0F (bit field)
Bit field:
Default
0
A2 (Coordinator Association)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Sets or displays the Coordinator association options.
Parameter range
0 - 7 (bit field)
Bit field:
1 Allow Channel 0 Coordinator will not perform Energy Scan to determine free
reassignment channel. It operates on the channel determined by the CH
parameter.
The binary equivalent of the default value (0x06) is 00000110. ‘Bit 0’ is the last digit of the sequence.
Default
0
AI (Association Indication)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Reads the Association status code to monitor association progress. The following table provides the
status codes and their meanings.
Status
code Meaning
0x00 Coordinator successfully started, End device successfully associated, or operating in peer
to peer mode where no association is needed.
0x03 Active Scan found a PAN coordinator, but it isn't currently accepting associations.
0x04 Active Scan found a PAN coordinator in a beacon-enabled network, which is not a
supported feature.
0x05 Active Scan found a PAN, but the PAN ID doesn't match the configured PAN ID on the
requesting end device and bit 0 of A1 is not set to allow reassignment of PAN ID.
0x06 Active Scan found a PAN on a channel that does not match the configured channel on the
requesting end device and bit 1 of A1 is not set to allow reassignment of the channel.
Parameter range
0 - 0x13 [read-only]
Default
N/A
DA (Force Disassociation)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Causes the End Device to immediately disassociate from a Coordinator (if associated) and re-attempt
to associate.
Parameter range
-
Default
-
FP (Force Poll)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
The FP command is deferred until changes are applied. This prevents indirect messages from arriving
at the end device while it is operating in Command mode.
Parameter range
N/A
Default
N/A
AS (Active Scan)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Sends a Beacon Request to a Broadcast address (0xFFFF) and Broadcast PAN (0xFFFF) on every
channel in SC. SD determines the amount of time the device listens for Beacons on each channel. A
PanDescriptor is created and returned for every Beacon received from the scan. Each PanDescriptor
contains the following information:
CoordAddress (SH + SL parameters)<CR>
Note If MY on the coordinator is set less than 0xFFFF, the MY value is displayed.
Parameter range
0-6
Default
N/A
ED (Energy Detect)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Starts an energy detect scan. This command accepts an argument to specify the time in milliseconds
to scan all channels. The device loops through all the available channels until the time elapses. It
returns the maximal energy on each channel, a comma follows each value, and the list ends with a
carriage return. The values returned reflect the energy level that ED detects in -dBm units.
Parameter range
0-6
Default
N/A
EE (Encryption Enable)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Enables or disables Advanced Encryption Standard (AES) encryption.
Set this command parameter the same on all devices in a network.
The firmware uses the 802.15.4 Default Security protocol and uses AES encryption with a 128-bit key.
AES encryption dictates that all devices in the network use the same key, and that the maximum RF
packet size is 95 bytes if Tx compatibility is enabled (you set bit 0 of C8). If C8, bit 0 is not set, see
Maximum payload.
When encryption is enabled, the device always uses its 64-bit long address as the source address for
RF packets. This does not affect how the MY (Source Address), DH (Destination Address High) and DL
(Destination Address Low) parameters work.
If MM (MAC Mode) is set to 1 or 2 and AP (API Enable) parameter > 0:
With encryption enabled and a 16-bit short address set, receiving devices can only issue RX
(Receive) 64-bit indicators. This is not an issue when MM = 0 or 3.
If a device with a non-matching key detects RF data, but has an incorrect key:
When encryption is enabled, non-encrypted RF packets received are rejected and are not sent out the
UART.
Parameter range
0-1
Parameter Description
0 Encryption Disabled
1 Encryption Enabled
Default
0
This command is write-only. If you attempt to read KY, the device returns an OK status.
Set this command parameter the same on all devices in a network.
The entire payload of the packet is encrypted using the key and the CRC is computed across the
ciphertext.
Parameter range
128-bit value (up to 16 bytes)
Default
0
NI (Node Identifier)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Stores the node identifier string for a device, which is a user-defined name or description of the
device. This can be up to 20 ASCII characters.
n XCTU prevents you from exceeding the string limit of 20 characters for this command. If you
are using another software application to send the string, you can enter longer strings, but the
software on the device returns an error.
Use the ND (Network Discovery) command with this string as an argument to easily identify devices on
the network.
The DN command also uses this identifier.
Parameter range
A string of case-sensitive ASCII printable characters from 1 to 20 bytes in length. The string cannot
start with the space character. A carriage return or a comma automatically ends the command.
Default
0x20 (an ASCII space character)
Note NP returns a hexadecimal value. For example, if NP returns 0x66, this is equivalent to 102 bytes.
Parameter range
0 - 0xFFFF (bytes) [read-only]
Default
N/A
RF interfacing commands
The following AT commands are RF interfacing commands.
Parameter range
0-4
The following table shows the TX power versus the PL setting.
XBee modules
XBee-PRO modules
Default
4
PM (Power Mode)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Set or read the power mode of the device. Enabling boost mode improves the receive sensitivity by
2dB and increase the transmit power by 3dB.
Parameter range
0-1
Setting Meaning
0 Boost mode disabled
1 Boost mode enabled
Default
1
CA (CCA Threshold)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Set or read the Clear Channel Assessment (CCA) threshold. Prior to transmitting a packet, the device
performs a CCA to detect energy on the channel. If the device detects energy above the CCA threshold,
it will not transmit the packet.
The CA parameter is measured in units of -dBm.
Note If device is operating in Europe, this value must be set to 0x34 to comply with EN 300 328 Listen
Before Talk requirements. Alternatively the device can be set to PL3 as explained in Europe (CE).
Parameter range
0x28 - 0x50
Default
0x2C (-44 decimal dBm)
Sleep commands
The following AT commands are sleep commands.
SM (Sleep Mode)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Sets or displays the sleep mode of the device.
By default, Sleep Modes are disabled (SM = 0) and the device remains in Idle/Receive mode. When in
this state, the device is constantly ready to respond to either serial or RF activity.
Parameter range
0, 1, 4, 5
Parameter Description
0 No sleep (disabled)
1 Pin sleep
2 Reserved
3 Reserved
4 Cyclic Sleep Remote
5 Cyclic Sleep Remote with pin wakeup
Default
0
Parameter range
1 - 0xFFFF (x 1 ms)
Default
0x1388 (5 seconds)
Parameter range
0 - 0x15F900 (x 10 ms) (4 hours)
Default
0
Parameter range
1 - 0xFFFF
Default
0x3E8 (10 seconds)
SO (Sleep Options)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Set or read the sleep options bit field of a device. This command is a bitmask.
You can set or clear any of the available sleep option bits.
Parameter range
0 - 0x3
Bit field:
Default
0
Note When using XCTU, you can only set and read non-standard interface data rates using the XCTU
Terminal tab. You cannot access non-standard rates through the Modem Configuration tab.
When you send the BD command with a non-standard interface data rate, the UART adjusts to
accommodate the interface rate you request. In most cases, the clock resolution causes the stored BD
parameter to vary from the sent parameter. Sending ATBD without an associated parameter value
returns the value actually stored in the device’s BD register.
The following table provides the parameters sent versus the parameters stored.
BD parameter sent (HEX) Interface data rate (b/s) BD parameter stored (HEX)
0 1200 0
4 19,200 4
7 115,200 7
E100 57,600 E0D1
1C200 115,200 1C2B8
Parameter range
Standard baud rates: 0x0 - 0x8
Parameter Description
0x0 1200 b/s
0x1 2400 b/s
0x2 4800 b/s
0x3 9600 b/s
0x4 19200 b/s
0x5 38400 b/s
0x6 57600
0x7 115200 b/s
0x8 230400 b/s
Default
0x03 (9600 b/s)
NB (Parity)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Set or read the serial parity settings for UART communications.
The device does not actually calculate and check the parity. It only interfaces with devices at the
configured parity and stop bit settings.
Parameter range
0x00 - 0x04
Parameter Description
0x00 No parity
0x01 Even parity
0x02 Odd parity
0x03 Mark parity (forced high)
Default
0x00
RO (Packetization Timeout)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Set or read the number of character times of inter-character silence required before transmission
begins when operating in Transparent mode.
RF transmission will also commence when the maximum payload—see Maximum payload—is received
in the DI buffer.
Set RO to 0 to transmit characters as they arrive instead of buffering them into one RF packet.
Parameter range
0 - 0xFF (x character times)
Default
3
D7 (DIO7/CTS)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Sets or displays the DIO7/CTS configuration (TH pin 12/SMT pin 25).
Parameter range
0, 1, 3 - 7
Parameter Description
0 Disabled
1 CTS flow control
2 N/A
3 Digital input
4 Digital output, low
5 Digital output, high
6 RS-485 Tx enable, low Tx (0 V on transmit, high when idle)
7 RS-485 Tx enable high, high Tx (high on transmit, 0 V when idle)
Default
0x1
D6 (DIO6/RTS)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Sets or displays the DIO6/RTS configuration (TH pin 16/SMT pin 29).
Parameter range
0, 1, 3 - 5
Parameter Description
0 Disabled
1 RTS flow control
2 N/A
3 Digital input
Parameter Description
4 Digital output, low
5 Digital output, high
Default
0
AP (API Enable)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Set or read the API mode setting. The device can format the RF packets it receives into API frames and
send them out the serial port.
When you enable API, you must format the serial data as API frames because Transparent operating
mode is disabled.
Enables API Mode.
Parameter range
0-2
Parameter Description
0 Transparent mode, API mode is off. All UART input and output is raw data and the
device uses the RO parameter to delineate packets.
1 API Mode Without Escapes. The device packetizes all UART input and output data in
API format, without escape sequences.
2 API Mode With Escapes. The device is in API mode and inserts escaped sequences to
allow for control characters. When XON (0x11), XOFF (0x13), Escape (0x7D), and start
delimiter 0x7E are data, these bytes are escaped so that they never appear in the
data and so that they can always be interpreted with their special meanings.
Default
0
D0 (DIO0/AD0)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Sets or displays the DIO0/AD0 configuration (TH pin 20/SMT pin 33).
Parameter range
0, 2 - 5
Parameter Description
0 Disabled
0 Unmonitored digital input
1 N/A
2 ADC
3 Digital input
4 Digital output, low
5 Digital output, high
Default
0
D1 (DIO1/AD1)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Sets or displays the DIO1/AD1 configuration (TH pin 19/SMT pin 32).
Parameter range
0-5
Parameter Description
0 Disabled
1 Commissioning button
1 SPI_ATTN for the through-hole device
2 ADC
3 Digital input
4 Digital output, low
5 Digital output, high
Default
0
D2 (DIO2/AD2)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Sets or displays the DIO2/AD2 configuration (TH pin 18/SMT pin 31).
Parameter range
0-5
Parameter Description
0 Disabled
1 SPI_CLK for through-hole devices
2 ADC
3 Digital input
4 Digital output, low
5 Digital output, high
Default
0
D3 (DIO3/AD3)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Sets or displays the DIO3/AD3 configuration (TH pin 17/SMT pin 30).
Parameter range
0-5
Parameter Description
0 Disabled
0 Unmonitored digital input
1 SPI_SSEL for the through-hole device
Default
0
D4 (DIO4)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Sets or displays the DIO4 configuration (TH pin 11/SMT pin 24).
Parameter range
0, 1, 3 - 5
Parameter Description
0 Disabled
0 Unmonitored digital input
1 SPI_MOSI for the through-hole device
2 N/A
3 Digital input
4 Digital output, low
5 Digital output, high
Default
0
D5 (DIO5/ASSOCIATED_INDICATOR)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Sets or displays the DIO5/ASSOCIATED_INDICATOR configuration (TH pin 15/SMT pin 28).
Parameter range
0, 1, 3 - 5
Parameter Description
0 Disabled
1 Associate LED indicator - blinks when associated
2 N/A
3 Digital input
4 Digital output, default low
5 Digital output, default high
Default
1
D8 (DIO8/SLEEP_REQUEST)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Sets or displays the DI8/DTR/SLP_RQ configuration (TH pin 9/SMT pin 10).
This line is also used with Pin Sleep, but pin sleep ignores the D8 configuration. It is always used to
control pin sleep, regardless of configuration of D8.
Note When using Pin sleep, the internal pull up/down resistor is not used
Parameter range
0, 3
Parameter Description
0 Disabled
1 N/A
2 N/A
3 Digital input
4 N/A
5 N/A
Default
0
P0 (RSSI/PWM0 Configuration)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Sets or displays the RSSI/PWM0 configuration ().
This command enables the option of translating incoming data to a PWM so that the output can be
translated back into analog form.
If the IA (I/O Input Address) parameter is correctly set and P0 is configured as PWM0 output, incoming
AD0 samples automatically modify the PWM0 value.
Parameter range
0-2
Parameter Description
0 Disabled
1 RSSI PWM0 output
2 PWM0 output
Default
1
P1 (PWM1 Configuration)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Sets or displays the PWM1 configuration (TH pin 7/SMT pin 8).
If IA (I/O Input Address) is correctly set and P1 is configured as PWM1 output, incoming AD0 samples
automatically modify the PWM1 value.
Parameter range
0, 2
Parameter Description
0 Disabled
2 PWM1 output
Default
0
P2 (SPI_MISO)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Sets or displays the SPI_MISO configuration (TH pin 4/SMT pin 17). This only applies to through-hole
devices.
Parameter range
0-1
Parameter Description
0 Disabled
1 SPI_MISO
Default
0
Parameter range
0 - 0x3FF
Default
0
Parameter range
0 - 0x3FF
Default
0
P5 (SPI_MISO)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Sets or displays the SPI_MISO configuration.
This only applies to surface-mount devices.
Parameter range
0, 1
Parameter Description
0 Disabled
1 SPI_MISO
Default
1
P6 (SPI_MOSI Configuration)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Sets or displays the SPI_MOSI configuration.
This only applies to surface-mount devices.
Parameter range
0, 1
Parameter Description
0 Disabled
1 SPI_MOSI
Default
1
P7 (SPI_SSEL )
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Sets or displays the SPI_SSEL configuration.
This only applies to surface-mount devices.
Parameter range
1, 2
Parameter Description
0 Disabled
1 SPI_SSEL
Default
1
P8 (SPI_SCLK)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Sets or displays the DIO18/SPI_CLK configuration.
This only applies to surface-mount devices.
Parameter range
1, 2
Parameter Description
0 Disabled
1 SPI_SCLK
Default
1
P9 (SPI_ATTN)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Sets or displays the SPI_ATTN configuration (pin 12).
This only applies to surface-mount devices.
Parameter range
1, 2
Parameter Description
0 Disabled
1 SPI_ATTN
Default
1
Note When using Pin sleep, the internal pull up/down resistor is not used
PR and PD only affect lines that are configured as digital inputs or disabled.
The following table defines the bit-field map for PR and PD commands.
6 DI8/SLEEP_RQ (pin 9)
7 DIN/CONFIG (pin 3)
Parameter range
0 - 0xFF (bit field)
Default
0xFF
Example
Sending the command ATPR 6F turn bits 0, 1, 2, 3, 5 and 6 ON, and bits 4 and 7 OFF. The binary
equivalent of 0x6F is 01101111. Bit 0 is the last digit in the bit field.
Parameter range
0x0 - 0xFF
Default
0xFF
Parameter range
0-1
Parameter Description
0 Disabled
1 Enabled
Default
1
Parameter range
0x1 - 0xFF
Default
1
IS (Force Sample)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Forces a read of all enabled digital and analog input lines. The data is returned through the UART or
SPI.
When operating in Transparent mode (AP = 0), the data is returned in the following format:
All bytes are converted to ASCII:
number of samples<CR>
channel mask<CR>
DIO data<CR> (If DIO lines are enabled)
ADC channel Data<CR> (This will repeat for every enabled ADC channel)
<CR> (end of data noted by extra <CR>)
When operating in API mode (AP = 1), the command immediately returns an OK response. The data
follows in the normal API format for DIO data.
Parameter range
N/A
Default
N/A
Parameter range
8-bit bit map; each bit represents the level of an I/O line set up as an output
Default
N/A
Parameter range
0 - 0xFFFF (bit field)
Default
0
IR (Sample Rate)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Set or read the I/O sample rate to enable periodic sampling. When set, this parameter causes the
device to sample all enabled DIO and ADC at a specified interval.
To enable periodic sampling, set IR to a non-zero value, and enable the analog or digital I/O
functionality of at least one device pin (see D0 (DIO0/AD0) -D8 (DIO8/SLEEP_REQUEST), P0
(RSSI/PWM0 Configuration) -P2 (SPI_MISO).
WARNING! If you set IR to 1 or 2, the device will not keep up and many samples will be
lost.
Parameter range
0 - 0xFFFF (x 1 ms)
Default
0
Parameter range
0 - 0xFF (x 100 ms)
Default
0x28 (four seconds)
The source address of the device to which outputs are bound. If an I/O sample is received from the
address specified, any pin that is configured as a digital output or PWM changes its state to match
that of the I/O sample.
Set IA to 0xFFFFFFFFFFFFFFFF to disable I/O line passing.
Set IA to 0xFFFF to allow any I/O packet addressed to this device (including broadcasts) to change the
outputs.
Parameter range
0 - 0xFFFF FFFF FFFF FFFF
Default
0xFFFFFFFFFFFFFFFF (I/O line passing disabled)
T0 (D0 Timeout)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Specifies how long pin D0 holds a given value before it reverts to configured value. If set to 0, there is
no timeout.
Parameter range
0 - 0xFF (x 100 ms)
Default
0xFF
Parameter range
0 - 0xFF (x 100 ms)
Default
0xFF
Parameter range
0 - 0xFF (x 100 ms)
Default
0xFF
Parameter range
0 - 0xFF (x 100 ms)
Default
0xFF
Parameter range
0 - 0xFF (x 100 ms)
Default
0xFF
Parameter range
0 - 0xFF (x 100 ms)
Default
0xFF
Parameter range
0 - 0xFF (x 100 ms)
Default
0xFF
Parameter range
0 - 0xFF (x 100 ms)
Default
0xFF
Parameter range
0 - 0xFF (x 100 ms)
Default
0xFF
Diagnostic commands
The following AT commands are diagnostic commands. Diagnostic commands are typically volatile
and will not persist across a power cycle.
VR (Firmware Version)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Reads the firmware version on a device.
Firmware version numbers have four significant digits. The reported number shows three or four
numbers in hexadecimal notation. A version is reported as ABCD. Digits ABC are the main release
number and D is the revision number from the main release. D is not required and if it is not present, a
zero is assumed for D. B is a variant designator.
Parameter range
0x2000 - 0x20FF
Default
Set in the factory
VL (Version Long)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Shows detailed version information including the application build date and time.
Parameter range
N/A
Default
N/A
HV (Hardware Version)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Display the hardware version number of the device.
Parameter range
0 - 0xFFFF [read-only]
Default
Set in firmware
Parameter range
0 - 0xFF [read-only]
Default
N/A
EC (CCA Failures)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Resets or displays the count of Clear Channel Assessment (CCA) failures. This register increments
when the device does not transmit a packet because it detected energy above the CCA threshold level
set with CA command. This count saturates at its maximum value. Set the count to zero to reset the
count.
Parameter range
0 - 0xFFFF
Default
N/A
EA (ACK Failures)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Resets or displays the count of acknowledgment failures. This register increments when the device
expires the retries without receiving an ACK on a packet transmission. This count saturates at its
maximum value. Set the count to zero to reset the count.
Parameter range
0 - 0xFFFF
Default
N/A
Parameter range
0 - 0xFFFFFFFF
Default
0x10000
Parameter range
2 - 0x1770 (x 100 ms)
Default
0x64 (10 seconds)
Parameter range
N/A
Default
N/A
AC (Apply Changes)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Immediately applies new settings without exiting Command mode.
Applying changes means that the device is re-initialized based on changes made to its parameter
values. Once changes are applied, the device immediately operates according to the new parameter
values.
This behavior is in contrast to issuing the WR (Write) command. The WR command saves parameter
values to non-volatile memory, but the device still operates according to previously saved values until
the device is rebooted or the CN (Exit AT Command Mode) or AC commands are issued. For more
information, see Queue Local AT Command Request - 0x09.
Parameter range
N/A
Default
N/A
GT (Guard Times)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
Set the required period of silence before and after the command sequence characters of the
Command mode sequence (GT + CC + GT). The period of silence prevents inadvertently entering
Command mode.
Parameter range
0x2 - 0xCE4 (x 1 ms)
Default
0x3E8 (one second)
CC (Command Character)
This command applies to the XBee/XBee-PRO S2C 802.15.4 RF Module.
The character value the device uses to enter Command mode.
The default value (0x2B) is the ASCII code for the plus (+) character. You must enter it three times
within the guard time to enter Command mode. To enter Command mode, there is also a required
period of silence before and after the command sequence characters of the Command mode
sequence (GT + CC + GT). The period of silence prevents inadvertently entering Command mode.
Parameter range
0 - 0xFF
Default
0x2B (the ASCII plus character: +)
AP command
setting Description
AP = 0 Transparent operating mode, UART serial line replacement with API modes
disabled. This is the default option.
AP = 1 API operation.
AP = 2 API operation with escaped characters (only possible on UART).
The API data frame structure differs depending on what mode you choose.
The firmware silently discards any data it receives prior to the start delimiter. If the device does not
receive the frame correctly or if the checksum fails, the device discards the frame.
When operating in API 2, if an unescaped 0x7E byte is observed, it is treated as the start of a new API
frame and all data received prior to this delimiter is silently discarded. For more information on using
this API mode, refer to the following knowledge base article:
http://knowledge.digi.com/articles/Knowledge_Base_Article/Escaped-Characters-and-API-Mode-2
The following table shows the structure of an API frame with escaped characters:
Escape characters
When sending or receiving a UART data frame, you must escape (flag) specific data values so they do
not interfere with the data frame sequencing. To escape an interfering data byte, insert 0x7D and
follow it with the byte to be escaped XOR’d with 0x20. If not escaped, 0x11 and 0x13 are sent as is.
Data bytes that need to be escaped:
n 0x7E – Frame delimiter
n 0x7D – Escape
n 0x11 – XON
n 0x13 – XOFF
Example - Raw UART data frame (before escaping interfering bytes): 0x7E 0x00 0x02 0x23 0x11 0xCB
0x11 needs to be escaped which results in the following frame: 0x7E 0x00 0x02 0x23 0x7D 0x31 0xCB
Note In the previous example, the length of the raw data (excluding the checksum) is 0x0002 and the
checksum of the non-escaped data (excluding frame delimiter and length) is calculated as:
0xFF - (0x23 + 0x11) = (0xFF - 0x34) = 0xCB.
Start delimiter
This field indicates the beginning of a frame. It is always 0x7E. This allows the device to easily detect a
new incoming frame.
Length
The length field specifies the total number of bytes included in the frame's data field. Its two-byte
value excludes the start delimiter, the length, and the checksum.
Frame data
This field contains the information that a device receives or will transmit. The structure of frame data
depends on the purpose of the API frame:
Frame data
Start Frame
delimiter Length type Data Checksum
1 2 3 4 5 6 7 8 9 ... n n+1
0x7E MSB LSB API frame type Data Single byte
n Frame type is the API frame type identifier. It determines the type of API frame and indicates
how the Data field organizes the information.
n Data contains the data itself. This information and its order depend on the what type of frame
that the Frame type field defines.
Checksum
Checksum is the last byte of the frame and helps test data integrity. It is calculated by taking the hash
sum of all the API frame bytes that came before it, except the first three bytes (start delimiter and
length).
The device does not process frames sent through the serial interface with incorrect checksums, and
ignores their data.
1. Add all bytes of the packet, except the start delimiter 0x7E and the length (the second and
third bytes).
2. Keep only the lowest 8 bits from the result.
3. Subtract this quantity from 0xFF.
To verify the checksum of an API frame:
1. Add all bytes including the checksum; do not include the delimiter and length.
2. If the checksum is correct, the last two digits on the far right of the sum equal 0xFF.
Example
Consider the following sample data packet: 7E 00 0A 01 01 50 01 00 48 65 6C 6C 6F B8
Byte(s) Description
7E Start delimiter
00 0A Length bytes
01 API identifier
01 API frame ID
50 01 Destination address low
00 Option byte
Byte(s) Description
48 65 6C 6C 6F Data packet
B8 Checksum
To calculate the check sum you add all bytes of the packet, excluding the frame delimiter 7E and the
length (the second and third bytes):
7E 00 0A 01 01 50 01 00 48 65 6C 6C 6F B8
Add these hex bytes:
01 + 01 + 50 + 01 + 00 + 48 + 65 + 6C + 6C + 6F = 247
Now take the result of 0x247 and keep only the lowest 8 bits which, in this example, is 0x47 (the two
far right digits). Subtract 0x47 from 0xFF and you get 0xB8 (0xFF - 0x47 = 0xB8). 0xB8 is the checksum
for this data packet.
If an API data packet is composed with an incorrect checksum, the XBee/XBee-PRO S2C 802.15.4 RF
Module will consider the packet invalid and will ignore the data.
To verify the check sum of an API packet add all bytes including the checksum (do not include the
delimiter and length) and if correct, the last two far right digits of the sum will equal FF.
01 + 01 + 50 + 01 + 00 + 48 + 65 + 6C + 6C + 6F + B8 = 2FF
Frame descriptions
The following sections describe the API frames.
Description
This frame type is used to send serial payload data as an RF packet to a remote device with a
corresponding 64-bit IEEE address.
Note This frame format is deprecated and should only be used by customers who require
compatibility with legacy Digi RF products. For new designs, we encourage you to use Transmit
Request frame - 0x10 to initiate API transmissions.
Format
The following table provides the contents of the frame. For details on frame structure, see API frame
format.
4 8-bit Frame ID Identifies the data frame for the host to correlate with a
subsequent response.
If set to 0, the device will not emit a response frame.
5 64-bit Destination Set to the 64-bit IEEE address of the destination device.
address If set to 0x000000000000FFFF, the broadcast address is used.
13 8-bit Options A bit field of options that affect the outgoing transmission:
n Bit 0: Disable MAC ACK [0x01]
n Bit 1: Reserved (set to 0)
n Bit 2: Send packet with Broadcast PAN ID [0x04]
l 802.15.4 firmwares only
14-n variable RF data The serial data to be sent to the destination. Use NP to query
the maximum payload size that can be supported based on
current settings.
EOF 8-bit Checksum 0xFF minus the 8-bit sum of bytes from offset 3 to this byte
(between length and checksum).
Examples
Each example is written without escapes (AP = 1) and all bytes are represented in hex format. For
brevity, the start delimiter, length, and checksum fields have been excluded.
64-bit unicast
Sending a unicast transmission to a device with the 64-bit address of 0013A20012345678 with the
serial data "TxData".
The corresponding Transmit Status - 0x89 response with a matching Frame ID will indicate whether
the transmission succeeded.
7E 00 11 00 52 00 13 A2 00 12 34 56 78 00 54 78 44 61 74 61 9E
64-bit broadcast
Sending a broadcast transmission of the serial data "Broadcast" and suppressing the corresponding
response by setting Frame ID to 0.
7E 00 14 00 00 00 00 00 00 00 00 FF FF 00 42 72 6F 61 64 63 61 73 74 6E
Description
This frame type is used to send serial payload data as an RF packet to a remote device with a
corresponding 16-bit network address.
Note This frame format is deprecated and should only be used by customers who require
compatibility with legacy Digi RF products. For new designs, we encourage you to use Transmit
Request - 0x10 to initiate API transmissions.
Format
The following table provides the contents of the frame. For details on frame structure, see API frame
format.
4 8-bit Frame ID Identifies the data frame for the host to correlate with a
subsequent response.
If set to 0, the device will not emit a response frame.
5 16-bit Destination Set to the 16-bit network address of the destination device.
address If set to 0xFFFF, the broadcast address is used.
7 8-bit Options A bit field of options that affect the outgoing transmission:
n Bit 0: Disable MAC ACK [0x01]
n Bit 1: Reserved (set to 0)
n Bit 2: Send packet with Broadcast PAN ID [0x04]
l 802.15.4 firmwares only
8-n variable RF data The serial data to be sent to the destination. Use NP to query
the maximum payload size that can be supported based on
current settings.
EOF 8-bit Checksum 0xFF minus the 8-bit sum of bytes from offset 3 to this byte
(between length and checksum).
Examples
Each example is written without escapes (AP = 1) and all bytes are represented in hex format. For
brevity, the start delimiter, length, and checksum fields have been excluded.
16-bit unicast
Sending a unicast transmission to a device with the 16-bit address of 1234 with the serial data
"TxData".
The corresponding Transmit Status - 0x89 response with a matching Frame ID will indicate whether
the transmission succeeded.
7E 00 0B 01 87 12 34 00 54 78 44 61 74 61 EB
16-bit broadcast
Sending a broadcast transmission of the serial data "Broadcast" and suppressing the corresponding
response by setting Frame ID to 0.
7E 00 0E 01 00 FF FF 00 42 72 6F 61 64 63 61 73 74 6D
Description
This frame type is used to query or set command parameters on the local device. Any parameter that
is set with this frame type will apply the change immediately. If you wish to queue multiple parameter
changes and apply them later, use the Queue Local AT Command Request - 0x09 instead.
When querying parameter values, this frame behaves identically to Queue Local AT Command Request
- 0x09: You can query parameter values by sending this frame with a command but no parameter
value field—the two-byte AT command is immediately followed by the frame checksum. When an AT
command is queried, a Local AT Command Response - 0x88 frame is populated with the parameter
value that is currently set on the device. The Frame ID of the 0x88 response is the same one set by the
command in the 0x08 request frame.
Format
The following table provides the contents of the frame. For details on frame structure, see API frame
format.
4 8-bit Frame ID Identifies the data frame for the host to correlate with a
subsequent response.
If set to0, the device will not emit a response frame.
5 16-bit AT command The two ASCII characters that identify the AT Command.
7-n variable Parameter If present, indicates the requested parameter value to set
value the given register.
(optional) If no characters are present, it queries the current
parameter value and returns the result in the response.
EOF 8-bit Checksum 0xFF minus the 8-bit sum of bytes from offset 3 to this byte
(between length and checksum).
Examples
Each example is written without escapes (AP = 1) and all bytes are represented in hex format. For
brevity, the start delimiter, length, and checksum fields have been excluded.
7E 00 0E 08 A1 4E 49 45 6E 64 20 44 65 76 69 63 65 38
7E 00 04 08 17 54 50 3C
Description
This frame type is used to query or set queued command parameters on the local device. In contrast
to Local AT Command Request - 0x08, this frame queues new parameter values and does not apply
them until you either:
n Issue a Local AT Command using the 0x08 frame
n Issue an AC command—queued or otherwise
When querying parameter values, this frame behaves identically to Local AT Command Request - 0x08:
You can query parameter values by sending this frame with a command but no parameter value
field—the two-byte AT command is immediately followed by the frame checksum. When an AT
command is queried, a Local AT Command Response - 0x88 frame is populated with the parameter
value that is currently set on the device. The Frame ID of the 0x88 response is the same one set by the
command in the 0x09 request frame.
Format
The following table provides the contents of the frame. For details on frame structure, see API frame
specifications.
4 8-bit Frame ID Identifies the data frame for the host to correlate with a
subsequent response.
If set to0, the device will not emit a response frame.
5 16-bit AT command The two ASCII characters that identify the AT Command.
7-n variable Parameter If present, indicates the requested parameter value to set
value the given register at a later time.
(optional) If no characters are present, it queries the current
parameter value and returns the result in the response.
EOF 8-bit Checksum 0xFF minus the 8-bit sum of bytes from offset 3 to this byte
(between length and checksum).
Examples
Each example is written without escapes (AP = 1) and all bytes are represented in hex format. For
brevity, the start delimiter, length, and checksum fields have been excluded.
The device will continue to operate at the current baud rate until the change is applied with a
subsequent AC command.
The corresponding Local AT Command Response - 0x88 with a matching Frame ID will indicate
whether the parameter change succeeded.
7E 00 05 09 53 42 44 07 16
7E 00 04 09 17 54 50 3B
Description
This frame type is used to query or set AT command parameters on a remote device.
For parameter changes on the remote device to take effect, you must apply changes, either by setting
the Apply Changes options bit, or by sending an AC command to the remote.
When querying parameter values you can query parameter values by sending this framewith a
command but no parameter value field—the two-byte AT command is immediately followed by the
frame checksum. When an AT command is queried, a Remote AT Command Response- 0x97 frame is
populated with the parameter value that is currently set on the device. The Frame ID of the 0x97
response is the same one set by the command in the 0x17 request frame.
Note Remote AT Command Requests should only be issued as unicast transmissions to avoid
potential network disruption. Broadcasts are not acknowledged, so there is no guarantee all devices
will receive the request. Responses are returned immediately by all receiving devices, which can cause
congestion on a large network.
Format
The following table provides the contents of the frame. For details on frame structure, see API frame
specifications.
4 8-bit Frame ID Identifies the data frame for the host to correlate with a
subsequent response.
If set to 0, the device will not emit a response frame.
5 64-bit 64-bit Set to the 64-bit IEEE address of the destination device.
destination
address
13 16-bit Reserved Unused, but this field is typically set to 0xFFFE.
15 8-bit Remote Bit field of options that apply to the remote AT command
command request:
options
n Bit 0: Disable ACK [0x01]
n Bit 1: Apply changes on remote [0x02]
l If not set, changes will not applied until the device
receives an AC command or a subsequent
command change is received with this bit set
16 16-bit AT command The two ASCII characters that identify the AT Command.
18-n variable Parameter If present, indicates the requested parameter value to set the
value given register.
(optional) If no characters are present, it queries the current parameter
value and returns the result in the response.
EOF 8-bit Checksum 0xFF minus the 8-bit sum of bytes from offset 3 to this byte
(between length and checksum).
Examples
Each example is written without escapes—AP = 1—and all bytes are represented in hex format. For
brevity, the start delimiter, length, and checksum fields have been excluded.
7E 00 15 17 27 00 13 A2 00 12 34 56 78 FF FE 02 4E 49 52 65 6D 6F 74 65 F6
Frame Command AT
type Frame ID 64-bit dest Reserved options command Parameter value
0x17 0x27 0x0013A200 0xFFFE 0x02 0x4E49 0x52656D6F7465
12345678
Request Matches Unused Apply "NI" "Remote"
response Change
7E 00 11 17 68 00 13 A2 00 12 34 56 78 FF FE 00 49 44 04 51 D8
7E 00 0F 17 FA 00 13 A2 00 12 34 56 78 FF FE 00 54 50 84
Description
This frame type is emitted when a device configured with legacy API output— = 2—receives an RF data
packet from a device configured to use 64-bit source addressing—MY = 0xFFFE.
Note This frame format is deprecated and should only be used by customers who require
compatibility with legacy Digi RF products. For new designs, we encourage you to use Receive Packet -
0x90 for reception of API transmissions.
Format
The following table provides the contents of the frame. For details on frame structure, see API frame
specifications.
Frame
Offset Size Field Description
0 8-bit Start Indicates the start of an API frame.
Delimiter
1 16-bit Length Number of bytes between the length and checksum.
3 8-bit Frame type 64-bit Receive Packet - 0x80
4 64-bit 64-bit The sender's 64-bit IEEE address.
source
address
12 8-bit RSSI Received Signal Strength Indicator. The Hexadecimal equivalent
of (-dBm) value. For example if RX signal strength is -40 dBm,
then 0x28 (40 decimal) is returned.
13 8-bit Options Bit field of options that apply to the received message:
n Bit 0: Reserved
n Bit 1: Packet was sent as a broadcast [0x02]
n Bit 2: 802.15.4 only - Packet was broadcast across all
PANs [0x04]
14-n variable RF data The RF payload data that the device receives.
EOF 8-bit Checksum 0xFF minus the 8-bit sum of bytes from offset 3 to this byte
(between length and checksum).
Examples
Each example is written without escapes (AP = 1) and all bytes are represented in hex format. For
brevity, the start delimiter, length, and checksum fields have been excluded.
64-bit unicast
A device with the 64-bit address of 0013A20087654321 sent a unicast transmission to a specific
device with the payload of "TxData". The following frame is emitted if the destination is configured
with AO = 2.
7E 00 11 80 00 13 A2 00 12 34 56 78 5E 01 54 78 44 61 74 61 11
Description
This frame type is emitted when a device configured with legacy API output— = 2—receives an RF data
packet from a device configured to use 16-bit source addressing—MY < 0xFFFE.
Note This frame format is deprecated and should only be used by customers who require
compatibility with legacy Digi RF products. For new designs, we encourage you to use Receive Packet
frame - 0x90 for reception of API transmissions.
Format
The following table provides the contents of the frame. For details on frame structure, see API frame
specifications.
Frame
Offset Size Field Description
0 8-bit Start Indicates the start of an API frame.
Delimiter
1 16-bit Length Number of bytes between the length and checksum.
3 8-bit Frame type 16-bit Receive Packet - 0x81
4 16-bit 16-bit The sender's 16-bit network address.
source
address
6 8-bit RSSI Received Signal Strength Indicator. The Hexadecimal equivalent
of (-dBm) value. For example if RX signal strength is -40 dBm,
then 0x28 (40 decimal) is returned.
7 8-bit Options Bit field of options that apply to the received message:
n Bit 0: Reserved
n Bit 1: Packet was sent as a broadcast [0x02]
n Bit 2: 802.15.4 only - Packet was broadcast across all
PANs [0x04]
8-n variable RF data The RF payload data that the device receives.
EOF 8-bit Checksum 0xFF minus the 8-bit sum of bytes from offset 3 to this byte
(between length and checksum).
Examples
Each example is written without escapes (AP = 1) and all bytes are represented in hex format. For
brevity, the start delimiter, length, and checksum fields have been excluded.
64-bit unicast
A device with the 16-bit address of 1234 sent a unicast transmission to a specific device with the
payload of "TxData". The following frame is emitted if the destination is configured with AO = 2.
7E 00 0B 81 12 34 5E 01 54 78 44 61 74 61 93
Description
This frame type is emitted when a device configured with legacy API output— = 2— receives an I/O
sample frame from a remote device configured to use 64-bit source addressing—MY = 0xFFFE. Only
devices running in API mode will send I/O samples out the serial port.
Note This frame format is deprecated and should only be used by customers who require
compatibility with legacy Digi RF products. For new designs, we encourage you to use I/O Sample
Indicator - 0x92 for reception of I/O samples.
Format
The following table provides the contents of the frame. For details on frame structure, see API frame
specifications.
Frame
Offset Size Field Description
0 8-bit Start Indicates the start of an API frame.
Delimiter
1 16-bit Length Number of bytes between the length and checksum.
3 8-bit Frame type 64-bit I/O Sample Indicator - 0x82
4 64-bit 64-bit The sender's 64-bit IEEE address.
source
address
12 8-bit RSSI Received Signal Strength Indicator. The Hexadecimal equivalent
of (-dBm) value. For example if RX signal strength is -40 dBm,
then 0x28 (40 decimal) is returned.
13 8-bit Options Bit field of options that apply to the received message:
n Bit 0: Reserved
n Bit 1: Packet was sent as a broadcast [0x02]
n Bit 2: 802.15.4 only - Packet was broadcast across all
PANs [0x04]
bit 0: DIO0
bit 1: DIO1
Frame
Offset Size Field Description
bit 2: DIO2
bit 3: DIO3
bit 4: DIO4
bit 5: DIO5
bit 6: DIO6
bit 7: DIO7
bit 8: DIO8
bit 9: ADC0
bit 10: ADC1
bit 11: ADC2
bit 12: ADC3
bit 13: N/A
bit 14: N/A
bit 15: N/A
Each bit represents either a DIO line or ADC channel. Bit set to 1
if channel is active.
17 16-bit Digital If the sample set includes any digital I/O lines—Digital channel
samples (if mask > 0—this field contain samples for all enabled digital I/O
included) lines. If no digital lines are configured as inputs or outputs, this
field will be omitted.
DIO lines that do not have sampling enabled return 0. Bits in
this field are arranged the same as they are in the channel mask
field.
19 16-bit Analog If the sample set includes any analog I/O lines, each enabled
variable samples (if analog input returns a 16-bit value indicating the ADC
included) measurement of that input.
Analog samples are ordered sequentially from AD0 to AD3.
EOF 8-bit Checksum 0xFF minus the 8-bit sum of bytes from offset 3 to this byte
(between length and checksum).
Description
This frame type is emitted when a device configured with legacy API output— = 2— receives an I/O
sample frame from a remote device configured to use 64-bit source addressing—MY = 0xFFFE. Only
devices running in API mode will send I/O samples out the serial port.
Note This frame format is deprecated and should only be used by customers who require
compatibility with legacy Digi RF products. For new designs, we encourage you to use I/O Data
Sample Rx Indicator frame - 0x92 for reception of I/O samples.
Format
The following table provides the contents of the frame. For details on frame structure, see API frame
specifications.
Frame
Offset Size Field Description
0 8-bit Start Indicates the start of an API frame.
Delimiter
1 16-bit Length Number of bytes between the length and checksum.
3 8-bit Frame type 16-bit I/O Sample Indicator - 0x83
4 16-bit 16-bit The sender's 16-bit network address.
source
address
6 8-bit RSSI Received Signal Strength Indicator. The Hexadecimal equivalent
of (-dBm) value. For example if RX signal strength is -40 dBm,
then 0x28 (40 decimal) is returned.
7 8-bit Options Bit field of options that apply to the received message:
n Bit 0: Reserved
n Bit 1: Packet was sent as a broadcast [0x02]
n Bit 2: 802.15.4 only - Packet was broadcast across all
PANs [0x04]
Frame
Offset Size Field Description
bit 3: DIO3
bit 4: DIO4
bit 5: DIO5
bit 6: DIO6
bit 7: DIO7
bit 8: DIO8
bit 9: ADC0
bit 10: ADC1
bit 11: ADC2
bit 12: ADC3
bit 13: N/A
bit 14: N/A
bit 15: N/A
Each bit represents either a DIO line or ADC channel. Bit set to 1
if channel is active.
11 16-bit Digital If the sample set includes any digital I/O lines—Digital channel
samples (if mask > 0— this field contain samples for all enabled digital I/O
included) lines. If no digital lines are configured as inputs or outputs, this
field will be omitted.
DIO lines that do not have sampling enabled return 0. Bits in
this field are arranged the same as they are in the channel mask
field.
13 16-bit Analog If the sample set includes any analog I/O lines, each enabled
variable samples (if analog input returns a 16-bit value indicating the ADC
included) measurement of that input.
Analog samples are ordered sequentially from AD0 to AD3.
EOF 8-bit Checksum 0xFF minus the 8-bit sum of bytes from offset 3 to this byte
(between length and checksum).
Description
This frame type is emitted in response to a local AT Command request. Some commands send back
multiple response frames; for example, ND (Network Discovery). Refer to individual AT command
descriptions for details on API response behavior.
This frame is only emitted if the Frame ID in the request is non-zero.
Format
The following table provides the contents of the frame. For details on frame structure, see API frame
specifications.
4 8-bit Frame ID Identifies the data frame for the host to correlate with a prior
request.
8-n variable Command If the host requested a command parameter change, this field
data will be omitted.
(optional) If the host queried a command by omitting the parameter value
in the request, this field will return the value currently set on
the device.
EOF 8-bit Checksum 0xFF minus the 8-bit sum of bytes from offset 3 to this byte
(between length and checksum).
Examples
Each example is written without escapes (AP = 1) and all bytes are represented in hex format. For
brevity, the start delimiter, length, and checksum fields have been excluded.
7E 00 05 88 01 4E 49 00 DF
Frame AT Command
type Frame ID command Status Command data
0x88 0xA1 0x4E49 0x00 (omitted)
Response Matches "NI" Success Parameter changes return no
request data
7E 00 07 88 01 54 50 00 FF FE D5
Description
This frame type is emitted when a transmit request completes. The status field of this frame indicates
whether the request succeeded or failed and the reason.
This frame is only emitted if the Frame ID in the request is non-zero.
Note Broadcast transmissions are not acknowledged and always return a status of 0x00, even if the
delivery failed.
Format
The following table provides the contents of the frame. For details on frame structure, see API frame
specifications.
Frame
Offset Size Field Description
0 8-bit Start Indicates the start of an API frame.
Delimiter
1 16-bit Length Number of bytes between the length and checksum.
3 8-bit Frame type Transmit Status - 0x89
4 8-bit Frame ID Identifies the data frame for the host to correlate with a prior
request.
5 8-bit Delivery Complete list of delivery statuses:
status 0x00 = Success
0x01 = No ACK received
0x02 = CCA failure
0x03 = Indirect message unrequested
0x04 = Transceiver was unable to complete the transmission
0x21 = Network ACK failure
0x22 = Not joined to network
0x2C = Invalid frame values (check the phone number)
0x31 = Internal error
0x32 = Resource error - lack of free buffers, timers, etc.
0x34 = No Secure Session Connection
0x35 = Encryption Failure
0x74 = Message too long
0x76 = Socket closed unexpectedly
0x78 = Invalid UDP port
0x79 = Invalid TCP port
0x7A = Invalid host address
Frame
Offset Size Field Description
0x7B = Invalid data mode
0x7C = Invalid interface.
0x7D = Interface not accepting frames.
0x7E = A modem update is in progress. Try again after the
update is complete.
0x80 = Connection refused
0x81 = Socket connection lost
0x82 = No server
0x83 = Socket closed
0x84 = Unknown server
0x85 = Unknown error
0x86 = Invalid TLS configuration (missing file, and so forth)
0x87 = Socket not connected
0x88 = Socket not bound
Refer to the tables below for a filtered list of status codes that are
appropriate for specific devices.
EOF 8-bit Checksum 0xFF minus the 8-bit sum of bytes from offset 3 to this byte
(between length and checksum).
XBee 802.15.4
0x00 = Success
0x01 = No ACK received
0x02 = CCA failure
0x03 = Indirect message unrequested
0x04 = Transceiver was unable to complete the transmission
0x21 = Network ACK failure
0x22 = Not joined to network
0x31 = Internal error
0x32 = Resource error - lack of free buffers, timers, etc.
0x74 = Message too long
Examples
Each example is written without escapes (AP = 1) and all bytes are represented in hex format. For
brevity, the start delimiter, length, and checksum fields have been excluded.
Successful transmission
Host sent a unicast transmission to a remote device using a 64-bit Transmit Request - 0x00 frame.
The corresponding 0x89 Transmit Status with a matching Frame ID is emitted as a response to the
request:
7E 00 03 89 52 00 24
Description
This frame type is emitted in response to specific conditions. The status field of this frame indicates
the device behavior.
Format
Frame
Offset Size Field Description
0 8-bit Start Indicates the start of an API frame.
Delimiter
1 16-bit Length Number of bytes between the length and checksum.
3 8-bit Frame type Modem Status - 0x8A
4 8-bit Modem Complete list of modem statuses:
status 0x00 = Hardware reset or power up
0x01 = Watchdog timer reset
0x02 = Joined network
0x03 = Left network
0x06 = Coordinator started
0x07 = Network security key was updated
0x0B = Network woke up
0x0C = Network went to sleep
0x0D = Voltage supply limit exceeded
0x0E = Digi Remote Manager connected
0x0F = Digi Remote Manager disconnected
0x11 = Modem configuration changed while join in progress
0x12 = Access fault
0x13 = Fatal error
0x3B = Secure session successfully established
0x3C = Secure session ended
0x3D = Secure session authentication failed
0x3E = Coordinator detected a PAN ID conflict but took no action
0x3F = Coordinator changed PAN ID due to a conflict
0x32 = BLE Connect
0x33 = BLE Disconnect
0x34 = Bandmask configuration failed
0x35 = Cellular component update started
0x36 = Cellular component update failed
0x37 = Cellular component update completed
0x38 = XBee firmware update started
0x39 = XBee firmware update failed
0x3A = XBee firmware update applying
0x40 = Router PAN ID was changed by coordinator due to a conflict
0x42 = Network Watchdog timeout expired
0x80 through 0xFF = Stack error
Refer to the tables below for a filtered list of status codes that are
Frame
Offset Size Field Description
appropriate for specific devices.
EOF 8-bit Checksum 0xFF minus the 8-bit sum of bytes from offset 3 to this byte
(between length and checksum).
XBee 802.15.4
0x00 = Hardware reset or power up
0x01 = Watchdog timer reset
0x02 = End device successfully associated with a coordinator
0x03 = End device disassociated from coordinator or coordinator failed to form a new network
0x06 = Coordinator formed a new network
0x0D = Voltage supply limit exceeded
0x3B = XBee 3 - Secure session successfully established
0x3C = XBee 3 - Secure session ended
0x3D = XBee 3 - Secure session authentication failed
0x32 = XBee 3 - BLE Connect
0x33 = XBee 3 - BLE Disconnect
0x34 = XBee 3 - No Secure Session Connection
Examples
Each example is written without escapes (AP = 1) and all bytes are represented in hex format. For
brevity, the start delimiter, length, and checksum fields have been excluded.
Boot status
When a device powers up, it returns the following API frame:
7E 00 02 8A 00 75
Description
This frame type is emitted in response to a Remote AT Command Request - 0x17. Some commands
send back multiple response frames; for example, the ND command. Refer to individual AT command
descriptions for details on API response behavior.
This frame is only emitted if the Frame ID in the request is non-zero.
Format
The following table provides the contents of the frame. For details on frame structure, see API frame
specifications.
4 8-bit Frame ID Identifies the data frame for the host to correlate with a prior
request.
18-n variable Parameter If the host requested a command parameter change, this field
value will be omitted.
(optional) If the host queried a command by omitting the parameter
value in the request, this field will return the value currently set
on the device.
EOF 8-bit Checksum 0xFF minus the 8-bit sum of bytes from offset 3 to this byte
(between length and checksum).
Examples
Each example is written without escapes (AP = 1) and all bytes are represented in hex format. For
brevity, the start delimiter, length, and checksum fields have been excluded.
7E 00 0F 97 27 00 13 A2 00 12 34 56 78 12 7E 4E 49 00 51
Transmission failure
Host queued the the PAN ID change of a remote device using a Remote AT Command Request - 0x17.
Due to existing network congestion, the host will retry any failed attempts.
The corresponding 0x97 Remote AT Command Response with a matching Frame ID is emitted as a
response:
7E 00 0F 97 27 00 13 A2 00 12 34 56 78 FF FE 49 44 04 EA
7E 00 11 97 27 00 13 A2 00 12 34 56 78 FF FE 54 50 00 00 2F A8
1. The system integrator must ensure that the text on the external label provided with this device
is placed on the outside of the final product.
2. RF Modules may only be used with antennas that have been tested and approved for use with
the modules.
WARNING! As an Original Equipment Manufacturer (OEM) you must ensure that FCC
labeling requirements are met. You must include a clearly visible label on the outside of the
final product enclosure that displays the following content:
Required FCC Label for OEM products containing the XBee-PRO S2C SMT RF Module
Contains FCC ID: MCQ-PS2CSM
This device complies with Part 15 of the FCC Rules. Operation is subject to the following two
conditions: (1.) this device may not cause harmful interference and (2.) this device must accept any
interference received, including interference that may cause undesired operation.
Required FCC Label for OEM products containing the XBee S2C TH RF Module
Contains FCC ID: MCQ-S2CTH
This device complies with Part 15 of the FCC Rules. Operation is subject to the following two
conditions: (1.) this device may not cause harmful interference and (2.) this device must accept any
interference received, including interference that may cause undesired operation.
Required FCC Label for OEM products containing the XBee-PRO S2C TH RF Module
Contains FCC ID: MCQ-PS2CTH
This device complies with Part 15 of the FCC Rules. Operation is subject to the following two
conditions: (1.) this device may not cause harmful interference and (2.) this device must accept any
interference received, including interference that may cause undesired operation.
FCC notices
IMPORTANT: XBee/XBee-PRO S2C 802.15.4 RF Modules have been certified by the FCC for use with
other products without any further certification (as per FCC section 2.1091). Modifications not
expressly approved by Digi could void the user's authority to operate the equipment.
IMPORTANT: OEMs must test final product to comply with unintentional radiators (FCC section 15.107
& 15.109) before declaring compliance of their final product to Part 15 of the FCC Rules.
IMPORTANT: The RF module has been certified for remote and base radio applications. If the module
will be used for portable applications, the device must undergo SAR testing.
This equipment has been tested and found to comply with the limits for a Class B digital device,
pursuant to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection
against harmful interference in a residential installation. This equipment generates, uses and can
radiate radio frequency energy and, if not installed and used in accordance with the instructions, may
cause harmful interference to radio communications. However, there is no guarantee that interference
will not occur in a particular installation.
If this equipment does cause harmful interference to radio or television reception, which can be
determined by turning the equipment off and on, the user is encouraged to try to correct the
interference by one or more of the following measures: Re-orient or relocate the receiving antenna,
Increase the separation between the equipment and receiver, Connect equipment and receiver to
outlets on different circuits, or Consult the dealer or an experienced radio/TV technician for help.
Regulatory information
FCC-approved antennas (2.4 GHz)
The XBee and XBee-PRO RF Modules can be installed using antennas and cables constructed with non-standard connectors (RPSMA, RPTNC, etc.) An
adapter cable may be necessary to attach the XBee connector to the antenna connector.
The modules are FCC approved for fixed base station and mobile applications for the channels indicated in the tables below. If the antenna is mounted at
least 25 cm (10 in) from nearby persons, the application is considered a mobile application. Antennas not listed in the table must be tested to comply
with FCC Section 15.203 (Unique Antenna Connectors) and Section 15.247 (Emissions).
The antennas in the tables below have been approved for use with this module. Cable loss is required when using gain antennas as shown in the tables.
Digi does not carry all of these antenna variants. Contact Digi Sales for available antennas.
All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option.
A24-HASM-450 Dipole (Half-wave articulated RPSMA - 4.5”) 2.1 Fixed 25 cm N/A N/A N/A
A24-HABSM* Dipole (Articulated RPSMA) 2.1 Fixed 25 cm N/A N/A N/A
29000095 Dipole (Half-wave articulated RPSMA - 4.5”) 2.1 Fixed/Mobile 25 cm N/A N/A N/A
A24-HABUF-P5I Dipole (Half-wave articulated bulkhead mount U.FL. 2.1 Fixed/Mobile 25 cm N/A N/A N/A
Regulatory information
Required antenna cable loss (dB)
Type Gain Min. Channels Channel Channel
Part number (description) (dBi) Application* separation 11-24 25 26
A24-HASM-525 Dipole (Half-wave articulated RPSMA - 5.25") 2.1 Fixed 25 cm N/A N/A N/A
Omni-directional antennas
A24-F2NF Omni-directional (Fiberglass base station) 2.1 Fixed/Mobile 25 cm N/A N/A N/A
A24-F3NF Omni-directional (Fiberglass base station) 3.0 Fixed/Mobile 25 cm N/A N/A N/A
A24-F5NF Omni-directional (Fiberglass base station) 5.0 Fixed 25 cm N/A N/A N/A
A24-F8NF Omni-directional (Fiberglass base station) 8.0 Fixed 2m N/A N/A 0.1
A24-F9NF Omni-directional (Fiberglass base station) 9.5 Fixed 2m N/A N/A 1.6
A24-F10NF Omni-directional (Fiberglass base station) 10.0 Fixed 2m N/A N/A 2.1
A24-F12NF Omni-directional (Fiberglass base station) 12.0 Fixed 2m N/A N/A 4.1
A24-W7NF Omni-directional (Fiberglass base station) 7.2 Fixed 2m N/A N/A N/A
A24-M7NF Omni-directional (Mag-mount base station) 7.2 Fixed 2m N/A N/A N/A
A24-F15NF Omni-directional (Fiberglass base station) 15.0 Fixed 2m 1.1 1.1 7.1
Panel antennas
Regulatory information
Required antenna cable loss (dB)
Type Gain Min. Channels Channel Channel
Part number (description) (dBi) Application* separation 11-24 25 26
A24-P19NF Flat Panel 19.0 Fixed 2m 1.1 9.1 16.6
Yagi antennas
Regulatory information
The following table shows the antennas approved for use with the XBee S2C TH RF Module.
A24-HASM- Dipole (Half-wave articulated RPSMA - 4.5”) 2.1 Fixed 25 cm N/A N/A N/A
450
A24-HABSM Dipole (Articulated RPSMA) 2.1 Fixed 25 cm N/A N/A N/A
29000095 Dipole (Half-wave articulated RPSMA - 4.5”) 2.1 Fixed/Mobile 25 cm N/A N/A N/A
A24-HABUF- Dipole (Half-wave articulated bulkhead mount U.FL. 2.1 Fixed/Mobile 25 cm N/A N/A N/A
P5I w/ 5” pigtail)
A24-HASM- Dipole (Half-wave articulated RPSMA - 5.25") 2.1 Fixed 25 cm N/A N/A N/A
525
Omni-directional antennas
A24-F2NF Omni-directional (Fiberglass base station) 2.1 Fixed/Mobile 25 cm N/A N/A N/A
A24-F3NF Omni-directional (Fiberglass base station) 3.0 Fixed/Mobile 25 cm N/A N/A N/A
A24-F5NF Omni-directional (Fiberglass base station) 5.0 Fixed 25 cm N/A N/A N/A
Regulatory information
Required antenna cable loss (dB)
Part Gain Min. Channels Channel Channel
number Type (description) (dBi) Application* separation 11-24 25 26
A24-F9NF Omni-directional (Fiberglass base station) 9.5 Fixed 2m N/A N/A 0.9
A24-F10NF Omni-directional (Fiberglass base station) 10.0 Fixed 2m N/A N/A 1.4
A24-F12NF Omni-directional (Fiberglass base station) 12.0 Fixed 2m N/A N/A 3.4
A24-W7NF Omni-directional (Fiberglass base station) 7.2 Fixed 2m N/A N/A N/A
A24-M7NF Omni-directional (Mag-mount base station) 7.2 Fixed 2m N/A N/A N/A
A24-F15NF Omni-directional (Fiberglass base station) 15.0 Fixed 2m 0.4 0.4 6.4
Panel antennas
Regulatory information
Required antenna cable loss (dB)
Part Gain Min. Channels Channel Channel
number Type (description) (dBi) Application* separation 11-24 25 26
A24-Y12NF Yagi (12-element) 12.0 Fixed 2m N/A 2.4 7.9
A24-Y13NF Yagi (13-element) 12.0 Fixed 2m N/A 2.4 7.9
A24-Y15NF Yagi (15-element) 12.5 Fixed 2m N/A 2.9 8.4
A24-Y16NF Yagi (16-element) 13.5 Fixed 2m N/A 3.9 9.4
A24-Y16RM Yagi (16-element, RPSMA connector) 13.5 Fixed 2m N/A 3.9 9.4
A24-Y18NF Yagi (18-element) 15.0 Fixed 2m 0.4 5.4 10.9
Regulatory information
The following table shows the antennas approved for use with the XBee-PRO S2C SMT RF Module.
A24-HASM- Dipole (Half-wave articulated RPSMA - 4.5”) 2.1 Fixed 25 cm N/A N/A
450
A24-HABSM Dipole (Articulated RPSMA) 2.1 Fixed 25 cm N/A N/A
29000095 Dipole (Half-wave articulated RPSMA - 4.5”) 2.1 Fixed/Mobile 25 cm N/A N/A
A24-HABUF- Dipole (Half-wave articulated bulkhead mount U.FL. w/ 5” 2.1 Fixed/Mobile 25 cm N/A N/A
P5I pigtail)
A24-HASM- Dipole (Half-wave articulated RPSMA - 5.25") 2.1 Fixed 25 cm N/A N/A
525
Omni-directional antennas
Regulatory information
Required antenna cable loss
(dB)
Part Gain Min Channels 11-
Number Type (Description) (dBi) Application* Separation 23† Channel 24†
A24-F9NF Omni-directional (Fiberglass base station) 9.5 Fixed 2m N/A N/A
A24-F10NF Omni-directional (Fiberglass base station) 10 Fixed 2m N/A N/A
A24-F12NF Omni-directional (Fiberglass base station) 12 Fixed 2m N/A 1.6
A24-W7NF Omni-directional (Fiberglass base station) 7.2 Fixed 2m N/A N/A
A24-M7NF Omni-directional (Mag-mount base station) 7.2 Fixed 2m N/A N/A
A24-F15NF Omni-directional (Fiberglass base station) 15.0 Fixed 2m 1.1 4.6
Panel antennas
Regulatory information
Required antenna cable loss
(dB)
Part Gain Min Channels 11-
Number Type (Description) (dBi) Application* Separation 23† Channel 24†
A24-Y12NF Yagi (12-element) 12.0 Fixed 2m 1.6 5.1
A24-Y13NF Yagi (13-element) 12.0 Fixed 2m 1.6 5.1
A24-Y15NF Yagi (15-element) 12.5 Fixed 2m 2.1 5.6
A24-Y16NF Yagi (16-element) 13.5 Fixed 2m 3.1 6.6
A24-Y16RM Yagi (16-element, RPSMA connector) 13.5 Fixed 2m 3.1 6.6
A24-Y18NF Yagi (18-element) 15.0 Fixed 2m 4.6 8.1
Regulatory information
The following table shows the antennas approved for use with the XBee-PRO S2C TH RF Module.
A24-HASM- Dipole (Half-wave articulated RPSMA - 4.5”) 2.1 Fixed/Mobile 25 cm N/A N/A
450
A24-HABSM Dipole (Articulated RPSMA) 2.1 Fixed 25 cm N/A N/A
29000095 Dipole (Half-wave articulated RPSMA - 4.5”) 2.1 Fixed/Mobile 25 cm N/A N/A
A24-HABUF- Dipole (Half-wave articulated bulkhead mount U.FL. w/ 5” 2.1 Fixed 25 cm N/A N/A
P5I pigtail)
A24-HASM- Dipole (Half-wave articulated RPSMA - 5.25") 2.1 Fixed/ Mobile 25 cm N/A N/A
525
Omni-directional antennas
Regulatory information
Required antenna cable loss
(dB)
Part Gain Min. Channels 11-
number Type (description) (dBi) Application* separation 23† Channel 24†
A24-F9NF Omni-directional (Fiberglass base station) 9.5 Fixed 2m N/A N/A
A24-F10NF Omni-directional (Fiberglass base station) 10.0 Fixed 2m N/A N/A
A24-F12NF Omni-directional (Fiberglass base station) 12.0 Fixed 2m N/A 1.4
A24-W7NF Omni-directional (base station) 7.2 Fixed 2m N/A N/A
A24-M7NF Omni-directional (Mag-mount base station) 7.2 Fixed 2m N/A N/A
A24-F15NF Omni-directional (Fiberglass base station) 15.0 Fixed 2m 0.4 4.4
Panel antennas
Regulatory information
Required antenna cable loss
(dB)
Part Gain Min. Channels 11-
number Type (description) (dBi) Application* separation 23† Channel 24†
A24-Y12NF Yagi (12-element) 12.0 Fixed 2m 1.4 4.4
A24-Y13NF Yagi (13-element) 12.0 Fixed 2m 1.4 4.4
A24-Y15NF Yagi (15-element) 12.5 Fixed 2m 1.9 4.9
A24-Y16NF Yagi (16-element) 13.5 Fixed 2m 2.9 5.9
A24-Y16RM Yagi (16-element, RPSMA connector) 13.5 Fixed 2m 2.9 5.9
A24-Y18NF Yagi (18-element) 15.0 Fixed 2m 4.4 7.4
* If using the RF module in a portable application (for example - if the module is used in a handheld device and the antenna is less than 25 cm from the
human body when the device is in operation): The integrator is responsible for passing additional SAR (Specific Absorption Rate) testing based on FCC
rules 2.1091 and FCC Guidelines for Human Exposure to Radio Frequency Electromagnetic Fields, OET Bulletin and Supplement C. The testing results will
be submitted to the FCC for approval prior to selling the integrated unit. The required SAR testing measures emissions from the module and how they
affect the person.
† Although certified to operate on channels 11-24, currently this product only supports channels 12-23.
RF exposure
If you are an integrating the XBee into another product, you must include the following Caution
statement in OEM product manuals to alert users of FCC RF exposure compliance:
2.1 General
No requirements are associated with this section.
2.7 Antennas
A list of approved antennas is provided for the XBee/XBee-PRO S2C 802.15.4 RF Modules. See FCC-
approved antennas (2.4 GHz).
Europe (CE)
The XBee/XBee-PRO S2C 802.15.4 RF Modules (non-PRO variants) have been tested for use in several
European countries. For a complete list, refer to www.digi.com/resources/certifications.
If XBee/XBee-PRO S2C 802.15.4 RF Modules are incorporated into a product, the manufacturer must
ensure compliance of the final product with articles 3.1a and 3.1b of the Radio Equipment Directive. A
Declaration of Conformity must be issued for each of these standards and kept on file as described in
the Radio Equipment Directive.
Furthermore, the manufacturer must maintain a copy of the XBee/XBee-PRO S2C 802.15.4 RF Module
user guide documentation and ensure the final product does not exceed the specified power ratings,
antenna specifications, and/or installation requirements as specified in the user guide.
CE labeling requirements
The “CE” marking must be affixed to a visible location on the OEM product. The following figure shows
CE labeling requirements.
The CE mark shall consist of the initials “CE” taking the following form:
n If the CE marking is reduced or enlarged, the proportions given in the above graduated
drawing must be respected.
n The CE marking must have a height of at least 5 mm except where this is not possible on
account of the nature of the apparatus.
n The CE marking must be affixed visibly, legibly, and indelibly.
n if you reduce or enlarge the size of your marking, the letters forming the UKCA marking must
be in proportion to the version set out below
n the UKCA marking is at least 5 mm in height – unless a different minimum dimension is
specified in the relevant legislation
n the UKCA marking is easily visible, legible (from 1 January 2023 it must be permanently
attached)
n the UKCA marking can take different forms (for example, the colour does not have to be solid),
as long as it remains visible, legible and maintains the required proportions.
Important note
Digi customers assume full responsibility for learning and meeting the required guidelines for each
country in their distribution market. Refer to the radio regulatory agency in the desired countries of
operation for more information.
1. Set the PL command to 3 (6 dBm) or lower, which ensures that the maximum transmitter
power is under the limit at which LBT is required.
or
2. Set the CA command as described in CA (CCA Threshold) to enable LBT at the required noise
threshold level.
Declarations of conformity
Digi has issued Declarations of Conformity for the XBee RF Modules concerning emissions, EMC, and
safety. For more information, see www.digi.com/resources/certifications.
Antennas
The following antennas have been tested and approved for use with the XBee/XBee-PRO S2C 802.15.4
RF Module:
All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an
antenna manufacturer for an equivalent option.
n Dipole (2.1 dBi, Omni-directional, Articulated RPSMA, Digi part number A24-HABSM)
n PCB Antenna (0.0 dBi)
n Monopole Whip (1.5 dBi)
Labeling requirements
Labeling requirements for Industry Canada are similar to those of the FCC. A clearly visible label on
the outside of the final product enclosure must display the following text:
Detachable antenna
Under Industry Canada regulations, this radio transmitter may only operate using an antenna of a
type and maximum (or lesser) gain approved for the transmitter by Industry Canada. To reduce
potential radio interference to other users, the antenna type and its gain should be so chosen that the
equivalent isotropically radiated power (EIRP) is not more than that necessary for successful
communication.
Conformément à la réglementation d'Industrie Canada, le présent émetteur radio peut fonctionner avec
une antenne d'un type et d'un gain maximal (ou inférieur) approuvé pour l'émetteur par Industrie
Canada. Dans le but de réduire les risques de brouillage radioélectrique à l'intention des autres
utilisateurs, il faut choisir le type d'antenne et son gain de sorte que la puissance isotrope rayonnée
équivalente (p.i.r.e.) ne dépasse pas l'intensité nécessaire àl'établissement d'une communication
satisfaisante.
Australia (RCM)
XBee S2C 802.15.4 and XBee-PRO S2C 802.15.4 modules comply with requirements to be used in end
products in Australia and New Zealand. All products with EMC and radio communications must have
registered RCM and R-NZ marks. Registration to use the compliance mark will only be accepted from
Australia or New Zealand manufacturers or importers, or their agents.
In order to have a RCM or R-NZ mark on an end product, a company must comply with a or b below.
South Korea
The low-power XBee S2C TH and XBee S2C devices have received South Korean approvals. To show
conformity to the certificate, you must add a label with the South Korean product information to the
XBee S2C 802.15.4 RF Module.
For the through-hole device, you can place the label on the reverse side.
Recommended label material: Abraham Technical (700342) MFG P/N TAAE-014250.
The label size is: 15.9 mm x 15.9 mm (0.625 in x 0.625 in)
The complete label information is as follows:
CAUTION! By placing a label over the existing label, the certifications for Europe (CE),
Australia, New Zealand (RCM), and Japan will no longer apply.
IFETEL (Mexico)
Mexico does not have a “modular” approval for radio products.
If XBee/XBee-PRO S2C 802.15.4 RF Modules are integrated into a product, the manufacturer must
ensure compliance of the final product with all the requirements of Mexican regulations.
Manufacturer: Digi International
Country: USA
Brand: Digi
The Tariff Code (HS) for all XBee/XBee-PRO S2C radio modules is 8517-62-15.
WARNING! The Original Equipment Manufacturer (OEM) must ensure that Mexico IFT
labeling requirements are met.
The IFETEL number for the XBee product must be listed either on the end product, on the packaging,
in the manual, or in the software with the following phrase, substituting the IFT number for the XBee
S2C product you are using for the XXXXXXXXX-XXXX:
“Este equipo contiene el módulo XBee con Número IFETEL: XXXXXXXXX-XXXX”
or
Background 186
Load 802.15.4 firmware 186
Background
Our XBee/XBee-PRO ZB RF modules are built on the same hardware as the XBee/XBee-PRO S2C
802.15.4 RF Module. It is possible to load 802.15.4 firmware on existing ZB modules. The table below
shows which part numbers are compatible with 802.15.4 firmware.
Note Currently the 802.15.4 firmware is approved for use only in the United States, Canada, Europe,
Australia and Japan. You can find region-specific regulatory information for the firmware in Regulatory
information.
CAUTION! The antenna cable loss requirements for the 802.15.4 firmware are different than
the ZB firmware for gain antennas exceeding 2.1 dBi. If you migrate a ZB device to 802.15.4
firmware, and are using gain antennas, you must adhere to the cable loss requirements
found in Regulatory information.
XBee/XBee-PRO ZB S2C part numbers Revision Form factor Hardware version (HV)
XB24CZ7PIS-004 All XBee SMT 0x22
XB24CZ7RIS-004
XB24CZ7UIS-004
XB24CZ7PIT-004 All XBee TH 0x2E
XB24CZ7SIT-004
XB24CZ7UIT-004
XB24CZ7WIT-004
XBP24CZ7PIS-004 Rev L XBee SMT 0x30
XBP24CZ7RIS-004 (and later)
XBP24CZ7UIS-004
XBP24CZ7PIT-004 All XBee TH 0x2D
XBP24CZ7SIT-004
XBP24CZ7UIT-004
XBP24CZ7WIT-004
In addition to the differences between the 802.15.4 and Zigbee protocols, some of the operational
features are different between the two firmware versions. For example, the XBee-PRO 802.15.4
supports fewer channels than the Zigbee firmware. It is important that you read and understand this
user guide before developing with the 802.15.4 firmware.
1. Verify that your device's part number (listed on the label) is included in the list shown in
Background.
2. Install the device in a Digi development board and connect it to your PC.
3. The next steps involve loading firmware using XCTU. To download XCTU and read detailed
instructions about it, go to:
https://www.digi.com/products/xbee-rf-solutions/xctu-software/xctu
4. When you get to the Update firmware dialog box, in the Function set area, click the 802.15.4
option, and the newest firmware version.
5. Click Update and follow the instructions.
6. When the updating process successfully completes, your device runs 802.15.4 firmware. You
can change back to Zigbee firmware at any time by following the same process and selecting
the Zigbee firmware option instead.
Pin mapping
The following table shows the pin mapping for the surface-mount (SMT) pins to the through-hole (TH)
pins. The pin names are from the XBee S2C SMT device.
2 VCC 1
3 DOUT 2
4 DIN/CONFIG 3
5 [Reserved] 4
6 RESET 5
7 PWM0/RSSI PWM 6
8 PWM1 7
9 [Reserved] 8
10 DI8/SLEEP_RQ/DTR 9
11 GND 10
12 SPI_ATTN /BOOTMODE
13 GND
14 SPI_CLK
15 SPI_SSEL
16 SPI_MOSI
17 SPI_MISO
18 [Reserved]
19 [Reserved]
20 [Reserved]
21 [Reserved]
22 GND
23 [Reserved]
24 DIO4 11
25 DIO7/CTS 12
26 On/SLEEP 13
27 VREF 14
35 GND
36 RF
37 [Reserved]
The round holes in the diagram are for the TH design, and the semi-oval pads are for the SMT design.
Pin 1 of the TH design is lined up with pad 1 of the SMT design, but the pins are actually offset by one
pad; see Pin mapping. By using diagonal traces to connect the appropriate pins, the layout will work
for both devices.
PCB design and manufacturing contains information on attaching the SMT device.
a. Calculated shelf life in sealed bag: 12 months at < 40 °C and < 90% relative humidity (RH).
b. Environmental condition during the production: 30 °C /60% RH according to IPC/JEDEC J-STD-
033C, paragraphs 5 through 7.
c. The time between the opening of the sealed bag and the start of the reflow process cannot
exceed 168 hours if condition b) is met.
d. Baking is required if conditions b) or c) are not met.
e. Baking is required if the humidity indicator inside the bag indicates a RH of 10% more.
f. If baking is required, bake modules in trays stacked no more than 10 high for 4-6 hours at
125 °C.
While the underside of the module is mostly coated with solder resist, we recommend that the copper
layer directly below the module be left open to avoid unintended contacts. Copper or vias must not
interfere with the three exposed RF test points on the bottom of the module (see below).
Furthermore, these modules have a ground plane in the middle on the back side for shielding
purposes, which can be affected by copper traces directly below the module.
Rework
CAUTION! Any modification to the device voids the warranty coverage and certifications.
Rework should never be performed on the module itself. The module has been optimized to give the
best possible performance, and reworking the module itself will void warranty coverage and
certifications. We recognize that some customers will choose to rework and void the warranty; the
following information is given as a guideline in such cases to increase the chances of success during
rework, though the warranty is still voided.
The module may be removed from the OEM PCB by the use of a hot air rework station, or hot plate.
Care should be taken not to overheat the module. During rework, the module temperature may rise
above its internal solder melting point and care should be taken not to dislodge internal components
from their intended positions.