Digi ConnectPort X4 User manual











iDigi®GatewayDevelopmentKit
GettingStartedGuide
WirelessWANVersion






June8,2011
90001253_A

iDigiGatewayDevelopmentKitGettingStartedGuide–WirelessWANVersion  2

©2011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.


iDigiGatewayDevelopmentKitGettingStartedGuide–WirelessWANVersion  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D:
Troubleshootingonpage79.



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.

iDigiGatewayDevelopmentKitGettingStartedGuide–WirelessWANVersion  4

Contents
UsingthisGuide............................................................................................................................................3
ContactInformation..................................................................................................................................3
ConventionsusedinthisGuide................................................................................................................3
IntroductiontotheiDigi®GatewayDevelopmentKit–WirelessWANVersion...........................................7
GoalsoftheKit..........................................................................................................................................7
RequirementsoftheKit............................................................................................................................7
SystemRequirements...........................................................................................................................7
WebBrowserRequirements.................................................................................................................7
AdditionalRequirements......................................................................................................................7
Part1:SetupyourDigi®GatewayDevelopmentKit......................................................................................8
Step1:KitPreparation..............................................................................................................................8
IdentifyYourKitComponents...............................................................................................................8
Step2:UnpackandSetuptheConnectPortX4........................................................................................9
Step3:ConfiguretheConnectPortX4....................................................................................................10
ConfiguringtheConnectPortX4IPGatewayPriority.........................................................................11
ConfiguringtheEthernetInterface.....................................................................................................12
ViewingIPAddressInformation.........................................................................................................13
ViewingEthernetStatistics.................................................................................................................13
Step4:SetuptheXBeeSmartPlugandXBeeSensor.............................................................................14
Step5:ConnecttheConnectPort®X4toiDigi®........................................................................................15
AddtheConnectPortX4®toyouriDigi®Inventory............................................................................17

iDigiGatewayDevelopmentKitGettingStartedGuide–WirelessWANVersion  5

Step6:InstalltheDigiESP™forPythonDevelopmentEnvironment.....................................................19
Step7:CreateyourfirstiDigi®DiaProject..............................................................................................22
Step8:PerformaniDigiWebServicesAPI™Request............................................................................43
Step9:UsingtheiDigi®GatewayDevelopmentKitDemonstrationApplication....................................50
GettingFamiliarwiththeiDigiGatewayDevelopmentKitDemonstrationApplication....................52
XBee®Sensor:.....................................................................................................................................52
XBeeSmartPlugTM(forUSkitsonly):.................................................................................................53
LoggedData:.......................................................................................................................................54
Part2:LearnMore......................................................................................................................................57
iDigi®Dia&iDigi®.....................................................................................................................................57
GoingtoMarket?................................................................................................................................57
DigiESP™forPython...............................................................................................................................58
Digi’s®GatewayProducts........................................................................................................................63
GatewayFunctionality........................................................................................................................63
Programmability.................................................................................................................................63
XBee®Sensor...........................................................................................................................................64
XBeeSmartPlug™(orXBee®WallRouterinnon‐USkits)......................................................................64
Digi’s®ZigBeeRFModules.......................................................................................................................64
AppendixA:ConfiguringforGSM/EdgeCellularNetworks........................................................................65
Step1:InsertingtheSIMCard(s)............................................................................................................65
Step2:ConfiguringtheCellularInterface...............................................................................................66
AppendixB:ConfiguringforCDMACellularNetworks...............................................................................68
CDMACellularConfigurationExample(Verizon)................................................................................68

iDigiGatewayDevelopmentKitGettingStartedGuide–WirelessWANVersion  6

CDMACellularConfigurationExample(Sprint)..................................................................................72
AppendixC:ConfiguringforWiMAXNetworks..........................................................................................75
Step1:ConnectingtotheConnectPortX4HomePage..........................................................................75
Step2:ConfiguringtheWirelessWANInterfaceforWiMAXNetworks................................................76
Step3:ViewingtheWiMAXConnectionStatus......................................................................................78
AppendixD:Troubleshooting.....................................................................................................................79
XBee®devicesfailtojointheConnectPortX4’sXBee®network.............................................................79
IstheASSCLEDsolidgreen?...............................................................................................................79
IstheASSCLEDblinkinggreen?..........................................................................................................79
iDigiManagerPro™doesnotdiscoveryourConnectPort®X4...............................................................80
iDigiManagerPro™liststheConnectPort®X4as‘Disconnected’..........................................................82

