Axis A1214 User manual

AXISA1214NetworkDoorControllerKit
Usermanual

AXISA1214NetworkDoorControllerKit
TableofContents
Solutionoverview...........................................3
Productoverview...........................................4
Productcomponents.........................................5
Installation................................................6
AXISA1210-Busermanual...................................7
Getstarted................................................8
Findthedeviceonthenetwork....................................8
Openthedevice'swebinterface....................................8
Createanadministratoraccount...................................8
Securepasswords...............................................8
erifythatnoonehastamperedwiththermware....................9
Webinterfaceoverview..........................................9
Installation................................................10
Congureourdevice........................................11
Thewebinterface...........................................12
Status........................................................12
Accesscontrol..................................................13
System........................................................13
Maintenance...................................................22
Learnmore................................................23
Cybersecurity...................................................23
Specications..............................................24
Productoverview................................................24
LEDindicators..................................................24
Buttons.......................................................25
Connectors....................................................25
Troubleshooting............................................31
Resettofactorydefaultsettings...................................31
Firmwareoptions...............................................31
Checkthecurrentrmwareversion.................................31
Upgradethermware............................................31
Technicalissues,clues,andsolutions................................32
Contactsupport.................................................33
2

AXISA1214NetworkDoorControllerKit
Solutionoverview
Solutionoverview
ThenetworkdoorcontrollerkitcaneasilybeconnectedtoandpoweredbyyourexistingIPnetworkwithnoneedforspecialcabling.
Eachnetworkdoorcontrollerkitcanpowerandcontroluptoeightreaders.
3

AXISA1214NetworkDoorControllerKit
Produtoverview
Produtoverview
1Hingepin(2x)
2Hinge:left(2x),right(2x)
3Cabinetbase
4Cableholeandgasket:¾
� (2x),½ � (3x)
5Drillout(5x)
6Cabinetmountingplate
7Screwholeforwallmount(6x)
8Hook(4x)
9Screwholeforbracketmount(4x)
10Knockout:¾
� (5x)
11Knockout:¾
� (8x)
12Knockout:11/2
� ,¾ �
13Controllerkitmountingplategroundingpoint
14Controllermountingplate(4x)
15Doorcontroller(4x)
16Controllerkitmountingplate
17Cabinetdoor
4

AXISA1214NetworkDoorControllerKit
Produtomponents
Produtomponents
Thedoorcontrollerkitconsistsofthefollowingcomponents:
•4xAXISA1210-BNetworkDoorController
•1xAXISTQ1808-ESurveillanceCabinet
•1xAXISTA1601MountingPlate
5

AXISA1214NetworkDoorControllerKit
Installation
Installation
Towatchthisvideo,gotothewebversionofthisdocument.
help.axis.com/?&piaId=81064&section=solutionoverview
6

AXISA1214NetworkDoorControllerKit
AXISA1210-Busermanual
AXISA1210-Busermanual
Note
ThefollowingisabouthowtocongureanduseAXISA1210-BNetworkDoorController.
7

