MZCommands

Module Ready URC

This URC is sent by monoZ:Jet to the host upon successful power-on. monoZ:Jet does not accept command inputs until this URC is sent back to host. If the host does not receive this URC, a hardware reset or power reboot of monoZ:Jet is recommended.

URC

+MZREADY

Maximum Response Time

+MZREADY

1 second

Note:

1. If host and monoZ:Jet is powered ON at the same time, then there is a possibility the host may miss the +MZREADY message.

Module Start

This command initializes the monoZ:Jet module and establish communication with the cellular network and the IoT platform using the configured BAND & ORG ID parameters. If the SIM is not detected(+MZSTART: 1), the Band setting is incorrect(+MZSTART: 2), or the modem fails to start(+MZSTART: 5), the respective error URCs(+MZSTART: 1/2/5) is immediately generated and monoZ:Jet shall not make any retry attempt. In the event of a failed network connection (+MZSTART: 3) or failed IoT platform connection (+MZSTART: 4), monoZ:Jet will return its respective failure URCs (+MZSTART: 3/4) and retry every few minutes (2min followed by 3min followed by every 5min) indefinitely until a successful connection (+MZSTART: 0) is established. The host can force an exit from this loop through a hardware reset, full sleep, or a power shutdown. Even after successful execution (+MZSTART: 0), host can +MZSTART URCs in the event of any error or failures.

Execution command

MZSTART 

Response

MZOK/MZFAIL
+MZSTART: <s_sts> 
+MZDEBUG: <dbg_sts> 

Defined Values

<s_sts>

Integer Type.

0

Start Success

1

SIM not inserted. Check SIM.

2

Band setting fail. Check band setting.

3

Network connection failed.
Reattempting netwok connection.

4

IoT Platform connection failed.
Reattemping platform connection.

5

Modem start fail. Perform hardware reset.

<dbg_sts>
*Only when Debug mode is ON.

Integer Type.

0

Not registered, monoZ:Jet is not currently searching a new operator to register

1

Registered, home network

2

Not registered, but monoZ:Jet is currently searching a new operator to register

3

Registration denied

4

Unknown (e.g. out of GERAN/UTRAN/E UTRAN coverage)

5

Registered, roaming

10

Modem Power ON success

11

Modem Power ON failed

12

Modem Power OFF success

13

Modem Power OFF failed

14

Modem Band setting success

15

Network connect success

16

Network disconnect success

17

Network disconnect failed

20

IoT platform open success

21

IoT platform open failed

Maximum Response Time

MZOK/MZFAIL	2 seconds
+MZSTART/+MZDEBUG	3 minutes

Usage

Without Debug Mode

Note: Response varies based on network situation.

+MZREADY
MZSTART
MZOK
+MZSTART: 3
+MZSTART: 0

With Debug Mode

Note: Response varies based on network situation.

MZSTART
MZOK
MZDEBUG=1
MZOK
+MZDEBUG: 10
+MZDEBUG: 2
+MZDEBUG: 0
+MZDEBUG: 2
+MZDEBUG: 2
+MZDEBUG: 2
+MZDEBUG: 5
+MZDEBUG: 15
+MZDEBUG: 20
+MZSTART: 0

Note:

1. Reception of FOTA data from IoT Platform data to monoZ:Jet will be enabled upon +MZSTART:0
2. MZBAND & MZORGID setting can be set only before executing MZSTART command

Firmware Version

This command reads the current firmware version of monoZ:Jet.

Execution command

MZVERSION 

Response

MZOK/MZFAIL
+MZVERSION: <version> 

Defined Values

<version>

String Type.

Maximum Response Time

MZOK/MZFAIL	2 seconds
+MZVERSION	2 seconds

Usage

MZVERSION
MZOK
+MZVERSION: MZJ2_V2.0.1

Data Send

This command transmits payload data to the IoT platform. If an internal timeout occurs, monoZ:Jet automatically retries up to three times at the protocol level before returning a data send failure URC to the host. Following a failure, the module disconnects and reconnects to the network and IoT platform to resolve any potential network or platform related issues.

Execution command

MZSEND=<payload> 

Response

MZOK/MZFAIL
+MZSEND: <send_sts> 
+MZDEBUG: <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

Data Send Success

1

Data Send Failed

2

Payload Size Exceeds limit