iDigiGatewayDevelopmentKitGettingStartedGuide–WirelessWANVersion  7

IntroductiontotheiDigi®GatewayDevelopmentKit–
WirelessWANVersion
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Cloud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. ConfiguretheWirelessWANinterfaceoftheConnectPortX4.
2. CreateaniDigideveloperaccountontheiDigiM2MoperatingCloud.
3. SetupandconfigurethephysicalelementsofanXBeewirelessnetworkandunderstand
howthenetworkismanagedthroughaConnectPortX4gateway.
4. 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.
5. 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.
6. 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D:Troubleshootingonpage79formoreinformation.

iDigiGatewayDevelopmentKitGettingStartedGuide–WirelessWANVersion  8

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.

Figure1:KitComponents
ThetablebelowindicatesthetypeandquantityofcellularorWiMAXantennasincludedinyourkit.
AntennaSprint
X4K‐Z1U‐C1011‐A1
Verizon
X4K‐Z1U‐C2011‐A1
AT&T
X4K‐Z1U‐H2011‐A1
Generic
X4K‐Z1U‐U7011‐A1
WiMAX
X4K‐Z1U‐C6011‐A1
A11111
B22
C 2 2
D 2

iDigiGatewayDevelopmentKitGettingStartedGuide–WirelessWANVersion  9

Step2:UnpackandSetuptheConnectPortX4
TobeginsettingupyouriDigiGatewayDevelopmentKit,youwillneedtoconnecttheantennas
toyourConnectPortX4,connectyourPC’sEthernetcabletotheConnectPortX4,andthen
powerontheConnectPortX4,andthenformyourXBeenetwork.

Figure2:ConnectingHardware
1. RemovetheConnectPortX4fromtheboxandattachtheXBeeantennatotheunit.
2. AttachtheCellularorWiMAXantenna(s)toyourConnectPortX4.
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.

iDigiGatewayDevelopmentKitGettingStartedGuide–WirelessWANVersion  10

Step3:ConfiguretheConnectPortX4
Note:Bydefault,ConnectPortX4WirelessWANmodelsareconfiguredwithastaticIPAddressof
192.168.1.1fortheEthernetinterface,andtheyareconfiguredtoactasaDHCPServer.This
configurationsimplifiestheinitialconfigurationoftheunit.
1. ConnectoneendoftheEthernetcabletoyourPC,andtheotherendtotheConnectPort
X4Ethernetport(ensurethatyourPCisconfiguredtoobtainitsIPaddressviaDHCP).
2. OpentheWebinterfaceoftheConnectPortX4bynavigatingtothe192.168.1.1address
inaWebbrowseronthePCandyouwillseeascreensimilartothefollowing:

Figure3:WebInterface
3. ConfiguretheConnectPortX4WirelessWANandEthernetinterface.Selectthe
AppendixbelowthatbestmatchestheWirelessWANinterfaceofyourConnectPortX4.
Note:FormoreinformationonhowtoproperlyconfiguretheConnectPortX4Wireless
WANinterface,refertothefollowingAppendix:
AppendixA:ConfiguringforaGSM/Edgecellularnetwork(AT&T)
AppendixB:ConfiguringforaCDMAcellularnetwork(Verizon)
AppendixC:ConfiguringforaCDMAcellularnetwork(Sprint)
AppendixD:ConfiguringforaWiMAXnetwork

iDigiGatewayDevelopmentKitGettingStartedGuide–WirelessWANVersion  11

OnceyouhavefollowedtheconfigurationexamplesfortheWirelessWANinterfaceintheappropriate
Appendix,continuewiththefollowingsectionsbelow:
ConfiguringtheConnectPortX4IPGatewayPriority
OncetheConnectPortX4'smobileinterfaceisconnected,itcouldconceivablyreachtheInternetvia
eitherofitsnetworkinterfaces(MobileorEthernet).ConfiguringtheConnectPortX4GatewayPriority
Listdeterminesthepriorityforeachofitsnetworkinterfaces.BydefaulttheConnectPortX4givesthe
Mobileinterfacethehighestpriority.
TheConnectPortX4IPGatewayPriorityListandtheDNSPriorityListareconfigurableviathe
Configuration>Network>AdvancedNetworkSettingspage,asdisplayedbelow:(GatewayPrioritywill
displayWiMAXforWiMAXunits.)

