INGICS TECHNOLOGY BLE WiFi Gateway iGS01 … Gateway iGS01 User Guide ... For WiFi connection, it...

Post on 23-May-2018

221 views 0 download

Transcript of INGICS TECHNOLOGY BLE WiFi Gateway iGS01 … Gateway iGS01 User Guide ... For WiFi connection, it...

  • INGICSTECHNOLOGY

    GuideVer.3a

    BLE_WiFiGatewayiGS01UserGuide

    iGS01isabridgetoconnectthelocalBLEdevices,sensors,orbeaconstotheinternetbytheWiFi.ThroughaneasywebUIinterface,onecanconfiguretheinternetconnectiontoageneralcloudserver,likeTCP,HTTP(S),orMQTT.ManagementthroughthecloudtotheBLEdevicesbecomessimplethroughiGS01.ThisguideistohelptheusertofigureouthowtooperateandconfiguretheiGS01.

    ContentsContentsOverview

    InsidetheboxWiFiBLE

    InputandOutputMulti-functionbutton

    WPSResettoDefaultFirmwareUpgrade

    LEDsCreateConnectionWebUserInterface

    Wi-FiSimpleAPStation

    NetworkAPClientSettingAPServerSetting

    ApplicationsM2MTCPServerM2MTCPClientHTTPClient

    RequestIntervalThrottleControl

    MQTTClientMQTTS

    AdvancedBLEFilter

    RSSIPayloadWhitelist

    DeviceKey/CertificationUpdateSystem

    NTPsettingRevisionHistory

    Statement

    INGICSTECHNOLOGYCO.,LTD.JK.FAN@INGICS.COMWWW.INGICS.COM 1

  • INGICSTECHNOLOGYOverview

    TheiGS01gatewayreadsbeacons(likeiBeaconorEddystone),customizedtags,orBLEsensorsand

    sendstheinformationtothelocalTCPserverorinternetHTTPorMQTTserver.Usercanconfigurethe

    transmitperiodandserverinformationthroughasimplewebUI.Belowisthetypicalapplicationdiagramof

    iGS01.

    Insidethebox

    InsidetheBox,thereareoneiGS01unit,one1MUSBcable,andone2dBidipoleantenna.iGS01is

    poweredbyastandardmicro-USBcable,ratedat5V&500mA.Youcanpowerthisdevicewithastandard

    smartphonechargerortheUSBportofanyhostdevicethatcansupport500mAorabove.

    INGICSTECHNOLOGYCO.,LTD.JK.FAN@INGICS.COMWWW.INGICS.COM 2

  • INGICSTECHNOLOGYWiFi

    ForWiFiconnection,itprovidestwomodes--AccessPointmode(APmode)andStationmode.In

    APmode,itactsasasimpleAPsupportingDHCP.Themainpurposeofthismodeisforconfiguration.In

    Stationmode,itisaclientdevicekeepstryingtojointotheAPinyourhomeoroffice.AfterjoiningtheAP,

    thegatewaycanbridgeyourBLEdevicestothelocalTCPserverofcloudserverformanagement.

    BLEBLEisnormallyinlisteningmode.ItcollectsthemessagesadvertisedbyotherBLEdevices.These

    messagesarethentransferredtoWiFiandsenttothecloudserverconfiguredbytheuser.Thepacket

    formatsenttothecloudserverisinbelowform

    $,,,,,*\r\nexamples:$GPRP,CCB97E7361A4,CB412F0C8EDC,-49,1309696773206D65736820233220285445535429020106 $GPRP,E5A706E3923A,CB412F0C8EDC,-87,0201041AFF590002150112233445566778899AABBCCDDEEFF0000100C3BB *Note: Since firmware v1.2.4+ a timestamp field is added when NTP is enabled. To enable NTP, please update your application server accordingly. Reservedforfuturetag/beacontype.CurrentlyonlyGPRP(generalpurposereport)isdefined.

    MACaddressorIDoftag/beacon

    MACaddressofgatewaysBLE

    RSSIoftag/beacon

    Rawpacketreceivedbythegateway

    OptionaltimestampwhenNTPisenabled(firmwarev1.2.4+)

    InputandOutput

    Multi-functionbuttonOnemulti-functionbuttonislocatedundertheiGS01bodyasthefigureshowed.

    INGICSTECHNOLOGYCO.,LTD.JK.FAN@INGICS.COMWWW.INGICS.COM 3

  • INGICSTECHNOLOGYItisusedtoactWPS,resettodefaultsettings,andOTA(over-the-airFWupgrade).Belowishowit

    functions.

    Function Mode TriggerCondition

    WPS Station shortpressforover1secandrelease

    Resettodefaultsettings Any longpressforover5sec

    OTA Bootup pressthenpoweron,keeppressingtillLEDsflash

    WPSWheniGS01isinStationmode,youmayuseWPStoconnectittoyourAccessPoint.First

    presstheWPSbuttononyourAccessPoint,whenitready,thenpresstheWPSbuttonontheiGS01

    device(theWPSbuttonneedtobepressedforover1sec)tojoinit.

    ResettoDefaultIncaseyouneedtogobacktotheoriginalsettings,keeppressingthereset/defaultbuttonin

    yourdeviceforover5secsnomatterinwhichmodethedeviceis.TheWiFiLEDwillbeturnedoff

    andwhenyoureleasethebutton,theiGS01willreboottoitsdefaultsettings(APmode).

    FirmwareUpgradeCheckAP002_iGS01_Firmware_Upgradefordetails.

    LEDsTherearetwoLEDstoindicatecurrentstatusliketherightfigure.TheupperoneisBLELEDandthe

    loweroneisWiFiLED.Belowistheirbehaviors.

    On Flash

    BLELED findtag/beaconinrange BLEtransmissionhappening

    WiFiLED APmode:APisreadyforconnectStationmode:connecttoassignedAPsuccessfully

    WiFitransmissionhappeningThedevicequicklyblinkingwhilejoiningAPduringboot

    INGICSTECHNOLOGYCO.,LTD.JK.FAN@INGICS.COMWWW.INGICS.COM 4

  • INGICSTECHNOLOGYCreateConnection

    iGS01isinAccessPoint(AP)modedefaultly.Ifyouhavenoideawhatmodecurrentlyitisin,please

    pressthemulti-functionbuttontoresetittothedefaultstate.InAPmode,youcouldscanandconnectit

    withtheWiFiofyourNB/PC/Mac/Tablet/Smartphone.Itsnameisjustlikeabovefigurewithpartofthe

    macaddress.Thedefaultkeytoconnectwithitis12345678.Youcanchangeitlaterwhenyougetinto

    thewebUI.

    Afterconnection,enterIPaddress192.168.10.1inyourbroswer.Thedefaultaccount/passwordare

    bothadmin.Youcanchangethepasswordlater.InwebUI,anychangeneedtobesavedfirst.Afterall

    changesmade,clickreboottomakethechangeseffective.WhenInStationmode,theIPaddressofthe

    iGS01isassignedbythetheotherAP.TogetintothewebUI,youhavetofindtheassignedIPaddress.

    ThefollowingsectionsdescribedetailsofthewebUI.

    WebUserInterface

    Wi-FiiGS01canworkinSimpleAPmodeandStationmode.Thesemodesandtherelatedsettingscanbe

    managedinthispage.

    SimpleAPSSID:ThedefaultnameisBLE-WiFiplus

    thelastdigitsofthemacaddress.Its

    configurablebyuser.

    SecurityProtocol:Open,WPATKIP,WPA

    AES,WPA2TKIP,WPA2AESare

    supported.WPA2AESisrecommended.

    SecurityKey:8-63characterscanbe

    input

    Channel:1~11(ch12andch13couldbe

    INGICSTECHNOLOGYCO.,LTD.JK.FAN@INGICS.COMWWW.INGICS.COM 5

  • INGICSTECHNOLOGYsupportedbyrequest)

    StationScan:ClickittoscanavailableAPs.

    SiteSurvey:Thescanresultislistedhere

    andusercanchoosethecorrectAPfrom

    thelist.TheWiFichanneloftheAPis

    alsolisted.

    SSID:Nomanualinputrequired.Itis

    automaticallyfilledonceuserchoosean

    APfromthescanlist.

    SecurityProtocol:Basicallyitis

    automaticallydetectedandselected

    afterchoosinganAPfromthescanlist.

    ButincasetheAPsettingisinWEPopen

    orWEPshared,userhastoconfirmitby

    himself.

    SecurityKey:Typetheoneassignedin

    yourAP.

    Network

    APClientSettingThissettingismainlyforStationmode.

    NormallyDHCPclientisenabledtojoina

    WiFiAPw/DHCP.Ifonewantsto

    manuallyassignanIPaddressforiGS01,

    theDHCPclientshouldbedisabled.Once

    disabled,usershouldassigntheIP,

    Netmask,Gateway,and/orDNSserver.

    APServerSetting

    INGICSTECHNOLOGYCO.,LTD.JK.FAN@INGICS.COMWWW.INGICS.COM 6

  • INGICSTECHNOLOGYThissettingisforAPmode.ThedefaultIPaddressofiGS01inAPmodeis192.168.10.1and

    thenetmaskis255.255.255..IncasetheuserwanttochangetheIPaddressinAPmode,just

    settheIPandNetmaskhere.ThecorrespondingDHCPclientaddresswillbechangedtoo.

    Forexample,iftheDHCPserverIPaddress

    ischangedto192.168.0.1.,theDHCPclients

    associatedtoiGS01APwillbe192.18.0.X.

    Applications

    M2MTCPServeriGS01isaTCPserverwithfixedIPaddress

    192.168.10.1.Thedefaultportis8080and

    usercanalsoassigntheport.

    M2MTCPClientIfthereisalreadyaTCPserver,onecanset

    iGS01asaTCPclienttocommunicatewith

    theserver.Entertheaddressandport

    numberoftheTCPservertoconnectthem.

    HTTPClientAnotherconnectioninapplicationisthrough

    settingiGS01asaHTTPclient.Inthis

    scenario,onehastoassigntheHTTPhost

    addressandportnumber.Alsotheurlpath

    isnecessarytobringtheBLEdatatothe

    HTTPserverthroughthegateway.Some

    HTTPserversmayneedusernameand

    password.Theothersmayneedextra

    headerandvalue.

    Request Interval Onecanalsoassigntherequestintervalto

    INGICSTECHNOLOGYCO.,LTD.JK.FAN@INGICS.COMWWW.INGICS.COM 7

  • INGICSTECHNOLOGYuploadthedatatotheHTTPserver.ThisisusefulanditcanreducetheHTTPconnections.

    Whentheintervalissetas0,thedatawillbesentimmediately.Whenitissetasanon-zero

    valueinsecond,thedatawillbesentwheneverthebufferisfullorthetimeintervalis

    reached.

    Throttle Control Ifuserselecttoenablethrottlecontrol,iGS01willkeepthelastrecordforeachTAG/Beacon

    IDinthegiveninterval(requestinterval).Inthisway,onecanreducetheuploadconnections

    totheHTTPserver.

    MQTTClientMQTTserverissupportedbytheiGS01.In

    thisscenario,onehastoassigntheMQTT

    hostaddressandportnumber.Alsothe

    publishtopicneedtobeassigned.ClientID

    isdefaultlyassignedasthegatewayname

    withpartofMACaddress,usercanchangeit

    aswell.IfClientIDisnotset,systemwill

    generatearandomnumberforit.Username

    andpasswordareoptional.

    MQTTS FromfirmwareversionV1.2.2,usercan

    enableMQTTSsupport.UsercanalsoenableRootCA/UseCertificatebasedontheserver

    requirement.Forexample,toenableAWS-IOT,theuserhastoenableMQTTS/ROOTCA/Use

    Certificateoptionsandupload

    certificateandprivatekeyinadvanced

    page.

    AdvancedThisisanewaddedpageiniGS01

    configurationUIsincefirmwareV1.2.2.

    INGICSTECHNOLOGYCO.,LTD.JK.FAN@INGICS.COMWWW.INGICS.COM 8

  • INGICSTECHNOLOGYBLEFilter

    UsercansetBLEfiltertofilterouttheunwantedBLEinformation.Therearetwokindof

    filters.OneisbyBLERSSIvalueandtheotherisbypattern/maskcombination.

    RSSI Ifthebarispulledrightto-50dBm,onlytheBLEtag/beaconwithRSSIlargerthanorequalto

    -50dBm(say-45dBm)willbesentouttotheserver.

    Payload Whitelist Setpattern/maskfieldstoconfigurethewhitelist.

    Ifpayload&mask!=pattern&mask,theentrywillbefilteredout.

    DeviceKey/CertificationUpdateUsercanuploadcertificationandkeyhere.

    ThisisusedbyMQTTS.AWS-IOTusersmustuploadthecertificateandprivatekeyhereto

    publishdatatoAWS-IOT.

    SystemFirmwareanddeviceinformation,includingMAC

    addressandIPaddressinstationmodeareshownhere.

    ThewebUIpasswordcanalsobechangedhere(the

    usernameisfixedasadmin).

    NTPsettingUsercanenabletheNTPtoaddthe

    timestampinformationintheBLEpackage

    formatasstatedinpage.3.Userhastoset

    thetimeserverandtheupdateperiodofthe

    NTP.Remembertosavethesettingand

    reboottomakethesettingeffective.

    INGICSTECHNOLOGYCO.,LTD.JK.FAN@INGICS.COMWWW.INGICS.COM 9

  • INGICSTECHNOLOGY

    RevisionHistory

    DATE REVISION CHANGES

    Oct7,2015 1 Initialrelease

    Oct15,2015 1a ModifytheHTTPclientwordingandaddRequestIntervalsetting

    Nov28,2015 2 1. Updatethephotoofgatewayinoncoverpage2. RenameBLE2WiFitoiGS013. UpdatetheoverviewchapterandaddaInsidethe

    Boxsections.4. ModifywordingandaddfigureinLEDsection.The

    LEDpositionischanged.5. UpdatetheHTTPclientsectioninchapter

    Applications.6. UpdatetheAPServerSettingsectioninchapter

    Network

    Apr6,2016 2a ThismodificationisforfirmwareV1.2.0andlater1. RevisetheUIscreenbecauseoftheUIstylechanged2. FromV1.2.2,supportAWSIOTandMQTTS.Modify

    thesettinginMQTTclientsection3. AddAdvancedpageforaddingfilterfeatureand

    RootCA/Certificatefileupload.4. EnhancetheLEDdefinitionforbetteridentificationin

    LEDsection

    May6,2016 2b AddstatementforFCC,IC,andNCCinpage11

    Jul4,2016 3 FromV1.2.4firmware,NTPfunctionisadded.Inpage.3andpage.9,addtheNTPandtimestampdescription.

    May25,2017 3a AddCEDoCforREDDirective2014/53/EUinlastpage

    INGICSTECHNOLOGYCO.,LTD.JK.FAN@INGICS.COMWWW.INGICS.COM 10

  • INGICSTECHNOLOGYStatementFederalCommunicationCommissionInterferenceStatementThisequipmenthasbeentestedandfoundtocomplywiththelimitsforaClassBdigitaldevice,pursuanttoPart15oftheFCCRules.Theselimitsaredesignedtoprovidereasonableprotectionagainstharmfulinterferenceinaresidentialinstallation.Thisequipmentgenerates,usesandcanradiateradiofrequencyenergyand,ifnotinstalledandusedinaccordancewiththeinstructions,maycauseharmfulinterferencetoradiocommunications.However,thereisnoguaranteethatinterferencewillnotoccurinaparticularinstallation.Ifthisequipmentdoescauseharmfulinterferencetoradioortelevisionreception,whichcanbedeterminedbyturningtheequipmentoffandon,theuserisencouragedtotrytocorrecttheinterferencebyoneofthefollowingmeasures:.Reorientorrelocatethereceivingantenna..Increasetheseparationbetweentheequipmentandreceiver..Connecttheequipmentintoanoutletonacircuitdifferentfromthattowhichthereceiverisconnected..Consultthedealeroranexperiencedradio/TVtechnicianforhelp.FCCCaution:Toassurecontinuedcompliance,anychangesormodificationsnotexpresslyapprovedbythepartyresponsibleforcompliancecouldvoidtheuser'sauthoritytooperatethisequipment.(Example-useonlyshieldedinterfacecableswhenconnectingtocomputerorperipheraldevices).FCCRadiationExposureStatementThisequipmentcomplieswithFCCRFradiationexposurelimitssetforthforanuncontrolledenvironment.Thisequipmentshouldbeinstalledandoperatedwithaminimumdistanceof20centimetersbetweentheradiatorandyourbody.Thistransmittermustnotbeco-locatedoroperatinginconjunctionwithanyotherantennaortransmitter.Theantennasusedforthistransmittermustbeinstalledtoprovideaseparationdistanceofatleast20cmfromallpersonsandmustnotbeco-locatedoroperatinginconjunctionwithanyotherantennaortransmitter.ThisdevicecomplieswithPart15oftheFCCRules.Operationissubjecttothefollowingtwoconditions:(1)Thisdevicemaynotcauseharmfulinterference,and(2)Thisdevicemustacceptanyinterferencereceived,includinginterferencethatmaycauseundesiredoperation.IndustryCanadaStatementThisdevicecomplieswithIndustryCanadalicence-exemptRSSstandard.Operationissubjecttothefollowingtwoconditions:(1)thisdevicemaynotcauseinterference,and(2)thisdevicemustacceptanyinterference,includinginterferencethatmaycauseundesiredoperationofthedevice.LeprsentappareilestconformeauxCNRd'IndustrieCanadaapplicablesauxappareilsradioexemptsdelicence.L'exploitationestautoriseauxdeuxconditionssuivantes:(1)l'appareilnedoitpasproduiredebrouillage,et(2)l'utilisateurdel'appareildoitacceptertoutbrouillageradiolectriquesubi,mmesilebrouillageestsusceptibled'encompromettrelefonctionnement.ICRadiationExposureStatementThisequipmentcomplieswithICRSS-102radiationexposurelimitsetforthforanuncontrolledenvironment.Thisequipmentshouldbeinstalledandoperatedwithminimumdistance20cmbetweentheradiatorandyourbody.CetquipementestconformeauxCNR-102d'IndustrieCanada.Cetquipementdoittreinstalletutilisavecunedistanceminimalede20centimtresentreleradiateuretvotrecorps.Cetmetteurnedoitpastreco-localisesouoprantenconjonctionavecautreantenneoumetteur.Lesantennesutilisespourcetmetteurdoiventtreinstallsetfournirunedistancedesparationd'aumoins20centimtredetoutepersonneetdoitpastreco-situenifonctionnerenconjonctionavecuneautreantenneoumetteur.NCC MPE1mW/cm2 0.0103mW/cm2

    INGICSTECHNOLOGYCO.,LTD.JK.FAN@INGICS.COMWWW.INGICS.COM 11

  • INGICSTECHNOLOGY

    INGICSTECHNOLOGYCO.,LTD.JK.FAN@INGICS.COMWWW.INGICS.COM 12