Keyeditor Page



Home
About
Contact
Donate
Download
Frequently Asked Questions
Documentation
Articles
Support and Mailing List
PointShare exchange
Tools and Resources
Multi-language Support


Keyeditor, functions and parameters

Like all programs Loadstone GPS makes use of functions to perform certain tasks. Sometimes a function is activated via the Loadstone menu, sometimes via a simple keypress on the phones keypad. In the 'Configuration/keyeditor' menu you can review the various functions, the key that they are assigned to and sometimes the parameter used. You can add, edit or delete keys, functions and parameters to adapt the Loadstone GPS program to your personal needs.

These functions can have parameters that can hold variables. A function has a name, a parameter is something used by the function, a variable is a container that holds a value. Sounds complicated? Here's an example.

Example

A typical function is the 'launch_browser' function. As can be expected this function launches the phones browser. The launch_browser function uses as a parameter the URL that the browser has to connect to. To connect to the Loadstone GPS website the complete function looks as follows:
launch_browser http://www.loadstone-gps.com

This URL is stored in the variable ${website} so that a shorter form of this function looks like:
launch_browser ${website}

In the keyeditor you can attach this function to a key of your choice for quick access.

Below is a list of functions and a list of variables used in Loadstone GPS.

Functions



name parameters description
add_database string add database optionally specifying the database file to add
append_points string append checkpoints optionally specifying the checkpoints file to load
auto_announce none auto announce toggle
beep string play the specified sound
cell_info none show cell name or number
cellmonitor_toggle none cell monitor toggle
clear_points none clear checkpoints
closest_point integer 0-4 show closest point in the given direction
0 any direction, 1 north/ahead, 2 east/right, 3 south/behind, 4 west/left
connect_default_gps none connect default gps receiver
connect_secondary_gps none connect secondary gps receiver
database_closest_point integer 0-4 show closest point in the given direction always using the database
0 any direction, 1 north/ahead, 2 east/right, 3 south/behind, 4 west/left
database_find_point none find point always using the database
database_show_area integer 0-4 show points in the area in the given direction always using the database
0 any direction, 1 north/ahead, 2 east/right, 3 south/behind, 4 west/left
dgps_off none turn dgps off (for mtk receivers)
dgps_rtcm none rtcm dgps mode (for mtk receivers)
dgps_waas none waas dgps mode (for mtk receivers)
disconnect_gps none disconnect gps receiver
echo string display the specified string of text
enter_point none manually enter a point
exploration_mode none exploration/navigation mode toggle
find_gps none find gps receiver
find_point none find point
goto none go to specified latitude/longitude
goto_locked_point none go to locked point
gps_accuracy none show accuracy
gps_altitude none show altitude
gps_coldstart none cold start the receiver
gps_date none show gps date
gps_decimal_latitude none show latitude in decimal format
gps_decimal_longitude none show longitude in decimal format
gps_grid_square none show gps position in grid square format
gps_heading none show heading
gps_hotstart none hot start the receiver
gps_latitude none show latitude in time format
gps_longitude none show longitude in time format
gps_powersaving_off none power saving off
gps_powersaving_on none power saving on
gps_quality none show gps quality
gps_reset none reset the gps receiver
gps_satellites none show number of satellites
gps_speed none show speed
gps_time none show gps time
gps_vertical_accuracy none show vertical accuracy
gps_waas_off none waas/egnos off
gps_waas_on none waas/egnos on
gps_warmstart none warm start the receiver
isolate_checkpoint none isolate checkpoint toggle
label_cell none label cell
label_point none label point
launch_browser string launch the phone's web browser optionally specifying the url to start with
load_database string load database optionally specifying the database file to load
load_points string load checkpoints optionally specifying the checkpoints file to load
lock_point none set locked point
locked_point none show locked point
logging_toggle none logging start/stop toggle
moon_age none show moon age
moon_azimuth none show moon azimuth
moon_declination none show moon declination
moon_distance none show moon distance
moon_elevation none show moon elevation
moon_phase none show moon phase
moon_right_ascension none show moon right ascension
moonrise none show moonrise and moonset times
next_comment none show comment for next checkpoint
next_point none show next checkpoint
online_tool integer 0-999 launch the specified online tool
0 show tools list, any other number launch that tool in the list
play_memo none play the last recorded voice memo
pointdirection_toggle none toggle point direction setting
record_memo none record a voice memo
relaying_toggle none relaying start/stop toggle
remove_database none remove database
sbas_off none turn sbas off (for mtk receivers)
sbas_on none turn sbas on (for mtk receivers)
show_area integer 0-4 show points in the area in the given direction
0 any direction, 1 north/ahead, 2 east/right, 3 south/behind, 4 west/left
signalmonitor_toggle none signal monitor toggle
sound_toggle none sound toggle
sun_azimuth none show sun azimuth
sun_declination none show sun declination
sun_distance none show sun distance
sun_elevation none show sun elevation
sun_right_ascension none show sun right ascension
sunrise none show sunrise and sunset times
training_mode none training mode toggle
tripmetre_reset none reset trip meter
tripmetre_show none show trip meter
tripmetre_toggle none trip meter start/stop toggle
undefine none remove any functions assigned to this key
unlock_point none clear locked point
use_checkpoints none use checkpoints only toggle
wakeup_toggle none wake up toggle