AXISA1214NetworkDoorControllerKit
Getstarted
Getstarted
Findthedeviceonthenetwork
TondAxisdevicesonthenetworkandassignthemIPaddressesinWindows®,useAXISIPUtilityorAXISDeviceManager.Both
applicationsarefreeandcanbedownloadedfromaxis.com/support.
FormoreinformationabouthowtondandassignIPaddresses,gotoHowtoassignanIPaddressandaccessyourdevice.
Browserspport
Youcanusethedevicewiththefollowingbrowsers:
ChromeTMFirefox®EdgeTMSafari®
Windows®recommendedrecommended
macOS®recommendedrecommended
Linux®recommendedrecommended
Otheroperatingsystems*
*TouseAXISOSwebinterfacewithiOS15oriPadOS15,gotoSettings Settings
Settings> > >Safari Safari Safari> > >Advanced Advanced Advanced> > >Experimental Experimental ExperimentalFeatures Features Featuresanddisable
NSURLSessionWebsocket.
Ifyouneedmoreinformationaboutrecommendedbrowsers,gotoAXISOSPortal.
Openthedevice'swebinterface
1.OpenabrowserandtypetheIPaddressorhostnameoftheAxisdevice.
IfyoudonotknowtheIPaddress,useAXISIPUtilityorAXISDeviceManagertondthedeviceonthenetwork.
2.Typetheusernameandpassword.Ifyouaccessthedeviceforthersttime,youmustcreateanadministratoraccount.See
Createanadministratoraccountonpage8.
Createanadministratoraccont
Thersttimeyoulogintoyourdevice,youmustcreateanadministratoraccount.
1.Enterausername.
2.Enterapassword.SeeSecurepasswordsonpage8.
3.Re-enterthepassword.
4.ClickAdduser.
Important
Thedevicehasnodefaultaccount.Ifyoulosethepasswordforyouradministratoraccount,youmustresetthedevice.See
Resettofactorydefaultsettingsonpage31.
Secrepasswords
Important
Axisdevicessendtheinitiallysetpasswordincleartextoverthenetwork.Toprotectyourdeviceaftertherstlogin,set
upasecureandencryptedHTTPSconnectionandthenchangethepassword.
8

AXISA1214NetworkDoorControllerKit
Getstarted
Thedevicepasswordistheprimaryprotectionforyourdataandservices.Axisdevicesdonotimposeapasswordpolicyasthey
maybeusedinvarioustypesofinstallations.
Toprotectyourdatawestronglyrecommendthatyou:
•Useapasswordwithatleast8characters,preferablycreatedbyapasswordgenerator.
•Don’texposethepassword.
•Changethepasswordatarecurringinterval,atleastonceayear.
Verifythatnoonehastamperedwiththermware
TomakesurethatthedevicehasitsoriginalAxisrmware,ortotakefullcontrolofthedeviceafterasecurityattack:
1.Resettofactorydefaultsettings.SeeResettofactorydefaultsettingsonpage31.
Afterthereset,securebootguaranteesthestateofthedevice.
2.Congureandinstallthedevice.
Webinterfaceoverview
Thisvideogivesyouanoverviewofthedevice’swebinterface.
Towatchthisvideo,gotothewebversionofthisdocument.
help.axis.com/?&piaId=81064&section=webinterfaceoverview
Axisdevicewebinterface
9

AXISA1214NetworkDoorControllerKit
Installation
Installation
Towatchthisvideo,gotothewebversionofthisdocument.
help.axis.com/?&piaId=81064&section=solutionoverview
10

AXISA1214NetworkDoorControllerKit
Configureyourdevie
Configureyourdevie
Forhowtocongureyourdevice,seeAXISCameraStationusermanualorthird-partysolutions.
11

AXISA1214NetworkDoorControllerKit
Thewebinterfae
Thewebinterfae
Toreachthedevice’swebinterface,typethedevice’sIPaddressinawebbrowser.
Note
Supportforthefeaturesandsettingsdescribedinthissectionvariesbetweendevices.Thisiconindicatesthat
thefeatureorsettingisonlyavailableinsomedevices.
Showorhidethemainmenu.
Accessthereleasenotes.
Accesstheproducthelp.
Changethelanguage.
Setlightthemeordarktheme.
Theusermenucontains:
•Informationabouttheuserwhoisloggedin.
•Changeaccount:Logoutfromthecurrentaccountandlogintoanewaccount.
•Logout:Logoutfromthecurrentaccount.
Thecontextmenucontains:
•Analticsdata:Accepttosharenon-personalbrowserdata.
•Feedback:Shareanyfeedbacktohelpusimproveyouruserexperience.
•Legal:iewinformationaboutcookiesandlicenses.
•About:iewdeviceinformation,includingrmwareversionandserialnumber.
•Legacdeviceinterface:Changethedevice’swebinterfacetothelegacyversion.
Stats
Timesncstatus
ShowsNTPsynchronizationinformation,includingifthedeviceisinsyncwithanNTPserverandthetimeremaininguntil
thenextsync.
NTPsettings:iewandupdatetheNTPsettings.TakesyoutotheDateandtimepagewhereyoucanchangetheNTPsettings.
Deviceinfo
Showsthedeviceinformation,includingrmwareversionandserialnumber.
Upgradermware:Upgradethermwareonyourdevice.TakesyoutotheMaintenancepagewhereyoucandoarmware
upgrade.
12

