Product Info
NTXEmbeddedWM18xAPI
2
HowtoReadThisDocumentation
AnywherethetermModuleisuseditisreferringtotheNTXEmbeddedWM18xWi‐Fimodule.
AnywherethetermDeviceisuseditisreferringtoyourelectronicsthatarecommunicatingtothe
Moduleusingaserialconnection.
Throughoutthedocumentationactualvaluesthat aresentorreceivedviaserial
communication
betweenthemoduleandthedevicewillbeBOLD.
Example:NTX_CONFIG
Anythingthatwillbereplacedbyactualdatawillbeindicatedby{}.
Example:NTX_AP,{SSID},{password}
Where{SSID}and{password}mustbereplacedbytheactualSSIDandpasswordtobevalid.Soifyour
SSIDisAbcdandthepasswordis1234thecommandwouldlooklike:
NTX_AP,Abcd,1234
AllcommandstotheWM18Xareformattedinthesameway:
{Command},{Data}
Notallcommandshavedata.Ifnodataissent,thecommaisnotneeded.
Somepartsofthe{Data}maybeoptional.Thesewillbeindicatedbysquarebrackets[].
AllcommandstotheWM18xshouldbeterminatedwithacarriagereturnorlinefeed.Eitheronewill
causetheWM18xtoacceptthecommandandtrytoparseit.
DEVICESTARTUP
WhentheWM18xpowersonyouwillseethefollowingmessage
NTX_RESTART,{version}
Example:
NTX_RESTART,XC20180921.01
Thefirmwareversionusuallya2or3letterprefixindicatingthecustombuildcustomerandthedatein
yyyymmddformatofthebuild.Ifasubbuildnumberorspecialbuildisrequireditwillbeindicatedby
thenumbersafterthedecimal.Notallversionswillhavea
subbuildnumberordecimal.
IftheWM18xcrashesitwillautomaticallyrestartandsendtheNTX_RESTART,{version}message.