Digi X4K-Z1U-00011-A1 User manual











iDigi®GatewayDevelopmentKit
GettingStartedGuide








December16,2010
90001205_A
Downloaded from Elcodis.com electronic components distributor

iDigiGatewayDevelopmentKitGettingStartedGuide 2

©2010DigiInternationalInc.
Allrightsreserved.

Digi,iDigi,DigiInternational,theDigiandiDigilogos,ConnectPort,DigiESP,iDigiDia,XBee,DigiXBee
SmartPlug,iDigiManagerPro,iDigiWebServicesAPI,andaDigiInternationalCompanyaretrademarks
orregisteredtrademarksofDigiInternational,Inc.intheUnitedStatesandothercountriesworldwide.
Allothertrademarksarethepropertyoftheirrespectiveowners.

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,either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.

Thisproductcouldincludetechnicalinaccuraciesortypographicalerrors.Changesareperiodicallymade
totheinformationherein;thesechangesmaybeincorporatedinneweditionsofthepublication.

Downloaded from Elcodis.com electronic components distributor

iDigiGatewayDevelopmentKitGettingStartedGuide 3

UsingthisGuide
ContactInformation
PleasealwayschecktheproductspecificsectionontheDigisupportwebsiteforthemost
currentrevisionofthisdocument:http://www.digi.com/gatewaydevelopmentkit.

FormoreinformationaboutyourDigiproducts,orforcustomerserviceandtechnicalsupport,
contactDigiInternational.

TocontactDigiInternationalbyUse
MailDigiInternational
1101BrenRoadEast
Minnetonka,MN55343
U.S.A.
WorldWideWebhttp://www.digi.com/support
Telephone(US)(952)912‐3444or(877)912‐3444
Telephone(otherlocations)+1(952)912‐3444or(877)912‐3444

ConventionsusedinthisGuide



Thisiconindicatesastepthathasthepotentialtobe
troublesome.Furtherinformationregardingitems
markedwiththissymbolcanbefoundinAppendixA:
Troubleshootingonpage60.



Thisiconindicatesahint,orconceptthatislearned.


Thisiconindicatesthatagoalofthekithasbeen
completed.

Thisiconindicatesawarningofthepotentialfor
confusionordanger.
Downloaded from Elcodis.com electronic components distributor

iDigiGatewayDevelopmentKitGettingStartedGuide 4

Contents
IntroductiontotheiDigi®GatewayDevelopmentKit...................................................................................6
GoalsoftheKit..........................................................................................................................................6
RequirementsoftheKit............................................................................................................................6
Part1:SetupyourDigi®GatewayDevelopmentKit......................................................................................7
Step1:KitPreparation..............................................................................................................................7
Step2:ConnecttheConnectPortX4®toyourLocalNetwork..................................................................8
Step3:ConnectyourConnectPort®X4toiDigi®......................................................................................10
Step4:InstalltheDigiESP™forPythonDevelopmentEnvironment.....................................................14
Step5:CreateyourfirstiDigi®DiaProject..............................................................................................17
Step6:PerformaniDigiWebServicesAPI™Request............................................................................38
Step7:UsingtheiDigi®GatewayDevelopmentKitDemonstrationApplication....................................45
Part2:LearnMore......................................................................................................................................52
iDigi®Dia&iDigi®.....................................................................................................................................52
DigiESP™forPython...............................................................................................................................54
Digi’s®Gatewayproducts........................................................................................................................58
XBee®Sensor...........................................................................................................................................59
XBeeSmartPlug™(orXBee®WallRouterinnon‐USkits)......................................................................59
Digi’s®ZigBeeRFModules.......................................................................................................................59
AppendixA:Troubleshooting.....................................................................................................................60
XBee®devicesfailtojointheConnectPortX4’sXBee®network.............................................................60
IstheASSCLEDsolidgreen?...............................................................................................................60
Downloaded from Elcodis.com electronic components distributor

iDigiGatewayDevelopmentKitGettingStartedGuide 5

IstheASSCLEDblinkinggreen?..........................................................................................................60
iDigiManagerPro™doesnotdiscoveryourConnectPort®X4...............................................................61
iDigiManagerPro™liststheConnectPort®X4as‘Disconnected’..........................................................63
Downloaded from Elcodis.com electronic components distributor

iDigiGatewayDevelopmentKitGettingStartedGuide 6

IntroductiontotheiDigi®GatewayDevelopmentKit
ThankyouforpurchasinganiDigiGatewayDevelopmentKit.Thekitisdesignedtomakeiteasy
tosetupanXBeenetwork,uploadacustomiDigiDiaapplication,andprovideseamless
connectivitytotheiDigiplatformforwebservicesintegrationtostandardbusinessapplications
overtheInternet.Beforeyoustartworkingwiththekit,let’scoversomebasics.
GoalsoftheKit
Asyougothroughthestepsinthiskit,youwill:
1. CreateaniDigideveloperaccountontheiDigiM2Moperatingplatform.
2. SetupandconfigurethephysicalelementsofanXBeewirelessnetworkandunderstand
howthenetworkismanagedthroughaConnectPortX4gateway.
3. UsetheDigiESPforPythonIDEtobuild,download,andlaunchaniDigiDiaapplication
foryourConnectPortX4gateway,theninteractwiththeapplicationinarealisticsetting.
4. UsetheiDigiManagerProWebServicesConsoletosendawebservicerequesttothe
ConnectPortX4retrievingthecurrentXBeedevices’sensorreadings.
5. UsetheiDigiGatewayDevelopmentKitDemonstrationApplicationtounderstandhow
anEnterpriseapplicationcouldusetheiDigiWebServicesAPItomonitorthedata
gatheredbytheXBeedevices’sensors.
RequirementsoftheKit
SystemRequirements
ToinstallthesoftwarementionedintheGettingStartedGuide,youwillneedaPCrunning
MicrosoftWindowsXP,VistaorWindows7.
WebBrowserRequirements
MicrosoftInternetExplorer7.0ornewer
GoogleChrome4.0ornewer
MozillaFirefox3.0ornewer
AdditionalRequirements
ThisGettingStartGuideassumesascenariowheretherearenootherXBeewirelessdevicesin
thearea(otherthantheonesprovidedwiththiskit)andthatthelocalnetworkhasanInternet
connection.