AXISA1214NetworkDoorControllerKit
Thewebinterfae
Accesscontrol
Alarms
Devicemotion:Turnontotriggeranalarminyoursystemwhenitdetectsamovementofthedoorcontroller.
Casingopen:Turnontotriggeranalarminyoursystemwhenitdetectsanopendoorcontrollercase.Turnoffthissettingfor
barebonedoorcontrollers..
Externaltamper:Turnontotriggeranalarminyoursystemwhenitdetectsanexternaltamper.Forexample,whensomeone
opensorclosestheexternalcabinet.
•Supervisedinput:Turnontomonitortheinputstateandconguretheend-of-lineresistors.
-Touseparallelrstconnection,selectParallelrstconnectionwitha22KΩparallelresistoranda4.7
KΩserialresistor.
-Touseserialrstconnection,selectSerialrstconnectionandselectaresistorvaluefromtheResistor
valuesdrop-downlist.
Peripherals
Upgradereaders:Clicktoupgradereaderstoanewrmwareversion.Thefeaturecanonlyupgradesupportedreaderswhen
theyareonline.
System
Timeandlocation
Dateandtime
Thetimeformatdependsonthewebbrowser’slanguagesettings.
Note
Werecommendyousynchronizethedevice’sdateandtimewithanNTPserver.
Snchronization:Selectanoptionforthedevice’sdateandtimesynchronization.
•Automaticdateandtime(manualNTSKEservers):SynchronizewiththesecureNTPkeyestablishmentservers
connectedtotheDHCPserver.
-ManualNTSKEservers:EntertheIPaddressofoneortwoNTPservers.WhenyouusetwoNTPservers,
thedevicesynchronizesandadaptsitstimebasedoninputfromboth.
•Automaticdateandtime(NTPserversusingDHCP):SynchronizewiththeNTPserversconnectedtotheDHCPserver.
-FallbackNTPservers:EntertheIPaddressofoneortwofallbackservers.
•Automaticdateandtime(manualNTPservers):SynchronizewithNTPserversofyourchoice.
-ManualNTPservers:EntertheIPaddressofoneortwoNTPservers.WhenyouusetwoNTPservers,the
devicesynchronizesandadaptsitstimebasedoninputfromboth.
•Customdateandtime:Manuallysetthedateandtime.ClickGetfromsstemtofetchthedateandtimesettings
oncefromyourcomputerormobiledevice.
Timezone:Selectwhichtimezonetouse.Timewillautomaticallyadjusttodaylightsavingtimeandstandardtime.
Note
Thesystemusesthedateandtimesettingsinallrecordings,logs,andsystemsettings.
Network
IPv4
13

