FALCOM MAMBOII User Manual

Page 1
THIS DOCUMENT IS AVAILABLE AT HTTP://WWW.FALCOM.DE/
MAMBOII
operating with firmware version 2.4.0
Configuration Command Set
User’s guide
Supports both GSM and TCP applications
Version: 1.1.0; Last Updated: 13/09/2007; This document will be regularly updated.
Page 2
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
Table of contents
1 INTRODUCTION ...................................................................................... 12
1.1 About this document .......................................................................................................12
1.1 Related documents ..........................................................................................................13
2 GENERAL ............................................................................................ 14
2.1 Features of the Firmware ................................................................................................14
2.2 The principle of firmware operation .............................................................................. 16
2.3 Internet and intranet applications setup with MAMBOII ..............................................18
2.3.1 Internet based applications ...........................................................................................18
2.3.2 Intranet applications ..................................................................................................... 19
2.4 TCP/IP Overview .............................................................................................................. 19
2.5 IEEE 802.15.4 Overview ...................................................................................................19
3 COMMAND SYNTAX, PFAL COMMANDS AND SUPPORTED PARAMETERSFOR
FALCOM MAMBOII .......................................................................... 20
3.1 PFAL Command syntax and response message structure .........................................20
3.1.1 Command syntax of PFAL commands .........................................................................20
3.1.1.1 Command types <c_type> .............................................................................................................. 22
3.1.2 Aliases ..........................................................................................................................22
3.1.3 Using identifiers (optional) ............................................................................................23
3.1.4 Response command structure ......................................................................................23
3.2 PFAL Commands .............................................................................................................25
3.2.1 “Sys” command type .....................................................................................................31
3.2.1.1 “Security” command index .............................................................................................................. 31
3.2.1.1.1 Sys.Security.Lock,”password” – Sends a pasword to lock your system ................................... 31
3.2.1.1.2 Sys.Security.Unlock,”password” – Sends a pasword to unlock your system ........................... 31
3.2.1.1.3 Sys.Security.RemoveLock,”password” – Sends a password to remove locking of your system
.................................................................................................................................................. 32
3.2.1.2 “RUpdate” command index ............................................................................................................. 33
3.2.1.2.1 Sys.RUpdate.Init – Initializes remote upgrade ......................................................................... 33
3.2.1.2.2 Sys.RUpdate.DataMode,<msg_input> – Defines transfer channel & continues upgrading ..... 34
3.2.1.2.2.1 Binary update commands ....................................................................................................35
3.2.1.2.2.2 List of binary commands ..................................................................................................... 35
3.2.1.2.3 Sys.RUpdate.Finish – Finishes Remote Update ...................................................................... 37
3.2.1.3 “Device” command index ................................................................................................................ 38
3.2.1.3.1 Sys.Device.Reset – Resets the system ................................................................................... 38
3.2.1.3.2 Sys.Device.Update – Set the system into the update mode .................................................... 38
3.2.1.3.3 Sys.Device.Shutdown – Shutdown the system ........................................................................ 39
3.2.1.3.4 Sys.Device.FactoryReset – Resets configuration to its default ................................................. 39
3.2.1.3.5 Sys.Device.Sleep=<type> – Puts the system into the sleep state ............................................ 39
3.2.1.3.6 Sys.Device.ClearAlarm – Clears existing alarms and restart the device ................................. 42
3.2.1.3.7 Sys.Device.ClearConfig – Clear existing configuration ............................................................. 42
3.2.1.3.8 Sys.Device.CfgUpdateMode – Prevents interferences between old and new alarms .............. 42
3.2.1.4 “Timer” command index .................................................................................................................. 44
3.2.1.4.1 Sys.Timer<index>.Configure=<mode>,<timeout> – Configures Timers ................................... 44
3.2.1.4.2 Sys.Timer<index>.Start=<timer_settings>– Starts/restarts Timers ........................................... 45
3.2.1.4.3 Sys.Timer<index>.Stop– Stop running Timers ..........................................................................46
3.2.1.4.4 Sys.Timer<index>.Pause – Pauses (suspends) running Timers .............................................. 46
3.2.1.4.5 Sys.Timer<index>.Resume– Restarts the execution of paused timers .....................................47
3.2.1.4.6 Sys.Timer<index>.Arm– Arms initialized and disarmed timers ................................................. 47
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 2 of 271
Page 3
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.1.4.7 Sys.Timer<index>.Disarm – Disarms initialized and armed Timers .......................................... 47
3.2.1.4.8 Sys.Timer<index>.Erase – Erases Timer settings .................................................................... 48
3.2.1.4.9 Sys.Timer<index>.Save<storage_index>– Saves Timer state to Storage index ...................... 48
3.2.1.4.10 Sys.Timer<index>.Load<storage_index>– Loads Timers with Storage contents ................... 49
3.2.1.4.11 Sys.Timer<index>.State – Reads Timer state ......................................................................... 49
3.2.1.5 “Trigger” command index ................................................................................................................ 50
3.2.1.5.1 Sys.Trigger<index>.Set=<state_type> – Activates/deactivates system Triggers ......................50
3.2.1.5.2 Sys.Trigger<index>– Reads triggers state ................................................................................ 50
3.2.1.5.3 Sys.Trigger<index>.Save<storage_index>– Saves Trigger state to Storage index .................. 51
3.2.1.5.4 Sys.Trigger<index>.Load<storage_index>– Load Triggers with Storage contents ...................51
3.2.1.6 “Counter” command index .............................................................................................................. 52
3.2.1.6.1 Sys.Counter<index>.Set=<value> – Sets Counters to a value ................................................. 52
3.2.1.6.2 Sys.Counter<index>.Increment=<inc_value> – Increments Counter’s value ............................53
3.2.1.6.3 Sys.Counter<index>.Decrement=<dec_value> – Subtracts Counter’s value ........................... 53
3.2.1.6.4 Sys.Counter<index>.State – Reads Counter’s state ................................................................ 54
3.2.1.6.5 Sys.Counter<index>.Save<storage_index>– Saves Counter’s state to Storage index ............ 54
3.2.1.6.6 Sys.Counter<index>.Load<storage_index>– Loads Counters with storage contents ...............55
3.2.1.6.7 Sys.Counter<index>.Clear – Sets Counters to 0 ...................................................................... 55
3.2.1.7 “MACRO” command index .............................................................................................................. 56
3.2.1.7.1 Sys.Macro<index>– Activates configured Macros .................................................................... 56
3.2.1.8 “GSM” command index ................................................................................................................... 57
3.2.1.8.1 Sys.GSM.Enable – Powers on the GSM engine ...................................................................... 57
3.2.1.8.2 Sys.GSM.Disable – Powers off the GSM engine ...................................................................... 57
3.2.1.8.3 Sys.GSM.Reset – Resets the GSM engine .............................................................................. 57
3.2.1.9 “GPS” command index .................................................................................................................... 58
3.2.1.9.1 Sys.GPS.Enable – Powers on the GPS engine ....................................................................... 58
3.2.1.9.2 Sys.GPS.Disable – Powers down the GPS engine .................................................................. 58
3.2.1.9.3 Sys.GPS.Reset – Resets the GPS engine ............................................................................... 58
3.2.1.10 “UserEvent” command index ........................................................................................................ 59
3.2.1.10.1 Sys.UserEvent<index> – Creates a user-event for specific application requirements ............ 59
3.2.1.11 “BAT” command index .................................................................................................................. 60
3.2.1.11.1 Sys.Bat.Voltage – Queries battery voltage ............................................................................. 60
3.2.1.11.2 Sys.Bat.ChargeState – Gets the current backup battery state ..............................................60
3.2.1.12 “BT” command index ..................................................................................................................... 61
3.2.1.12.1 Sys.BT.Enable – Powers on the Bluetooth module ................................................................61
3.2.1.12.2 Sys.BT.Disable – Powers off the Bluetooth module .............................................................. 61
3.2.1.12.3 Sys.BT.Reset – Resets the Bluetooth chip ............................................................................. 62
3.2.1.13 “CPU” command index .................................................................................................................. 63
3.2.1.13.1 Sys.CPU.Reset – Resets the ARM7 controller and sets the device into the upgrade mode. . 63
3.2.1.14 “IEEE” command index ................................................................................................................. 64
3.2.1.14.1 Sys.IEEE.Enable – Powers on the IEEE module ................................................................... 64
3.2.1.14.2 Sys.IEEE.Disable – Powers off the IEEE module ................................................................... 64
3.2.1.14.3 Sys.IEEE.Reset – Resets the IEEE module ............................................................................ 64
3.2.1.15 “DISPLAY” command type ............................................................................................................ 65
3.2.1.15.1 Display.Show – Displays a specific view on the MAMBOII's screen ...................................... 65
3.2.1.15.2 Display.Dialog – Creates a full-screen dialog box ................................................................... 66
3.2.1.15.3 Display.Alarm – Displays a specific alarm image on the screen ............................................ 67
3.2.2 “CNF” command type ...................................................................................................69
3.2.2.1 Cnf.Set,<parameter_name=value> - Sets up configuration settings for an application and overrides
default settings .......................................................................................................................... 69
3.2.2.2 Cnf.Get,<parameter_name> - Get configuration settings from device .......................................... 74
3.2.2.3 Cnf.Clear,<parameter_name> - Clears all settings in a parameter ................................................ 78
3.2.2.4 Cnf.ShowUser - Shows user specified settings .............................................................................. 79
3.2.2.5 Cnf.ShowDefault - Shows default settings ...................................................................................... 79
3.2.2.6 Cnf.Show - Shows all used parameters .......................................................................................... 80
3.2.2.7 Cnf.Search,<parameter_search> – Searches for a parameter name ............................................. 81
3.2.3 “IO” command type .......................................................................................................82
3.2.3.1 “Beep” command index ................................................................................................................... 82
3.2.3.1.1 IO.Beep<index>=<config_type> – Generates beep tones ........................................................ 82
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 3 of 271
Page 4
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.3.2 “Vibration” command index ............................................................................................................. 83
3.2.3.2.1 IO.Vibration=<config_type> – Manages device vibrations ........................................................ 83
3.2.4 “GPS” command type ...................................................................................................84
3.2.4.1 “Nav” command index ..................................................................................................................... 84
3.2.4.1.1 GPS.Nav.Position<buffer_index> – Gets the travelled distance from a stored position ........... 84
3.2.4.1.2 GPS.Nav.Position<buffer_index>=<type> – Stores temporarily a GPS position ...................... 84
3.2.4.1.3 GPS.Nav.Position<buffer_index>=save<storage_index> – Moves GPS position data from buffer
to storage index ........................................................................................................................ 85
3.2.4.1.4 GPS.Nav.Position<buffer_index>=load<storage_index> – Loads GPS data from storage to
buffer index for temporarily use ................................................................................................ 86
3.2.4.1.5 GPS.Nav.Distance – Gets the current travelled distance from a start point ..............................86
3.2.4.1.6 GPS.Nav.Distance=<value> – Sets/resets the distance to a user value ...................................87
3.2.4.1.7 GPS.Nav.SaveLastValid – Saves the last valid position, if no GPS-fix valid ........................... 87
3.2.4.1.8 GPS.Nav.PowerSave=<on>,<onTime>,<lpTime> – Enables/Disables the low power mode ....88
3.2.4.2 “History” command index ................................................................................................................ 89
3.2.4.2.1 GPS.History.Write,<flag>,<”text”> – Stores GPS data or user text in the history memory ...... 89
3.2.4.2.2 GPS.History.Clear– Clears the history memory ....................................................................... 90
3.2.4.2.3 GPS.History.GetStart– Shows the oldest date stored in the history memory .......................... 91
3.2.4.2.4 GPS.History.SetRead,<s_date>,<s_time>-,<e_date>,<e_time>– Selects the number of records
to be downloaded from the history memory ............................................................................ 91
3.2.4.2.5 GPS.History.Read – Downloads the selected history records in parts ..................................... 92
3.2.4.2.5.1 How to read the history records in textual format ................................................................ 93
3.2.4.2.5.2 Further notes for converting history data with special remark to data/event logging features
........................................................................................................................................... 95
3.2.4.2.6 GPS.History.Push – Downloads the selected history records at once ...................................... 96
3.2.4.3 “Geofence” command index ............................................................................................................ 98
3.2.4.3.1 GPS.Geofence.Park.Set –Activates a park area .......................................................................98
3.2.4.3.2 GPS.Geofence.Park.Remove– Disables the activated park area ............................................. 98
3.2.4.3.3 GPS.Geofence.GeoState,<geo_id> – Gets the state of a Geofence ...................................... 100
3.2.4.3.4 GPS.Geofence.AreaState,<area_id>– Gets the state of an Area ........................................... 100
3.2.5 “GSM” command type ................................................................................................ 101
3.2.5.1 “GSM” general command indices ................................................................................................. 101
3.2.5.1.1 GSM.PIN=<”pin”> - Enters the PIN number of the used SIM card .......................................... 101
3.2.5.1.2 GSM.PUK=<”puk”>,<”pin”> - Enters the PUK and PIN numbers of the used SIM card ..........101
3.2.5.1.3 GSM.IMEI – Gets the serial identification number of the device ............................................. 101
3.2.5.1.4 GSM.SIMID – Get the ID of SIM Card ..................................................................................... 102
3.2.5.1.5 GSM.OwnNumber– Gets the current voice call number of the device .................................... 102
3.2.5.1.6 GSM.Balance– Gets the account information of the used prepaid SIM card .......................... 102
3.2.5.2 “Voice Call” command index ......................................................................................................... 103
3.2.5.2.1 GSM.VoiceCall.Dial,<“p_number“> - Makes a GSM voice call .............................................. 103
3.2.5.2.2 GSM.VoiceCall.Accept - Accepts an incoming voice call ....................................................... 103
3.2.5.2.3 GSM.VoiceCall.Hangup – Hangs up an active voice call ....................................................... 103
3.2.5.2.4 GSM.VoiceCall.Audio.Profile=<audio_index> – Sets the active audio profile .........................104
3.2.5.2.5 GSM.VoiceCall.Ringtone=<type>,<volume> - Sets the ring tone settings .............................. 104
3.2.5.2.6 GSM.VoiceCall.Volume.Speaker=<n_gain>,<volume>,<sidetone> - Sets or gets the
loudspeaker settings .............................................................................................................. 105
3.2.5.2.7 GSM.VoiceCall.Volume.Microphone=<gain>,<n_gain> - Sets or gets the microphone settings
................................................................................................................................................ 105
3.2.5.3 “SMS” command index ................................................................................................................. 106
3.2.5.3.1 GSM.SMS.Send,<”p_number“>,<protocols>,<”text”> - Sends an SMS message .................. 106
3.2.5.3.2 GSM.SMS.Inbox.State – Shows inbox SMS ........................................................................... 107
3.2.5.3.3 GSM.SMS.Inbox.Clear – Clears inbox SMS ........................................................................... 107
3.2.5.3.4 GSM.SMS.Outbox.State – Shows outbox SMS ..................................................................... 107
3.2.5.3.5 GSM.SMS.Outbox.Clear – Clears outbox SMS ..................................................................... 107
3.2.5.4 “Data Call” command index .......................................................................................................... 108
3.2.5.4.1 GSM.DataCall.Send,<protocols>,<”text”> - Transfers messages via an established data call 108
3.2.5.4.2 GSM.DataCall.Accept - Accepts an incoming Data call ......................................................... 108
3.2.5.4.3 GSM.DataCall.Hangup – Hangs up an active voice call ....................................................... 109
3.2.5.5 “GPRS” command index ............................................................................................................... 109
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 4 of 271
Page 5
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.5.5.1 GSM.GPRS.Connect – Performs a GPRS attach ................................................................... 109
3.2.5.5.2 GSM.GPRS.Disconnect – Performs a GPRS detach ..............................................................109
3.2.5.5.3 GSM.GPRS.State – Gets the GPRS status ............................................................................ 110
3.2.5.5.4 GSM.GPRS.Traffic=<complete>,<incoming>,<outgoing> – Set or read a GPRS traffic counter
................................................................................................................................................ 110
3.2.6 “TCP” command type ................................................................................................. 111
3.2.6.1 “TCP” command index .................................................................................................................. 111
3.2.6.1.1 TCP.Client.Connect - Performs a TCP connection to the server ............................................ 111
3.2.6.1.2 TCP.Client.Send,<protocols>,<”text”> - Transfers a TCP packet to the connected server .....112
3.2.6.1.3 TCP.Client.State – Gets the status of the TCP connection ..................................................... 112
3.2.6.1.4 TCP.Client.Disconnect - Disconnects from TCP server .......................................................... 113
3.2.6.2 “STORAGE” command index ........................................................................................................ 114
3.2.6.2.1 TCP.Storage.Dispatch - Moves TCP storage contents to outgoing TCP buffer ...................... 114
3.2.6.2.2 TCP.Storage.Clear – Clears TCP Storage .............................................................................. 114
3.2.6.2.3 TCP.Storage.AddProtocol,<protocols>,<”text”> - Addes data to the TCP storage ................. 115
3.2.6.2.4 TCP.Storage.AddRecord,<protocol>,<”text”> - Appends a binary dataframe to the TCP storage
................................................................................................................................................ 116
3.2.6.3 “SMTP” command index ............................................................................................................... 118
3.2.6.3.1 TCP.SMTP.Send,<email_address>,<protocols>,<”text”> - Send an Email to the connected
remote server ......................................................................................................................... 118
3.2.7 “MSG” command type ................................................................................................ 120
3.2.7.1 “Send” command index ................................................................................................................. 120
3.2.7.1.1 MSG.Send.Serial,<protocols>,<”text”> - Redirects command responses to the serial interface
(Bluetooth) .............................................................................................................................. 120
3.2.7.1.2 MSG.Send.RawSerial,<protocols>,<”text”> - Redirects command responses to the serial
interface in unformatted data structure ...................................................................................121
3.2.7.1.3 MSG.Send.CSD,<protocols>,<”text”> - Redirects command responses to CSD channel. ..... 122
3.2.7.1.4 MSG.Send.TCP,<protocols>,<”text”> - Redirects command responses to TCP channel ....... 123
3.2.7.2 “Mode” command index ................................................................................................................ 125
3.2.7.2.1 MSG.Mode.Serial=<out_sys_messages>,<mode>- Defines the communication mode on serial
channel .................................................................................................................................. 125
3.2.7.2.2 MSG.Mode.CSD=<out_sys_messages>,<mode> - Defines the communication mode on CSD
channel ................................................................................................................................... 127
3.2.7.2.3 MSG.Mode.TCP=<out_sys_messages>,<mode> - Defines the communication mode on TCP
channel ................................................................................................................................... 128
3.2.7.3 “Version” command index ............................................................................................................. 130
3.2.7.3.1 MSG.Version.Complete - Gets all versions information of the target device .......................... 130
3.2.7.3.2 MSG.Version.Modules - Gets the modules versions of the target device ............................... 130
3.2.7.3.3 MSG.Version.InternalComm - Gets the internal communication version of the target device 130
3.2.7.3.4 MSG.Version.HardwareRev - Gets the hardware revision of the target device ...................... 131
3.2.7.3.5 MSG.Version.Hardware - Gets the hardware version of the target device ............................. 131
3.2.7.3.6 MSG.Version.Software - Gets the software version of the target device ................................ 131
3.2.7.3.7 MSG.Version.SoftwareID - Gets the firmware ID of the firmware ........................................... 131
3.2.7.4 “Info” command index ................................................................................................................... 132
3.2.7.4.1 MSG.Info.ServerLogin – Gets login information that the device sends to the server .............. 132
3.2.7.4.2 MSG.Info.Protocol,<protocols>,<”text”> - Transmits protocol reports to the sender ............... 132
3.2.7.4.3 MSG.Info.Time – Gets the current system time ...................................................................... 133
3.2.7.4.4 MSG.Info.Alarm,<alarm_index> - Shows the configuration of an alarm ................................. 134
3.2.7.5 “Channel” command index ............................................................................................................ 135
3.2.7.5.1 MSG.Channel.SerialGSM – Channels all input commands transmitted via serial port directly to
GSM engine ........................................................................................................................... 135
3.2.8 “IEEE” command type ................................................................................................ 136
3.2.8.1 “Keyfob” command index .............................................................................................................. 136
3.2.8.1.1 IEEE.Keyfob<kf_div_index>.LED<lindex>=<config_type> – Configures LEDs on a Keyfob
device ..................................................................................................................................... 136
3.2.8.1.2 IEEE.Keyfob<kf_div_index>.Beep=<config_type> – Generates beep tones on a Keyfob device
................................................................................................................................................ 137
3.2.8.1.3 IEEE.Keyfob<kf_div_index>.Vibration=<config_type> – Generates vibration on a Keyfob device
................................................................................................................................................ 138
3.2.8.2 “IOBOX” command index .............................................................................................................. 139
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 5 of 271
Page 6
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.8.2.1 IEEE.IOBox<ib_div_index>.OUT<oindex>=<config_type> – Configures outputs of I/O-BOX 139
3.2.8.2.2 IEEE.IOBox<ib_div_index>.power=<power_mode> – Changes the operation mode of I/O-BOX
................................................................................................................................................ 139
3.2.8.2.3 IEEE.IOBox<ib_div_index>.bat.level - Gets battery charge state .......................................... 140
3.2.9 “BT” command type ....................................................................................................141
3.2.9.1 “Audio” command index ................................................................................................................ 141
3.2.9.1.1 BT.Audio.Bound - Pairs Bluetooth audio devices ...................................................................141
3.2.9.1.2 BT.Audio.Connect - Places both Bluetooth devices in the connection mode ........................141
3.2.9.1.3 BT.Audio.Disconnect - Closes a currently open audio connection .......................................142
3.2.10 Set or query device configuration settings ............................................................... 143
3.2.10.1 DEVICE parameters .................................................................................................................. 144
3.2.10.2 DEVICE.NAME ........................................................................................................................... 144
3.2.10.3 DEVICE.CMD.PFAL.EN ............................................................................................................ 144
3.2.10.4 DEVICE.COMM.SERIAL ........................................................................................................... 145
3.2.10.5 DEVICE.COMM.CSD ................................................................................................................. 147
3.2.10.6 DEVICE.COMM.TCP.CLIENT ................................................................................................... 148
3.2.10.7 DEVICE.IGNTIMEOUT ............................................................................................................... 149
3.2.10.8 DEVICE.BAT.MODE ................................................................................................................... 150
3.2.10.9 DEVICE.GPS.STARTUP ............................................................................................................ 151
3.2.10.10 DEVICE.GPS.AUTOCORRECT ............................................................................................... 151
3.2.10.11 DEVICE.GPS.CFG ................................................................................................................... 152
3.2.10.12 DEVICE.GPS.TIMEOUT ........................................................................................................... 152
3.2.10.13 DEVICE.GSM.STARTUP .......................................................................................................... 153
3.2.10.14 DEVICE.IEEE.STARTUP .......................................................................................................... 153
3.2.10.15 DEVICE.BT.STARTUP ............................................................................................................. 154
3.2.10.16 DEVICE.BT.LOCALNAME ........................................................................................................ 154
3.2.10.17 DEVICE.BT.AUDIOGW ............................................................................................................ 154
3.2.10.18 DEVICE.PFAL.SEND.FORMAT ............................................................................................... 155
3.2.11 DISP Parameter ....................................................................................................... 157
3.2.11.1 DISP.VIEW<index> ..................................................................................................................... 157
3.2.11.2 DISP.MENU<index> ................................................................................................................... 158
3.2.11.3 DISP.PHONE<index> ................................................................................................................. 160
3.2.11.4 DISP.COLOR<id> ....................................................................................................................... 160
3.2.11.5 DISP.FONT ................................................................................................................................. 161
3.2.11.6 DISP.MESSAGE<index> ............................................................................................................ 161
3.2.11.7 DISP.SAVER .............................................................................................................................. 161
3.2.11.8 DISP.TZ ...................................................................................................................................... 162
3.2.12 IEEE Parameter ........................................................................................................163
3.2.12.1 IEEE.PANID ................................................................................................................................ 163
3.2.12.2 IEEE.KEYFOB<cnf_kf_div_index> ............................................................................................. 163
3.2.12.3 IEEE.IOBOX<cnf_ib_div_index> ................................................................................................ 164
3.2.13 REPLACE parameter .............................................................................................. 166
3.2.13.1 REPLACE<index> ...................................................................................................................... 166
3.2.14 Optional Settings ...................................................................................................... 168
3.2.14.1 STORAGE<id> ........................................................................................................................... 168
3.2.14.2 SAVE.LASTVALID ...................................................................................................................... 168
3.2.14.3 USERTXT<text> ......................................................................................................................... 168
3.2.14.4 MACRO<index> .......................................................................................................................... 169
3.2.15 IO parameter ........................................................................................................... 170
3.2.15.1 IO.BEEP.ENABLE ...................................................................................................................... 170
3.2.16 MOTION parameter .................................................................................................171
3.2.16.1 MOTION.FILTER ........................................................................................................................ 171
3.2.17 ALIAS parameter ......................................................................................................172
3.2.17.1 ALIAS.<type> .............................................................................................................................. 172
3.2.18 DBG parameter ........................................................................................................ 172
3.2.18.1 DBG.EN ..................................................................................................................................... 172
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 6 of 271
Page 7
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.19 PROT parameters .................................................................................................... 174
3.2.19.1 PROT.<message_id> ................................................................................................................ 174
3.2.19.2 PROT.START.BIN ..................................................................................................................... 175
3.2.20 GSM parameters ...................................................................................................... 176
3.2.20.1 GSM.PIN ..................................................................................................................................... 176
3.2.20.2 GSM.CALLID.EN ....................................................................................................................... 176
3.2.20.3 GSM.CALLTONE.ENABLE ........................................................................................................ 177
3.2.20.4 GSM.OPLOST.RESTART ......................................................................................................... 177
3.2.20.5 GSM.OPERATOR.BLACKLIST ................................................................................................. 178
3.2.20.6 GSM.OPERATOR.SELECTION ................................................................................................ 178
3.2.20.7 GSM.SMS.RESPONSE .............................................................................................................. 179
3.2.20.8 GSM.RINGTONE ........................................................................................................................ 180
3.2.20.9 GSM.PROFILE.AUDIO<prof_index> .......................................................................................... 180
3.2.20.10 GSM.PROFILE.CURRENTAUDIO ........................................................................................... 182
3.2.21 GPRS parameters ................................................................................................... 183
3.2.21.1 GPRS.APN ................................................................................................................................ 183
3.2.21.2 GPRS.AUTOSTART .................................................................................................................. 183
3.2.21.3 GPRS.QOSMIN ......................................................................................................................... 184
3.2.21.4 GPRS.QOS ................................................................................................................................ 186
3.2.21.5 GPRS.DIAL ................................................................................................................................ 188
3.2.21.6 GPRS.TIMEOUT ........................................................................................................................ 188
3.2.22 PPP parameters ....................................................................................................... 189
3.2.22.1 PPP.USERNAME ...................................................................................................................... 189
3.2.22.2 PPP.PASSWORD ...................................................................................................................... 189
3.2.22.3 PPP.AUTOPING ........................................................................................................................ 189
3.2.22.4 PPP.AUTH ................................................................................................................................. 190
3.2.23 TCP parameters ....................................................................................................... 191
3.2.23.1 TCP.CLIENT.CONNECT ............................................................................................................ 191
3.2.23.2 TCP.CLIENT.ALTERNATIVE ..................................................................................................... 192
3.2.23.3 TCP.CLIENT.PING .................................................................................................................... 193
3.2.23.4 TCP.CLIENT.TIMEOUT ............................................................................................................. 193
3.2.23.5 TCP.CLIENT.DNS.TIMEOUT .................................................................................................... 194
3.2.23.6 TCP.CLIENT.LOGIN .................................................................................................................. 194
3.2.23.7 TCP.STORAGE ......................................................................................................................... 195
3.2.23.8 TCP.CLIENT.SENDMODE ......................................................................................................... 195
3.2.23.9 TCP.SMTP.CONNECT ............................................................................................................... 196
3.2.23.10 TCP.SMTP.LOGIN .................................................................................................................... 196
3.2.23.11 TCP.SMTP.FROM .................................................................................................................... 197
3.2.24 GF parameter (Geofences) ...................................................................................... 198
3.2.24.1 How to do Geofencing with the MAMBOII ................................................................................. 198
3.2.24.1.1 Determine the Zone’s Grid Coordinates ................................................................................ 198
3.2.24.2 Set up the Geofencing zones and areas .....................................................................................199
3.2.24.3 GF.CONFIG ............................................................................................................................... 200
3.2.24.4 GF.AREA<ID> ........................................................................................................................... 201
3.2.24.5 GF<id> ....................................................................................................................................... 201
3.2.25 AL<index> parameter (Alarm configuration) ............................................................ 206
3.2.25.1 AL<n>= <conditions>:<actions> -Set alarm configuration .......................................................... 207
3.2.25.1.1 Supported System Events and States ................................................................................... 212
3.2.25.1.1.1 Comparators used within Events/States ........................................................................ 212
3.2.25.1.1.2 Sys (System states and events) ...................................................................................... 213
3.2.25.1.1.2.1 Sys.eSerialData (SerialData states and events) .............................................................................213
3.2.25.1.1.2.2 Sys.Device (Device states and events) ..........................................................................................213
3.2.25.1.1.2.3 Sys.Timer (TIMER states and events) ............................................................................................214
3.2.25.1.1.2.4 Sys.Trigger (TRIGGER states and events) .................................................................................... 214
3.2.25.1.1.2.5 Sys.Counter (COUNTER events and states) ..................................................................................215
3.2.25.1.1.2.6 Sys.BT (BLUETOOTH states and events) ......................................................................................216
3.2.25.1.1.2.7 BT.Audio (BLUETOOTH Audio states and events) ........................................................................216
3.2.25.1.1.2.8 Sys.GPS (GPS states and events) .................................................................................................216
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 7 of 271
Page 8
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.25.1.1.2.9 Sys.GSM (GSM states and events) ................................................................................................217
3.2.25.1.1.2.10 Sys.Power (POWER states and events) ...................................................................................... 217
3.2.25.1.1.2.11 Sys.Bat (BATTERY states and events) ........................................................................................218
3.2.25.1.1.2.12 Sys.UserEvent (UserEvent states and events) .............................................................................218
3.2.25.1.1.3 DISPLAY (DISPLAY states and events) ......................................................................... 219
3.2.25.1.1.3.1 DISPLAY.DIALOG (DIALOG states and events) ............................................................................219
3.2.25.1.1.4 IO (IO states and events) ................................................................................................ 220
3.2.25.1.1.4.1 IO.Motion (Motion states and events) .............................................................................................220
3.2.25.1.1.4.2 IO.BTN (Button states and events) .................................................................................................220
3.2.25.1.1.5 GPS (GPS states and events) .........................................................................................221
3.2.25.1.1.5.1 GPS.Nav (Navigation states and events) .......................................................................................221
3.2.25.1.1.5.2 GPS.Time (GPS Time states and events) ......................................................................................222
3.2.25.1.1.5.3 GPS.History (History states and events) ........................................................................................223
3.2.25.1.1.5.4 GPS.Geofence (Geofence states and events) ...............................................................................224
3.2.25.1.1.5.5 GPS.Area (Area states and events) ................................................................................................225
3.2.25.1.1.6 GSM (GSM states and events) ....................................................................................... 226
3.2.25.1.1.6.1 GSM (GSM Operator states and events) ........................................................................................226
3.2.25.1.1.6.2 GSM.eCellChange (Cell states and events) ...................................................................................226
3.2.25.1.1.6.3 GSM.VoiceCall (Voice Call states and events) ...............................................................................227
3.2.25.1.1.6.4 GSM.SMS (SMS states and events) ...............................................................................................228
3.2.25.1.1.6.5 GSM.DataCall (Data Call states and events) .................................................................................229
3.2.25.1.1.6.6 GSM.GPRS (GPRS states and events) ..........................................................................................230
3.2.25.1.1.7 TCP (TCP states and events) ......................................................................................... 231
3.2.25.1.1.7.1 TCP.Client (TCP Client states and events) .................................................................................... 231
3.2.25.1.1.7.2 TCP.SMTP (SMTP states and events) ...........................................................................................231
3.2.25.1.1.8 IEEE.KEYFOB (states and events) ................................................................................. 232
3.2.25.1.1.8.1 IEEE.KEYFOB<index>.State (KEYFOB states and events) .......................................................... 232
3.2.25.1.1.9 IEEE.IOBOX (states and events) .................................................................................... 232
3.2.25.1.1.9.1 IEEE.IOBOX<index>.State (IOBOX states and events) .................................................................232
3.2.25.1.1.9.2 IEEE.IOBOX<index>.IN (Input states and events) .........................................................................233
3.2.25.1.1.9.3 IEEE.IOBOX<index>.ANA (Analogue Input states and events) .....................................................233
4 HOW TO TEST THE FALCOM MAMBOII USING FIRMWARE 2.4.0 AND LATER .... 234
4.1 How to test the MAMBOII-EVAL-KIT ............................................................................234
4.2 What kind of rules should be considered to prepare your applications with
MAMBOII: ....................................................................................................................234
4.3 Test your MAMBOII by creating a simple configuration ............................................235
4.3.1 Load the configuration into the MAMBOII device ......................................................236
4.3.2 Run the test ............................................................................................................... 237
4.3.3 How to connect an I/O-BOX device to the MAMBOII .................................................238
4.3.4 How to connect a Bluetooth audio headset to the MAMBOII .................................... 238
4.4 TCP server communication ..........................................................................................240
4.4.1 Getting started with basis configuration (required for TCP/Internet applications, only)
.................................................................................................................................240
4.5 Using the MAMBOII device as real-time navigation system ..................................... 241
5 HOW TO SEND SMS MESSAGE TO THE MAMBOII DEVICE ......................... 242
6 APPENDIX .......................................................................................... 243
6.1 How to update a new firmware into the MAMBOII ......................................................243
6.2 Supported dynamic entries .......................................................................................... 243
6.3 Supported protocols ..................................................................................................... 245
6.4 Supported character sets ............................................................................................. 246
6.4.1 GSM alphabet tables and UCS2 character values .....................................................247
6.5 NMEA messages transmitted/selected by/on MAMBOII device ................................251
6.5.1 Description of NMEA output messages .....................................................................251
6.5.1.1 $GPGGA message ....................................................................................................................... 252
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 8 of 271
Page 9
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
6.5.1.2 $GPRMC message ....................................................................................................................... 252
6.5.1.3 $GPGSV message ........................................................................................................................ 253
6.5.1.4 $GPGSA message ........................................................................................................................ 253
6.5.1.5 $GPVTG message ........................................................................................................................ 254
6.5.1.6 $GPGLL message ........................................................................................................................ 254
6.5.1.7 $GPIOP message ......................................................................................................................... 255
6.5.1.8 $GPGSM message ....................................................................................................................... 255
6.5.1.9 $GPAREA message ..................................................................................................................... 256
6.5.1.10 BIN protocol and its format ........................................................................................................ 256
6.6 How to convert the coordinates ...................................................................................257
6.7 Explanation of the History Binary Data .......................................................................257
6.7.1 Maximum values & the time the history space will be used up .................................. 257
6.8 MAMBOII communication modes and their functionality ..........................................259
6.9 Default settings of the firmware version 2.4.0 ............................................................260
6.10 Buttons and LEDs designation of the Keyfob corresponding to the firmware
version 2.4.0 ...............................................................................................................262
6.10.1 Pin designations for the 16-pin MOLEX and 8-pin connector of the I/O-BOX
corresponding to the firmware version 2.4.0 and later ...........................................263
6.11 MAMBOII Configuration Examples ............................................................................ 264
6.11.1 Basic Configuration Examples ..................................................................................264
6.11.1.1 Alarm Syntax ............................................................................................................................... 264
6.11.1.2 History ......................................................................................................................................... 264
6.11.1.2.1 History entries based on the distance .................................................................................. 264
6.11.1.3 Voice calls ................................................................................................................................... 264
6.11.1.3.1 Accept incoming voice calls .................................................................................................. 264
6.11.1.3.2 Refuse voice calls after the second ring ................................................................................264
6.11.1.4 CSD (Data calls) ......................................................................................................................... 265
6.11.1.4.1 Accept incoming data calls .................................................................................................... 265
6.11.1.4.2 Refuse data calls after the second ring ................................................................................. 265
6.11.1.5 SMS ............................................................................................................................................ 265
6.11.1.5.1 SMS responses for self defined commands .......................................................................... 265
6.11.2 Advanced Examples .................................................................................................265
6.11.3 Navigation speed ......................................................................................................265
6.11.3.1.1 Check the over speed of the device each 5 seconds ............................................................ 265
6.11.3.2 Trigger ......................................................................................................................................... 265
6.11.3.2.1 Save and load important trigger states .................................................................................. 265
6.11.3.3 Counter ....................................................................................................................................... 266
6.11.3.3.1 Limit the number of automatically sent SMS ......................................................................... 266
6.11.3.4 Actions based on distance ......................................................................................................... 266
6.11.3.4.1 Report a position each 1000 metres via SMS ....................................................................... 266
6.11.3.5 History for combined conditions .................................................................................................. 266
6.11.3.5.1 Time based history entries .................................................................................................... 267
6.11.3.5.2 Time and distance based history entries ............................................................................... 267
6.11.3.6 TCP storage ................................................................................................................................ 267
6.11.3.6.1 Send special device information to server periodically .........................................................267
6.11.4 Special consideration when using firmware features ............................................... 268
6.11.4.1 Using commands inside alarms .................................................................................................. 268
6.11.4.2 SMS send ................................................................................................................................... 269
6.11.4.3 CSD send .................................................................................................................................... 269
6.11.4.4 Storing information to non volatile memory .................................................................................269
6.12 ISP, GPRS configuration parameters of German service providers ...................... 269
6.13 Used abbreviations ......................................................................................................270
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 9 of 271
Page 10
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
Version history:
Version Author Changes Change date
1.0.0 F. Beqiri - Initial version based on the firmware revision 2.4.0 29/05/2007
1.0.1 F. Beqiri - New firmware revision 2.4.3
- Corrected the range of ring tones from 0..7 to 1..32 and volume from 0..7 to 0..4 – see chapter GSM.VoiceCall.Ringtone.
--Corrected maximal speaker volume see
GSM.VoiceCall.Volume.Speaker=<n_gain>,<volume>,<sidetone>.
- Added new command IO.Vibration=<config_type>.
- Added new con figuration parameter DISP.TZ - Converts from time-zone name to
local time.
13/09/2007
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 10 of 271
Page 11
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
Cautions
Information furnished herein by FALCOM is accurate and reliable. However, no responsibility is assumed for its use.
Please, read carefully the safety precautions. If you have any technical questions regarding this document or the product
described in it, please contact your vendor. General information about FALCOM and its range of products are available at
the following Internet address: http://www.falcom.de/
Trademarks
Some mentioned products are registered trademarks of their respective companies.
Copyright
This document is copyrighted by FALCOM WIRELESS COMMUNICATIONS GmbH with all rights reserved. No part of this documentation may be produced in any form without the prior written permission of FALCOM WIRELESS COMMUNICATIONS GmbH.
FALCOM WIRELESS COMMUNICATIONS GmbH.
No patent liability is assumed with respect to the use of the information contained herein.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 11 of 271
Page 12
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -

1 INTRODUCTION

THIS IS PRELIMINARY DOCUMENTATION AND IS SUBJECT TO CHANGE.
This document represents the description of the firmware version 2.4.0 and later and the supported Configuration Command Set for the FALCOM MAMBOII as well.
FALCOM firmware has been developed to accommodate a wide variety of applications, but it is often necessary to change firmware parameters in order to customize devices for customer applications.
Before using the MAMBOII or upgrading to a new firmware version, please, read the latest product information, see related documents item [1].
Table of Contents (TOC) or PDF bookmarks above will help you locate the chapter/section you need.
Square brackets denote optional settings that may be specified or not.

1.1 About this document

Due to the large size of this document and its huge information, it has been separated into 6 chapters. Each chapter includes a brief description to help you find the needed information quickly. Throughout the document uses the hypertext links (shown in blue text) enabling to navigate the chapters/sections or set parameter description.
The document is separated into the following chapters:
Chapter 2General” presents the firmware’s basic benefits, lists key features
and describes the principle of its operation. Figuratively are represented the general system requirements for each access method. It also provides a brief overview of the TCP/IP protocol.
Chapter 3Command syntax, PFAL Commands and supported parameters– for FALCOM
M represents the structure of input commands which can be directly
transmitted to the MAMBOII unit via Bluetooth, TCP connection and SMS. Commands are executed (as an action), when the set conditions are met. A detailed description of the PFAL commands and supported parameters is also given. Default values and example commands are listed after each command description. It also includes the steps for creation of applications, how to specify the alarms on the MAMBOII device and the configuration possibilities by using a range of events, states and actions. Each category of events and states is described separately. The differences between Events and States are also given. It also describes, how many possible combinations can be made, what happens when raised events and states are called by an application.
Chapter 4, “How to test the Falcom MAMBOII using firmware 2.4. describes how to
transfer the input messages, how to test and evaluate the MAMBOII Unit. How to load a simple configuration into the MAMBOII, how to connect a Keyfob / I/O-BOX / Bluetooth headset to the MAMBOII, how to set the LEDs when events occur and how to configure the Buttons to release alarms/actions when notifications are needed. It also describes how to communicate remotely (online) with the MAMBOII device via a TCP-server.
Chapter 5 „How to send SMS message to the MAMBOII device” presents how SMS
messages can be sent to the MAMBOII device. More precisely, how to configure the MAMBOII device via SMS.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 12 of 271
Page 13
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
Chapter 6 “Appendix” represents the supported character set, the default
setting of the released firmware, the supported output protocols (NMEA and other messages) and alarm configuration examples etc.

1.1 Related documents

Some others PDF documents such as FCC approval, application notes, Certificate of Conformity R&TTE etc. are also available on the Web at: http://www.falcom.de/ in the published download area.
In addition to this document, the following files comprise the full set of FALCOM MAMBOII product manuals:
NR PDF file name Description
[1] MAMBO_II_hardware_manual.pdf Contains information about the hardware features and technical
details.
[2] MAMBO_II_getting_started.pdf Contains an introduction how to get started with MAMBOII device,
how do the software and hardware operate, factory preloaded configuration settings.
[3] MAMBO_II_software_update.pdf Contains information how to upgrade the MAMBOII device to a new
firmware version locally via Bluetooth.
[4] AppNotes_Transform_history_data.pdf Contains information of how to transform history data that are being
transmitted from MAMBOII via TCP connection.
[5] AppNote_Remote_update.pdf Contains information of how to upgrade the MAMBOII device to a
new firmware revision remotely via TCP.
These PDF files are viewable and printable from Adobe Reader. If you do not have the Adobe Reader installed, you can download it from http://www.adobe.com .
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 13 of 271
Page 14
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -

2 GENERAL

The MAMBOII operating with firmware version 2.4.0 and later (using eCos operating system) offers a speedy development of system solutions within the fields of:
Fleet management with GPS-location
vehicle security
Web based client-server applications (built-in TCP-IP and PPP stack internet
capable protocols)
Real-time navigation
and many others …

2.1 Features of the Firmware

The internal operating firmware (using eCos operating system) of MAMBOII unit is a fundamental component, which in combination with the excellent hardware performance makes the MAMBOII device to be the best application where the personal security and fleet management today are required. It is an application designed to be deployed in the field of fleet management and specifically designed and developed for personal tracking and security.
The firmware 2.4.x offers a range of benefits:
Advanced to work in different modes (GSM and GPRS/TCP, Bluetooth, WLAN
communications),
Allows full Internet access over GPRS,Advantages in terms of cost and speed, with low costs option for Web- based client-
server applications (always on-line - pay only for the data you send or receive),
Remote configuration and communication over GSM and TCP, more specifically; SMS
message or TCP packet generation, voice & data calls,
Remote firmware upgrades (it is implemented, but it is not tested yet),Supports up to four different power saving features (four different sleep modes), Automatically switching between GSM and TCP working modes,Automatically connecting/disconnecting to/from the remote services (GPRS network &
/TCP server),
Buffers all GPS positions* in case the TCP connection drops out,Operator re-selection when the GSM cell offers no GPRS services
(GSM.OPERATOR.SELECTION parameter configuration-dependent).
Redirects commands and messages from one communication channel to another
one,
Tracks down the initialization/execution of firmware, monitors runtime errors from
different communication interfaces (Locally, GSM and TCP),
Locates vehicle position by GPS (collects information from vehicle and transfers it to
the control center both on demand and at regular intervals via SMS and TCP for vehicle tracking and recovery)
Locates and tracks vehicles equipped with MAMBOII on-line using WebMap from
Internet,
Controls the speed of vehicleIn a short time interval individual or multiple units can be tracked at any time or
location,
Supports simple to complex alarm settings, Supports vibration alert when receiving a call,
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 14 of 271
Page 15
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
Supports up to 32 different beep tones,Controls up to 6 IEEE devices (KeyFob & I/O-BOX) and handles all events that are
fired on such devices.
Provides GPS data for real-time navigation via Bluetooth wireless communication,Designed to transfer a high-quality audio stream wirelessly (provides the Bluetooth Audio
Gateway Service to support the Bluetooth Headset and the Hands-Free-wirelessly receiving and placing GSM voice calls.
Flexible system configuration (up to 100 flexible and various alarms with logical AND
[&] or OR [?] conjunction possible),
Supports a wide range of states and events for a global set of your alarm system,Supports a wide range of actions to be executed in case the events raise and states
change,
Alarms can be executed directly from the MAMBOII's display.Supports detecting of the button changes in different interval of time,Up to 20 TIMERs available - TIMERs properties and their configuration methods affect
the functionality to activate events handler and execute actions at regular interval,
Up to 20 TRIGGERs implemented to execute and start various actions to a particular
time,
Up to 20 COUNTER implemented to limit the number of actions executed
automatically,
Up to 20 MACROs enabling execution of up to 50 alarms/commands at once.Up to 10 user predefined events intended for other alarm execution.History function (records, stores GPS position data in the on-board FLASH memory
and replays vehicle activity, route verification),
Supports downloading of all or a part of the history stored data via TCP or Bluetooth,Supports clearing of all history stored records, Geo-fencing functionality, setup to 100 Geofencing zones within up to 32 areas with
inside/outside features (reporting when pre-defined geo-fence zones are entered/left, a specific route is deviated off or a country is left; territory management, route verification, arrival/departure notification, prohibited locations, unauthorized movement, and more).
*)
The firmware contains a TCP buffer. Thus the GPS position data can be internally stored in case the connection to the services will be dropped out (e.g. bad GSM coverage). Once the connection is re-established, the stored data will be sent directly to the used remote server. Following a short overview, how many packets (data) can internally be buffered:
binary RMC: approx. 1800 (packets) RMC+GPIO: approx. 400 (packets) GGA,GSA,GSV,RMC,GLL,VTG,GPIO,GSM: approx. 80 (packets)
All aforementioned feature events can be controlled and GPS position can be received by means of any GSM phone or any workstation, which has access to the used remote server. You can easily perform configuration and feature changes either via Bluetooth connection or via a TCP-connection.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 15 of 271
Page 16
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -

2.2 The principle of firmware operation

The integration of the MAMBOII operating with firmware version 2.4.0 in the field mentioned in chapter 2, page 14, requires the following elements:
1. MAMBOII Unit(s)
2. A SIM card for Voice and/or DATA and /or GPRS
3. GPRS settings (provided by your provider)
4. TCP settings (from the setup Web Server in your network)
5. Remote Server (the setup Server for Web applications)
6. User (Personal Computer connected to the remote Server)
The illustration below represents the interfaces that the MAMBOII uses to access the Remote Server via GPRS Network. In addition, it shows that TCP communication enables the MAMBOII device to be monitored/tracked online from your PC via the Internet services.
Figure 1: Interfaces that the firmware uses to access the Remote Server via GPRS Network
The principle of system operation is very simple. Each object is equipped with a MAMBOII device, which consists of:
an integrated GPS-receiver with internal active antenna for reception of signals
from GPS satellite system,
a GSM/GPRS-modem with internal antenna for transmission of these GPS data by
radio.
A Bluetooth transceiver with internal antenna to enable wireless data
connectivity to a PC, PDA, Mobile phone etc. for sending/receiving the GPS data and input commands.
A Bluetooth Audio Gateway to enable wireless audio connectivity to a Bluetooth
headset.
The GPS receiver uses the satellites data to calculate the exact position of the vehicle (object) fitted with MAMBOII unit. The GPS data received from the MAMBOII unit can be transferred through the GPRS network (IP-based) and the Internet to your remote server for online purposes. A user-developed program installed on the remote server, can help you to connect to the vehicles equipped with MAMBOII units.
For such purposes, at first the MAMBOII device must be locally configured (with the help
of any terminal program or FALCOM Workbench software – a developed program to
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 16 of 271
Page 17
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
help you configure and evaluate FALCOM devices). All MAMBOII devices are pre­configured to work with the default settings. So all default settings must be changed and adapted to your application conditions (including: GPRS settings of your provider, the remote server settings and the PIN of the used SIM card - see chapter 3.2.2.1 in this manual). When the configuration of the MAMBOII is done, it tries to register itself into the GSM network. Once it is successfully registered into the GSM network, it can start automatically to establish a GPRS connection (depending on the GPRS configuration – see chapter 3.2.21) and by means of TCP settings (see chapter 3.2.23) a TCP connection to the remote server.
Once the MAMBOII is attached to the GPRS network over the Basis Station, temporary a dynamic IP-address will be allocated by the MAMBOII device from the GPRS network. With the help of the IP-address that constantly changes, the GPRS network enables MAMBOII device to perform a TCP connection to the used remote server (to the specified IP address and Port number). By means of these IP addresses as object identifiers, all MAMBOII device can be direct configured from the remote server.
Such online applications enable you tracking and monitoring in a short time several 100 vehicles (objects) equipped with a MAMBOII device.
Furthermore, the data transmitted from MAMBOII device is received in real time. The MAMBOII device can be programmed so that the vehicle location and additional information will be received not only via a TCP server, but also via SMS.
The operating firmware 2.4.0 and later offers a rich set of events, states and commands that you can use to customize high-performance web solutions. The solution architecture varies with the type of application you decide to create.
Depending on the configuration settings that is loaded on the device, the MAMBOII is capable of using up to three different system solutions:
GSM This system solution supports SMS, Voice call and Data call. Using only these
features you are able a speedy development of communication services, which do not require GPRS and TCP configurations. The configuration of both services (GPRS/TCP) can be in such case disabled. To control your MAMBOII device you can send via SMS all commands given in this document. Also via SMS you will be notified when an alarm is triggered in the MAMBOII device. To use SMS services, users need a subscription to a mobile network that supports it, and the use of SMS must be enabled for that user. The user needs to have a phone number for the MAMBOII device or a SMS server to send a short message to, or receive a message from. On the SMS server side, you can install several solutions to enable receiving of SMS messages or forwarding them to other systems. Finally, the user also needs a mobile phone that supports SMS and knowledge of how to send or read a short message (command or responses).
GPRS/Internet The MAMBOII device supports TCP/IP application, an Internet based
application that allows access via the World Wide Web (www). Since the Internet is just a medium for computers to "talk" to each other, it enables you to track, message or monitor the MAMBOII units at almost any PC in any location around the world (see figure above). The presence of the remote server is an essential prerequisite, which is needed to log in the MAMBOII units to the used remote server. A computer (PC client) connected to the Internet with the pre-installed standard web browser is also necessary (see chapter
2.3, page 18). To be able to monitor and control such systems solutions both
GSM and GPRS/TCP configuration settings have to be done. MAMBOII is able to contact you via E-mail – in this case you have to configure SMTP services, too.
Real-Time Navigation MAMBOII is also a high-capacity navigation system, which
connects your Bluetooth™-enabled device with the performance of an intelligent and dynamic destination guidance. The Bluetooth feature for
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 17 of 271
Page 18
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
MAMBOII supports a communication technology that allows devices within a 10-meter proximity to communicate with each other without physical cables. MAMBOII in communication with your installed GPS Mapping software on the Bluetooth™-enabled device points you the way comfortably and reliably from the current location A to your desired destination B. In this way you always stay for longer distances on the optimal course, arrive your destination point comfortable and ease.