<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	2 seconds
+MZSEND/+MZDEBUG	20 seconds

Usage

Without Debug Mode

Normal case

MZSEND=Payload123
MZOK
+MZSEND: 0

Network/Platform Disruption while MZSEND: case 1

MZSEND=Payload123
MZOK  
+MZSEND: 1
+MZSTART: 3 or 4
+MZSTART: 0

Network/Platform Disruption while MZSEND: case 2

MZSEND=Payload123
MZOK
+MZSTART: 3 or 4
+MZSTART: 3 or 4
+MZSTART: 0
+MZSEND: 0

With Debug Mode

MZSEND=Payload123
MZOK
+MZDEBUG: 30
+MZSEND: 0

Downlink Data

This command enables monoZ:Jet to open downlink session with IoT platfom. Once enabled, the session remains active until a power-off, hardware reset, or full sleep occurs. In the event of a network disconnection and reconnection, the module automatically re-enables itself without requiring host intervention.

Execution command

MZRECEIVE 

Response

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, “#$%&’()/<>.,?;+-!@
There is a possibility certain kanji characters may not be accepted.

<receive_sts>

Integer Type.

0

Downlink enable success

1

Downlink enable failed

2

Downlink data received

3

Downlink data error - payload size exceed limit

<dbg_sts>
*Only when Debug mode is ON.

Integer Type.

40

IoT Platform subscription success

41

IoT Platform subscription failed

Maximum Response Time

MZOK/MZFAIL	2 seconds
+MZRECEIVE/+MZDEBUG	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 Mode

This command puts the monoZ:Jet module to different Low Power Modes(LPM).

Execution command

MZSLEEP=<Key_val> 

Response

MZOK/MZFAIL
+MZSLEEP: <sleep_sts> 
+MZDEBUG: <dbg_sts>

Defined Values

<Key_val>

Integer Type.

0

Full sleep mode. monoZ:Jet will go to full deep sleep mode within 5 seconds of sending back +MZSLEEP: 0 URC to the host. monoZ:Jet cannot take MZ commands in this mode and wake up is triggered by raising HOST to BOARD_WKP(P407) Pin to HIGH or via power off/on.
Avg. Power consumption: ~20μA

1

Semi sleep mode.monoZ:Jet shall be in ON state however it will be disconnected from the network similar to airplane mode. Wakeup is triggered using MZSTART.
Avg. Power consumption: ~25mA

2

Light Sleep mode. monoZ:Jet shall be in network connected state however the module shall be disconnected from the IoT platform. Wakeup is triggered using MZSTART.
Avg. Power consumption: ~110mA

<sleep_sts>

Integer Type.

0

Sleep mode success

1

Sleep mode fail

<dbg_sts>
*Only when Debug mode is ON.

Integer Type.

12

Modem power OFF success

13

Modem power OFF failed

16

Network disconnect success

17

Network disconnect failed

50

IoT platform disconnect success

51

IoT platform disconnect failed

Maximum Response Time

MZOK/MZFAIL	2 seconds
+MZSLEEP/+MZDEBUG	10 seconds

Usage

Without Debug Mode

MZSLEEP=1
MZOK
+MZSLEEP:0

With Debug Mode

MZSLEEP=1
MZOK
+MZDEBUG: 16
+MZSLEEP: 0

Note:

1. monoZ:Jet stores the last connected network information during the full sleep process. To speed up network connection after the next power-on, it is recommended to execute MZSLEEP=0 before powering off the monoZ:Jet.
2. If MZRECEIVE was enabled on the monoZ:Jet before Semi sleep or Light sleep, then monoZ:Jet automatically enables the session after wakeup.
3. In the case of Full Sleep, the user must reenable the downlink session upon wakeup.

Network Time

This command is used to capture and return the system clock.

Execution command

MZTIME

Response

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	2 seconds
+MZTIME	2 seconds

Usage

MZTIME
+MZTIME: 0,2024/06/17,16:11:23+36

Network Status

This command is used to read the status of connected network.

Execution command

MZNWSTATUS

Response

MZOK
+MZNWSTATUS: <r_sts>,"<lac>","<ci>","<oper>","<band>",<rssi>,<rsrp>,<sinr>,<rsrq>
+MZNWSTATUS: <r_sts>

Defined Values

<r_sts>

Integer Type.

0

Network Status Read Success

1

Network Status Read Failed

<lac>