AXISA1214NetworkDoorControllerKit
Thewebinterfae
AssignIPv4automaticall:SelecttoletthenetworkrouterassignanIPaddresstothedeviceautomatically.Werecommend
automaticIP(DHCP)formostnetworks.
IPaddress:EnterauniqueIPaddressforthedevice.StaticIPaddressescanbeassignedatrandomwithinisolatednetworks,
providedthateachaddressisunique.Toavoidconicts,werecommendyoucontactyournetworkadministratorbeforeyou
assignastaticIPaddress.
Subnetmask:Enterthesubnetmasktodenewhataddressesareinsidethelocalareanetwork.Anyaddressoutsidethelocal
areanetworkgoesthroughtherouter.
Router:EntertheIPaddressofthedefaultrouter(gateway)usedtoconnectdevicesthatareattachedtodifferentnetworksand
networksegments.
FallbacktostaticIPaddressifDHCPisn’tavailable:SelectifyouwanttoaddastaticIPaddresstouseasfallbackifDHCP
isunavailableandcan’tassignanIPaddressautomatically.
IPv6
AssignIPv6automaticall:SelecttoturnonIPv6andtoletthenetworkrouterassignanIPaddresstothedeviceautomatically.
Hostname
Assignhostnameautomaticall:Selecttoletthenetworkrouterassignahostnametothedeviceautomatically.
Hostname:Enterthehostnamemanuallytouseasanalternativewayofaccessingthedevice.Theserverreportandsystemlog
usethehostname.AllowedcharactersareA–Z,a–z,0–9and-.
DNSservers
AssignDNSautomaticall:SelecttolettheDHCPserverassignsearchdomainsandDNSserveraddressestothedevice
automatically.WerecommendautomaticDNS(DHCP)formostnetworks.
Searchdomains:Whenyouuseahostnamethatisnotfullyqualied,clickAddsearchdomainandenteradomaininwhichto
searchforthehostnamethedeviceuses.
DNSservers:ClickAddDNSserverandentertheIPaddressoftheDNSserver.ThisprovidesthetranslationofhostnamestoIP
addressesonyournetwork.
HTTPandHTTPS
HTTPSisaprotocolthatprovidesencryptionforpagerequestsfromusersandforthepagesreturnedbythewebserver.Theencrypted
exchangeofinformationisgovernedbytheuseofanHTTPScerticate,whichguaranteestheauthenticityoftheserver.
TouseHTTPSonthedevice,youmustinstallanHTTPScerticate.GotoSstem>Securittocreateandinstallcerticates.
Allowaccessthrough:SelectifauserisallowedtoconnecttothedevicethroughtheHTTP,HTTPS,orbothHTTPandHTTPS
protocols.
Note
IfyouviewencryptedwebpagesthroughHTTPS,youmightexperienceadropinperformance,especiallywhenyou
requestapageforthersttime.
HTTPport:EntertheHTTPporttouse.Thedeviceallowsport80oranyportintherange1024-65535.Ifyouareloggedinasan
administrator,youcanalsoenteranyportintherange1-1023.Ifyouuseaportinthisrange,yougetawarning.
HTTPSport:EntertheHTTPSporttouse.Thedeviceallowsport443oranyportintherange1024-65535.Ifyouareloggedinas
anadministrator,youcanalsoenteranyportintherange1-1023.Ifyouuseaportinthisrange,yougetawarning.
Certicate:SelectacerticatetoenableHTTPSforthedevice.
14

