Keybord Support

Keyboard Support

AvNav supports keyboard shortcuts for important functions.
You can freely assign keys to functions inside AvNav.

Concept

The assignment is defined in 3 levels (columns):

  1. Page
    This is the page shown in AvNav (see user documentation). By using the keyword "all" you can assign the function to all pages.
  2. Group
    This just groups the functionality.
  3. Function
    The particular function to be triggered (like the click on a button).

You can assign one or multiple keys to each of those triples (page, group, function). The more specific configuration will take effect (e.g. an assigment for navpage will win against an assignment for all).

Configuration

The assignment is handled via a file keys.json in the user directory. This file can be edited directly there. Additionally there is a  builtin keys.json file holding the defaults.

The keys.json in the user directory overwrites the defaults.

In this example I created a keyboard assignment for "man over board" to the keys Ctrl-Space and Ctrl-x.

If you just assign a single key the square brackets are not necessary. After you saved your changes you must reload the AvNav page.

Pages Groups and Functions

The list of pages, groups and functions below will reflect the current state when creating this documentation. Step by step new ones will be added.

For the names to be used for the keys refer to the documentation. If the Control key is pressed additionally the string "Control-" will be prepended.

The function names within the group "button" are the names you find beside the buttons in the user documentation.
Clicking a widget can be achieved by using the group "widgets" and entering the name of the widget as the function (the name as displayed in the layout editor). A SOG widget could be triggered with

"all":{
"widgets": {
"SOG": "s"
}
}

using the key "s" on all pages.

The dialog buttons can be assigned using the group "dialogButton" and the name of the button as function. To determine the name you can use the developer tools of your browser (e.g. "inspect element"). You should be careful to only assign special keys to dialog buttons - otherwise you might not be able anymore to make normal inputs.

In the table below I listed the groups and functions that either have a default key assignment - or are neither buttons nor widgets. The texts in brackets are just hints about the functionality.

Assignments

Seite Group Function Default Keys
all button Cancel "Escape"

map zoomIn ["+","PageUp"]


zoomOut ["-","PageDown"]


up "ArrowUp"


down "ArrowDown"


left "ArrowLeft"


right "ArrowRight"


lockGps (keep map center at boat position) "l"


unlockGps "u"


toggleGps ["t","Control-a"]


toggleCourseUp "b"


centerToGps (one time center map to boat)

alarm stop "a"

global
mobon
["Control- "]


moboff


mobtoggle


anchoron (start anchor watch at current position, since 20220421) "i"


anchoroff (20220421) "Control-i"

addon 0 (first addon) "Control-0"


1 "Control-1"


2 "Control-2"


3 "Control-3"


4 "Control-4"


5 "Control-5"


6 "Control-6"


7 "Control-7"
gpspage (dashboard) button Cancel ["d","Escape"]
navpage (navigation page) widget AisTarget "a" (goes to the Ais Info page)


COG "d" (switches to the Dashboard, with the key d you can so toggle between navigation page and dashboard page)

button LockMarker (start navigation to current map center) "g"


StopNav "s"


ShowRoutePanel (open the  Route Editor) ["Control-r","r"]

map centerToGps (one time map center to boat position) "c"

page centerToTarget (move the chart to have the current target waypoint at center) "w"


navNext (navigate to the next point from the route) ["n","Control-n"]


toggleNav (navigation on/off) ["Control-g"]
mainpage (Hauptseite) page selectChart (goto the navigation page using the selected chart) "Enter"


nextChart ["Tab","ArrowDown"]


previousChart "ArrowUp"

button ShowSettings "Control-+"


ShowStatus "Control-s"


ShowGps "d"


Night ["c","Control-c","Control-g"]
infopage (license)


addonpage (user apps)


addresspage (QR codes)


statuspage (server status)


wpapage (wifi control)


routepage (route list)


downloadpage (files/download)


settingspage


editroutepage (route editor)


addonconfigpage (configuration of user apps)


viewpage