Figure4:AdvancedNetworkSettings



iDigiGatewayDevelopmentKitGettingStartedGuide–WirelessWANVersion  12

ConfiguringtheEthernetInterface
NowthattheConnectPortX4’smobileinterfaceisconfigured,youwillneedtoconfiguretheEthernet
interface.TheEthernetconfigurationchangeswillinvolvedisablingtheDHCPServeranddetermining
howtheConnectPortX4willbegivenitsIPaddress.
1. ClickonConfiguration>Networkfromtheleft‐handmenu.YoushouldseetheNetwork
Configurationscreen(withtheEthernetIPSettingspagedisplayedbydefault)asshown:

Figure5:EthernetIPSettings
2. ClicktheDHCPServerSettingslinkandopentheDHCPServerSettingspage.
3. TodisabletheDHCPServer,un‐checkthe"EnableDynamicHostConfigurationProtocol
(DHCP)Server"entry.ClickApplywhenfinished.
4. ReturntotheEthernetIPSettingspagebyclickingtheEthernetIPSettingslink.
5. ConfiguretheConnectPortX4witheitherastaticIPaddress,orhaveitgetitsIPaddress
fromaDHCPServer,whichevermethodisappropriate.ClickApplywhenfinished.

iDigiGatewayDevelopmentKitGettingStartedGuide–WirelessWANVersion  13

ViewingIPAddressInformation
TheConnectPortX4HomepagewilldisplaytheIPaddressforboththeEthernetandMobilenetworks.

Figure6:ConnectPortX4HomePage
ViewingEthernetStatistics
ToviewinformationabouttheEthernetLinkaswellasEthernetandIPstatistics,navigatetothe
Administration>SystemInformation>Networkpage.
TheConnectPortX4isnowreadytobemovedtoyourEthernetnetwork,andbydefaultwilluseits
mobileinterfaceasitsprimarynetworkinterface.
DisconnecttheConnectPortX4fromyourPCandthenconnectittotheEthernetnetwork(ifthePC
needstobereconfiguredwithastaticIPaddress,dothispriortomovingthePCtotheEthernetnetwork
aswell).
YouhavejustcompletedGoal#1:
ConfiguretheWirelessWANinterfaceofthe
ConnectPortX4.


iDigiGatewayDevelopmentKitGettingStartedGuide–WirelessWANVersion  14

Step4:SetuptheXBeeSmartPlugandXBeeSensor
XBee/ZigBeeNote:IfyouhaveadditionalXBee/ZigBeedevices,forthebestkitexperience,we
recommendpoweringdownordisablejoining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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.
2. RemovetheXBeeSensorfromtheboxandinsert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D:
Troubleshootingonpage79formoreinformation.

iDigiGatewayDevelopmentKitGettingStartedGuide–WirelessWANVersion  15

Step5:ConnecttheConnectPort®X4toiDigi®
TheiDigiCloudisanon‐demandhostedserviceplatformwithnoinfrastructurerequirementsforthe
user.TheiDigiCloud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Cloud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theiDigiLoginbuttonintheupperrightcornerofthepage.
c. ClicktheiDigiDeveloperCloudloginbutton.

Figure7:iDigiCloudScreen
YouwillberedirectedtotheiDigiDeveloperCloudlogin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


iDigiGatewayDevelopmentKitGettingStartedGuide–WirelessWANVersion  16

d. IfyoudonotalreadyhaveaniDigideveloperaccount,clickonthe“Areyouanew
user"linkandcreateyouraccount.
Ifyoualreadyhaveanaccount,loginandskipaheadtothe“AddtheConnectPortX4
toyouriDigiinventory”sectiononthenextpage.

Figure8:iDigiLoginPage
ContinuefillinginallrequiredfieldsoftheiDigiRegistrationFormuntilyoucomplete
theiDigiRegistrationprocess.

Figure9:NewUserRegistrationPage
e. AftercompletingtheiDigiRegistrationprocess,youwillberedirectedtotheiDigi
Loginpage(refertoFigure5,above).EnteryouriDigiusercredentialsandthenclick
theLoginbutton.

YouhavejustcompletedGoal#2:
CreatinganiDigideveloperaccounton
theiDigiM2Moperatingplatform.