AXISA1214NetworkDoorControllerKit
Thewebinterfae
Networkdiscoverprotocols
Bonjour®:Turnontoallowautomaticdiscoveryonthenetwork.
Bonjourname:Enterafriendlynametobevisibleonthenetwork.ThedefaultnameisthedevicenameandMACaddress.
UPnP®:Turnontoallowautomaticdiscoveryonthenetwork.
UPnPname:Enterafriendlynametobevisibleonthenetwork.ThedefaultnameisthedevicenameandMACaddress.
WS-Discover:Turnontoallowautomaticdiscoveryonthenetwork.
One-clickcloudconnection
One-clickcloudconnection(O3C)togetherwithanO3Cserviceprovideseasyandsecureinternetaccesstoliveandrecordedvideo
fromanylocation.Formoreinformation,seeaxis.com/endtoendsolutions/hostedservices.
AllowO3C:
•One-click:Thisisthedefaultsetting.PressandholdthecontrolbuttononthedevicetoconnecttoanO3Cservice
overtheinternet.YouneedtoregisterthedevicewiththeO3Cservicewithin24hoursafteryoupressthecontrol
button.Otherwise,thedevicedisconnectsfromtheO3Cservice.Onceyouregisterthedevice,Alwasisenabledand
thedevicestaysconnectedtotheO3Cservice.
•Alwas:ThedeviceconstantlyattemptstoconnecttoanO3Cserviceovertheinternet.Onceyouregisterthedevice,
itstaysconnectedtotheO3Cservice.Usethisoptionifthecontrolbuttononthedeviceisoutofreach.
•No:DisablestheO3Cservice.
Proxsettings:Ifneeded,entertheproxysettingstoconnecttotheproxyserver.
Host:Entertheproxyserver’saddress.
Port:Entertheportnumberusedforaccess.
LoginandPassword:Ifneeded,enterusernameandpasswordfortheproxyserver.
Authenticationmethod:
•Basic:ThismethodisthemostcompatibleauthenticationschemeforHTTP.It’slesssecurethantheDigestmethod
becauseitsendstheusernameandpasswordunencryptedtotheserver.
•Digest:Thismethodismoresecurebecauseitalwaystransfersthepasswordencryptedacrossthenetwork.
•Auto:Thisoptionletsthedeviceselecttheauthenticationmethoddependingonthesupportedmethods.Itprioritizes
theDigestmethodovertheBasicmethod.
Ownerauthenticationke(OAK):ClickGetketofetchtheownerauthenticationkey.Thisisonlypossibleifthedeviceis
connectedtotheinternetwithoutarewallorproxy.
SNMP
TheSimpleNetworkManagementProtocol(SNMP)allowsremotemanagementofnetworkdevices.
SNMP:SelecttheversionofSNMPtouse.
•v1andv2c:
-Readcommunit:Enterthecommunitynamethathasread-onlyaccesstoallsupportedSNMPobjects.The
defaultvalueispublic.
-Writecommunit:EnterthecommunitynamethathasreadorwriteaccesstoallsupportedSNMPobjects
(exceptread-onlyobjects).Thedefaultvalueiswrite.
-Activatetraps:Turnontoactivatetrapreporting.Thedeviceusestrapstosendmessagesforimportant
eventsorstatuschangestoamanagementsystem.Inthewebinterface,youcansetuptrapsforSNMPv1
andv2c.TrapsareautomaticallyturnedoffifyouchangetoSNMPv3orturnoffSNMP.IfyouuseSNMPv3,
youcansetuptrapsthroughtheSNMPv3managementapplication.
-Trapaddress:EntertheIPaddressorhostnameofthemanagementserver.
-Trapcommunit:Enterthecommunitytousewhenthedevicesendsatrapmessagetothemanagement
system.
15

AXISA1214NetworkDoorControllerKit
Thewebinterfae
-Traps:
-Coldstart:Sendsatrapmessagewhenthedevicestarts.
-Warmstart:SendsatrapmessagewhenyouchangeanSNMPsetting.
-Linkup:Sendsatrapmessagewhenalinkchangesfromdowntoup.
-Authenticationfailed:Sendsatrapmessagewhenanauthenticationattemptfails.
Note
AllAxisideoMIBtrapsareenabledwhenyouturnonSNMPv1andv2ctraps.Formoreinformation,see
AXISOSPortal>SNMP.
•v3:SNMPv3isamoresecureversion,whichprovidesencryptionandsecurepasswords.TouseSNMPv3,we
recommendyoutoactivateHTTPS,asthepasswordisthensentthroughHTTPS.Thisalsopreventsunauthorized
parties’accesstounencryptedSNMPv1andv2ctraps.IfyouuseSNMPv3,youcansetuptrapsthroughtheSNMPv3
managementapplication.
-Passwordfortheaccount“initial”:EntertheSNMPpasswordfortheaccountnamed“initial”.Althoughthe
passwordcanbesentwithoutactivatingHTTPS,wedon’trecommendit.TheSNMPv3passwordcanonly
besetonce,andpreferablyonlywhenHTTPSisenabled.Oncethepasswordisset,thepasswordeldisno
longerdisplayed.Tosetthepasswordagain,youmustresetthedevicetofactorydefaultsettings.
Connectedclients
Showsthenumberofconnectionsandconnectedclients.
Viewdetails:iewandupdatethelistoftheconnectedclients.ThelistshowsIPaddress,protocol,port,andPID/Process
ofeachclient.
Secrity
Certicates
Certicatesareusedtoauthenticatedevicesonanetwork.Thedevicesupportstwotypesofcerticates:
•Client/servercerticates
Aclient/servercerticatevalidatesthedevice’sidentity,andcanbeself-signedorissuedbyaCerticateAuthority(CA).
Aself-signedcerticateofferslimitedprotectionandcanbeusedbeforeaCA-issuedcerticatehasbeenobtained.
•CAcerticates
YoucanuseaCAcerticatetoauthenticateapeercerticate,forexampletovalidatetheidentityofanauthentication
serverwhenthedeviceconnectstoanetworkprotectedbyIEEE802.1X.Thedevicehasseveralpre-installedCA
certicates.
Theseformatsaresupported:
•Certicateformats:.PEM,.CER,and.PFX
•Privatekeyformats:PKCS#1andPKCS#12
Important
Ifyouresetthedevicetofactorydefault,allcerticatesaredeleted.Anypre-installedCAcerticatesarereinstalled.
Filterthecerticatesinthelist.
Addcerticate:Clicktoaddacerticate.
Thecontextmenucontains:
•Certicateinformation:iewaninstalledcerticate’sproperties.
•Deletecerticate:Deletethecerticate.
•Createcerticatesigningrequest:Createacerticatesigningrequesttosendtoaregistrationauthoritytoapply
foradigitalidentitycerticate.
16