String type.
Two-byte location area code in hexadecimal format.

<ci>

String type.
Four-byte E-UTRAN cell ID in hexadecimal format.

<oper>

String type.
Operator in numeric format.

<band>

String type.
Selected band for network connection.

<rssi>

Integer type.
LTE Received signal strength indicator.

<rsrp>

Integer type.
Reference signal received power.

<sinr>

Integer type.
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 -20dB to +30dB.

<rsrq>

Integer type.
Reference signal received quality (RSRQ). Unit: dB.

Maximum Response Time

MZOK/MZFAIL	2 seconds
+MZNWSTATUS	2 seconds

Usage

MZNWSTATUS
MZOK
+MZNWSTATUS: 0,"1859","017CED06","44020","LTE BAND 8",-66,-94,75,-15

Debug

This command enables or disables debugging mode on monoZ:Jet. When enabled, the module generates additional URCs, indicated by +MZDEBUG, for the corresponding MZ commands.

Execution command

MZDEBUG=<key_val>

Response

MZOK/MZFAIL

Defined Values

<key_val>

Integer Type.

0

Exit Debug Mode

1

Enter Debug Mode

Maximum Response Time

MZOK/MZFAIL

2 seconds

Usage

MZDEBUG=1
MZOK

Set Org ID

This command configures the Organization ID (ORGID) required for connecting to the monoZ:Link IoT platform. The ORGID configuration is stored in non-volatile memory of the device. This setting must be done before executing MZSTART.

Execution command

MZORGID="<org_id>"

Response

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	2 seconds
+MZORGID	5 seconds

Usage

MZORGID="MTI-1"
MZOK
+MZORGID: 0

Set Band

This command configures the BAND setting on monoZ:Jet for cellular network connectivity. By default, all supported bands are enabled, and during MZSTART, the module attempts to connect to the network in ascending order of the configured band. Band setting is stored in non-volatile memory of the device. This setting must be done before executing MZSTART.

Execution command

MZBAND=<GSM_bandval>,<eMTC_bandval>,<NB_IoT_bandval>

Response

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	2 seconds
+MZBAND	5 seconds

Usage

MZBAND=”0x0”,”0x2089b”,”0x80a”
+MZBAND: 0

Note:

1. The BAND setting plays a key role in reducing network connection time. We recommend configuring the band settings according to the device’s target operating region (refer to the table). This shall limit the band search to supported bands/networks of the region. Please contact us for tailored recommendations specific to your country or region.

Japan	MZBAND=0x0,0x20081,0x0
Europe	MZBAND=0x0,0x80084,0x80084
US&Canada	MZBAND=0x0,0x81A,0x81A
All Bands (Default)	MZBAND=0xf,0x2000000000f0e189f,0x200000000090f189f

FOTA - Send FOTA message

This command allows the host to set a firmware update status message for the OTA server after successful monoZ:Jet initialization via MZSTART. It is used to report the host firmware version or the outcome of an FOTA update. The MZSTARTMSG command can only be executed before MZSTART, and the configured message will be sent immediately to the FOTA server upon succesful platform connection.

Execution command

MZSTARTMSG=<message>

FOTA update URC

MZOK/MZFAIL
<upon_succesful_MZSTART>
+MZSTARTMSG: <send_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

STARTMSG message send success

1

STARTMSG message send failed

2

STARTMSG message length exceeds limit

3

STARTMSG message invalid format

Maximum Response Time

MZOK/MZFAIL	2 seconds
+MZMZSTATMSG	5 seconds (from MZSTART:0)

Usage

MZSTARTMSG=V.1.2 update complete
MZOK
MZSTART
+MZSTART:0
+MZREQFOTASEG: 0

FOTA - Update URC

monoZ:Jet pass the FOTA update availability notification & requested FOTA segment payload to the host using this URC. New FOTA update notification message can be received anytime during an active MZSTART session.

FOTA update URC #1 - FOTA Notification

+MZFOTARECEIVE: <receive_sts>,dt:<Epoch-Time>,host:<new-version-no>,hostsize:<file-name - size-in-Bytes>,hostseg:<total-segments> 
+MZDEBUG: <dbg_sts>

FOTA update URC #2 - Requested FOTA segment

+MZFOTARECEIVE: <receive_sts>,<segment-number>,<payload-format>,<requested-segment>

Defined Values

