Template:FM36 SMS Command List: Difference between revisions

Latest revision as of 14:29, 27 November 2019

All commands are case sensitive. While FM36YX operates in Deep Sleep mode and user tries to send SMS message it cannot arrive to FM36YX device, because GSM/GPRS module is disabled most of the time (wake up depends on Send Period parameter). FM36YX will receive the SMS when it wakes up (exits deep sleep mode).

Command	Description	Response
getstatus	Modem Status information	Yes
getweektime	Current device time, Day of Week and amount of minutes passed since start of week	Yes
getops	List of currently available GSM operator	Yes
getcfgtime	Date and Time of last successful configuration	Yes
ggps	Google Map Link information	Yes
getgps	Current GPS data and time	Yes
cpureset	Reset CPU	No
resetprof	Reset all FLASH1 profile configuration to default profile	No
getver	Device / Modem / Code version information	Yes
getinfo	Device runtime system information	Yes
getimeiccid	Returns IMEI, CCID	Yes
deleterecords	Delete all records saved on FLASH	No
getio	Readout digital inputs and outputs	Yes
readio #	Readout digital input value according entered ID, # - ID value	Yes
setdigout ## Y1 Y2#	set digital outputs 0 – OFF, 1 – ON Y1 – timeout for DO1 Y2 – timeout for DO2	Yes
getparam #	Readout parameter value according entered ID. # - ID value.	Yes
setparam # #	Set parameter value according entered ID and Value. 1.# - ID value. 2.# - New Parameter Value	Yes
getparam 1271 X	X values can be 1, 2, 3	Yes
setparam 1271 X/212 X	If X is from 0 to 49, X means index of operator code which has to be configured.	Yes
flush #,#,#,#,#,#,#	Initiates all data sending to specified target server 1.# - IMEI 2.# - APN 3.# - LOGIN 4.# - PASS 5.# - IP 6.# - PORT 7.# - MODE (0-TCP/1-UDP)	No
setkey # #	Add new or change current configuration keyword. If device is locked, keyword cannot be changed 1.# - old keyword (if adding new keyword space 2.# - new keyword	Yes
delkey #	Remove existing keyword. (If device is locked, keyword cannot be changed) # - old keyword	Yes
readops #	1 – send first 20 operator codes, 2 – send from 21st to 40th operator codes, 3 – send all other operator codes
sn #	Static navigation, 1 – enable, 0 – disable	Yes
banlist	Banned operators information	Yes
crashlog	Device last information before unexpected reset	Yes
delete_all_sms	Deletes all SMS	No
lvcangetprog	CAN Program Number request by SMS	Yes
lvcansetprog #	Set LVCAN program number	Yes
lvcangetinfo	Get LV-CAN info by SMS	Yes