AXISA1214NetworkDoorControllerKit
Thewebinterfae
Securekestore:
•Secureelement(CCEAL6+):Selecttousesecureelementforsecurekeystore.
•TrustedPlatformModule2.0(CCEAL4+,FIPS140-2Level2):SelecttouseTPM2.0forsecurekeystore.
IEEE802.1x
IEEE802.1xisanIEEEstandardforport-basednetworkadmissioncontrolprovidingsecureauthenticationofwiredandwireless
networkdevices.IEEE802.1xisbasedonEAP(ExtensibleAuthenticationProtocol).
ToaccessanetworkprotectedbyIEEE802.1x,networkdevicesmustauthenticatethemselves.Theauthenticationisperformedby
anauthenticationserver,typicallyaRADIUSserver(forexample,FreeRADIUSandMicrosoftInternetAuthenticationServer).
Certicates
WhenconguredwithoutaCAcerticate,servercerticatevalidationisdisabledandthedevicetriestoauthenticateitself
regardlessofwhatnetworkitisconnectedto.
Whenusingacerticate,inAxis'implementation,thedeviceandtheauthenticationserverauthenticatethemselveswithdigital
certicatesusingEAP-TLS(ExtensibleAuthenticationProtocol-TransportLayerSecurity).
Toallowthedevicetoaccessanetworkprotectedthroughcerticates,youmustinstallasignedclientcerticateonthedevice.
Clientcerticate:SelectaclientcerticatetouseIEEE802.1x.Theauthenticationserverusesthecerticatetovalidatethe
client’sidentity.
CAcerticate:SelectCAcerticatestovalidatetheauthenticationserver’sidentity.Whennocerticateisselected,thedevice
triestoauthenticateitselfregardlessofwhatnetworkitisconnectedto.
EAPidentit:Entertheuseridentityassociatedwiththeclientcerticate.
EAPOLversion:SelecttheEAPOLversionthatisusedinthenetworkswitch.
UseIEEE802.1x:SelecttousetheIEEE802.1xprotocol.
Preventbrute-forceattacks
Blocking:Turnontoblockbrute-forceattacks.Abrute-forceattackusestrial-and-errortoguesslogininfoorencryptionkeys.
Blockingperiod:Enterthenumberofsecondstoblockabrute-forceattack.
Blockingconditions:Enterthenumberofauthenticationfailuresallowedpersecondbeforetheblockstarts.Youcansetthe
numberoffailuresallowedbothonpagelevelanddevicelevel.
IPaddresslter
Uselter:SelecttolterwhichIPaddressesareallowedtoaccessthedevice.
Polic:ChoosewhethertoAlloworDenaccessforcertainIPaddresses.
Addresses:EntertheIPnumbersthatareeitherallowedordeniedaccesstothedevice.YoucanalsousetheCIDRformat.
Custom-signedrmwarecerticate
ToinstalltestrmwareorothercustomrmwarefromAxisonthedevice,youneedacustom-signedrmwarecerticate.The
certicateveriesthatthermwareisapprovedbyboththedeviceownerandAxis.Thermwarecanonlyrunonaspecic
devicewhichisidentiedbyitsuniqueserialnumberandchipID.OnlyAxiscancreatecustom-signedrmwarecerticates,
sinceAxisholdsthekeytosignthem.
Install:Clicktoinstallthecerticate.Youneedtoinstallthecerticatebeforeyouinstallthermware.
17

