Product Info

NTXEmbeddedWM18xAPI
16
Workflows:
Connection
WhenyourdevicefirstestablishestheserialconnectiontotheWM18x,youshouldwaitforthe
NTX_RESTARTmessagebeforesendinganythingtothemodule.NTX_RESTARTindicatesthatthe
moduleiscommunicatingwithyourdeviceproperly.
Next,waitfortheNTX_STATUSmessage.Thismessagewillindicateifthemoduleiscommunicatingwith
theAPandwithLet’sCook.
Ifyourdevicetakeslongertocomeupandstartcommunicatingseriallyandthismessageismissed,itis
suggestedthatyoumakecallstoNTX_ONLINE
FromtheresultsoftheNTX_STATUSorNTX_ONLINEmessage,youshouldbeabletodecidewhattodo
next.
SincetheWM18xconnectstothelastknownaccesspointautomatically,aftertheinitialconnectionis
establishedthereisverylittleforthedevicetodoonstartupaftertheinitialconnectionisestablished.
Inmostsystems,thereisaUItosettheSSIDandpassword.Initiallyyoushould
callNTX_CONFIGsoyou
canshowtheMACaddressintheUI.ThisisimportantbecausetheMACaddressisusedtouniquely
identifythemoduletotheNetworkcloud.Yourdevice’sserialnumbermaychangebuttheMACwillnot
changesoitcanalwaysbeusedtofind
thedeviceifyouareunsureoftheserialnumber.
Whenadeviceconnectsforthefirsttime,weatherafterapowercycleorwhenthemodulestatus
transitionsfromofflinetoonline,itisrecommendedthatthedevice,getthecurrenttimeanddateand
thensendthecurrentstatus
(NTX_LC_STATUS)andmetadata(NTX_LC_META_DEVICE).Thismakessure
CustomerConnecthaseverythingitneedstoshowthecurrentstatusofthedevice.
Afterconnectiontotheaccesspointissuccessful,themoduleisreadytoconnecttotheNetwork
system.Tostartthisprocessitneedstheserialnumberof
thedevice.Use
NTX_SET_DEVICESERIAL,{serialnumber}tosetit.
FirstTimeConnectionCheckList:
WaitforNTX_RESTARTandorNTX_ONLINE
IfNTX_ONLINEvalueis0,SendNTX_AP,{SSID},{password}
WaitforNTX_ONLINE,1
SendNTX_SET_OVENSERIAL,{ovenserial}
WaitforNTX_ONLINE,2
LogintoNetworkandselectthenewdeviceinthependinglistandeitherconfirmitorputitina
group.Untilthisisdone,thedevicewillnotreportNTX_ONLINE,2.Assoonasthedeviceis
confirmedonline, themodulewillgetamessageandinformthedeviceit
isreadytoreceivedata.
OnceNTX_ONLINE,2isreceived