Home » Lantronix Manuals » Electronics Accessories » Lantronix FOX3 Series » Manual Viewer

Lantronix FOX3 Series PFAL Command Reference - Page 48

Important Notice, Command description, Parameter description, AvlFW, Notes

View all Lantronix FOX3 Series manuals

Add to My Manuals
Save this manual to your list of manuals

Page 48 highlights

PFAL COMMANDS 4.2.3. Sys.WebUpdate The Firmware Web-Update is an advanced method to perform a remote firmware upgrade over the air. After being activated, the web update itself can be initiated via any available textual user interface using the following commands. Please refer to Application Note "AppNote_WebUpdate_Howto.pdf" for more details. Important Notice: Web-Update is currently under test and therefore, it is not activated per default. In order to activate it, send the command "PFAL,CNF.Set,DEVICE.TCP.WEBUPDATE=1" 4.2.3.1. Sys.WebUpdate.Start - Starts an activated Web-Update Command syntax Examples Sys.WebUpdate.Start,""[,] $PFAL,SYS.WebUpdate.Start,"www.test.com/avl_3.0.0_rc19-Zc0535461.zip",80 FIRMWARE DEVICES FOX3-2G FOX3-3G FOX3-4G BOLERO40 2.16.x 3.0.x 3.1.x 3.2.x MODELS Std. Std. BLE BID AU DR C1-NA C4-NA C1-EU M1 41 43 45     PFAL   Command description This command has the following functions:  Starts an activated Web Update  Web Update is an autonomous feature and becomes active as soon as GPRS is connected  Interrupted downloads (i.e. when the connection drops) are resumed later  Device performs remote update reset when download is completed. Parameter description It specifies the domain name and the path to the firmware file name residing on that server (the path may also include sub-directory separated with/). For example, the "www.test.de/AvlFW/avl_3.0.0_rc19-Zc0535461.zip" instructs the device to go to the www.test.de Web server (www.test.de is a dummy, please specify your web server address), open the folder AvlFW and access the file named avl_3.0.0_rc19Zc0535461.zip. [] It specifies the optional port number (by default, the port number for a Web server is 80) for HTTP protocol. Notes  Please refer to Application Note "AppNote_WebUpdate_Howto.pdf" for more details.  It is strongly NOT recommended to use another remote update when starting web update.  It is not recommended to start web update again while a web update is in progress.  Be sure that the Web-Update is activated via configuration setting before executing this command - if not, the following error may occur: $ PFAL Command Reference 48

