Professional Documents
Culture Documents
de/
This HTML site is best viewed with installed Internet Explorer 7.0
FALCOM Workbench
User's Guide
top Page 1
Table of Contents
1 Introduction
1.1 Scope of the document
1.2 Related documents
1.3 FALCOM Workbench version changes description
2 FALCOM Workbench Software
2.1 Installation on Microsoft Windows Systems
2.1.1 Uninstall the Workbench
2.2 System requirements
2.3 Running the FALCOM Workbench Software
3 Quick start
4 Detailed description
4.1 Menu
4.1.1 File|Settings
4.1.1.1 Adjusting the aspects of workbench behaviour
4.1.1.1.1 File|Settings|Editor
4.1.1.1.2 File|Settings|General settings
4.1.1.1.3 File|Settings|Profile Manager
4.2 Toolbar
4.2.1 Port - view
4.2.2 Terminal - view
4.2.2.1 Console color chooser
4.2.2.2 Terminal settings
4.2.3 Editor - view
4.2.3.1 How to read the current device configuration
4.2.3.2 How to modify the current device configuration
4.2.3.3 How to save the device configuration to a file
4.2.4 Python Editor - view
4.2.5 History - view
4.2.6 Firmware uploader - view
4.2.7 GPS Details - view
4.2.8 Resource - view
4.2.9 AGPS Packer - view
4.2.10 Logger - view
4.2.11 GSM-I/O Detail - view
4.2.12 Clock - view
4.2.13 Output Console - view
4.2.14 Settings - view
4.2.15 Help - view
4.3 Connections - view
4.4 VirtualDesk - view
top Page 2
Caution
Information furnished herein by FALCOM is believed to be accurate and reliable. However,
no responsibility is assumed for its use. Also the information contained herein is subject to
change without notice.
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 is available at the following Internet
address: www.falcom.de.
Trademarks
Some mentioned products are registered trademarks of their respective companies.
Copyright
This documentation is copyrighted by FALCOM WIRELESS COMMUNICATIONS GmbH with
all rights reserved. No part of this document may be produced in any form without the prior
written permission of FALCOM WIRELESS COMMUNICATIONS GmbH.
Note
Specifications and information given in this document are subject to change by FALCOM
without notice.
top Page 3
1 Introduction
1.1 Scope of the document
This document is intended to provide a quick reference how to install the FALCOM
Workbench software and brief instructions how configure FALCOM devices with serial
interface ports. It also explains how to use it and communicate with FALCOM devices for
collection, evaluation, and analysis the received data from the device. The FALCOM
Workbench software enables end-users and system integrators a communication interface
between your PC and target device via a serial port to test performances and develop a wide
range of applications in a quick and simply way.
FALCOM Workbench is developed to support the following devices from FALCOM:
Before using one of the above-mentioned devices or upgrading one of them to a new
firmware version, please, read the latest product information - see related documents [1]
This document does not describe how to connect the device to a PC, such description can be
found in the user manual of the used device.
More information can also be available at the FALCOM website: www.falcom.de
STEPPII
[4] FOX_EVALKIT_getting_started.pdf Contains information how to get started with FOX Evalkit.
top Page 4
NR PDF file name Description
MAMBO
MAMBO2
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
top Page 5
1.3 FALCOM Workbench version changes description
Following changes have been made on the FALCOM Workbench versions:
Added new plugin "Python Editor - view" - enables to load, write and save your
Python scripts into your target device,
Added new plugin "Resources - view" for MAMBO2 only using Simple or Standard
GUI,
Added new plugin "Packer/AGPS -view" allows downloading of A-GPS data from
the FALCOM server,
Connecting to a UDP Server or Client is now available. See "Port - view",
top Page 6
2 FALCOM Workbench Software
FALCOM Workbench software can be installed from the FALCOM Website: www.falcom.de.
The software can be installed on Microsoft Windows systems.
Double-click the Workbench icon (if you've created a shortcut on the display).
Choose Programs|Falcom Workbench|Falcom Workbench from the Windows Start
menu.
Double-click Workbench.exe in the ..\Falcom Workbench\ directory.
top Page 7
After starting your Workbench software, the first thing you will see is a dialog box showing the
profiles you have stored for your workspace. For now, just click OK button to load the default
profile.
Based on the default profile, the screen should look similar to the figure below. From this
window you can access all important program parts.
top Page 8
Figure 3: First w orkbench's layout.
1. Help file
The workbench software uses an on-line help that can be accessed from the Help-icon,
after the software has been installed.
2. Mouse activities
Use the left mouse button to open any view from the Toolbar at the top of workbench's
screen. Each view can independently be moved using drag and drop functions. To close
the workbench or any view, use the X-icon at the top-right of each view. Copy and Paste
using the right-mouse button is disabled on the Terminal and Editor.
3. VirtualDesk Manager
Use VirtualDesk view to organize a busy desk of the Workbench. If you usually have
many views opened at a time, you can now organize them on four different desks. Using
keys F1, F2, F3 and F4 you can switch between the workbench desks. For example,
press the F1 key from anywhere in the Workbench to view the upper-left desk or press
the F4 key to view the lower-right desk.
top Page 9
4. Connection Manager
Use Connection-view to establish connection between views and show their incoming or
outgoing data.
top Page 10
3 Quick start
This chapter gives you a quick guide of the main parts and tools of this software. Before any
data can be received from or sent to the target device a communication channel must be
established. Connect the target device to your PC either via a serial cable or Bluetooth
depending on interface the device supports. For more information, how to made a serial or
Bluetooth connection, refer to the corresponding manual "Getting_started.pdf" of the used
device.
There are a few things the program needs to know before it can begin normal operation (as
reference use the Fig.5 above).
1. Go to Toolbar and open Port-View, click on the icon with hint "Open a new serial port
view" that appears when the user moves the mouse pointer over theToolbar.
2. From the Port-View select (see figure below) chose the following settings:
Port: COM port(e.g. COM1) where the target device is connected
Baud: Baud rate that the target device supports (for example, by
default the STEPPIII communicates with 57600 bps)
Data bits: 8
Parity: No
Stop bit: 1
Flow None
control:
top Page 11
Figure 7:Port-view and its settings.
3. When the port settings match with the port settings the target device uses, then open a
serial connection by clicking on the icon shown right the COM port number. The icon
will change from to .
4. Later on, open a Terminal-view from the workbench toolbar with hint "Terminal".
1. To display the incoming data on the Terminal-view, use the right-mouse button
anywhere in the Connection-view (see figure below) to zoom out and then click on the
circle (currently red) labelled "Port COM1". Its color will change from red to green,
showing that the connection between these views is established.
top Page 12
The Connection-view provides schematically connections for setting up relationships among
views. It illustrates schematically these relationships and lets you perform connection and
display the data per mouse click. For more information see section 4.3.
Figure 10:Connection-view .
6. Later on, open a GPS Details-view and an Editor-view from the workbench's toolbar
respectively.
►
Figure 11: Editor-icon & GPS Details-icon
►
Figure 12: GPS Details-connected to the Port/COM1 & Editor - connected to the Terminal
top Page 13
If the connected device is operating correctly, the GPS Details - view will show all GPS
information about satellites in view, position in the sky, signal to noise ratio, time, speed and
latitude, longitude and altitude etc. (GPS protocols should be switched on to view this data).
A user profile is a collection of settings associated to a specific device. You may save multiple
profiles, for example, to separate activities with different devices. One of them can be loaded
from the dialog box that appears when you start the Workbench.
To load a user-profile:
Close Workbench software and start it again (see chapter Running the FALCOM
Workbench Software.
Select the profile you saved from the "Load profile" dialog box that appears when you
start the Workbench software and then click "OK" button.
The Workbench will open the same views with assigned settings as you save it.
To overwrite a user-profile:
Choose "File|Save profile" from the Workbench menu. Changes to your profile will
be shown on the next start of the Workbench.
top Page 14
4 Detailed description
4.1 Menu
It provides an easy way to access the functions of the software. The icons at the top-right
corner are used to minimize/maximize/close the workbench software:
The following table lists and describes all menus and menu items in the Workbench:
Menu Description
Clock Opens a StopWatch - view with Start, Stop and Reset buttons.
top Page 15
Menu Description
File
Settings Adjust the different aspects of workbench behaviour. See also "File|Settings"
Save profile Overwrites the current loaded profile with the active Workbench layout.
Save profile as... Saves the active Workbench layout as a new profile.
Save profile and exit Saves/Overwrites current profile settings and closes the Workbench
Window
Workbench
Manage Profiles Manages your personal profiles. See also "File|Manage Profiles"
Help
Help Opens the Workbench user's guide in HTML format. See also "File|Help"
top Page 16
4.1.1 File|Settings
You have choosen File|Settings from the main menu to adjust the aspects of workbench
behaviour. The workbench settings dialog box opens. The workbench settings dialog box
consists of a group of icons representing the views you can use to evaluate and configure
your target device.
Items Description
top Page 17
4.1.1.1 Adjusting the aspects of workbench behaviour
4.1.1.1.1 File|Settings|Editor
Use the Color of the Editor to specify how the different elements appear in the Editor. You
can specify foreground colors for everything listed in the Editor. You have choosen
Editor|Colors|Comments, Succes, Error, $PFAL or Others either from the File|Settings
or Settings-icon from the Workbench's toolbar. The following dialog box appears. The
sample "Preview" field shows the default color settings to the different elements in the Editor.
To select a color, choose one of the set buttons shown on this dialog box, and assing the
user-color to it.
For example, you want to select another color for comments displayed in an Editor. To
change it, click on the Comment-button, select the color you like, and then click "OK"-button.
The sample "Preview" field shows how your settings will appear in the editor.
The same steps can be used to change the color for evering what in Editors can be
displayed.
Note: If you choose the same color for an element as background color (white), you will be
unable to read them).
Butons Behaviours
Comments Specifies the color of comments (starting with "/*" or "//") in the Editor.
Success Specifies the color of commands that respons success when thay are sent to the device.
Error Specifies the color of commands that respons error when they are sent to the device.
Others Specifies the color for enything else shown in the Editor.
top Page 18
4.1.1.1.2 File|Settings|General settings
Please, follow the on-screen instructions to make changes to the General settings.
You have choosen Profile Manager|Profiles either from the File|Settings or Settings-
icon from the Workbench's toolbar. The dialog box shown on the "Fig.15" appears.
Please, follow the on-screen instructions to make changes to the Profile Manager.
top Page 19
4.2 Toolbar
ToolBar is a container for tool icons. Typically, the tool icons correspond to items in the
workbench menu and give the user more direct access to the Workbench views. It consists of
a group of icons representing the views you can use to evaluate and configure your target
device.
The following table lists the description of each button on the workbench toolbar:
Buttons Description
Opens a new Port - view. For more details, refer to the "Port-view" description.
Opens a new Terminal - view. For more details, refer to the "Terminal - view" description.
Opens a new Editor - view. For more details, refer to the "Editor - view" description.
Opens a new Python Editor - view. For more details, refer to the "Python Editor - view" description.
Opens a new History - view. For more detailes, refer to the "History - view" description.
Opens a new Uploader-view. For more details, refer to the "Firmware uploader-view" description.
Opens a new GPS Detail - view. For more details, refer to the "GPS Detail - view" description.
Opens a new Resource - view. For more details, refer to the "Resource - view" description.
Opens a new A-GPS - view. For more details, refer to the "A-GPS - view" description.
Opens a new Logger - view. For more details, refer to the "Logger - view" description.
Opens a new GSM-I/O Detail-view. For more details, refer to the "GSM-I/O Detail-view" description.
Opens a Stopwatch -view. For more details, refer to the "Clock -view" description.
Opens a new Output Console-view. For more details, refer to the "Output Console - view"
description.
Opens the Workbench settings dialog box. For more details, refer to the "File|Settings" description.
top Page 20
Buttons Description
Opens an online Help - view. For more details, refer to the "File|Help - view" description.
top Page 21
4.2.1 Port - view
To open the Port-view either choose Plugins|Port from the main menu or just click the Port-
icon on the Toolbar.
This view allows you to open and close different types of communication. The port
type for each communication port is listed below:
Serial port type - opens a serial communication between your device and PC.
TCP_Client port type - creates a TCP connection to the TCP server. The IP port is the
remote port number to connect to. It alows you to connect to a TCP server and receives the
debug information from the remote device that comes into the specified IP port.
TCP_Server port type - Crates a TCP connection and the IP port number is the port to
listen incoming TCP connection.
UDP_Client port type - creates a UDP connection to the UDP server. The IP port is the
remote port number to connect to. It alows you to connect to a UDP server and receives the
debug information from the remote device that comes into the specified IP port.
UDP_Server port type - Crates a UDP connection and the IP port number is the port to
listen incoming UDP connection.
The open and close-buttons on the right of the COM port number will show the current
state of that connection. When you want to Open a connection, at first select the type of the
communication, then enter the port settings and finally click on the button to open it. The
total number of incoming and outgoing data in byte is shown when it is opened and there is
traffic of data. If you want to close a connection, just click on the - button. If you want to
remove this port from the Port-view, then click on the button.
top Page 22
You can also open more than one port and communicate at the same time with them without
the need to start the program twice or more times. To add a port into the Port-view, click on
the Port-icon on the Toolbar. If you click the Port-icon 5 times, the Port-view will add 5 Ports
on it. To communicate separately with these ports you have to connect a Terminal-view to
each port and an Editor to each Terminal.
Item/Button Description
Displays the total number of incoming data, in bytes, since this port is opened.
Displays the total number of outgoing data, in bytes, since this port is opened.
Serial settings: represents the serial port properties. Appears when you chose Serial from
the Port type.
Port Selects COM port number from the list (from COM1 to COMxx) to connect to.
Selects COM port speed from the list (110 to 460800 baud). Please select the same
Baud
baud rate the target device uses. (e.g. by default STEPPIII uses 57600 bps)
Data Selects COM port data bits from the list (5,6,7 or 8).
Parity Selects COM port parity from the list (none, odd, even, mark, space).
Stop bit Selects COM port stop bits from the list (1, 2).
Flow Control Selects COM port flow control from the list (None, XONXOFF, CTSRTS).
TCP_Client configuration: appears when you chose TCP_Client from the Port type.
TCP Description
top Page 23
TCP_Server configuration: appears when you chose TCP_Server from the Port type.
TCP Description
UDP_Client configuration: appears when you chose UDP_Client from the Port type.
UDP Description
UDP_Server configuration: appears when you chose UDP_Server from the Port type.
UDP Description
top Page 24
4.2.2 Terminal - view
The Terminal-View allows you to send and receive any kind of messages to/from the device
(serial port). This view appears when you either click the Terminal-icon on the Workbench's
toolbar or start "Plugins|Terminal" from the Workbench's menu. When you turn on the
device, it sends periodically each second its GPS data and debug information (if enabled) to
its serial port. To monitor and evaluate this data, open a Terminal-view and connect it to an
opened Port control (e.g. COM1) using the Connection-view on the lower right corner of
the Workbench's backplane. The Terminal-View displays the protocols being sent by the
device in a textual form and in a regular weight font - see figure below. To reposition this view
on the backplane, either press and hold the left mouse button in the terminal's tile bar while
moving the mouse to a new position or use the VirtualDesk-view (see Fig. 4).
As above, the Terminal-View allows you to send messages to the device and to display the
received messages and command responses from the device. To sent a message/command
to the device, click on the Details-button near buttom right corner of the terminal, type the
command (without $-character, see Figure above, number [1]) on the Details input field,
enter any necessary command parameters shown on the button of this view, and then press
Enter key on your keyboard. All messages sent to the target device will be shown in the bold
font - see Figure above, number [2]. The check boxes - PFAL, CRC, CR and LF on the
bottom of the Terminal-view can be checked or unchecked, depending on which format the
commands should be sent to the device. These check boxes are only for the data/commands
sent to the device and not for incoming data from device. When sending a command to a
device, the command responces are also displayed on the terminal (see Figure above,
number [3]) To sent a PFAL command to the targed device, please refer to the related
documents "PFAL Command reference.pdf" manual for the used device.
top Page 25
Terminal contains many components enabling you to lock, clear and filter the Terminal
contents - the description of each component is given in table below. Filtering is useful when,
you want to restrict the Terminal to display only protocols/messages received from the device
that contain the specified text. When filtering is enabled, only the data that meets the filter
criteria appeares on the Terminal. To select the filter criteria left mouse click on the filter icon
next to the filter input field and select either Simple filter or Regular expression filter (by
default Simple filter is available). How to create a filter the incoming data, refer to "Filter
incoming data")..
The table below lists the terminal's tool buttons and their explanations:
Items Description
Tool Buttons
Clear All Clears the contents of all opened Terminals (available in the revision 2.1.0-RC2).
Stop All Stops all opened Terminals (available in the revision 2.1.0-RC2).
Displays the Terminal color chooser dialog box, enabling you to set the text color inside all
Colors Terminals using the Color dialog box, making it easier to quickly identify parts of the displayed
messages. For more details, refer to the Terminal color chooser description.
Displays the Terminal settings dialog box, enabling you to make the components in the
Terminal visible/hidden, to change the mode and name of the Terminal as well as to define the
Settings
number of lines or characters in the Terminal. For more details, refer to the Terminal settings
description.
Settings
Changes the format of the Terminal form textual (default) to Binary. Incomming protocols/
messages are shown in binary format.
- Maximizes/Restores a Terminal
top Page 26
Figure 21: Terminal bottom part.
The table below lists the terminal's filter components and their explanations:
Items Description
Filter components
Locks and unlocks displaying of incoming data on the terminal. Lock button can be used to
► read and copy specific data received from the device.
Enables/disables filtering for all incoming data (the data sent from the device).
Enables/disables filtering for outgoing data (the data sent to the device).
Specifies text that the incoming or/and outgoing data must contain. The icon next to this field
specifies how filter expressions are applied to the incoming/outgoing data:
Simple filter - (default) Catches all messages containing the specified text.
Regular expression filter - Catches all messages containing the specified expression.
For example, if you want to view only "GPRMC" protocol on the Terminal, then just enter
"GPRMC" on the input field next to this button and the Terminal appears only RMC protocol
each second. If you want to view only system events, successes and errors, then just type
"EVENT|SUCCESS|ERROR" (without spaces) on the input field next to this button. To have
both "GPRMC" and "EVENT|SUCCESS|ERRORS" in separate terminals, just add a new
child terminal to the main terminal by clickin "Add" at the terminal's upper part. See also
figure below. To apply multiple extensions to your filter, separate them using a pipe "|", also
known as vertical bar "ALT Gr+|". Filters are applied to every line in terminal.You can turn off
filtering by either removing the text from the filter input field or clicking on the same button
that has activated filtering.
Detail components
Allows entering of commands/messages in the text format that will be sent to the target
device. Use Up/Down arrow keys to recall prior/next commands respectively.
Converts automatically the typed text into hex value (Hex Value).
Adds the text "PFAL," at the beginning of each command sent from the "Details" input field.
Adds the checksum at the end of each command sent from the "Details" input field.
Adds a Carriage Return to each command sent from the "Details" input field.
Adds a Line Feed to each command sent from the "Details" input field.
top Page 27
Figure 22: Filtering of messages on the terminal.
top Page 28
4.2.2.1 Console color chooser
This dialog box prompts when you click the Color-button on the Console Toolbar. It allows
you to change the color of the text in a Terminal using the window color dialog box. When the
user selects a color on the window color dialog box and clicks OK, the selected color is
assigned to the messages in the terminal. For example, if you want to highlight system events
by red color, than click Color-button on the terminal's toolbar, click "Events"-button on the
color chooser and select red color on the window color dialog box. Finally, click "OK" on the
on the window color dialog box and "Close" on the console color chooser.
Figure 23: Console color chooser and w indow color dialog box.
Buttons Description
Opens window color dialog box to select the user-color for highlighting $GPEVENT messages in
Events
the Terminal.
Opens window color dialog box to select the user-color for highlighting $GPACTION messages in
Actions
the Terminal.
Opens window color dialog box to select the user-color for highlighting $GPSTATE messages in
States
the Terminal.
Opens window color dialog box to select the user-color for highlighting $GPERROR messages in
Errors
the Terminal.
Opens window color dialog box to select the user-color for highlighting debug messages
Debug
($GPDEBUG) in the Terminal.
Opens window color dialog box to select the user-color for highlighting specific text in the Terminal
Color defined by the user. If the entered text is found in a line on the Terminal, then the complete line is
highlighted by the selected color.
top Page 29
4.2.2.2 Terminal settings
This dialog box appears when you click the Settings-button on the Terminal Toolbar. It
allows you to manage the size of the contents and to specify the font type and size of the
Terminal. The actual size of Terminal depends on the amount of data you define such as the
number of lines and/or the number of chars. Whenever one of these settings is met, the
contents of the Terminal will be cleared. The Terminal contents is also limited by the amount
of available disk space. For example, if you want to change the font type, click the Settings-
button on the terminal's toolbar, click Fonts-button on the appeared dialog box and then
select the font type on the window font dialog box. Finally, click "OK" and then close the
terminal settings dialog box.
Figure 24: Terminal settings and dialog box for selecting fonts.
Settings Description
Number of Lines Specifies the maximum of lines allowed in a Terminal before its content is cleared.
Number of Chars Specifies the maximum of characters allowed in a Terminal before its content is cleared.
Allows users to rename Terminals for better identifying them. If you find it difficult to
Terminal Name
identify them one by one, give them a name of your own.
Controls the layout of the Terminal view. Allows switching between normal and simple
Simple Mode
mode. For more details, refer to the Normal/Simple mode description
Displays a Windows dialog box for selecting fonts. When the user selects a font and
Fonts
clicks OK, the dialog closes and the selected font is applied in the Terminal.
top Page 30
Users can easily switch between core tabs, contextual normal and simple modes. The simple
mode offers a set of icons displayed on the bottom of the Terminal providing the same
function as the Terminal toolbar, but in a smaller form. To know the function of these icons,
just point the mouse cursor over an icon and read the hint text displayed. The function of
each icon can be found in the tables above.
Figure 25: Layouts of the Terminal in the normal mode and simple mode
top Page 31
4.2.3 Editor-view
Editor enables you to directly change, overwrite, configure, read and save the current
configuration settings on the target device. Choose "Open new Editor" on the Editor tool
buttons to add a new child Editor to the existing Editor-view. If there is more than one editor
opened, the user can select each Editor by clicking the editor page tab that appears on the
top. While performing any read process the editor tab shows the name of the firmware
running on the target device. To send each PFAL command separately to the target device,
just double-click that command text. While to send just a command repeatedly, select the
Loop+" PFAL commad " (e.g. Loop " $PFAL,CNF.Set,DEVICE.NAME=unnamed SteppIII ") that
appears when the user clicks on a PFAL command with the right mouse button.
when Loop function is executed, to stop it, click Stop-icon that appears on the Editor-
toolbar. By default, all PFAL commands sent from the Editor to the device that response
SUCCESS are highlighted in blue color; all refused commands (that response ERROR) are
highlighted in red; and non PFAL commands are highlight in blue (see also
"File|Settings|Editor|Color").
top Page 32
Toolbar
Icons Description
Opens a windows dialog box for selecting and opening *conf│.txt - configuration files. Hint: The
selected file must contain PFAL commands and not simply text. However, the workbench is
delivered with different configuration files which are available in the "/Falcom
Workbench/data/device configuration/*.config". These files can be changed and used for further
configuration purposes.
Transmits the current selected file to the target device. Each line is read and sent as a separate
command. When the first command is successfully transmitted and responses are received, it
skips to the next line of the file. If no file has been selected, an error message box will be
displayed. If no connection between Editor and serial port where the configuration has to be
transmitted then an Error message prompts.
Shows user configuration setting including all configuration settings changed and executed by the
user, excluding factory preloaded configuration settings.
Saves the contents of the current editor to a file. Displays a windows dialog box for entering file
name and saving configuration file.
Copies all text currently on the clipboard back to the location of the insertion point on the editor.
Cancel all changes made to the Text since the last call to the ClearUndo method.
Reverse the effects of your most recent Undo. It has an effect only immediately after an Undo
command.
Configuration options
Options Description
Sent Shows the number of commands that are being sent to the device.
Success Shows the number of commands that are successfully sent to the device.
CRC Enables/disables adding the checksum at the end of each sent command -optional
Number of times to retry if a command does not respond - optional. (it sets a retry schedule for
Retry
each command that does not respond, and not for commands that respond ERROR or OK).
It specifies the amount of time (in milliseconds) to wait for a response from the device and number
Delay of milliseconds between delivery attempts - optional. (This process continues until the number of
retries has been reached.)
Enables to execute the contents of the Editor line-wise repeatedly, based on the value assigned to
Delay option. To send just a command repeatedly, click the Loop+PFAL commad that appears
Loop
when the user clicks on a PFAL command with the right mouse button. To stop it click Stop-icon
that appears on the Editor-toolbar when Loop function is executed.
top Page 33
4.2.3.1 How to read the current device configuration
To read the device configuration, click on the icon from the Editor menu. A list of device
configuration is shown on the Editor. The description about the parameters used in the
device configuration can be found in the corresponding PFAL Command Set for that device
(for all AVL devices use the document
"steppIII_fox_bolero_lt_PFAL_Configuration_Command_Set_2.x.x.pdf").
To modify the current device configuration or add new configuration into the connected
device, follow the steps given below:
1. Open a new Editor (e.g. "Editor1") and connect it to the Terminal-view which is already
connected to a Port). The COM port is the port where the target device is connected to.
2. To prevent any interference between old and new alarms, it is recommended to set the
device into the Configuration Update Mode before sending any configuration to the device.
The device is set into the Configuration Update Mode using the command
$PFAL,Sys.Device.CfgUpdateMode.
3. Write the configuration that you want to send to the target device. Information about the
PFAL commands, Events und State can be found in the corresponding PFAL Command
Set for that device (for all AVL devices use the document
"steppIII_fox_bolero_lt_PFAL_Configuration_Command_Set_2.x.x.pdf").
4. After writing the configuration, you can either double click each line separately or click
the -icon to start sending the configuration automatically. When you select "Send the
configuration automatically" then the Editor reads each line and sends it as a PFAL
command to the target device. After the target device responds within the specified
"Delay" time, the Editor skips to the next line, otherwise if the device does not response
within the specified "Delay" time then the same PFAL command will be send again as
many times as you have specified in the "Retry" field on the button of the Editor.
Editor integrates up to five different colors, which may be shown during sending the
configuration to the target device. Editor Colors can also be changed by the user, see
"File|Settings|Editor|Colors" for details. The table below lists the default colors used in
the Editor:
Color Meaning
Green PFAL Command has been sent successfully. Device has acknowledged that command with OK.
PFAL Command has responded with error or it has not responded within the specified delay-time.
Red To get more details, move the mouse pointer over the red-marked commands and pause
momentarily.
Non PFAL Commands. Text has been sent to the device but no responses returned with the
Blue
specified delay time.
5. Once the configuration file has been successfully transmitted, it is recommended to reset
the target device using the $PFAL,Sys.Device.Reset command.
top Page 34
4.2.3.3 How to save the device configuration to a file.
6. To save the configuration from an Editor, click on the -icon, browse the Workbench
installation directory under (.../data/device_configuration or another folder), assign
the file name (e.g. testconfig.conf) and then click "Save".
The "default_stepp3_2_5_8_x.conf" file contains the default settings for STEPPIII device.
The "default_mamboII_2_5.conf" file contains the default settings for MAMBO2 device.
.... and so on.
A configuration file may also contains comments. There are two different comments:
Block comments - rectangular areas that contain text.
/* Text between a slash-plus-asterisk and an asterisk-plus-slash also constitutes a
block comment.*/
Single comments - single line comments:
// Any text between a double-slash and the end of the line constitutes a single
comment.
To load default configuration, click on the -icon on the Editor, and then browse the
directory (.../data/device_configuration) and select the corresponding file.
Please, note that the factory-preloaded configuration could be overwritten but not
deleted.
Prevent spaces at the end of each PFAL command line.
top Page 35
4.2.4 Python Editor-view
Python Editor is a new plugin which has been implememted in the sofware revision 2.6.2.0
RC6. It enables you to load, write and save your Python scripts into your target device (e.g.
DR864 modem or any other FALCOM device suporting Python). The Python Editor toolbar
has the same buttons and the same functions as the normal Editor toolbar. For more details
refer to the Editor toolbar Table. To start the Python script, just go to the toolbar on the
Python Editor and the button with hint "Start sending script".
On the bottom of the Python Editor there are also the following settings to be done:
Settings Meaning
Delay Specifies a time delay before the next line on the Python Editor is sent to the COM port.
Enable Script The stored script will be active all the time and start after the device reboots or powers up.
top Page 36
4.2.5 History - view
The History-view enables you to download all or a part of GPS data that has been saved
inside the target device. How often the data is saved inside the device depends on the user
defined save parameter conditions (e.g when a timer of 20 sec. expires and the the speed is
greater than 50km/h then save current position of the device). To save GPS data and other
information inside the device the PFAL command e.g. "$PFAL,GPS.History.Write,xx,"user
text" can be used. To download this data in your PC, the History-view can be used. It offers
not only the receiving and saving of this data in to a file but also you have the possibility to
convert the binary data into the NMEA format and ready to upload the file with GPS data to a
maping software and graphically representation of the driven road.
You can open this view, either by choosing Plugins|History from the main menu or History-
icon from the Workbech's Toolbar. The following dialog box appears.
As mentioned above, using this view you are able to download either the whole GPS data
saved in the device or a part (time-based) them. When the download process starts a
progress bar on the bottom of this view will show the state of completion. To download such a
data follow the steps given below:
1 - Download all GPS data saved inside the device in seven step process:
Choosing this option the Workbench requests all GPS data that has been saved inside
the device and saves them either as binary or NMEA format in the user selected file.
1. Open a History-view (if not opened). The option "Save converted data" has currently no
efect in the download process, whether it is selected or not. It is kept free for future use.
2. Connect this History-view to the device via the Port-view that you want to download the
saved GPS data (e.g. Port control1 > COM1).
3. Select the option "Download all".
4. Select also the option "Binary-> Convert".
5. Click on the button "Download".
6. On the appeared "Save in" windows dialog box, enter a filename in the "File name" entry
(e.g. "STEPPIII_NMEA1.txt") and choose the type of save data file you wish to use from
the "Save as type:" (by default the data will be save in *.txt extended format), and finally
click on the "Save" button. If you cancel this process a dialog box with "History
download canceled from user" prompts.
7. Once the download process has successfully completed, a dialog box appears. If the
download process fails (means the device does not response within 15 seconds after you
start the download), an Error with text "Error while donloading distory data" prompts.
The option "Save converted data" has currently no efect in the download process,
whether it is selected or not. It is kept free for future use.
If the download process fails (means the device does not response within 15
seconds after starting the download), an Error with text "Error while donloading
distory data" prompts.
top Page 37
2 - Download a part of GPS data saved inside the device in seven step process:
Choosing this option, the Workbench requests a part of GPS data (based on the Stat
and Stop date) that has been saved inside the device and saves them either as Binary or
NMEA format in the user selected file.
Figure 30: Dow nloading a part of GPS data from the device.
The option "Save converted data" has currently no efect on the download process,
whether it is selected or not. It is kept free for future use.
Please note that, the Stop date must be greater than the Start date, otherwise no
GPS data can be selected.
If the Stop-date is found, but the Start date not, all GPS data stored earlier than the
Stop-date will be downloaded.
If the download process fails (means the device does not response within 15
seconds after starting the download), an Error with text "Error while donloading
distory data" prompts.
top Page 38
The following table lists and describes all options available on the History-view:
General
Options Description
Save
converted It has no efect in this version.
data
History Format - For more details about these options, refer to the PFAL command
"$PFAL,GPS.History.Read,fmt=..".
Options Description
Binary Downloads and stores the history data to the specified file in binary format.
Binary-
Downloads and stores the history data to the specified file in NMEA format.
>Convert
Txt Downloads and stores the history data to the specified file in textual format.
Generates an RMC protocol for each entry available in the history and then downloads and stores
RMC this data to the specified file in NMEA format. This file with RMC prtocol can then be uploaded and
plotted on a map software.
Downloads and saves to the specified file, only the user text. When the download process starts
User
a progress bar on the bottom of this view will show the state of completion
Buttons Function
Opens the windows "Save in" dialog box and starts the download. When the download has
Download
successfully completed, a confirmation message prompts.
top Page 39
4.2.6 Firmware uploader - view
You can open this view, either by choosing Plugins|Firmware from the main menu or
Firmware-icon from the Workbech's Toolbar. The following dialog box appears.
Transmission options
Parameters Description
Determines the number of bytes that will be sent in one packet. This setting is network
dependat for remote upgrade. Min=512 bytes; Max=4096 bytes. The lower the packet size, the
Packet size more secure is the packet transmission. The higher the packet size, the faster is the packet
transmission. Set it to maximum (= 4096 bytes) for high-volume data transmission. If you see
that the "Total retries" increases itself, just decrease the packet size.
Specifies how long to wait for pending packets before trying to send it again. Set it to
Timeout [ms]
maximum (= 9000 ms).
Determines how many times a packet should be resent if the target device does not
Max. Retries
response "SUCCESS" within the timeout. Set it to 5.
Determines how many packets should be sent at once. This setting is device dependat
Max. Slots
(MAMBO uses 3 slots while other devices use 5 slots). Set it to 5
Transmission
Switches the target device into the selected data mode (BLUETOOTH,TCP,SERIAL or USB).
channel
Current
Description
uploads
Opens a dialog box that allows you to select the location of the firmware update file with
Browse
extension ".frp".
Provide you with visual feedback information about the firmware upgrade progress (appears
after you load the firmware upgrade file).
top Page 40
The Workbench software offers two different possibilities to upgrade a device to a new
firmware. Typically, firmware upgrades are done locally via Bluetooth*, Serial or USB. This
method is easy, fast and reliable. However, when the local access to the device is not
possible, you can perform the firmware upgrade via a TCP connection. Following you will find
the description of both local and remote variants.
Below is the step-by-step procedure how to upgrade your target device locally (via
Bluetooth, Serial and USB port):
* It is preferred to upgrade the firmware over the USB or Serial port rather than Bluetooth.
top Page 41
b). To make a TCP connection with a FALCOM device you need to do the
following steps:
When the TCP connection between the Workbench and STEPPIII is established (on the
Terminal are displayed the loggin data the STEPPIII sends), you will need to do the following
additonal steps to perform the frimware upgrade remotely:
7. Open a Firmware Uploader-view, select TCP from the Transmission channel and set the
Max. Retries and Slots to 5.
8. Click "Browse" button and select the firmware file with extension ".frp".
9. Connect the Firmware Uploader-view to the Port Control TCP_Server via Connection-view.
10. To start the remote upgrade process, click on the ► button. The current status of the
firmware upgrade is shown in the progress bar. The number of the TCP packets and the
responses form the remote device are shown in the Terminal 1.
The Workbench Software 2.6.0 supports only the .frp files for the upgrade.
Device should be stationary - not moving and should have a good GSM reception.
Only one device can be upgraded at a time remotely (in this way).
Before performing the firmware upgrade remotely, make sure that the targed device
is already connected to an external power supply.
While the firmware upgrade is in progress, do not send any command to the device
and do not manually reboot it until the device restarts itself.
During this procedure, recording history and overwritting device configuration are
stopped.
top Page 42
4.2.7 GPS Detail - view
GPS Detail - view displays graphically the location of each of the tracked, used, and
available satellite. It also shows the elevation, azimuth and signal quality for each satellite the
device sees. You can open this view, either by choosing Plugins|GPS Detail from the main
menu or GPS Detail-icon from the Workbech's Toolbar. The following dialog box appears.
To display information on this view you should connect it via the Connection-view to a
Terminal-view that this is already connected to a Port-view and the device connected to this
port is turned on and it transmitts periodically its GPS protocolls to its serial port. This view
shows three different characteristics when evaluating GPS performances such as: Signal
Strength, GPS Details and Orbital Position.
1. Signal Strength:
This part is a combined graphical and text display of satellite tracking. It displays the
satelite number, the Signal level and its quality.
top Page 43
4.2.8 Resource - view
Resource - view allows you to extract images and icons out of the selected firmware file
"*.frp", edit images and compile them into the firmaware file again. The figure below shows an
extracted firmware file that runs on the MAMBO2 devices. Hint: Only MAMBO2 firmware
(Simple and Standard GUI) contains images. To be able to edit such images from the
firmware, you have to extract a firmware file first. Therefore, select a "*.frp" firmware file by
clicking the Browse button and navigate to the firmware file you want to extract. During
loading the firmware all images compiled into this firmware are listed in the tab Logo_Icons. A
double click on an image that you want to edit or replace (e.g. "logo.bmp") and a modal
Windows dialog box is shown for saving that image. After editing that image with an image
editing program you can load it again by double clicking on it. When all images are edited
and loaded to compile the firmware again with the new images, click the button "Save to
Firmware" and a modal Windows dialog box is shown for saving that firmware file. Enter the
name of the firmware with extention "frp" and click the button "Save" to save it. How to load
this firmware into the MAMBO2, refer to chapter "Firmware uploader". The tab Phonebook
will be filled with images only when loading a firmware file for MAMBO2 Simple GUI.
Components Description
Browse Opens a dialog box for selecting the firmware file name with extension ".frp" to be extracted.
Logo_Icons Lists all images that are compiled into the selected firmware file for the MAMBO2.
Saves all selected images into a *.frp file. These images can then be loaded into the MAMBO2
Save as device as an extra resource. When the MAMBO2 is turned on, it looks first into this resource
resource and if it finds any images it loads them, otherwise it loads the default ons available in the
firmware.
Save as
Compiles the selected firmware with new eddited images.
Firmware
Phonebook Lists all images that are compiled into the selected firmware file for the MAMBO2 Simple GUI.
New Adds new images into the phonebook of the loaded firmware (the image names can be from
Phonebook 300.bmp to 399.bmp). See "MAMBO2PFALCommandsReferenceGuide_xxxxx.pdf" for more
Item details.
top Page 44
4.2.9 Packer - view
Packer - view allows you to download AGPS data from the Falcom server and upgrade a
Falcom device (using a GPS reciver from µ-Blox) by sending this data serially. A-GPS stands
for "Assisted Global Positioning System". As the term describes, A-GPS’s main function is to
assist standard GPS so the device can operate more quickly and efficiently than unassisted
ones. Basically, A-GPS offers both offline and online solutions.
Off-line solution: Users acquire the latest A-GGPS data from FALCOM A-GPS server
through internet (TCP/IP) using the Workbench software and then upgrade the device by
sending the received file serially. On-line solution: AVL devices get the latest aiding data
from the FALCOM A-GPS server by GSM/GPRS using an IP address. The device connects to
that remote server and it pushes automatically the latest data to the device once connected.
A-GPS data are available in the FALCOM A-GPS server and can be downloaded into AVL
devices through internet or GSM/GPRS. When you use a FALCOM device with the A-GPS
function (such as AVL device using µ-Blox receiver), the built-in GPS receiver will be able to
start working right away; the receiver doesn’t need to wait for the GPS data from satellites.
This will reduce TTFF (time-to-first-fix) time because the satellites orbit data are already
partially known. A-GPS is also helpful when doing positioning in a GPS signal weakness zone,
as the GPS receiver will refer to A-GPS database to perform positioning. FALCOM supplies
the off-line and on-line solution services. For A-GPS on-line solutions, refer to the
corresponfing PFAL command set.
top Page 45
The off-line solution can be applied with the Workbench software using the A-GPS - plugin.
To open it, click the Packer icon from the plugin menu. On the Packer view select the device
class from the "Device class" (e.g. steppIII belong to AVL class), the device type from the
"Device type" (e.g. for steppIII select steppIII), the variant from the "Variant" selection box
(e.g. simple and standard options aply only for MAMBO2 corresponding to the Simple and
Standard GUI) and finally select the days on the buttom-left side and click Download button:
Once A-GPS data has been downloaded from the FALCOM server and a temporarily file (with
extention *.alp) is shown on the area below the "Device class", click the button "Pack" on the
buttom right of this view and save that file into the "*.frp" format (e.g. "agps_110110.frp")
which is acteptable by the AVL devices; To send the stored file "agps_110110.frp" to your
target AVL device you have do the following steps:
1. Connect your device to a free COM port on your PC where the Work bench is installed.
2. Open the Port-view and select SERIAL from the Port type.
3. Select the Port number (e.g. COM1) where your device is connected and the speed
(Baudrate) for the communication with the device. The baud rate must match the baud
rate of the device. Click on the ► icon next to the Port to open that connection
4. Open a Terminal-view and connect it to the Port-view via Connection-view (this is only to
see device reponses).
5. Open a Firmware-view and connect it to the Port-view via Connection-view
6. On the Firmware-view, select the Pack et size, Time out, Max. retries and Max. slots.
Depending on the channel the connected device uses, select Bluetoth, USB or Serial
from Transmission channel.
7. Click "Browse". A window will open that allows you to select the location of the A-GPS file
you saved in the step 1 (agps_110110.frp).
8. Finally, click ► (appeared when you load the "*.frp" file) to start the download.
top Page 46
4.2.10 Logger - view
Logger - view provides the ability to log all information received from the target device to a
named log-file and load it back at a later time for evaluation purposes. It allows also you to
filter out which data should be saved in the selected file. You can open this view, either by
choosing Plugins|Recorder from the main menu or Data Recorder-icon from the
Workbech's Toolbar. The following dialog box appears.
The following table lists and describes all elements/options available on the Logger-view:
Logging
Description
elements
Specifies and shows the full path and file name of the specified file for saving
Log file incoming/outgoing data or reading/playing data its records. Click on the to specify the file
name and the folder where the log file will be saved.
Filters Simply enter the filter text for the data to be saved. Click on the to deactivate or activate
filtering.
Add
timestamp If selected, it adds a timestamp (the PC local time) to each record/data being saved into the
to logged specified file.
lines
If selected, it marks each record into the specified file with either "RX" for incoming data or "TX"
logRXTX
for outgoing data for easy identification during playing.
Player
Description
elements
If the selected file is currently being played, you can click the Stop button to stop playing the file.
Note that if you click Play after you click Stop, starts playing the file from the beginning.
Plays the selected file backward (rewind) something faster than Back button.
Pauses reading and playing of records from the selected file at a specific point.
If the selected file is not currently being played, starts playing the file based on the
specified Delay time line time interval. If the selected file is currently being played, click
Pause to pause playing at a specific point. If you click Play after you pause playing, the
file continues to play from the point you paused it.
Plays the selected file forward something faster than Play button.
Visual feedback about the current position of the file being read/wrote. To manually
move the slider to the desired position drag it with the mouse or click the mouse on the
bar.
Delay between lines Sets the delay time, in milliseconds, between playing two records (default = 1000 ms)
Number of Lines
(shown on the Shows the number of lines from the selected file
bottom)
To save the data coming from the connected device (see also figure below), follow the
steps below:
1. Open a Port-view (e.g. Port control 1) and connect it to the device COM port (the
connected device must be turned on and transmitting periodically its GPS protocolls to
its serial port).
2. Open a Terminal-view and connect it to the opened Port control-view.
3. Open a Logger-view and connect it via the Connection-view to the Terminal-view.
4. Click on the button to specify the file name and the folder where the log file will be
saved..
5. Finally, click on the record buton.
2. How to play the data from a saved file (see also figure below):
To play the data from a saved file, follow the steps below:
1. Open a Terminal-view.
2. Open a Logger-view and connect it via the Connection-view to the Terminal-view.
3. Click on the button to specify the file name to be played.
4. Finally, click on the play buton below the Player.
Lines displayed on the terminal may look like: " 2009-03-09 12:23:55 >TX
>$GPRMC,112601.015,A,5040.4158,N,01058.8608,E,0.15,115.58,090309,,*0E".
top Page 48
Figure 40: Connection possibilities for saving and playing the saved data.
top Page 49
4.2.11 GSM-I/O - view
GSM-I/O-view shows the IO port status the device supports, GSM, GPRS connection status,
the signal quality and the name of the GSM network provider. All values shown on this view
are taken from the GPIOP and GSM protocol. If these protocols are switched off, no data will
be displayed.
The following table lists and describes all elements/options available on the GSM-I/O-view:
Elements Description
Digital
Indicates the current status of the digital inputs (if supported by the connected device).
IN
Checked = High; Unchecked = Low;
Indicates the current status of the digital outputs (if supported by the connected device).
OUT
Checked = active; Unchecked = unactive;
Indicates the current status of the ignition line (if supported by the connected device).
IGN
Checked = High; Unchecked = Low;
Indicates the current status of the internal battery (if supported by the connected device).
Charg.
Checked = Charging; Unchecked = Not charging;
Analog
IN 1 Shows the current voltage value on the analog input 1 (if supported by the connected device).
IN 2 Shows the current voltage value on the analog input 2 (if supported by the connected device).
top Page 50
Elements Description ( C O N T I N U E D )
Analog
IN 3 Shows the current voltage value on the analog input 3 (if supported by the connected device).
IN 4 Shows the current voltage value on the analog input 4 (if supported by the connected device).
Power
Shows the current input voltage of the external power supply.
ext.
Power
Shows the current voltage of the internal battery.
bat.
GSM
Shows the GPRS current state. Unknown = double-click to refresh; Disabled = GPRS not
GPRS
available; Connected/Disconnected = connected/disconnected to GPRS services
top Page 51
4.2.13 Output Console - view
Output Console-view enables to debug the workbench software, to view detailed
information about the software errors which can be occured while working with Workbench
software. You can open this view, either by choosing Plugins|Output Console from the
main menu or Output console-icon from the Workbech's Toolbar. The following console
appears.
This console can not be connected to any other views, as it debugs and shows detailed
information that may occur in the Workbench software itself.
top Page 52
4.2.15 Help - view
Help-view provides information to help you use the workbench software. It includes a set of
buttons (Back, Forward, Stop, Refresh, Local and Online). Click online-button to view
manuals in the online help.
Icons Description
Loads the help file which is archived in your local PC during the workbench software installation.
top Page 53
4.3 Connections - view
Connection-view provides schematically connections for setting up relationships among
views. Click on the Connection-view with right mouse button to view it in full size. When the
mouse leaves the bounds of the Connection-view it goes back to the standard view. These
are designed as circular shapes labelled by the name of the view. It illustrates these
relationships schematically and lets you perform connections per mouse click on.
Connection-view and its functions are best explained through example.
Connection - view use two different colors. The color depends on the state of the
connection to an active view.
none Represents an active view (e.g Terminal1 is selected/click oned by the user)
RED Represents no connection to the active view (e.g. Terminal1 and Logger).
Represents a connection to an active view (e.g. see Fig. 43: Terminal1 is connected to the
GREEN GPS Details 1, so all information on the GPS Details 1 are taken from the protocols coming
on the Terminal1).
Example:
Assume that the Connection-view resembles Fig. 43. In this case, the GPS Details 1 is
the active view (clicked by the user), which is connected to the Terminal 1 view (shown
in green). If you now click on the Terminal 1 view, and see the Connection-view, it is
connected to Port control 1-view. So, the incoming data on the Port control 1 is
displayed on the Terminal1, and the GPS Details 1 holds its required data for its
elements from the Terminal1.
The connection between views can be bidirectional. To explain such connections, just
follow the steps below:
Open a new Port-view from the Toolbar, set the port to connect to (e.g. COM2),
and then connect it.
Open a Logger-view and two Terminal-views (Terminal1 and Terminal2) from the
Toolbar.
Connect the Terminal1 with the Port-view (Port COM2)
Finally, connect the Logger with Terminal1 and then connect Terminal2 with the
Logger.
top Page 54
When you start logging process, by clicking on the record ● -button, the Logger
writes all the data shown in the Terminal1 into the specified log file.
When the Logger plays a log file, by clicking on the record ► -button, the data is
shown in the Terminal2.
Example:
You can open a Terminal, an Editor and a GPS Details on one area (1), a Help on the
second (2), several Terminals, Editors and GPS Details on the third (3), and GSM details,
Logger and IOs on the fourth (4).
Each of them can be dragged from one position and dropped to another position using
the left-mouse button.
top Page 55