@@ Line 1: / Line 1: @@
-All commands are case sensitive. While FM36YX operates in Deep Sleep mode and user tries to send SMS message it cannot arrive to FM36YX device, because GSM/GPRS module is disabled most of the time (wake up depends on Send Period parameter). FM36YX will receive the SMS when it wakes up (exits deep sleep mode).
+All commands are case sensitive. While {{{model|FM36YX}}} operates in Deep Sleep mode and user tries to send SMS message it cannot arrive to {{{model|FM36YX}}} device, because GSM/GPRS module is disabled most of the time (wake up depends on Send Period parameter). {{{model|FM36YX}}} will receive the SMS when it wakes up (exits deep sleep mode).
 {| class="wikitable"
 |-
-! style="width: 1px; background: black; color: white;" | Command
+! style="width: 200px; background: black; color: white;" | Command
-! style="width: 1px; background: black; color: white;" | Description
+! style="width: 250px; background: black; color: white;" | Description
 ! style="width: 1px; background: black; color: white;" | Response
 |-
-! style="text-align: left; vertical-align: top;" | getstatus
+! style="text-align: left; vertical-align: top;" | ''[[FM36_getstatus|getstatus]]''
 | style="text-align: left; vertical-align: top;" | Modem Status information
 | style="text-align: left; vertical-align: top;" | Yes
 |-
-! style="text-align: left; vertical-align: top;" | getweektime
+! style="text-align: left; vertical-align: top;" | ''[[FM36_getweektime|getweektime]]''
 | style="text-align: left; vertical-align: top;" | Current device time, Day of Week and amount of minutes passed since start of week
 | style="text-align: left; vertical-align: top;" | Yes
 |-
-! style="text-align: left; vertical-align: top;" | getops
+! style="text-align: left; vertical-align: top;" | ''[[FM36_getops|getops]]''
 | style="text-align: left; vertical-align: top;" | List of currently available GSM operator
 | style="text-align: left; vertical-align: top;" | Yes
 |-
-! style="text-align: left; vertical-align: top;" | getcfgtime
+! style="text-align: left; vertical-align: top;" | ''[[FM36_getcfgtime|getcfgtime]]''
 | style="text-align: left; vertical-align: top;" | Date and Time of last successful configuration
 | style="text-align: left; vertical-align: top;" | Yes
 |-
-! style="text-align: left; vertical-align: top;" | ggps
+! style="text-align: left; vertical-align: top;" | ''[[FM36_ggps|ggps]]''
 | style="text-align: left; vertical-align: top;" | Google Map Link information
 | style="text-align: left; vertical-align: top;" | Yes
 |-
-! style="text-align: left; vertical-align: top;" | getgps
+! style="text-align: left; vertical-align: top;" | ''[[FM36_getgps|getgps]]''
 | style="text-align: left; vertical-align: top;" | Current GPS data and time
 | style="text-align: left; vertical-align: top;" | Yes
@@ Line 39: / Line 39: @@
 | style="text-align: left; vertical-align: top;" | No
 |-
-! style="text-align: left; vertical-align: top;" | getver
+! style="text-align: left; vertical-align: top;" | ''[[FM36_getver|getver]]''
 | style="text-align: left; vertical-align: top;" | Device / Modem / Code version information
 | style="text-align: left; vertical-align: top;" | Yes
 |-
-! style="text-align: left; vertical-align: top;" | getinfo
+! style="text-align: left; vertical-align: top;" | ''[[FM36_getinfo|getinfo]]''
 | style="text-align: left; vertical-align: top;" | Device runtime system information
+| style="text-align: left; vertical-align: top;" | Yes
+|-
+! style="text-align: left; vertical-align: top;" | ''[[FM36_getimeiccid|getimeiccid]]''
+| style="text-align: left; vertical-align: top;" | Returns IMEI, CCID
 | style="text-align: left; vertical-align: top;" | Yes
 |-
@@ Line 51: / Line 55: @@
 | style="text-align: left; vertical-align: top;" | No
 |-
-! style="text-align: left; vertical-align: top;" | getio
+! style="text-align: left; vertical-align: top;" | ''[[FM36_getio|getio]]''
 | style="text-align: left; vertical-align: top;" | Readout digital inputs and outputs
 | style="text-align: left; vertical-align: top;" | Yes
 |-
-! style="text-align: left; vertical-align: top;" | readio #
+! style="text-align: left; vertical-align: top;" | ''[[FM36_readio #|readio #]]''
 | style="text-align: left; vertical-align: top;" | Readout digital input value according entered ID, # - ID value
 | style="text-align: left; vertical-align: top;" | Yes
 |-
-! style="text-align: left; vertical-align: center;" | setdigout ## Y1 Y2
+! style="text-align: left; vertical-align: center;" | ''[[FM36_setdigout|setdigout ## Y1 Y2#]]''
 | style="text-align: left; vertical-align: top;" | set digital outputs<br />0 – OFF, 1 – ON<br />Y1 – timeout for DO1<br />Y2 – timeout for DO2
 | style="text-align: left; vertical-align: center;" | Yes
 |-
-! style="text-align: left; vertical-align: center;" | getparam #
+! style="text-align: left; vertical-align: center;" | ''[[FM36_getparam|getparam #]]''
 | style="text-align: left; vertical-align: top;" | Readout parameter value according entered ID.<br /># - ID value.
 | style="text-align: left; vertical-align: center;" | Yes
 |-
-! style="text-align: left; vertical-align: center;" | setparam # #
+! style="text-align: left; vertical-align: center;" | ''[[FM36_setparam|setparam # #]]''
 | style="text-align: left; vertical-align: top;" | Set parameter value according entered ID and Value.<br />1.# - ID value.<br />2.# - New Parameter Value
 | style="text-align: left; vertical-align: center;" | Yes
 |-
-! style="text-align: left; vertical-align: top;" | getparam 1271 X
+! style="text-align: left; vertical-align: top;" | ''[[FM36_getparam_1271|getparam 1271 X]]''
 | style="text-align: left; vertical-align: top;" | X values can be 1, 2, 3
 | style="text-align: left; vertical-align: top;" | Yes
 |-
-! style="text-align: left; vertical-align: center;" | flush #,#,#,#,#,#,#
+! style="text-align: left; vertical-align: center;" | ''[[FM36_setparam_1271|setparam 1271 X/212 X]]''
+| style="text-align: left; vertical-align: top;" | If X is from 0 to 49, X means index of operator code which has to be configured.
+| style="text-align: left; vertical-align: center;" | Yes
+|-
+! style="text-align: left; vertical-align: center;" | ''[[FM36_flush|flush #,#,#,#,#,#,#]]''
 | style="text-align: left; vertical-align: top;" | Initiates all data sending to specified target server<br />1.# - IMEI<br />2.# - APN<br />3.# - LOGIN<br />4.# - PASS<br />5.# - IP<br />6.# - PORT<br />7.# - MODE (0-TCP/1-UDP)
 | style="text-align: left; vertical-align: center;" | No
 |-
-! style="text-align: left; vertical-align: center;" | readops #
+! style="text-align: left; vertical-align: center;" | ''[[FMB_setkey|setkey # #]]''
+| style="text-align: left; vertical-align: top;" | Add new or change current configuration keyword. If device is locked, keyword cannot be changed <br />
+.# - old keyword (if adding new keyword space<br />
+.# - new keyword
+| style="text-align: left; vertical-align: center;" | Yes
+|-
+! style="text-align: left; vertical-align: center;" | ''[[FMB_delkey|delkey #]]''
+| style="text-align: left; vertical-align: top;" | Remove existing keyword. (If device is locked, keyword cannot be changed)<br /> # - old keyword
+| style="text-align: left; vertical-align: center;" | Yes
+|-
+! style="text-align: left; vertical-align: center;" | ''[[FM36_readops|readops #]]''
 | style="text-align: left; vertical-align: top;" | 1 – send first 20 operator codes, 2 – send from 21st to 40th operator codes, 3 – send all other operator codes
 | style="text-align: left; vertical-align: top;" |
 |-
-! style="text-align: left; vertical-align: top;" | sn #
+! style="text-align: left; vertical-align: top;" | ''[[FM36_sn|sn #]]''
 | style="text-align: left; vertical-align: top;" | Static navigation, 1 – enable, 0 – disable
 | style="text-align: left; vertical-align: top;" | Yes
 |-
-! style="text-align: left; vertical-align: top;" | banlist
+! style="text-align: left; vertical-align: top;" | ''[[FM36_banlist|banlist]]''
 | style="text-align: left; vertical-align: top;" | Banned operators information
 | style="text-align: left; vertical-align: top;" | Yes
 |-
-! style="text-align: left; vertical-align: top;" | crashlog
+! style="text-align: left; vertical-align: top;" | ''[[FM36_crashlog|crashlog]]''
 | style="text-align: left; vertical-align: top;" | Device last information before unexpected reset
 | style="text-align: left; vertical-align: top;" | Yes
@@ Line 99: / Line 117: @@
 | style="text-align: left; vertical-align: top;" | No
 |-
-! style="text-align: left; vertical-align: top;" | lvcangetprog
+! style="text-align: left; vertical-align: top;" | ''[[FM36_lvcangetprog|lvcangetprog]]''
 | style="text-align: left; vertical-align: top;" | CAN Program Number request by SMS
 | style="text-align: left; vertical-align: top;" | Yes
 |-
-! style="text-align: left; vertical-align: top;" | lvcansetprog #
+! style="text-align: left; vertical-align: top;" | ''[[FM36_lvcangetprog_num|lvcansetprog #]]''
 | style="text-align: left; vertical-align: top;" | Set LVCAN program number
 | style="text-align: left; vertical-align: top;" | Yes
 |-
-! style="text-align: left; vertical-align: top;" | lvcangetinfo
+! style="text-align: left; vertical-align: top;" | ''[[FM36_lvcangetinfo|lvcangetinfo]]''
 | style="text-align: left; vertical-align: top;" | Get LV-CAN info by SMS
 | style="text-align: left; vertical-align: top;" | Yes
 |}
-{| class="wikitable"
-|-
-! style="width: 1px; background: black; color: white;" | Response details
-! style="width: 1px; background: black; color: white;" | Description
-|-
-! style="text-align: left; vertical-align: top;" | Data Link
-| style="text-align: left; vertical-align: top;" | Indicate module connection to server at the moment: 0 – Not connected, 1 – connected
-|-
-! style="text-align: left; vertical-align: top;" | GPRS
-| style="text-align: left; vertical-align: top;" | Indicate if GPRS is available at the moment
-|-
-! style="text-align: left; vertical-align: top;" | Phone
-| style="text-align: left; vertical-align: top;" | Voice Call status: 0 – ready, 1 – unavailable, 2 – unknown, 3 – ringing, 4 – call in progress, 5 – asleep
-|-
-! style="text-align: left; vertical-align: top;" | SIM
-| style="text-align: left; vertical-align: top;" | SIM Status: 0 – ready, 1 – pin, 2 – puk, 3 – pin2, 4 – puk2
-|-
-! style="text-align: left; vertical-align: top;" | OP
-| style="text-align: left; vertical-align: top;" | Connected to GSM Operator: numerical id of operator
-|-
-! style="text-align: left; vertical-align: top;" | Signal
-| style="text-align: left; vertical-align: top;" | GSM Signal Quality [0-5]
-|-
-! style="text-align: left; vertical-align: top;" | NewSMS
-| style="text-align: left; vertical-align: top;" | Indicate if new message received
-|-
-! style="text-align: left; vertical-align: top;" | Roaming
-| style="text-align: left; vertical-align: top;" | 0 – Home Network, 1 – roaming
-|-
-! style="text-align: left; vertical-align: top;" | SMSFull
-| style="text-align: left; vertical-align: top;" | SMS storage is full? 0 – ok, 1 – SMS storage full
-|-
-! style="text-align: left; vertical-align: top;" | LAC
-| style="text-align: left; vertical-align: top;" | GSM Tower Location Area Code
-|-
-! style="text-align: left; vertical-align: top;" | Cell ID
-| style="text-align: left; vertical-align: top;" | GSM Tower Cell ID Code
-|}
-  Example: Data Link: 0 GPRS: 1 Phone: 0 SIM: 0 OP: 24602 Signal: 5 NewSMS: 0 Roaming: 0 SMSFull: 0 LAC: 1 Cell ID: 864