MZCommands
Module Start
This command is used to initialize monoZ:Jet module and check SIM Status, Configure Band and OrgID, attach to cellular network and open connection with IoT platform using run time value. This command must be used after +MZREADY from monoZ:Jet module. Upon unsuccessful network/IoT connection in first attempt, monoZ:Jet shall send back a failure URC and attempt connection with network/platform 2 more times with unsuccessful URC after every attempt in case of failure. After +MZSTART:0, further +MZSTART URCs can be expected anytime in the event of network or IoT PF disconnect.
MZSTART
MZOK/MZFAIL
+MZSTART: <s_sts>
+DEBUG: <dbg_sts>
Defined Values
<s_sts>
Integer Type.
0
Start Success
1
SIM Not Inserted
2
Band Setting Fail
3
Network Connection Fail
4
IoT Platform Connection Fail
5
Modem Start Fail
<dbg_sts>
*Only when Debug mode is ON.
Integer Type.
Maximum Response Time
MZOK/MZFAIL | 1 second |
+MZSTART/+DEBUG | 3 minutes |
Usage
Without Debug Mode
+MZREADY
MZSTART
MZOK
+MZSTART: 0
With Debug Mode
MZSTART
MZOK
MZDEBUG=1
MZOK
+MZDEBUG: 10
+MZDEBUG: 14
+MZDEBUG: 10
+MZDEBUG: 2
+MZDEBUG: 0
+MZDEBUG: 2
+MZDEBUG: 5
+MZDEBUG: 15
+MZDEBUG: 20
+MZSTART: 0
Firmware Version
This command reads the current software version of monoZ:Jet.
MZVERSION
MZOK/MZFAIL
+MZVERSION: <version>
Defined Values
<version>
String Type.
Maximum Response Time
MZOK/MZFAIL | 1 second |
+MZVERSION | 1 second |
Usage
Without Debug Mode
MZVERSION
MZOK
+MZVERSION: MZJ2_V2.0.1
Data Send
This command is used to send data to IoT PF through monoZ:Jet.
MZSEND=<payload>
MZOK/MZFAIL
+MZSEND: <send_sts>
+DEBUG: <dbg_sts>
Defined Values
<payload>
String Type.
Max byte size
1024B
Accepted Characters
Alphanumeric, Kanji, “#$%&’()//<>.,?
There is a possibility certain kanji characters may not be accepted.
<send_sts>
Integer Type.
0
Send Success
1
Send Fail
2
Send Payload size exceeds
<dbg_sts>
*Only when Debug mode is ON.
Integer Type.
30
Data Send Success
31
Data Send Retransmit
32
Data Send Failed
Maximum Response Time
MZOK/MZFAIL | 1 second |
+MZSEND/+DEBUG | 5 seconds |
Usage
Without Debug Mode
MZSEND=Payload123
MZOK
+MZSEND: 0
With Debug Mode
MZSEND=Payload123
MZOK
+MZDEBUG: 30
+MZSEND: 0
DL Data Receive
This command enable monoZ:Jet to receive data from IoT Platform.
MZRECEIVE
MZOK/MZFAIL
+MZRECEIVE: <r_sts>
+MZRECEIVE: <r_sts>,<DL data>
+MZDEBUG: <dbg_sts>
Defined Values
<DL data>
String Type.
Max Byte size
1020B
Accepted Characters
Alphanumeric, Kanji, “#$%&’()//<>.,?
<receive_sts>
Integer Type.
0
Receive success
1
Receive failed
2
Receive payload
3
Receive payload size exceed limit
<dbg_sts>
*Only when Debug mode is ON.
Integer Type.
Maximum Response Time
MZOK/MZFAIL | 1 second |
+MZRECEIVE/+DEBUG | 5 seconds |
Usage
Without Debug Mode
MZRECEIVE
MZOK
+MZRECEIVE: 0
<when message sent from platform>
+MZRECEIVE: 2,"Test message"
With Debug Mode
MZRECEIVE
+MZDEBUG: 40
+MZRECEIVE: 0
<when message sent from platform>
+MZRECEIVE: 2,"Test message"
Sleep
This command is used to put the module to different Low Power Modes(LPM).
MZSLEEP=<Key_val>
MZOK/MZFAIL
+MZSLEEP: <sleep_sts>
+DEBUG: <dbg_sts>
Defined Values
<Key_val>
Integer Type.
0
Full sleep. Wake up triggered by raising HOST to BOARD_WKP(P407) Pin to HIGH. MCU will go to Full sleep mode after 5 sec of receiving +MZSLEEP: 0 URC and shall not take any MZ input via UART.
1
Network Disconnect (Module will be in ON state but Network will be disconnected).
2
Platform Disconnect (Module will be in ON state, Network will be in connected state, module will be disconnected from IoT PF).
<sleep_sts>
Integer Type.
0
Sleep Success
1
Sleep Fail
<dbg_sts>
*Only when Debug mode is ON.
Integer Type.
Maximum Response Time
MZOK/MZFAIL | 1 second |
+MZSLEEP/+DEBUG | 5 seconds |
Usage
Without Debug Mode
MZSLEEP=1
MZOK
+MZSLEEP:0
With Debug Mode
MZSLEEP=1
MZOK
+DEBUG: 50
+MZSLEEP: 0
Time
This command is used to capture and return the real time clock.
MZTIME
MZOK/MZFAIL
+MZTIME: <r_sts>,<yy/mm/dd,hh:mm:ss±zz>
+MZTIME: <r_sts>
Defined Values
<r_sts>
Integer Type.
0
Time Read Success
1
Time Read Failed
Maximum Response Time
MZOK/MZFAIL | 1 second |
+MZTIME | 1 second |
Usage
Without Debug Mode
MZTIME
+MZTIME: 0,2024/06/17,16:11:23+36
NW Status
This command is used to read current network status.
MZNWSTATUS Capture Network Status
Execution Command
Response
MZSTATUS
MZOK
+MZNWSTATUS:
<r_sts>,<sysmode>,<value1>,<value2>,<value3,<value4>
+MZNWSTATUS: <r_sts>
Mzximum Response Time
MZOK: 1 second
+MZNWSTATUS: 2 seconds
MZSTATUS
Defined Values
<r_sts>
Integer Type.
<sysmode>
String Type.
"NOSERVICE"
No Service Mode
"GSM"
GSM/GPRS/EDGE mode
"eMTC"
eMTC mode
"NBIoT"
NB-IoT mode
The following table lists the signal strength type corresponding to each service mode.
<sysmode> | <value1> | <value2> | <value3> | <value4> |
NO SERVICE | - | - | - | - |
GSM | <GSM_RSSI> | - | - | - |
eMTC | <LTE_RSSI> | <LTE_RSRP> | <LTE_SINR> | <LTE_RSRQ> |
NBIoT | <LTE_RSSI> | <LTE_RSRP> | <LTE_SINR> | <LTE_RSRQ> |
<GSM_RSSI>
Integer Type.
Received signal strength indicator (dBm)
<LTE_RSSI>
Integer Type.
Received signal strength indicator (dBm)
<LTE_RSRP>
Integer Type.
Received signal strength indicator (dBm)
<LTE_SINR>
Integer Type.
Signal-to-interference-plus-noise-ratio (SINR). Logarithmic value of SINR. Values are in 1/5th of a dB. Range: 0–250, which translates to -20 dB to +30 dB
<LTE_RSRQ>
Integer Type.
Reference signal received quality (dBm)
Maximum Response Time
MZOK/MZFAIL | 1 second |
+MZNWSTATUS | 1 second |
Usage
Without Debug Mode
MZNWSTATUS
+MZNWSTATUS: 0,"eMTC",-66,-88,140,-8
Debug
This command is used to enter and exit Debugging mode. If entered once it shall put monoZ:Jet in debug mode until exited.
MZDEBUG=<key_val>
MZOK/MZFAIL
MZOK
Defined Values
<key_val>
Integer Type.
0
Enter Debugging Mode
1
Exit Debugging Mode
Maximum Response Time
MZOK/MZFAIL | 1 second |
OK/ | 1 second |
Usage
Without Debug Mode
MZDEBUG=1
MZOK
Set Org ID
This command is used to configure ORGID setting for connecting with monoZ:Link IoT PF. ORG ID can be set only before MZSTART.
MZORGID="<org_id>"
MZOK/MZFAIL
+MZORGID: <cfg_sts>
Defined Values
<org_id>
String Type.
Maximum Size:
12B
Acceptable characters
Alphanumeric, “#$%&’()//<>.,?
<cfg_sts>
Integer Type.
0
ORGID Configuration Success
1
ORGID Configuration Fail
2
ORGID Syntax Invalid
3
ORGID Length Exceeds
Maximum Response Time
MZOK/MZFAIL | 1 second |
+MZORGID | 5 second |
Usage
Without Debug Mode
MZORGID="MTI-1"
+MZORGID: 0
Set Band
This command is used for configure BAND setting to connect with network. By default, all supported bands are enabled in ascending order of priority.
MZBAND="<GSM_bandval>","<eMTC_bandval>","<NB_IoT_bandval>"
MZOK/MZFAIL
+MZBAND: <cfg_sts>
Defined Values
<GSM_bandval>
A hexadecimal value that specifies the GSM frequency band (e.g.: 0xa =0x2(DCS1800) + 0x8(PCS1900)). If it is set to 0, it means not to change GSM frequency band.
0
No Change
0x1
EGSM900
0x2
DCS1800
0x4
GSM850
0x8
PCS1900
0xf
All of the supported bands above
<eMTC_bandval>
A hexadecimal value that specifies the eMTC frequency band (e.g.: 0x15 =0x01(LTE B1) + 0x04(LTE B3) + 0x10(LTE B5)). If it is set to 0, the eMTC frequency band will not be changed.
0
No Change
0x0
All supported bands
0x1 (BAND_PREF_LTE_BAND1)
LTE B1
0x2 (BAND_PREF_LTE_BAND2)
LTE B2
0x4 (BAND_PREF_LTE_BAND3)
LTE B3
0x8 (BAND_PREF_LTE_BAND4)
LTE B4
0x10 (BAND_PREF_LTE_BAND5)
LTE B5
0x80 (BAND_PREF_LTE_BAND8)
LTE B8
0x800 (BAND_PREF_LTE_BAND12)
LTE B12
0x1000 (BAND_PREF_LTE_BAND13)
LTE B13
0x20000 (BAND_PREF_LTE_BAND18)
LTE B18
0x40000 (BAND_PREF_LTE_BAND19)
LTE B19
0x80000 (BAND_PREF_LTE_BAND20)
LTE B20
0x1000000 (BAND_PREF_LTE_BAND25)
LTE B25
0x2000000 (BAND_PREF_LTE_BAND26)
LTE B26
0x4000000 (BAND_PREF_LTE_BAND27)
LTE B27
0x8000000 (BAND_PREF_LTE_BAND28)
LTE B28
0x20000000000000000 (BAND_PREF_LTE_BAND66)
LTE B66
<NB-IoT_bandval>
A hexadecimal value that specifies the NB-IoT frequency band (e.g.: 0x15 =0x01(LTE B1) + 0x04(LTE B3) + 0x10(LTE B5)). If it is set to 0, the NB-IoT frequency band will not be changed. By default, all bands are set.
0
No Change
0x0
All supported bands
0x1 (BAND_PREF_LTE_BAND1)
LTE B1
0x2 (BAND_PREF_LTE_BAND2)
LTE B2
0x4 (BAND_PREF_LTE_BAND3)
LTE B3
0x8 (BAND_PREF_LTE_BAND4)
LTE B4
0x10 (BAND_PREF_LTE_BAND5)
LTE B5
0x80 (BAND_PREF_LTE_BAND8)
LTE B8
0x800 (BAND_PREF_LTE_BAND12)
LTE B12
0x1000 (BAND_PREF_LTE_BAND13)
LTE B13
0x20000 (BAND_PREF_LTE_BAND18)
LTE B18
0x40000 (BAND_PREF_LTE_BAND19)
LTE B19
0x80000 (BAND_PREF_LTE_BAND20)
LTE B20
0x1000000 (BAND_PREF_LTE_BAND25)
LTE B25
0x8000000 (BAND_PREF_LTE_BAND28)
LTE B28
0x20000000000000000 (BAND_PREF_LTE_BAND66)
LTE B66
<cfg_sts>
Integer Type.
0
Band Configuration Success
1
Invalid GSM Band value
2
GSM Band value Length Exceeds
3
Invalid eMTC Band value
4
eMTC Band value Length Exceeds
5
Invalid NB-IoT Band value
6
NB-IoT Band value Length Exceeds
Maximum Response Time
MZOK/MZFAIL | 1 second |
+MZBAND | 5 second |
Usage
Without Debug Mode
MZBAND=”0x0”,”0x2089b”,”0x80a”
+MZBAND: 0
Special URC
monoZ:Jet has 2 special URCs namely MZFAIL and MZERROR as described below.
MZFAIL SPECIAL MZFAIL | |
Response URC MZFAIL |
|
Response URC MZFAIL |
|