Parameters for functions depend on the function. If no parameters are
specified for a function requiring parameters then 0 is used in case of an
integer parameter or an empty string is used in case of a string parameter.

Variables


Functions that take a string parameter can have variables within the parameter. A variable is specified with: ${variablename}
The recognized variables and there meanings are as follows:

approachingsound point approaching sound specification
arrivingsound point arriving sound specification
cellchangedsound cell changed sound specification
clocktickbeepsound clock tick beep sound specification
date current date (yyyy-mm-dd)
distanceunit current distance unit, m, i, or n.
errorsound error sound specification
gpsaccuracy gps accuracy (numeric value only)
gpsaltitude gps altitude (numeric value only)
gpsdate gps date (yyyy-mm-dd)
gpsgridsquare gps grid square
gpsheading gps heading in degrees
gpsintlatitude gps latitude as an integer value
gpsintlongitude gps longitude as an integer value
gpslatitude gps latitude as a decimal value
gpslongitude gps longitude as a decimal value
gpssatellites gps satellites used for fix
gpssatellitesinview gps satellites in view
gpsspeed gps speed (numeric value only)
gpstime gps time (hh-mm-ss)
gpsverticalaccuracy gps vertical accuracy (numeric value only)
intlatitude if in navigation mode gps latitude as an integer value, if in
exploration mode exploration position latitude as an integer value.
intlongitude if in navigation mode gps longitude as an integer value, if in
exploration mode exploration position longitude as an integer value.
latitude if in navigation mode gps latitude as a decimal value, if in
exploration mode exploration position latitude as a decimal value.
longitude if in navigation mode gps longitude as a decimal value, if in
exploration mode exploration position longitude as a decimal value.
nosignalsound no signal sound specification
playstartedsound play started sound specification
playstoppedsound play stopped sound specification
pointannouncementsound point announcement sound specification
recordstartedsound record started sound specification
recordstoppedsound record stopped sound specification
signalsound signal sound specification
time current time (hh-mm-ss)
timeoffset current time zone offset
userid user id calculated from username
username username
version loadstone version and series
website http://www.loadstone-gps.com



------------------------------------------------------------

Although Loadstone-GPS is free to use, it has used up thousands of development and testing hours since February 2004. In order for us to continue funding this project, adding features, improving functionality, and strengthening the support and documentation we need your help.

Please consider making a donation (Large or small - any amount is gratefully received) and will ensure development of this project continues well into the future.


Select this link to donate to the Loadstone-GPS project

------------------------------------------------------------


Google
 

------------------------------------------------------------


Use of this web site or any products, programs, and information associated with the Loadstone GPS project constitutes that you have read and understood the disclaimers set forth on the Legalities page

All brands, company names, and product names are trademarks or registered trademarks of their respective holder.
COPYRIGHT 2005 - 2012 - The Loadstone GPS team, All rights reserved
This page has had 534 unique hits since 24/June/2006
This page last edited: 04 May 2010