Product Info

ManualsBrandsNTX Embedded ManualsElectronicsWi-Fi Module

NTXEmbeddedWM18xAPI



ThankyouforpurchasinganNTXEmbeddedWi‐FimoduleforCustomerConnectNetworkCloud.This

APIguidewillhelpyouunderstandhow ourmoduleworksandwhatyoucandowithit.



AbouttheWM18x

ThereareseveralmodelsoftheWM18xfromNTXEmbedded.APIcallsbelowworkonallWM18x

modelsunlessotherwisenoted.

ThefirmwareonyourWM18xis custommadeforyou.ThisdocumentisthegeneralAPIdocumentation

fortheWM18x.Yourfirmwaremayhavespecialrestrictionsoradditionalcalls.These

differenceswillbe

providedtoyoubyNTXEmbeddedasaseparatedocument.

TheWM18Xhasitsownprocessorandisprogrammedforyourapplication.Itisdesignedtodoasmuch

oftheworkofcommunicatingtotheInternetorcloudservicesanddoingWi‐Fistuffasit

cansoyour

processorcandomoreimportantthings.ItisnotageneralpurposeWi‐Fimodule.AssuchtheAPI

allowsonlythemostbasicfeaturesneededtoestablishaconnection toanaccesspointandtosendand

receivethedata.Everythingelseishandledforyouby

theNTXEmbeddedWM18xmodule.Thisisdone

bothforsecurityreasonsandtominimizetheworkyoursystemhasto do.



CustomerConnectNetworkCloud

ThisversionoftheAPIisdesignedtoconnecttotheCustomerConnectNetworkcloudservicesasan

MQTTclient.ItimplementssomeoftheAPIasdescribedintheHounödocuments:



MQTTMessages(OvenEvents.docx),VersionP16A,Dated06‐26‐2018



OvenActivation,Version1.04,Dated02‐07‐2018



FirmwareUpdateandWIFIParameters,Version1.03,Dated06‐26‐2018

TheHounöhostedCustomerConnectNetworkcloudservicesallowyourdevicetosecurelyconnectto

anMQTTbrokerandsendperiodicandlivedatafromyourdevicetothecloudforstorageand/ordisplay.

ItalsohasamechanismtoinformthedevicethroughtheWM18xWi‐Fimodulethatfilesareavailablefor

downloadandtheWM18xcanretrievethosefilesandgivethemtothedevice.Allofthehardworkof

connectingandmaintainingtheconnectiontotheMQTTbrokeraswellaspacketizingthedataproperly

is

donebytheWM18xmodule.TheAPIcallsbelowinthe

NetworkAPIsectionofthisdocumentare

usedtosendandretrievedatafromthesecloudservices.



ConnectionMethods

TheWM18xcomesinseveralcommunicationconfigurationsincludingRS232,RS485,RS422.



ItisalsocapableofcommunicatingatvariousBaudrates.Inordertopreventaccidentalchangestothe

serialsettings,noAPIexistsatthistimetomodifytheserialsettingsonthefly.Yourcustomfirmware

fortheWM18xwillhavetheserialsettingsyouspecifythatwillcommunicateto

yourdevice.

Thedefaultserialsettingsare:

Baud:115200;DataBits:8;Parity:None;StopBits:1;FlowControl:None

Summary of content (22 pages)