Note:IfotherXBeenetworksarepresentandopenforjoining,theXBeeSensorandXBeeSmart
Plugmayjointhewrongnetwork.Pleaserefertothe“XBeedevicesfailtojointheConnectPort
X4’snetwork”sectionofAppendixA:Troubleshootingonpage60formoreinformation.
Downloaded from Elcodis.com electronic components distributor

iDigiGatewayDevelopmentKitGettingStartedGuide 7

Part1:SetupyourDigi®GatewayDevelopmentKit
Step1:KitPreparation
IdentifyYourKitComponents
Carefullyunpackandverifythecontentsofyourkit.Yourkitshouldincludeeachofthe
following:

Figure1:KitContents
DownloadtheDigi®DeviceDiscoveryApplication
Forproperkitconfigurationandoperation,theDigiDeviceDiscoveryApplicationmustbe
downloadedandinstalled.
TodownloadtheDigiDeviceDiscoveryApplication:
1. Navigatetohttp://www.digi.com/gatewaydevelopmentkitandthenclickonthe
“DownloadDigiDeviceDiscoveryApplication”link(withintheDocumentationtab).
2. Clickthe“Downloadyourfile”linkandthenfollowthepromptstoinstallthe
application.
Downloaded from Elcodis.com electronic components distributor

iDigiGatewayDevelopmentKitGettingStartedGuide 8

Step2:ConnecttheConnectPortX4®toyourLocalNetwork
TobeginsettingupyouriDigiGatewayDevelopmentKityouwillneedtoconnectandpoweron
theConnectPortX4,andformyourXBeenetwork.Todoso,followthesesteps:
Note:IfyouhaveadditionalXBee/ZigBeedevices,forthebestkitexperience,werecommend
thatyoupowerdownordisablejoiningonotherXBee/ZigBeePANsintheareabeforebeginning
thisstep.Ifyouareunabletodothisotherdevicesmightjointhekitnetworkandcreate
interferencewhendeployingyouriDigiDiaproject.Youcouldalsoencounterissuesconnecting
theXBeeSensorandXBeeSmartPlugtotheConnectPortX4astheyareconfiguredtojoinany
availablePAN.
1. RemovetheConnectPortX4fromtheboxandattachtheXBeeantennatothe
ConnectPortX4.
2. ConnectoneendoftheEthernetcabletotheConnectPortX4,andtheotherendtoyour
Ethernetswitch(asshownbelow).


Figure2:EthernetSwitch

WARNING:IftheConnectPortX4doesnothaveaccesstotheInternetthiskitcannotbe
completed.
Downloaded from Elcodis.com electronic components distributor

iDigiGatewayDevelopmentKitGettingStartedGuide 9

3. ConnectthepowersupplytotheConnectPortX4andthenplugthepowersupplyintoa
walloutlet.
Note:Thepowersupplyhasatwist‐lockingconnector,ensurethattheconnectoris
lockedintoplace.
4. RemovetheXBeeSmartPlugfromtheboxandplugitintoawalloutlet.ThegreenLED
willblinktoindicatethattheXBeeSmartPlugisassociatedwithanXBeenetwork.
5. Removethebatteries(3)fromtheboxandinstallthemintotheXBeeSensor(unscrew
thetwoscrewsontheXBeeSensortoinstallthebatteries).TheXBeeSensor’sASSCLED
willblinkwhenthedeviceisconnectedtoyourXBeenetwork.
Note:IfeitheroftheXBeedevicesfailstoblinkitsASSCLEDindicatingthatitisconnectedto
yourXBeenetwork,pleaserefertothe“IstheASSCLEDsolidgreen?”sectionofAppendix
A:Troubleshootingonpage60formoreinformation.

Figure3:SettingupyourConnectPortX4
Downloaded from Elcodis.com electronic components distributor

iDigiGatewayDevelopmentKitGettingStartedGuide 10

Step3:ConnectyourConnectPort®X4toiDigi®
TheiDigiplatformisanon‐demandhostedserviceplatformwithnoinfrastructurerequirements
fortheuser.TheiDigiplatformprovidesdevicemanagement,iDigiclientapplicationtoiDigi
devicedatainteraction(messaging),anddatastorageforanetworkcomprisedofbothwired
andwirelessDigiandthird‐partyGateways(callediDigidevices).TheiDigiplatformprovides
easyintegrationwithM2Mandmeshnetworkdevices.

First,beforeyoucanconnectyourConnectPortX4toiDigi,youmustcreateaniDigideveloper
account.

1. TosetupaniDigideveloperaccount:
a. Navigatetohttp://www.idigi.com.
b. ClickontheiDigiLoginbutton.

Figure4:iDigiHomePage
WanttolearnmoreaboutiDigi?
PleaserefertotheiDigiUser’sGuidewhichcan
befoundat
http://www.digi.com/gatewaydevelopmentkit

Downloaded from Elcodis.com electronic components distributor