SmartPad II Light Show User Guide.fm

Information contained in this document is confidential and should not be distributed outside of Midwest Technologies Illinois, LLC
without the consent of Midwest Technologies Illinois, LLC.
Lightshow User’s Guide for SmartPad I & SmartPad II
Oct. 28th, 2004 - Week 44
Light Show User’s Guide
Program Intent
The Light Show program is intended for a sales show demonstration of the Swath XL lightbar.
Essentially Light Show will simulate a functioning lightbar while running guidance on the Swath XL.
The SmartPad will not display a moving map while Light Show is running. This program strictly runs a
lightbar simulation. Light Show program can be run either from the PC card while inserted into the
Smart-pad, or by installing it to the Smart-pad's flash memory system.
Installation
You will/should have a self-extracting executable file named ltshow.exe. Un-zip this file; this will unzip a
new folder named Support. The Support folder will contain 3 files; ltshow.exe, ltshow.inc and ltshow.txt.
Installing and Running Light Show from the PC Card
Place the entire Support folder onto the PC card. Do not put the Support folder in any sub-folder on
the PC card; it must be place at the root (highest level) of the PC Card.
Firmly seat the PC Card in the SmartPad slot and turn on the unit.
When the main menu appears, select Light Show from the Swath XL Tools menu. When you select
this entry, the Light Show Swath XL Lightbar guidance simulation will begin.
The ltshow.txt file contains a list of keywords that are interpreted as lightbar states. These keywords
are part of the Swath XL Light Show data dictionary. Each data dictionary keyword is defined below.
The ltshow.exe program reads each keyword contained in the ltshow.txt file and displays that state on
the lightbar. After a little practice and review of the Light Show data dictionary, you will be able to
create your own Light Show by modifying the ltshow.txt file.
The Light Show program will cycle through the set of lightbar states in ltshow.txt. When the program
encounters the last keyword state the last state in the ltshow.txt file, it simply moves back to the first
keyword state and starts over. To end the Light Show program, hit the cancel key.
Installing and Running Light Show from the Smartpad
You can also install a version of Light Show onto the Swath XL Smartpad. This eliminates the need to
have the PC card inserted into the Smartpad in order to run the Light Show program. To install Light
Show on to the Smartpad follow these steps:
Obtain the self-extracting zip file named ltshinst.exe. Extract (unzip) the contents of the ltshinst.exe
program. A folder named install is created when you unzip the ltshinst.exe file. Copy this folder and its
contents, on to the Swath XL PC card. When you are completed, you should have a folder named
install on your PC card.
Insert the PC card into the PC card slot located on the Swath XL Smartpad; turn the unit on. Move to
the Tools menu, and run the Light Show install program.
After you have installed the program, turn the unit off. Remove the PC card and turn the unit back on.
Return to the Tools menu, you should see the Light Show program in the menu listings. You can now
run Light Show with out a PC card in the Smartpad PC slot.
If you want to change the Light Show sequence, you can modify the ltshow.txt file located in the install
folder of the PC card. Read the section below describing how to modify the ltshow.txt file.
The ltshow.txt File Definition
Ltshow.txt contains the list of lightbar states that the Light Show program will cycle through. Each state
takes up a single line and ends with a carriage return. Since the last state in the file is followed by a
carriage return, there will be one blank line at the end of the ltshow.txt file.
Each state is composed of a keyword and one or more optional parameters, in the form:
Keyword OptParam1 OptParam2
The keyword and parameters are space delimited. At this time, no state contains more than two
parameters. If a state does not have any parameters, its keyword is immediately followed by a carriage
return. If a keyword is entered improperly, it will be skipped by Light Show.
A definition of each of the states is given below.
Keyword:
all_lights_on
[OptParam1] None
[OptParam2] None
Definition: Turns all of the lightbar (non-screen) LEDs on.
Example:
"all_lights_on" - turns all lightbar LEDs on.
Figure 1: all_lights_on
Keyword:
all_lights_off
[OptParam1] None
[OptParam2] None
Definition: Turns all of the lightbar (non-screen) LEDS off.
Example:
"all_lights_off" - turns all lightbar LEDS off.
Keyword:
light_check
[OptParam1] None
[OptParam2] None
Page 2 of 11
Definition: Displays the LED light show presented to the user when guidance is started. No text is
presented.
Example: "light_check" - Displays guidance light show.
Keyword:
light_check_prod
[OptParam1] None
[OptParam2] None
Definition: Displays the full light show presented to the user when guidance is started. This includes
the product text.
Example: "light_check_prod" - Displays full guidance light show.
Keyword:
gps_slow
[OptParam1] None
[OptParam2] None
Definition: Displays the text and lights, which are presented in guidance when the receiver is not
providing positions at a fast enough rate.
Example:
"gps_slow" - displays the GPS SLOW light show.
Figure 2: gps_slow
Keyword:
no_dgps
[OptParam1] None
[OptParam2] None
Definition: Displays the text and lights which are presented in guidance when the receiver is not
providing corrected positions.
Example:
"no_dgps" - displays the NO DGPS light show.
Figure 3: no_dgps
Keyword:
no_gps
[OptParam1] None
Page 3 of 11
[OptParam2] None
Definition: Displays the text and lights which are presented in guidance when the receiver is not
providing positions.
Example:
"no_gps" - displays the NO GPS light show.
Keyword:
mark_a
[OptParam1] None
[OptParam2] None
Definition: Displays the MARK A message, displayed during guidance, to prompt the user for the first
guideline point.
Example:
"mark_a" - displays MARK A message in the lightbar screen.
Figure 4: mark_a
Keyword:
mark_b
[OptParam1] None
[OptParam2] None
Definition: Displays the MARK B message, displayed during guidance, to prompt the user for the
second guideline point.
Example:
"mark_b" - displays MARK B message in the lightbar screen.
Figure 5: mark_b
Keyword:
applied
[OptParam1] None
[OptParam2] None
Definition: Displays the APPLIED message, displayed during guidance, when the vehicle is moving
into an already applied region.
Page 4 of 11
Example:
"applied" - displays the APPLIED message in the lightbar screen.
Figure 6: applied
Keyword:
bnd_left
[OptParam1] None
[OptParam2] None
Definition: Displays the MAP BND left message/arrow, which are displayed in guidance when the user
to creating a boundary to the left of the vehicle.
Example:
"bnd_left" - displays the MAP BND left message/arrow in the lightbar screen.
Figure 7: bnd_left
Keyword:
bnd_right
[OptParam1] None
[OptParam2] None
Definition: Displays the MAP BND right message/arrow, which are displayed in guidance when the
user to creating a boundary to the right of the vehicle.
Example:
"bnd_right" - displays the MAP BND right message in the lightbar screen.
Figure 8: bnd_right
Keyword:
swath_num
[OptParam1] The swath number (negative for left). (integer)
[OptParam2] None
Definition: Displays the swath number message. This is the message presented to the user during
guidance if Swath # was selected in setup as a display message.
Page 5 of 11
Example:
"swath_num 0" - displays BASELINE in the lightbar screen.
Keyword:
speed
[OptParam1] The speed. Must be >= 0.
[OptParam2] 1 for MPH or 2 for KPH.
Definition: Displays the ground speed message. This is the message presented to the user during
guidance if Ground Speed was selected in setup as a display message.
Example:
"speed 22.4 1" - displays 22.4 MPH in the lightbar screen.
Figure 9: speed
Keyword:
area
[OptParam1] The area. Must be >= 0.
[OptParam2] 1 for AC or 2 for HA.
Definition: Displays the area applied message. This is the message presented to the user during
guidance if Area Applied was selected in setup as a display message.
Example:
"area 78.9 1" - displays 78.9 ac in the lightbar screen.
Figure 10: area
Keyword:
heading
[OptParam1] The heading error. Must be between -180.0 and 180.0.
[OptParam2] None
Definition: Displays the heading error message. This is the message presented to the user during
guidance if Heading Error was selected in setup as a display message.
Example:
"heading 90.0" - displays H 90.0 and arrow to right in the lightbar screen.
Keyword:
heading_na
[OptParam1] None
[OptParam2] None
Page 6 of 11
Definition: Displays the heading error not determined message. This is the message presented to the
user during guidance if Heading Error was selected in setup as a display message and the vehicle
heading has not yet been determined.
Example:
"heading_na" - displays ??? in the lightbar screen.
Keyword:
xtrack
[OptParam1] The cross-track error (negative for left arrows).
[OptParam2] None
Definition: Displays the cross-track error message. This is the message presented to the user during
guidance if X-Track was selected in setup as a display message.
Example:
"xtrack -2.3" - displays 2.3 with left arrows on either side in the lightbar screen.
Figure 11: xtrack
Keyword:
brightness
[OptParam1] Sets the LED brightness (1-100).
[OptParam2] Sets the Text display brightness (1-100).
Definition: Sets the lightbar LED and text display brightness.
Example:
70%.
"brightness 50 70" - sets the LED brightness to 50% and the text display brightness to
Keyword:
flash_on
[OptParam1] None
[OptParam2] None
Definition: Enables flashing lights (such as the guidance lights) on the lightbar. Note that this is the
default state when Light Show starts.
Example:
"flash_on" - enables flashing lights.
Keyword:
flash_off
[OptParam1] None
[OptParam2] None
Definition: Disables flashing lights (such as the guidance lights) on the lightbar. If these lights are tuned
on, they will not flash.
Example:
"flash_off" - disables flashing lights.
Page 7 of 11
Keyword:
pause
[OptParam1] The number of milliseconds (1000 =s 1 second) Light Show will wait before moving to the
next state.
[OptParam2] None
Definition: Pauses specified number of milliseconds before moving to next state.
Example:
"pause 1000" - waits 1 second before continuing to next state
Keyword:
text
[OptParam1] The text you want to display on the lightbar. If the text is greater than eight characters in
length, it will be truncated.
[OptParam2] None
Definition: Displays the specified text on the lightbar screen.
Example:
"text SWATH XL" - displays Mid-Tech on the lightbar screen.
Figure 12: text
Keyword:
fill_screen
[OptParam1] None
[OptParam2] None
Definition: Lights up all the LEDs in the lightbar screen.
Example:
"fill_screen" - lights up all screen LEDs.
Figure 13: fill_screen
Keyword:
clear_screen
[OptParam1] None
[OptParam2] None
Definition: Turns off all the LEDs in the lightbar screen.
Example:
"clear_screen" - clears the lightbar screen.
Page 8 of 11
Keyword:
model
[OptParam1] None
[OptParam2] None
Definition: Displays the lightbar model string. This string is also displayed in Lightbar Test.
Example:
version.
"model" - Will currently display M4-2.0 where 4 is the model ID and 2.0 is the firmware
Keyword:
set_guide_light
[OptParam1] Sets a specific guide LED to the on state. Parameter value ranges is between -11 and 11,
where the minus values are to the left.
[OptParam2] None
Definition: Sets the specified guide LED. This state must be followed by show_set_lights to actually
turn the light on. By separating these two states, we are able to turn on any combination of stop and
guide lights.
Example:
"set_guide_light 2" - sets the guide light 2 to the right of center to on.
"set_guide_light 0" - sets the center light to on.
"show_set_lights".
Figure 14: set_guide_light
Keyword:
set_stop_light
[OptParam1] The stop lights to turn on. May be 1 (Green), 2 (Yellow), or 3 (Red).
[OptParam2] None
Definition: Sets the specified stop LEDs to on. This state must be followed by show_set_lights to
actually turn the light on. By separating these two states, we are able to turn on any combination of
stop and guide lights.
Example:
"set_stop_light 3" - sets the red stoplights to on
"set_guide_light 2" - sets the guide light 2 to the right of center to on.
"set_guide_light 0" - sets the center light to on.
Page 9 of 11
"show_set_lights".
Figure 15: set_stop_light
Keyword:
show_set_lights
[OptParam1] None
[OptParam2] None
Definition: Displays the lights set with set_guide_light and set_stop_light.
Example:
"set_stop_light 1"
"set_guide_light -2"
"set_guide_light 0"
"show_set_lights" - turns on the green stop light and the center and 2nd guide light to the left of center.
Figure 16: show_set_lights
Keyword:
show_lights
[OptParam1] The number of the guide light to illuminate. May be between -11 and 11.
[OptParam2] The stop light to turn on. May be 1 (Green), 2 (Yellow), or 3 (Red). (integer)
Definition: This state is a combination of set_guide_light, set_stop_light, and show_set_lights. It will
turn on a single guide light and stop light.
Example:
center.
"show_lights 2 1" - turns on the green stop light and the 2nd guide light to the right of
Figure 17: show_lights
Page 10 of 11
Install Instructions for SmartPad II v 4.01
Required Files:
ltshow_spII.zip (extracts to: ltshow.exe, ltshow.lmf, ltshow.txt)
Instructions:
•
Extract the zip file to a Compact Flash (CF) card. This will place a “Support” folder with
the necessary ltshow files at the root of the card.
•
•
•
Insert the CF card into the Smart Pad II.
Go to Tools, down arrow to the last item on the menu, it should be called “Light Show”.
Select it and hit enter. Lightshow will run. Hit the escape key to exit Lightshow.
Notes:
•
This version of Lightshow was created with the existing Smart Pad I executable for the
SP II environment.
•
The ltshow.txt files you used with the SmartPad I version will work with the SmartPad II.
Commands and format are the same if you wish to construct new files.
•
This temporary fix uses the same screen colors and dimensions as those on the SP I.
Therefore, this instance of lightshow is gray scale and will not cover the entire display.
•
•
This version of lightshow does not support touch screen display.
The touch screen still works in the area outside of the Lightshow window. Please do not
touch the screen outside of the Lightshow window or you will be required to power off
the SP II to turn off Lightshow.
Page 11 of 11