PAGE 1
NTX Embedded WM 18x API Thank you for purchasing an NTX Embedded Wi‐Fi module for Customer Connect Network Cloud. This API guide will help you understand how our module works and what you can do with it. About the WM18x There are several models of the WM18x from NTX Embedded. API calls below work on all WM18x models unless otherwise noted. The firmware on your WM18x is custom made for you. This document is the general API documentation for the WM18x.
PAGE 2
NTX Embedded WM 18x API How to Read This Documentation Anywhere the term Module is used it is referring to the NTX Embedded WM18x Wi‐Fi module. Anywhere the term Device is used it is referring to your electronics that are communicating to the Module using a serial connection. Throughout the documentation actual values that are sent or received via serial communication between the module and the device will be BOLD. Example: NTX_CONFIG Anything that will be replaced by actual data will be indicated by {}.
PAGE 3
NTX Embedded WM 18x API AUTO CONNECT The WM18x tries to automatically connect to an access point. It uses the last good SSID and password it stored to try to connect. If the last good SSID and password fails, it will try to connect using the previous SSID and password it stored. The module always keeps 2 sets of SSID and password, a primary and a backup. If the module has never been connected to an access point, it will not try to auto connect.
PAGE 4
NTX Embedded WM 18x API NTX_SEND_CNT – This message prompts the device to send the counters using NTX_LC_SVC_CNT. This is initiated from the Network cloud portal by a user. This message is sent only once. If it is missed or disregarded, the user will have to make the request again before NTX_SEND_CNT is resent to the device. NTX_SEND_FCNT ‐ This message prompts the device to send the fault counts using NTX_LC_FSTAT. This is initiated from the Network cloud portal by a user. This message is sent only once.
PAGE 5
NTX Embedded WM 18x API NTX_AP,{SSID},{password} {SSID} – the name of the access point to connect to. (MAX 75 characters) {password} – the password for the SSID. (MAX 75 characters) Example: NTX_AP,MySSIDName,MyPass#ord Response: NTX_ONLINE,{online status} See NTX_ONLINE for possible values of {online status} Notes: 1. Every NTX_AP call will cause the WM18x to disconnect from the current SSID if it is connected and try to connect using the new SSID name and password. 2.
PAGE 6
NTX Embedded WM 18x API NetworkSerial is the unique serial number Network knows this module by. By default the serial number will be the HEX values of the MAC address of each module without any colons between segments. NTX_DISABLE This API call causes the module to disconnect from any API, stop attempting to connect and stop all transmission. No API call will work when disabled, until the module is Enabled. This mode also puts the module into low power mode.
PAGE 7
NTX Embedded WM 18x API NTX_LISTAP Example: NTX_LISTAP Response: NTX_LISTAP,{AP1,AP2,…,APn} {AP1,AP2,…,APx} is a comma delimited list of the SSID for all access points detected. Notes: 1. 2. 3. 4. 5. If no access points are found, NTX_LISTAP,NO_AP will be returned The strongest RSSI access point will be listed first. Duplicate access point names are not included. Only 10 detected access points will be listed at a time.
PAGE 8
NTX Embedded WM 18x API Sends a serial number of the device to the module. The serial number is required to initiate a connection to the Network service. See connection workflows. NTX_WIFI_VERSION Example: NTX_ WIFI _VERSION Response: NTX_ WIFI _VERSION,{version_number} This call is for informational purposes only. You may want to display the Wi‐Fi firmware version or use it for diagnostic purposes.
PAGE 9
NTX Embedded WM 18x API NetworkAPI These API calls are specifically designed to send or receive data to the Network cloud services. Since they are making a call out to the Internet the response may be asynchronous so many of them are designed with no immediate response from the module. If you see Response: NONE, the device should make the call and move on to the next call without waiting for a response. Always observe call timing minimums.
PAGE 10
NTX Embedded WM 18x API NTX_LC_ACTIVITY Example: NTX_LC_ACTIVITY,{date_time},{activity_id},{group}[,{data_1_name},{data_1_type},{data_1_value}, {data_2_name},{data_2_type},{data_2_value},…,{data_n_name},{data_n_type},{data_n_value}] Response: None {date_time} if this activity is live/realtime data send ‐1. If this is offline data, meaning stored, the {date_time} must be in the form of {yyyy}‐{mm}‐{dd}T{hh}:{mm}:{ss}Z %d‐%02d‐%02dT%02d:%02d:%02dZ And all dates and times must be in GMT/UTD.
PAGE 11
NTX Embedded WM 18x API NTX_FILE The WM18x module has the ability to receive files from Customer Connect. These files can be menu updates, images, firmware updates or just about anything. These files can be retrieved from Customer Connect when they are available or just when needed. The process of moving a file across a serial connection is slow so the Device and the Module will not be sending and receiving regular data information while this is happening.
PAGE 12
NTX Embedded WM 18x API 3. IMPORTANT: One entry for each fault id in the Matrix File must be represented in each call to NTX_LC_FSTAT even if the count is 0. In other words if you have 10 fault IDs, all 10 fault IDs and counts must be sent with every call of NTX_LC_FSTAT. Any fault IDs that are not sent will not be shown in the Network data page. 4. Faults can be sent no more than once an hour. We suggest sending them only once a day. 5.
PAGE 13
NTX Embedded WM 18x API {device_info_1_name} is a string – use the exact value in the Matrix File. {device_info_1_value} is a string. Max 35 characters. Response: None Address meta data is usually information like city, state, country, address, zip etc. Meta data will be defined in the events matrix.
PAGE 14
NTX Embedded WM 18x API {data_1_type} – string – the type of the data_x_value about to be sent {data_1_value} – the value The state of the device shows up on the front and back of the live card in Let’s Cook. It is sent only if the device is being actively monitored and is not stored in Let’s Cook. The device should always send it when the state changes to the module but it will only be sent to the cloud if the device is being monitored.
PAGE 15
NTX Embedded WM 18x API NTX_LC_SVC_CNT Example: NTX_LC_SVC_CNT,{counter_1_id},{counter_1_type},{counter_1_value}, … , ,{counter_n_id},{counter_n_ type},{counter_n_value} {counter_x_id} is the integer id of the counter as defined in the events matrix. { counter_x_type} can be: “count” or “hours” {counter_x_value} is an integer Response: None Counters are shown in the Service Counters tab of Let’s Cook. All counters must be sent every time.
PAGE 16
NTX Embedded WM 18x API Workflows: Connection When your device first establishes the serial connection to the WM18x, you should wait for the NTX_RESTART message before sending anything to the module. NTX_RESTART indicates that the module is communicating with your device properly. Next, wait for the NTX_STATUS message. This message will indicate if the module is communicating with the AP and with Let’s Cook.
PAGE 17
NTX Embedded WM 18x API  o Send and handle the response for NTX_DATE and NTX_TIME if needed o Send NTX_LC_META_DEVICE,{…} o Send NTX_LC_META_ADDRESS,{…} o Send NTX_LC_STATE,{…} Continue to monitor the serial connection and send data as needed Second Time Connection Check List     Wait for NTX_RESTART and or NTX_ONLINE If NTX_ONLINE value is 0, Send NTX_AP,{SSID},{password} Wait for NTX_ONLINE,1 or 2 If NTX_ONLINE,2 o Send NTX_SET_OVENSERIAL,{oven serial} o Send and handle the response for NTX_DATE
PAGE 18
NTX Embedded WM 18x API Mode 2: Listening. In several cases, the module may send information to the device based on input from the cloud like a request to refresh the statistics or a change in connectivity state. For each of these, the device needs to be listening and needs to handle them when they come in. Mode 3: File Transfer. In this case, there is no end of data terminator character, it is all based on the buffer size. The rest of the modes should be suspended while in this mode.
PAGE 19
NTX Embedded WM 18x API Power Supply Range 3.0V ~ 3.6V Operating Temperature ‐20 ℃ ~ 85 ℃ Storage Environment Weight ‐40 ℃ ~ 90 ℃ , < 90%RH 1.5g BOM Part Description CAP CER 0.01uF 16V X7R 0603 CAP TANT 100UF 20% 4V 1206 CAP CER 0.1UF 16V 10% X7R 0603 DNP ‐ CONN HEADER VERT 2POS .100 TIN FERRITE BEAD 30 OHM @100MHz 3A 0805 1LN RES 1.
PAGE 20
NTX Embedded WM 18x API PCB Layout Figure 1 ESP32‐S PCB Top Layer Figure 2 ESP32‐S PCB GND Layer 20
PAGE 21
NTX Embedded WM 18x API Figure 3 ESP32‐S PCB POWER Layer Figure 4 ESP32‐S PCB Bottom Layer Document Version: 12/5/2018 21
PAGE 22
NTX Embedded WM 18x API FCC Statements This device complies with part 15 of the FCC Rules. Operation is subject to the following two conditions: (1) This device may not cause harmful interference, and (2) this device must accept any interference received, including interference that may cause undesired operation. Changes or modifications not expressly approved by the party responsible for compliance could void the user's authority to operate the equipment.