iDigiGatewayDevelopmentKitGettingStartedGuide–WirelessWANVersion  17

AddtheConnectPortX4®toyouriDigi®Inventory
TheiDigiCloudallowsyoutosecurelymanagethedevicesinyourdeviceinventory.
1. ToaddtheConnectPortX4toyourinventory,followthesesteps:
a. SelecttheDeviceslinkintheLeftNavigationBar.
b. ClicktheAddDevicesbuttonintheToolBartoopentheAddDevices
applet.TheAddDevicesappletwilldiscovertheDigidevicesonyournetwork.
Note:Inordertodiscoverdevicesonyournetworkautomatically,theAddDevicesapplet
requiresJavaRuntimeEnvironment(JRE)1.6ornewer.
IfJavaRuntimeEnvironment(JRE)1.6isnotinstalled,youmustaddyourdevicemanually;
seethe“iDigiManagerProdoesnotdiscoveryourConnectPortX4”sectionofAppendixD:
Troubleshooting,onpage80formoreinformation.
c. SelectyourConnectPortX4fromthelist.Toverifythatyouareselectingthe
correctdevicefromthelist,matchtheMACaddresslistedonyourlabel(found
onthebottomofthedevice)withtheMACaddresslistedwithintheAdd
Devicesapplet.ClicktheOKbutton.

Figure10:AddDevicesApplet

iDigiGatewayDevelopmentKitGettingStartedGuide–WirelessWANVersion  18

d. Waitabout60secondsthengobacktotheDeviceslistandclicktheRefresh
button.ThestatusofyourConnectPortX4shouldnowappearas“Connected.”

Figure11:iDigiDeviceInventory

Note:Ifthedevicestillappearsas‘Disconnected’afterclickingtheRefreshbutton,please
refertothe“’iDigiManagerProliststheConnectPortX4as‘Disconnected'”sectionof
AppendixD:Troubleshooting,onpage82formoreinformation.


iDigiGatewayDevelopmentKitGettingStartedGuide–WirelessWANVersion  19

Step6:InstalltheDigiESP™forPythonDevelopment
Environment
TheDigiESPforPythonDevelopmentEnvironmentisanEclipse‐basedIntegratedDevelopment
Environment(IDE)thatsimplifiestheprocessofcreatingPythonapplicationsforiDigidevices.It
alsoprovidesmanyexampleprojects,oneofwhichwewillbeusinglaterinthissection.
TodownloadandinstalltheDigiESPforPythonDevelopmentEnvironment:
1. Navigatetohttp://www.digi.com/gatewaydevelopmentkitandclickonthe“Download
DigiESPforPython”link.
2. YouwillberedirectedtothePythonProductpage.Thevariousdownloadoptionsfor
theDigiESPforPythonframeworkwillbedisplayedonthispage.Clickonthe“DigiESP
forPython‐WindowsXP/Vista/Windows7installerver.1.2.0.5”linktodownloadthe
DigiESPforPythonDevelopmentEnvironment.
Note:MacoperatingsystemsarenotsupportedinthisDevelopmentKitexperience.

Figure12:SelectDigiESPforPythonDownloadVariant

iDigiGatewayDevelopmentKitGettingStartedGuide–WirelessWANVersion  20

3. OncetheDigiESPforPythonframeworkhasbeendownloaded,runtheDigiESPfor
Pythonframeworkinstallationwizard.Followthestepsinthewizardtocompletethe
installationprocess.ClickFinishattheendoftheinstallation.
Note:ApromptwillaskyouifyouwouldliketoopentheReleaseNotesassociatedwith
theDigiESPforPythonframework,deselectthischeckbox.
4. TheDigiESPforPythonframeworkwilllaunchautomaticallyandpromptyoutoselecta
workspacedirectory.Usethedefaultworkspacedirectory(orclicktheBrowsebutton
andnavigatetoyourdesiredalternateworkspacelocation),checkthe“Usethisasthe
defaultanddonotaskagain”box,andclickOK.
Note:TheDigiESPforPythonframework'workspace'isthedirectorywhereprojectsand
configurationswillbestored.Thedefaultlocationforthisdirectoryisasubfoldercalled
workspaceontheuserhomedirectory,forexample,C:/Documentsand
Settings/[username]/workspace.

Figure13:SelectingyourDigiESPforPythonWorkspace