AXISA1214NetworkDoorControllerKit
Thewebinterfae
Acconts
Accounts
Addaccount:Clicktoaddanewaccount.Youcanaddupto100accounts.
Account:Enterauniqueaccountname.
Newpassword:Enterapasswordfortheaccount.Passwordsmustbe1to64characterslong.OnlyASCIIprintablecharacters
(code32to126)areallowedinthepassword,forexample,letters,numbers,punctuation,andsomesymbols.
Repeatpassword:Enterthesamepasswordagain.
Privileges:
•Administrator:Hasfullaccesstoallsettings.Administratorscanalsoadd,update,andremoveotheraccounts.
•Operator:Hasaccesstoallsettingsexcept:
-AllSstemsettings.
-Addingapps.
•Viewer:Doesn’thaveaccesstochangeanysettings.
Thecontextmenucontains:
Updateaccount:Edittheaccountproperties.
Deleteaccount:Deletetheaccount.Youcan’tdeletetherootaccount.
MQTT
MQTT(MessageQueuingTelemetryTransport)isastandardmessagingprotocolfortheInternetofThings(IoT).Itwasdesignedfor
simpliedIoTintegrationandisusedinawidevarietyofindustriestoconnectremotedeviceswithasmallcodefootprintand
minimalnetworkbandwidth.TheMQTTclientinAxisdevicermwarecansimplifyintegrationofdataandeventsproducedinthe
devicetosystemswhicharenotvideomanagementsoftware(MS).
SetupthedeviceasanMQTTclient.MQTTcommunicationisbasedontwoentities,theclientsandthebroker.Theclientscan
sendandreceivemessages.Thebrokerisresponsibleforroutingmessagesbetweenclients.
YoucanlearnmoreaboutMQTTinAXISOSPortal.
ALPN
ALPNisaTLS/SSLextensionthatallowsfortheselectionofanapplicationprotocolduringthehandshakephaseoftheconnection
betweentheclientandserver.ThisisusedtoenableMQTTtrafcoverthesameportthatisusedforotherprotocols,suchasHTTP.
Insomecases,theremightnotbeadedicatedportopenforMQTTcommunication.AsolutioninsuchcasesistouseALPNto
negotiatetheuseofMQTTastheapplicationprotocolonastandardport,allowedbytherewalls.
MQTTclient
18