2.3 Internet and intranet applications setup with MAMBOII

2.3.1 Internet based applications

To control and monitor the MAMBOII device, as well as to set and poll configuration remotely from your client PC over Internet, user developed programs must be available. A client PC requests a server PC to perform actions. Since the Internet is just a medium for computers to "talk" to each other, it enables you to perform applications. If such an Internet solution is required to perform your applications, you can write a simple chat program in a programming language to exchange text messages between a client and server. You might be familiar with such programs as they are often used in on-line chat rooms. You will write two programs (one running on the client PC, the other on the server PC) resulting in a teletype-like application; you and a friend can type messages to each other over the Internet. Understanding how these two programs work might help you in developing programs to control hardware devices over the Internet. The FALCOM Company does not provide for users any source code for such applications.
Figure 2: Internet applications setup with MAMBOII
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 18 of 271
Page 19
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -

2.3.2 Intranet applications

Figure below represents the client PC and server PC communication. However, to exchange text messages (TCP packets) between server and MAMBOII device a program developed by the user must be available and already installed on the remote server. The user sends a request to the remote server via the client PC. The user­developed program installed on the remote server receives the message from the client PC and automatically sends it in the correct format to the connected MAMBOII device. The MAMBOII device responses the remote server. The remote server returns the requested information back to the client PC with help of the installed program. The FALCOM does not provide any source code for such programs.
Figure 3: Intranet applications setup with MAMBOII

2.4 TCP/IP Overview

The MAMBOII represents over TCP/IP stack contained in the firmware 2.4.0 a kind of serial communication.
TCP (Transmission Control Protocol) is the most widely used transport protocol for non­real-time Internet applications like www, e-mail. It provides a connection-oriented end­to-end service ensuring the reliable transfer of data.
As with all other communication protocols, TCP/IP is composed of following layers:
IP is responsible for moving packet of data from node to node. IP forwards
each packet based on a four-byte destination address (the IP number). IP operates on gateway machines that move data from department to organization to region and then around the world.
TCP is responsible for verifying the correct delivery of data from client to server.
Data can be lost in the intermediate network. TCP adds support to detect errors or lost data and to trigger retransmission until the data is correctly and completely received.
PORT is a name given to the package of subroutines that provide access to
TCP/IP on most system.

2.5 IEEE 802.15.4 Overview

IEEE 802.14.4 is an industry standard set of specifications for WLANs developed by the Institute of Electrical and Electronics Engineers (IEEE). IEEE 802.14.4 defines the physical layer and media access control (MAC) sub-layer for wireless communications.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 19 of 271
Page 20
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3 COMMAND SYNTAX, PFAL COMMANDS AND
SUPPORTED PARAMETERS– FOR FALCOM MAMBOII

3.1 PFAL Command syntax and response message structure

3.1.1 Command syntax of PFAL commands

The input messages provided in the next section can be sent to the target device locally via Bluetooth connection with the help of any terminal program, remotely via SMS or remotely via a TCP connection with the help of a remote server.
Each PFAL message containing the command <cmd> is distinguished as alone caption. Within a chapter you will find a table divided in two rows.
The first row indicates the Command syntax, which could not be sent to the
device in that form. Within the Command syntax there are invalid characters such as “<”, “>” and assigned name, which are used to show the Command syntax, only.
The second row shows the example(s) how the message(s) can be sent to the
MAMBOII device. The set parameters in those examples depend on the user conditions. All examples can be modified and adapted to the user requirements.
The PFAL messages have the following formats, and in one of these formats the MAMBOII device will accept the user sent messages:
Header Command Parameter Checksum End Sequence
$PFAL <cmd> <parameter> <*CKSUM> <CR><LF> $PFAL <cmd> <parameter> none <CR><LF> PFAL <cmd> <parameter> <*CKSUM> <CR><LF> PFAL <cmd> <parameter> none <CR><LF>
Table 1: PFAL command syntaxes.
[$]*PFAL The [$]PFAL is message header. <cmd> The <cmd> determines the command(s) to be specified/executed. To
specify/execute a <cmd> command, throughout the document are used so-called <c_type> (type) and <c_index> (index) and <c_subindex> (subindex). Other to say, a command type is sorted by an index, while the command index may be limited by a subindex (only if the index supports any subindex). The index changes according to the user-specified command type, while the subindex changes according to the user­specified command type and index. The command type, index and subindex are separated by dots [“.” character]. The command index may include a value; in this case no subindex is supported. Also the subindex may include a value. According to this explanation, the improved syntax to specify the <cmd> command is:
<c_type>.<c_index>.<c_subindex> or <c_type>.<c_index>=<value or <c_type>.<c_index>.<c_subindex>=<value>
Combining the <cmd> commands on the same input message line is now allowed. If more then one <cmd> command is set on the same command line, they should be separated by semi-colon “;”. The double quotes have to be omitted when you enter the semi-colon. Note that, the maximal
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 20 of 271
Page 21
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
length of <cmd> commands is limited to 1500 characters. The common syntax in this case is:
<cmd_1>;<cmd_2>;<cmd_3>….<cmd_n>
<parameter> The <parameter> can contain different valid parameters supported
by the MAMBOII firmware. In some PFAL commands the <parameter> entry is omitted. However, the specified parameter depends on the defined <cmd> command. Some parameters do not require any value, so it will be left empty. According to this explanation, the improved syntax to specify the
<parameter> is:
<parameter>=<value>
[<*CKSUM>]* If the checksum <*CKSUM> is used, it consists of an asterisk “*”
character (without double quotes) followed by two hex values. In order to calculate the Checksum, use your own application. Below a small source code written in Visual Basic:
//***************************************** Public Sub CheckSum(field As String) If field = “” then CS = “*” CS = 0 For i = 1 to Len(field) CS = CS Xor Asc(Mid$(field, i, 1)) Next CS = Hex(CS) If Len(CS) =1 then CS = “0” & CS CS = “*” & CS END SUB //*****************************************
Therefore, the string over which the checksum has to be calculated is:
field = PFAL,<cmd>,<parameter>
excluding “$”character. The “CS” variable in the CheckSum procedure must be declared as a global variable.
[<CRLF>]** Carriage Return plus Line Feed (ASCII CODE #13#10 (without any spaces) -
hexadecimal: 0x0D 0x0A)
According to the explanations above, the improved syntax to specify a PFAL command is:
$PFAL,<c_type>.<c_index>.<c_subindex>,<parameter>=<value><*CKSUM><CR><LF>
or
$PFAL,<c_type>.<c_index>.<c_subindex>,<parameter>=<value><CR><LF>
or
PFAL,<c_type>.<c_index>.<c_subindex>,<parameter>=<value><*CKSUM><CR><LF>
or
PFAL,<c_type>.<c_index>.<c_subindex>,<parameter>=<value><CR><LF>
For example:
1) $PFAL,SYS.Device.Reset*31<CR><LF>
2) $PFAL,Sys.Trigger5<CR><LF>
3) $PFAL,IO.Beep3=hpulse,1000 <CR><LF>
4) $PFAL,IO.Vibration=hpulse,5000;MSG.Send.Serial,0,”Phone is vibrating“<CR><LF>
5) $PFAL,Sys.Timer0.Start=single,5000<CR><LF>
6) $PFAL,Cnf.Set,DEVICE.NAME=”myMAMBOII”<CR><LF>
7) $PFAL,Cnf.Set,AL0=IO.BTN.e0=short:IO.Beep3=hpulse,1000<CR><LF>
*
Optional
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 21 of 271
Page 22
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
The example 6 above signifies that the device name is specified to “myMAMBOII”. The example 7 above signifies that the MAMBO II will beep, when left button (BTN0) is
short-pressed.
3.1.1.1 Command types <c_type>
It is used to separate the huge amount of commands to different types. Currently the following command types are available.
<c_type> Definition
Sys
Accomplishes a predefined set of system tasks such as: System management tasks, including:
- Reset,
- Shutdown/power management etc.
Initialization/interruption of system processes, including:
- Timers,
- Counters etc.
Cnf
The operating firmware provides parameters that can be set/changed or read. Based on the parameter-settings some events will be occurred.
IO
Accomplishes a predefined set of system peripheral commands allowing access to the LEDs, Beep tones generation and Vibrating alerts.
GPS
Accomplishes a predefined set of GPS tasks including navigation, history logging and geo-fences and areas.
GSM
Accomplishes a predefined set of GSM tasks including SMS, voice and data calls, GPRS services etc.
TCP
Accomplishes a predefined set of TCP connection tasks including connecting disconnecting and sending of TCP packets to the predefined address of remote server etc.
MSG
Accomplishes a predefined set of output messages (GPS protocols) allowing information to be transmitted across the serial interface, CSD network or Internet (TCP).
IEEE
Accomplishes a predefined set of IEEE tasks on the device as well as provides parameters to connect the IEEE devices (Keyfob + I/O-BOX) to the MAMBOII.
Table 2: Supported command types <c_type>.

3.1.2 Aliases

This PFAL command specifies the alias names for all available <c_type>, <c_index>, <c_subindex>.
Following aliases are defined as default:
Sys is the alias name of System Cfg is the alias name of Config
if an alias has been specified, it can be freely used instead of the original word (or number). To specify alias names, please refer to the chapter 3.2.17.1 page 172.
Notes
To avoid misinterpretation about using alias names, please assure that no
equal or very similar aliases are used inside the same command type/index.
Also avoid starting of alias with numbers as they might be misinterpreted as
original index numbers.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 22 of 271
Page 23
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -

3.1.3 Using identifiers (optional)

Syntax1
-$PFAL:id<idtxt>,<commands>*<CS><CRLF>
Syntax2
-$PFAL:id<idtxt>,<commands><CRLF>
Syntax3
-PFAL:id<idtxt>,<commands>*<CS><CRLF>
Syntax4
-PFAL:id<idtxt>,<commands><CRLF>
Table 3: Identifier syntaxes
<idtxt> It can specify an optional text, which may not contain a comma (,).
The specified case sensitive text will be sent back within the corresponding PFAL response.
<commands> one or more device commands (see „command structure“ for
details)
<CS> The NMEA Checksum (see description of the checksum in chapter
3.1.1)
<CRLF> Carriage Return Line Feed (ASCII CODE 13 10 (without any spaces) -
hexadecimal: 0x0D 0x0A)

3.1.4 Response command structure

A configuration report is presented in text format, which includes the parameters listed in the table below.
Types of response message:
Respond message type if a PFAL command contains just one command.
Responses structure
Example $PFAL,Cnf.Set,DEVICE.NAME=myMAMBOII<CRLF>
Read commands
$<cmd><CR><LF> $report of executed parameter<CR><LF> $SUCCESS or $ERROR<CR><LF> $<end>
Example 1
$<Cnf.Get> $NAME=my MAMBOII $SUCCESS $<end>
Execution commands
$<cmd><CR><LF> $ report of executed parameter<CR><LF> $SUCCESS or $ERROR<CR><LF> $<end>
Example 2
$<Cnf.Set> $NAME written to flash $SUCCESS $<end>
Respond message type if a PFAL command contains several commands.
Responses structure
Example $PFAL,Sys.Trigger0;Sys.Trigger5<CRLF>
Read commands
$<Sys.Trigger0><CR><LF> $Trigger0=high<CR><LF> $<Sys.Trigger5><CR><LF> $Trigger5=low<CR><LF> $SUCCESS<CR><LF> $<end><CR><LF>
Respond message type if identifiers are used.
Responses structure
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 23 of 271
Page 24
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
Example PFAL:id001,Sys.Trigger0<CRLF>
Read commands
$<Sys.Trigger0><CR><LF> $Trigger0=high <CR><LF> $SUCCESS<CR><LF> $<end:001><CR><LF>
Table 4: Response messages structure.
Note
In case the first command fails (i.e. used wrong syntax or it cannot be
correctly executed), the execution stops at this command and system will respond an error.
If identifiers are submitted within PFAL commands, they will be sent back
inside the PFAL responses.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 24 of 271
Page 25
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -

3.2 PFAL Commands

The following table provides a complete list of the PFAL commands used to manage/administrate different parts of an application built on the MAMBOII system.
Please note that, the PFAL commands listed in the table below could not be sent to the target device in that form. Information about each command can be found on the respective reference chapter and page. Use the hypertext links (shown in blue text) to navigate the chapter/sections. Each chapter describes the tasks each command performs, how command settings can be defined etc.
Please note that, only straight double quotation marks (" ") should be used within PFAL commands, configuration parameters, etc. As this documentation has been created using Microsoft Word, some straight quotation marks might have been transformed to the right and left smart (curly) quotation marks, which won't be accepted by the device.
PFAL COMMAND SET MEANING Chapter
System commands
$PFAL,Sys.Security.Lock,”password Locks the system 3.2.1.1.1
$PFAL,Sys.Security.Unlock,”password Unlocks the system 3.2.1.1.2
$PFAL,Sys.Security.RemoveLock,”password Removes the system lock 3.2.1.1.3
$PFAL,Sys.RUpdate.Init Selects the sectors to be updated 3.2.1.2.1
$PFAL,Sys.RUpdate.DataMode Selects the blocks within sectors to be updated 3.2.1.2.2
$PFAL,Sys.RUpdate.Finish
Blocks sending of PFAL commands through the selected communication mode
3.2.1.2.3
$PFAL,Sys.Device.Reset Resets the system 3.2.1.3.1
$PFAL,Sys.Device.Update Resets the system into the update mode. 3.2.1.3.2
$PFAL,Sys.Device.Shutdown Shuts down the system 3.2.1.3.3
$PFAL,Sys.Device.FactoryReset Resets the user configuration to default settings. 3.2.1.3.4
$PFAL,Sys.Device.Sleep=<value>
Sets the system into the sleep mode until one of the set signals detected
3.2.1.3.5
$PFAL,Sys.Device.ClearAlarm
Clears the user alarm settings and restarts the system
3.2.1.3.6
$PFAL,Sys.Device.ClearConfig
Clears the user configuration settings and restarts the system
3.2.1.3.7
$PFAL,Sys.Device.CfgUpdateMode
Enters the system into a special configuration update mode to change the alarm configurations.
3.2.1.3.8
$PFAL,Sys.Timer<index>.Configure=<mode>,<timeout> Configures a system timer 3.2.1.4.1
$PFAL,Sys.Timer<index>.Start=<timer_settings> Starts/restarts a system timer 3.2.1.4.2
$PFAL,Sys.Timer<index>.Stop Stops a running timer 3.2.1.4.3
$PFAL,Sys.Timer<index>.Pause Pauses (suspends) a running timer 3.2.1.4.4
$PFAL,Sys.Timer<index>.Resume Restarts the execution of a paused timer 3.2.1.4.5
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 25 of 271
Page 26
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
PFAL COMMAND SET MEANING Chapter
$PFAL,Sys.Timer<index>.Arm Arms an initialized and disarmed timer 3.2.1.4.6
$PFAL,Sys.Timer<index>.Disarm Disarms an initialized and armed timer 3.2.1.4.7
$PFAL,Sys.Timer<index>.Erase Erases the configuration of a timer 3.2.1.4.8
$PFAL,Sys.Timer<index>.Save<storage_index> Saves a timer state to a storage index 3.2.1.4.9
$PFAL,Sys.Timer<index>.Load<storage_index> Loads the saved timer state from a storage index 3.2.1.4.10
$PFAL,Sys.Timer<index>.State Reads the state of a used timer 3.2.1.4.11
$PFAL,Sys.Trigger<index>=<state_type> Activates/deactivates a system trigger 3.2.1.5.1
$PFAL,Sys.Trigger<index> Retrieves the current trigger state 3.2.1.5.2
$PFAL,Sys.Trigger<index>.Save<storage_index> Saves the state of trigger to a storage index 3.2.1.5.3
$PFAL,Sys.Trigger<index>.Load<storage_index> Loads a saved trigger from a storage index 3.2.1.5.4
$PFAL,Sys.Counter<index>.Set=<value> Sets the value of a counter 3.2.1.6.1
$PFAL,Sys.Counter<index>.Increment=<inc_value> Increments the value of a counter 3.2.1.6.2
$PFAL,Sys.Counter<index>.Decrement=<dec_value> Decrements the value of a counter 3.2.1.6.3
$PFAL,Sys. Counter<index>.State Retrieves the state of a used counter 3.2.1.6.4
$PFAL,Sys.Counter<index>.Save<storage_index> Saves the state of the counter to a storage index 3.2.1.6.5
$PFAL,Sys.Counter<index>.Load<storage_index> Loads a saved counter from a storage index 3.2.1.6.6
$PFAL,Sys. Counter<index>.Clear Sets a specified counter to 0 3.2.1.6.7
$PFAL,Sys.Macro<index> Activates a configured macro 3.2.1.7.1
$PFAL,Sys.GSM.Enable Powers on the GSM engine 3.2.1.8.1
$PFAL,Sys.GSM.Disable Powers off the GSM engine 3.2.1.8.2
$PFAL,Sys.GSM.Reset Resets the GSM engine 3.2.1.8.3
$PFAL,Sys.GPS.Enable Powers on the GPS engine 3.2.1.9.1
$PFAL,Sys.GPS.Disable Powers off the GPS engine 3.2.1.9.2
$PFAL,Sys.GPS.Reset Resets the GPS engine 3.2.1.9.3
$PFAL,Sys.UserEvent<index>
Creates a user-event for specific application requirements
3.2.1.10.1
$PFAL,Sys.Bat.Voltage Queries the battery voltage. 3.2.1.11.1
$PFAL,Sys.Bat.ChargeState
Query whether the internal battery is currently charging.
3.2.1.11.2
$PFAL,Sys.BT.Enable Powers on Bluetooth module 3.2.1.12.1
$PFAL,Sys.BT.Disable Powers off Bluetooth module 3.2.1.12.2
$PFAL,Sys.BT.Reset Resets Bluetooth module 3.2.1.12.3
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 26 of 271
Page 27
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
PFAL COMMAND SET MEANING Chapter
$PFAL,Sys.CPU.Reset
Resets main controller and set system into the firmware update mode.
3.2.1.13.1
$PFAL,Sys.IEEE.Enable Powers on IEEE module 3.2.1.14.1
$PFAL,Sys.IEEE.Disable Powers off IEEE module 3.2.1.14.2
$PFAL,Sys.IEEE.Reset Resets IEEE module. 3.2.1.14.3
DISPLAY commands
$PFAL,Display.Show=<view>
Shows a specific view on the screen. 3.2.1.15.1
$PFAL,Display.Dialog=<id>,<”caption”>,<icon>,<tim
eout>,<”left-option”>,<”right-option”>,<”text”>
Creates and displays a dialog box on the screen. 3.2.1.15.2
$PFAL,Display.Alarm=<image>,<timeout>,<”text”>
Displays a specific alarm icon on the screen 3.2.1.15.3
CNF Configuration commands
$PFAL,Cnf.Set,<parameter_name=value> Sets up or changes device configuration settings 3.2.2.1
$PFAL,Cnf.Get,<parameter_name>
Retrieves configuration settings of the set parameter name
3.2.2.2
$PFAL,Cnf.Clear,<parameter_name>
Clears the configuration settings of the set parameter name
3.2.2.3
$PFAL,Cnf.ShowUser Retrieves user settings 3.2.2.4
$PFAL,Cnf.ShowDefault Retrieves default settings 3.2.2.5
$PFAL,Cnf.Show Retrieves settings of all used parameters 3.2.2.6
$PFAL,Cnf.Search,<parameter_name> Searches for a parameter name (text type) 3.2.2.7
IO commands
$PFAL,IO.Beep<index>=<config_type> Generates beep tones 3.2.3.1.1
$PFAL,IO.Vibration=<config_type> Manages device vibrations 3.2.3.2.1
GPS commands
$PFAL,GPS.Nav.Position<buffer_index>
Retrieves the distance of the device from a stored location
3.2.4.1.1
$PFAL,GPS.Nav.Position<buffer_index>=<type> Saves temporarily a device location 3.2.4.1.2
$PFAL,GPS.Nav.Position<buffer_index>=save<storage_in
dex>
Moves the GPS data from the buffer and stores it to a storage index
3.2.4.1.3
$PFAL,GPS.Nav.Position<buffer_index>=load<storage_ind
ex>
Loads the GPS data from storage to buffer index for temporarily use
3.2.4.1.4
$PFAL,GPS.Nav.Distance Retrieves the distance from a start point 3.2.4.1.5
$PFAL,GPS.Nav.Distance=<value> Sets/resets the distance to a user defined value 3.2.4.1.6
$PFAL,GPS.Nav.SaveLastValid Saves last valid position. 3.2.4.1.7
$PFAL,GPS.Nav.PowerSave=<on>,<onTime>,<lpTime>
Enables/Disables the low power mode of GPS receiver.
3.2.4.1.8
$PFAL,GPS.History.Write,<add_prot_to_memory>,<”text”>
Records a GPS position data into the history memory
3.2.4.2.1
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 27 of 271
Page 28
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
PFAL COMMAND SET MEANING Chapter
$PFAL,GPS.History.Clear Clears the history memory space 3.2.4.2.2
$PFAL,GPS.History.GetStart
Retrieves the oldest date stored in the history memory
3.2.4.2.3
$PFAL,GPS.History.SetRead,<s_date>,<s_time>­<e_date>,<e_time>
Selects the number of records from the history memory to be downloaded
3.2.4.2.4
$PFAL,GPS.History.Read
Downloads the selected records from the history memory
3.2.4.2.5
$PFAL,GPS.History.Push Downloads the selected history records at once 3.2.4.2.6
$PFAL,GPS.Geofence.Park.Set
Places/activates a virtual circular fence around vehicle (Park area)
3.2.4.3.1
$PFAL,GPS.Geofence.Park.Remove Disables an activated park area 3.2.4.3.2
$PFAL,GPS.Geofence.GeoState,<geo_id> Retrieves the state of a defined geo-fence 3.2.4.3.3
$PFAL,GPS.Geofence.AreaState,<area_id> Retrieves the state of a defined area 3.2.4.3.4
GSM commands
$PFAL,GSM.PIN=<”pin”> Enters the PIN number of the used SIM card 3.2.5.1.1
$PFAL,GSM.PUK=<”puk”>,<”pin”> Enters the PUK and PIN numbers 3.2.5.1.2
$PFAL,GSM.IMEI
Retrieves the serial identification number of the product
3.2.5.1.3
$PFAL,GSM.SIMID Retrieves the ID of SIM Card 3.2.5.1.4
$PFAL,GSM.OwnNumber Retrieves the caller's phone number 3.2.5.1.5
$PFAL,GSM.Balance
Retrieves the account information of the used SIM card
3.2.5.1.6
$PFAL,GSM.VoiceCall.Dial,< “p_number“> Performs a GSM Voice call 3.2.5.2.1
$PFAL,GSM.VoiceCall.Accept Accepts an incoming voice call 3.2.5.2.2
$PFAL,GSM.VoiceCall.Hangup Hangs-up an active voice call 3.2.5.2.3
$PFAL,GSM.VoiceCall.Audio.Profile=<audio_index> Sets the active audio profile 3.2.5.2.4
$PFAL,GSM.VoiceCall.Ringtone=<type>,<volume> Sets or retrieves the ring tone settings 3.2.5.2.5
$PFAL,GSM.VoiceCall.Volume.Speaker=<n_gain>,<volume >,<sidetone>
Sets or retrieves the loudspeaker settings 3.2.5.2.6
$PFAL,GSM.VoiceCall.Volume.Microphone=<gain>,<n_gai
n>
Sets or retrieves the microphone settings 3.2.5.2.7
$PFAL,GSM.SMS.Send,<”p_number“>,<protocols>,<”text”> Sends a SMS to the defined phone number 3.2.5.3.1
$PFAL,GSM.SMS.Inbox.State Retrieves all inbox SMS messages 3.2.5.3.2
$PFAL,GSM.SMS.Inbox.Clear
Clears all inbox SMS messages (SMS memory for incoming messages)
3.2.5.3.3
$PFAL,GSM.SMS.Outbox.State Retrieves all outbox SMS messages 3.2.5.3.4
$PFAL,GSM.SMS.Outbox.Clear
Clears all outbox SMS messages (SMS memory for outgoing messages)
3.2.5.3.5
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 28 of 271
Page 29
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
PFAL COMMAND SET MEANING Chapter
$PFAL,GSM.DataCall.Sent,<protocols>,<”text”>
Sends messages to a GSM modem via an established data call
3.2.5.4.1
$PFAL,GSM.DataCall.Accept Accepts an incoming Data call 3.2.5.4.2
$PFAL,GSM.DataCall.Hangup Hangs-up an active voice call 3.2.5.4.3
$PFAL,GSM.GPRS.Connect Performs a GPRS attach 3.2.5.5.1
$PFAL,GSM.GPRS.Disconnect Performs a GPRS detach 3.2.5.5.2
$PFAL,GSM.GPRS.State Retrieves the GPRS state 3.2.5.5.3
$PFAL,GSM.GPRS.Traffic=<complete>,<incoming>,<outgoi
ng>
Sets or retrieves the GPRS traffic counter 3.2.5.5.4
TCP commands
$PFAL,TCP.Client.Connect Performs a TCP connection to the remote server 3.2.6.1.1
$PFAL,TCP.Client.Send,<protocols>,<”text”>
Sends a TCP packet to the connected remote server
3.2.6.1.2
$PFAL,TCP.Client.State Retrieves the TCP connection state 3.2.6.1.3
$PFAL,TCP.Client.Disconnect
Performs a TCP Disconnection from the connected server
3.2.6.1.4
$PFAL,TCP.Storage.Dispatch
Moves the currently stored information inside the TCP storage to the outgoing TCP buffer
3.2.6.2.1
$PFAL,TCP.Storage.Clear Clears the contents of the created TCP storage 3.2.6.2.2
$PFAL,TCP.Storage.AddProtocol,<protocol>,<”text”>
Writes the specified protocols and/or user text to the TCP storage
3.2.6.2.3
$PFAL,TCP.Storage.AddRecord,<protocol>,<”text”> Appends a binary dataframe to TCP storage 3.2.6.2.4
Communication/ Messaging commands
$PFAL,MSG.Send.Serial,<protocols>,<”text”>
Outputs the selected protocols + additional system information to the serial interface in formatted data structure.
3.2.7.1.1
$PFAL,MSG.Send.RawSerial,<protocols>,<”text”>
Redirects command responses to the serial interface in unformatted data structure
3.2.7.1.2
$PFAL,MSG.Send.CSD,<protocols>,<”text”>
Transmits the selected protocols + additional system information to the connected GSM modem via an established data call.
3.2.7.1.3
$PFAL,MSG.Send.TCP,<protocols>,<”text”>
Transmits the selected protocols + additional system information to the connected TCP server
3.2.7.1.4
$PFAL,MSG.Mode.Serial=<out_sys_messages>,<mode>
Retrieves or forwards the in/out system messages to the selected destination
3.2.7.2.1
$PFAL,MSG.Mode.CSD=<out_sys_messages>,<mode>
Retrieves or forwards the in/out system messages to the selected destination
3.2.7.2.2
$PFAL,MSG.Mode.TCP=<out_sys_messages>,<mode>
Retrieves or forwards the in/out system messages to the selected destination
3.2.7.2.3
$PFAL,MSG.Version.Complete Retrieves all version information of the target device 3.2.7.3.1
$PFAL,MSG.Version.Modules Retrieves the modules versions of the target device 3.2.7.3.2
$PFAL,MSG.Version.InternalComm
Retrieves the internal communication version of the target device
3.2.7.3.3
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 29 of 271
Page 30
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
PFAL COMMAND SET MEANING Chapter
$PFAL,MSG.Version.HardwareRev Retrieves the hardware revision of the PCB 3.2.7.3.4
$PFAL,MSG.Version.Hardware Retrieves the hardware version of the target device 3.2.7.3.5
$PFAL,MSG.Version.Software Retrieves the software version of the target device 3.2.7.3.6
$PFAL,MSG.Version.SoftwareID Retrieves the software ID 3.2.7.3.7
$PFAL,MSG.Info.ServerLogin Identifies the device to the FALCOM’s Server 3.2.7.4.1
$PFAL,MSG.Info.Protocol,<protocols>,<”text”> Transmits the selected protocols to the sender 3.2.7.4.2
$PFAL,MSG.Info.Time Retrieves the current system time 3.2.7.4.3
$PFAL,MSG.Info.Alarm,<alarm_index> Transmits the selected alarm to the sender 3.2.7.4.4
$PFAL,MSG.Channel.SerialGSM
Channels messages from serial port directly to GSM engine
3.2.7.5.1
IEEE commands
$PFAL,IEEE.Keyfob<kf_div_index>.LED<lindex>=<config_t
ype>
Sets and controls LED blinking to a Keyfob 3.2.8.1.1
$PFAL,IEEE.Keyfob<kf_div_index>.Beep=<config_type>
Sets and controls the Beep tones to be generated on a Keyfob.
3.2.8.1.2
$PFAL,IEEE.Keyfob<kf_div_index>.Vibration=<config_type >
Sets the type of vibration alert on a Keyfob 3.2.8.1.3
$PFAL,IEEE.IOBox<ib_div_index>.OUT<oindex>=<config_t
ype>
Configures the outputs on an I/O-BOX 3.2.8.2.1
$PFAL,IEEE.IOBox<ib_div_index>.power=<power_mode> Set the operation mode on an I/O-BOX 3.2.8.2.2
$PFAL,IEEE.IOBox<ib_div_index>.bat.level Gets battery charge state 3.2.8.2.3
Bluetooth-Audio commands
$PFAL,BT.Audio.Bound Pairs Bluetooth audio devices 3.2.9.1.1
$PFAL,BT.Audio.Connect
Places both Bluetooth devices in the connection mod
3.2.9.1.2
$PFAL,BT.Audio.Disconnect Closes a currently open audio connection 3.2.9.1.3
Table 5: Complete list of PFAL commands.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 30 of 271
Page 31
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -

3.2.1 “Sys” command type

3.2.1.1 “Security” command index
The software has built-in locking feature that prevents other users from accessing the system MAMBOII until the Unlock command is executed. The system lock is not released until the last locking password does not match exactly with the unlock password on the same MAMBOII unit. To remove permanently a previously applied lock on a MAMBOII unit, the system has to be unlocked first. If the password authentication fails, the only possibility to recover the password is to read out the firmware via serial port.
An application can use this mechanism for following purposes:
To ensure that system does not answer any user request while the
system lock is held.
to prevent unauthorized users from attempting to change the system
configuration.
3.2.1.1.1 Sys.Security.Lock,”password” – Sends a pasword to lock your system
Command syntax Sys.Security.Lock,<”password”>
Examples $PFAL,Sys.Security.Lock,”12345”
Responses
$security lock installed
Command description
This command restricts other users from being able to use your MAMBOII while you are away (to prevent other users from modifying the system configuration and from executing the system alarms sent via TCP, SMS, CSD or Bluetooth). To unlock the MAMBOII use the command (Sys.Security.Unlock,”password”)
Parameter description
<”password”>
It specifies the password (string type) to lock the system. Password consists of a string with a length up to 50 characters.
Note:
If device iMAMBOII s already locked it responses: $To execute PFAL
commands, first unlock the system with PFAL,SYS.Security.Unlock,<password>
3.2.1.1.2 Sys.Security.Unlock,”password” – Sends a pasword to unlock your system
Command syntax Sys.Security.Unlock,<”password”>
Examples $PFAL,Sys.Security.Unlock,”12345”
Responses
$security unlocked until next restart
Command description
This command allows you to unlock a previously applied lock on a device just for the time the device is running until the next restart. The entered password must correspond with the existing password that is specified for that device when you have locked that device. Unlocking the system enables other users to read/write the configuration and to execute PFAL commands if they know the phone number of the device. No other PFAL command is accepted by the system MAMBOII, if it
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 31 of 271
Page 32
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
stays locked. To remove the password use
$PFAL,Sys.Security.RemoveLock,<”password”>.
Parameter description
<”password”>
It specifies the password (string type) to unlock the system. It consists of a string with a length up to 50 characters.
3.2.1.1.3 Sys.Security.RemoveLock,”password” – Sends a password to remove locking of your system
Command syntax Sys.Security.RemoveLock,<”password”>
Examples $PFAL,Sys.Security.RemoveLock,”12345”
Responses
$security lock removed
OR
$security lock currently inactive
Command description
This command allows you to remove permanently a system lock, if the specified password matches exactly the existing password on the system. To remove permanently an existing password, first unlock the system, then remove it. To change your existing password, first unlock the system than remove the password and finally specify a new password with Sys.Security.Lock,”password.
Parameter description
<”password”>
It specifies the password (string type) to be removed. It consists of a string with a length up to 50 characters. To remove the system lock, the last locking password must be used.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 32 of 271
Page 33
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.1.2 “RUpdate” command index
There are two ways to upgrade the firmware of the MAMBOII, one is upgraded locally by SiRFflash tool and the other is done via wireless connection through Remote server.
The former one is the most common way for customer use and all instructions how to upgrade the firmware locally via a serial connection are available in a separate manual - See related documents [4], in chapter page .
The second one is the most difficult way and it can be implemented only through system integrators. More information is available in a separate manual - see related documents 4], in chapter page .
Except the information found in this document, FALCOM will not offer additional technical support for developing/implementing such web-based solutions.
It is strongly recommended not to use these commands without special care. All commands within this chapter enable to remote upgrade the MAMBOII device to a
new firmware version that is accessible over the Internet. If the MAMBOII device performs a reset during firmware update, use the option Resume
to resume a previous update. The old firmware is replaced by the new one, only when the command “$PFAL,Sys.RUpdate.Finish” completes.
3.2.1.2.1 Sys.RUpdate.Init – Initializes remote upgrade
Command syntax
Sys.RUpdate.Init,<type>,<option>,<size>,<sectors>,<config>
Examples
$PFAL,Sys.RUpdate.Init,FW_raw,new,890812,14,clear_cnf
Message description
Starts the firmware remote update or resumes a previous update process (also possible after a system restart). Returns the number of sectors required for the update process. To start transferring the firmware to the MAMBOII device you have to define the channel from where the firmware data will be received.
Parameter description
<type>
It specifies the type of the remote firmware update. It can be set to:
Value Meaning
FW_raw Performs a remote update from uncompressed firmware
data.
FW_cpr Performs a remote update from compressed firmware
data. The size of the compressed firmware is limited to 786 KB (maximal 12 sectors). A configuration can be stored within the compressed file, which will be unpacked then.
<option>
It specifies the option of the remote firmware update. It can be set to:
Value Meaning
new Required for starting a new remote update. It erases
previously transmitted data and also erases e.g. possible history data stored in this region
resume Required for resuming a previous update. Erases
previously transmitted device configuration, which has to be transmitted again. Previously stored firmware data is not erased
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 33 of 271
Page 34
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
<size>
Specifies the exact length of the remote update firmware data. For FW_raw, this number specifies the length (in bytes) of the binary firmware data. For FW_cpr, this number specifies the length (in bytes) of the compressed firmware data.
<sectors>
Specifies how large the new firmware is (how many sectors it uses in uncompressed format) – one sector is 64 KB. Example: a firmware uses 14 sectors, so 14 has to be specified for <size>.
<config>
Value Meaning
raw_cfg Erases the device configuration during the update
process. A new (uncompressed) configuration can be transmitted via remote update. (see select sector for more details). Config can still be used until the remote update is finished ; after finishing, the old configuration will be cleared
compressed_cfg A new configuration is stored within the compressed
firmware. No separate config will be needed. It is not allowed to write uncompressed configuration data to the configuration sector if compressed_cfg is selected.
current_cfg Uses the currently stored device configuration later. No
separate configuration needs to be specified. An existing compressed configuration would be overwritten.
3.2.1.2.2 Sys.RUpdate.DataMode,<msg_input> – Defines transfer channel & continues upgrading
Command syntax
Sys.RUpdate.DataMode,<msg_input>
Examples
$PFAL,Sys.RUpdate.DataMode,TCP
Message description
Enters the data mode, which allows only entering of binary update commands. Inside this mode, no PFAL commands can be executed.
Parameter description
<msg_input>
Specifies in which channel the firmware-based packets will be received. Now binary Update commands can be sent (see next chapter).
Value Meaning
Serial Received via serial line
TCP Received via a TCP connection (from MAMBOII server)
CSD Received via a CSD call (GSM datacall)
Note:
This command can be executed anytime after a remote update has been
initiated (Rupdate.Init)
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 34 of 271
Page 35
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.1.2.2.1 Binary update commands
Command syntax
<sta><length><cmd_id><answer_id><datalength><data><sto>
Binary Command Responses*
Format Size Description Syntax Example**
<sta> 1 Byte - 0xFC
<length>
1-n Byte
- MSB bit (0x80) signalizes that another length byte follows.
- The length itself may range from '0x00 … 0x7F' for each byte (to a
maximal length of 4096 – the current size of the internal buffer)
- Shows the number of bytes after <length> until <sto> (<sto> is
included)
<cmd_id>
1-n Byte
- MSB bit (0x80) signalizes that another cmd byte follows
- Specifies the command being sent. In the sub-section are listed all
commands and their values correspondingly
<answer_id> 1 Byte
- Here can be specified any value– the headline of the corresponding response will contain this value in order to identify the response. (Therefore different values should be used for different commands)
<datalength>
1-2 Bytes
- Specifies the amount of following bytes inside <data> its value
depends on the specified <cmd_id> (see below)
- MSB bit (0x80) signalizes that another length byte follows
- The length itself may range from '0x00 … 0x7F' for each byte (to a
maximal length of 4096 – the current size of the internal buffer).
<data>
0-n Byte
- (Specified with <datalength>)
- Contains formatted data which depends on the specified
<cmd_id> (see below)
<sto> 1 Byte - 0xEC
<$><txt_id>,< txt_cmd>>
$answer lines $SUCCESS
OR ERROR $<end>
$<01,03> $C06F $SUCCESS $<end>
* Although update commands are sent in binary, their answers are text messages, which match the PFAL answer format.
** A response for a checksum command (its id is 0x01)
<txt_id> - the textual hexadecimal value of <id> ( i.e. <id>=0xA9 <txt_id> = "A9") <txt_cmd> - the textual hexadecimal value of <cmd>
3.2.1.2.2.2 List of binary commands
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 35 of 271
Page 36
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
Syntax
Exit Data Mode
Select Sector
Write Data to Sector
Read Sector Checksum
Clear Sector
<cmd_id> 0x00 0x01 0x02 0x03 0x04
<datalength> 0x00 0x01
4 + number of bytes to be written.
2 0
<data> -
Number of sector or 99 to select configuration sector.
- - -
<pos> - -
2 Bytes (position
inside sector 0x00­0xFFFF)
2 Bytes (position inside sector 0x00­0xFFFF)
-
<data_to_write> - - data for this position - -
<cksum> - -
2 Byte (16 bit checksum of <pos> and <data_to_write>)
- -
Functionality
Switches back to normal Command mode (PFAL commands)
- Selects one of the sectors (0 ... number returned from
RUpdate.Init
command).
- If 'CFG' is selected, only a half sector can be accessed. The new device configuration can be stored there if desired.
- This selected sector is used for all further commands.
- Data can be written only to the currently selected sector.
- The checksum command works only for the currently selected sector.
- Erasing a sector can be performed only on the currently selected one.
Writes data to the specified position inside a currently selected sector
Computes a 16 Bit Cksum of the currently selected sector from the first byte until <pos> (the byte at the specified position is included). This Cksum has to match with the expected value (i.e. of the new firmware sector)
- If this Cksum differs from expected results data is corrupted, which can result in an unreachable device.
- In case a wrong cksum was reported, the whole sector has to be erased (see next command)
- Note: If just a part of a sector needs to be written, the specified position should be the last byte written. If the maximum value (0xFFFF) is specified, trailing 0xFF’s inside this sector would be also used for calculation.
- Do not specify 0xFFFF for the very last sector containing a configuration
- the maximum value for this sector is 0x7FFF.
Erases a currently selected sector. (i.e. if corrupted data was inside)
leave empty
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 36 of 271
Page 37
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.1.2.3 Sys.RUpdate.Finish – Finishes Remote Update
Command syntax
Sys.RUpdate.Finish
Examples
$PFAL,Sys.RUpdate.Finish
Message description
In case of a successful firmware update, the device will perform a reset and starts with the updated firmware after approx. 30-40 seconds (depending on the size of the firmware).
Parameter description
None.
Note:
All data required for the firmware update has to be specified and verified
using checksum commands before executing this command.
For "FW_raw" type:
If the finish command fails, note that after resuming the firmware update
later, a previously transmitted configuration will be always erased.
This doesn't matter in case the old firmware configuration is used (option
keep_cnf), but in case it was transferred (option clear_cnf), it MUST be transferred again before finishing the update.
Else the device will be unreachable (because it will start using default
settings).
In case the firmware update was resumed, note that a previously transmitted
configuration will be always erased. This doesn't matter in case the old device configuration is used, but in case it was transferred, it MUST be transferred again before finishing the update procedure. Otherwise the device will be unreachable (because it will start with default settings)
This command doesn't create a PFAL answer if successful executed (just in
case of an error).
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 37 of 271
Page 38
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.1.3 “Device” command index
Device commands allow you to perform a system reset, shutdown, sleep or to reset the system configuration settings. Once one action is executed the corresponding event is respectively raised in your application. The start event raises after the system (re)starts (after initialization), while the shutdown event raises once the command shutdown is executed. You can then handle these events (see chapter 3.2.25.1.1.2.2, page 213) to execute alarms you need. See examples in chapter 6.11.3.2, page 265 and chapter
6.11.3.3, page 266. The following actions can be executed:
Reset, Update,Shutdown,FactoryReset,SleepClearAlarmClearConfig
3.2.1.3.1 Sys.Device.Reset – Resets the system
Command syntax Sys.Device.Reset
Examples $PFAL,Sys.Device.Reset Responses -
Command description
This command enables an application and services to be shut down and restarted. It tells your target device to stop what it is doing and start over again, bypassing any system extensions.
Parameter description
None.
Notes
This input command performs immediately a system reset. No responses will be
delivered from the MAMBOII device.
3.2.1.3.2 Sys.Device.Update – Set the system into the update mode
Command syntax $PFAL,Sys.Device.Update
Examples $PFAL,Sys.Device.Update
Message description
This command is intended to set the MAMBOII device into the update mode. Upgrading the MAMBOII device to a new firmware takes place only via Bluetooth connection.
Parameter description
None.
Notes
No responses will be delivered from the MAMBO device to the user.
How to upgrade the MAMBOII to a new firmware version, refer to the
“MamboII_firmware_update.pdf”.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 38 of 271
Page 39
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.1.3.3 Sys.Device.Shutdown – Shutdown the system
Command syntax Sys.Device.Shutdown
Examples $PFAL,Sys.Device.Shutdown Responses -
Command description
This command shuts down the device immediately and discards all currently queued requests after the event “Sys.device.eShutdown” occurs. This event could not be used as a condition to execute alarm. To turn on the device again, the
on/off” button (BTN0) must be pressed, thereby a switch-on signal tone is generated.
Parameter description
none.
3.2.1.3.4 Sys.Device.FactoryReset – Resets configuration to its default
Command syntax Sys.Device.FactoryReset
Examples
$PFAL,Sys.Device.FactoryReset
Responses
-
Command description
Using this command, the system’s configuration settings will be reset to the original defaults. Subsequently the Bluetooth module performs a reset.
Parameter description
None.
Notes
No responses will be delivered from the MAMBOII unit. Once this command is
executed, all settings done by the user will be erased forever. The device will run up with default settings. Default settings are listed in chapter 6.9 on page
260.
3.2.1.3.5 Sys.Device.Sleep=<type> – Puts the system into the sleep state
Command syntax Sys.Device.Sleep=<type>
Examples
$PFAL,Sys.Device.Sleep=Ign $PFAL,Sys.Device.Sleep=Ring+Motion+Timer
Responses
E.g. activate sleep mode Ignition
Command description
This command serves to control the functionality level of the MAMBOII device. It can be used to choose one of the supported SLEEP modes. All SLEEP modes reduce the functionality of the MAMBOII device to a minimum and thus minimize the current consumption. This command puts the system into one or more sleep modes for a length of time until the corresponding wakeup event is detected. The MAMBOII appears to be off when it goes to sleep, but it can still respond to wakeup events. Wakeup events can occur when the device receives an input signal, such as a ring call or SMS, or when software requests that the device wake up at a predetermined time etc. The wake-up event switches that sleep mode off and takes the MAMBOII device back to full functionality. Depending on the user application, a power-saving mode can be activated to conserve the battery power. Comparing to other sleep modes, the Ring mode requires more power consumption, since the GSM engine remains active and registered all the time.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 39 of 271
Page 40
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
Parameter description
<type>
It defines under which conditions the MAMBOII device should be woken up. The value can be set to.
Value Meaning
IGN Puts the system into IGN-SLEEP mode until the BTN1 (right-
button on MAMBOII) is short pressed (see chapter 6.10).
This SLEEP mode permanently blocks the serial interface (Bluetooth), closes the available TCP line, detaches the MAMBOII from the GPRS and deregisters it form GSM network. To switch the unit to normal operation, press short the BTN1 .
Motion Puts the system into MOTION-SLEEP mode until motion is
detected (
attempts to move it in any direction, either up or
down, or left or right)
. MOTION-SLEEP mode permanently blocks the serial interface (Bluetooth), closes the available TCP line, detaches the MAMBOII from the GPRS and deregisters it form GSM network. A
ttempts to move it in any
direction
switch the MOTION-SLEEP mode off and take the MAMBOII device back to full functionality. It uses the use the same filter parameter as MOTION.FILTER.
Ring Puts the system into RING-SLEEP mode until an incoming
call or an SMS message arrives. This SLEEP mode permanently blocks the serial interface (Bluetooth), closes the available TCP line and detaches the MAMBOII from the GPRS services. Only GSM engine remains powered and GSM-registered (for detecting incoming calls and SMS). The major benefit of RING-SLEEP mode is that the MAMBOII remains accessible via GSM services such as SMS, voice or data call. The first incoming ring terminates the RING-SLEEP mode, hangs up that call, ri-initializes the GSM engine and takes the MAMBOII device back to full functionality. Please note that, the MAMBOII could not be put into the RING-SLEEP mode if it is not GSM registered. Blocking the Bluetooth serial line signifies the sleep mode activation. All PFAL commands sent within the SMS contents will be executed after the GSM has been ri­initialized.
Timer=<timeout> Puts the system into TIMER-SLEEP mode until the timer
expires. The period of time the MAMBOII device stays in the TIMER-SLEEP mode can be defined in the timeout entry. TIMER-SLEEP mode permanently blocks the Bluetooth serial interface, closes the available TCP line, detaches the MAMBOII from the GPRS services and deregisters it form GSM network. The system will be woken up again when the timer expires. The time expiration switches the TIMER-SLEEP mode off and takes the MAMBOII device back to full functionality.
Note: Do not use the TIMER-SLEEP parameter alone. It is
recommanded to combine it with the IGN-SLEEP parameter.
<timeout>
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 40 of 271
Page 41
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
Specifies how long the device will sleep before a time out signal occurs. Its format is "hh:mm:ss", where the characters indicate the two digits of hour, followed minutes and seconds with an accuracy of 1 second. The timeout can be set to a value form 00:00:00 to 99:59:59.
Sleep time specified as <hh>:<mm>:<ss>.
Notes
During the system MAMBOII is going into one of the sleep modes, it will kill all
running tasks as smoothly as it can. The internal software checks/generates and calls the following instances:
The Sys.Device.eShutdown event raises (if this event is set, the system
can execute any action),
If the system should perform an Ign sleep mode, the system calls the
specified <time_out> value of the DEVICE.IGNTIMEOUT parameter, which determines the number of milliseconds to wait between executing the actions (which have not been delivered yet, since they are triggered) and sleep process. Following processes are still active until the sleep process is performed:
Except the Sys.Device.eSshutdown event, all other events
thereafter raise, unfortunately will be killed.
Active SMS messages will attempt to be delivered,Active TCP packets will attempt to be transmitted,Existing connections such as the TCP and GPRS will be closed
after alarms are executed.
The MAMBOII will be de-registered from the GSM services.
Once these instances are checked by the internal firmware and the specified timeout <time_out> is exceeded the device hardware cancels all other processes and goes into the specified sleep mode, even if there are still actions to be executed. The target system (MAMBOII) will be turned on again, once one of the specified signals triggers.
Should the MAMBOII device be set into the Ring sleep mode, make sure that
the GSM engine is switched on !!!!.
The IGN wake up signal is generated when the user press the BTN1
(BTN.e1=short event) of the MAMBOII device, see chapter 6.10.
The system MAMBOII can be set into more than one sleep modes, if entered
strings are separated by + (plus) .
For example: $PFAL,Sys.Device.Sleep=Ign+Ring+Timer=01:00:00 means,
the system wakes up when either the BTN1 is short pressed, a ring signal is detected or 1 hour has passed since the device is set into the Timer sleep mode.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 41 of 271
Page 42
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.1.3.6 Sys.Device.ClearAlarm – Clears existing alarms and restart the device
Command syntax Sys.Device.ClearAlarm
Examples
$PFAL,Sys.Device.ClearAlarm
Responses
-
Command description
This command clears all user-set alarms and restarts the system when this command is successfully processed.
Parameter description
None
3.2.1.3.7 Sys.Device.ClearConfig – Clear existing configuration
Command syntax Sys.Device.ClearConfig
Examples
$PFAL,Sys.Device.ClearConfig
Responses
-
Command description
The MAMBOII device has the option to clear all user-specified configuration and to restart the system when the clear command is successfully processed. Default settings (see chapter 6.9 on page 260) remain available.
Parameter description
None
3.2.1.3.8 Sys.Device.CfgUpdateMode – Prevents interferences between old and new alarms
Command syntax Sys.Device.CfgUpdateMode
Examples
$PFAL,Sys.Device.CfgUpdateMode
Responses
-
Command description
This command enters the device into a special configuration update mode, which is recommended during alarm configurations. This mode prevents the interferences between old and new alarms.
When being inside this mode:
- All configured alarms become inactive
- The configured Macros can be directly executed via PFAL commands.
Parameter description
None.
Notes
To exit the configuration update mode, a system reset is required
This mode can also be used to test the alarm conditions and simulate step by
step usual alarm behaviour:
Events will be displayedAlarm states can be checked using the MSG.Info.Alarm command
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 42 of 271
Page 43
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
Alarm actions will be simulated using the PFAL commands (because no
actions are being executed) (i.e. user have to start timers, increment counters or change the trigger states etc..)
However, it is not possible to easily change other system states such as device
speed, connection states etc..
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 43 of 271
Page 44
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.1.4 “Timer” command index
Timers are system-based timers, which allow you a recurring interval at which the elapsed events are raised in your application. You can then handle these events (see chapter 3.2.25.1.1.2.3, page 213) to execute regular or single alarms you need. System Timers raise the elapsed events, based on the value of the interval. You could use a system Timer to execute alarms, for example, every 30 minutes. See examples in chapters , page and 6.11.3.2, page 265.
Each timer can be:
configured, started, stopped, erased paused resumed armed, disarmed, saved loadedrequested
Remarks: Only armed timers raise events when they expire (by default, all times are
armed when they start. To manually arm a timer you have to disarm it first).
3.2.1.4.1 Sys.Timer<index>.Configure=<mode>,<timeout> – Configures Timers
Command syntax Sys.Timer<index>.Configure=<mode>,<timeout>
Examples
$PFAL,Sys.Timer0.Configure=cyclic,5000 $PFAL,Sys.Timer1.Configure=single,2000 …… …… $PFAL,Sys.Timer19.Configure=……………………
Responses
E.g. Timer 0 configured
Command description
This command is intended to configure the system timers, which will be started in a later time using the Sys.Timer<index>.Start command.
Parameter description
<index>
Determines the index of the timer to be configured. Up to 20 Timers are available. It can be set to a value from 0 to 19.
<mode>
Specifies the configuration mode of the Timer.
Value Meaning
single Initiates a single run when the specified timer<index>
starts. Its raised event can be used to execute an action once.
cyclic Initiates periodically when the specified timer<index>
starts. Its raised event can be used to execute an action regularly.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 44 of 271
Page 45
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
<timeout>
32-bit integer value from 0 to 2147483647. Determines the amount of time, in milliseconds, on which the specified Timer<index> runs. Each time the specified timeout passes, the corresponding Timer event occurs.
Notes
Use caution when using cyclic timers in combination with a very small timeout
value. Always keep an eye for the execution time of alarms which are executed upon this timer event (i.e. periodical SMS cannot be sent faster than each 10 seconds. So, timers with very short time intervals will only slow down the system performances)
The accuracy of system timers is approx. 200 ms. Therefore, a 0 value of
<index> is valid, however the timer will be called every 200 milliseconds.
If a Timer<index> is currently running, and this command is executed, the
running timer will be stopped. To activate/start it use the “SYS.Timer0.Start” command.
3.2.1.4.2 Sys.Timer<index>.Start=<timer_settings>– Starts/restarts Timers
Command syntax Sys.Timer<index>.Start=<timer_settings>
Examples
$PFAL,Sys.Timer0.Start $PFAL,Sys.Timer0.Start=cyclic,2000 $PFAL,Sys.Timer0.Start=single,2000
Responses
E.g. $Timer 0 started
OR
$Timer 0 initialized and started
Command description
This command is intended to start a configured timer or to restart a stopped timer. System timers can be used to activate/execute delayed alarms. Timers can be set/configured to automatically activate system actions at specific times. The
<timer_settings> is optional*. It consists of the <mode> and <timeout> values. Using the <timer_settings>, the Timer<index> can be (re)configured and (re)started at once
without using the $PFAL,Sys.Timer<index>.Configure command, otherwise, if <timer_settings> is omitted, the Timer<index> has to be configured before it starts.
Parameter description
<index>
Determines the index of the timer to be started. Up to 20 Timers are available. It can be set to a value from 0 to 19.
<timer_settings>
This parameter is optional. It can be used to start an un-configured timer or to overwrite the existing settings by the new one. It consists of the <mode> and <timeout> parameters which can be set the same as by the
Sys.Timer<index>.Configure. If this parameter is used, the syntax of this command
looks like this:
Command syntax PFAL,Sys.Timer<index>.Start=<mode>,<timeout>
<mode>
It specifies the timer’s task to be performed. Use it to perform an action either periodically or just once. It can be set to:
single Performs a single execution. it allows an action to be performed
just once.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 45 of 271
Page 46
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
cyclic Performs execution periodically. Based on its event that occurs
each time the specified <timeout> passes, it allows an action(s) to be performed periodically.
<timeout>
It specifies a 32-bit integer value. It can be set to a value from 0 to 2147483647. It determines the amount of time, in milliseconds, on which the specified Timer<index> runs. Each time the specified timeout passes, the corresponding Timer event occurs, if Timer<index> is not disarmed.
Notes
Use caution when using cyclic timers in combination with a very small
timeout. Always keep an eye for the execution time of alarms which are executed upon this timer event (i.e. periodical SMS cannot be send faster than each 10 seconds, so specifying fast timers will only slow down system performance in this case)
The $PFAL,Sys.Timer<index>.Start command without value can be used only
by the configured timers.
The accuracy of system timers is approx. 200 ms. Therefore, a 0 value of
<timeout> is valid, however the timer will be called every 200 milliseconds.
3.2.1.4.3 Sys.Timer<index>.Stop– Stop running Timers
Command syntax Sys.Timer<index>.Stop
Examples
$PFAL,Sys.Timer0.Stop
Responses
$Timer 9 stopped
Command description
A system timer can be stopped at any time before it finishes executing. You can request that, a system timer ends execution prematurely by using the Stop command. It forces a running timer to stop its execution immediately. Stop command resets the value of the stopped timer to zero. The execution of a stopped timer restarts by using the Start command, only.
Parameter description
<index>
Identifies the index number of the timer to be stopped. Up to 20 Timers are available. It can be set to a value from 0 to 19.
3.2.1.4.4 Sys.Timer<index>.Pause – Pauses (suspends) running Timers
Command syntax Sys.Timer<index>.Pause
Examples
$PFAL,Sys.Timer0.Pause
Responses
E.g. $Timer 0 paused
Command description
A system timer can be paused (suspended) at any time before it finishes executing. To suspend a system timer temporarily, use its Pause command. It suspends the activation of the defined system timer. The defined timer does not resume execution until the Resume or Start command is called.
Parameter description
<index>
Determines the index of the timer to be paused. Up to 20 Timers are available. It can be set to a value from 0 to 19.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 46 of 271
Page 47
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.1.4.5 Sys.Timer<index>.Resume– Restarts the execution of paused timers
Command syntax Sys.Timer<index>.Resume
Examples
$PFAL,Sys.Timer0.Resume
Responses
E. g. $Timer 0 resumed //if previously paused
OR
$error resuming Timer 0 // if already running or stopped
Command description
Use Resume command to start a paused Timer again. Commands to Pause can be nested; Resume command must be used the same number of times the Pause command was used before.
Parameter description
<index>
Determines the index of the timer to be resumed. Up to 20 Timers are available. It can be set to a value from 0 to 19. Please, specify a paused timer.
3.2.1.4.6 Sys.Timer<index>.Arm– Arms initialized and disarmed timers
Command syntax Sys.Timer<index>.Arm
Examples
$PFAL,Sys.Timer0.Arm
Responses
E.g. Timer 0 armed //if previously disarmed
OR
$error arming Timer 0 //if already armed
Command description
Each Timer<index> is armed (default setting) when started or resumed the execution. A timer can be manually armed after your have disarmed it. Only armed timers generate events when the specified timeout expires.
Parameter description
<index>
Determines the index of the timer to be armed. Up to 20 Timers are available. It can be set to a value from 0 to 19. Please, specify the value of a disarmed system timer.
3.2.1.4.7 Sys.Timer<index>.Disarm – Disarms initialized and armed Timers
Command syntax Sys.Timer<index>.Disarm
Examples
$PFAL,Sys.Timer0.Disarm
Responses
E.g. Timer 0 disarmed
OR
$error disarming Timer 0 //if previously disarmed
Command description
None of Timer<index> is disarmed when they start or resume their execution. To disarm them call the Disarm command.
Parameter description
<index>
Determines the index of the timer to be disarmed. Up to 20 Timers are available. It can be set to a value from 0 to 19.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 47 of 271
Page 48
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.1.4.8 Sys.Timer<index>.Erase – Erases Timer settings
Command syntax Sys.Timer<index>.Erase
Examples
$PFAL,Sys.Timer0.Erase
Responses
E.g. $Timer 0 erased
Command description
This command erases the configuration of the defined system timer. If the timer is running, it stops its execution immediately. The Timer<index> is no longer in use. To activate it, it must be reconfigured and then started.
Parameter description
<index>
Determines the index of the timer to be erased. Up to 20 Timers are available. It can be set to a value from 0 to 19.
3.2.1.4.9 Sys.Timer<index>.Save<storage_index>– Saves Timer state to Storage index
Command syntax
Sys.Timer<index>.Save<storage_index>
Examples
$PFAL,Sys.Timer0.Save0
Responses
E.g. $Timer 0 saved
Command description
To save the state of a Timer<index> , use this command. This command overwrites the contents of the <storage_index> (if not empty).
Parameter description
<index>
Determines the index of the timer to be saved. Up to 20 Timers are available. It can be set to a value from 0 to 19.
<storage_index>
Integer type storage index in the range 0 to 4. Each storage index is a portion of FLASH memory in which determined data written on it will be not lost when the device performs a reset, goes into sleep mode or is turned off. Each storage index has a fixed size into the FLASH and each of them can be updated with new data. Read also the description of “storage index given in the table of abbreviations.
Notes
Alias names can be defined for all storage indices by using
ALIAS.STORAGE<storage_index>=<alias_name>. Read the description of
”storage index” given in the table of abbreviations.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 48 of 271
Page 49
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.1.4.10 Sys.Timer<index>.Load<storage_index>– Loads Timers with Storage contents
Command syntax Sys.Timer<index>.Load<storage_index>
Examples
$PFAL,Sys.Timer0.Load0
Responses
E.g. $Timer 0 loaded
OR
$error loading Timer 19 //if storage index is empty or results other
data
Command description
To load the state of a saved Timer<index>, use this command. Once the load command is called, the defined timer will be restarted up to the time the timer was saved.
Parameter description
<index>
Determines the index of the timer to be loaded. Up to 20 Timers are available. It can be set to a value from 0 to 19.
<storage_index>
Integer type storage index in the range 0 to 4. Each storage index is a fixed portion of FLASH memory in which determined data written on it will be not lost when the device performs a reset, goes into sleep mode or is turned off. The <storage_index> is reserved to save the status of a Timer, Counter, Trigger etc. Each storage index can be updated with new data. Each data set into a storage index overwrites the existed contents. Read also the description of
”storage index” given in the table of abbreviations.
Notes
Alias names can be defined for all storage indices by using
ALIAS.STORAGE<storage_index>=<alias_name>. Read also the description of
”storage index” given in the table of abbreviations.
3.2.1.4.11 Sys.Timer<index>.State – Reads Timer state
Command syntax Sys.Timer<index>.State
Examples
$PFAL,Sys.Timer0.State
Responses
E.g. $state of timer 0: , initialized, active, running, armed
Command description
To know the state of a used Timer<index>, use this command. Depending on the current state of the requested timer, the following states may be retrieved:
erased active running armed
initialized inactive paused disarmed
Parameter description
<index>
Determines the index of the timer to be displayed. Up to 20 Timers are available. It can be set to a value from 0 to 19.
Notes
The retrieved timer states are comma separated.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 49 of 271
Page 50
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.1.5 “Trigger” command index
Triggers are user-based Triggers, which allow you to set, save and load their states when the Trigger state (see chapter 3.2.25.1.1.2.4, page 214) is called in your application. You can then handle this Trigger state as an option to enable or disable the execution of various alarms. See examples in chapter 6.11.3.2, page 265.
Each Trigger can be:
Activated/deactivated, Read,Saved, Loaded.
3.2.1.5.1 Sys.Trigger<index>.Set=<state_type> – Activates/deactivates system Triggers
Command syntax Sys.Trigger<index>.Set=<state_type>
Examples
$PFAL,Sys.Trigger0.Set=high
Responses
Command description
To activate and deactivate system triggers use this command. Default setting of each Trigger<index> is low (inactive)
Parameter description
<index>
Determines the index of the trigger to be altered. Up to 20 Triggers are available. It can be set to a value from 0 to 19.
<state_type>
Determines the trigger state to be set. Following states can be set:
Value Meaning
High Sets Trigger<index> to high level (active)
Low Sets Trigger<index> to low level (inactive)
Notes
Triggers do not generate events, when they alter their state.
3.2.1.5.2 Sys.Trigger<index>– Reads triggers state
Command syntax Sys.Trigger<index>
Examples
$PFAL,Sys.Trigger0
Responses
E.g. : $state of trigger 0: low
Command description
To read the state of a system trigger use this command.
Parameter description
<index>
Determines the index of the trigger to be read. Up to 20 Triggers are available. It can be set to a value from 0 to 19.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 50 of 271
Page 51
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.1.5.3 Sys.Trigger<index>.Save<storage_index>– Saves Trigger state to Storage index
Command syntax Sys.Trigger<index>.Save<storage_index>
Examples
$PFAL,Sys.Trigger0.Save0
Responses
E.g. $Trigger 0 saved
Command description
To save a Trigger<index>, use this command. This command overwrites the contents of the <storage_index> (if not empty).
Parameter description
<index>
Determines the index of the trigger to be saved. Up to 20 Triggers are available. It can be set to a value from 0 to 19.
<storage_index>
Integer type storage index in the range 0 to 4. Each storage index is a fixed portion of FLASH memory in which determined data written on it will be not lost when the device performs a reset, goes into sleep mode or is turned off. The <storage_index> is reserved to save the status of a Timer, Counter, Trigger etc. Each storage index can be updated with new data. Each data set into a storage index overwrites the existed contents. Read also the description of
storage index given in the table of abbreviations.
Notes
Alias names can be defined for all storage indices by using
ALIAS.STORAGE<storage_index>=<alias_name>. Read also the description of storage index given in the table of abbreviations.
3.2.1.5.4 Sys.Trigger<index>.Load<storage_index>– Load Triggers with Storage contents
Command syntax Sys.Trigger<index>.Load<storage_index>
Examples
$PFAL,Sys.Trigger0.Load0
Responses
E.g. $Trigger 0 loaded
OR
$error loading Trigger 0 //if storage index is empty or results other
data
Command description
To load the state of a saved Trigger<index>, use this command. A loaded state can be either High or Low depending on the state when the trigger was saved.
Parameter description
<index>
Determines the index of the trigger to be loaded. Up to 20 Triggers are available. It can be set to a value from 0 to 19.
<storage_index>
Integer type storage index in the range 0 to 4. Each storage index is a fixed portion of FLASH memory in which determined data written on it will be not lost when the device performs a reset, goes into sleep mode or is turned off. <storage_index> is reserved to save the status of a Timer, Counter, Trigger etc. Each storage index can be updated with new data. Each data set into a storage index overwrites the existed contents. Read also the description of
storage index given in the table of abbreviations.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 51 of 271
Page 52
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
Notes
Alias names can be defined for all storage indices by using
ALIAS.STORAGE<storage_index>=<alias_name>. Read also the description of storage index given in the table of abbreviations.
3.2.1.6 “Counter” command index
Counters are user-based counters, which allow you a limitation of automatically alarms at which a counter reaches its minimum value zero (0) or the defined value in your application. You can then handle this event (see chapter 3.2.25.1.1.2.5, page 214) to execute specific alarms you need. You could use a counter to execute limited alarms, for example, 10 alarms. See examples in chapter 6.11.3.3, page 266. Each counter can be:
set, incremented, decremented, requested (its state),saved, loaded, cleared.
3.2.1.6.1 Sys.Counter<index>.Set=<value> – Sets Counters to a value
Command syntax Sys.Counter<index>.Set=<value>
Examples
$PFAL,Sys.Counter0.Set=1000
Responses
E.g. $Counter 0 set to 1000
OR $Counter 0 set to -100 //The value range exceeded
Command description
To define the value of a Counter<index>, use this command. It is the start value from which the increment and decrement commands initiate their count up and down method.
Parameter description
<index>
Determines the index of the counter to be set. Up to 20 Counters are available. It can be set to a value from 0 to 19.
<value>
32-bit integer value from 0 to 2147483647. Sets the value of the specified Counter<index>.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 52 of 271
Page 53
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.1.6.2 Sys.Counter<index>.Increment=<inc_value> – Increments Counter’s value
Command syntax Sys.Counter<index>.Increment=<inc_value>
Examples
$PFAL,Sys.Counter0.Increment=11
Responses
E.g. $Counter 0 incremented by 11
OR
$Counter 0 incremented by -103 //The value range exceeded
Command description
Use this command to add a value <inc_value> to the current value of a
Counter<index>. It corresponds to the statement <new_value>=<value> + <inc_value>. When the Counter<index> reaches the maximum value (232-1 =
2147483647), further increments have no effect.
Parameter description
<index>
Determines the index of the counter to be incremented. Up to 20 Counters are available. It can be set to a value from 0 to 19.
<inc_value>
32-bit integer value from 0 to 2147483647. It increments (it counts up from the initial set value toward 2
32
- 1) the value of the specified Counter<index> by a
given number <inc_value>.
3.2.1.6.3 Sys.Counter<index>.Decrement=<dec_value> – Subtracts Counter’s value
Command syntax Sys.Counter<index>.Decrement=<dec_value>
Examples
$PFAL,Sys.Counter0.Decrement=11
Responses
E.g. $Counter 0 decremented by 11
OR
$Counter 0 decremented by -103 //The value range exceeded
Command description
Use this command to subtract the current value of a Counter<index> by <dec_value>. It corresponds to the statement <new_value>=<value> -<dec_value>.
When the Counter<index> reaches the minimum value (0), further decrements have no effect.
Parameter description
<index>
Determines the index of the counter to be subtracted. Up to 20 Counters are available. It can be set to a value from 0 to 19.
<dec_value>
32-bit integer value from 0 to 2147483647. It decrements (it counts down from the initial set value toward 0) the value of the specified Counter<index> by a given number <dec_value>.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 53 of 271
Page 54
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.1.6.4 Sys.Counter<index>.State – Reads Counter’s state
Command syntax Sys.Counter<index>.State
Examples
$PFAL,Sys.Counter0.State
Responses
E.g. $state of counter 0: 1011 //if prior incremented by 11.
OR
E.g. $state of counter 0: 989 //if prior decremented by 11.
Command description
To know the state of a used Counter<index>, use this command.
Parameter description
<index>
Determines the index of the counter to be read. Up to 20 Counters are available. It can be set to a value from 0 to 19.
3.2.1.6.5 Sys.Counter<index>.Save<storage_index>– Saves Counter’s state to Storage index
Command syntax Sys.Counter<index>.Save<storage_index>
Examples
$PFAL,Sys.Counter0.Save0
Responses
E.g. $Counter 0 saved
Command description
To save a Counter<index>, use this command. This command overwrites the contents of the <storage_index> (if not empty).
Parameter description
<index>
Determines the index of the counter to be saved. Up to 20 Counters are available. It can be set to a value from 0 to 19.
<storage_index>
Integer type storage index in the range 0 to 4. Each storage index is a fixed portion of FLASH memory in which determined data written on it will be not lost when the device performs a reset, goes into sleep mode or is turned off. The <storage_index> is reserved to save the status of a Timer, Counter, Trigger, etc. Each storage index can be updated with new data. Each data set into a storage index overwrites the existed contents. Read also the description of
storage index given in the table of abbreviations.
Notes
Alias names can be defined for all storage indices by using
ALIAS.STORAGE<storage_index>=<alias_name>. Read also the description of storage index given in the table of abbreviations.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 54 of 271
Page 55
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.1.6.6 Sys.Counter<index>.Load<storage_index>– Loads Counters with storage contents
Command syntax Sys.Counter<index>.Load<storage_index>
Examples
$PFAL,Sys.Counter0.Load0
Responses
E.g. $Counter 0 loaded
OR
$error loading Counter 0 //if storage index is empty or results other
data
Command description
To load a saved Counter<index>, use this command.
Parameter description
<index>
Determines the index of the counter to be loaded. Up to 20 Counters are available. It can be set to a value from 0 to 19.
<storage_index>
Integer type storage index in the range 0 to 4. Each storage index is a fixed portion of FLASH memory in which determined data written on it will be not lost when the device performs a reset, goes into sleep mode or is turned off. The <storage_index> is reserved to save the status of a Timer, Counter, Trigger etc. Each storage index can be updated with new data. Each data set into a storage index overwrites the existed contents. Read also the description of storage index given in the table of abbreviations.
Notes
Alias names can be defined for all storage indices by using
ALIAS.STORAGE<storage_index>=<alias_name>. Read also the description of storage index given in the table of abbreviations.
3.2.1.6.7 Sys.Counter<index>.Clear – Sets Counters to 0
Command syntax Sys.Counter<index>.Clear Examples
$PFAL,Sys.Counter0.Clear
Responses
E.g. $Counter 0 set to 0
Command description
To set a specified Counter<index> to zero, use this command. This might cause the generation of a counter event (Sys.Counter.e0) if the value of this counter has not reached zero (0) before.
Parameter description
<index>
Determines the index of the counter to be cleared. Up to 20 Counters are available. It can be set to a value from 0 to 19.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 55 of 271
Page 56
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.1.7 “MACRO” command index
3.2.1.7.1 Sys.Macro<index>– Activates configured Macros
Command syntax Sys.Macro<index> Examples
$PFAL,Sys.Macro0
Responses
E.g. $activate macro 0
Command description
This command is intended to activate a configured Macro. To configure a Macro, please refer to the corresponding index of the parameter (MACRO<index>). Using of different indices enable you to execute up to 50 commands set into a single alarm (AL). How to set a Macro refer to the chapter 3.2.25.1.1.9.3 page 233.
Parameter description
<index>
Determines the index of the macro to be activated. Up to 20 macros are available for use. It can be set to a value from 0 to 19.
Notes
The command does not directly execute a macro several times, even if the
macro is activated, e.g. by an event, it will execute the Marco just once.
Of course, a macro can be executed several times, but the time between 2
macro activations depends on how much time the macro needs to execute all set commands before it will be reactivated.
If the time-span between two macro activations is too short, then only a part
of set commands within a macro might be executed twice.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 56 of 271
Page 57
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.1.8 “GSM” command index
3.2.1.8.1 Sys.GSM.Enable – Powers on the GSM engine
Command syntax Sys.GSM.Enable Examples
$PFAL,Sys.GSM.Enable
Responses
E.g. $SUCCESS
Command description
This command switches on the GSM engine, if previously has been switched off. The event SYS.GSM.eEnable occurs.
Parameter description
none.
3.2.1.8.2 Sys.GSM.Disable – Powers off the GSM engine
Command syntax Sys.GSM.Disable
Examples
$PFAL,Sys.GSM.Disable
Responses
E.g. $SUCCESS
Command description
This command is intended to switch off the GSM engine, if it is currently running. The event SYS.GSM.eDisable occurs.
Parameter description
None.
3.2.1.8.3 Sys.GSM.Reset – Resets the GSM engine
Command syntax Sys.GSM.Reset
Examples
$PFAL,Sys.GSM.Reset
Responses
E.g. $SUCCESS
Command description
This input command resets the GSM engine, if it is currently powered on. The event SYS.GSM.eEnable occurs when the GSM engine restarts.
Parameter description
None.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 57 of 271
Page 58
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.1.9 “GPS” command index
3.2.1.9.1 Sys.GPS.Enable – Powers on the GPS engine
Command syntax Sys.GPS.Enable
Examples
$PFAL,Sys.GPS.Enable
Responses
E.g. $SUCCESS
Command description
This command powers on the GPS engine if previously has been switched off. The event SYS.GPS.eEnable occurs. By default the GPS engine is always powered on when the system starts.
Parameter description
None.
3.2.1.9.2 Sys.GPS.Disable – Powers down the GPS engine
Command syntax Sys.GPS.Disable
Examples
$PFAL,Sys.GPS.Disable
Responses
E.g. $SUCCESS
Command description
This command powers off the GPS engine if it is currently running. The event SYS.GPS.eDisable occurs.
Parameter description
None.
3.2.1.9.3 Sys.GPS.Reset – Resets the GPS engine
Command syntax Sys.GPS.Reset
Examples
$PFAL,Sys.GPS.Reset
Responses
E.g. $SUCCESS
Command description
This command resets the GPS engine. The event SYS.GSM.eEnable occurs when the GSM engine restarts. This command can be executed, for example, when the GPS engine reports error during the runtime.
Parameter description
None.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 58 of 271
Page 59
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.1.10 “UserEvent” command index
3.2.1.10.1 Sys.UserEvent<index> – Creates a user-event for specific application requirements
Command syntax Sys.UserEvent<index>
Examples
$PFAL,Sys.UserEvent0
Responses
E.g. $launch user event 0
Command description
This command is intended to create a user-event (see chapter 3.2.25.1.1.2.12) which can be used to execute one or more alarms. Once this command is executed the corresponding event index (e.g SYS.UserEvent.e0) rises.
Parameter description
<index>
Determines the index of the UserEvent to be created. Up to 10 UserEvents are available. It can be set to a value from 0 to 9.
Notes
This event can be used to directly combine/link several alarms. (i.e. for
optimizing larger configurations or simply if more than 5 conditions are needed).
WARNING
The UserEvent is not recommended for use, as it may produce „endless loops“
that can slow down the system performances or may affect the stability of other functions.
Use the UserEvents at own risk. However, when using the UserEvents, think
about all consequences of (maybe recursively) launching alarms, especially in combination with various states, which may influence itself by actions. System behaviour can be very unpredictable and complex.
Therefore no support will be provided for configurations that contain
UserEvents.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 59 of 271
Page 60
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.1.11 “BAT” command index
3.2.1.11.1 Sys.Bat.Voltage – Queries battery voltage
Command syntax Sys.Bat.Voltage
Examples
$PFAL,Sys.Bat.Voltage
Responses
E.g. $battery voltage: 4.1 V
Command description
This command requests the current voltage of the internal battery. The returned value is in Volt (V). This command reports the correct voltage of the battery if no external power applied to the MAMBOII device at request time.
Parameter description
none.
3.2.1.11.2 Sys.Bat.ChargeState – Gets the current backup battery state
Command syntax Sys.Bat.ChargeState
Examples
$PFAL,Sys.Bat.ChargeState
Responses
E.g. $battery is charging
Command description
Returns a text indicating the current battery status as follows:
battery is discharging Indicates that the battery is currently discharging.
battery is charging Indicates that the battery is currently charging.
Parameter description
None.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 60 of 271
Page 61
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.1.12 “BT” command index
3.2.1.12.1 Sys.BT.Enable – Powers on the Bluetooth module
Command syntax $PFAL,Sys.BT.Enable
Examples
$PFAL,Sys.BT.Enable
Responses
E.g. $SUCCESS
Command description
This command powers on the Bluetooth module, if previously has been switched off. The event SYS.BT.eEnable occurs. By default the BT is powered on during system startup.
Parameter description
None.
3.2.1.12.2 Sys.BT.Disable – Powers off the Bluetooth module
Command syntax $PFAL,Sys.BT.Disable
Examples
$PFAL,Sys.BT.Disable
Responses
E.g. $SUCCESS
Command description
This command powers off the Bluetooth module if it is currently running. The event SYS.BT.eDisable occurs.
Parameter description
None.
Notes
The Bluetooth module will remain powered off, when programmatically
disabled, as long as the firmware is running. Whenever the MAMBOII device performs a system reset, or wake up from sleep mode or shutdown, the Bluetooth will be enabled and it remains active all the time until the user disables it again. If necessary to disable Bluetooth functionalities for a long period of time and, thus, to minimize the current consumption of MAMBOII device you have to specify two alarms. The following configuration can be done:
$PFAL,Cnf.Set,AL0=Sys.Device.eStart:Sys.Timer0=single,12000000
$PFAL,Cnf.Set,AL1=Sys.Timer.e0&Sys.BT.sDisconnected:Sys.BT.Disable
As you see above, the Bluetooth module stays active for 20 minutes after the system was powered on, woken up or restarted. If Timer0 expires and the user has not performed a Bluetooth connection, then the Bluetooth module will be powered off. From now on the Bluetooth interface is permanently blocked. Only GSM and GPRS services can be used to enable the Bluetooth module again, while the MAMBOII device is running.
The major benefit of the used system Timer is that the Bluetooth interface remains 20 minutes accessible after system starts up so that, it allows users to establish a Bluetooth connection within this time. Once the Bluetooth connection results established the «Sys.BT.sDisconnected» state returns False, which prevents disabling the Bluetooth module whereas the MAMBOII remains running at full functionality.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 61 of 271
Page 62
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
To re-enable the Bluetooth module only for a time while the device is running
and the Bluetooth module has already been disabled, just send the command «$PFAL,Sys.BT.Enable» to device via SMS or via TCP connection.
To re-enable the Bluetooth module to stay always active, the user set
configuration on alarms AL0 and AL1 have to be deleted (empty). The
«$PFAL,Cnf.Set,AL0;Cnf.Set,AL1» command without settings has to be
sent to device via SMS or TCP connection.
Please note, if you have disabled the Bluetooth functionality and the MAMBOII
device is unable to log in to any network (GSM and/or GPRS, due to: no SIM PIN has been entered, location area not allowed or roaming not allowed etc.), then the MAMBOII device is no more accessible either by SMS, TCP nor via Bluetooth interface. In this case, the first system reset stops power saving and takes the Bluetooth module for just 20 minutes long back to full functionality (The total time to establish a Bluetooth connection is estimated to be 20 minutes. However plan enough time to complete a Bluetooth connection).
3.2.1.12.3 Sys.BT.Reset – Resets the Bluetooth chip
Command syntax $PFAL,Sys.BT.Reset
Examples
$PFAL,Sys.BT.Reset
Responses
E.g. $SUCCESS
Command description
This command resets immediately the Bluetooth moule. The event SYS.BT.eEnable occurs when the BT restarts.
Parameter description
None.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 62 of 271
Page 63
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.1.13 “CPU” command index
3.2.1.13.1 Sys.CPU.Reset – Resets the ARM7 controller and sets the device into the upgrade mode.
Command syntax $PFAL,Sys.CPU.Reset
Examples
$PFAL,Sys.CPU.Reset
Responses
-
Command description
This command resets the ARM7 controller and sets MAMBOII into RedBoot console. If the system MAMBOII is set into the upgrade mode, the new firmware can be transferred over Bluetooth interface. To to enter RedBoot you have to press “Crtl+C” within 3 seconds after this command is executed. If RedBoot console is left and the system starts up, you have to perform a Bluetooth connection, because during reset Bluetooth module is turned off and during startup will be turned on again.
Parameter description
None.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 63 of 271
Page 64
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.1.14 “IEEE” command index
3.2.1.14.1 Sys.IEEE.Enable – Powers on the IEEE module
Command syntax $PFAL,Sys.IEEE.Enable
Examples
$PFAL,Sys.IEEE.Enable
Responses
E.g. $SUCCESS
Command description
This command powers on the IEEE module, if previously has been switched off. The event SYS.IEEE.eEnable occurs. By default the IEEE module is always powered on when the system is started up.
Parameter description
None.
3.2.1.14.2 Sys.IEEE.Disable – Powers off the IEEE module
Command syntax $PFAL,Sys.IEEE.Disable
Examples
$PFAL,Sys.IEEE.Disable
Responses
E.g. $SUCCESS
Command description
This command powers off the IEEE module if it is currently running. The event SYS.IEEE.eDisable occurs.
Parameter description
None.
3.2.1.14.3 Sys.IEEE.Reset – Resets the IEEE module
Command syntax $PFAL,Sys.IEEE.Reset
Examples
$PFAL,Sys.IEEE.Reset
Responses
E.g. $SUCCESS
Command description
This command resets the IEEE module. The event SYS.IEEE.eEnable occurs when the IEEE restarts. It can be executed, for example, when the IEEE hardware reports error during the runtime.
Parameter description
None.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 64 of 271
Page 65
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.1.15 “DISPLAY” command type
3.2.1.15.1 Display.Show – Displays a specific view on the MAMBOII's screen
Command syntax $PFAL,Display.Show=<view>
Examples
$PFAL,Display.Show=VIEW_GSM $PFAL,Display.Show=VIEW_GPS
…… ……
Responses
E.g $SUCCESS
Command description
This command displays a specific view on the MAMBOII's screen.
Parameter description
<view>
Determines the view to be displayed on the screen. Following views are supported:
Value Meaning
VIEW_GSM Displays the GSM view (graphically displays the GSM
operator name and field strength - A line made up of a series of dashes)
VIEW_GPS Displays the GPS view (graphically displays the current
Location, Speed and Direction)
VIEW_SKY Displays the SKY view (graphically displays the number and
position of the satellites on the horizon in the form of a polar plot)
VIEW_SAT Displays the SAT view (graphically and textually displays the
satellite number, status, azimuth, elevation, C/No, and last five seconds of measured signal strength)
VIEW_MENU Displays the first Menu view (displays the main menu
created with DISP.MENU<id>)
VIEW_PBOOK Displays the PBook view (displays all phonebook entries
created with DISP.PHONE<index>)
VIEW_TACHO Displays the Tacho view (graphically and textually displays
the current speed in km/h)
VIEW_KOMPASS Displays the Compass view (graphically displays the
current direction you are going)
VIEW_HEADING Displays the Heading view (graphically displays the current
direction you are going and current speed you are moving)
VIEW_MILOMETER Displays the Milemeter view (graphically displays in
miles the current distance travelled from a start point)
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 65 of 271
Page 66
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.1.15.2 Display.Dialog – Creates a full-screen dialog box
Command syntax
$PFAL,Display.Dialog=<id>,<”caption”>,<icon>,<timeout>,<”option_left”>,<”option_right”>,<”messag
e_text”>
Examples
$PFAL,Display.Dialog=1,”Message”,4,10,”Cancel”,”OK”,”Hallo World”
Responses
E.g. $SUCCESS
Command description
This command creates, and displays a dialog box on the screen. The MAMBOII device contains a dialog box that performs one of three functions: letting the user know that something has happened and confirmation or cancellation of an action. The dialog box occupies all of the screen (full-screen) and provide up to two options that are accessible through the left and right key. Each option on this dialog box provides an event when it is pressed. This event can be used to run any alarm. See chapter 3.2.25.1.1.3 about available events.
Parameter description
<id>
Identifies the message box to be created. Up to 100 dialog boxes in range from 0 to 99 are available.
<”caption”>
Specifies a text string that identifies the type of the message to the user.
<icon>
Specifies the icon that appears on the right side of caption in the dialog box when it is displayed. It can be set to a value in range 0 to 5.
<timeout>
Specifies the time how long, in seconds, the dialog box will stay open on the screen.
<”option_left”>
Specify the text to label the left option contained in the dialog box.
<”option_right”>
Specify the text to label the right option contained in the dialog box.
<”message_text”>
Specify the string containing the message to be displayed on the dialog box. If you want to display also any dynamic entry the syntax of the <”text”> can be changed to:
“text&(<entry1>)text&(<entry2>)text…&(<entryn>)“
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 66 of 271
Page 67
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
Each dynamic entry is separated by ampersand “&” without spaces and it is enclosed in parentheses “( )“.
The command for requesting such system states might look like this:
For example:
$PFAL,Display.Dialog=10,”Speed Message”,4,10,”Left”,”Right”,”on: &(Date) at &(Time) it is moving at &(Speed) m/s"
Dynamic entries are listed in chapter 6.2 page 243.
3.2.1.15.3 Display.Alarm – Displays a specific alarm image on the screen
Command syntax $PFAL,Display.Alarm=<image>,<timeout>,<”text”>
Examples
$PFAL,Display.Alarm=WARNING,20,”Battery low $PFAL,Display.Alarm=CALL,20,”Incoming call”
$PFAL,Display.Alarm=NEWSMS,20,”New SMS”
…… ……
Responses
E.g. $SUCCESS
Command description
This command enables you to display a specific alarm icon on the screen letting the user know that something has happened (e.g., a specific event occurs, receiving call, leaving/entering a geofence area etc.).
Parameter description
<image>
Specifies the image to be displayed on the screen. It can be set to:
Value Meaning
WARNING Displays a warning image (e.g. when the battery
becomes low)
CALL Displays a call image (e.g. when receiving a GSM call).
NEWSMS Displays an SMS image (e.g. when receiving an SMS).
MAIL Displays a mail image (e.g. when receiving a mail).
KEYFOB Displays a keyfob image (e.g. when a keyfob results
connected)
GEOFENCE Displays a geofence image (e.g. when leaving/entering a
Geofence or Area).
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 67 of 271
Page 68
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
<timeout>
Specifies the time how long, in seconds, the alarm will stay appeared on the screen.
<”text”>
Specify the string containing the message that will be displayed on the screen together with the specified image.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 68 of 271
Page 69
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -

3.2.2 “CNF” command type

This PFAL configuration command is intended to execute/require fast and easy the system configuration. This configuration setting determines the functionality of your MAMBOII device and your application to be developed.
With this configuration command, you can:
Set device configuration settings (the configuration stored into the FLASH
memory can get partly erased if the size of the new firmware loaded into FLASH is greater than the size of the memory assigned for the firmware).
Get current parameter configuration
Show user modified/added parameters
Show configuration settings of all used parameter
Show default configuration settings
Search for a configuration parameter
3.2.2.1 Cnf.Set,<parameter_name=value> - Sets up configuration
settings for an application and overrides default settings
Command syntax
Cnf.Set,<parameter_name>=<settings>
Examples
$PFAL,Cnf.Set,GSM.PIN=1234
$PFAL,Cnf.Set,DEVICE.NAME=MAMBOII
$PFAL,Cnf.Set,TCP.CLIENT.CONNECT=1,212.119.014,0005 $PFAL,Cnf.Set,AL0=IO.BTN.e0=long:SYS.Timer0.start=single,5000 $PFAL,Cnf.Set,AL1=IO.BTN.e0=short:SYS.Device.Sleep=Ring+Timer=02:00 ….
Responses
$DEVICE.NAME written to flash
Command description
This command is a helper function that sets the configuration on the device. This firmware provides basic configurations needed whenever the system starts up and as starting points for creation of an application. The default configurations are provided to give you a head start in developing of an application for specific requirements. They are intended to reduce your application development time. Once you have chosen a configuration parameter, you can configure it or overwrite the existing settings to suit your specific needs, using this command. The exact point at which you configure a parameter depends on your application to be developed. The examples in table above show how to set and configure a parameter using the “$PFAL,Cnf.Set” command. The configuration can be done, via Bluetooth, SMS or TCP (if the communication resources for these services are already available). If the parameter settings are omitted, the existing settings specified by the user is cleared and the factory default settings will be used.
Parameter description
<parameter_name>=<settings>
Specifies the name of a parameter you want to configure its settings. Set one of the parameters listed in the table below and define the settings of that parameter as described in the chapter 3.2.10, page 143. The structure of the message responses from the MAMBOII device is given in chapter 3.1.4, page 23. To show the default settings of the MAMBOII device, refer to the chapter 6.9 on page 260.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 69 of 271
Page 70
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
The following table shows the configuration parameters grouped by major category that are available in the MAMBOII firmware. Use the hypertext links (shown in blue text) to navigate to the parameter description, which explains how to configure that parameter and indicates the supported values
Parameter names Brief description Chapter
Device Configuration Settings
DEVICE.NAME Defines or changes the device name 3.2.10.2
DEVICE.CMD.PFAL.EN
Enables/disables the communication interfaces to the device.
3.2.10.3
DEVICE.COMM.SERIAL
Specifies the serial communication mode and output interface for forwarding information.
3.2.10.4
DEVICE.COMM.CSD
Specifies the CSD communication mode and output interface for forwarding information.
3.2.10.5
DEVICE.COMM.TCP.CLIENT
Specifies the TCP communication mode and output interface for forwarding information.
3.2.10.6
DEVICE.IGNTIMEOUT
Specifies the amount of time before the system goes to sleep.
3.2.10.7
DEVICE.BAT.MODE
Specifies the minimum voltage on the internal battery on which the event Sys.Bat.eLow will raise.
3.2.10.8
DEVICE.GPS.AUTOCORRECT
Modifies/adjusts the GPS auto correction of the target device.
3.2.10.10
DEVICE.GPS.CFG
Determines the number of satellites that are required to get a valid GPS fix.
3.2.10.11
DEVICE.GPS.TIMEOUT
Determines the period of time in minutes on which the GPS will search for satellites before it performs a GPS or optional System reset.
3.2.10.12
DEVICE.GSM.STARTUP Controls the operation of the GSM engine at boot time. 3.2.10.13
DEVICE.IEEE.STARTUP Controls the operation of the IEEE module at boot time. 3.2.10.14
DEVICE.BT.STARTUP
Controls the operation of the built-in Bluetooth Module at boot time.
3.2.10.15
DEVICE.BT.LOCALNAME
Sets the name to your MAMBOII for identifying it on Bluetooth connection.
3.2.10.16
DEVICE.BT.AUDIOGW
Enters the passkey and device ID of your Bluetooth audio device to be connected to.
3.2.10.17
DEVICE.PFAL.SEND.FORMAT
Defines the format of how responses of any MSG.Send command will be sent out.
3.2.10.18
DISP configuration Settings
DISP.VIEW<index>
Allows to determine the background of the home screen view and the views to be displayed when navigating with 5-way key.
3.2.11.1
DISP.MENU<index> Enables adding of items directly into a menu or submenu. 3.2.11.2
DISP.PHONE<index>
Allows adding/deleting of an entry in/from your phone book.
3.2.11.3
DISP.COLOR<id>
Allows changing of colors of each component available on the MAMBOII's screen such as: Texts, Bars, Vews and so on.
3.2.11.4
DISP.FONT Specifies the typeface of the font available on the device. 3.2.11.5
DISP.MESSAGE<index> Specifies the text for SMS. 3.2.11.6
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 70 of 271
Page 71
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
DISP.SAVER
Defines the timeout of inactivity for starting the screen saver.
3.2.11.7
DISP.TZ
Converts from time-zone name to local time and show it when screen saver is activated.
3.2.11.8
IEEE configuration Settings
IEEE.PANID
Allows you to specify the PAN (Personal Area Network) identifier
3.2.12.1
IEEE.KEYFOB<cnf_kf_div_index> Allows you to make an IEEE connection to a Keyfob 3.2.12.2
IEEE.IOBOX<cnf_ib_div_index> Allows you to make an IEEE connection to a I/O-BOX 3.2.12.3
REPLACE configuration Settings
REPLACE<index> Specifies the text to be replaced. 3.2.13.1
MACRO Parameter settings
MACRO<index>
Defines the configuration settings of a Macro. Up to 10 macro indices in a range of 0 to 9 can be set.
3.2.14.4
IO configuration setting
IO.BEEP.ENABLE Controls the operation of the beeper during start-up. 3.2.15.1
MOTION configuration Settings
MOTION.FILTER Defines filter parameters for the device motions. 3.2.16.1
ALIAS configuration Settings
ALIAS.<type> Defines alias names for use instead of default name 3.2.17.1
DBG configuration settings
DBG.EN
Enables a special debug mode for displaying the data being sent to the MAMBOII device and responses received.
3.2.18.1
Protocol Configuration Settings (sent via Bluetooth)
PROT.<id> Specifies sending of NMEA protocols in interval of time 3.2.19
PROT.START.BIN
Creates your own BIN protocol. It consists of 18 Bytes and it can be e.g. device identifier
3.2.19.2
GSM configuration Settings
GSM.PIN
Sets the PIN of used SIM card (only locally possible, by connecting the device to a PC)
3.2.19.2
GSM.CALLID.EN Enables/disables the caller identification 3.2.20.2
GSM.CALLTONE.ENABLE Controls the Call Progress Tones. 3.2.20.3
GSM.OPLOST.RESTART
Specifies if the system (MAMBOII) should be restarted in case of bad GSM coverage
3.2.20.4
GSM.OPERATOR.BLACKLIST
Creates a customized blacklist of the GSM operator names
3.2.20.5
GSM.OPERATOR.SELECTION Configures the GSM operator selection 3.2.20.6
GSM.SMS.RESPONSE
Enables/disables the responses from the MAMBOII device when SMS communication is applied
3.2.20.5
GSM.RINGTONE
Chooses on your own preferences the type and volume of ring tones.
3.2.20.8
GSM.PROFILE.AUDIO<prof_inde x>
Adjusts the specified profile for loudspeaker volume level and microphone side tone
3.2.20.9
GSM.PROFILE.CURRENTAUDIO
Loads a specific audio profile for using a headset.
3.2.20.10
GPRS configuration Settings
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 71 of 271
Page 72
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
GPRS.APN
Specifies the APN (Access Point Name) context of your provider such as “internet.t-d1.de”.
3.2.21.1
GPRS.AUTOSTART
Enables/disables the GPRS auto start. It re-enables GPRS connection when it fails
3.2.21.2
GPRS.QOSMIN
Specifies the minimum acceptable profile for identified context
3.2.21.3
GPRS.QOS
Specifies the required acceptable profile for identified context
3.2.21.4
GPRS.DIAL Specifies the dial text for GPRS connection 3.2.21.5
GPRS.TIMEOUT
Specifies the time out in which the GPRS connection is automatically closed if there is no TCP communication currently available
3.2.21.6
PPP configuration Settings
PPP.USERNAME
Specifies the user name that your network operator has provided you (if required)
3.2.21.5
PPP.PASSWORD
Specifies the password that your network operator has provided you (if required)
3.2.22.2
PPP.AUTOPING
Activates/deactivates the maximal idle time until the next ping will be sent to the GPRS network for keeping the GPRS connection alive
3.2.22.3
PPP.AUTH
Allows to define the authentification method that will be used over PPP.
3.2.22.4
TCP Configuration Settings
TCP.CLIENT.CONNECTTCP.CLIE NT.CONNECT TCP.CLIENT.CONNECT
Specifies the address and port of the remote server and connects to that server
3.2.23.1
TCP.CLIENT.ALTERNATIVE Specifies the address and port of an alternative server 3.2.23.2
TCP.CLIENT.PING
Activates the sending of ping to the remote server for keeping that connection alive
3.2.23.3
TCP.CLIENT.TIMEOUT
Enables/disables the maximal idle time until the next ping request
3.2.23.4
TCP.CLIENT.DNS.TIMEOUT Controls caching of DNS records. 3.2.23.5
TCP.CLIENT.LOGIN Sends the login data to the used remote server 3.3.10.6
TCP.STORAGE Specify the size of TCP storage and the operation mode. 3.2.23.7
TCP.CLIENT.SENDMODE
This parameter configuration allows to select between fast and safe TCP transmissions.
3.2.23.8
TCP.SMTP.CONNECT
Specifies the address and port of the SMTP server and connects to that server
3.2.23.9
TCP.SMTP.LOGIN Specifies the login data for SMTP server 3.2.23.10
TCP.SMTP.FROM Specifies the address from who the email will be sent. 3.2.23.11
Geofence Configuration Settings
GF.CONFIG
Sets the global configuration of the Geofence functionalities
3.2.24.3
GF.AREA<ID> Sets up to 32 areas in a range of 0 to 31 3.2.24.4
GF<id>
Sets up to 100 Geofence zones in a range of 0 to 99, to define the form of Geofence zones (small areas) and attach those zones to a specific area(s) (). The MAMBOII device can hold up to 100 Geofence zones
3.2.24.5
Alarm Configuration Setting
AL<index> Specifies a powerful multi-configuration and reporting 3.2.25
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 72 of 271
Page 73
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
messages as well as to create a maximum monitoring of system events and states which can be occurred during the operation of the device.
Table 6: The configuration parameters grouped by major category.
Notes
If one parameter is sent to the target device MAMBOII without value, the
current value of that parameter will be automatically set to the default (if default exists).
The default settings of the firmware version 2.4.0 are given in chapter 6.9 on
page 260.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 73 of 271
Page 74
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.2.2 Cnf.Get,<parameter_name> - Get configuration settings from
device
Command syntax Cnf.Get,<parameter_name>
Examples
$PFAL,Cnf.Get,DEVICE.NAME $PFAL,Cnf.Get,TCP.CLIENT.CONNECT $PFAL,Cnf.Get,GF.CONFIG $PFAL,Cnf.Get,GSM.SMS.RESPONSE
….
….
Responses
E.g. $DEVICE.NAME=MAMBOII
$SUCCESS
OR
$configuration name DEVICE.NAMES does not exist //When the
parameter name does not exist.
$ERROR
OR
$error updating DEVICE settings //When settings are not available. $ERROR
Command description
Using this command the MAMBOII device responds the current configuration settings corresponding to the specified <parameter_name>. The configuration settings are stored in the internal FLASH memory.
Parameter description
<parameter_name>
Sets the name of a parameter you want to request its settings. The following table shows the configuration parameters that are available in the MAMBOII firmware and can be requested. Use the hypertext links (shown in blue text) to navigate the parameter description, which explains you, what does the received configuration mean.
Parameter names Brief description Chapter
Device Configuration Settings
DEVICE.NAME Reads out the device name. 3.2.10.2
DEVICE.CMD.PFAL.EN
Reads out the allowed communication interfaces to the device.
3.2.10.3
DEVICE.COMM.SERIAL
Reads out the serial communication mode and the output interface for forwarding responses of commands and data that arrive on serial interface.
3.2.10.4
DEVICE.COMM.CSD
Reads out the CSD communication mode and the output interface for forwarding responses of commands and data that arrive via CSD interface.
3.2.10.5
DEVICE.COMM.TCP.CLIENT
Reads out the TCP communication mode and the output interface for forwarding responses of commands and data that arrive via TCP interface.
3.2.10.6
DEVICE.IGNTIMEOUT
Reads out the amount of time before the system goes to sleep.
3.2.10.7
DEVICE.BAT.MODE
Reads the minimum user-specified voltage for the internal battery on which the event Sys.Bat.eLow will be generated.
3.2.10.8
DEVICE.GPS.AUTOCORRECT
Reads out the GPS auto correction settings of the target device
3.2.10.10
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 74 of 271
Page 75
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
DEVICE.GPS.CFG
Reads out the number of satellites that must be available to get valid GPS fix.
3.2.10.11
DEVICE.GPS.TIMEOUT
Reads the timeout in minutes before MAMBOII performs a GPS or System reset if there is no GPS fix available.
3.2.10.12
DEVICE.GSM.STARTUP
Reads out whether the GSM engine is enabled at boot time.
3.2.10.13
DEVICE.IEEE.STARTUP
Reads out whether the IEEE module is enabled at boot time.
3.2.10.14
DEVICE.BT.STARTUP
Reads out whether the Bluetooth module is enabled at boot time.
3.2.10.15
DEVICE.BT.LOCALNAME
Reads out the local name of your MAMBOII used for Bluetooth connection.
3.2.10.16
DEVICE.BT.AUDIOGW
Reads out the specified MAC address and PIN code of the used Bluetooth headset.
3.2.10.17
DEVICE.PFAL.SEND.FORMAT
Reads the format of any MSG.Send command responses.
3.2.10.18
DISP configuration Settings
DISP.VIEW<index>
Reads out the view assigned to the specified index.
3.2.11.1
DISP.MENU<index>
Reads out the menu text and command (if available) assigned to the specified index.
3.2.11.2
DISP.PHONE<index>
Reads out the phone number assigned to a name.
3.2.11.3
DISP.COLOR<id>
Reads out the color value assigned to each component on the MAMBOII's screen.
3.2.11.4
DISP.FONT
Reads out the typeface of the font assigned on the device.
3.2.11.5
DISP.MESSAGE<index> Reads out the text assigned to a message index. 3.2.11.6
DISP.SAVER Reads out timeout for starting the screen saver. 3.2.11.7
DISP.TZ
Reads out how the time-zone name is converted to local time.
3.2.11.8
IEEE configuration Settings
IEEE.PANID
Reads out the PAN (Personal Area Network) identifier for IEEE.
3.2.12.1
IEEE.KEYFOB<cnf_kf_div_index> Reads out the setting of connecting a Keyfob. 3.2.12.2
IEEE.IOBOX<cnf_ib_div_index> Reads out the setting of connecting a I/O-BOX. 3.2.12.3
REPLACE configuration Settings
REPLACE<index> Shows the text specified for replacement. 3.2.13.1
Optional Parameter settings
STORAGE<id> Reads out the contents of a storage index. 3.2.14.1
SAVE.LASTVALID
Reads out the last valid position stored on the device.
3.2.14.2
USERTXT<text> Reads out the user text. 3.2.14.3
MACRO<index>
Reads out the configuration settings of a Macro. Up to 10 macro indices in a range of 0 to 9 can be queries.
3.2.14.4
IO configuration setting
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 75 of 271
Page 76
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
IO.BEEP.ENABLE
Reads out whether the beeper will be turned on during system startup.
3.2.15.1
MOTION configuration Settings
MOTION.FILTER Reads out the motion settings. 3.2.16.1
ALIAS configuration Settings
ALIAS.<type> Reads out the alias name assigned to the type. 3.2.17.1
DBG configuration settings
DBG.EN
Reads out whether or not the debugging mode is enabled.
3.2.18.1
Protocol Configuration Settings (sent via Bluetooth)
PROT.<id>
Reads out the time interval on which a NMEA protocol is transmitted to the Bluetooth serial line
3.2.19
PROT.START.BIN Reads out the contents of your own BIN protocol. 3.2.19.2
GSM configuration Settings
GSM.CALLID.EN Reads out the caller identification settings 3.2.20.2
GSM.CALLTONE.ENABLE Reads out the validity of Call Progress Tones. 3.2.20.3
GSM.OPLOST.RESTART
Reads out the settings when the GSM operator gets lost.
3.2.20.4
GSM.OPERATOR.BLACKLIST Reads out the GSM operator blacklist 3.2.20.5
GSM.OPERATOR.SELECTION Reads out the selected GSM operator 3.2.20.6
GSM.SMS.RESPONSE Returns the number of responses to a SMS 3.2.20.5
GSM.RINGTONE Reads out the type and volume of ring tones. 3.2.20.8
GSM.PROFILE.AUDIO<prof_index>
Reads out the specified profile for loudspeaker volume level and microphone sidetone
3.2.20.9
GSM.PROFILE.CURRENTAUDIO
Reads out the audio profile being used for the headset.
3.2.20.10
GPRS configuration Settings
GPRS.APN Returns the PDP context of your provider 3.2.21.1
GPRS.AUTOSTART Reads out the GPRS connection at startup 3.2.21.2
GPRS.QOSMIN
Reads out the minimum acceptable profile for the identified context
3.2.21.3
GPRS.QOS
Reads out the required acceptable profile for the identified context
3.2.21.4
GPRS.DIAL Reads out the dial text for GPRS connection 3.2.21.5
GPRS.TIMEOUT
Reads out the time out in which the GPRS connection is automatically closed if there is no TCP communication currently available.
3.2.21.6
PPP configuration Settings
PPP.USERNAME
Reads out the user name specified for the GPRS network.
3.2.21.5
PPP.PASSWORD
Reads out the password specified for the GPRS network.
3.2.22.2
PPP.AUTOPING
Reads out the amount of time, in milliseconds, on which a ping will be sent to the GPRS network
3.2.22.3
PPP.AUTH
Reads out the authentification method used over PPP.
3.2.22.4
TCP Configuration Settings
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 76 of 271
Page 77
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
TCP.CLIENT.CONNECTTCP.CLIENT .CONNECT
Reads out the address and port of the specified remote server.
3.2.23.1
TCP.CLIENT.ALTERNATIVE
Reads out the address and port of the specified alternative server.
3.2.22.2
TCP.CLIENT.PING Reads out whether or not ping sending is active. 3.2.23.3
TCP.CLIENT.TIMEOUT
Reads out the specified maximal idle time between two ping requests.
3.2.23.4
TCP.CLIENT.DNS.TIMEOUT Reads out the DNS timeout. 3.2.23.5
TCP.CLIENT.LOGIN
Reads out the specified login data for remote server.
3.3.10.6
TCP.STORAGE
Shows the size of TCP storage and its operation mode.
3.2.23.7
TCP.CLIENT.SENDMODE
Shows whether the TCP transmissions is selected to fast or safe.
3.2.23.8
TCP.SMTP.CONNECT
Reads out the address and port of the specified SMTP server.
3.2.23.9
TCP.SMTP.LOGIN Reads out the login data for SMTP server 3.2.23.10
TCP.SMTP.FROM Reads out the sender email address. 3.2.23.11
Geofence Configuration Settings
GF.CONFIG
Polls the global configuration settings for Geofences
3.2.24.3
GF.AREA<ID>
Polls the areas configuration settings. Up to 32 areas in a range of 0 to 31 can be requested
3.2.24.4
GF<id>
Polls the geofence configuration settings. Up to 100 Geofence zones in a range of 0 to 99, can be requested
3.2.24.5
Alarm Configuration Setting
AL<index>
Polls the alarm configuration settings. Up to 100 alarm indices in a range of 0 to 99, can be requested.
3.2.25
Table 7: The parameters grouped by major category that can be requested to get their
configuration settings.
Notes
The default settings of the firmware version 2.4.0 are given in chapter 6.9 on
page 260.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 77 of 271
Page 78
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.2.3 Cnf.Clear,<parameter_name> - Clears all settings in a
parameter
Command syntax $PFAL,Cnf.Clear,<”parameter_name”>
Examples
$PFAL,Cnf.Clear,”AL”
Responses
E.g. $ALIAS.CNF
$ALIAS.SYS.COUNTER0 $ALIAS.SYS.TIMER0 $ALIAS.SYS.TIMER1 $ALIAS.SYS.TIMER2 $ALIAS.SYS.TIMER3 $ALIAS.SYS.TIMER4 $ALIAS.SYS.TIMER5 $ALIAS.SYS.TIMER6 $ALIAS.SYS.TIMER7 $ALIAS.SYS.TIMER8 $ALIAS.SYS.TRIGGER0 $ALIAS.SYS.TRIGGER1 $ALIAS.SYS $AL0 $AL1 $AL2 $AL8 $AL9 $AL10 $AL11 $21 entries erased and deactivated $SUCCESS
Command description
The command clears the configuration settings of the specified parameter name. For example, with a single PFAL command, erases all parameters that start with “AL”. The default settings (see chapter 6.9 on page 260) remain available.
Parameter description
<”parameter_name”>
It specifies the name of the parameter, in capital letters and wrapped in quotation marks, for erasing its present settings. Set one of the parameters listed in the chapter 3.2.10, page 143.
Notes
The name of the parameter (or the start characters) must be written in capital
letters.
No semicolon may be inside the specified parameter name.
If several user configuration settings would match the specified parameter
name, a list of all deleted parameters is given out.
The default settings cannot be erased.
If many configuration settings have to be erased, this command might need
several seconds to complete the process.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 78 of 271
Page 79
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.2.4 Cnf.ShowUser - Shows user specified settings
Command syntax $PFAL,Cnf.ShowUser
Examples
$PFAL,Cnf.ShowUser
Responses
E.g. $DEVICE.GPS.STARTUP=on
$DEVICE.GPS.TIMEOUT=1,30 $DEVICE.GSM.STARTUP=on $DEVICE.IEEE.STARTUP=off $DEVICE.IGNTIMEOUT=60000 $DEVICE.SLEEP.IGN=1 $DEVICE.PFAL.SEND.FORMAT="$",CKSUM,"","$<end>" $DISP.MENU1.0=Phonebook $DISP.MENU1.1=Office:GSM.VoiceCall.Dial,"+49200000000" $DISP.MENU1.2=Home:GSM.VoiceCall.Dial,"+493600000000" $DISP.MENU2.0=Messages $DISP.MENU2.1.0=Incoming SMS $DISP.MENU2.1.1=Last SMS:DISPLAY.Show=VIEW_SMS $DISP.MENU2.2.0=Outgoing SMS $DISP.MENU2.2.1=Last SMS:DISPLAY.Show=VIEW_SMS
end so on ...
Command description
This command delivers all parameter names that are modified/added by the user.
Parameter description
none.
Notes
Except default configuration, all other parameter names with their settings are
delivered.
3.2.2.5 Cnf.ShowDefault - Shows default settings
Command syntax $PFAL,Cnf.ShowDefault
Examples
$PFAL,Cnf.ShowDefault
Responses
E.g. $DEVICE.SERIAL.BAUDRATE=115200
$DEVICE.GPS.BAUDRATE=38400 $DEVICE.COMM.SERIAL=cmd,F $DEVICE.CMD.PFAL.EN=F $DEVICE.PFAL.SEND.FORMAT="$",CKSUM,"","$<end>" $DEVICE.BAT.MODE=always,3.55 $DEVICE.IGNTIMEOUT=60000 $DEVICE.SLEEP.IGN=1 $DEVICE.GPS.STARTUP=on $DEVICE.GPS.AUTOCORRECT=off,5.0,127,50,10 $DEVICE.GPS.TIMEOUT=1,30 $DEVICE.GPS.CFG=3
and so on ...
Command description
This command delivers all default parameter names. See default settings listed in chapter 6.9 page 260.
Parameter description
none.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 79 of 271
Page 80
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.2.6 Cnf.Show - Shows all used parameters
Command syntax $PFAL,Cnf.Show
Examples
$PFAL,Cnf.Show
Responses
E.g. $DEVICE.SERIAL.BAUDRATE=115200
$DEVICE.GPS.BAUDRATE=38400 $DEVICE.COMM.SERIAL=cmd,F $DEVICE.CMD.PFAL.EN=F $DEVICE.PFAL.SEND.FORMAT="$",CKSUM,"","$<end>" $DEVICE.BAT.MODE=always,3.55 $DEVICE.IGNTIMEOUT=60000 $DEVICE.SLEEP.IGN=1 $DEVICE.GPS.STARTUP=on $DEVICE.GPS.AUTOCORRECT=off,5.0,127,50,10 $DEVICE.GPS.TIMEOUT=1,30
$DEVICE.GPS.CFG=3
$DEVICE.GPS.STARTUP=on $DEVICE.GPS.TIMEOUT=1,30 $DEVICE.GSM.STARTUP=on $DEVICE.IEEE.STARTUP=off $DEVICE.IGNTIMEOUT=60000 $DEVICE.SLEEP.IGN=1 $DEVICE.PFAL.SEND.FORMAT="$",CKSUM,"","$<end>" $DISP.MENU1.0=Phonebook $DISP.MENU1.1=Office:GSM.VoiceCall.Dial,"+49200000000" $DISP.MENU1.2=Home:GSM.VoiceCall.Dial,"+493600000000" $DISP.MENU2.0=Messages $DISP.MENU2.1.0=Incoming SMS $DISP.MENU2.1.1=Last SMS:DISPLAY.Show=VIEW_SMS $DISP.MENU2.2.0=Outgoing SMS
$DISP.MENU2.2.1=Last SMS:DISPLAY.Show=VIEW_SMS
end so on ...
Command description
This command outputs all new defined parameter names.
Parameter description
None.
Notes
Default settings are displayed, when no new settings are specified for that
parameter. For example, if the user changes the device name from default “unnamed MAMBOII” to a new name “myMAMBOII”, and then performs a request with the “$PFAL,Cnf.Show” the MAMBOII outputs the new defined parameter settings “myMAMBOII” .
If the user has cleared a parameter value, the default value will be shown.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 80 of 271
Page 81
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.2.7 Cnf.Search,<parameter_search> – Searches for a parameter name
Command syntax $PFAL,Cnf.Search,<parameter_search>
Examples
$PFAL,Cnf.Search,”DEVICE” $PFAL,Cnf.Search,”TCP” ………..
Responses
E.g. $ALIAS.CNF=Config
$ALIAS.SYS.COUNTER0=_RESET $ALIAS.SYS.TIMER0=_1SEC $ALIAS.SYS.TIMER2=_7SEC $ALIAS.SYS.TRIGGER1=TRIGGER_ARM $ALIAS.SYS.TIMER8=_60SEC $ALIAS.SYS=System $AL0=SYS.Device.eStart:SYS.TIMER_1SEC.start=cyclic,1000&SYS.TIMER_60S
EC.start=cyclic,60000&SYS.TIMER_60SEC.start=cyclic,60000&SYS.TIMER_7S EC.start=cyclic,7000
$AL1=SYS.TIMER.e_20SEC&TCP.Client.sConnected&GPS.Nav.Position.s0>100: GPS.Nav.Position0=current&TCP.Client.Send,8,""
and so on ....
Command description
This command pools all available parameters and settings that start with the entered characters <parameter_search>.
Parameter description
<parameter_search>
Determines the text, in capital letters, to be searched. The specified text must be wrapped in quotation marks (""). The text to be searched can be one of the parameter names listed in chapter 3.2.10, page 143.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 81 of 271
Page 82
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -

3.2.3 “IO” command type

Inputs/outputs are hardware-based signals, which can be used to notify the user when system events raise. For example, you might want to be notified when an incoming voice call detected, or when the BTN0 button is pressed or when the internal battery reaches a certain voltage level. Following notification methods can be implemented:
Beep (plays a sound through the device's speaker), Vibration alert,
3.2.3.1 “Beep” command index
3.2.3.1.1 IO.Beep<index>=<config_type> – Generates beep tones
Command syntax $PFAL,IO.Beep<index>=<config_type>
Examples
$PFAL,IO.Beep1=high $PFAL,IO.Beep2=low $PFAL,IO.Beep3=hpulse,5000 $PFAL,IO.Beep0=cyclic,500,1000
…… $PFAL,IO.Beep23=…..
Responses
E.g. $SUCCESS
Command description
The MAMBOII device provides up to 24 different beep tones. Using this command you can select the beep tone to be generated, for example, when the device receives a SMS, call, GPS-fix, TCP connect, etc.
Parameter description
<index>
It specifies the beep tones index. The index can be set to a value from 0 to 23. Each of them has a particular sound.
<config_type>
Configures settings related to generating a beep on the device. It can be set to:
Value Meaning
high Generates continuous beep.
low Disables continuous or cyclic beep.
hpulse,<high_time> Generates a single beep for a given period of time
<high_time>.
lpulse,<low_time> Disables a continuous or a high beep for a given
period of time <low_time>.
cyclic,<high_time>,<low_time> Generates cyclic beeps for the given time
periods <high_time> and <low_time> respectively.
<high_time>
Specifies the number of milliseconds to generate a beep.
<low_time>
Specifies the number of milliseconds to disable the beep.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 82 of 271
Page 83
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.3.2 “Vibration” command index
3.2.3.2.1 IO.Vibration=<config_type> – Manages device vibrations
Command syntax $PFAL,IO.Vibration=<config_type>
Examples
$PFAL,IO.Vibration=hpulse,5000 $PFAL,IO.Vibration=cyclic,500,1000
Responses
E.g. $SUCCESS
Command description
This command makes the device vibrate, for example, when the device receives a GSM call, SMS, TCP packet etc.
Parameter description
<config_type>
Configures settings related to generating a vibration on the device. The <config_type> can be set to:
Value Meaning
high Continuous vibration.
low Disables continuous vibration.
hpulse,<high_time> Vibrates for a period of time given in milliseconds
<high_time>.
cyclic,<high_time>,<low_time> Generates cyclic beeps for the given time
periods <high_time> and <low_time> respectively.
<high_time>
Specifies the number of milliseconds to generate a beep.
<low_time>
Specifies the number of milliseconds to disable the beep.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 83 of 271
Page 84
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -

3.2.4 “GPS” command type

3.2.4.1 “Nav” command index
3.2.4.1.1 GPS.Nav.Position<buffer_index> – Gets the travelled distance from a
stored position
Command syntax $PFAL,GPS.Nav.Position<buffer_index>
Examples
$PFAL,GPS.Nav.Position0
Responses
E.g. $position 0 is set
Command description
The command retrieves the number of meters driven from a stored position <buffer_index>.
Parameter Description
<buffer_index>
Integer type, specifies the memory buffer index in the range from 0 to 4.
3.2.4.1.2 GPS.Nav.Position<buffer_index>=<type> – Stores temporarily a GPS
position
Command syntax $PFAL,GPS.Nav.Position<buffer_index>=<type>
Examples
$PFAL,GPS.Nav.Position1=current $PFAL,GPS.Nav.Position0=none $PFAL,GPS.Nav.Position2=pos50.683317,10.980760,490.0
Responses
E.g. $position 1 set to current
$SUCCESS
OR
$position 2 set to fixed position $SUCCESS
OR
$ERROR //If no GPS-fix available
Command description
This command stores current or user-defined GPS position into the specified position <buffer_index>. After a device position has been stored into a <buffer_index>, you may launch certain action based on the distance calculated from this saved position and current position of the device.
Parameter Description
<buffer_index>
Integer type, specifies the memory buffer index in the range from 0 to 4. The data in a buffer index is stored temporarily. The content of each buffer index is available as long as the internal software is running. Should the device be reset, switched off, or goes into sleep mode, each index loses its contents forever. Each memory buffer index can be updated with new data or the available data on them can be erased.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 84 of 271
Page 85
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
<type>
Defines the type of the GPS position to be saved. Following types can be defined.
Value Meaning
none Clears the contents of the <buffer_index>
current Stores the current GPS position into the <buffer_index>
pos<lat>,<lon>,<alt> Stores temporarily a user-defined location
(comma-separated latitude, longitude and altitude). The
<lat>,<lon> and <alt> are given in decimal format. The <alt>
determines the altitude, in meters, above sea level. If you do not know exactly the altitude of that location then specify a circa value excluding the decimal dot “.” (integer value).
Notes
This command enables periodically sending of messages based on distance
covered by the device.
Current GPS position of the device will be stored into a <buffer_index>, if there
is a valid GPS fix.
3.2.4.1.3 GPS.Nav.Position<buffer_index>=save<storage_index> – Moves GPS
position data from buffer to storage index
Command syntax $PFAL,GPS.Nav.Position<buffer_index>=save<storage_index>
Examples
$PFAL,GPS.Nav.Position3=save0
Responses
E.g. $Position 1 saved
Command description
This command moves the contents of the selected <buffer_index> and stores it into the selected <storage_index> for permanent use. The contents of the selected
<storage_index> can be refreshed with a new one while the data in the <buffer_index> remains unchanged. This command is used to memorize a position
during system reset, a system shutdown or a sleep mode.
Parameter description
<buffer_index>
Integer type, specifies the memory buffer index in the range from 0 to 4. The data in a buffer index is stored temporarily. The content of each buffer index is available as long as the internal software is running. Should the device be reset, switched off, or goes into sleep mode, each index loses its contents forever. Each memory buffer index can be updated with new data or the available data on them can be erased.
<storage_index>
Integer type, specifies the storage index in the range from 0 to 4. Each storage index is a portion of FLASH memory in which determined data written on them will not be lost when the device performs a reset, goes into sleep mode or is turned off. Each storage index has a fixed size space and each of them can be updated with new data. Read also the description of storage index given in the table of abbreviations.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 85 of 271
Page 86
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
Notes
An Alias name can be defined for each storage index by using
ALIAS.STORAGE<storage_index>=<alias_name>. Read also the description of storage index given in the table of abbreviations.
3.2.4.1.4 GPS.Nav.Position<buffer_index>=load<storage_index> – Loads GPS
data from storage to buffer index for temporarily use
Command syntax $PFAL,GPS.Nav.Position<buffer_index>=load<storage_index>
Examples
$PFAL,GPS.Nav.Position3=load0
Responses
E.g. $Position 3 loaded
Command description
This command loads the contents of the selected <storage_index> into the selected <buffer_index> for temporarily use. The selected buffer index will be updated with
new data while the contents of the <storage_index> remains unchanged. Do not use other data stored from a Timer or a Trigger, just GPS position. Validate this content before using it.
Parameter description
<buffer_index>
Integer type, specifies the memory buffer index in the range from 0 to 4. The data in a buffer index is stored temporarily. The content of each buffer index is available as long as the internal software is running. Should the device be reset, switched off, or goes into sleep mode, each index loses its contents forever. Each memory buffer index can be updated with new data or the available data on them can be erased.
<storage_index>
Integer type, specifies the storage index in the range from 0 to 4. Each storage index is a portion of FLASH memory in which determined data written on them will not be lost when the device performs a reset, goes into sleep mode or is turned off. Each storage index has a fixed size space and each of them can be updated with new data. Read also the description of storage index given in the table of abbreviations.
Notes
An Alias name can be defined for each storage index by using
ALIAS.STORAGE<storage_index>=<alias_name>. Read also the description of storage index given in the table of abbreviations.
3.2.4.1.5 GPS.Nav.Distance – Gets the current travelled distance from a start
point
Command syntax $PFAL,GPS.Nav.Distance
Examples
$PFAL,GPS.Nav.Distance
Responses
e.g. $current distance: 1000 m
Command description
This command returns the current covered distance, in meter, since the device has left a known start point. When the MAMBOII device has got a valid GPS fix, the MAMBOII stores internally a start point. The stored distance, which is based on a point-to-point calculation, results automatically updated once the vehicle (equipped with a MAMBOII) starts moving.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 86 of 271
Page 87
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
Parameter description
None
Notes
To get the distance that the device has covered (e.g. during a trip), firstly
reset the distance to zero using $PFAL,GPS.Nav.Distance=0 (see next section) and when the destination point of the trip is reached, simply request the driven distance using $PFAL,GPS.Nav.Distance.
If you reset the device during the trip, the covered distance will be set to zero.
3.2.4.1.6 GPS.Nav.Distance=<value> – Sets/resets the distance to a user value
Command syntax $PFAL,GPS.Nav.Distance=<value>
Examples
$PFAL,GPS.Nav.Distance=0 $PFAL,GPS.Nav.Distance=10
Responses
Command description
This command resets the distance to a user-defined value, which may represent either a new start point or the distance tolerance from where a trip starts.
Parameter description
<value>
Integer type value in the range 0 to 2147483647.
Notes
Each value sent to the device overwrites the existing value.
3.2.4.1.7 GPS.Nav.SaveLastValid – Saves the last valid position, if no GPS-fix
valid
Command syntax $PFAL,GPS.Nav.SaveLastValid
Examples
$PFAL,GPS.Nav.SaveLastValid
Responses
E.g. $last valid position saved to configration
Command description
If MAMBOII is currently receiving invalid GPS position data, an empty RMC message will be stored (RMC data containing only zero values). To prevent storing of this invalided GPS data, utilize this command as an alarm (AL2=Sys.Device.eShutdown:GPS.Nav.SaveLastValid) to store the last valid position to non-volatile memory before the MAMBOII device goes to sleep. This data stored in non-volatile memory will be needed on the next power up scenario. If during the next start-up scenario there is no valid GPS fix, the stored last valid position will be automatically attached to “MSG.Info.Serverlogin“ command and sent to the remote server. In this way you always receive valid GPS position instead of a RMC protocol containing only zero values (if the device has an invalid GPS-fix after start­up, only).
Parameter description
none.
Notes
Due to the non volatile memory is limited to several 100'000 write operations, it
is strongly recommended to prevent periodically saving of last valid position in a short amount of time.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 87 of 271
Page 88
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.4.1.8 GPS.Nav.PowerSave=<on>,<onTime>,<lpTime> – Enables/Disables the
low power mode
Command syntax $PFAL,GPS.Nav.Powersave=<on>,<onTime><lpTime>
Examples
$PFAL,GPS.Nav.Powersave=on,400,2000 $PFAL,GPS.Nav.Powersave=off
Responses
E.g. $SUCCESS
Command description
This command enables or disables individually the low-power mode of the integrated high sensitive GPS receiver. By default, it is disabled (off).
Parameter description
<on>
String type. Enables or disables low-power mode. It can be set to:
Value Meaning
on Enables low-power mode.
off Disables low-power mode.
<onTime>
Integer type in the range 200 to 900. It defines the OnTime period, in milliseconds, the GPS receiver will stay in full power state until a GPS position solution (fix) is made and estimated to be reliable.
<lpTime>
Integer type in the range 1000 ... 10000. It defines the complete interval of time, in milliseconds, the embedded GPS receiver will stay in full and low power states.
Note:
For optimum performance, it is recommended to use either 300 ms onTime
and 1000 ms lpTime or 400 ms onTime and 2000 ms lpTime.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 88 of 271
Page 89
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.4.2 “History” command index
The GPS satellites are continuously transmitting a radio message containing information, including when the data was sent. When the GPS receiver fitted in the vehicle is powered on, through the connected GPS antenna, it receives continuously the radio messages sent from satellites containing GPS information the sent data. The received information from at least 4 satellites will be computed and carried out the necessary calculations to determine its current position. This data solution can be stored in the on­board Flash memory for further evaluation.
The History functions enable the MAMBOII device to store the position and time into the history storage space (a portion of FLASH which uses 960 Kbytes memory size). When the MAMBOII unit has obtained a GPS Fix, it is capable of saving up to 245.715 position records in its history memory space. The History function works on what is called a FIFO principal: First in, first out, it means when the memory space has been used up, the oldest records will automatically be deleted to make space for new incoming data.
3.2.4.2.1 GPS.History.Write,<flag>,<”text”> – Stores GPS data or user text in the
history memory
Command syntax $PFAL,GPS.History.Write,<flag>,<”text”>
Examples
$PFAL,GPS.History.Write,20,“enter_the_text_to_be stored” $PFAL,GPS.History.Write,40,”” $PFAL,GPS.History.Write,0,””
Responses
E.g $SUCCESS
Command description
This command records a new GPS position entry (including current position, speed, number of satellites and time) into the history memory space. Additional information can be attached to each entry, if the <flag> and <”text”> parameters are defined. Entries can be written without having a valid GPS fix (i.e. store user messages, IN/OUT states or other additional information).
Parameter Description
<flag>
It determines whether or not additional information has to be stored in the history memory. Following are listed for additional information in hexadecimal value (specify it excluding “0x”):
Value Meaning
0x00 Writes the current GPS position of the device.
0x01 Writes the current state of the Iinput and Output.
0x02 Writes the current state of the GSM (field strength, cell id,
area code, of incoming/outgoing SMS etc.)
0x04 Writes the current operating mode of the system, GPRS,
PPP, TCP, system lifetime.
0x08 reserved.
0x10 Writes the current analog values (for FALCOM devices
that have analog inputs only) .
0x20 Writes the specified text from the <”text> field (up to 99
characters available)
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 89 of 271
Page 90
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
0x40 Writes the current state of the Geofence areas (inside or
outside of a marked area)
0x80 reserved
<”text”>
It is a string that represents user information. The specified text is limited to 99 characters and it must be wrapped in quotation marks (" "). If no user text has to be written, this field can be left empty, except quotation marks (""). The hex value (20) will be added automatically to the <flag> if the user text is not empty.
Notes
Do NOT execute this command more often than once per second.
Entries can be written without having a fix. In such a case the entries may
store the user messages, the IN/OUT states or other additional information.
Whenever a record is stored in the history, it will be „invalid“, if there is no GPS-
fix currently available. However, each entry can store:
The internal last valid position (if available)Or the last stored valid position (if available)Or an empty data “ECEF:0,0,0”
Whenever there is no GPS-fix currently available, the most recent available
timestamp is captured from:
Last valid position if it is the newest timestamp of the systemOr locally shown RMC if this is the most recent timeOr internal time is used that means the date can start from 06.01.1980.
When you retrieve the history records remember that only records with a valid
GPS fix show absolutely a reliable timestamp. Please read also Notes of SetRead and Read for further details.
In order to attach more than one additional information at once, specify the
sum determined by adding the corresponding hex value of each additional information, for example:
the hex value 7 means: IN/OUT +GSM+ system states will be stored
together with current location of the device at once.
3.2.4.2.2 GPS.History.Clear– Clears the history memory
Command syntax $PFAL,GPS.History.Clear
Examples
$PFAL,GPS.History.Clear
Responses
e.g. $history cleared (duration: 3,750 seconds)
Command description
This command clears all records available in the history memory.
Parameter Description
None
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 90 of 271
Page 91
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.4.2.3 GPS.History.GetStart– Shows the oldest date stored in the history
memory
Command syntax $PFAL,GPS.History.GetStart
Examples
$PFAL,GPS.History.GetStart
Responses
E.g. $history starts at 14.02.2007,01:56:26
Command description
This command returns the oldest date available in the history memory.
Parameter Description
None
3.2.4.2.4 GPS.History.SetRead,<s_date>,<s_time>-,<e_date>,<e_time>– Selects
the number of records to be downloaded from the history memory
Command syntax
$PFAL,GPS.History.SetRead,all
$PFAL,GPS.History.SetRead,<s_date>,<s_time>-<e_date>,<e_time>
Examples
$PFAL,GPS.History.SetRead,all $PFAL,GPS.History.SetRead,14.6.2005,10:5:20-14.6.2005,10:06:16
Responses
E.g. $345109 Bytes (337 KB) estimated for readout inside history
Command description
Using this command the records in the history memory can be selected/marked and prepared for download. The start date/time and end date/time allow downloading of records within a certain range, only. In order to choose/mark all records in the history memory use “GPS.History.SetRead,all rather than the start date/time and the end date/time. All records available in the history are based on the UTC time (Universal Time Coordinated). Therefore, consider when you specify the start date/time and the end date/time.
Parameter Description
<s_date>
Specifies the start date. Its format is DD.MM.YYYY
Value Meaning
DD Represents the day as a number (1-31)
MM Represents the month as a number (1-12).
YYYY Represents the year as a four-digit number (1900-9999).
<s_time>
Specifies the start time. Its format is HH:MM:SS
Value Meaning
HH Represents the hour (0-23).
MM Represents the minute (0-59).
SS Represents the second (0-59).
<e_date>
Specifies the end date. Its format is DD.MM.YYYY
Value Meaning
DD Represents the day as a number w (1-31)
MM Represents the month as a number (1-12).
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 91 of 271
Page 92
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
YYYY Represents the year as a four-digit number (1900-9999).
<e_time>
Specifies the end time. Its format is HH:MM:SS
Value Meaning
HH Represents the hour (0-23).
MM Represents the minute (0-59).
SS Represents the second (0-59).
Notes
If the start date or end time is greater than the date or time of the latest
stored record, then no records can be selected. It results as an invalid argument. The MAMBOII device will respond with an ERROR.
If the end date is greater then the date included in the latest stored record,
then all records beginning from the given start date will be chosen.
This command does not download the history data, it just chooses/selects the
records for download. The download process starts once the device receives the GPS.History.Read command (see next section).
3.2.4.2.5 GPS.History.Read – Downloads the selected history records in parts
Command syntax GPS.History.Read,fmt=<format>
Examples
$PFAL,GPS.History.Read $PFAL,GPS.History.Read,fmt=txt
Responses
E.g.$14.02.2007,01:56:26,1,7,19.7606457,-135.0000000,-
6380557.66,7,0:11111111.11101111,1:255.6FFF.76FF.111.127.127.222.158, 2:111.39.125.253.1534050047,4:3223.4;5733.4,5:W¿ ¾ÿÿ÷ÿ?tÎû þ³{÷Ó~û«ÿý ÿï| ¿¾ÿ½{ò~ÿmë÷ÿý¿ ÿ ÿÛ~M;ÿ÷ï· öÿ®ûÿ~½?ߺþþÿç  ン яхo¿~»Хv_юП¿ у¯я яыюыыычv]л яяяЯ пяяП¯}~Яю{щзющ яяяwя~юы э¿ыяфяюлпя»{{ыпП¿эчопяпчvл=eпцч}щяwю }яээ я+¿оªямЯ¿лю_э¿ЧяъчлЬяяпыYч§я_þý?ûwßZ ÿ?×~,6:AC71.FFEF
$18.02.2007,01:56:26,1,7,4.7647032,-130.6012946,-
6378247.30,7,0:11111111.11111110,1:203.FFFF.EF5F.246.255.247.255.255,2 :247.253.253.245.-8388681,4:6552.3;6527.7,5: яяюпЯяяы¿ыЭуся{Дюп{[я·ю®ячяy¿яяяяпэя¿яьяя¿ппяUя {ЯwяпъьЭчП?~яъяяц Эл¹ í÷÷÷¿ÿÿþ Ýÿÿ~÷zgÿÿÿ ÿý~ûûÿÿ{ó·ÿûÿlÿ¿û{ÿßÿó?ÖÞnÿç {ÿÿ»¯ÿÿû ÿÿÿÿ~o {o¯û÷Þ 7чпэяячэччыючыяэяяюЯяя·{tэяя¿хячпяяя³яЯ яяЯяч¯яя¾ю¾я ?чяяЯяя[«яZыял¿юЯ ÿkýÿÿþ _¿ü,6:FFFF.FFFF
$SUCCESS
Message description
The purpose of this command is to transfer partly the selected history records to an Internet TCP server via TCP protocol or to the serial interface via a serial cable. Before you can use this command for transferring history records to a remote server, the MAMBOII must already be connected to that server. Once you have marked a set of records in the history with $PFAL,GPS.History.SetRead command, to start the download process send this command to the remote MAMBOII. This command executes the download process of the marked history records. If such records are found in the history, the download process results in following way:
By default, transferring of history records results in binary format. The description of
the binary data is given in chapter 6.7 Appendix on page 257. Other formats are also available, see parameter description of this command.
The download process consists of block sizes equivalent to 512 bytes (1/2
kilobyte) per stream / per command.
All selected records (block of records) will not be transmitted at once, except
if the size of the selected records is 512 bytes or smaller.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 92 of 271
Page 93
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
Each time the system MAMBOII receives the GPS.History.Read command, it
responds with a maximum packet size of 512 bytes even if the size of the marked records is larger than 512 bytes. It means as larger the size of the selected history data, as more GPS.History.Read commands have to be sent to the target device.
When the selected history records have been successfully downloaded, the
MAMBOII device responds a message “readout completed”.
Example:
To download a 16 Kbytes set of records equivalent to 16384 bytes, you have to send 32-times (16384 byte: 512 bytes = 32 times) the GPS.History.Read command to the target MAMBOII device.
Parameter Description
<format>
It defines the format of the history (logged) records to be downloaded. It can be defined to:
Value Meaning
bin Downloads history records in the binary format (default) It
is the same as you send only GPS.History.Read).
txt Downloads history records in a special textual format. A
brief description of this format can be found in the next sub-chapter.
rmc A standard RMC protocol is generated for each history
entry.
Notes
Note, the maximum number of bytes that can be downloaded at once is
predefined to 512 bytes.
To download the history records, please consider that the start date/time and
end date/time are based on the UTC Time, otherwise you will download the stored history records in the incorrect time.
No PFAL commands could be entered/executed after the time the
command has been sent until the download process is successfully done.
Advantage to this command: As above, this command does not download
the all history records you have selected at once. It splits the size of the selected records in 512 bytes per packet and sends a 512 bytes packet out upon user request. Splitting history data to several packets allows the remote server to execute arbitrary commands even if the history readout process has been started. Reading history packets can continue whenever it is desired (but before you shut down or reset the MAMBOII device).
3.2.4.2.5.1 How to read the history records in textual format
Each history entry is reported within a single line of the following format.
$<history_entry_standard><history_entry_extension><CRLF>
Format Example Description
$ $ Start of records
<history_entry_standard> <date>,<time>,<fix>,<minsats>,<lat>,<lon>,<alt>,<speed>
dd.mm.yyyy 13.10.2006 Date: dd day, mm month, yy year separated by dots.
hh:mm:ss 13:26.56 Time: hh hours, mm minutes, ss seconds separated by colons.
dd.mmmmmm 50.673325 Latitude, a double value in decimal degrees format.
dd.mmmmmm 10.980685
Longitude, a double value in decimal degrees format.
dd.m 600.9 Altitude, an approximate height value (08000) above sea level in
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 93 of 271
Page 94
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
meter format.
x 1 GPS position validity:
0: invalid 1: GPS fix (valid)
xx 03 Number of satellites in view (0 to 15)
xxx 100 Speed, an integer (0225) representing the speed value over the
ground in meter/second format
<history_entry_extention> <ext1>,<ext2>, ….,<extn>
<ext_id>:<data>
1:00001001.00000010It is an optional parameter and is added only if extensions exist.
Extensions are sorted before output, so it is assured that e.g. extension containing IN and OUT state will come first, before all other extensions.
A complete set of extensions, separated by commas, is shown in the table below (sorted: the upper entry comes first).
<CR><LF> End of message termination
Table 8: Reading history records in textual format.
<ext>
<ext_id>:<data>
<ext_id>
<data>
Example Description
1 <IN>.<OUT> 1:00001001.00000010 Separated by dots, it shows the state of input output lines.
IN e.g. 00000000 (I/O7... I/00) unused OUT e.g. 00000000 (I/O7 ... I/00) unused
2 <fieldstrength>.<ar
ea_code>.<cell_id> .<SMS_in>.<SMS_ out>
2:20.5518.4caa.10.9 Separated by dots, it shows both the current GSM network cell
information and incoming/outgoing SMS number. <fieldstrength> GSM field strength (0 to 31) 0: $-$113 dB
31: $-$51 dB (99=unknown) <area code> area/country code of GSM operator <cell_id> GSM cell ID <SMS_IN> Incoming SMS number <SMS_out> Outgoing SMS number
4 <GPRS>.<PPP>.<
TCP>.<Main>.<Life time>
4:1.2.3.4.20000 Separated by dots, it shows the current system state.
<GPRS> current GPRS state <PPP> current PPP state <TCP> current TCP state <Main> current main state <lifetime> current time since the device started (in
milliseconds) There is no more information about the states given above. They should
be used for debugging purposes only (i.e. to report when a system state changes or how the system state was at a specific time). This information might be useful and should be sent within support requests.
8 Alarm event (not yet implemented)
10 <analog0>;<analog1>10:5.24;5.24 Separated by semicolon, it shows the current state of the analog inputs.
<analog0> fractional number – e.g. 5.24 <analog1> fractional number – e.g. 5.24
20 "<user_specified_te
xt>"
Wrapped in quotation marks, it shows the user message. <user specified text> It can be either a simply text or
outputs of the dynamic protocols.
40 <areas_h>.<areas_l>40:2000.00FC Separated by dot, it shows the area states (feature of Geofencing -
inside or outside of an area) <areas_h> hexadecimal value of area 16..31 (area16
is the least significant bit) <areas_l> hexadecimal value of area 0..15 (area0 is
the least significant bit) It is almost the same syntax as in the GPAREA protocol.
80 reserved
<CRLF>
* Latitude South and Longitude West have negative value indicated by sign minus “ - “
Table 8.1: A complete set of extensions.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 94 of 271
Page 95
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.4.2.5.2 Further notes for converting history data with special remark to data/event logging features
If a record has „no GPS fix“, its position should be ignored for any navigation (the position is invalid, and if it is a differential record, its relative position will be 0 for dx, dy, dz). Furthermore, the shown time is no valid GPS time.
This time is usually reliable in the following case:
The device has had a GPS fix after startup. This fix got lost due to bad GPS coverage. The internal time stored inside this record is quite accurate (± a few seconds for a long time span)
This time is not reliable in the following case:
The device has no GPS fix after startup. Only the stored LastValid position (and its time) could be used to initialize the internal clock. MAMBOII uses this time (LastValid) and increments it as long as no valid GPS time available. However, the internal time can be in the past (depending on how long the device has been switched off after saving the LastValidPosition for the last time). History records created with „last valid“ times are ordered correctly – so you can assume which record happened before/after another one in the past ( allows event /data logging). Furthermore, time differences between single records are also correctly shown for a session:
In order to distinguish which records belong to a „session“ in the past (device started, wrote history records and was sent to sleep later), you can do two things:
1. Write a record containing special user data right before saving the last valid position and sending the device to sleep. Whenever, you read out this user data later, you know when the device was sent to sleep (your session ended).
2. As a general hint: whenever a new „full record“ is written, the device probably performs a restart.
- if there is a time gap between the last differential record and the new full record, the device has been sent to sleep (this time gap shows how long the device has been sleeping/shut off)
- if there is no time gap in between, the device wasn’t sent to sleep, which means the time differences between all records of this session are absolutely reliable.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 95 of 271
Page 96
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.4.2.6 GPS.History.Push – Downloads the selected history records at once
Command syntax GPS.History.Push,<msg_output>,<format>
Examples
$PFAL,GPS.History.Push,Serial $PFAL,GPS.History.Push,TCP,fmt=txt
Responses
E.g. $history push activated
$<GPS.History.Read> вэяяп Ышя»яээяя?У_чыЯчю»½уяяУ¾цюя ¿ы_у¿¿яяячя¿я¿яыючпяя½ kыuЛ?·?лу¿пы
Чыºчля?я?ыч]ьыэюяхяль»ЮWыКсЯюТээцыvµямг³ Пwэч·эяЫµБчхуц·гя п чкхпuOлЯ   vя½я?э½яНпяªлvs?опэяЫнщчЯюрнляя~г¿Чч¿wЮйыыЧХoи ¯мяЯп³/чснзяэя <{п?я| òý½õ÷ü¿þè?ñý¾ýgÿ×
$SUCCESS
..........
$<GPS.History.Read> ¿?¯ÿ;ßÌß¿þ½Ûkïûï²vÿîÿ¾ÿ ÷{ý¿úºÿÙ
´ñÿ Юьяпэяэ¿ю~qэ¾Ыын?ЧьПчъч{µ ч_чяпяЯзъ¿ця»жфЯ]lsъ¯яэп®_Oю_ъляЪу ?яГу Æÿû п»я~лщdf²эжЮоХяЧe¯7оэя¸сю··ч?яякg ½ъъУЭя¼шц?яЙР ящ»·ЯлЯQэяяЧяпячя º? ыйы£Ю Ъ Н~яъ¯о?ччsеo?ъЯюяялы яяяяячя|}   ×ЗпюрХхяw¯¿яяЯчяяя£ыеяХояяп¿½Яjoзr[эт}?Ы?эьяз¾х »яуяяoъюяъчяRля~¿яuч ЯязяsNхяящ±пя«oяя¿яЫnэяьно}__iЫЫз>яуц/уяя яя·э»ю¿ы¿y¼}яячºпзя5о^янъЫу яK¿¹яыяцяЯязOХэяязыяяыэ¿ы _лоsяяюуяу¿]я¿гЯЯяяяюж?чыеШя я¿я¿Н{я¯оьЯчэя цяяяяяяЯя¯Gл¿яЯэяП }чkял~юпячЭ
$SUCCESS
..........
Message description
The purpose of this command is to transfer history records to an Internet TCP server via the TCP protocol at once. This command executes the download process of the marked records. If records are found in the history memory space, the download process results in following way:
By default, transferring of history records results in binary format. The description of
the binary data is given in chapter 6.7 Appendix on page 257.
The download process consists of block sizes, equivalent to 512 bytes (1/2
kilobyte) per stream/command.
All selected records (block) will be transferred at once, but still 512 bytes per packet.
That means, to download a bock sizes of records 2 MB you have to send this command just one time.
When the selected records have been successfully downloaded, the MAMBOII
device responds a message “readout completed
Parameter Description
<msg_output>
It defines the channel into which the history data will be downloaded. It can be defined to:
Value Meaning
Serial Outputs history records to the serial port
CSD Outputs history records via an established CSD to an
external modem.
TCP Outputs history records via an established TCP
communication to a remote server.
<format>
This setting is optional (if omitted the history data are retrieved in binary format). It defines the format of the history (logged) data to be downloaded at once via defined channel <msg_output>. It can be set to:
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 96 of 271
Page 97
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
Value Meaning
fmt=bin Downloads history records in the binary format (default) It
is the same as you send only
GPS.History.Push.TCP[Serial,DCS]).
fmt=txt Downloads history records in a special textual format. A
brief description of this format is available in tables Table 8 and 8.1 above.
fmt=rmc A standard RMC protocol is generated for each history
entry.
Notes
Advantage: No multiple Read commands have to be specified.
Disadvantage: During the history readout process, no commands or low
priority alarm actions will be executed. It is also not possible to accept a voice call or send/receive SMS for instance.
Responses to this command are the same as responses to the
GPS.History.Read.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 97 of 271
Page 98
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.4.3 “Geofence” command index
In order to have a basic understanding of conditional logic and geographic coordinates, please refer to chapter 3.2.24, page 198.
3.2.4.3.1 GPS.Geofence.Park.Set –Activates a park area
Command syntax $PFAL,GPS.Geofence.Park.Set
Examples
$PFAL,GPS.Geofence.Park.Set
Responses
E.g. $park position set
$SUCCESS OR $error setting park position //due to bad GPS coverage
$ERROR
Command description
This command activates a park area (GF.0). The index of the park area is factory predefined to 0. It places the MAMBOII (vehicle) into a circular park area, where the current position (including Latitude and Longitude) of the MAMBOII is the center of circle and the user specified <p_value> value (see GF.CONFIG parameter) is the radius, in meter, of the circular area.
Parameter Description
none
Notes
The events GF.e0=inside and AREA.e0=inside are usually occurred from the
GPS.Geofence.Park.Set. Both events (GPS.GF.e0=inside and GPS.AREA.e0=inside) can be used to confirm the proper activation of the
park area.
This command only works if the device has a valid GPS position, because the
<p_value> for the circle is GPS-dependant (to know when the vehicle leaves this circle).
If the MAMBOII device has got a valid GPS-fix, the GPS.GF.e0=inside and
GPS.AREA.e0=inside will occur indicating the park area is properly set.
To deactivate the park area, use the GPS.Geofence.Park.Remove command.
This command will be written in the Flash memory, so even when the device
performs a reset, the park area will remain active until it is manually deactivated. Whenever the system restarts, and the park area remains active, the events GPS.GF.e0=inside and GPS.AREA.e0=inside are occurred as soon as the MAMBOII receives valid GPS position.
3.2.4.3.2 GPS.Geofence.Park.Remove– Disables the activated park area
Command syntax $PFAL,GPS.Geofence.Park.Remove
Examples
$PFAL,GPS.Geofence.Park.Remove
Responses
E.g. $park position removed
Command description
This command removes an active park area (GF.0).
Parameter Description
none
Notes
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 98 of 271
Page 99
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
The event GPS.GF.e0=inside and GPS.AREA.e0=inside are no longer
available.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 99 of 271
Page 100
CONFIGURATION COMMAND SET - FIRMWARE REVISION 2.4.0_BETA -
3.2.4.3.3 GPS.Geofence.GeoState,<geo_id> – Gets the state of a Geofence
Command syntax $PFAL,GPS.Geofence.GeoState,<geo_ID>
Examples
$PFAL,GPS.Geofence.GeoState,1
Responses
e.g. $device is outside of GF1
Command description
To read out the states of the created Geofence zones, whether the MAMBOII device is inside or outside of the specified Geofence zone, use this command. To configure/establish Geofencing use the GF<id> parameter. Please, use the description of the GF<id> parameter as a reference.
Parameter Description
<geo_ID>
Specifies the Geofence ID-number. Up to 100 Geofences are available. It can be set to a value from 0 to 99. Only already established Geofencing can be read.
3.2.4.3.4 GPS.Geofence.AreaState,<area_id>– Gets the state of an Area
Command syntax $PFAL,GPS.Geofence.AreaState,<area_ID>
Examples
$PFAL,GPS.Geofence.AreaState,1
Responses
e.g. $device is outside of AREA1
Command description
To read out the state of an established area, whether the MAMBOII device is inside or outside of the specified area, use this command. To configure/establish areas use the parameter. Please, use the description of the parameter as a reference.
Parameter Description
<area_ID>
Specifies the ID-number of an area. It can be set to a value from 0 to 31. Only areas that are already established are readable.
This confidential document is a property of FALCOM and may not be copied or circulated without previous permission.
Page 100 of 271
Loading...