<receive_sts>

Integer Type.

1

New host firmware information received

2

Requested firmware segment received

3

Received firmware segment size exceeds limits

<Epoch-Time>

EPOCH Timestamp set by monoZ:Link while initiating the message.

<new-version-no>

FOTA version number as set by the user.

<file-name - size-in-Bytes>

FOTA file name as provided by user & total file size in Bytes

<total-segments>

Total no of segments in which FOTA file has been split.
Maximum size per segment = 1024B

<segment-number>

Received segment number of the FOTA file

<payload-format>

The format of contents in requested segment
A = ASCII
H = Hex

<requested-segment>

The requested segment data of FOTA file
Maximum size per segment = 1024B

<dbg_sts>

Integer Type.

40

IoT platform subscription success

41

IoT platform subscription failed

Usage

Without Debug Mode

FOTA Notification

+MZFOTARECEIVE: 1,dt:1740104482,host:1.1.5,hostsize:hostappV1.0.2.zip - 223390,hostseg:219

Requested FOTA segment

+MZFOTARECEIVE: 2,1,A,504b03041400000008001b84545aede14634b3b30100d0f603000b000000633361707056312e302e32cc5d097c94c5159f3d727018220408476113142d2a12ce445136893150149144a4b47577b359482424210997a85912af9aaa7c42c5965602d6ca465b690505b512c05a5ada0a7851b57593a805c2114842b25cdbff9b99dd9d5df643dbfefafb157f9bef7bff3733efcd9b376fce5dab736ebbd568309898fc6762af33039e3fcb15b455e289272849004b673df077381bc662419b83e92e7e761bc29ff10139325fba117fa23c87b0f0a74179c630fd7fd7e49802cf408ec05faeab653a70fe34873dbba562453d58583ea3ccd7761bf2f1a739ec694182d033543fb3fce473fce2e72d2cfc6996cf995f5615d2fbb96394f0e267092a1f7a86f2dd897cb1ec9bff4b94cf5924ef1276f1e2117a86dae1fa92e282eb4b0aaf2b292e5dbcec3a87a3c2593471fce8cab2d16942a724d9c6b933ee62a977bef14adbda6d6fbef7f29e25aee7660e7eeccca9c7cd5207834813f48938c53f34a5dd665a0a562539cc66c29ec6e719d261e9d5176e7bf5e96d49fbff3ae48da9739ff718fe79acf017b5b1150fdf36e4daccde2facefff9739512b1f94d18b25a747c307b1fa3c7318d60cbfe81ba50c439fe8f87934d7e551f091a6e8e97fa453cecb3af8953da2977f85397afa845ed1d377b0e8e9e7e994d3161b1ddfd0

With Debug Mode

FOTA subscribe

 +MZSTART: 0
 +MZDEBUG: 40

FOTA - Request firmware segment

This command is used to request the firmware segment from monoZ:Link.

Execution command

MZREQFOTASEG=<segment>

FOTA update URC

MZOK/MZFAIL
+MZREQFOTASEG: <send_sts> 
+MZDEBUG: <dbg_sts>

Defined Values

<segment>

String Type.
Max Byte size: 1B
Accepted Characters: Numeric

<send_sts>

Integer Type.

0

Request send success

1

Request send failed

2

Invalid segment

<dbg_sts>

Integer Type.

30

Data send success

31

Data send retransmitting

32

Data send failed

Maximum Response Time

MZOK/MZFAIL	2 seconds
+MZREQFOTASEG/+MZDEBUG	20 seconds

Usage

Without Debug Mode

MZREQFOTASEG=1
MZOK
+MZREQFOTASEG: 0

With Debug Mode

 MZREQFOTASEG=1
 MZOK
 +MZDEBUG: 30
 +MZREQFOTASEG: 0

ERROR URC

monoZ:Jet has 2 special URCs namely MZFAIL and MZERROR as described below.

MZFAIL	MZFAIL URC shall be returned for a MZ command if any prior MZ Command is in progress and its respective URC has not been sent back to host MZFAIL shall be returned for MZ commands (MZTIME, MZNWSTATUS, MZSEND, MZRECEIVE) when executed before succesful MZSTART. MZFAIL shall be returned for MZ commands (MZBAND, MZORGID) when executed after succesful MZSTART.
MZERROR	MZERROR URC shall be returned for any invalid MZ command