Section	Page
PFAL COMMAND REFERENCE	1
Intellectual Property	2
Revision History	3
Table of Contents	9
1. INTRODUCTION	11
1.1. Scope of the document	12
1.2. Quick reference table	13
1.3. Related documents	14
2. GENERAL ABOUT FIRMWARE	16
2.1. Features of the operating firmware	16
2.2. The principle operation	18
2.3. TCP/IP Overview	20
3. PFAL COMMAND SYNTAX REFERENCE	21
3.1. PFAL structure and responses	21
4. PFAL COMMANDS	24
4.1. Alarm	35
4.1.1. Alarm.Info – Displays all conditions defined in a specific alarm	35
4.1.2. Alarm.Clear – Clears and erases a specific alarm	36
4.1.3. Alarm.Reload – Reloads all alarms	36
4.1.4. Alarm.Call – Executes actions on the specified alarm index	37
4.2. SYS	38
4.2.1. Sys.Security	38
4.2.1.1. Sys.Security.Lock,\	38
4.2.1.2. Sys.Security.Unlock,\	39
4.2.1.3. Sys.Security.RemoveLock,\	39
4.2.1.4. Sys.Security.HideAlarm,\	40
4.2.1.5. Sys.Security.UnhideAlarm,\	40
4.2.2. Sys.RUpdate	41
4.2.2.1. Sys.RUpdate.Init – Initializes remote firmware update	41
4.2.2.2. Sys.RUpdate.Abort – Aborts a started remote update and allows writing into the history again	42
4.2.2.3. Sys.RUpdate.DataMode,<msg_input> – Defines the upgrade channel & continues upgrading	44
4.2.2.3.1. Binary update commands	45
4.2.2.3.2. List of binary commands	46
4.2.2.4. Sys.RUpdate.Finish – Finishes a remote update	47
4.2.3. Sys.WebUpdate	48
4.2.3.1. Sys.WebUpdate.Start – Starts an activated Web-Update	48
4.2.3.2. Sys.Webupdate.Stop – Stops a started Web-Update	49
4.2.3.3. Sys.Webupdate.State – Reads the status of the started Web-Update	49
4.2.4. Sys.Device	50
4.2.4.1. Sys.Device.Reset – Initiates a device restart with optional delay	50
4.2.4.2. Sys.Device.Shutdown – Initiates a device shutdown.	51
4.2.4.3. Sys.Device.FactoryReset – Resets device to the factory defaults	51
4.2.4.4. Sys.Device.ChargeSleep=<wakeup_condition> – Send the device into sleep and activate charging	53
4.2.4.5. Sys.Device.Sleep=<wakeup_condition> – Sends the device into sleep mode	53
4.2.4.6. Sys.Device.Doze=<wakeup_condition> – Sends the device into doze mode	58
4.2.4.7. Sys.Device.CfgUpdateMode – Sets the configuration settings into update mode	59
4.2.4.8. Sys.Device.ClearConfig – Erases the current configuration settings	61
4.2.4.9. Sys.Device.BackupReset – Factory reset and restore backup	61
4.2.4.10. Sys.Device.RestoreBios – Upgrades or downgrades the on-board BIOS	62
4.2.4.11. Sys.Device.ClearAGPS – Erases an existing AGPS file from device	62
4.2.4.12. Sys.Device.PwrManagement.Set,<Options>,<Off_Time>,<On_Time> – Sets the power management options for deep sleep mode - for ROCK device only	63
4.2.4.13. Sys.Device.PwrManagement.EnterSleep – Enters the ROCK device into deep sleep mode	64
4.2.5. Sys.Power	65
4.2.5.1. Sys.Power.Mode - Sets the device into a low power mode	65
4.2.6. Sys.Set/GetTime	66
4.2.6.1. Sys.SetTime – Sets the system time	66
4.2.6.2. Sys.GetTime – Gets the system time	66
4.2.7. Sys.1-Wire	67
4.2.7.1. Sys.1Wire.Enable – Enables the 1-wire bus on the device	67
4.2.7.2. Sys.1Wire.Disable – Disables the 1-wire bus on the device	67
4.2.7.3. Sys.1Wire.Devices – Lists the IDs of the 1-Wire devices connected to the bus	68
4.2.7.4. Sys.1Wire.Temperature – Lists the temperatures of the 1-Wire sensors	68
4.2.8. Sys.GSM	69
4.2.8.1. Sys.GSM.<mode> – Powers on/off the GSM engine	69
4.2.8.2. Sys.GSM.Reset – Initiates a GSM reset	70
4.2.9. Sys.GPS	71
4.2.9.1. Sys.GPS.<mode> – Powers on/off the GPS engine	71
4.2.9.2. Sys.GPS.Reset – Initiates a GPS reset	71
4.2.10. Sys.Timer	72
4.2.10.1. Sys.Timer<index>.Configure<mode>,<timeout> – Configures a specific timer	72
4.2.10.2. Sys.Timer<index>.Start=<timer_settings> – Starts/restarts a specific timer	73
4.2.10.3. Sys.Timer<index>.Stop – Stops a running timer	74
4.2.10.4. Sys.Timer<index>.Pause– Pauses (suspends) a running timer	75
4.2.10.5. Sys.Timer<index>.Resume– Restarts a paused timer	75
4.2.10.6. Sys.Timer<index>.Arm– Arms an initialized and disarmed timer	76
4.2.10.7. Sys.Timer<index>.Disarm– Disarms an initialized and armed timer	76
4.2.10.8. Sys.Timer<index>.Erase - Erases the configuration of a timer	78
4.2.10.9. Sys.Timer<index>.Save<slot_id>– Saves a timer state to a storage slot	78
4.2.10.10. Sys.Timer<index>.Load<slot_id> – Loads the saved timer state from a storage slot	79
4.2.10.11. Sys.Timer<index>.State – Reads the state of a used timer	79
4.2.11. Sys.Trigger	81
4.2.11.1. Sys.Trigger<index>=<state_type> – Sets a Trigger to high or low	81
4.2.11.2. Sys.Trigger<index>– Reads the current trigger state	81
4.2.11.3. Sys.Trigger<index>.Save<slot-id> – Saves the state of trigger to a storage slot	82
4.2.11.4. Sys.Trigger<index>.Load<storage_slot>– Loads a saved trigger from a storage slot	83
4.2.12. Sys.Counter	84
4.2.12.1. Sys.Counter<index>.Set=<value> – Assigns a value to the counter	84
4.2.12.2. Sys.Counter<index>.Increment=<inc_value> – Increments an existing value of the counter	84
4.2.12.3. Sys.Counter<index>.Decrement=<dec_value> – Subtracts an existing value of the counter	85
4.2.12.4. Sys.Counter<index>.Set=<value> – Assigns a value to the counter	86
4.2.12.5. Sys.Counter<index>.Increment=<inc_value> – Increments an existing value of the counter	86
4.2.12.6. Sys.Counter<index>.Decrement=<dec_value> – Subtracts an existing value of the counter	87
4.2.12.7. Sys.Counter<index>.Add – Adds a value to a counter	87
4.2.12.8. Sys.Counter<index>.Sub – Subtracts a value from a counter	88
4.2.12.9. Sys.Counter<index>.Save<slot_id>– Saves the state of a counter to a storage slot	88
4.2.12.10. Sys.Counter<index>.Load<slot_id>– Loads a saved counter from the storage slot	89
4.2.12.11. Sys.Counter<index>.Clear – Sets the value of a counter to 0	91
4.2.13. Sys.nvCounter	92
4.2.13.1. Sys.nvCounter<index>.State – Reports the status of a nvCounter	92
4.2.13.2. Sys.nvCounter<index>.Clear - Clears the status of a nvCounter	93
4.2.13.3. Sys.nvCounter<index>.Set – Assigns a value to the nvCounter	93
4.2.13.4. Sys.nvCounter<index>.Increment=<inc_value> – Increments the existing value of a nvCounter	94
4.2.13.5. Sys.nvCounter<index>.Decrement=<dec_value> – Subtracts the existing value of a nvCounter	94
4.2.14. Sys.Macro	95
4.2.14.1. Sys.Macro<index>– Activates an already configured macro	95
4.2.15. Sys.CAN - 1st CAN bus	96
4.2.15.1. Sys.CAN.Enable – Enables the CAN interface	97
4.2.15.2. Sys.CAN.Disable – Disables the CAN interface	98
4.2.15.3. Sys.CAN.Msg.Add – Adds a CAN message for reading	99
4.2.15.4. Sys.CAN.Msg.Remove – Removes an added CAN message	100
4.2.15.5. Sys.CAN.Msg.Info – Shows a list of all active CAN & CANB messages	101
4.2.15.6. Sys.CAN.Var.Add – Adds a CAN variable to a slot for reading	101
4.2.15.7. Sys.CAN.Var.Remove – Removes an added CAN variable from the slot	104
4.2.15.8. Sys.CAN.Var.Info – Shows settings and current CAN value of the given slot	105
4.2.15.9. Sys.CAN.GetTimings – Shows the hardware timing of the CAN bus	105
4.2.15.10. Sys.CAN.FMS.<mode> – Enables/Disables the CAN-FSM functionalities	106
4.2.15.11. Sys.CAN.OBDII.Enable – Enables OBD-II port on 1st CAN interface (on main port)	106
4.2.15.12. Sys.CAN.OBDII.Disable – Disables the CAN-OBDII functionalities	107
4.2.15.13. Sys.CAN.Timeout – Defines CAN timeout for Idle/active events	107
4.2.15.14. Sys.CAN.OBDII.DTCrq – Requests a diagnostic trouble code message (DTC)	107
4.2.15.15. Sys.Can.DTCO.FMS.<mode> – Enables/Disables tachograph communication via FMS	108
4.2.15.16. Sys.Can.DTCO.SendAPDU – Transfer messages(requests) to a tachograph	108
4.2.15.17. SYS.CAN.CANopen.enable – Enable CANopen on the main interface (8-pin connector)	109
4.2.15.18. SYS.CAN.CANopen.disable – Disable CANopen on the main interface	109
4.2.15.19. SYS.CAN.CANopen.cmd,\	109
4.2.16. Sys.CANB - Second CAN bus	111
4.2.16.1. Sys.CANB.Enable – Enables the second CAN interface on IOBOX-CAN	111
4.2.16.2. Sys.CANB.Disable – Disables thesecond CAN interface on IOBOX-CAN	112
4.2.16.3. Sys.CANB.Msg.Add – Adds a CANB message to the IOBOX-CAN	112
4.2.16.4. Sys.CANB.Msg.Remove – Removes a CANB message from IOBOX-CAN	114
4.2.16.5. Sys.CANB.Var.Add – Adds a CAN variable to the slot	115
4.2.16.6. Sys.CANB.Var.Remove – Removes a CAN variable from the slot	119
4.2.16.7. Sys.CANB.GetTimings – Shows the hardware timing of CANB	119
4.2.16.8. Sys.CANB.FMS.<enable> – Enables/Disables the CAN-FSM functionalities	120
4.2.16.9. Sys.CANB.OBDII.Enable – Enables OBD-II port on second CAN interface (on main port)	120
4.2.16.10. Sys.CANB.OBDII.Disable – Disables the CAN-OBDII functionalities	121
4.2.16.11. Sys.CANB.Timeout – Defines CANB timeout for Idle/active events	121
4.2.16.12. Sys.CANB.OBDII.DTCrq – Requests a Diagnostic Trouble Code message (DTC)	121
4.2.16.13. Sys.CanB.DTCO.FMS.<mode> – Enables/Disables tachograph communication via FMS	122
4.2.16.14. SYS.CANB.CANopen.enable – Enable CANopen on the second interface (8-pin connector)	122
4.2.16.15. SYS.CANB.CANopen.disable - Disable CANopen on the second interface	123
4.2.16.16. SYS.CANB.CANopen.cmd ,\	123
4.2.17. Sys.WLAN	124
4.2.17.1. Sys.WLAN.<mode> – Enables or disables the WLAN module on IOBOX-WLAN	124
4.2.18. Sys.LUA	125
4.2.18.1. Sys.Lua.Start – Starts a Lua script loaded to device	125
4.2.18.2. Sys.Lua.Stop – Stops an already running Lua script	125
4.2.18.3. Sys.Lua.Dump – Reads Lua script source code available on device	125
4.2.18.4. Sys.Lua.Lock,<\	126
4.2.18.5. Sys.Lua.UnLock,<\	126
4.2.18.6. Sys.Lua.Dump,<\	126
4.2.18.7. Sys.Lua.Clear – Clears Lua script available on device	127
4.2.18.8. SYS.LUA.Event,<id>,<\	127
4.2.18.9. SYS.Lua.Start[,<\	127
4.2.18.10. SYS.Lua.Clear[,<\	128
4.2.18.11. SYS.Lua.Info[,<\	128
4.2.18.12. SYS.Lua.Write[,<\	128
4.2.19. Sys.BLE	130
4.2.19.1. Sys.BLE.Enable – Enables BLE in device	130
4.2.19.2. Sys.BLE.Disable – Disables BLE in device	130
4.2.19.3. Sys.BLE.Scan – Scans for new BLE devices	131
4.2.19.4. Sys.BLE.List – Lists available BLE devices	131
4.2.19.5. Sys.BLE.ClearList – Clears the list of BLE sensors saved from last scan	131
4.2.19.6. Sys.BLE.ListDev – Lists of active BLE devices	132
4.2.19.7. Sys.BLE.ListAdd – Lists of added BLE devices	132
4.2.19.8. Sys.BLE.ListRel – Lists of released BLE devices	133
4.2.19.9. Sys.BLE.Select,<index> – Selects a BLE beacon by index in the list	133
4.2.19.10. Sys.BLE.Show,<index>,<”text”> – Shows one of the entries in the list	134
4.2.20. Sys.BlueID	135
4.2.20.1. Sys.BlueID.SetTicket – Sets booking for car sharing	135
4.2.20.2. Sys.BlueID.ListTickets – Lists available tickets	136
4.2.20.3. SYS.BlueID.ClearTicket – Clear all available tickets	136
4.2.20.4. SYS.BlueID.ClearLastTicket – Clear last available ticket	136
4.2.20.5. SYS.BlueID.SetState – Clear last available ticket	137
4.2.21. Sys.NFC	138
4.2.21.1. Sys.NFC.Enable – Enables NFC reader	138
4.2.21.2. Sys.NFC.Disable – Disables NFC reader	138
4.2.21.3. Sys.NFC.reset – Resets NFC reader	139
4.2.21.4. Sys.NFC.Play – Plays specific tones on buzzer on NFC reader	139
4.2.21.5. Sys.NFC.LED – Sets LED behaviours on NFC reader	140
4.2.22. Sys.UserEvent	142
4.2.22.1. Sys.UserEvent<index> – Creates an user-event	142
4.2.23. Sys.WhiteList	143
4.2.23.1. Sys.Whitelist.Info – Counts and shows the number of entries in the whitelist	143
4.2.23.2. Sys.Whitelist.Show – Shows the contents of the entries defined in the whitelist	143
4.2.23.3. Sys.Whitelist.Clear – Erases all whitelist entries	144
4.2.23.4. Sys.Whitelist.Set<index>=<\	144
4.2.23.5. Sys.Whitelist.Get,<index> – Reports the assigned text of the specific index	145
4.2.24. Sys.Bat	146
4.2.24.1. Sys.Bat.Voltage – Queries the current battery voltage	146
4.2.24.2. Sys.Bat.ChargeMode – Enables and disables the battery charging	146
4.2.24.3. Sys.Bat.ChargeState – Gets the current battery charge status	147
4.2.24.4. Sys.Bat.Mode – Set the battery power mode	148
4.2.25. Sys.MSG	150
4.2.25.1. MSG.Event – Transmit and execute user defined commands	150
4.3. CNF	152
4.3.1. Cnf.Set,<parameter_name=value> - Checks/Sets/Stores the parameter settings into the device	152
4.3.2. Cnf.Get,<parameter_name> - Gets parameter settings from device	157
4.3.3. Cnf.Clear,<parameter_name> - Clears settings of the parameter name	158
4.3.4. Cnf.ShowUser - Shows the configuration settings defined by the user	158
4.3.5. Cnf.ShowDefault - Returns default configuration settings	159
4.3.6. Cnf.Show - Returns all used parameter settings	159
4.3.7. Cnf.Search,<parameter_name> – Searches for a parameter name	160
4.3.8. Cnf.Backup - Backup current user configuration	160
4.3.9. Cnf.EraseBackup – Erases the backed up user configuration settings	161
4.3.10. Cnf.Restore – Restores the backed up user configuration settings	161
4.3.11. Cnf.Write,<parameter_name=value> - Saves parameter settings into the device	162
4.3.12. Cnf.Write,Device.CAN.Transceiver=<on> - Ensures proper operation of IO2 & IO3	162
4.3.13. CNF.Load – Overwrites the existing config with a file from flash	163
4.4. IO	164
4.4.1. Firmware-indexed IOs	164
4.4.2. IO<index>.Set=<conf_type> – Defines the output behaviour	166
4.4.3. IO<index>.Get - Returns the current function and level of IO.	169
4.4.4. IO<index>.GetDI – Returns the level of the digital inputs	169
4.4.5. IO<index>.GetAI – Returns the level of the analog inputs	170
4.4.6. IO<index>.GetDO – Returns the level of the digital output	170
4.4.7. IO<index>.Config - Configures the functionality and behaviours of IOs.	171
4.4.8. IO<index>.Calibrate - Calibrates the offset or gain of analog input	176
4.4.9. IO<index>.ClearCalibration– Erases the stored calibration values for IO.	179
4.4.10. IO<index>.Info – Returns the current function of specified IO	180
4.4.11. IO.Counter	181
4.4.11.1. IO<index>.Counter.Info – Returns the current state and the counter value of IO	181
4.4.11.2. IO<index>.Counter.Start – Starts the IO specified hardware	181
4.4.11.3. IO<index>.Counter.Set – Sets the value of a specified hardware counter	182
4.5. GPS	183
4.5.1. GPS.Nav	183
4.5.1.1. GPS.Nav.Position<buffer_index> – Returns bee-line distance, device to stored location	183
4.5.1.2. GPS.Nav.Position<buffer_index>=<type> – Saves temporarily or clear device position	184
4.5.1.3. GPS.Nav.Position<buffer_index>=save<slot_id> – Moves the GPS data from buffer to storage	185
4.5.1.4. GPS.Nav.Position<buffer_index>=load<slot_id> – Loads the data temporarily from storage to buffer	185
4.5.1.5. GPS.Nav.Distance – Reads the distance travelled	186
4.5.1.6. GPS.Nav.Distance=<value> – Sets a user distance	186
4.5.1.7. GPS.Nav.Distance.Save – Stores the distance	187
4.5.1.8. GPS.Nav.Distance.Load – Loads distance from memory	187
4.5.1.9. GPS.Nav.DeltaDistance – Reads delta distance counter	188
4.5.1.10. GPS.Nav.DeltaDistance=<value> – Sets a delta distance	188
4.5.1.11. GPS.Nav.Distance2 – Reads total distance covered since initial startup	189
4.5.1.12. GPS.Nav.Distance2=<value> – Sets a fixed distance value	190
4.5.1.13. GPS.Nav.SetHeadingTolerance=<value> – Defines heading tolerance	190
4.5.1.14. GPS.Nav.ResetHeading – Resets heading	191
4.5.1.15. GPS.Nav.SetHeading2Tolerance=<value> – Defines the Heading2 tolerance	192
4.5.1.16. GPS.Nav.ResetHeading2 – Resets Heading2	193
4.5.1.17. GPS.Nav.SaveLastValid – Saves last valid position, if no GPS-fix valid	193
4.5.1.18. GPS.Nav.HoldPosition – Holds the current GPS position at this location	195
4.5.1.19. GPS.NAV.GNSS– Enables/Disables specific GNSS operations	195
4.5.1.20. GPS.Nav.DeadReckoning– Enables/Disables the use of Dead-Reckoning feature	196
4.5.2. GPS.History	197
4.5.2.1. GPS.History.Write,<add_prot_to_memory>,<\	197
4.5.2.2. GPS.History.Clear - Clears the history memory	199
4.5.2.3. GPS.History.GetStart– Returns the oldest date stored in the history memory	199
4.5.2.4. GPS.History.SetRead,all – Selects number of history records to download	199
4.5.2.5. GPS.History.SetRead,<start_index>-<end_index> – Selects number of history indices to download	201
4.5.2.6. GPS.History.Read – Downloads selected history records in parts	201
4.5.2.6.1. Reading history records in textual format	203
4.5.2.6.2. Further notes for converting history data with special remark to data/event logging features	205
4.5.2.7. GPS.History.Push – Downloads all selected history records at once	206
4.5.3. GPS.Geofence	208
4.5.3.1. GPS.Geofence.Park.Set – Places and activates parking area	208
4.5.3.2. GPS.Geofence.Park.Remove– Disables an activated park area	209
4.5.3.3. GPS.Geofence.GeoState,<geo_id>– Returns the state of a Geofence	209
4.5.3.4. GPS.Geofence.AreaState,<area_id>– Read the state of an area	210
4.5.4. GPS.MultiGeofence	211
4.5.4.1. GPS.MultiGeofence.Info - Shows the number of geofences being used	211
4.5.4.2. GPS.MultiGeofence.Clear - Clears the list of geofences	212
4.5.4.3. GPS.MultiGeofence.GetWP – Gets the position and radius of specific multi-geofence	212
4.5.4.4. GPS.MultiGeofence.SetWP – Sets the position and radius of specific multi-geofence	213
4.5.4.5. GPS.MultiGeofence.Test,<lat>,<lon> – Tests if GPS position is inside corridor boundaries	214
4.5.5. GPS.WPGeofence	215
4.5.5.1. GPS.WPGeofence.Info – Shows information about waypoints	215
4.5.5.2. GPS.WPGeofence.Clear – Erases the entire waypoint list	216
4.5.5.3. GPS.WPGeofence.GetWP,<id> – Gets the position and radius of the waypoint	216
4.5.5.4. GPS.WPGeofence.SetMode2D – Change mode of waypoint to 2D (two-dimensional)	216
4.5.5.5. GPS.WPGeofence.SetMode3D – Change mode of waypoint to 3D (three-dimensional)	217
4.5.5.6. GPS.WPGeofence.SetWP,<id>,<lat>,<lon>,<alt>,<radius> – Adds an entry to waypoint list	217
4.5.5.7. GPS.WPGeofence.Test,<id>,<lat>,<lon>,<alt>,<radius> – Tests if GPS position is inside corridor boundaries	219
4.6. EcoDrive	220
4.6.1. EcoDrive.TripStart - Starts a new EcoDrive trip	220
4.6.2. EcoDrive.TripStop - Ends a started EcoDrive trip	220
4.6.3. EcoDrive.CurrentTrip - Reports current trip data	221
4.6.4. EcoDrive.LastTrip - Reports last trip data	222
4.7. GSM	223
4.7.1. GSM General	223
4.7.1.1. GSM.PIN=<\	223
4.7.1.2. GSM.PUK=<\	223
4.7.1.3. GSM.IMEI – Returns the international mobile equipment identity	224
4.7.1.4. GSM.IMSI – Returns the International Mobile Subscriber Identity	224
4.7.1.5. GSM.ICCID – Returns the Integrated Circuit Card Identifier of the SIM card	224
4.7.1.6. GSM.OwnNumber– Returns the phone number of the SIM card	225
4.7.1.7. GSM.Balance– Returns account balance of an used prepaid SIM card	225
4.7.1.8. GSM.USSD – Performs an USSD call and return its answer	226
4.7.1.9. GSM.MCC – Gets the current mobile country code	226
4.7.1.10. GSM.Band – Specifies the GSM band used by the device	227
4.7.2. GSM.CMB	228
4.7.2.1. GSM.CBM.Add,<message_slot>,<cbm_id> - Adds a CBM message to the message slot	228
4.7.2.2. GSM.CBM.Remove,<message_slot> - Removes data from message slot	228
4.7.2.3. GSM.CBM.Info - Queries CBM information	229
4.7.3. GSM.VoiceCall	230
4.7.3.1. GSM.VoiceCall.Dial,<\	230
4.7.3.2. GSM.VoiceCall.Accept - Accepts an incoming voice call	230
4.7.3.3. GSM.VoiceCall.Hangup – Hangs up an active voice call	231
4.7.3.4. GSM.VoiceCall.SendDTMF,<duration>,<\	231
4.7.4. GSM.Audio	232
4.7.4.1. GSM.Audio.ActiveProfile - Selects and activates an audio profile	232
4.7.4.2. GSM.Audio.ShowProfile - Shows details of audio profile	232
4.7.4.3. GSM.Audio.SaveProfileAs - Stores audio settings to a profile	233
4.7.4.4. GSM.Audio.DeleteProfile - Erases a stored profile	233
4.7.4.5. GSM.Audio.EchoCancel - Activates or deactivates echo cancellation	235
4.7.4.6. GSM.Audio.SideTone - Activates audible feedback to speaker	235
4.7.4.7. GSM.Audio.SpeakerMute - Activates or deactivates speaker output	236
4.7.4.8. GSM.Audio.SpeakerGain - Sets speaker gain	236
4.7.4.9. GSM.Audio.MicrophoneMute - Activates or deactivates microphone	237
4.7.4.10. GSM.Audio.HandsfreeMicroGain - Sets microphone gain	237
4.7.4.11. GSM.Audio.HandsetMicroGain - Sets microphone gain	238
4.7.4.12. GSM.Audio.AudioRingPath - Selects path of ring signals	238
4.7.4.13. GSM.Audio.RingTone - Selects ring tone for incoming calls	239
4.7.4.14. GSM.Audio.RingGain - Sets gain of ring tones	239
4.7.4.15. GSM.Audio.AudioPath - Selects path for regular audio signals	240
4.7.4.16. GSM.Audio.SoundMode - Selects global sound mode	240
4.7.4.17. GSM.Audio.SMSSignalToneMode =<mode>- Sets the SMS Signal Tone Mode	241
4.7.5. GSM.SMS	242
4.7.5.1. GSM.SMS.Send,<\	242
4.7.5.2. GSM.SMS.SendRaw,<\	243
4.7.5.3. GSM.SMS.SendMulti – Send out SMS with more than 160 chars	244
4.7.5.4. GSM.SMS.Inbox.Clear – Clears all stored SMS Messages from the SMS memory	245
4.7.5.5. GSM.SMS.Inbox.State – Returns all inbox SMS Messages from the SMS memory	245
4.7.5.6. GSM.SMS.ClearSIM – Delets all SMS Messages from the SIM memory	245
4.7.5.7. GSM.SMS.Outbox.Clear – Clears outgoing SMS from the SMS memory	246
4.7.5.8. GSM.SMS.Outbox.State – Returns all outbox SMS Messages from the SMS memory	246
4.7.6. GSM.DataCall	247
4.7.6.1. GSM.DataCall.Send,<protocols>,<\	247
4.7.6.2. GSM.DataCall.Accept - Accepts incoming GSM data call	247
4.7.6.3. GSM.DataCall.Hangup – Hangs up active data call	248
4.7.7. GSM.GPRS	249
4.7.7.1. GSM.GPRS.Connect – Performs a GPRS attach	249
4.7.7.2. GSM.GPRS.Disconnect – Performs a GPRS detach	249
4.7.7.3. GSM.GPRS.State - Returns GPRS state	250
4.7.7.4. GSM.GPRS.Traffic[=<complete>,<incoming>,<outgoing>] – Sets/returns GPRS traffic counter	251
4.7.8. GSM.SetInternal/ExternalAntenna	252
4.7.8.1. GSM.SetExternalAntenna - Switches to the external antenna	252
4.7.8.2. GSM.SetInternalAntenna - Switches to the internal antenna	252
4.8. TCP	253
4.8.1. TCP. Client	253
4.8.1.1. TCP.Client.Connect - Performs a TCP connection to the used server	253
4.8.1.2. TCP.Client.Disconnect - Disconnects from the used server	253
4.8.1.3. TCP.Client.State – Returns TCP connection state	254
4.8.1.4. TCP.Client.Send,<protocols>,<\	254
4.8.1.5. TCP.Client.ClearSendBuffer - Clears the outgoing TCP buffer	255
4.8.1.6. TCP.Client.RxKey= <\	255
4.8.1.7. TCP.Client.TxKey= <\	256
4.8.1.8. TCP.Client.FlushSendBuffer - Transfers buffered data immediately	256
4.8.1.9. TCP.Client.SetCertificate – Set certificate used by TLS library	256
4.8.1.10. TCP.Client.ShowCertificate – Shows the used TLS certificate on the main TCP connection	257
4.8.2. TCP.Storage	258
4.8.2.1. TCP.Storage.Dispatch - Sends a TCP packet to the connected server	258
4.8.2.2. TCP.Storage.Clear - Clears TCP storage	259
4.8.2.3. TCP.Storage.AddProtocol,<protocol>,<\	259
4.8.2.4. TCP.Storage.AddRecord,<protocol>,<\	260
4.8.3. TCP.SMTP	261
4.8.3.1. TCP.SMTP.Send,<\	261
4.8.3.2. TCP.SMTP.SendRaw,<\	262
4.8.4. TCP.Client2	263
4.8.4.1. TCP.Client2.SetCertificate – Set certificate on the second TCP connection	263
4.8.4.2. TCP.Client2.ShowCertificate - Shows the used TCP certificate on the second TCP connection	264
4.8.4.3. TCP.Client2.Connect – Opens a second TCP connection	264
4.8.4.4. TCP.Client2.Disconnect – Closes the second TCP connection	265
4.8.4.5. TCP.Client2.State – Shows the state of the second TCP connection	265
4.8.4.6. TCP.Client2.Send,<protocols>,<\	266
4.8.4.7. TCP.Client2.ClearSendBuffer – Clears the outgoing TCP buffer from the second TCP connection	266
4.8.4.8. TCP.Client2.FlushSendBuffer – Flushes the outgoing TCP buffer for the second TCP connection	267
4.8.4.9. TCP.Client2.TxKey=<\	267
4.8.4.10. TCP.Client2.RxKey=<\	268
4.9. WLAN	269
4.9.1. WLAN.Scan - Scan for new WLAN networks	269
4.9.2. WLAN.Connect – Connect to a WLAN network profile	269
4.9.3. WLAN.Send,<protocol>,<\	270
4.9.4. WLAN.Client.Disconnect – Disconnects from a TCP server	271
4.9.5. WLAN.Disconnect – Disconnects from WLAN network	271
4.10. MSG	272
4.10.1. MSG.Send	272
4.10.1.1. MSG.Send.Serial<port>,<protocols>,<\	272
4.10.1.2. MSG.Send.HexSerial<port>,<protocols>,<\	273
4.10.1.3. MSG.Send.RawSerial<port>,<protocols>,<\	275
4.10.1.4. MSG.Send.USB,<protocols>,<\	276
4.10.1.5. MSG.Send.RawUSB,<protocols>,<\	276
4.10.1.6. MSG.Send.FlashBuffer,<protocols>,<\	277
4.10.1.7. MSG.Send.RawFlashBuffer,<protocols>,<\	277
4.10.1.8. MSG.Send.CSD,<protocols>,<\	278
4.10.1.9. MSG.Send.TCP,<protocols>,<\	278
4.10.1.10. MSG.Send.RawTCP,<protocols>,<\	279
4.10.1.11. MSG.Send.Service,<protocols>,<\	279
4.10.1.12. MSG.Send.TCPBuffer,<protocols>,<\	280
4.10.1.13. MSG.Send.RawTCPBuffer,<protocols>,<\	280
4.10.1.14. MSG.Send.UDP,<protocols>,<\	281
4.10.1.15. MSG.Send.SMTP,<email_address>,<protocols>,<\	281
4.10.2. Msg.ClearBuffer - Clears all information in a buffer	282
4.10.3. MSG.Mode	283
4.10.3.1. MSG.Mode.<interface>=<output_mode>,<input_mode> - Transparent mode between interfaces/channels	283
4.10.4. MSG.Event	285
4.10.4.1. MSG.Event – Creates event with text on different interfaces	285
4.10.5. MSG.Version	286
4.10.5.1. MSG.Version.Complete - Retrieves device firmware and hardware versions	286
4.10.5.2. MSG.Version.Modules - Retrieves modules versions	286
4.10.5.3. MSG.Version.BIOS - Retrieves BIOS version	286
4.10.5.4. MSG.Version.HardwareRev - Retrieves device hardware revision	288
4.10.5.5. MSG.Version.Hardware - Retrieves device hardware name	288
4.10.5.6. MSG.Version.Software - Returns the software version of the target device	288
4.10.5.7. MSG.Version.AddTag – Adds a configuration profile identifier in device name	289
4.10.5.8. MSG.Version.DelTag – Removes a configuration functionality identifier from device name	289
4.10.6. MSG.Info	290
4.10.6.1. MSG.Info.ServerLogin – Shows the login data to be reported to a server	290
4.10.6.2. MSG.Info.Protocol,<protocols>,<\	291
4.10.6.3. MSG.Info.Time – Reports the time, date, week number and week day of the device	291
4.10.6.4. MSG.Info.Alarm,<alarm_index> - Shows all conditions of specific alarm index	291
4.10.7. MSG.Feature	293
4.10.7.1. MSG.Feature – Reports device PREMIUM-FEATURE and installation state.	293
4.10.7.2. MSG.Feature=<\	294
5. CONFIGURATION SETTINGS	295
5.1. DEVICE	296
5.1.1. DEVICE.NAME	296
5.1.2. DEVICE.SERIAL<port>.BAUDRATE	296
5.1.3. DEVICE.SERIAL<port>.FORCEON=<on_off>	297
5.1.4. DEVICE.SERIAL<port>.HANDSHAKE	298
5.1.5. DEVICE.CMD.PFAL.EN	299
5.1.6. DEVICE.COMM.<interface>	301
5.1.7. DEVICE.SERIAL1.MODE485=<on_off>	302
5.1.8. DEVICE.COMM.BINEVENT<port>	303
5.1.9. DEVICE.BAT.MODE	305
5.1.10. DEVICE.BAT.CHARGEMODE	306
5.1.11. DEVICE.IGNTIMEOUT	307
5.1.12. DEVICE.GSM.STARTUP	308
5.1.13. DEVICE.GPS.AUTOCORRECT	309
5.1.14. DEVICE.GPS.CFG	312
5.1.15. DEVICE.GPS.TIMEOUT	314
5.1.16. DEVICE.PFAL.SEND.FORMAT	316
5.1.17. DEVICE.CAN.OBD.STARTUP	318
5.1.18. DEVICE.CAN.FMS.STARTUP	319
5.1.19. DEVICE.CAN.STARTUP	320
5.1.20. DEVICE.CAN.DTCOFMS.STARTUP	322
5.1.21. DEVICE.CAN.ERR.EVENTS	323
5.1.22. DEVICE.CAN.EVENT_<slot>	324
5.1.23. DEVICE.DTCO.D8	327
5.1.24. DEVICE.LOWPOWER	328
5.1.25. DEVICE.GPS.JAMMINGLEVEL=<min>,<max>	329
5.1.26. DEVICE.WLAN.STARTUP	330
5.1.27. DEVICE.NFC	331
5.1.28. DEVICE.VIN	331
5.2. REPLACE	332
5.2.1. REPLACE<index>	332
5.3. USER	334
5.3.1. USER<index>=<user_text>	334
5.4. MOTION	335
5.4.1. MOTION.FILTER	335
5.4.2. MOTION.BEARING	336
5.4.3. MOTION.FORCE	338
5.4.4. MOTION.3DFORCE	339
5.5. ALIAS	341
5.5.1. ALIAS.<type>	341
5.6. DBG	342
5.6.1. DBG.EN	342
5.7. PROT	343
5.7.1. PROT.<message_id>	343
5.7.2. PROT.START.BIN	344
5.7.3. PROT.ERR	345
5.7.4. PROT.NA	345
5.7.5. PROT.EMPTY	346
5.8. ECODRIVE	347
5.8.1. ECODRIVE.CAR	347
5.8.2. ECODRIVE.LIMITS	349
5.8.3. ECODRIVE.TOPOLOGY	350
5.8.4. ECODRIVE.AUTOSTART	351
5.9. GSM	352
5.9.1. GSM.PIN	352
5.9.2. GSM.BALANCE.DIAL	353
5.9.3. GSM.CALLID.EN	353
5.9.4. GSM.OPERATOR.BLACKLIST	354
5.9.5. GSM.OPERATOR.SELECTION	354
5.9.6. GSM.EXT.WHITELIST	357
5.9.7. GSM.OPERATOR.GPRSCHECK	358
5.9.8. GSM.OPLOST.RESTART	358
5.9.9. GSM.SMS.RESPONSE	360
5.9.10. GSM.MODEPREF	361
5.9.11. GSM.SIMSLOT	362
5.10. GPRS	363
5.10.1. GPRS.APN	363
5.10.2. GPRS.APN2	363
5.10.3. GPRS.APN.ALTERNATIVE	364
5.10.4. GPRS.AUTOSTART	365
5.10.5. GPRS.DIAL	365
5.10.6. GPRS.TIMEOUT	366
5.10.7. GPRS.QOSMIN	367
5.10.8. GPRS.QOS	370
5.11. PPP	372
5.11.1. PPP.USERNAME	372
5.11.2. PPP.USERNAME2	372
5.11.3. PPP.PASSWORD	374
5.11.4. PPP.PASSWORD2	374
5.11.5. PPP.AUTOPING	375
5.11.6. PPP.AUTH	375
5.12. TCP	377
5.12.1. TCP.CLIENT.CONNECT	377

Match case Limit results 1 per page

PFAL COMMANDS

PFAL Command Reference

4.2.3.

Sys.WebUpdate

The Firmware Web-Update is an advanced method to perform a remote firmware upgrade

over the air. After being activated, the web update itself can be initiated via any available

textual user interface using the following commands. Please refer to Application

Note “

AppNote_WebUpdate_Howto.pdf

" for more details.

Important Notice:

Web-Update is currently under test and therefore, it is not activated per default. In

order to activate it, send the command "PFAL,CNF.Set,DEVICE.TCP.WEBUPDATE=1"

4.2.3.1.

Sys.WebUpdate.Start – Starts an activated Web-Update

Command syntax

Sys.WebUpdate.Start,"

url_file

"[,

port

Examples

$PFAL,SYS.WebUpdate.Start,"www.test.com/avl_3.0.0_rc19-Zc0535461.zip",80

FIRMWARE

DEVICES

FOX3-2G

FOX3-3G

FOX3-4G

BOLERO40

2.16.x

3.0.x

3.1.x

3.2.x

MODELS

Std.

BLE

BID

C1-NA

C4-NA

C1-EU



PFAL



Command description

This command has the following functions:



Starts an activated Web Update



Web Update is an autonomous feature and becomes active as soon as GPRS is

connected



Interrupted downloads (i.e. when the connection drops) are resumed later



Device performs remote update reset when download is completed.

Parameter description

<url_file>

It specifies the domain name and the path to the firmware file name residing on that

server

(the path may also include sub-directory separated with/)

For example, the

www.test.de/AvlFW/avl_3.0.0_rc19-Zc0535461.zip

instructs the device to go to the

www.test.de

Web server (www.test.de is a dummy, please specify your web server

address), open the folder

AvlFW

and access the file named

avl_3.0.0_rc19-

Zc0535461.zip

[<port>]

It specifies the optional port number (b

default

, the

port

number for a Web server is

) for HTTP protocol.

Notes



Please refer to Application Note “

AppNote_WebUpdate_Howto.pdf

" for more

details.



It is strongly NOT recommended to use another remote update when starting web

update.



It is not recommended to start web update again while a web update is in progress.



Be sure that the Web-Update is activated via configuration setting before executing

this command - if not, the following error may occur:

$<SYS.WebUpdate.Start>