AXISA1214NetworkDoorControllerKit
Thewebinterfae
Connect:TurnonorofftheMQTTclient.
Status:ShowsthecurrentstatusoftheMQTTclient.
Broker
Host:EnterthehostnameorIPaddressoftheMQTTserver.
Protocol:Selectwhichprotocoltouse.
Port:Entertheportnumber.
•1883isthedefaultvalueforMQTToverTCP
•8883isthedefaultvalueforMQTToverSSL
•80isthedefaultvalueforMQTToverWebSocket
•443isthedefaultvalueforMQTToverWebSocketSecure
ALPNprotocol:EntertheALPNprotocolnameprovidedbyyourMQTTbrokerprovider.ThisisonlyapplicablewithMQTToverSSL
andMQTToverWebSocketSecure.
Username:Entertheusernamethattheclientwillusetoaccesstheserver.
Password:Enterapasswordfortheusername.
ClientID:EnteraclientID.Theclientidentierissenttotheserverwhentheclientconnectstoit.
Cleansession:Controlsthebehavioratconnectionanddisconnectiontime.Whenselected,thestateinformationisdiscarded
atconnectanddisconnect.
Keepaliveinterval:Enablestheclienttodetectwhentheserverisnolongeravailablewithouthavingtowaitforthelong
TCP/IPtimeout.
Timeout:Thetimeintervalinsecondstoallowaconnecttocomplete.Defaultvalue:60
Devicetopicprex:UsedinthedefaultvaluesforthetopicintheconnectmessageandLWTmessageontheMQTTclienttab,
andinthepublicationconditionsontheMQTTpublicationtab.
Reconnectautomaticall:Specieswhethertheclientshouldreconnectautomaticallyafteradisconnect.
Connectmessage
Speciesifamessageshouldbesentoutwhenaconnectionisestablished.
Sendmessage:Turnontosendmessages.
Usedefault:Turnofftoenteryourowndefaultmessage.
Topic:Enterthetopicforthedefaultmessage.
Paload:Enterthecontentforthedefaultmessage.
Retain:SelecttokeepthestateofclientonthisTopic
QoS:ChangetheQoSlayerforthepacketow.
LastWillandTestamentmessage
TheLastWillTestament(LWT)letsaclientprovideatestamentalongwithitscredentialswhenconnectingtothebroker.Ifthe
clientdisconnectsungracefullyatsomepointlater(maybebecausehispowersourcedied),itcanletthebrokerdeliveramessage
tootherclients.ThisLWTmessagehasthesameformasanordinarymessageandgetsroutedviathesamemechanics.
Sendmessage:Turnontosendmessages.
Usedefault:Turnofftoenteryourowndefaultmessage.
Topic:Enterthetopicforthedefaultmessage.
19

AXISA1214NetworkDoorControllerKit
Thewebinterfae
Paload:Enterthecontentforthedefaultmessage.
Retain:SelecttokeepthestateofclientonthisTopic
QoS:ChangetheQoSlayerforthepacketow.
MQTTpublication
Usedefaulttopicprex:Selecttousethedefaulttopicprex,thatisdenedinthedevicetopicprexintheMQTTclienttab.
Includetopicname:SelecttoincludethetopicthatdescribestheconditionintheMQTTtopic.
Includetopicnamespaces:SelecttoincludeONIFtopicnamespacesintheMQTTtopic.
Includeserialnumber:Selecttoincludethedevice’sserialnumberintheMQTTpayload.
Addcondition:Clicktoaddacondition.
Retain:DeneswhichMQTTmessagesaresentasretained.
•None:Sendallmessagesasnon-retained.
•Propert:Sendonlystatefulmessagesasretained.
•All:Sendbothstatefulandstatelessmessagesasretained.
QoS:SelectthedesiredlevelfortheMQTTpublication.
MQTTsubscriptions
Addsubscription:ClicktoaddanewMQTTsubscription.
Subscriptionlter:EntertheMQTTtopicthatyouwanttosubscribeto.
Usedevicetopicprex:AddthesubscriptionlterasprextotheMQTTtopic.
Subscriptiontpe:
•Stateless:SelecttoconvertMQTTmessagesintoastatelessmessage.
•Stateful:SelecttoconvertMQTTmessagesintoacondition.Thepayloadisusedasthestate.
QoS:SelectthedesiredlevelfortheMQTTsubscription.
Accessories
I/Oports
Usedigitalinputtoconnectexternaldevicesthatcantogglebetweenanopenandclosedcircuit,forexample,PIRsensors,door
orwindowcontacts,andglassbreakdetectors.
UsedigitaloutputtoconnectexternaldevicessuchasrelaysandLEDs.YoucanactivateconnecteddevicesthroughtheAPIX®
ApplicationProgrammingInterfaceorthewebinterface.
20