-S63 Vector Charts Plugin
-oeSENC Vector Charts Plugin
+Information on these can be accessed through the online wiki:
+S63 Vector Charts Plugin
-BSB4 Charts Plugin
+oeSENC Vector Charts Plugin
-NV Charts Plugin
+BSB4 Charts Plugin
+ +NV Charts Plugin

@@ -119,13 +121,13 @@

-Chart Sources Free chart sources list.
+Chart Sources; Free chart sources list. (see online wiki).
Chart Formats Supported chart formats.
Background GSHHS Shoreline
- High Resolution Background GSHHS Shoreline
+High Resolution Background GSHHS Shoreline (see online wiki)

@@ -141,7 +143,7 @@ CM93 Offsets How to correct Offsets at your own risk.
-Chart Conversion Manual Kap, Imgkap, libBSB GE
+Chart Conversion Manual, Kap, Imgkap, libBSB GE (see online wiki)

diff -Nru opencpn-doc-4.8.10129.2/doc/faq.html opencpn-doc-4.8.2.0/doc/faq.html --- opencpn-doc-4.8.10129.2/doc/faq.html 2018-01-30 12:28:30.000000000 +0000 +++ opencpn-doc-4.8.2.0/doc/faq.html 2018-02-07 14:43:14.000000000 +0000 @@ -1,765 +1,747 @@ - - - - - opencpn:opencpn_user_manual:faq - - - - - - - - - - - - - - - - - - - - - -

- - - -

FAQ

- -

Where is my log file?

- -

-Read this explanation - Getting Started -

- -

Where is my config.ini file?

- -

-Read this explanation - Getting Started -

- -

Where can I download the User Manual?

- -

-It is downloaded with the software, so use “?” icon and then “Help”! It is also available on the Website Download page Then scroll to the bottom under ARCHIVES. -

- -

How to find all those files you are talking about?

- -

-A big contributing factor to this problem is that Windows default settings hides system files, and also by default, don't show file extensions. -

These settings can be changed however.
-
In XP go to My Computer →Tools → Folder Options -View. Mark “Show hidden files and folders” and uncheck “Hide extensions for known file types”.
-
Other versions of Windows are similar, but may not be exactly like this.
-

- -

-Now you should find the files we talked about in the previous paragraph. -

- -

Is there a compatible Hardware List?

- -

-Keeping an updated list of all the devices available is virtually impossible. -

As long as your device is able to produce NMEA 0183, OpenCPN most likely won't have any problem understanding it.
-
Rather than looking for a list, which can't contain everything, ask in the support forum whether your equipment of choice is likely to work with OpenCPN before going shopping.
-
If still looking for lists, you may like the following links
-
1. Information about connecting various devices to OpenCPN:Supplementary hardware
  -
2. Radars for OpenCPN: Radar Overlay
  -
-

- -

Trouble with Installation, finding Charts, and connecting GPS & Instruments.

OpenCPN Installation
-
Chart Files Tab
-
Installing Charts with Chart Downloader Plugin Chart Downloader
-
Installing GPS GPS Setup and Status
-
Instruments - Devices must provide NMEA 0183 data via Serial or Network with a range of protocols and settings available. The description for connecting to hardware is in the Options > Data Connections section. Connections and for additional assistance NMEA Sentences
-
See Supplementary Hardware
-
Also read Supplementary Software which has information about using an Android Phone's GPS, etc.
-

- -

OpenCPN crashes, what should I do?

It is highly unlikely that uninstalling and reinstalling OpenCPN is going to resolve anything, really. But if you can't resist the temptation, help yourself, it is equally unlikely that it makes the things worse.
-
You should have a look into the logfile to find out whether it contains some clues that could help isolate the problem. If the crash is related to displaying a chart, try to isolate on which one and create the simplest possible scenario we could reproduce. You should try to get fresh charts.
-
You should try disabling OpenGL if it is enabled or vice versa.
-
While OpenCPN is not running, move the complete data folder (C:\ProgramData\opencpn on Windows, ~/.opencpn on Linux ~/Library/Preferences/opencpn / on Mac ) to a backup location and see whether something was rotten in your local OpenCPN data. Do not delete it if you want to keep your waypoints, routes and tracks!
-
If on Linux, run opencpn from command line and see whether it produces a backtrace to help identify the cause of the crash.
-
Still on Linux, you can use gdb or another debugger to get the backtrace and help identify the cause of the crash.
-

- -

Why is recently updated OpenCPN performing badly?

Look in the opencpn.log file. Try closing Opencpn, deleting the opencpn.log file and then reopening OpenCPN to create a new log file, then use Opencpn to cause the trouble again. Then look at the Log file to find messages that are associated with the problem.
-
Verify the problem is not from an old and outdated opencpn.ini file. Rename your opencpn.ini file for possible reuse later, and restart Opencpn to create a fresh new opencpn.ini file. Test for the problem.
-
Do you have Chart Display problems? Try turning on or off OpenGL and Running update of the Chart Database.
-
Do you have a problem with paid charts? see Oesenc or ocharts.
-
Do you have old plugins? Disable and uninstall all external plugins with the plugin uninstall program. Test OpenCPN and then download new updated plugins and install them one at a time and test.
-
Final Resort: Try starting over by uninstalling Opencpn following this approach.
-
- Go to the ProgramFiles “OpenCPN” folder, and use the uninstall programs, preferably starting with the plugins, and ending with the OpenCPN.
  -
- Check that the “opencpn” initialization folder of program data has been removed. Otherwise, do it manually.
  -
- Use the CCleaner software to clean the PC Windows registry in particular. (option)
  -
- Download OpenCPN again and all the plugins you need.
  -
- Install OpenCPN.
  -
- Run OpenCPN to verify that the operation is correct.
  -
- Install, one by one, the plugins you need.
  -
- Run each plugin before installing another one
  -
-

- -

I have a problem so I reinstalled, but that did not help.

- -

-- Try this approach instead - Troubleshoot Installation -

- -

GPS is not found by OpenCPN, but my GPS is working!

See Getting Started > GPS Setup
-
-
But I know my GPS is working because the GPS program shows that it is working fine. Have you closed that program before trying to connect OpenCPN to the GPS? Only one program can connect to the GPS at a time.
-

- -

GPS is installed and I think its working, what next?

OpenCPN Installation
-
Perhaps you'd like to download some charts? We suggest using Chart Downloader.
-

- -

Charts used to show, but using 3.0.2 and later, they no longer work.

OpenCPN used to display charts with an unknown projection as a Mercator chart. The same thing applies to an “UNKNOWN” or not recognized geodetic datum, where OpenCPN used to default to WGS84.
-
This is no longer the case. If OpenCPN don't recognize the chart projection, it will not be displayed.
-
- Potentially serious errors are thus avoided.
  -
- The event is logged in the opencpn.log.
  -
- Users may run into problems if a chart projection is stated as “UNKNOWN” even though it really is a prefect Mercator chart.
  -
-
Unfortunately, some conversion tools take a shortcut and don't enter the “PR” tag in the kap-chart-header correctly.
-
- The projection of a chart can always be found, and the “PR=UNKNOWN” should always be avoided.
  -
-

- -

-Official charts that OpenCPN really can't display, with a latitude < 70 degrees north/south, are very few indeed. Really only a handful of legacy, Gnomonic, large scale charts. Charts with “UNKNOWN” or blank geodetic datum are best avoided, they may be dangerously inaccurate. -

- -

Many error messages when starting OpenCPN from Linux command line.

- -

-Messages like: -

“ALSA lib pcm.c:2217:(snd_pcm_open_noupdate) Unknown PCM cards.pcm.side ALSA lib audio/pcm_bluetooth.c:1614:(audioservice_expect) BT_GET_CAPABILITIES failed : Input/output error(5)” or
-
“(opencpn:8979): Gdk-CRITICAL : IA_gdk_drawable_get_size: assertion `GDK_IS_DRAWABLE (drawable)' failed”
-
'(opencpn:8979): Gdk-CRITICAL : IA_gdk_drawable_get_depth: assertion `GDK_IS_DRAWABLE (drawable)' failed Error opening coefficient file“
-
”(opencpn:8979): Gdk-CRITICAL : IA_gdk_window_get_origin: assertion `GDK_IS_WINDOW (window)' failed“
-

- -

-are quite normal and have nothing to do with OpenCPN. Just ignore them! -

- -

Why doesn't the plugin work?

See Plugin API Versions
-
It is best to keep OpenCPN and plugins updated to the most current version.
-
If you are having trouble, it is likely you will be asked to update plugins and Opencpn to be current.
-

- -

When will OpenCPN be ported to Android?

There are two versions in the Google Play Store. We suggest you will be happiest with the paid version created by D. Register because it is updated regularly and is current. There is a forum at http://bigdumboat.com/aocpn/forum/.
-

- -

Why do vector charts take so long to load?

The behavior you see is expected for ENC charts. ENCs must be converted to internal SENC format before use for navigation. This takes a little bit of time, depending on your system capabilities. But it only has to be done once, and the converted SENCs are stored on your system for later use.
-
All ECS systems must convert ENCs to SENCs. Some take longer, (like OpenCPN), so that subsequent access is faster. Some convert faster, leaving more work to do at the time of actual chart display. Its a design decision. OpenCPN is optimized for speed in real use, not for speed in conversion.
-

- -

Why don't charts show at all zoom levels while quilting is enabled?

If I turn off quilting, I can select the individual maps just fine and zoom to any level on them. No amount of clicking/hiding the maps using the map bar at the bottom of the screen show the maps. Only a zoom allows them to be seen. This problem of disappearing maps happens all over the country at different zoom levels.
-
Answer: OpenGL is turned off. Without OpenGL, OpenCPN will not quilt Mercator and Transverse Mercator charts together. Try enabling OpenGL with Options (wrench tool icon)> Display> Advanced. Click on the box between “Graphics” and “Use Accelerated Graphics (OpenGL)” to put a checkmark in the box.
-
When OpenGL is enabled, OpenCPN will quilt Mercator and Transverse Mercator charts (and some other projections).
-
If “Texture Compression with Caching” is enabled under “OpenGL Options” there will be a delay before each chart is displayed for the first time. Subsequent display of the charts in the cache will be faster.
-

- -

Whenever a specific chart is opened, OpenCPN crashes. What's going on?

Chances are the chart file is corrupted.
-
Note the name and number of the suspect chart and replace it with a fresh download.
-
Read the log file that may contain relevant information regarding the chart.
-
Sometimes the bad chart blocks OpenCPN from restarting.
-
Follow these instructions instead Troubleshoot Installation
-

- -

What are all those 'U' s or '*' astericks in triangle all over my Vector Charts?

- -

-Most users just want to get rid of the triangles, but please refer to the Quality of Data Documentation. -

In Options > Charts > Vector Charts Tab when using Display Category “All”, Uncheck “Chart Information Objects” which hides the “U” symbols .
-
In Options > Charts > Vector Charts Tab for a finer grain control when using Display Category “Mariners Standard”, In the selection List Box, Uncheck “Quality of Data” which hides the “U” symbols.
-

- -

What are those acronyms on the charts?

- -

-To learn the acronyms used in this application search the S57 'Object and Attribute' catalog at: http://www.s-57.com/
- -Also, when viewing ENC charts: -

“U's” show up all over the charts
-
Text detail seems to be missing ..like bouy identification ..Bridge names and clearances etc…
-
Depth sounding seem to disappear zooming in and out.
-

- -

-Hit Text: The A+ button. To show text. -

- -

How to remove those pink crosses (isolated anger symbology)?

- -

-This isolated danger symbology is a part of the new ENC S57 presentation standard which OpenCPN complies with, get used to it. -OR -You can try to cover them with your depth setting. Look at the manual Vector Display Tab > Shallow, Safety & Deep Depths -Safety Contour”, where you will find an example of just how depth is taken into account when displaying the magenta cross. -

Safety Depth = 2 meters almost of the pink crosses are covered, but not those in depths 2-5m.
-
Safety Depth = 10 meters all pink crosses are covered and you have lost your pink friends.
-

- -

Kap files are no longer displayed correctly. Why?

Old versions of OpenCPN were correcting broken KAPs on the fly. (They work on 3.2 but not on any 4. release ) The new ones don't do it anymore as the number of damaged charts circulating around decreased significantly and we gained some extra performance during chart loading. Refer to these sections of the User Documentation too.
-
Chart Conversion Manual Specifically libBSB and ImgKap and Kap files.
-
To fix your charts, run bdbfix on them.
-

- -

What causes spurious waypoints which must be deleted?

Condition: Multitude of repeated waypoints, which get copied when a waypoint is dragged. Sometimes a route WP is shifted, two routes are made, one with the name, the other unnamed.
-
Possible Solutions: Determine if the addition of waypoints are from inadvertantly hitting the wrong keys on the keyboard, or the mouse.
-
The other possiblity is that the navobj change file is corrupted. Close O and try to delete the change file In W8.1 it is found in C:\ProgramData\opencpn/navobj.xml.changes. Normally, after that O will work again.
-

- -

Can I use my Seaclear wci or OziCharts?

- -

-See Use-seaclear-wci-charts and Oziexplorer to Opencpn -Also see Not supported formats that can be converted and Map2Kap and WCI Charts -

- -

Can I import SeaClear routes and waypoints into OpenCPN?

Yes. I had originally created and maintained all my routes and waypoints in SeaClear, exported them, loaded them into GPS Utility (for Windows) and saved them as text files.
-
To import into OpenCPN I opened all my text files (routes and waypoints) with GPSUtility, saved that out as one big gpx file, and loaded it into OpenCPN. Works like a champ.
-
I've edited them and saved them back out as GPX files with no trouble.
-
Individual routes can be edited and saved in appropriately named GPX files.
-

- -

How to synchronize Routes, Waypoints & Marks with another computer?

- -

-Three ways to synchronize: -

From the Route & Mark Manager > Route Tab, select “Export all visible” or highlight select routes and “Export Selected” to a gpx folder. Then use saved gpx file to import the Routes to another computer. For Marks pick the Waypoint Tab, select “Export all visible” or highlight select waypoints and “Export selected” to a gpx folder. Then import waypoints from the other computer.
-
Copy the navobj.xml file to the second computer's navobj.xml file, which will overwrite your routes and marks on that computer. If you are connected via a network you can make a batch file to do this.
-
To copy all waypoints or routes, make a copy & rename the navobject.xml file to .gpx file and import the waypoints, routes and/or tracks. This does all waypoints/routes/tracks at once.
-

- -

-The navobj.xml file resides in the same folder as the opencpn.ini settings file, under the OpenCPN User folder. For windows this is usually “C:\programdata\opencpn\”. -The navobject.xml file is in in fact a .gpx file containing all waypoints/routes/tracks. -See Navigation Data Backup for more information. -

- -

Jumping GPS!

- -

-GPS AIVDO Boat Position is Jumping many miles away. -

See this entire thread. http://www.cruisersforum.com/forums/f134/opencpn-jumping-map-194531.html#post2535508 You will need to use OpenCPN NmeaData Window and a Free nmea decoders and a program like Notepad++ to figure out what the offending sentences are.
-
Remember that “The NMEA standard uses two primary sentences to for AIS data !AIVDM (Received Data from other vessels) and !AIVDO (Your own vessels information)” AIS - Automatic Identification System - Information
-
Problem may be from having two different Own Ship position signals at the same priority, with the additional problem that AIVDO sentences position, sog & cog are just wrong. 1. First disable all but one GPS signal. (Disconnect or turn off.) 2. Stop sending AIVDO (Use either hardware or software settings.) 3. Filter out all AIVDO messages completely. See the User Manual > Connections > Filters put “AIVDO” in the Input filtering line.
-

- -

Charts jump while Using Follow Ship Offset, Look Ahead & North up Modes

- -

-Chart Rotation Smoothing. When follow ship, offset mode, look ahead mode and north up mode are all turned on, the goal of the look ahead is to position the ship about 2/3 away from the farthest point directly ahead of the ship. Because the screen is a rectangle, the ship's position on the screen keeps changing, since the farthest point ahead is changing rapidly. Use Options > Display > Advanced Chart Rotation Averaging Time [new title] or Course-up Update Period _Time [old title] to smooth the chart rotation. It is actually another “always on” COG filter that smooths VP rotation and makes the chart much less jumpy. In conjunction with NMEA course and speed filtering the chart moves slowly in a nice way. -

Under Options > Display > Advanced see Chart Rotation Averaging Time
-
and for more about Display Orientation -Look Ahead and Course up
-

- -

AIS Targets HDG and COG may be wildly different

- -

-The TRUE Heading reported in the target query is always as actually reported by the target. We do not apply variation to that value before presentation. So, what you see is no error. Of course, in situations with strong cross currents, or maneuvering, the reported HDG and COG may be wildly different. -

- -

How can a SART Alarm be disabled or ignored?

- -

-MOB SART has been tested extensively. The methods for deactivation should work. See SART. Also Disable SART When Alert is active, find the Alert's MMSI number in the AIS Target List. Then Add a “New” MMSI number in Options→Ships→MMSI. Then Edit the Options→Ships→MMSI Properties to “ignore” this target. Then close the Options Dialog. Then “Acknowledge” the SART alert one more time, and no further alerts will be seen. If you restart OCPN, you will never get alerts for this target again. -

- -

How to send routes to GPS via USB or via NMEA Serial connection

- -

-There are so many GPS models that the answer is a bit complicated. A lot depends on which GPS model you have. OpenCPN can communicate with many GPS receivers via a serial connection. Some GPS receivers have a serial connector that can be wired to a DB-9 serial connector. Newer ones have a USB port that will appear like a serial connection to your computer. Still newer ones appear to your computer like an external drive. -

- -

-If your GPS receiver shows up as a serial connection on your computer chances are you can upload routes and waypoints directly to it from within OpenCPN. The GPS and OpenCPN have to be set to the same communication protocol. If you normally have them set to NMEA (for updating the OpenCPN chart display with position data from the GPS) you may need to change a Garmin GPS to the GRMN proprietary protocol to upload routes, waypoints, and tracks. If your GPS doesn't show up as a serial connection you may still be able to transfer routes and waypoints to it outside of OpenCPN. If the GPS appears as an external drive on your computer try this. Use OpenCPN to export your routes and waypoints to a GPX file (read the User Manual section on the Route & Mark Manager for more details). Then use your operating system to copy the GPX file from your hard drive to your GPS. If that doesn't work, try GPSBabel or EasyGPS for the transfer. -

- -

-Depending on your GPS model and the way the route was created in OpenCPN you may wind up with a route on your GPS or just a list of waypoints. The route points may or may not appear as waypoints on the GPS. -

Garmin has a program called Homeport which connects to most of their small GPSmap and Plotters which will upload/download waypoints and routes. I believe it will also import gpx routes.
-
EasyGPS is a free program that allows you to transfer routes, waypoints, and tracks between your Windows computer and your Garmin, Magellan, or Lowrance GPS.
-
GPSBabel is another free program that allows you to transfer data between your computer and your GPS. It runs on Windows, Mac, and Linux operating systems and supports a wide range of GPS models.
-
There are also some helpful notes in the manual.
-
Route & Mark Manager
-
Sending Routes and Waypoints to a GPS
-
Hardware GPS Devices
-
The oBabel plugin uses GPSBabel to transfer routes without leaving OpenCPN.
-

- -

Night time Mode Title bar is too bright in Windows

In Windows, Night, F5, mode. The title bar on the floating plugin window is a bit glaring (this mode is controlled by windows by way of a theme and is not possible to change from an application) .
-
The best solution is to simply “dock” the dashboard window at night, either left or right. This brings the window decorations back under OCPN control, and we recently added logic to dim it in this mode.
-
Dimming the screen, if it is available and goes far enough is often best. F6 General Dimming, in steps, of the entire Screen. (except Mac OS X ). OpenGL must be off.
-
Otherwise the “Change color scheme' F5 button or (C, Ctrl+C, Ctrl+G). This may or may not work on your particular computer.
-
See Keyboard Shortcuts
-
For Linux users, who have little differentiation between shallow water colurs and land colours, try “F.Lux” which has a 2000k setting that makes the screen quite dull over the daytime colour palette. F.lux is confirmed as massive win on Linux. Daytime palette and use F7 to drop the brightness a bit more if needed. https://itsfoss.com/night-shift-flux-ubuntu-linux/
-

- -

How are fonts adjusted in the User Interface?

See Options > User Interface Fonts and Font Color.
-

- -

How are fonts adjusted for the AIS Target List?

The AIS Target List does not exist in UI > Options Fonts selection. AIS target list uses the “Dialog” font key in Options > User Interface, Fonts and Font Color..
-

- -

How are font sizes for vector chart Depth Soundings adjusted?

- -

-Out of the box, the “Depth” notation is unreadable. -

Try Options > User Interface > Chart Object Scale Slider set on +4 or +5.
-
Try using the Swedish color palette which changes depth font to black.
-
The Chart Object Scale Slider is for Vector Charts only.
-
Raster Chart cartography is superior and depths are very clear in comparision.
-

- -

Waypoint Properties Editing Links

Opening the properties page, and adding a link to a JPG-image works fine. If I now edit the link, the image will no longer be displayed.
-
1. The button “Edit” changes state. You click on it to switch the links above to “edit mode”, each click on any of the links opens the dialog allowing you to change it's parameters. After editing the link, you have to click on the button again and then a click on the links will again start opening whatever they link to. What will happen when you click on the link is explained in the text bellow the buttons and changes according to the “Edit button”. If it says “Links are opened in the default browser”, the linked file or internet address should open, given it exists, which gets us to..
  -
-
Similarily, if I export a waypoint with a link to another computer, the link will not open.
-
1. The link is just a link, the file you link to is NOT “included” in the waypoint. When you transfer the waypoints to another computer, for links to local files to keep working, the files you link to would have to exist on the exactly same place on your disk there. Eg. The file that on computer A is C:\MyDocuments\MyPicture.jpg would have to exist with exactly the same file name, in the exactly same folder, on the exactly same disk on computer B.
  -
-

- -

OpenCPN and Great Circle Navigation

There is a Route Plugin for Great Circles.
-
Raster charts display bearings and headings as straight, measurable lines on the chart. Similarly, Vector ENC's are rendered as Mercator projections in OpenCPN and most other ECS's for the same reason.
-
For typical coastal navigation, errors which occur using rhumb line instead of great circle calculations are small for the distances usually covered by one chart.
-
Mercator Charts and Mercator navigation is the standard for most navigational purposes. Other terms used instead of “Mercator Sailing” is “Loxodrome Sailing” or “Rhumb Line Sailing”.
-

- -

OpenCPN 3.2.0 forward handles Great Circles directly

Great Circle Routes are explained Great Circle Sailing.
-
There is also a plugin available as well as some Supplementary Software to handle great Circles.
-

- -

Why aren't settings saved properly when I close Opencpn?

- -

Not saving settings when exiting -due to Inland ECDIS is checked

- -

European Inland Waterways ECDIS Mode

- -

-Issue just started with 4.8.0 where on exit doesn't save * Units * Configuration of toolbar * Starts in night mode I searched the opencpn.ini for these settings but not sure what I am looking for TBH. I also backed up this file and exited the program forming a new ini file, same issue. Any ideas? -

- -

-OpenCPN is probably set to use settings for Inland ECDIS European Inland Waterways ECDIS -

Click the wrench (or spanner) icon on toolbar to open the “Settings” dialog.
-
Select the “User Interface” tab, and
-
look below the “Interface Options” for
-
“Use Settings for Inland ECDIS Version 2.3”.
-
Remove the checkmark on the “Use … Inland ECDIS…” line.
-

- -

Right-click > Navigate > To Here has a problem

- -

-The new Active Route always disappears and I try to recreate it and it disappears again. -

If the distance to waypoint increases slightly then route manager says we have “arrived” and it tries to advance to the next waypoint.
-
But in a simple “Navigate to here” scenario there is no next waypoint so it just assumes it has arrived at the destination.
-
Also this problem may be due to some “noise” from the GPS position.
-
Try setting Options > Ships > Own Ship in the Routes box check “Advance route waypoint on arrival only”.
-

- -

How exactly does NMEA 0183 HDG Sentence work?

- -

-If HDG message also contains the variation and E/W flags then O will use that. If not then it will look in RMC message for a variation. If nothing there it will use WMM plugin unless user has selected the variation manually in options. -

- -

How do I save many waypoints to a Layer?

- -

-Question: Layers is a good feature, however I need a tool to create a layer with many waypoints (say 200 waypoints in Fiji). I'd like create a layer of all visible waypoints in a chart area that I have zoomed into. After creating the layer, I'd like to delete them from the waypoints list with a single command. -

- -

-Answer: Using the Route & Mark Manager -

Import the waypoints into the Waypoints Tab.
-
Select all the Waypoints by clicking & highlight the top waypoint, scroll to the bottom and while holding the Shift key, click to highlight all.
-
Wait for all the waypoints to be highlighted.
-
Click on the button “Export selected …”.
-
Browse to choose the directory to save the waypoints, & name the file 'Fiji Waypoints'.
-
Click on 'Save'.
-
All the waypoints will be in one .gpx file which, when put in the Layers folder can be displayed or not in the Layers Tab by toggling the 'eyeball'.
-
You can also use the 'List contents' in the Layers Tab to have the Waypoints displayed in the Waypoints Tab.
-
When done you can clear the Waypoints Tab from the Layers tab by clicking on 'Unlist Contents'.
-
See Handling Layers
-

- -

- - -

- - + + + + + opencpn:opencpn_user_manual:faq + + + + + + + + + + + + + + + + + + + + + +

+ + + +

FAQ

+ +

Where is my log file?

+ +

+Read this explanation - Getting Started +

+ +

Where is my config.ini file?

+ +

+Read this explanation - Getting Started +

+ +

Where can I download the User Manual?

+ +

+It is downloaded with the software, so use “?” icon and then “Help”! It is also available on the Website Download page Then scroll to the bottom under ARCHIVES. +

+ +

How to find all those files you are talking about?

+ +

+A big contributing factor to this problem is that Windows default settings hides system files, and also by default, don't show file extensions. +

These settings can be changed however.
+
In XP go to My Computer →Tools → Folder Options -View. Mark “Show hidden files and folders” and uncheck “Hide extensions for known file types”.
+
Other versions of Windows are similar, but may not be exactly like this.
+

+ +

+Now you should find the files we talked about in the previous paragraph. +

+ +

Is there a compatible Hardware List?

+ +

+Keeping an updated list of all the devices available is virtually impossible. +

As long as your device is able to produce NMEA 0183, OpenCPN most likely won't have any problem understanding it.
+
Rather than looking for a list, which can't contain everything, ask in the support forum whether your equipment of choice is likely to work with OpenCPN before going shopping.
+
If still looking for lists, you may like the following links
+
+

+ +

Trouble with Installation, finding Charts, and connecting GPS & Instruments.

OpenCPN Installation
+
Chart Files Tab
+
Installing Charts with Chart Downloader Plugin Chart Downloader
+
Installing GPS GPS Setup and Status
+
Instruments - Devices must provide NMEA 0183 data via Serial or Network with a range of protocols and settings available. The description for connecting to hardware is in the Options > Data Connections section. Connections and for additional assistance NMEA Sentences
+

+ +

OpenCPN crashes, what should I do?

It is highly unlikely that uninstalling and reinstalling OpenCPN is going to resolve anything, really. But if you can't resist the temptation, help yourself, it is equally unlikely that it makes the things worse.
+
You should have a look into the logfile to find out whether it contains some clues that could help isolate the problem. If the crash is related to displaying a chart, try to isolate on which one and create the simplest possible scenario we could reproduce. You should try to get fresh charts.
+
You should try disabling OpenGL if it is enabled or vice versa.
+
While OpenCPN is not running, move the complete data folder (C:\ProgramData\opencpn on Windows, ~/.opencpn on Linux ~/Library/Preferences/opencpn / on Mac ) to a backup location and see whether something was rotten in your local OpenCPN data. Do not delete it if you want to keep your waypoints, routes and tracks!
+
If on Linux, run opencpn from command line and see whether it produces a backtrace to help identify the cause of the crash.
+
Still on Linux, you can use gdb or another debugger to get the backtrace and help identify the cause of the crash.
+

+ +

Why is recently updated OpenCPN performing badly?

Look in the opencpn.log file. Try closing Opencpn, deleting the opencpn.log file and then reopening OpenCPN to create a new log file, then use Opencpn to cause the trouble again. Then look at the Log file to find messages that are associated with the problem.
+
Verify the problem is not from an old and outdated opencpn.ini file. Rename your opencpn.ini file for possible reuse later, and restart Opencpn to create a fresh new opencpn.ini file. Test for the problem.
+
Do you have Chart Display problems? Try turning on or off OpenGL and Running update of the Chart Database.
+
Do you have a problem with paid charts? see Oesenc or ocharts.
+
Do you have old plugins? Disable and uninstall all external plugins with the plugin uninstall program. Test OpenCPN and then download new updated plugins and install them one at a time and test.
+
Final Resort: Try starting over by uninstalling Opencpn following this approach.
+
- Go to the ProgramFiles “OpenCPN” folder, and use the uninstall programs, preferably starting with the plugins, and ending with the OpenCPN.
  +
- Check that the “opencpn” initialization folder of program data has been removed. Otherwise, do it manually.
  +
- Use the CCleaner software to clean the PC Windows registry in particular. (option)
  +
- Download OpenCPN again and all the plugins you need.
  +
- Install OpenCPN.
  +
- Run OpenCPN to verify that the operation is correct.
  +
- Install, one by one, the plugins you need.
  +
- Run each plugin before installing another one
  +
+

+ +

I have a problem so I reinstalled, but that did not help.

+ +

+- Try this approach instead - Troubleshoot Installation +

+ +

GPS is not found by OpenCPN, but my GPS is working!

See Getting Started > GPS Setup
+
+
But I know my GPS is working because the GPS program shows that it is working fine. Have you closed that program before trying to connect OpenCPN to the GPS? Only one program can connect to the GPS at a time.
+

+ +

GPS is installed and I think its working, what next?

OpenCPN Installation
+
Perhaps you'd like to download some charts? We suggest using Chart Downloader.
+

+ +

Charts used to show, but using 3.0.2 and later, they no longer work.

OpenCPN used to display charts with an unknown projection as a Mercator chart. The same thing applies to an “UNKNOWN” or not recognized geodetic datum, where OpenCPN used to default to WGS84.
+
This is no longer the case. If OpenCPN don't recognize the chart projection, it will not be displayed.
+
- Potentially serious errors are thus avoided.
  +
- The event is logged in the opencpn.log.
  +
- Users may run into problems if a chart projection is stated as “UNKNOWN” even though it really is a prefect Mercator chart.
  +
+
Unfortunately, some conversion tools take a shortcut and don't enter the “PR” tag in the kap-chart-header correctly.
+
- The projection of a chart can always be found, and the “PR=UNKNOWN” should always be avoided.
  +
+

+ +

+Official charts that OpenCPN really can't display, with a latitude < 70 degrees north/south, are very few indeed. Really only a handful of legacy, Gnomonic, large scale charts. Charts with “UNKNOWN” or blank geodetic datum are best avoided, they may be dangerously inaccurate. +

+ +

Many error messages when starting OpenCPN from Linux command line.

+ +

+Messages like: +

“ALSA lib pcm.c:2217:(snd_pcm_open_noupdate) Unknown PCM cards.pcm.side ALSA lib audio/pcm_bluetooth.c:1614:(audioservice_expect) BT_GET_CAPABILITIES failed : Input/output error(5)” or
+
“(opencpn:8979): Gdk-CRITICAL : IA_gdk_drawable_get_size: assertion `GDK_IS_DRAWABLE (drawable)' failed”
+
'(opencpn:8979): Gdk-CRITICAL : IA_gdk_drawable_get_depth: assertion `GDK_IS_DRAWABLE (drawable)' failed Error opening coefficient file“
+
”(opencpn:8979): Gdk-CRITICAL : IA_gdk_window_get_origin: assertion `GDK_IS_WINDOW (window)' failed“
+

+ +

+are quite normal and have nothing to do with OpenCPN. Just ignore them! +

+ +

Why doesn't the plugin work?

It is best to keep OpenCPN and plugins updated to the most current version.
+
If you are having trouble, it is likely you will be asked to update plugins and Opencpn to be current.
+

+ +

When will OpenCPN be ported to Android?

There are two versions in the Google Play Store. We suggest you will be happiest with the paid version created by D. Register because it is updated regularly and is current. There is a forum at http://bigdumboat.com/aocpn/forum/.
+

+ +

Why do vector charts take so long to load?

The behavior you see is expected for ENC charts. ENCs must be converted to internal SENC format before use for navigation. This takes a little bit of time, depending on your system capabilities. But it only has to be done once, and the converted SENCs are stored on your system for later use.
+
All ECS systems must convert ENCs to SENCs. Some take longer, (like OpenCPN), so that subsequent access is faster. Some convert faster, leaving more work to do at the time of actual chart display. Its a design decision. OpenCPN is optimized for speed in real use, not for speed in conversion.
+

+ +

Why don't charts show at all zoom levels while quilting is enabled?

If I turn off quilting, I can select the individual maps just fine and zoom to any level on them. No amount of clicking/hiding the maps using the map bar at the bottom of the screen show the maps. Only a zoom allows them to be seen. This problem of disappearing maps happens all over the country at different zoom levels.
+
Answer: OpenGL is turned off. Without OpenGL, OpenCPN will not quilt Mercator and Transverse Mercator charts together. Try enabling OpenGL with Options (wrench tool icon)> Display> Advanced. Click on the box between “Graphics” and “Use Accelerated Graphics (OpenGL)” to put a checkmark in the box.
+
When OpenGL is enabled, OpenCPN will quilt Mercator and Transverse Mercator charts (and some other projections).
+
If “Texture Compression with Caching” is enabled under “OpenGL Options” there will be a delay before each chart is displayed for the first time. Subsequent display of the charts in the cache will be faster.
+

+ +

Whenever a specific chart is opened, OpenCPN crashes. What's going on?

Chances are the chart file is corrupted.
+
Note the name and number of the suspect chart and replace it with a fresh download.
+
Read the log file that may contain relevant information regarding the chart.
+
Sometimes the bad chart blocks OpenCPN from restarting.
+
Follow these instructions instead Troubleshoot Installation
+

+ +

What are all those 'U' s or '*' astericks in triangle all over my Vector Charts?

+ +

+Most users just want to get rid of the triangles, but please refer to the Quality of Data Documentation. +

In Options > Charts > Vector Charts Tab when using Display Category “All”, Uncheck “Chart Information Objects” which hides the “U” symbols .
+
In Options > Charts > Vector Charts Tab for a finer grain control when using Display Category “Mariners Standard”, In the selection List Box, Uncheck “Quality of Data” which hides the “U” symbols.
+

+ +

What are those acronyms on the charts?

+ +

+To learn the acronyms used in this application search the S57 'Object and Attribute' catalog at: http://www.s-57.com/
+ +Also, when viewing ENC charts: +

“U's” show up all over the charts
+
Text detail seems to be missing ..like bouy identification ..Bridge names and clearances etc…
+
Depth sounding seem to disappear zooming in and out.
+

+ +

+Hit Text: The A+ button. To show text. +

+ +

How to remove those pink crosses (isolated anger symbology)?

+ +

+This isolated danger symbology is a part of the new ENC S57 presentation standard which OpenCPN complies with, get used to it. +OR +You can try to cover them with your depth setting. Look at the manual Vector Display Tab > Shallow, Safety & Deep Depths +Safety Contour”, where you will find an example of just how depth is taken into account when displaying the magenta cross. +

Safety Depth = 2 meters almost of the pink crosses are covered, but not those in depths 2-5m.
+
Safety Depth = 10 meters all pink crosses are covered and you have lost your pink friends.
+

+ +

Kap files are no longer displayed correctly. Why?

Old versions of OpenCPN were correcting broken KAPs on the fly. (They work on 3.2 but not on any 4. release ) The new ones don't do it anymore as the number of damaged charts circulating around decreased significantly and we gained some extra performance during chart loading. Refer to these sections of the User Documentation too.
+
To fix your charts, run bdbfix on them.
+

+ +

What causes spurious waypoints which must be deleted?

Condition: Multitude of repeated waypoints, which get copied when a waypoint is dragged. Sometimes a route WP is shifted, two routes are made, one with the name, the other unnamed.
+
Possible Solutions: Determine if the addition of waypoints are from inadvertantly hitting the wrong keys on the keyboard, or the mouse.
+
The other possiblity is that the navobj change file is corrupted. Close O and try to delete the change file In W8.1 it is found in C:\ProgramData\opencpn/navobj.xml.changes. Normally, after that O will work again.
+

+ +

Can I use my Seaclear wci or OziCharts?

+ +

+See Use-seaclear-wci-charts and Oziexplorer to Opencpn +Also see Not supported formats that can be converted and Map2Kap and WCI Charts +

+ +

Can I import SeaClear routes and waypoints into OpenCPN?

Yes. I had originally created and maintained all my routes and waypoints in SeaClear, exported them, loaded them into GPS Utility (for Windows) and saved them as text files.
+
To import into OpenCPN I opened all my text files (routes and waypoints) with GPSUtility, saved that out as one big gpx file, and loaded it into OpenCPN. Works like a champ.
+
I've edited them and saved them back out as GPX files with no trouble.
+
Individual routes can be edited and saved in appropriately named GPX files.
+

+ +

How to synchronize Routes, Waypoints & Marks with another computer?

+ +

+Three ways to synchronize: +

From the Route & Mark Manager > Route Tab, select “Export all visible” or highlight select routes and “Export Selected” to a gpx folder. Then use saved gpx file to import the Routes to another computer. For Marks pick the Waypoint Tab, select “Export all visible” or highlight select waypoints and “Export selected” to a gpx folder. Then import waypoints from the other computer.
+
Copy the navobj.xml file to the second computer's navobj.xml file, which will overwrite your routes and marks on that computer. If you are connected via a network you can make a batch file to do this.
+
To copy all waypoints or routes, make a copy & rename the navobject.xml file to .gpx file and import the waypoints, routes and/or tracks. This does all waypoints/routes/tracks at once.
+

+ +

+The navobj.xml file resides in the same folder as the opencpn.ini settings file, under the OpenCPN User folder. For windows this is usually “C:\programdata\opencpn\”. +The navobject.xml file is in in fact a .gpx file containing all waypoints/routes/tracks. +See Navigation Data Backup for more information. +

+ +

Jumping GPS!

+ +

+GPS AIVDO Boat Position is Jumping many miles away. +

See this entire thread. http://www.cruisersforum.com/forums/f134/opencpn-jumping-map-194531.html#post2535508 You will need to use OpenCPN NmeaData Window and a Free nmea decoders and a program like Notepad++ to figure out what the offending sentences are.
+
Remember that “The NMEA standard uses two primary sentences to for AIS data !AIVDM (Received Data from other vessels) and !AIVDO (Your own vessels information)” AIS - Automatic Identification System - Information
+
Problem may be from having two different Own Ship position signals at the same priority, with the additional problem that AIVDO sentences position, sog & cog are just wrong. 1. First disable all but one GPS signal. (Disconnect or turn off.) 2. Stop sending AIVDO (Use either hardware or software settings.) 3. Filter out all AIVDO messages completely. See the User Manual > Connections > Filters put “AIVDO” in the Input filtering line.
+

+ +

Charts jump while Using Follow Ship Offset, Look Ahead & North up Modes

+ +

+Chart Rotation Smoothing. When follow ship, offset mode, look ahead mode and north up mode are all turned on, the goal of the look ahead is to position the ship about 2/3 away from the farthest point directly ahead of the ship. Because the screen is a rectangle, the ship's position on the screen keeps changing, since the farthest point ahead is changing rapidly. Use Options > Display > Advanced Chart Rotation Averaging Time [new title] or Course-up Update Period _Time [old title] to smooth the chart rotation. It is actually another “always on” COG filter that smooths VP rotation and makes the chart much less jumpy. In conjunction with NMEA course and speed filtering the chart moves slowly in a nice way. +

Under Options > Display > Advanced see Chart Rotation Averaging Time
+
and for more about Display Orientation -Look Ahead and Course up
+

+ +

AIS Targets HDG and COG may be wildly different

+ +

+The TRUE Heading reported in the target query is always as actually reported by the target. We do not apply variation to that value before presentation. So, what you see is no error. Of course, in situations with strong cross currents, or maneuvering, the reported HDG and COG may be wildly different. +

+ +

How can a SART Alarm be disabled or ignored?

+ +

+MOB SART has been tested extensively. The methods for deactivation should work. See SART. Also Disable SART When Alert is active, find the Alert's MMSI number in the AIS Target List. Then Add a “New” MMSI number in Options→Ships→MMSI. Then Edit the Options→Ships→MMSI Properties to “ignore” this target. Then close the Options Dialog. Then “Acknowledge” the SART alert one more time, and no further alerts will be seen. If you restart OCPN, you will never get alerts for this target again. +

+ +

How to send routes to GPS via USB or via NMEA Serial connection

+ +

+There are so many GPS models that the answer is a bit complicated. A lot depends on which GPS model you have. OpenCPN can communicate with many GPS receivers via a serial connection. Some GPS receivers have a serial connector that can be wired to a DB-9 serial connector. Newer ones have a USB port that will appear like a serial connection to your computer. Still newer ones appear to your computer like an external drive. +

+ +

+If your GPS receiver shows up as a serial connection on your computer chances are you can upload routes and waypoints directly to it from within OpenCPN. The GPS and OpenCPN have to be set to the same communication protocol. If you normally have them set to NMEA (for updating the OpenCPN chart display with position data from the GPS) you may need to change a Garmin GPS to the GRMN proprietary protocol to upload routes, waypoints, and tracks. If your GPS doesn't show up as a serial connection you may still be able to transfer routes and waypoints to it outside of OpenCPN. If the GPS appears as an external drive on your computer try this. Use OpenCPN to export your routes and waypoints to a GPX file (read the User Manual section on the Route & Mark Manager for more details). Then use your operating system to copy the GPX file from your hard drive to your GPS. If that doesn't work, try GPSBabel or EasyGPS for the transfer. +

+ +

+Depending on your GPS model and the way the route was created in OpenCPN you may wind up with a route on your GPS or just a list of waypoints. The route points may or may not appear as waypoints on the GPS. +

Garmin has a program called Homeport which connects to most of their small GPSmap and Plotters which will upload/download waypoints and routes. I believe it will also import gpx routes.
+
EasyGPS is a free program that allows you to transfer routes, waypoints, and tracks between your Windows computer and your Garmin, Magellan, or Lowrance GPS.
+
GPSBabel is another free program that allows you to transfer data between your computer and your GPS. It runs on Windows, Mac, and Linux operating systems and supports a wide range of GPS models.
+
There are also some helpful notes in the manual.
+
Route & Mark Manager
+
Sending Routes and Waypoints to a GPS
+
The oBabel plugin uses GPSBabel to transfer routes without leaving OpenCPN.
+

+ +

Night time Mode Title bar is too bright in Windows

In Windows, Night, F5, mode. The title bar on the floating plugin window is a bit glaring (this mode is controlled by windows by way of a theme and is not possible to change from an application) .
+
The best solution is to simply “dock” the dashboard window at night, either left or right. This brings the window decorations back under OCPN control, and we recently added logic to dim it in this mode.
+
Dimming the screen, if it is available and goes far enough is often best. F6 General Dimming, in steps, of the entire Screen. (except Mac OS X ). OpenGL must be off.
+
Otherwise the “Change color scheme' F5 button or (C, Ctrl+C, Ctrl+G). This may or may not work on your particular computer.
+
See Keyboard Shortcuts
+
For Linux users, who have little differentiation between shallow water colurs and land colours, try “F.Lux” which has a 2000k setting that makes the screen quite dull over the daytime colour palette. F.lux is confirmed as massive win on Linux. Daytime palette and use F7 to drop the brightness a bit more if needed. https://itsfoss.com/night-shift-flux-ubuntu-linux/
+

+ +

How are fonts adjusted in the User Interface?

See Options > User Interface Fonts and Font Color.
+

+ +

How are fonts adjusted for the AIS Target List?

The AIS Target List does not exist in UI > Options Fonts selection. AIS target list uses the “Dialog” font key in Options > User Interface, Fonts and Font Color..
+

+ +

How are font sizes for vector chart Depth Soundings adjusted?

+ +

+Out of the box, the “Depth” notation is unreadable. +

Try Options > User Interface > Chart Object Scale Slider set on +4 or +5.
+
The Chart Object Scale Slider is for Vector Charts only.
+
Raster Chart cartography is superior and depths are very clear in comparision.
+

+ +

Waypoint Properties Editing Links

Opening the properties page, and adding a link to a JPG-image works fine. If I now edit the link, the image will no longer be displayed.
+
1. The button “Edit” changes state. You click on it to switch the links above to “edit mode”, each click on any of the links opens the dialog allowing you to change it's parameters. After editing the link, you have to click on the button again and then a click on the links will again start opening whatever they link to. What will happen when you click on the link is explained in the text bellow the buttons and changes according to the “Edit button”. If it says “Links are opened in the default browser”, the linked file or internet address should open, given it exists, which gets us to..
  +
+
Similarily, if I export a waypoint with a link to another computer, the link will not open.
+
1. The link is just a link, the file you link to is NOT “included” in the waypoint. When you transfer the waypoints to another computer, for links to local files to keep working, the files you link to would have to exist on the exactly same place on your disk there. Eg. The file that on computer A is C:\MyDocuments\MyPicture.jpg would have to exist with exactly the same file name, in the exactly same folder, on the exactly same disk on computer B.
  +
+

+ +

OpenCPN and Great Circle Navigation

There is a Route Plugin for Great Circles.
+
Raster charts display bearings and headings as straight, measurable lines on the chart. Similarly, Vector ENC's are rendered as Mercator projections in OpenCPN and most other ECS's for the same reason.
+
For typical coastal navigation, errors which occur using rhumb line instead of great circle calculations are small for the distances usually covered by one chart.
+
Mercator Charts and Mercator navigation is the standard for most navigational purposes. Other terms used instead of “Mercator Sailing” is “Loxodrome Sailing” or “Rhumb Line Sailing”.
+

+ +

OpenCPN 3.2.0 forward handles Great Circles directly

Great Circle Routes are explained Great Circle Sailing.
+

+ +

Why aren't settings saved properly when I close Opencpn?

+ +

Not saving settings when exiting -due to Inland ECDIS is checked

+ +

European Inland Waterways ECDIS Mode

+ +

+Issue just started with 4.8.0 where on exit doesn't save * Units * Configuration of toolbar * Starts in night mode I searched the opencpn.ini for these settings but not sure what I am looking for TBH. I also backed up this file and exited the program forming a new ini file, same issue. Any ideas? +

+ +

+OpenCPN is probably set to use settings for Inland ECDIS European Inland Waterways ECDIS +

Click the wrench (or spanner) icon on toolbar to open the “Settings” dialog.
+
Select the “User Interface” tab, and
+
look below the “Interface Options” for
+
“Use Settings for Inland ECDIS Version 2.3”.
+
Remove the checkmark on the “Use … Inland ECDIS…” line.
+

+ +

Right-click > Navigate > To Here has a problem

+ +

+The new Active Route always disappears and I try to recreate it and it disappears again. +

If the distance to waypoint increases slightly then route manager says we have “arrived” and it tries to advance to the next waypoint.
+
But in a simple “Navigate to here” scenario there is no next waypoint so it just assumes it has arrived at the destination.
+
Also this problem may be due to some “noise” from the GPS position.
+
Try setting Options > Ships > Own Ship in the Routes box check “Advance route waypoint on arrival only”.
+

+ +

How exactly does NMEA 0183 HDG Sentence work?

+ +

+If HDG message also contains the variation and E/W flags then O will use that. If not then it will look in RMC message for a variation. If nothing there it will use WMM plugin unless user has selected the variation manually in options. +

+ +

How do I save many waypoints to a Layer?

+ +

+Question: Layers is a good feature, however I need a tool to create a layer with many waypoints (say 200 waypoints in Fiji). I'd like create a layer of all visible waypoints in a chart area that I have zoomed into. After creating the layer, I'd like to delete them from the waypoints list with a single command. +

+ +

+Answer: Using the Route & Mark Manager +

Import the waypoints into the Waypoints Tab.
+
Select all the Waypoints by clicking & highlight the top waypoint, scroll to the bottom and while holding the Shift key, click to highlight all.
+
Wait for all the waypoints to be highlighted.
+
Click on the button “Export selected …”.
+
Browse to choose the directory to save the waypoints, & name the file 'Fiji Waypoints'.
+
Click on 'Save'.
+
All the waypoints will be in one .gpx file which, when put in the Layers folder can be displayed or not in the Layers Tab by toggling the 'eyeball'.
+
You can also use the 'List contents' in the Layers Tab to have the Waypoints displayed in the Waypoints Tab.
+
When done you can clear the Waypoints Tab from the Layers tab by clicking on 'Unlist Contents'.
+
See Handling Layers
+

+ +

+ + +

+ + diff -Nru opencpn-doc-4.8.10129.2/doc/getting_around/chart_info.html opencpn-doc-4.8.2.0/doc/getting_around/chart_info.html --- opencpn-doc-4.8.10129.2/doc/getting_around/chart_info.html 2018-01-30 12:28:30.000000000 +0000 +++ opencpn-doc-4.8.2.0/doc/getting_around/chart_info.html 2018-02-07 14:43:14.000000000 +0000 @@ -1,270 +1,270 @@ - - - - - opencpn:opencpn_user_manual:getting_around:chart_info - - - - - - - - - - - - - - - - - - - - - -

- - - -

Chart Info

- -

-Chart Conversion Manual
- -If you hover the cursor above one of the segments, representing a chart, in the Chart Selection Bar, a chart information box pops up. The chart info refers to the chart in the upper right corner, outlined in red and with pink-ish overlay.
- -
- -
- -
- -The information on a vector chart is similar.
- -
- -
- -For CM93, switch to single chart mode, to see the information.
- -If there seems to be a lot of information missing, it's because the chart has not been viewed in the present session. Get the chart up on the screen, the try again.
- -The Chart Info Box can be inactivated by hiding the Chart Bar. Use Hot keys
- -Ctrl + B to hide/show the Chart Bar. -

- -

What does all the information mean?

- -

-
- -ChartFile: The file on the local computer where the chart is.
- -
- -Name: The Name of the Chart. Not all vector charts have names, while raster charts always have names.
- -
- -Scale: The scale of the chart.
- -
- -ID: The chart number. For raster charts this is the same as the number of the paper chart. Vector chart cells have their own numbering scheme.
- -
- -Depth Units: For raster charts this is the units for the printed soundings. For vector charts this is the sounding units set in Options → Display → Units → Depth.
- -
- -Soundings: The datum for soundings. It is the level that all printed depth figures refers to. Consult a text book on Navigation for details.
- -
- -Datum: The geodetic datum. This will be WGS 84 for all new charts, compiled later than about 1993.
- -If this value is unknown to OpenCPN, or stated as “UNKNOWN”, or the value is missing altogether, OpenCPN will load the chart using WGS84.
- -This is a potential source of errors and far from ideal. The reason is that a number of chart-agencies, at least in the past, failed to state the correct GD value.
- -See below for an example of this kind of chart.
- -
- -If the chart is not using WGS 84, but a named, recognized datum, OpenCPN will automatically add necessary corrections.
- -
- -Projection: OpenCPN accepts Mercator, Transverse Mercator, UTM or Polyconical projections.
- -
- -Source Edition: The Chart Edition.
- -
- -Updated: The date when the chart was released. Expect the chart to be updated to this date, unless otherwise stated.
- -

- -

The OpenCPN Logfile

- -

-The file contains a wealth of information, and should be your first stop if your chart(s) don't load or if there is an error message. -

- -

Chart Accuracy

- -

-First… make sure your GPS is set to output positions using the WGS 84 Geodetic Datum.
- -
- -If you see a warning like the one below:
- -
- -
- -Be careful. The warning means that the charts geographic accuracy is bad. The position of Own Ship may not be correct.
- -A visual warning is that Own Ship turns from Red to Yellow when receiving a gps signal.
- -
- -First is a real scale vector version and then the default OwnShip bitmap
- -
- -
- -There is no quick fix for a bad chart, but try to switch to another chart if using single mode chart display. If quilting is on, right-click on the chart button in the chart-bar and select “Hide this chart”. Both suggestions assumes that the bad chart can be replaced by other charts, which of course isn't always possible.
- -The chart will probably be OK for navigation with traditional methods. Use bearings, vertical or horizontal sextant angles of conspicuous landmarks to confirm your position, as well as soundings or any other available resources. -

- -

Checking a chart for accuracy

- -

-A raster chart, using WGS 84, can easily be checked for the accuracy of the chart grid. This does not necessarily guarantee the position of the individual features on the chart. Refer to Calders book.
- -Activate Options → Display →General → Show Grid. A Latitude and Longitude grid will be displayed as a layer on top of the chart. This grid is OpenCPNs view of how a proper WGS 84 should look like. For raster charts this grid can be compared to the “printed” grid on the chart picture. Chart errors are to complicated to be treated in a few sentences. Refer to Nigel Calders book “How to Read a Nautical Chart” for an in depth but still easy to read text.
- -For a quick check, we are happy with a grid error that is in the region of 1 mm at the chart scale. For a chart in 1:50.000 this means an error of 50 m.
- -
- -Use OpenCPNs ability to grossly over-zoom a chart. Home in on a printed lat/long crossing. Below is a test on a commercial BSB3 chart in 1:60.000. The width of the printed grid - thick black lines - is about 12 m. The thin gray lines is OpenCPNs grid layer. The accuracy of this chart is very good.
- -
- -
- -
- -
- -
- -Another example. This time we are looking at a chart in 1:10.000. Very accurate.
- -
- -
- -
- -This method cannot be used unless the chart is WGS84. For other geodetic datums, expect a difference between the printed grid on a raster chart and OpenCPNs grid. To check for accuracy on this kind of chart find a wellknown object with an established position, for example a major Lighthouse, and compare this position with OpenCPN.
- -
- -Adjusting charts to agree with WGS 84.
- -This is an advanced subject.
- -For CM 93 read CM93 Offsets.
- -BSB/KAP chart can also be adjusted. For example the chart above can be made to agree exactly with the grid. Read the Chart Conversion Manual and make sure to understand imgkap and the kap file format.
- -The work flow to correct any kap chart is: -

Use imgkap to extract the chart picture
-
Copy the text header from the kap chart to a .txt file.
-
Adjust the DTM values in the .txt file
-
Use the imgkap with the picture and the .txt file to produce a new updated kap file.
-
Check for accuracy and go back to #3 if necessary.
-

- -

No Projection -> Chart rejected.

- -

-If the chart does not contain any information about the projection, OpenCPN doesn't know how to display it. Such a chart will not be loaded, but a note about the problem will appear in the log file.
-Missing a chart? Check your OpenCPN logfile. -

- -

No Datum -> —<<< Warning: Chart Datum may be incorrect. >>>—

- -

-The message will be in the Chart Info Box.
-This is a warning that the chart probably is not accurate enough for GPS navigation. It still should be OK with traditional methods. A minimum recommendation is to check the GPS position with traditional methods, a couple of compass bearings, for example.
-
-One example, that unfortunately have lead to problems for a few yachts, is DMA/NGA chart 28201, Puerto Morelos, in Mexico, from 1995. This chart, based on a Mexican survey from 1905, has a Datum Note, similar to this:
-
-
-
-
-
-Comparing 28201 with CM93 that is correct, in this particular case. Note the substantial corrections applied in CM93,
- -

- -

- - -

- - + + + + + opencpn:opencpn_user_manual:getting_around:chart_info + + + + + + + + + + + + + + + + + + + + + +

+ + + +

Chart Info

+ +

+ + +If you hover the cursor above one of the segments, representing a chart, in the Chart Selection Bar, a chart information box pops up. The chart info refers to the chart in the upper right corner, outlined in red and with pink-ish overlay.
+ +
+ +
+ +
+ +The information on a vector chart is similar.
+ +
+ +
+ +For CM93, switch to single chart mode, to see the information.
+ +If there seems to be a lot of information missing, it's because the chart has not been viewed in the present session. Get the chart up on the screen, the try again.
+ +The Chart Info Box can be inactivated by hiding the Chart Bar. Use Hot keys
+ +Ctrl + B to hide/show the Chart Bar. +

+ +

What does all the information mean?

+ +

+
+ +ChartFile: The file on the local computer where the chart is.
+ +
+ +Name: The Name of the Chart. Not all vector charts have names, while raster charts always have names.
+ +
+ +Scale: The scale of the chart.
+ +
+ +ID: The chart number. For raster charts this is the same as the number of the paper chart. Vector chart cells have their own numbering scheme.
+ +
+ +Depth Units: For raster charts this is the units for the printed soundings. For vector charts this is the sounding units set in Options → Display → Units → Depth.
+ +
+ +Soundings: The datum for soundings. It is the level that all printed depth figures refers to. Consult a text book on Navigation for details.
+ +
+ +Datum: The geodetic datum. This will be WGS 84 for all new charts, compiled later than about 1993.
+ +If this value is unknown to OpenCPN, or stated as “UNKNOWN”, or the value is missing altogether, OpenCPN will load the chart using WGS84.
+ +This is a potential source of errors and far from ideal. The reason is that a number of chart-agencies, at least in the past, failed to state the correct GD value.
+ +See below for an example of this kind of chart.
+ +
+ +If the chart is not using WGS 84, but a named, recognized datum, OpenCPN will automatically add necessary corrections.
+ +
+ +Projection: OpenCPN accepts Mercator, Transverse Mercator, UTM or Polyconical projections.
+ +
+ +Source Edition: The Chart Edition.
+ +
+ +Updated: The date when the chart was released. Expect the chart to be updated to this date, unless otherwise stated.
+ +

+ +

The OpenCPN Logfile

+ +

+The file contains a wealth of information, and should be your first stop if your chart(s) don't load or if there is an error message. +

+ +

Chart Accuracy

+ +

+First… make sure your GPS is set to output positions using the WGS 84 Geodetic Datum.
+ +
+ +If you see a warning like the one below:
+ +
+ +
+ +Be careful. The warning means that the charts geographic accuracy is bad. The position of Own Ship may not be correct.
+ +A visual warning is that Own Ship turns from Red to Yellow when receiving a gps signal.
+ +
+ +First is a real scale vector version and then the default OwnShip bitmap
+ +
+ +
+ +There is no quick fix for a bad chart, but try to switch to another chart if using single mode chart display. If quilting is on, right-click on the chart button in the chart-bar and select “Hide this chart”. Both suggestions assumes that the bad chart can be replaced by other charts, which of course isn't always possible.
+ +The chart will probably be OK for navigation with traditional methods. Use bearings, vertical or horizontal sextant angles of conspicuous landmarks to confirm your position, as well as soundings or any other available resources. +

+ +

Checking a chart for accuracy

+ +

+A raster chart, using WGS 84, can easily be checked for the accuracy of the chart grid. This does not necessarily guarantee the position of the individual features on the chart. Refer to Calders book.
+ +Activate Options → Display →General → Show Grid. A Latitude and Longitude grid will be displayed as a layer on top of the chart. This grid is OpenCPNs view of how a proper WGS 84 should look like. For raster charts this grid can be compared to the “printed” grid on the chart picture. Chart errors are to complicated to be treated in a few sentences. Refer to Nigel Calders book “How to Read a Nautical Chart” for an in depth but still easy to read text.
+ +For a quick check, we are happy with a grid error that is in the region of 1 mm at the chart scale. For a chart in 1:50.000 this means an error of 50 m.
+ +
+ +Use OpenCPNs ability to grossly over-zoom a chart. Home in on a printed lat/long crossing. Below is a test on a commercial BSB3 chart in 1:60.000. The width of the printed grid - thick black lines - is about 12 m. The thin gray lines is OpenCPNs grid layer. The accuracy of this chart is very good.
+ +
+ +
+ +
+ +
+ +
+ +Another example. This time we are looking at a chart in 1:10.000. Very accurate.
+ +
+ +
+ +
+ +This method cannot be used unless the chart is WGS84. For other geodetic datums, expect a difference between the printed grid on a raster chart and OpenCPNs grid. To check for accuracy on this kind of chart find a wellknown object with an established position, for example a major Lighthouse, and compare this position with OpenCPN.
+ +
+ +Adjusting charts to agree with WGS 84.
+ +This is an advanced subject.
+ +For CM 93 read CM93 Offsets.
+ + + +The work flow to correct any kap chart is: +

Use imgkap to extract the chart picture
+
Copy the text header from the kap chart to a .txt file.
+
Adjust the DTM values in the .txt file
+
Use the imgkap with the picture and the .txt file to produce a new updated kap file.
+
Check for accuracy and go back to #3 if necessary.
+

+ +

No Projection -> Chart rejected.

+ +

+If the chart does not contain any information about the projection, OpenCPN doesn't know how to display it. Such a chart will not be loaded, but a note about the problem will appear in the log file.
+Missing a chart? Check your OpenCPN logfile. +

+ +

No Datum -> —<<< Warning: Chart Datum may be incorrect. >>>—

+ +

+The message will be in the Chart Info Box.
+This is a warning that the chart probably is not accurate enough for GPS navigation. It still should be OK with traditional methods. A minimum recommendation is to check the GPS position with traditional methods, a couple of compass bearings, for example.
+
+One example, that unfortunately have lead to problems for a few yachts, is DMA/NGA chart 28201, Puerto Morelos, in Mexico, from 1995. This chart, based on a Mexican survey from 1905, has a Datum Note, similar to this:
+
+
+
+
+
+Comparing 28201 with CM93 that is correct, in this particular case. Note the substantial corrections applied in CM93,
+ +

+ +

+ + +

+ + diff -Nru opencpn-doc-4.8.10129.2/doc/getting_around/gps_setup_and_status.html opencpn-doc-4.8.2.0/doc/getting_around/gps_setup_and_status.html --- opencpn-doc-4.8.10129.2/doc/getting_around/gps_setup_and_status.html 2018-01-30 12:28:30.000000000 +0000 +++ opencpn-doc-4.8.2.0/doc/getting_around/gps_setup_and_status.html 2018-02-07 14:43:14.000000000 +0000 @@ -1,175 +1,175 @@ - - - - - opencpn:opencpn_user_manual:getting_around:gps_setup_and_status - - - - - - - - - - - - - - - - - - - - - -

- - - -

GPS Setup & Status

- -

GPS Setup

- -

-
- -Please refer to -

GPS Setup
-
-
Display Orientation
-
-

- -

GPS Status

- -

-The default Ownship icon is rendered as grey if there is no valid gps position fix available and like this when a gps fix is available
- -
- -The GPS status is also indicated all the way to the right along the top of the screen, together with the North Up/ Course Up Indicator, unless this position is covered by the floating ToolBar. The GPS status is then found bottom left.
- -
- -This windows visibility is user settable in Options→User Interface→ Show Compass/GPS Status Window. Short cut “Ctrl-I“
- -

- -

-The GPS Status Icons should be interpreted as follows: -

- -

- No GPS data at all, or position not available. -

- -

- GPS fix, the position is known and received from the GPS. Signal is frequent enough and good for navigation, satellite count is not available in the data feed . -

- -

- Active/Valid GPS data + GPS reporting 1 - 4 satellites. Only if satellite count is available from GPS receiver. -

- -

- Active/Valid GPS data + GPS reporting 5 - 9 satellites. Only if satellite count is available from GPS receiver. -

- -

- Active/Valid GPS data + GPS reporting 10+ satellites. Only if satellite count is available from GPS receiver. -

- -

-Ball: -A Ball could be 1,2 or 3 bars, the number of satellites is unknown because the GSV sentence may be unavailable. There is a good fix, the ball just means we get the position often enough. We know a good GPS fix requires a minimum of 4 satellites to resolve the four unknowns X,Y,Z (spatial) and t (time). That is the minimum and one more satellite is better because it is likely to be more stable. The Ball may be using position data with more than 4 satellites available, but not showing any bars because the sentence is filtered out by your network or multiplex filters. -

- -

-Bars: -The GPS may also send data about the satellite constellations (its name/the PRN, azimuth and elevation for each of the sats). The GSV Sentence contains this information. If your network or multiplex filters the GSV sentences out, the only indicator showing will be the Green Ball. -

If there are many fluctuations in the number of bars, there might be problem with reception but there is no direct relation (such as many satellites = good quality). With more bars it is more probable that the fix is better (however there is no guarantee), and with more satellites the reception is more stable. Bars are interesting to watch in urban & treed environments, but for boating a minor issue in general. The bars are not better than the dot, the only difference really is they show we have data about the number of sats available.
-
In real life, various gps receivers may behave slightly differently, especially when starting up and finding satellites. Five sats with a strong signal can give a better fix than ten at low elevation pinned on the horizon. Some modern designs of GPS chip sets disregard “low quality” sats and rely on few ones with optimal reception. What they will show in the GSV NMEA sentence - all sats in sight or just the ones used varies from manufacturer to manufacturer.
-

- -

-The small dialog, containing the GPS indicator and the Course Up / North Up indicator, can be toggled on/off with the “Ctrl+i” shortcut. -

- -

-The GPS status, including available satellites, is also available as an instrument on the DashBoard. -

- -

-GPS and low accuracy charts. -

- -

-OpenCPN is checking loaded charts for accuracy as far as possible. If there is a problem with a chart, the chart info box that becomes visible when holding the cursor over the chart rectangle in the chart bar, will say ” Warning: Chart georef accuracy is poor.” -

- -

-A visual warning is that Own Ship turns from Red to Yellow when receiving a gps signal. -

- -

-First is a real scale vector version and then. the default OwnShip bitmap -

- -

-There is no quick fix for a bad chart, but try to switch to another chart if using single mode chart display. If quilting is on, right-click on the chart button in the chart-bar and select “Hide this chart”. Both suggestions assumes that the bad chart can be replaced by other charts, which of course isn't always possible. -

- -

- - -

- - + + + + + opencpn:opencpn_user_manual:getting_around:gps_setup_and_status + + + + + + + + + + + + + + + + + + + + + +

+ + + +

GPS Setup & Status

+ +

GPS Setup

+ +

+
+ +Please refer to +

GPS Setup
+
+
Display Orientation
+
+

+ +

GPS Status

+ +

+The default Ownship icon is rendered as grey if there is no valid gps position fix available and like this when a gps fix is available
+ +
+ +The GPS status is also indicated all the way to the right along the top of the screen, together with the North Up/ Course Up Indicator, unless this position is covered by the floating ToolBar. The GPS status is then found bottom left.
+ +
+ +This windows visibility is user settable in Options→User Interface→ Show Compass/GPS Status Window. Short cut “Ctrl-I“
+ +

+ +

+The GPS Status Icons should be interpreted as follows: +

+ +

+ No GPS data at all, or position not available. +

+ +

+ GPS fix, the position is known and received from the GPS. Signal is frequent enough and good for navigation, satellite count is not available in the data feed . +

+ +

+ Active/Valid GPS data + GPS reporting 1 - 4 satellites. Only if satellite count is available from GPS receiver. +

+ +

+ Active/Valid GPS data + GPS reporting 5 - 9 satellites. Only if satellite count is available from GPS receiver. +

+ +

+ Active/Valid GPS data + GPS reporting 10+ satellites. Only if satellite count is available from GPS receiver. +

+ +

+Ball: +A Ball could be 1,2 or 3 bars, the number of satellites is unknown because the GSV sentence may be unavailable. There is a good fix, the ball just means we get the position often enough. We know a good GPS fix requires a minimum of 4 satellites to resolve the four unknowns X,Y,Z (spatial) and t (time). That is the minimum and one more satellite is better because it is likely to be more stable. The Ball may be using position data with more than 4 satellites available, but not showing any bars because the sentence is filtered out by your network or multiplex filters. +

+ +

+Bars: +The GPS may also send data about the satellite constellations (its name/the PRN, azimuth and elevation for each of the sats). The GSV Sentence contains this information. If your network or multiplex filters the GSV sentences out, the only indicator showing will be the Green Ball. +

If there are many fluctuations in the number of bars, there might be problem with reception but there is no direct relation (such as many satellites = good quality). With more bars it is more probable that the fix is better (however there is no guarantee), and with more satellites the reception is more stable. Bars are interesting to watch in urban & treed environments, but for boating a minor issue in general. The bars are not better than the dot, the only difference really is they show we have data about the number of sats available.
+
In real life, various gps receivers may behave slightly differently, especially when starting up and finding satellites. Five sats with a strong signal can give a better fix than ten at low elevation pinned on the horizon. Some modern designs of GPS chip sets disregard “low quality” sats and rely on few ones with optimal reception. What they will show in the GSV NMEA sentence - all sats in sight or just the ones used varies from manufacturer to manufacturer.
+

+ +

+The small dialog, containing the GPS indicator and the Course Up / North Up indicator, can be toggled on/off with the “Ctrl+i” shortcut. +

+ +

+The GPS status, including available satellites, is also available as an instrument on the DashBoard. +

+ +

+GPS and low accuracy charts. +

+ +

+OpenCPN is checking loaded charts for accuracy as far as possible. If there is a problem with a chart, the chart info box that becomes visible when holding the cursor over the chart rectangle in the chart bar, will say ” Warning: Chart georef accuracy is poor.” +

+ +

+A visual warning is that Own Ship turns from Red to Yellow when receiving a gps signal. +

+ +

+First is a real scale vector version and then. the default OwnShip bitmap +

+ +

+There is no quick fix for a bad chart, but try to switch to another chart if using single mode chart display. If quilting is on, right-click on the chart button in the chart-bar and select “Hide this chart”. Both suggestions assumes that the bad chart can be replaced by other charts, which of course isn't always possible. +

+ +

+ + +

+ + diff -Nru opencpn-doc-4.8.10129.2/doc/getting_started/chart_installation.html opencpn-doc-4.8.2.0/doc/getting_started/chart_installation.html --- opencpn-doc-4.8.10129.2/doc/getting_started/chart_installation.html 2018-01-30 12:28:30.000000000 +0000 +++ opencpn-doc-4.8.2.0/doc/getting_started/chart_installation.html 2018-02-07 14:43:14.000000000 +0000 @@ -1,114 +1,110 @@ - - - - - opencpn:opencpn_user_manual:getting_started:chart_installation - - - - - - - - - - - - - - - - - - - - - -

- - - -

Chart Installation

- -

Several steps suggested to obtain & setup charts.

- -

-For first time users we suggest you use the Chart Downloader Tab which helps to find and download free charts and is included with the installation of OpenCPN 4.2. If you choose to manually load charts please pay close attention to the following: -

- -

-Know the path to the the “Chart” directory. Make note of the Charts Folder path you selected. -

- -

-If you choose to manually download charts, be sure uncompress and install them in your Charts directory -

- -

Charts Overview

- -

-OpenCPN itself does not come with charts.
- -Charts are a complex subject. Having accurate and current charts is important for safe navigation.
- -There are a number of resources on this website and others to obtain charts.
- -However the USA provides free NOAA Charts and many other countries do as well. See Chart Sources below. -

Charts Main resource for Charts.
-
Chart Files Tab OpenCPN does not come with charts. Description of how to Install Charts.
-
Chart Downloader Tab Chart Downloader provides an easy way to download and install free NOAA and RNC and ENC charts around the world. It is the easiest way to get started with charts. Download a few charts in your area and use them to learn, then later add more as needed. NOTE: Free charts are not assured everywhere.
-
Chart Sources Extensive list of free charts available, mostly covered by Chart Downloader Plugin
-
Chart Formats See why this is a complex subject
-
Chart Manual Install Download & install yourself
-
NOAA's Chart Download website
-
High Resolution Background Map GSHHS Hi Res (230mb) Use with Watchdog Landfall alarms.
-
Background Map (GSHHS Low Res) - Installed, used by Opencpn for the initial rough background map.
-

- -

- - -

- - + + + + + opencpn:opencpn_user_manual:getting_started:chart_installation + + + + + + + + + + + + + + + + + + + + + +

+ + + +

Chart Installation

+ +

Several steps suggested to obtain & setup charts.

+ +

+For first time users we suggest you use the Chart Downloader Tab which helps to find and download free charts and is included with the installation of OpenCPN 4.2. If you choose to manually load charts please pay close attention to the following: +

+ +

+Know the path to the the “Chart” directory. Make note of the Charts Folder path you selected. +

+ +

+If you choose to manually download charts, be sure uncompress and install them in your Charts directory +

+ +

Charts Overview

+ +

+OpenCPN itself does not come with charts.
+ +Charts are a complex subject. Having accurate and current charts is important for safe navigation.
+ +There are a number of resources on this website and others to obtain charts.
+ +However the USA provides free NOAA Charts and many other countries do as well. See Chart Sources below. +

Charts Main resource for Charts.
+
Chart Files Tab OpenCPN does not come with charts. Description of how to Install Charts.
+
Chart Downloader Tab Chart Downloader provides an easy way to download and install free NOAA and RNC and ENC charts around the world. It is the easiest way to get started with charts. Download a few charts in your area and use them to learn, then later add more as needed. NOTE: Free charts are not assured everywhere.
+
Chart Formats See why this is a complex subject
+
Chart Manual Install Download & install yourself
+
NOAA's Chart Download website
+
Background Map (GSHHS Low Res) - Installed, used by Opencpn for the initial rough background map.
+

+ +

+ + +

+ + diff -Nru opencpn-doc-4.8.10129.2/doc/getting_started/gps_setup.html opencpn-doc-4.8.2.0/doc/getting_started/gps_setup.html --- opencpn-doc-4.8.10129.2/doc/getting_started/gps_setup.html 2018-01-30 12:28:30.000000000 +0000 +++ opencpn-doc-4.8.2.0/doc/getting_started/gps_setup.html 2018-02-07 14:43:14.000000000 +0000 @@ -1,626 +1,620 @@ - - - - - opencpn:opencpn_user_manual:getting_started:gps_setup - - - - - - - - - - - - - - - - - - - - - -

- - - -

GPS Setup

- -

-Below we describe only the basics of getting a gps up and running.
- -

- -

-For a full description of all options read Options Setting
- -
- -Make sure your GPS is not being used by some other program!!!! -Only one program can at one time use the connection. when your GPS program is using the GPS, Opencpn will not be able to do the same. Please quit all other programs using the same connection. -

- -

-Make sure your GPS is set to output positions using the WGS 84 Geodetic Datum. This is less of an issue nowadays, compared to, say 10 - 15 years ago.
- -Some units can't be changed, and is permanently set to WGS 84. The BU-353 is one of those. -

- -

-Matrix of GPS Devices
- -Matrix of GPS Devices
- -

- -

-Refer to GPS Setup & Status -

- -

Windows 10

- -

-Windows 10 users generally must purchase a new GPS Puck specifically configured for Windows 10. For Example, the BU-353 which works with earlier versions of Windows does not work without an elaborate work around involving preventing automatic update of Prolific USB drivers by the OS. It is far easier and more reliable to simply purchase another Windows 10 compatible GPS Puck (similar to the BU-353 S4) and use the associated drivers.
- -
- -This Windows 8 Microsolft GNSS drive has been found to be helpful. (Also described more completely below.) -

- -

Windows XP/Vista/7/8

- -

-Note that the extensive use of the cheap gps mouse BU-353 as an example below, should only be seen as an illustration. -
- -To use OpenCPN with a GPS, a GPS receiver is needed. -

- -

-There are a variety of possible choices for a GPS receiver: -

A computer, such as a Sony Vaio P has a built in GPS receiver
-
A NMEA Expander to amplify a nmea stream to multiple listeners
-
A hand-held GPS receiver
-
A dedicated GPS receiver
-

- -

-The remainder of this section describes using OpenCPN with a dedicated GPS receiver, however, the instructions for a dedicated receiver will be similar for any serial/USB connected NMEA data stream. -

- -

A Dedicated GPS Receiver

- -

-There are several companies making dedicated GPS receivers. The Supplementary Hardware section for GPS devices lists several manufacturers. -

- -

-NMEA has traditionally been implemented as a serial protocol and therefore, even if a USB connection is used, there needs to be a USB to Serial Port conversion. The specific driver for the each GPS receiver will handle this conversion. -

- -

An Example - Configuring BU-353

- -

-It is not necessary to use the installation disk to setup the BU-353. Following the steps listed below will result in the latest driver being installed. -

Download the latest driver from Prolific - http://www.usglobalsat.com/s-24-support-drivers.aspx#A
-
Unzip and install the driver
-
Plug in the BU-353.
-
Start → (Right Click) My Computer → Properties → Hardware →Device Manager
-or Start→Run devmgmt.msc
-
Expand Ports
-
Look for the “Prolific USB-to-Serial Comm Port” and note the com port number (e.g., COM4)
-

- -

Right click on the “Prolific USB-to-Serial Comm Port”. Choose Driver
-
Select 4800 bits per second, 8 data bits, None parity, 1 stop bit, and None for Flow Control
-

- -

Start OpenCPN
-
Click on the Options Icon
-
Select “Connections”, and “Add Connection” and “Serial”
-
Under “Data Port” select the Com port noted in #6
-
Choose OK
-
Select Auto Follow to center the map over your GPS location
-

- -

Troubleshooting

- -

-There is a small LED located on the BU-353. If the LED is off there is no power being received. Check the connection. -

- -

-If the LED is solid it indicates the BU-353 is searching for a GPS signal. Try moving the GPS receiver to a clear location. -

- -

-If the LED is flashing it indicates the BU-353 has a position fix and is transmitting data. -

Try viewing the NMEA data stream in OpenCPN. Choose Options→Connections→Show NMEA Debug Window
-
Alternatively, a diagnostic program is included on the installation CD called GPSInfo.exe. Launch this program to install the diagnostic utility.
-

- -

-If it appears that the NMEA data stream is being received, the most likely issue is that OpenCPN is not centered over your location. Click AutoFollow to center the map at your GPS location. -

- -

Known Issues

- -

-If you change the USB port for the GPS receiver Prolific will reassign the COM port number. This will require repeating steps 4-12 above. If you are having trouble with Prolific drivers and an Error Code, try reading this page http://www.ifamilysoftware.com/news37.html -

- -

-On some computer / GPS receiver combinations when the computer resumes from Stand By the GPS receiver will no longer transmit its NMEA data stream, and only garbage instead of ASCII characters will be visible in the NMEA Data Stream Window. The red indicator led will not work.
-
-To change back to NMEA mode search for and download SIRFDemo.exe.
-Unpack and start. Set correct Baud rate and and com port as above.
-Click connect to data source button. Action → Switch to NMEA protocol, then exit.
-There are many more settings available in SIRFDemo.exe -

- -

-An alternative workaround for this issue is provided by using a COM port splitter such as XPort http://www.curioustech.net/xport.html -

Download XPort.
-
Unzip it to a folder of your choice
-
Double Click XPort.exe
-
Set the Baud Rate to 4800
-
Under Enable Ports add an entry for COM10
-
Click “Find GPS”. The port returned should match the port identified in Step #6 in the Configuring BU-353 Section
-
Select Prolific USB-to-Serial Comm Port in the check box section
-
Return to OpenCPN
-
Click on the ToolBox Icon
-
Select GPS
-

- -

-Under NMEA Data Source change the Com port to COM10 -

- -

How to use OpenCPN on a tablet windows 8 with GNSS Sensor

- -

-http://www.cruisersforum.com/forums/showthread.php?p=1341714
- -A small application that enables windows 8 tablets (or notebooks with GNSS sensor) to use OpenCPN. Tested and GNSS sensor seems to be able to pick up the signal quite well. See the details here: https://bitbucket.org/petrsimon/geol...ntcp/wiki/Home
- -Also refer to Win8 GNSS Sensor
- -

- -

Linux

- -

-To proceed, the “user” you use on your computer must belong to a group that is allowed to open serial connections. This group is normally “dialout” on Debian based Linuxes, including Ubuntu, and “uucp” on Red Hat based distributions. Read more in Connections for Linux.
-Check your status by writing “groups” on a command line. The response will be all groups that the user belongs to. Make sure that “dialout” or “uucp” is included. If not, you have to add your user to this group. There are many ways to do this, one is to issue this command:
-“sudo usermod -a -G dialout $USER”. Logout of your current session for group changes to take effect.
-This applies to many Debian based distributions, for other distros just drop the sudo and do the command as root, using “su”.
-All major Linux distribution includes a graphical user settings dialog, where adding a user to a group, could be fixed. -

- -

Two methods are available, direct connection or through gpsd.

- -

We start with gpsd.

Install the gpsd and gpsd-clients packages
-

      
-$ sudo apt-get install gpsd gpsd-clients

Go to Options→ Connections→ Add Connection and select “Network” plus the GPSD radio button. Address should be “localhost” and DataPorts should be set to 2947.
-
On Ubuntu 10.04 and later, that is really all you have to do. When you plug in your gps this will trigger gpsd to start.
-
“xgps” is client that comes with the gpsd-clients package, and is useful for testing that the gps and gpsd is working properly. If xgps isn't working, it's a gps or gpsd problem, not an OpenCPN problem
-

- -

Direct connection.

Make sure that gpsd isn't running then connect your gps and start OpenCPN. On Ubuntu 12.04 the easiest way to achieve this is to uninstall gpsd.
-
In the Options→Connections → Add Connection, select “Serial”.Set “dataPort to the port where you plugged in your gps. If you plugged in BU 353 this will probably be /dev/ttyUSB0.
-
Choose 4800 baud, unless you know that the gps is set to something else.
-
The gps should now work…if not, check the NMEA data stream window. If only binary garbage is visible, the gps has to be reset to NMEA mode, see more about this above in windows section. An alternative is to use gpsd, that will work with the gps in Sirf mode.
-
To do this in Linux for BU 353 as well as many other gps:es, make sure that gpsd is running and that the package “gpsd-clients” is installed. On Ubuntu 12.04 gpsd needs to be temporarily installed. Make sure to kill any instances of gpsd with the command:
-

 "sudo killall gpsd"

This command will put the GPS into NMEA mode.
-

  * $gpsctl -n

If that doesn't work, try
-

$ gpsctl -f -n /dev/ttyUSB0

This will force a low-level access, bypassing gpsd. For more information: $man gpsctl
-
More information is as always available through “man gpsctl” Close down OpenCPN before running gpsctl.
-
-None of this is normally noticed when using gpsd, as this program reads both NMEA and SIRF binary sentences.
-

- -

More Linux hints

If you can't connect to a physical port, such as /dev/ttyUSBO, indicated by a line in the opencpn.log file. Check that you, as a user, belong to the group “dialout”. To see which groups you belong to, run the command “groups”. Not all Linux distributions add the user to this group by default. To add yourself to the dialout group
-

"sudo usermod -a -G dialout $USER"

Check if gpsd is working:
-

$ ps aux | grep gpsd
-nobody 12338 0.3 0.1 4124 1448 ? S<s 18:31 0:00 gpsd -F /var/run/gpsd.sock 
-you 12356 0.0 0.0 3036 800 pts/3 S+ 18:32 0:00 grep –color=tty -d skip gpsd

This or similar responses indicate that gpsd is running. If you only have something like the second line,…it is not running.
-
Run the command
-

"$ls -lrtd /dev/*|tail -10"

and see the 10 latest created device files. Run this just after plugin in your gps to see which device was created.
-
Determine which device your GPS is on your linux system by checking the startup. Look for a line that says something about GPS and /dev/ttyUSB# in the command “dmesg”
-
Or even better, after connecting a gps mouse, BU-353, we look for a dmesg by running this command.
-

$ dmesg | grep tty
-and get this response back.
-[13616.095305] usb 2-3: pl2303 converter now attached to ttyUSB0

Add a script to start gpsd, if this is not done by your distribution. I saved mine as startgps and set the executable attribute. Edit line 3 to match your device, ie /dev/ttyUSB0
-

#!/bin/sh
- sudo killall gpsd
- sudo gpsd -n -D 2 /dev/ttyUSB0

Run the script:
-

$ ./startgps

- -

-If this is a new installation, click on the Toolbox icon and configure your GPS source, chart directories, and other settings. -

- -

Other Distributions

Install gpsd from source. More information is available here: http://catb.org/gpsd/
-

- -

Udev Rules

If you have problem with, for example gps, connecting to different ports each time you restart udev is your friend.
-
udev supports persistent device naming, which does not depend on, for example, the order in which the devices are plugged into the system. The default udev setup provides persistent names for storage devices.
-
There is a lot about udev on the Internet. For OpenCPN specifics, read the cruisersforum.
-

- -

Bluetooth GPS

- -

-More user experience of setting up bluetooth GPS are welcome, as the notes below just reflects a few users experience. Please use the Forum. -

- -

Ubuntu 10.10 and older.

- -

-If you have a bluetooth GPS you will need to first configure it through the standard Ubuntu Bluetooth “set up new device ” proceedure. Once you have done that you will need to find what the address of the GPS is. To do that you run this command: -

"sudo hcitool scan"

- -

-it will then start looking for the Bluetooth GPS and hopefully find your GPS. You should see something similar to: -

Scanning …
-00:1C:88:10:D3:4D    iBT-GPS

- -

-In this case I have a IBT-GPS at address 00:1C:88:10:D3:4D (Your GPS address will be different) -

- -

-Next we have to bind the GPS address to a “virtual” device OpenCPN understands in this case rfcomm0. We do this with the following command: -

sudo rfcomm bind /dev/rfcomm0 00:1C:88:10:D3:4D

- -

-Note put your GPS address in this line -You should not have to run these commands each time your linux is restarted as it will remember your GPS address. -

- -

-Now all you need to do is go into OpenCPN Toolbox and select GPS. -Now in the NMEA Data Source options select from the pulldown menu: -“/dev/rfcomm0”, or write it in the box, if not present as an alternative. -

- -

-That's it - you should now have a Bluetooth GPS Connected. -

- -

-Ubuntu 12.04 -

- -

--Pair GPS with bluetooth icon --break connection with bluetooth icon --get device id: sudo hcitool scan --get channel for gps: sdptool records 00:02:78:0A:4E:E9 (put your actual number here) --sudo gedit /etc/bluetooth/rfcomm.conf #edit rfcomm input file. Text should be: -

# RFCOMM configuration file.
-#
-# $Id: rfcomm.conf,v 1.1 2002/10/07 05:58:18 maxk Exp $
-# rfcomm0 {
-# Automatically bind the device at startup
-bind yes;

- -

-' -

# Bluetooth address of the device
-device xx:xx:xx:xx:xx:xx;

- -

-' -

# RFCOMM channel for the connection
-channel 1;#use channel number as provided by sdptool records XX:XX:XX:XX:XX:XX

- -

-' -

# Description of the connection
-comment "Your GPS Device Here";
-}

- -

-' -

sudo rfcomm release 0 (not strictly neccesary)

- -

-. -

sudo rfcomm connect 0

- -

-You only need to to this once, not required if you reboot at this point). -

…connected /dev/rfcomm0 to 00:00:00:00:00:00 (whatever) 
-Press CTRL-C for hangup

- -

-in a separate terminal, you can test the connection with -

rfcomm show /dev/rfcomm0 
-…rfcomm0: 00:08:1B:14:18:B6 channel 1 connected [tty-attached]

- -

-Your bluetooth GPS should now be working in open CPN. -Run -

sudo opencpn

- -

-To check that it works (/dev/rfcomm0 under GPS NMEA data source). If it works, try running opencpn without sudo, chances are that you cannot see the gps. if this is the case, use the following fix: -

sudo usermod -a -G dialout $USER ''

- -

Fedora

- -

-Run -

hcitool scan

- -

-to get the ID of your bluetooth gps device. -Make a file “rfcomm.config” and put it in /etc/bluetooth. -

- -

-This file is already present in Ubuntu, but needs editing for persistent connection. -

# RFCOMM configuration file. 
-# 
-# $Id: rfcomm.conf,v 1.1 2002/10/07 05:58:18 maxk Exp $ 
-# 
-rfcomm0 { 
-# Automatically bind the device at startup 
-bind yes; 
-# Bluetooth address of the device 
-device XX:XX:XX:XX:XX:XX; 
-# RFCOMM channel for the connection 
-channel 1; 
-# Description of the connection 
-comment "Your GPS Device Here"; 
-}

- -

-Change XX:XX:XX…. to your device ID -Open Opencpn and write /dev/rfcomm0 as GPS NMEA device. Note that you can add it yourself by writing directly into the scroll down box. -Permissions for /dev/rfcomm0 are for group “dialout”. Make sure you belong to that group. -The command “groups” will show all the groups you belong to. -Make sure that “gpsd” isn't running, issuing “killall gpsd” as root. -

- -

Mac OSX

- -

-Attaching a GPS device to a Mac is done via one of the USB ports. Whether using a device with its own USB lead or via a serial-USB adapter lead or an NMEA multiplexer with USB port, the appropriate OS X driver needs to be installed. Nearly all hardware uses one of just two chip makes: those from FTDI or Prolific. Both those companies make OS X drivers available on their web sites, but manufacturers of GPS devices usually package the driver with device. -

- -

-When the driver is installed and the device connected, start OpenCPN, select the Toolbox and click the GPS tab. Open the “NMEA Data Source” menu & select the the device from the list. It is not always obvious which is the correct one, but in general the device will have a name starting: ”/dev/cu.“ or ”/dev/tty.“. Some manufacturers make it obvious, like ”/dev/cu.MiniPlex-99000125“, but others may be more generic, like: ”/dev/cu.usbserial“. Set the “NMEA Baud Rate” to 4800 and click “OK”. If the correct selection has been made, you should see the GPS status icon change from red to green. -

- -

Virtualized Environments

- -

-Use of Virtualized Environments such as Parallels, VM, VirtualBox, etc to run an alternative version of Opencpn on your Mac or PC are beyond the scope of this section. However experienced users are invited to report the specifics about using USB ports with Virtual Configurations. Please be specific about the setup and software and explain how virtual USB ports work in that environment. These commenta will eventually make their way into this section. -

- -

-It should be noted that each Virtual Software handles virtualization of USB and Sharing differently. This can affect the connection and reliability of the connection for GPS. -

- -

-OpenCPN is user powered, so we depend on User's sharing their experiences. Please assist us. -

- -

- - -

- - + + + + + opencpn:opencpn_user_manual:getting_started:gps_setup + + + + + + + + + + + + + + + + + + + + + +

+ + + +

GPS Setup

+ +

+Below we describe only the basics of getting a gps up and running.
+ +

+ +

+For a full description of all options read Options Setting
+ +
+ +Make sure your GPS is not being used by some other program!!!! +Only one program can at one time use the connection. when your GPS program is using the GPS, Opencpn will not be able to do the same. Please quit all other programs using the same connection. +

+ +

+Make sure your GPS is set to output positions using the WGS 84 Geodetic Datum. This is less of an issue nowadays, compared to, say 10 - 15 years ago.
+ +Some units can't be changed, and is permanently set to WGS 84. The BU-353 is one of those. +

+ + +

+Refer to GPS Setup & Status +

+ +

Windows 10

+ +

+Windows 10 users generally must purchase a new GPS Puck specifically configured for Windows 10. For Example, the BU-353 which works with earlier versions of Windows does not work without an elaborate work around involving preventing automatic update of Prolific USB drivers by the OS. It is far easier and more reliable to simply purchase another Windows 10 compatible GPS Puck (similar to the BU-353 S4) and use the associated drivers.
+ +
+ + +

+ +

Windows XP/Vista/7/8

+ +

+Note that the extensive use of the cheap gps mouse BU-353 as an example below, should only be seen as an illustration. +
+ +To use OpenCPN with a GPS, a GPS receiver is needed. +

+ +

+There are a variety of possible choices for a GPS receiver: +

A computer, such as a Sony Vaio P has a built in GPS receiver
+
A NMEA Expander to amplify a nmea stream to multiple listeners
+
A hand-held GPS receiver
+
A dedicated GPS receiver
+

+ +

+The remainder of this section describes using OpenCPN with a dedicated GPS receiver, however, the instructions for a dedicated receiver will be similar for any serial/USB connected NMEA data stream. +

+ +

A Dedicated GPS Receiver

+ +

+There are several companies making dedicated GPS receivers. The Supplementary Hardware section for GPS devices lists several manufacturers. +

+ +

+NMEA has traditionally been implemented as a serial protocol and therefore, even if a USB connection is used, there needs to be a USB to Serial Port conversion. The specific driver for the each GPS receiver will handle this conversion. +

+ +

An Example - Configuring BU-353

+ +

+It is not necessary to use the installation disk to setup the BU-353. Following the steps listed below will result in the latest driver being installed. +

Download the latest driver from Prolific - http://www.usglobalsat.com/s-24-support-drivers.aspx#A
+
Unzip and install the driver
+
Plug in the BU-353.
+
Start → (Right Click) My Computer → Properties → Hardware →Device Manager
+or Start→Run devmgmt.msc
+
Expand Ports
+
Look for the “Prolific USB-to-Serial Comm Port” and note the com port number (e.g., COM4)
+

+ +

Right click on the “Prolific USB-to-Serial Comm Port”. Choose Driver
+
Select 4800 bits per second, 8 data bits, None parity, 1 stop bit, and None for Flow Control
+

+ +

Start OpenCPN
+
Click on the Options Icon
+
Select “Connections”, and “Add Connection” and “Serial”
+
Under “Data Port” select the Com port noted in #6
+
Choose OK
+
Select Auto Follow to center the map over your GPS location
+

+ +

Troubleshooting

+ +

+There is a small LED located on the BU-353. If the LED is off there is no power being received. Check the connection. +

+ +

+If the LED is solid it indicates the BU-353 is searching for a GPS signal. Try moving the GPS receiver to a clear location. +

+ +

+If the LED is flashing it indicates the BU-353 has a position fix and is transmitting data. +

Try viewing the NMEA data stream in OpenCPN. Choose Options→Connections→Show NMEA Debug Window
+
Alternatively, a diagnostic program is included on the installation CD called GPSInfo.exe. Launch this program to install the diagnostic utility.
+

+ +

+If it appears that the NMEA data stream is being received, the most likely issue is that OpenCPN is not centered over your location. Click AutoFollow to center the map at your GPS location. +

+ +

Known Issues

+ +

+If you change the USB port for the GPS receiver Prolific will reassign the COM port number. This will require repeating steps 4-12 above. If you are having trouble with Prolific drivers and an Error Code, try reading this page http://www.ifamilysoftware.com/news37.html +

+ +

+On some computer / GPS receiver combinations when the computer resumes from Stand By the GPS receiver will no longer transmit its NMEA data stream, and only garbage instead of ASCII characters will be visible in the NMEA Data Stream Window. The red indicator led will not work.
+
+To change back to NMEA mode search for and download SIRFDemo.exe.
+Unpack and start. Set correct Baud rate and and com port as above.
+Click connect to data source button. Action → Switch to NMEA protocol, then exit.
+There are many more settings available in SIRFDemo.exe +

+ +

+An alternative workaround for this issue is provided by using a COM port splitter such as XPort http://www.curioustech.net/xport.html +

Download XPort.
+
Unzip it to a folder of your choice
+
Double Click XPort.exe
+
Set the Baud Rate to 4800
+
Under Enable Ports add an entry for COM10
+
Click “Find GPS”. The port returned should match the port identified in Step #6 in the Configuring BU-353 Section
+
Select Prolific USB-to-Serial Comm Port in the check box section
+
Return to OpenCPN
+
Click on the ToolBox Icon
+
Select GPS
+

+ +

+Under NMEA Data Source change the Com port to COM10 +

+ +

How to use OpenCPN on a tablet windows 8 with GNSS Sensor

+ +

+http://www.cruisersforum.com/forums/showthread.php?p=1341714
+ +A small application that enables windows 8 tablets (or notebooks with GNSS sensor) to use OpenCPN. Tested and GNSS sensor seems to be able to pick up the signal quite well. See the details here: https://bitbucket.org/petrsimon/geol...ntcp/wiki/Home
+ + + +

+ +

Linux

+ +

+To proceed, the “user” you use on your computer must belong to a group that is allowed to open serial connections. This group is normally “dialout” on Debian based Linuxes, including Ubuntu, and “uucp” on Red Hat based distributions. Read more in Connections for Linux.
+Check your status by writing “groups” on a command line. The response will be all groups that the user belongs to. Make sure that “dialout” or “uucp” is included. If not, you have to add your user to this group. There are many ways to do this, one is to issue this command:
+“sudo usermod -a -G dialout $USER”. Logout of your current session for group changes to take effect.
+This applies to many Debian based distributions, for other distros just drop the sudo and do the command as root, using “su”.
+All major Linux distribution includes a graphical user settings dialog, where adding a user to a group, could be fixed. +

+ +

Two methods are available, direct connection or through gpsd.

+ +

We start with gpsd.

Install the gpsd and gpsd-clients packages
+

      
+$ sudo apt-get install gpsd gpsd-clients

Go to Options→ Connections→ Add Connection and select “Network” plus the GPSD radio button. Address should be “localhost” and DataPorts should be set to 2947.
+
On Ubuntu 10.04 and later, that is really all you have to do. When you plug in your gps this will trigger gpsd to start.
+
“xgps” is client that comes with the gpsd-clients package, and is useful for testing that the gps and gpsd is working properly. If xgps isn't working, it's a gps or gpsd problem, not an OpenCPN problem
+

+ +

Direct connection.

Make sure that gpsd isn't running then connect your gps and start OpenCPN. On Ubuntu 12.04 the easiest way to achieve this is to uninstall gpsd.
+
In the Options→Connections → Add Connection, select “Serial”.Set “dataPort to the port where you plugged in your gps. If you plugged in BU 353 this will probably be /dev/ttyUSB0.
+
Choose 4800 baud, unless you know that the gps is set to something else.
+
The gps should now work…if not, check the NMEA data stream window. If only binary garbage is visible, the gps has to be reset to NMEA mode, see more about this above in windows section. An alternative is to use gpsd, that will work with the gps in Sirf mode.
+
To do this in Linux for BU 353 as well as many other gps:es, make sure that gpsd is running and that the package “gpsd-clients” is installed. On Ubuntu 12.04 gpsd needs to be temporarily installed. Make sure to kill any instances of gpsd with the command:
+

 "sudo killall gpsd"

This command will put the GPS into NMEA mode.
+

  * $gpsctl -n

If that doesn't work, try
+

$ gpsctl -f -n /dev/ttyUSB0

This will force a low-level access, bypassing gpsd. For more information: $man gpsctl
+
More information is as always available through “man gpsctl” Close down OpenCPN before running gpsctl.
+
+None of this is normally noticed when using gpsd, as this program reads both NMEA and SIRF binary sentences.
+

+ +

More Linux hints

If you can't connect to a physical port, such as /dev/ttyUSBO, indicated by a line in the opencpn.log file. Check that you, as a user, belong to the group “dialout”. To see which groups you belong to, run the command “groups”. Not all Linux distributions add the user to this group by default. To add yourself to the dialout group
+

"sudo usermod -a -G dialout $USER"

Check if gpsd is working:
+

$ ps aux | grep gpsd
+nobody 12338 0.3 0.1 4124 1448 ? S<s 18:31 0:00 gpsd -F /var/run/gpsd.sock 
+you 12356 0.0 0.0 3036 800 pts/3 S+ 18:32 0:00 grep –color=tty -d skip gpsd

This or similar responses indicate that gpsd is running. If you only have something like the second line,…it is not running.
+
Run the command
+

"$ls -lrtd /dev/*|tail -10"

and see the 10 latest created device files. Run this just after plugin in your gps to see which device was created.
+
Determine which device your GPS is on your linux system by checking the startup. Look for a line that says something about GPS and /dev/ttyUSB# in the command “dmesg”
+
Or even better, after connecting a gps mouse, BU-353, we look for a dmesg by running this command.
+

$ dmesg | grep tty
+and get this response back.
+[13616.095305] usb 2-3: pl2303 converter now attached to ttyUSB0

Add a script to start gpsd, if this is not done by your distribution. I saved mine as startgps and set the executable attribute. Edit line 3 to match your device, ie /dev/ttyUSB0
+

#!/bin/sh
+ sudo killall gpsd
+ sudo gpsd -n -D 2 /dev/ttyUSB0

Run the script:
+

$ ./startgps

+ +

+If this is a new installation, click on the Toolbox icon and configure your GPS source, chart directories, and other settings. +

+ +

Other Distributions

Install gpsd from source. More information is available here: http://catb.org/gpsd/
+

+ +

Udev Rules

If you have problem with, for example gps, connecting to different ports each time you restart udev is your friend.
+
udev supports persistent device naming, which does not depend on, for example, the order in which the devices are plugged into the system. The default udev setup provides persistent names for storage devices.
+
There is a lot about udev on the Internet. For OpenCPN specifics, read the cruisersforum.
+

+ +

Bluetooth GPS

+ +

+More user experience of setting up bluetooth GPS are welcome, as the notes below just reflects a few users experience. Please use the Forum. +

+ +

Ubuntu 10.10 and older.

+ +

+If you have a bluetooth GPS you will need to first configure it through the standard Ubuntu Bluetooth “set up new device ” proceedure. Once you have done that you will need to find what the address of the GPS is. To do that you run this command: +

"sudo hcitool scan"

+ +

+it will then start looking for the Bluetooth GPS and hopefully find your GPS. You should see something similar to: +

Scanning …
+00:1C:88:10:D3:4D    iBT-GPS

+ +

+In this case I have a IBT-GPS at address 00:1C:88:10:D3:4D (Your GPS address will be different) +

+ +

+Next we have to bind the GPS address to a “virtual” device OpenCPN understands in this case rfcomm0. We do this with the following command: +

sudo rfcomm bind /dev/rfcomm0 00:1C:88:10:D3:4D

+ +

+Note put your GPS address in this line +You should not have to run these commands each time your linux is restarted as it will remember your GPS address. +

+ +

+Now all you need to do is go into OpenCPN Toolbox and select GPS. +Now in the NMEA Data Source options select from the pulldown menu: +“/dev/rfcomm0”, or write it in the box, if not present as an alternative. +

+ +

+That's it - you should now have a Bluetooth GPS Connected. +

+ +

+Ubuntu 12.04 +

+ +

+-Pair GPS with bluetooth icon +-break connection with bluetooth icon +-get device id: sudo hcitool scan +-get channel for gps: sdptool records 00:02:78:0A:4E:E9 (put your actual number here) +-sudo gedit /etc/bluetooth/rfcomm.conf #edit rfcomm input file. Text should be: +

# RFCOMM configuration file.
+#
+# $Id: rfcomm.conf,v 1.1 2002/10/07 05:58:18 maxk Exp $
+# rfcomm0 {
+# Automatically bind the device at startup
+bind yes;

+ +

+' +

# Bluetooth address of the device
+device xx:xx:xx:xx:xx:xx;

+ +

+' +

# RFCOMM channel for the connection
+channel 1;#use channel number as provided by sdptool records XX:XX:XX:XX:XX:XX

+ +

+' +

# Description of the connection
+comment "Your GPS Device Here";
+}

+ +

+' +

sudo rfcomm release 0 (not strictly neccesary)

+ +

+. +

sudo rfcomm connect 0

+ +

+You only need to to this once, not required if you reboot at this point). +

…connected /dev/rfcomm0 to 00:00:00:00:00:00 (whatever) 
+Press CTRL-C for hangup

+ +

+in a separate terminal, you can test the connection with +

rfcomm show /dev/rfcomm0 
+…rfcomm0: 00:08:1B:14:18:B6 channel 1 connected [tty-attached]

+ +

+Your bluetooth GPS should now be working in open CPN. +Run +

sudo opencpn

+ +

+To check that it works (/dev/rfcomm0 under GPS NMEA data source). If it works, try running opencpn without sudo, chances are that you cannot see the gps. if this is the case, use the following fix: +

sudo usermod -a -G dialout $USER ''

+ +

Fedora

+ +

+Run +

hcitool scan

+ +

+to get the ID of your bluetooth gps device. +Make a file “rfcomm.config” and put it in /etc/bluetooth. +

+ +

+This file is already present in Ubuntu, but needs editing for persistent connection. +

# RFCOMM configuration file. 
+# 
+# $Id: rfcomm.conf,v 1.1 2002/10/07 05:58:18 maxk Exp $ 
+# 
+rfcomm0 { 
+# Automatically bind the device at startup 
+bind yes; 
+# Bluetooth address of the device 
+device XX:XX:XX:XX:XX:XX; 
+# RFCOMM channel for the connection 
+channel 1; 
+# Description of the connection 
+comment "Your GPS Device Here"; 
+}

+ +

+Change XX:XX:XX…. to your device ID +Open Opencpn and write /dev/rfcomm0 as GPS NMEA device. Note that you can add it yourself by writing directly into the scroll down box. +Permissions for /dev/rfcomm0 are for group “dialout”. Make sure you belong to that group. +The command “groups” will show all the groups you belong to. +Make sure that “gpsd” isn't running, issuing “killall gpsd” as root. +

+ +

Mac OSX

+ +

+Attaching a GPS device to a Mac is done via one of the USB ports. Whether using a device with its own USB lead or via a serial-USB adapter lead or an NMEA multiplexer with USB port, the appropriate OS X driver needs to be installed. Nearly all hardware uses one of just two chip makes: those from FTDI or Prolific. Both those companies make OS X drivers available on their web sites, but manufacturers of GPS devices usually package the driver with device. +

+ +

+When the driver is installed and the device connected, start OpenCPN, select the Toolbox and click the GPS tab. Open the “NMEA Data Source” menu & select the the device from the list. It is not always obvious which is the correct one, but in general the device will have a name starting: ”/dev/cu.“ or ”/dev/tty.“. Some manufacturers make it obvious, like ”/dev/cu.MiniPlex-99000125“, but others may be more generic, like: ”/dev/cu.usbserial“. Set the “NMEA Baud Rate” to 4800 and click “OK”. If the correct selection has been made, you should see the GPS status icon change from red to green. +

+ +

Virtualized Environments

+ +

+Use of Virtualized Environments such as Parallels, VM, VirtualBox, etc to run an alternative version of Opencpn on your Mac or PC are beyond the scope of this section. However experienced users are invited to report the specifics about using USB ports with Virtual Configurations. Please be specific about the setup and software and explain how virtual USB ports work in that environment. These commenta will eventually make their way into this section. +

+ +

+It should be noted that each Virtual Software handles virtualization of USB and Sharing differently. This can affect the connection and reliability of the connection for GPS. +

+ +

+OpenCPN is user powered, so we depend on User's sharing their experiences. Please assist us. +

+ +

+ + +

+ + diff -Nru opencpn-doc-4.8.10129.2/doc/getting_started/opencpn_installation/dedicated_marine_os.html opencpn-doc-4.8.2.0/doc/getting_started/opencpn_installation/dedicated_marine_os.html --- opencpn-doc-4.8.10129.2/doc/getting_started/opencpn_installation/dedicated_marine_os.html 2018-01-30 12:28:30.000000000 +0000 +++ opencpn-doc-4.8.2.0/doc/getting_started/opencpn_installation/dedicated_marine_os.html 2018-02-07 14:43:14.000000000 +0000 @@ -1,99 +1,99 @@ - - - - - opencpn:opencpn_user_manual:getting_started:opencpn_installation:dedicated_marine_os - - - - - - - - - - - - - - - - - - - - - -

- - - -

Dedicated Marine OS

- -

XINUTOP

- -

-Another way to run OpenCPN or test it without installation on your current system is to use a specialized marine OS, which also include essential marine applications. Xinutop is a free an opensource Linux-Debian based solution and can operate on a large variety of x86 processors compliants. Xinutop can run as a live system on USB key. Perform a key is fast and simple, just download and grab the image. It can also be installed on a HDD/SSD, as primary, secondary or rescue OS.
- -
- -More under Supplementary Software Xinutop Marine OS
- -Infos and download at http://marinux.tuxfamily.org
- -See also in Supplementary Software Xinutop Marine OS -

- -

OpenPlotter

- -

The open-source sailing platform for ARM computers

- -

-There are people who buy boats but there are also people who build them, why not build your own electronics too? OpenPlotter is a combination of software and hardware to be used as navigational aid on small and medium boats. It is also a complete home automation system onboard. It works on ARM computers like the Raspberry Pi and is open-source, low-cost and low-consumption. Its design is modular, so you just have to implement what your boat needs. Do it yourself. -

- -

-You will need the basic parts and some optional parts. It will depend on what kind of data you want to collect, process or display and what kind of equipment your boat already has. -

- -

-http://www.sailoog.com/en/openplotter
- -Openplotter Cruisers Forum -

- -

- - -

- - + + + + + opencpn:opencpn_user_manual:getting_started:opencpn_installation:dedicated_marine_os + + + + + + + + + + + + + + + + + + + + + +

+ + + +

Dedicated Marine OS

+ +

XINUTOP

+ +

+Another way to run OpenCPN or test it without installation on your current system is to use a specialized marine OS, which also include essential marine applications. Xinutop is a free an opensource Linux-Debian based solution and can operate on a large variety of x86 processors compliants. Xinutop can run as a live system on USB key. Perform a key is fast and simple, just download and grab the image. It can also be installed on a HDD/SSD, as primary, secondary or rescue OS.
+ +
+ +More under Supplementary Software Xinutop Marine OS
+ +Infos and download at http://marinux.tuxfamily.org
+ +See also in Supplementary Software +

+ +

OpenPlotter

+ +

The open-source sailing platform for ARM computers

+ +

+There are people who buy boats but there are also people who build them, why not build your own electronics too? OpenPlotter is a combination of software and hardware to be used as navigational aid on small and medium boats. It is also a complete home automation system onboard. It works on ARM computers like the Raspberry Pi and is open-source, low-cost and low-consumption. Its design is modular, so you just have to implement what your boat needs. Do it yourself. +

+ +

+You will need the basic parts and some optional parts. It will depend on what kind of data you want to collect, process or display and what kind of equipment your boat already has. +

+ +

+http://www.sailoog.com/openplotter
+ +Openplotter Cruisers Forum +

+ +

+ + +

+ + diff -Nru opencpn-doc-4.8.10129.2/doc/getting_started/opencpn_installation/linux.html opencpn-doc-4.8.2.0/doc/getting_started/opencpn_installation/linux.html --- opencpn-doc-4.8.10129.2/doc/getting_started/opencpn_installation/linux.html 2018-01-30 12:28:30.000000000 +0000 +++ opencpn-doc-4.8.2.0/doc/getting_started/opencpn_installation/linux.html 2018-02-07 14:43:14.000000000 +0000 @@ -1,189 +1,187 @@ - - - - - opencpn:opencpn_user_manual:getting_started:opencpn_installation:linux - - - - - - - - - - - - - - - - - - - - - -

- - - -

Linux

- -

32/64 bit Ubuntu/Debian Distributions

- -

32/64 bit Fedora / Cent OS

- -

-
- -If you are installing OpenCPN for the first time on a computer with Ubuntu, or any other Linux flavor, you have to go through a few steps to make sure that all dependencies are met. Ubuntu uses “deb” packages and Fedora uses the “rpm” packages. -

For Debian based Linuxes: Make sure that you belong to the “dialout” group. To find out, run the “$groups” command. If you're not in “dialout”, add yourself with the command “$sudo usermod -a -G dialout $USER”. Check this straight away, it will save you from frustration later on. If there is a problem connecting the GPS to a physical port, such as /dev/ttyS0, the reason is probably that you don't belong to “dialout”.
-
For other Linux distributions, replace “dialout” above, with the result of this command: $stat -c %G /dev/ttyS0
-
It is recommended that you install the “xcalib” program, that is necessary to dim the screen for night time usage. Use your favourite package manager or just issue $sudo apt-get install xcalib from the command line (for debian based distros).
-
It is recommended that you install the “xdg-utils” program, that helps the grib plugin compose a SailDoc grib-request-mail. Use your favourite package manager or just issue $sudo apt-get install xdg-utils from the command line (for debian based distros).
-
On Ubuntu, start “System→Administration→Synaptic”. In Synaptic go to “Settings→Repositories” and tick the box “Community-maintained Open Source software (universe)”. Close Synaptic.
-
Download the correct .deb or .rpm from Download OpenCPN.
-
For Ubuntu, only use the download with an Ubuntu version number if you have exactly that version. Otherwise use the link “Download OpenCPN 3.X.X for all other *Ubuntu's”.
-
Use the stable release for navigation en route, or if you just started using OpenCPN.
-
Click on the downloaded package. An installation manager will guide you on most Linux distributions. All dependencies should automatically be installed. For most Linux installations, this is all you have to do. Consult the following 3 paragraphs if you run into trouble.
-
If you have problems with dependencies, run the recommended command line in the next paragraph. First check that you really have downloaded the correct version of OpenCPN. se above.
-
sudo gdebi
-

- -

- <downloaded_opencpn_file.deb>. The command “gdebi” will automatically install the dependencies for you. -

It is also possible to install the package via dpkg or rpm, on the condition that all dependencies are met. To make sure that this is the case on Ubuntu, open a terminal window to get a command line, (Applications→Accessories→Terminal) and copy and paste the following line:
-

sudo apt-get install libwxgtk2.8-0 libwxbase2.8-0 wx-common libglu1-mesa libgl1-mesa-glx zlib1g bzip2 gpsd gpsd-clients xcalib xdg-utils libportaudio2 libkml0 libtinyxml2.6.2 liburiparser1 zlib1g libexpat1

- -

-Then proceed with the commands below. -

For Ubuntu: $ sudo dpkg -i <downloaded_file.deb
-For Fedora: # sudo yum install –nogpgcheck <downloaded_file.rpm>
-

The binary will be installed to /usr/bin/opencpn and the static data used by the program will be in /usr/share/opencpn
-
If this is a new installation, click on the Options icon and configure your GPS source, chart directories, and other settings.
-
If there is a problem with sound, make sure that you, as a user, belongs to the “audio” group. To find out, run the “$groups” command. If you're not in “audio”, add yourself with “$sudo usermod -a -G audio $USER”
-
If you are running Debian Squeeze and want to install OpenCPN from the distributions .deb package, you will need to install with something like this in order to satisfy install dependencies related to libtinyxml:
-$sudo dpkg -i –force-depends opencpn_3.1.1327-1_i386.deb
-

- -

Using Linux repositories, an easier way to install and update.

- -

-Installing in a different, easy way. -

- -

Installing on Ubuntu

- -

-Add the OpenCPN ppa repository as explained in configuring Ubuntu PPA
- -- If you are using Synaptic, add the repository, reload the software sources as it suggests, search for and install opencpn
- -- No need to install anything manually -

- -

Other 32, 64bits, the armhf architecture, Linux Distributions and the BSD operating systems

Currently other distributions requires compiling the source. This will involve resolving various dependencies and is for folks comfortable with developing on Linux.
-
Download the source from sourceforge.net or directly from the Git server. The SourceForge link for this project is sourceforge.net/projects/opencpn/. More about compiling on Linux here Compiling - Linux.
-
Interested in maintaining a package for your favorite Linux distribution? Follow the SourceForge link above.
-
This also includes the different BSD distributions. Report your experiences back to the forum.
-

- -

openSUSE notes

- -

-Starting with openSUSE 11.4 and onwards, wxWidgets framework is shipped in several mutually exclusive flavors — “STL”, “noSTL” (“wxContainer”), “ANSI”, — of which OpenCPN is only compatible with “noSTL” (“wxContainer”) flavor. -

Older versions of OpenCPN support wxWidgets 2.8, which does not have a “default” flavor in openSUSE, and of which any flavor may be installed alongside with each other, but OpenCPN stricly requires “wxContainer”.
-
Modern versions of OpenCPN, starting with beta branch 4.5, use functionality that is only available in wxWidgets 2.9, but since that branch is not packaged by openSUSE maintainers, then wxWidgets 3.0 becomes a must. That one defaults to “STL” flavor, which is not appropriate for OpenCPN and will result in multitude of mysterious compilation errors if used, — OpenCPN requires “noSTL”.
-

- -

-To install the required wxWidgets 3.0, use the following command: -

sudo zypper install wxWidgets-3_0-nostl-devel

- -

-For legacy OpenCPN builds against the older wxWidgets 2.8, some virtual wx libraries (with no real content) must also be installed in addition to real-deal wx libraries themselves: -

sudo zypper install wxWidgets-wxcontainer-compat-lib-config libwx_baseu-2_8-0-compat-lib-wxcontainer libwx_baseu_net-2_8-0-compat-lib-wxcontainer libwx_baseu_xml-2_8-0-compat-lib-wxcontainer libwx_gtk2u_adv-2_8-0-compat-lib-wxcontainer libwx_gtk2u_aui-2_8-0-compat-lib-wxcontainer libwx_gtk2u_core-2_8-0-compat-lib-wxcontainer libwx_gtk2u_gl-2_8-0-compat-lib-wxcontainer libwx_gtk2u_html-2_8-0-compat-lib-wxcontainer

- -

-The above commands will also automatically trigger installation of underlying real-deal libraries and other dependencies if they were not present before. -

- -

- - -

- - + + + + + opencpn:opencpn_user_manual:getting_started:opencpn_installation:linux + + + + + + + + + + + + + + + + + + + + + +

+ + + +

Linux

+ +

32/64 bit Ubuntu/Debian Distributions

+ +

32/64 bit Fedora / Cent OS

+ +

+
+ +If you are installing OpenCPN for the first time on a computer with Ubuntu, or any other Linux flavor, you have to go through a few steps to make sure that all dependencies are met. Ubuntu uses “deb” packages and Fedora uses the “rpm” packages. +

For Debian based Linuxes: Make sure that you belong to the “dialout” group. To find out, run the “$groups” command. If you're not in “dialout”, add yourself with the command “$sudo usermod -a -G dialout $USER”. Check this straight away, it will save you from frustration later on. If there is a problem connecting the GPS to a physical port, such as /dev/ttyS0, the reason is probably that you don't belong to “dialout”.
+
For other Linux distributions, replace “dialout” above, with the result of this command: $stat -c %G /dev/ttyS0
+
It is recommended that you install the “xcalib” program, that is necessary to dim the screen for night time usage. Use your favourite package manager or just issue $sudo apt-get install xcalib from the command line (for debian based distros).
+
It is recommended that you install the “xdg-utils” program, that helps the grib plugin compose a SailDoc grib-request-mail. Use your favourite package manager or just issue $sudo apt-get install xdg-utils from the command line (for debian based distros).
+
On Ubuntu, start “System→Administration→Synaptic”. In Synaptic go to “Settings→Repositories” and tick the box “Community-maintained Open Source software (universe)”. Close Synaptic.
+
Download the correct .deb or .rpm from Download OpenCPN.
+
For Ubuntu, only use the download with an Ubuntu version number if you have exactly that version. Otherwise use the link “Download OpenCPN 3.X.X for all other *Ubuntu's”.
+
Use the stable release for navigation en route, or if you just started using OpenCPN.
+
Click on the downloaded package. An installation manager will guide you on most Linux distributions. All dependencies should automatically be installed. For most Linux installations, this is all you have to do. Consult the following 3 paragraphs if you run into trouble.
+
If you have problems with dependencies, run the recommended command line in the next paragraph. First check that you really have downloaded the correct version of OpenCPN. se above.
+
sudo gdebi
+

+ +

+ <downloaded_opencpn_file.deb>. The command “gdebi” will automatically install the dependencies for you. +

It is also possible to install the package via dpkg or rpm, on the condition that all dependencies are met. To make sure that this is the case on Ubuntu, open a terminal window to get a command line, (Applications→Accessories→Terminal) and copy and paste the following line:
+

sudo apt-get install libwxgtk2.8-0 libwxbase2.8-0 wx-common libglu1-mesa libgl1-mesa-glx zlib1g bzip2 gpsd gpsd-clients xcalib xdg-utils libportaudio2 libkml0 libtinyxml2.6.2 liburiparser1 zlib1g libexpat1

+ +

+Then proceed with the commands below. +

For Ubuntu: $ sudo dpkg -i <downloaded_file.deb
+For Fedora: # sudo yum install –nogpgcheck <downloaded_file.rpm>
+

The binary will be installed to /usr/bin/opencpn and the static data used by the program will be in /usr/share/opencpn
+
If this is a new installation, click on the Options icon and configure your GPS source, chart directories, and other settings.
+
If there is a problem with sound, make sure that you, as a user, belongs to the “audio” group. To find out, run the “$groups” command. If you're not in “audio”, add yourself with “$sudo usermod -a -G audio $USER”
+
If you are running Debian Squeeze and want to install OpenCPN from the distributions .deb package, you will need to install with something like this in order to satisfy install dependencies related to libtinyxml:
+$sudo dpkg -i –force-depends opencpn_3.1.1327-1_i386.deb
+

+ +

Using Linux repositories, an easier way to install and update.

+ +

+Installing in a different, easy way. +

+ +

Installing on Ubuntu

+ +

+Add the OpenCPN ppa repository as explained in configuring Ubuntu PPA
+ +- If you are using Synaptic, add the repository, reload the software sources as it suggests, search for and install opencpn
+ +- No need to install anything manually +

+ +

Other 32, 64bits, the armhf architecture, Linux Distributions and the BSD operating systems

Currently other distributions requires compiling the source. This will involve resolving various dependencies and is for folks comfortable with developing on Linux.
+
Interested in maintaining a package for your favorite Linux distribution? Follow the SourceForge link above.
+
This also includes the different BSD distributions. Report your experiences back to the forum.
+

+ +

openSUSE notes

+ +

+Starting with openSUSE 11.4 and onwards, wxWidgets framework is shipped in several mutually exclusive flavors — “STL”, “noSTL” (“wxContainer”), “ANSI”, — of which OpenCPN is only compatible with “noSTL” (“wxContainer”) flavor. +

Older versions of OpenCPN support wxWidgets 2.8, which does not have a “default” flavor in openSUSE, and of which any flavor may be installed alongside with each other, but OpenCPN stricly requires “wxContainer”.
+
Modern versions of OpenCPN, starting with beta branch 4.5, use functionality that is only available in wxWidgets 2.9, but since that branch is not packaged by openSUSE maintainers, then wxWidgets 3.0 becomes a must. That one defaults to “STL” flavor, which is not appropriate for OpenCPN and will result in multitude of mysterious compilation errors if used, — OpenCPN requires “noSTL”.
+

+ +

+To install the required wxWidgets 3.0, use the following command: +

sudo zypper install wxWidgets-3_0-nostl-devel

+ +

+For legacy OpenCPN builds against the older wxWidgets 2.8, some virtual wx libraries (with no real content) must also be installed in addition to real-deal wx libraries themselves: +

sudo zypper install wxWidgets-wxcontainer-compat-lib-config libwx_baseu-2_8-0-compat-lib-wxcontainer libwx_baseu_net-2_8-0-compat-lib-wxcontainer libwx_baseu_xml-2_8-0-compat-lib-wxcontainer libwx_gtk2u_adv-2_8-0-compat-lib-wxcontainer libwx_gtk2u_aui-2_8-0-compat-lib-wxcontainer libwx_gtk2u_core-2_8-0-compat-lib-wxcontainer libwx_gtk2u_gl-2_8-0-compat-lib-wxcontainer libwx_gtk2u_html-2_8-0-compat-lib-wxcontainer

+ +

+The above commands will also automatically trigger installation of underlying real-deal libraries and other dependencies if they were not present before. +

+ +

+ + +

+ + diff -Nru opencpn-doc-4.8.10129.2/doc/getting_started/opencpn_installation/mac_os_x.html opencpn-doc-4.8.2.0/doc/getting_started/opencpn_installation/mac_os_x.html --- opencpn-doc-4.8.10129.2/doc/getting_started/opencpn_installation/mac_os_x.html 2018-01-30 12:28:30.000000000 +0000 +++ opencpn-doc-4.8.2.0/doc/getting_started/opencpn_installation/mac_os_x.html 2018-02-07 14:43:14.000000000 +0000 @@ -93,7 +93,7 @@

-Use of your iPad with RealVNC and OpenCPN +Use of your iPad with RealVNC and OpenCPN

diff -Nru opencpn-doc-4.8.10129.2/doc/getting_started/opencpn_installation/orange_pi.html opencpn-doc-4.8.2.0/doc/getting_started/opencpn_installation/orange_pi.html --- opencpn-doc-4.8.10129.2/doc/getting_started/opencpn_installation/orange_pi.html 2018-01-30 12:28:30.000000000 +0000 +++ opencpn-doc-4.8.2.0/doc/getting_started/opencpn_installation/orange_pi.html 2018-02-07 14:43:14.000000000 +0000 @@ -1,89 +1,89 @@ - - - - - opencpn:opencpn_user_manual:getting_started:opencpn_installation:orange_pi - - - - - - - - - - - - - - - - - - - - - -

- - - -

Orange Pi

- -

What’s Orange Pi PC ？

- -

-It’s an open-source single-board computer. It can run Android 4.4, Ubuntu, Debian, as well as the banana pi Image. It uses the AllWinner H3 SoC, and has 1GB DDR3 SDRAM. It also has a Mali-400 gGPU that can run acellerated OpenGLES.
- -
- -One of the Linux distrobutions available is armbian, a linux for ARM development boards.
- -These instructions are for the armbian Debian Jessie release (5.05). And OpenCPN 4.2.0 in Apr 2016.
- -Updated to include armbian Debian Jessie release (5.14). And OpenCPN 4.4.0 in Jun 2016.
- -
- -To install from a debian package please see:
- -https://github.com/svkatielee/OpenCPN-repo
- -
- -To compile your own version please see the developer manual:
- -Developer Manual -

- -

-Building on armhf linux - Armbian - Orange Pi and
- -KB7KMO Projects: OpenCPN on Orange Pi an Allwinner H3 Arm SBC -

- -

- - -

- - + + + + + opencpn:opencpn_user_manual:getting_started:opencpn_installation:orange_pi + + + + + + + + + + + + + + + + + + + + + +

+ + + +

Orange Pi

+ +

What’s Orange Pi PC ?

+ +

+It’s an open-source single-board computer. It can run Android 4.4, Ubuntu, Debian, as well as the banana pi Image. It uses the AllWinner H3 SoC, and has 1GB DDR3 SDRAM. It also has a Mali-400 gGPU that can run acellerated OpenGLES.
+ +
+ +One of the Linux distrobutions available is armbian, a linux for ARM development boards.
+ +These instructions are for the armbian Debian Jessie release (5.05). And OpenCPN 4.2.0 in Apr 2016.
+ +Updated to include armbian Debian Jessie release (5.14). And OpenCPN 4.4.0 in Jun 2016.
+ +
+ +To install from a debian package please see:
+ +https://github.com/svkatielee/OpenCPN-repo
+ +
+ +To compile your own version please see the developer manual:
+ +Developer Manual +

+ +

+ + +KB7KMO Projects: OpenCPN on Orange Pi an Allwinner H3 Arm SBC +

+ +

+ + +

+ + diff -Nru opencpn-doc-4.8.10129.2/doc/getting_started/opencpn_installation/raspberrypi_rpi2.html opencpn-doc-4.8.2.0/doc/getting_started/opencpn_installation/raspberrypi_rpi2.html --- opencpn-doc-4.8.10129.2/doc/getting_started/opencpn_installation/raspberrypi_rpi2.html 2018-01-30 12:28:30.000000000 +0000 +++ opencpn-doc-4.8.2.0/doc/getting_started/opencpn_installation/raspberrypi_rpi2.html 2018-02-07 14:43:14.000000000 +0000 @@ -1,164 +1,161 @@ - - - - - opencpn:opencpn_user_manual:getting_started:opencpn_installation:raspberrypi_rpi2 - - - - - - - - - - - - - - - - - - - - - -

- - - -

Raspberry Pi 2/3

- -

Installing Raspbian

- -

-OpenCPN works on Raspberry Pi 2 and 3 (recommended) models. You can install OpenCPN adding an Ubuntu PPA (Personal Packages Archives) to your system's Software Sources. We will see how to do this but first of all you need to have a running system. -

- -

-Raspbian is the official Operating System for Raspberry Pi. You have two options to install Raspbian on an SD card: with NOOBS (New Out Of Box Software) or installing an SD image directly. We recommend NOOBS. -

- -

-Follow this easy guide for both options: https://www.raspberrypi.org/learning/software-guide/quickstart/ -

- -

-If you feel lazy you can try OpenPlotter, a complete marine Operating System for Raspberry Pi with OpenCPN + plugins installed and amazing extra tools ready to use. OpenPlotter can be installed with NOOBS following this guide: https://sailoog.gitbooks.io/openplotter-documentation/content/en/getting_started.html -

- -

Adding OpenCPN Ubuntu PPA to Raspbian Software Sources

- -

-Once you have Raspbian running on Raspberry Pi, go to Menu → Accessories → Terminal, and type: -

sudo nano /etc/apt/sources.list

- -

-A text editor will open. Move the cursor to the end and add this line: -

deb http://ppa.launchpad.net/opencpn/opencpn/ubuntu/ xenial main

- -

-Or, if your Raspbian is older than Scratch: -

deb http://ppa.launchpad.net/opencpn/opencpn/ubuntu/ trusty main

- -

-Save the file pressing Ctrl+X, say Yes and press enter. Now type: -

sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys C865EB40

- -

-and press enter. Now be sure you have Internet connection and type: -

sudo apt-get update

- -

-The Software sources will be updated and finally you will have to type: -

sudo apt-get install opencpn

- -

-and you are done! -

- -

-To install OpenCPN and all the available plugins for Linux, type: -

sudo apt-get install opencpn*

- -

-If you get an error doing this, you will have to install the plugins one by one typing: -

sudo apt-get install opencpn-plugin-watchdog
-sudo apt-get install opencpn-plugin-statusbar
-…

- -

-If a new version of OpenCPN is released, just type: -

sudo apt-get update
-sudo apt-get install opencpn

- -

Advanced

- -

Installing OpenCPN betas

- -

-Coming soon -

- -

OpenGL acceleration

- -

-Coming soon -

- -

Compiling OpenCPN on Raspberry Pi

- -

-https://opencpn.org/wiki/dokuwiki/doku.php?id=opencpn:developer_manual:developer_guide:compiling_linux:rpi2 -

- -

- - -

- - + + + + + opencpn:opencpn_user_manual:getting_started:opencpn_installation:raspberrypi_rpi2 + + + + + + + + + + + + + + + + + + + + + +

+ + + +

Raspberry Pi 2/3

+ +

Installing Raspbian

+ +

+OpenCPN works on Raspberry Pi 2 and 3 (recommended) models. You can install OpenCPN adding an Ubuntu PPA (Personal Packages Archives) to your system's Software Sources. We will see how to do this but first of all you need to have a running system. +

+ +

+Raspbian is the official Operating System for Raspberry Pi. You have two options to install Raspbian on an SD card: with NOOBS (New Out Of Box Software) or installing an SD image directly. We recommend NOOBS. +

+ +

+Follow this easy guide for both options: https://www.raspberrypi.org/learning/software-guide/quickstart/ +

+ + +

+ +

Adding OpenCPN Ubuntu PPA to Raspbian Software Sources

+ +

+Once you have Raspbian running on Raspberry Pi, go to Menu → Accessories → Terminal, and type: +

sudo nano /etc/apt/sources.list

+ +

+A text editor will open. Move the cursor to the end and add this line: +

deb http://ppa.launchpad.net/opencpn/opencpn/ubuntu/ xenial main

+ +

+Or, if your Raspbian is older than Scratch: +

deb http://ppa.launchpad.net/opencpn/opencpn/ubuntu/ trusty main

+ +

+Save the file pressing Ctrl+X, say Yes and press enter. Now type: +

sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys C865EB40

+ +

+and press enter. Now be sure you have Internet connection and type: +

sudo apt-get update

+ +

+The Software sources will be updated and finally you will have to type: +

sudo apt-get install opencpn

+ +

+and you are done! +

+ +

+To install OpenCPN and all the available plugins for Linux, type: +

sudo apt-get install opencpn*

+ +

+If you get an error doing this, you will have to install the plugins one by one typing: +

sudo apt-get install opencpn-plugin-watchdog
+sudo apt-get install opencpn-plugin-statusbar
+…

+ +

+If a new version of OpenCPN is released, just type: +

sudo apt-get update
+sudo apt-get install opencpn

+ +

Advanced

+ +

Installing OpenCPN betas

+ +

+Coming soon +

+ +

OpenGL acceleration

+ +

+Coming soon +

+ +

Compiling OpenCPN on Raspberry Pi

+ +

+https://opencpn.org/wiki/dokuwiki/doku.php?id=opencpn:developer_manual:developer_guide:compiling_linux:rpi2 +

+ +

+ + +

+ + diff -Nru opencpn-doc-4.8.10129.2/doc/getting_started/opencpn_installation/windows.html opencpn-doc-4.8.2.0/doc/getting_started/opencpn_installation/windows.html --- opencpn-doc-4.8.10129.2/doc/getting_started/opencpn_installation/windows.html 2018-01-30 12:28:30.000000000 +0000 +++ opencpn-doc-4.8.2.0/doc/getting_started/opencpn_installation/windows.html 2018-02-07 14:43:14.000000000 +0000 @@ -1,89 +1,87 @@ - - - - - opencpn:opencpn_user_manual:getting_started:opencpn_installation:windows - - - - - - - - - - - - - - - - - - - - - -

- - - -

Windows

- -

-. . . -

- -

-Windows XP SP3/Vista/7/8/10 (except W8 RT) * Download the installation package for Windows from Download OpenCPN. -

Use the stable release for navigation en route, or if you just started using OpenCPN.
-
Exit all other programs, including your anti virus program - known to create problems in some cases. Unplug your network cable, to be on the safe side.
-
Run the downloaded installer. Re-start your anti-virus. Re-connect the network
-
If upgrading from a previous version of OpenCPN, there is no need to un-install the old version. Simply install the new version and it will upgrade OpenCPN, saving all your existing configuration and preferences.
-
If this is a new installation, click on the Toolbox icon and configure your GPS source, chart directories, and other settings. It is highly recommended that you use the Chart Downloader Tab to setup directories and download charts.
-
If your installation goes well, but OpenCPN does not start as expected, try to download and install these runtime components.
-
Not Supported Windows versions:
-Win 8 RT is not supported.
-Win CE is not supported.
-Win XP SP 2 or 1 are not supported. The last OpenCPN version that included support was 2.6.1624.
-Win 2000 is not supported. The last OpenCPN version that included support was 2.5.0.
-Win 98/ME are not supported. The last OpenCPN version that included support was 2.1.0.
-
-

- -

-Old versions of OpenCPN are available on SourceForge. -

- -

- - -

- - + + + + + opencpn:opencpn_user_manual:getting_started:opencpn_installation:windows + + + + + + + + + + + + + + + + + + + + + +

+ + + +

Windows

+ +

+. . . +

+ +

+Windows XP SP3/Vista/7/8/10 (except W8 RT) * Download the installation package for Windows from Download OpenCPN. +

Use the stable release for navigation en route, or if you just started using OpenCPN.
+
Exit all other programs, including your anti virus program - known to create problems in some cases. Unplug your network cable, to be on the safe side.
+
Run the downloaded installer. Re-start your anti-virus. Re-connect the network
+
If upgrading from a previous version of OpenCPN, there is no need to un-install the old version. Simply install the new version and it will upgrade OpenCPN, saving all your existing configuration and preferences.
+
If this is a new installation, click on the Toolbox icon and configure your GPS source, chart directories, and other settings. It is highly recommended that you use the Chart Downloader Tab to setup directories and download charts.
+
If your installation goes well, but OpenCPN does not start as expected, try to download and install these runtime components.
+
Not Supported Windows versions:
+Win 8 RT is not supported.
+Win CE is not supported.
+Win XP SP 2 or 1 are not supported. The last OpenCPN version that included support was 2.6.1624.
+Win 2000 is not supported. The last OpenCPN version that included support was 2.5.0.
+Win 98/ME are not supported. The last OpenCPN version that included support was 2.1.0.
+
+

+ + +

+ + diff -Nru opencpn-doc-4.8.10129.2/doc/getting_started/opencpn_installation.html opencpn-doc-4.8.2.0/doc/getting_started/opencpn_installation.html --- opencpn-doc-4.8.10129.2/doc/getting_started/opencpn_installation.html 2018-01-30 12:28:30.000000000 +0000 +++ opencpn-doc-4.8.2.0/doc/getting_started/opencpn_installation.html 2018-02-07 14:43:14.000000000 +0000 @@ -77,16 +77,16 @@

-Download your version of OpenCPN here +Download your version of OpenCPN here

Use a “stable”, official release for actual navigation. The latest stable release is always available at the top of the download page or from Source Forge.
Beta releases are snapshots of the development process, and may contain errors or temporarily be unstable. Show stoppers are normally fixed very quickly however. This is where the latest features first are seen. Most of the time the beta releases are quite stable and the OpenCPN team appreciate it if more experienced users test the releases and report back.
The place to report bugs and suggest features is the Tracker. To reach the Tracker from the OpenCPN Web pages click on the “Tracker” tab at the upper right (above the blue bar). The sticky thread “Tracker/Flyspray - How and When to use it” (tab Forum) gives some hints.
+
The place to report bugs and suggest features is the Tracker. To reach from the OpenCPN.org pages click on the “Tracker” on the top menu. The sticky thread “Tracker/Flyspray - How and When to use it” (tab Forum) gives some hints.
To see what version you are using either look in (Help) ? → About or at the top of your display. A lot of information is also available in the Log file. See below.
+
To see what version you are using either look in (Help) ? ? About or at the top of your display. A lot of information is also available in the Log file. See below.

diff -Nru opencpn-doc-4.8.10129.2/doc/getting_started/touch_screen_tablets.html opencpn-doc-4.8.2.0/doc/getting_started/touch_screen_tablets.html --- opencpn-doc-4.8.10129.2/doc/getting_started/touch_screen_tablets.html 2018-01-30 12:28:30.000000000 +0000 +++ opencpn-doc-4.8.2.0/doc/getting_started/touch_screen_tablets.html 2018-02-07 14:43:14.000000000 +0000 @@ -1,221 +1,217 @@ - - - - - opencpn:opencpn_user_manual:getting_started:touch_screen_tablets - - - - - - - - - - - - - - - - - - - - - -

- - - -

Touch Screen Tablets

- -

-
- -It is no wonder that iPads and Android tablets have become so popular. They offer superior ergonomics vs. laptops in many settings, including areas with limited space and power such as boat cabins and cockpits. Tablets usually offer superior battery life, lower power consumption, and are easier to waterproof via inexpensive pouches.
- -
- -With the recent release of OpenCPN for Android on the Google Play Store, a huge selection of phones and tablets are now able to run OpenCPN very easily.
- -
- -OpenCPN can also run very nicely on Windows 8 tablets, many of which are available at very low cost. Here are some suggestions for running on Windows tablets:
- -
- -Running OpenCPN on a Windows 8 tablet
- -
- -Although Windows 8 tablets are not as common as iPads or Android, they have the advantage of running on the exact same Windows platform as PCs and laptops. This means you can install OpenCPN onto a tablet using the same installer that is used for Windows laptops and desktops. Just dowload the installer and appropriate charts, run the installer, and select the chart location just like you would on any PC.
- -
- -Because of differences in Windows 8 vs. prior Windows versions, and configuration differences in the tablet hardware, your user experience with OpenCPN on a Windows tablet may be enhanced by considering these optional tips and tricks:
- -
- -1. Install the Classic Shell free software. This facilitates using the tablet with traditional Windows desktop programs, and will make the Win8 environment more familiar for those who are coming from XP, Vista, or Win7. You can still bring up the Start Screen to use the newer “Metro” tablet apps, but Classic Shell restores the familiar Start menu that Windows users are accustomed to having.
- -
- - -
- -2. Check Device Manager-Sensors to verify whether your tablet has a GNSS Geolocation sensor. If so, your tablet has GPS capabilities already built in. (Some tablets have been discovered to have GPS even though the specifications may not mention it.)
- -
- - -
- -However, the Windows 8 tablets initially are configured in a way that only Metro apps can see the built-in GPS. In order to overcome this limitation, try installing petrsimon's excellent GeolocationTCP utility. Set this utility to launch at bootup so it's always there by putting a shortcut in the Startup folder created by Classic Shell.
- -
- - -
- -Then you need to configure OpenCPN to receive the NMEA data over the appropriate TCP port.
- -
- - -
- -3. GPS If you do not have an internal GPS and want one to interface with your tablet, I recommend a Bluetooth GPS transmitter instead of a wired dongle or puck. There are Android and iPhone apps that will transmit from your smartphone, or you can purchase a freestanding Bluetooth GPS made by GlobalSat or others. Transmitting GPS to the tablet via Bluetooth also facilitates putting the tablet into a waterproof pouch. Some have reported that hanging a USB connector off the side of the tablet may weaken the microUSB plug over time.
- -
- -4. The excellent form factor of the tablet opens up some great possibilities for use in the cockpit, if you select a tablet with a sufficiently bright screen. A suggested tablet model and more comprehensive list of tips can be found on this message thread.
- -
- -OpenCPN runs remarkably well on a tablet with practically no modifications. Microsoft has emulated many mouse functions in their OS. The right-click context menus are emulated by tap-hold. Zooming and unzooming in OpenCPN is accomplished by pinching gesture, or using the magnifying glass icons in the toolbar.
- -
- -Mouse hover (aka “rollover”) is not generally supported on tablets, and accidentally tapping the chart can lead to unexpected re-centering of the chart. To address this and other tablet needs, OpenCPN adds some some custom features available in the Options-User Interface menu: -

- -

-Activating “Enable Touchscreen Interface” alters the effect of tapping/clicking on the chart in the following ways:
- -
- --Suppresses re-centering of the chart by tapping (you need to tap-drag to pan the chart)
- --Tapping waypoint selects it for subsequent dragging
- --Tapping Routes and AIS targets shows popup info
- --Tapping tide/current icons shows appropriate dialog
- -
- -Here are some additional behaviors with “Enable Touchscreen Interface” activated:
- -
- --Optimize several common dialogs for screen rotation, i.e. landscape or portrait
- --Route Create workflow: “Done” by clicking toolbar “Route” icon, or normal context menu.
- --Toolbar navigation items (e.g. Zoom/Scale) are available during route creation.
- --Chart drag (a.k.a. swipe) is available during route creation.
- --Routepoint/Waypoint edit by drag is supported.
- --Increase pixel select radius, to allow for finger tip selection of routes/waypoints
- -
- -A second option, “Enable Tablet Scaled Graphics Interface” can improve the display, especially on tablets with high pixel density. At present, Windows tablets are generally lower pixel density than Android and iPad, but this may change with future hardware. This option does the following:
- -
- --Increase toolbar icon size
- --Increase context menu text item size
- --Increase selectable item sizes for several common dialogs
- -
- -Tablet Scaled Graphics may enlarge the toolbar icons too much for some tastes, especially on small tablets with limited screen space. As an alternative, Microsoft provides a Magnifier utility that temporarily zooms the view and allows for panning across the enlarged screen. It can be found in Start-All Programs-Windows Ease of Access (if you have Classis Shell installed), or by searching the Start Page in the Modern interface. I recommend pinning a shortcut to the taskbar for quick one-tap access. While zooming the OpenCPN menu can enlarge many chart features, Magnifier can enlarge additional elements like the very small depth soundings and the green-over-black status text displayed by the Active Route:
- -
- -
- -* Read more about the XTE in Connections Add a Serial Connection, “APB bearing precision”
- -
- -
- -
- -Following are Dave's comments on “Enable Tablet Scaled Graphics Interface”:
- -- It is important that the screen width dimension be properly set for this option to work.
- -- Manual override of screen width can be done at -Options→Display→Advanced Options Settings-Display-Advanced.
- -- Dave found, on his W8.1 tablet, that the automatically calculated size value was wrong, leading to extra large toolbar icons. Easy to correct with a physical measurement.
- -
- -In the “Tablet Scaled Graphics Interface”, the toolbar icon target minimum size is 9mm square.
- -This is the generally accepted minimum button size for several mobile platforms.
- -

- -

-Other Tablets and Operating System details.
- -

- -

-OpenCPN for Windows also runs successfully on: -

Microsoft Surface Pro 3 with Windows 8 and Globalstar Bu-343 puck gps.
-
Microsoft Surface Pro 3 with Windows 10 and Globalstar Bu-343 S4 puck gps.
-
Opencpn should run successfully on most Windows 10 Computers.
-

- -

- - -

- - + + + + + opencpn:opencpn_user_manual:getting_started:touch_screen_tablets + + + + + + + + + + + + + + + + + + + + + +

+ + + +

Touch Screen Tablets

+ +

+
+ +It is no wonder that iPads and Android tablets have become so popular. They offer superior ergonomics vs. laptops in many settings, including areas with limited space and power such as boat cabins and cockpits. Tablets usually offer superior battery life, lower power consumption, and are easier to waterproof via inexpensive pouches.
+ +
+ +With the recent release of OpenCPN for Android on the Google Play Store, a huge selection of phones and tablets are now able to run OpenCPN very easily.
+ +
+ +OpenCPN can also run very nicely on Windows 8 tablets, many of which are available at very low cost. Here are some suggestions for running on Windows tablets:
+ +
+ +Running OpenCPN on a Windows 8 tablet
+ +
+ +Although Windows 8 tablets are not as common as iPads or Android, they have the advantage of running on the exact same Windows platform as PCs and laptops. This means you can install OpenCPN onto a tablet using the same installer that is used for Windows laptops and desktops. Just dowload the installer and appropriate charts, run the installer, and select the chart location just like you would on any PC.
+ +
+ +Because of differences in Windows 8 vs. prior Windows versions, and configuration differences in the tablet hardware, your user experience with OpenCPN on a Windows tablet may be enhanced by considering these optional tips and tricks:
+ +
+ +1. Install the Classic Shell free software. This facilitates using the tablet with traditional Windows desktop programs, and will make the Win8 environment more familiar for those who are coming from XP, Vista, or Win7. You can still bring up the Start Screen to use the newer “Metro” tablet apps, but Classic Shell restores the familiar Start menu that Windows users are accustomed to having.
+ +
+ + +
+ +2. Check Device Manager-Sensors to verify whether your tablet has a GNSS Geolocation sensor. If so, your tablet has GPS capabilities already built in. (Some tablets have been discovered to have GPS even though the specifications may not mention it.)
+ +
+ + +
+ +However, the Windows 8 tablets initially are configured in a way that only Metro apps can see the built-in GPS. In order to overcome this limitation, try installing petrsimon's excellent GeolocationTCP utility. Set this utility to launch at bootup so it's always there by putting a shortcut in the Startup folder created by Classic Shell.
+ +
+ + +
+ +Then you need to configure OpenCPN to receive the NMEA data over the appropriate TCP port.
+ +
+ + +
+ +3. GPS If you do not have an internal GPS and want one to interface with your tablet, I recommend a Bluetooth GPS transmitter instead of a wired dongle or puck. There are Android and iPhone apps that will transmit from your smartphone, or you can purchase a freestanding Bluetooth GPS made by GlobalSat or others. Transmitting GPS to the tablet via Bluetooth also facilitates putting the tablet into a waterproof pouch. Some have reported that hanging a USB connector off the side of the tablet may weaken the microUSB plug over time.
+ +
+ +4. The excellent form factor of the tablet opens up some great possibilities for use in the cockpit, if you select a tablet with a sufficiently bright screen. A suggested tablet model and more comprehensive list of tips can be found on this message thread.
+ +
+ +OpenCPN runs remarkably well on a tablet with practically no modifications. Microsoft has emulated many mouse functions in their OS. The right-click context menus are emulated by tap-hold. Zooming and unzooming in OpenCPN is accomplished by pinching gesture, or using the magnifying glass icons in the toolbar.
+ +
+ +Mouse hover (aka “rollover”) is not generally supported on tablets, and accidentally tapping the chart can lead to unexpected re-centering of the chart. To address this and other tablet needs, OpenCPN adds some some custom features available in the Options-User Interface menu: +

+ + +

+Activating “Enable Touchscreen Interface” alters the effect of tapping/clicking on the chart in the following ways:
+ +
+ +-Suppresses re-centering of the chart by tapping (you need to tap-drag to pan the chart)
+ +-Tapping waypoint selects it for subsequent dragging
+ +-Tapping Routes and AIS targets shows popup info
+ +-Tapping tide/current icons shows appropriate dialog
+ +
+ +Here are some additional behaviors with “Enable Touchscreen Interface” activated:
+ +
+ +-Optimize several common dialogs for screen rotation, i.e. landscape or portrait
+ +-Route Create workflow: “Done” by clicking toolbar “Route” icon, or normal context menu.
+ +-Toolbar navigation items (e.g. Zoom/Scale) are available during route creation.
+ +-Chart drag (a.k.a. swipe) is available during route creation.
+ +-Routepoint/Waypoint edit by drag is supported.
+ +-Increase pixel select radius, to allow for finger tip selection of routes/waypoints
+ +
+ +A second option, “Enable Tablet Scaled Graphics Interface” can improve the display, especially on tablets with high pixel density. At present, Windows tablets are generally lower pixel density than Android and iPad, but this may change with future hardware. This option does the following:
+ +
+ +-Increase toolbar icon size
+ +-Increase context menu text item size
+ +-Increase selectable item sizes for several common dialogs
+ +
+ +Tablet Scaled Graphics may enlarge the toolbar icons too much for some tastes, especially on small tablets with limited screen space. As an alternative, Microsoft provides a Magnifier utility that temporarily zooms the view and allows for panning across the enlarged screen. It can be found in Start-All Programs-Windows Ease of Access (if you have Classis Shell installed), or by searching the Start Page in the Modern interface. I recommend pinning a shortcut to the taskbar for quick one-tap access. While zooming the OpenCPN menu can enlarge many chart features, Magnifier can enlarge additional elements like the very small depth soundings and the green-over-black status text displayed by the Active Route:
+ +
+ + +* Read more about the XTE in Connections Add a Serial Connection, “APB bearing precision”
+ +
+ +
+ +
+ +Following are Dave's comments on “Enable Tablet Scaled Graphics Interface”:
+ +- It is important that the screen width dimension be properly set for this option to work.
+ +- Manual override of screen width can be done at +Options→Display→Advanced Options Settings-Display-Advanced.
+ +- Dave found, on his W8.1 tablet, that the automatically calculated size value was wrong, leading to extra large toolbar icons. Easy to correct with a physical measurement.
+ +
+ +In the “Tablet Scaled Graphics Interface”, the toolbar icon target minimum size is 9mm square.
+ +This is the generally accepted minimum button size for several mobile platforms.
+ +

+ +

+Other Tablets and Operating System details.
+ +

+ +

+OpenCPN for Windows also runs successfully on: +

Microsoft Surface Pro 3 with Windows 8 and Globalstar Bu-343 puck gps.
+
Microsoft Surface Pro 3 with Windows 10 and Globalstar Bu-343 S4 puck gps.
+
Opencpn should run successfully on most Windows 10 Computers.
+

+ +

+ + +

+ + diff -Nru opencpn-doc-4.8.10129.2/doc/getting_started.html opencpn-doc-4.8.2.0/doc/getting_started.html --- opencpn-doc-4.8.10129.2/doc/getting_started.html 2018-01-30 12:28:30.000000000 +0000 +++ opencpn-doc-4.8.2.0/doc/getting_started.html 2018-02-07 14:43:14.000000000 +0000 @@ -23,18 +23,18 @@ @@ -48,19 +48,19 @@

OpenCPN 4.8.0

OpenCPN 4.8.2

-Welcome! This is the Documentation for the OpenCPN 4.8.0 stable release. (There are still areas that are not fully updated.) It is very easy and intuitive to get started with OpenCPN. The different menus, including the clever context-sensitive right-click menu, make it likely that you will find what you need. The program contains a lot of options to fit users with special demands and hardware. +Welcome! This is the Documentation for the OpenCPN 4.8.2 stable release. (There are still areas that are not fully updated.) It is very easy and intuitive to get started with OpenCPN. The different menus, including the clever context-sensitive right-click menu, make it likely that you will find what you need. The program contains a lot of options to fit users with special demands and hardware.

-Required reading YachtValhalla's PDF Tutorial for the new user starting up Exploring OpenCPN v3.0 +Required reading YachtValhalla's PDF Tutorial for the new user starting up Exploring OpenCPN v3.0 (pdf download)

- +

HELP, FAQ & OpenCPN User Manual

@@ -73,7 +73,7 @@

-In the Program “OpenCPN” Press and then the Help Tab to access the built-in version of this document. The installed documentation will open in your default browser. This is the first place to go for help, read the documentation please. To download a current snapshot of this wiki as one huge web page, Click here for fullindex (only works if you are online). Note that the details of downloading a single file html formatted properly have not been worked out yet. +In the Program “OpenCPN” Press and then the Help Tab to access the built-in version of this document. The installed documentation will open in your default browser. This is the first place to go for help, read the documentation please. To download a current snapshot of this wiki as one huge web page, here (only works if you are online). Note that the details of downloading a single file html formatted properly have not been worked out yet.

@@ -113,7 +113,7 @@

-If you encounter difficulties in using OpenCPN you may be asked to submit your Settings File and/or your Log File. This data will help the developers to diagnose your problem. +If you encounter difficulties in using OpenCPN you may be asked to submit your Settings File and/or your Log File. This data will help the developers to diagnose your problem.

@@ -141,12 +141,12 @@

Here is the note that all users have to approve when installing the program.

OpenCPN is distributed in the hope that it will be useful, 
-but WITHOUT ANY WARRANTY; without even the implied warranty of 
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
-See the GNU General Public License for more details. 
+OpenCPN is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+See the GNU General Public License for more details.
 OpenCPN must only be used in conjunction with approved paper
- charts and traditional methods of navigation. 
+ charts and traditional methods of navigation.
 DO NOT rely upon OpenCPN for safety of life or property.
 
 
@@ -172,16 +172,14 @@
 
 
 
-

-There is also a very useful PDF Tutorial for the new user starting up called Exploring OpenCPN 
-
+
 
 
 If you still have questions or would just like to get in touch with other OpenCPN users, there is a large community behind OpenCPN. You can find us in this Cruisers Forum.
 
 
 
-If you are an advanced users with programming experience we recommend the Developers Manual.
+If you are an advanced users with programming experience we recommend the Developers Manual.  (view online)

Binary files /tmp/tmpUnFJA0/V9lEOSntqZ/opencpn-doc-4.8.10129.2/doc/opencpn/manual/font1.h.357_tok.520ff8_w.300.jpg and /tmp/tmpUnFJA0/o5VFIPF7k0/opencpn-doc-4.8.2.0/doc/opencpn/manual/font1.h.357_tok.520ff8_w.300.jpg differ Binary files /tmp/tmpUnFJA0/V9lEOSntqZ/opencpn-doc-4.8.10129.2/doc/opencpn/manual/font.h.285_tok.2f35dd_w.300.jpg and /tmp/tmpUnFJA0/o5VFIPF7k0/opencpn-doc-4.8.2.0/doc/opencpn/manual/font.h.285_tok.2f35dd_w.300.jpg differ Binary files /tmp/tmpUnFJA0/V9lEOSntqZ/opencpn-doc-4.8.10129.2/doc/opencpn/manual/opencpn-options-userinterface1-scales.tok.1ed7a6_w.400.jpg and /tmp/tmpUnFJA0/o5VFIPF7k0/opencpn-doc-4.8.2.0/doc/opencpn/manual/opencpn-options-userinterface1-scales.tok.1ed7a6_w.400.jpg differ Binary files /tmp/tmpUnFJA0/V9lEOSntqZ/opencpn-doc-4.8.10129.2/doc/opencpn/manual/opencpn-options-userinterface1.tok.25d212_w.400.jpg and /tmp/tmpUnFJA0/o5VFIPF7k0/opencpn-doc-4.8.2.0/doc/opencpn/manual/opencpn-options-userinterface1.tok.25d212_w.400.jpg differ Binary files /tmp/tmpUnFJA0/V9lEOSntqZ/opencpn-doc-4.8.10129.2/doc/opencpn/manual/toolbar_ecdis_mode_01.jpg and /tmp/tmpUnFJA0/o5VFIPF7k0/opencpn-doc-4.8.2.0/doc/opencpn/manual/toolbar_ecdis_mode_01.jpg differ Binary files /tmp/tmpUnFJA0/V9lEOSntqZ/opencpn-doc-4.8.10129.2/doc/opencpn/manual/toolbar_ecdis_mode_02.jpg and /tmp/tmpUnFJA0/o5VFIPF7k0/opencpn-doc-4.8.2.0/doc/opencpn/manual/toolbar_ecdis_mode_02.jpg differ diff -Nru opencpn-doc-4.8.10129.2/doc/options_setting/chart.html opencpn-doc-4.8.2.0/doc/options_setting/chart.html --- opencpn-doc-4.8.10129.2/doc/options_setting/chart.html 2018-01-30 12:28:30.000000000 +0000 +++ opencpn-doc-4.8.2.0/doc/options_setting/chart.html 2018-02-07 14:43:14.000000000 +0000 @@ -1,147 +1,147 @@ - - - - - opencpn:opencpn_user_manual:options_setting:chart - - - - - - - - - - - - - - - - - - - - - -

- - - -

The Chart

- -

Chart Files

- -

Add Directory

- -

-In OpenCPN charts are added by adding the directory (folder) that contains the chart files. This tab is where charts are added and removed. Read about the details in Installing Charts -

- -

Remove Selected

- -

-Mark the chart directories that are no longer needed, press the button an then “Apply” or “OK”. -

- -

Scan Charts and Update Database

- -

-Use this option if you have made any changes to the contents of your chart directories, as for example after downloading new charts from NOAA, etc. It need not be checked if directories are added or subtracted, as the entire database will be scanned and updated automatically in this case. -

- -

Force Full Database Rebuild

- -

-Is mainly aimed at users converting or correcting existing charts, in a situation where changes are made to the geo-referencing, outline of the chart, or other attributes in the kap file header section. -

- -

Prepare all ENC charts

- -

-Converts all existing S57/S63 charts to an internal SENC format for fast loading. The button is there on popular request, and means that O don't stop to process a chart when encountered the first time, but instead process all charts at once. The process can take quite some time, depending on your system. If you already done the new conversion once and add a chart, pressing the button will be fast as only the new chart is processed. NOTE: There is also a new naming system for the processed files. It's a good idea to delete the SENC folder the first time you use the new beta, and then press “Prepare all ENC charts”. The only reason for this is to save some space on your hard desk. -

- -

Vector Charts Display

- -

-Read more about Vector Charts . -

- -

Chart Groups

- -

-Read more about Chart Groups . -

- -

Tides & Currents

- -

-Read more about Tides and Currents . -

- -

- - -

- - + + + + + opencpn:opencpn_user_manual:options_setting:chart + + + + + + + + + + + + + + + + + + + + + +

+ + + +

The Chart

+ +

Chart Files

+ +

Add Directory

+ +

+In OpenCPN charts are added by adding the directory (folder) that contains the chart files. This tab is where charts are added and removed. Read about the details in Installing Charts +

+ +

Remove Selected

+ +

+Mark the chart directories that are no longer needed, press the button an then “Apply” or “OK”. +

+ +

Scan Charts and Update Database

+ +

+Use this option if you have made any changes to the contents of your chart directories, as for example after downloading new charts from NOAA, etc. It need not be checked if directories are added or subtracted, as the entire database will be scanned and updated automatically in this case. +

+ +

Force Full Database Rebuild

+ +

+Is mainly aimed at users converting or correcting existing charts, in a situation where changes are made to the geo-referencing, outline of the chart, or other attributes in the kap file header section. +

+ +

Prepare all ENC charts

+ +

+Converts all existing S57/S63 charts to an internal SENC format for fast loading. The button is there on popular request, and means that O don't stop to process a chart when encountered the first time, but instead process all charts at once. The process can take quite some time, depending on your system. If you already done the new conversion once and add a chart, pressing the button will be fast as only the new chart is processed. NOTE: There is also a new naming system for the processed files. It's a good idea to delete the SENC folder the first time you use the new beta, and then press “Prepare all ENC charts”. The only reason for this is to save some space on your hard desk. +

+ +

Vector Charts Display

+ +

+Read more about Vector Charts . +

+ +

Chart Groups

+ +

+Read more about Chart Groups . +

+ +

Tides & Currents

+ +

+Read more about Tides and Currents . +

+ +

+ + +

+ + diff -Nru opencpn-doc-4.8.10129.2/doc/options_setting/connections.html opencpn-doc-4.8.2.0/doc/options_setting/connections.html --- opencpn-doc-4.8.10129.2/doc/options_setting/connections.html 2018-01-30 12:28:30.000000000 +0000 +++ opencpn-doc-4.8.2.0/doc/options_setting/connections.html 2018-02-07 14:43:14.000000000 +0000 @@ -1,822 +1,821 @@ - - - - - opencpn:opencpn_user_manual:options_setting:connections - - - - - - - - - - - - - - - - - - - - - -

- - - -

The Connections

- -

Features and Improvements

- -

-NMEA Sentences moved to “Advanced Features” -

- -

-OpenCPN version 3.2 featured a complete redesign of the NMEA message handling structure, including a new GUI and monitor window. This feature has been further improved and tuned in version 4.2. The current scheme provides extensive NMEA management capabilities, including: -

Input message filtering, by TALKER ID and/or message type.
-
Implement configurable NMEA Talker ID.
-
Virtually unlimited input port multiplexing, with shared I/O and individual data rate settings.
-
Selective message echo capability, similar to third-party mux applications.
-
Programmable output port messages, for e.g. autopilot interfaces.
-
Full Network input and output, including TCP, UDP, and GPSD services.
-
GPSD client support for Windows platforms.
-

- -

-Linux Serial Connections
- -Connections Window
- -Example Data Connections Window
- -Filter NMEA Course and Speed Data
- -Show NMEA Debug Window
- -Data Connections - Add and Remove
- -Add a Serial Connection
- -Add a Network Connection
- -Network GPSD connection
- -Connections Filter
- -Input Filtering
- -Output Filtering
- -Connection Notes
- -Sending an Active Route to an Autopilot
- -Sending Routes and Waypoints to a GPS
- -Broadcast and Multicast
- -

- -

Linux Serial Connections

- -

-Make sure that you belong to the “dialout” group. To find out, run the “$groups” command. If you're not in “dialout”, add yourself with the command “$sudo usermod -a -G dialout $USER”. Logout of your current session for group changes to take effect. Check this straight away, it will save you from frustration later on. If there is a problem connecting the GPS to a physical port, such as /dev/ttyS0, the reason is probably that you don't belong to “dialout”. OpenCPN will display a warning, once per session, if you try to configure a serial connection, or starts the program with an active serial connection, and don't belong to the right group. -

- -

-Red Hat based Linux versions are using the “uucp” group. Check what applies to your version of Linux, by using the return from the command stat -c %G `ls /dev/*|grep -m1 tty[A-Z,a-z][0] If the return is “root”, upgrade to a contemporary Linux version. -

- -

Connections Window

- -

-All this is different from the logic in earlier versions of OpenCPN. From version 3.2, there is no defined “autopilot” port. The autopilot is simply connected to any available output- enabled data-stream, and gets everything on the bus, subject to user specified output filtering. There is no specific “shared” AIS and GPS port, as all ports are shared. -

- -

-
- - -

- -

-The key point to keep in mind with this new setup is the complete orthogonality between message sources, message destinations, and transport media. All messages come and go from an internal “bus”, and all internal modules have access to all messages. Any message can be received, and possibly re-transmitted according to the configuration established. If the messages get onto the bus, -

- -

-OpenCPN will do the right thing. For example, if it is an AIS message, the AIS module will get the message and act accordingly. Plugins also get all messages. -

- -

Example Data Connections Window

- -

-To get a taste of what can be done, we start with a lab scenario. In the screen-shot above, four Data Ports are enabled. -

GPSD on localhost port 2947
-
/dev/ttyUSB1 as ais port
-
output port to a computer on the local network
-
San Fransisco AIS feed.
-

- -

-Note that the connections are automatically sorted in order of the priority setting The picture is from a Linux computer, but the receiving box is an Win XP. Both boxes are configured to use the same broadcasting address '192.168.0.255' on the local network, using the default 10110 port. Note that UDP, and not TCP, is used. OpenCPN on the XP box receives and shows all info from the three first ports and even data from the VDR plugin, if it's running. All input sources are merged together and available to transmit to an external computer. Every computer on-board can be used as a repeater to the main box! -

- -

-Note that in this scenario the UDP connection is output only. In previous releases of OpenCPN all UDP data connections would read data as well as write. This is a possible configuration in the current release but neither required nor generally desirable. If a broadcast connection is read/write, all data written will be read back leading to the potential for data loops. -

To avoid this, the priority of any read/write broadcast connection should be set lower than that of any other interface on which OpenCPN receives data for re-distribution over that interface.
-
For most purposes setting a broadcast connection to either read or write is the preferable solution.
-
The San Francisco AIS feed has now changed to ip address 76.103.90.196, also on port 9009.
-

- -

-There is no advantage to using a broadcast address on the local network with just a few computers. It's as easy to just specify the addresses of the receiving computers as outgoing connections on the transmitting computer. The “receivers” specify the “transmitter” as address for a connection. -

- -

-In real life, a common setup will include input from GPS, AIS and output to an Autopilot. If your GPS produces GPRMC, then this will be automatically shipped to the autopilot. -

Everything on the internal multiplex bus will be sent to the output port that the autopilot is connected to, even if a route is inactive.
-
If, a route is active, OpenCPN will create and send NMEA (EC)RMC sentences to output data ports.
-
The only reason OpenCPN “synthesize” an ECRMC sentence is to cover those odd cases when there is no other source of RMC in the system, and the Autopilot wants variation, SOG, etc. This might be the case if an older GPS produces GPGLL alone, for instance, which has no var. There is no “new” information in the transmitted, synthesized ECRMC.
-
The autopilot might be complaining that it is getting RMC information from two different talkers (GP and EC) at the same time, and cannot decide what to do. The easiest solution if don't like the ECRMC, is to filter it out of the output stream of the port connected to the autopilot. Or choose a filter to allow only GPRMC and ECRMB for this port.
-

- -

Filter NMEA Course and Speed Data

- -

-Providing a rolling average of COG/SOG, with configurable sampling period. This feature is useful, for example, if you find that course and speed from the gps is varying erratically due to the sea state. The Dashboard plugin is not affected by this setting - COG and SOG are updated about once per second. -

- -

Show NMEA Debug Window

- -

-If you check this box you will get a window that shows the NMEA data sentences coming into or going out from OpenCPN. In the picture above we can see the color-coding at work. Messages in red could occur as well, and indicates a transmit error. Connections Priority change messages, will also be printed to the NMEA Debug Window. The reason that AIVDM messages are both dropped and appear as “Output message”, is that there is more than one source for this message, and the filter just applies to one source. -

- -

-Have a look at the page NMEA Sentences to see which messages are understood. OpenCPN generally does not care about the Talker ID, the first two letters in the message type. $GPGGA above, is the talker GP = the gps, sending a GGA = position message, for example. At the end of each sentence there is a “*” followed by a calculated checksum. -

- -

-To see all messages it's important to close the Options dialog completely, while leaving the NMEA Debug window open. The ECAPB sentences etc, will not appear while the Connections dialog box is open as autopilot output is disabled during this time. -

- -

-Known issues: The pause button only works if the main Options dialog is closed. In Linux, the debug window can only be closed by unticking the Show NMEA Debug Window box, unless the the main Options dialog is closed. -

- -

-If there are NMEA sentences in the debug window, then OpenCPN has opened the port set in the Data Connections. Note that the source of each NMEA sentence is printed after the time stamp o each line. If your GPS port is configured, and there is no “red” boat, then the only reasons are: no gps fix or wrong sentence configuration from the GPS. -

- -

-Messages originating from GPSD or the VDR (Voyage Data Recorder plugin) will also show up in the debug window. -

- -

-For simple NMEA data stream debugging, add the following to your opencpn.ini file:Under [Settings] add a line DebugNMEA=1500 This will provide up to 1500 debug messages pertaining to NMEA traffic to the opencpn.log. -

- -

-Format uploads for FurunoGP3Xinputfiltering: If the special Furuno gps protocol is needed, tick this box. The reason is that Furuno uses their own version of NMEA for uploading routes. Furuno GPS users take note. It is now allowed to use a numeric, two digit OpenCPN route name (e.g. 10, 21, etc). -

- -

-Use GarminGRMN (Host) mode for uploads. Make sure that this box is ticked, if you have a Garmin GPS. The reason for this is that Garmin units cannot accept route uploads via standard NMEA0183. This is a “design feature” of all Garmin receivers. -

- -

-Use magnetic bearings in output sentence ECAPB. Some autopilots, among them Simrad, require navigational bearings, contained in the APB sentence, to be transmitted as Magnetic bearings rather than as True bearings, OpenCPNs default. -

- -

Data Connections - Add and Remove

- -

-Two Buttons “Add Connections” and “Remove Connections”, to the right of the Connections window are the key to this whole tab. -

- -

-The enable choice at the start of each connection line, is handy to organize connections, but still only use those that are needed for the moment. Tick or un-tick, and then press “Apply”, to activate the setting. -

- -

-A connection can be used for input and output at the same time, with the reservation that they have to use the same Baud rate. For more details, read on. -

- -

-When pressing “Add Connections” two basic choices are given, a serial or a network connection. -

- -

Add a Serial Connection

- -

-DataPort: Pick a port by pressing the \/ o the right side of the field. If the port you are looking for does not appear in the selection, write the correct port yourself in this field. -

- -

-Baud Rate: This is normally 4800 for GPS and 38400 for AIS, but check the documentation for the connected device. It's important to get this right and not just guess. -

- -

-Protocol: For future use, as only NMEA 0183 works, for now. -

- -

-Priority: Higher number equals Higher priority. The priority is set for each NMEA sentence individually. As long as a higher priority stream is available it's used. If this fails the next stream in line, with lower priority, kicks in and is used, until a higher priority stream appears. The present filter does not handle the case where, for example position messages, are received from different sentences.As an example, GPGLL and GPRMC both transmits the position information. The last received of either message will be used. -

- -

-Control Checksum. At the end of each NMEA sentence is a checksum, that makes sure that sentences are correctly received. This box is ticked by default, as OpenCPN calculates the checksum and compares it to the received checksum. Only sentences with a valid checksum are passed through. Un-ticking may help, if an application calculates checksums incorrectly or if the checksums are missing. -

- -

-Use Garmin(GRMN) mode for input: Make sure that this box is ticked, if you have a Garmin GPS set to this mode. The reason is that Garmin uses their own serial protocol. -

- -

-Receive input on this Port Greyed out here as it only applies to a network connection. see more below. -

- -

-Output on this port (as Autopilot or NMEA repeater ): Tick this box if the connection will be used for output. A common case is sending NMEA to an Autopilot. * Talker ID solves the problem where some “temperamental” devices, which should accept given sentences irrespective of the talker ID, in fact only accept for example GPRMC and not ECRMC -

- -

-APB bearing precision is greyed out unless “Output on this port” is checked. APB is the NMEA sentence “Autopilot Sentence 'B'”. The precision can be set to between 0 and 4 decimals, were 3 is the default. Some autopilots requires a different precision than the default, to work. Check your AP documentation. -

Note: The APB bearing precision (or NMEAAPBPrecision in Opencpn.ini file) setting is set in the Options > Connections settings page for connections that have outgoing messages. The precision is applied in the src/nmea0183/ apb.cpp file and is applied to:
-
- CrossTrackErrorMagnitude
  -
- BearingOriginToDestination
  -
- BearingPresentPositionToDestination
  -
- HeadingToSteer
  -
-
This change was made as some auto pilots are limited in the precision they can accept in the APB message. So all other messages and internally the precision is not changed. There is no change to the XTE message as that was not requested at the time. “XTE - Measured cross track error” NMEA message, that is a part of the APB message is not adjusted by the APB bearing precision setting.
-

- -

Add a Network Connection

- -

Protocol : There are three choices of protocols TCP, UDP and GPSD.

- -

-TCP: is a “connection-oriented” protocol which provides a reliable link between two network endpoints. TCP ensures that any network packets lost in transit are re-transmitted. Internet AIS servers normally accept TCP connections as do many serial-to-network/wifi devices. -

- -

-To make a connection to a remote TCP server, enter its IP address or hostname in the “Address” box and the TCP port on which the server listens in the “DataPort” box. Many devices use a non-standard TCP port rather than OpenCPN's standard 10110, so do check the server's documentation. If “0.0.0.0” is entered in the Address box, OpenCPN will act as a TCP server accepting a connection from a remote TCP client. OpenCPN will listen on all its host computer's network interfaces for TCP connections to the port specified in the “DataPort” field. There should normally be no reason to select a “DataPort” value other than the standard 10110 unless multiple servers are required: -

In the current implementation a single data connection can accept only one client.
-
If multiple clients wish to connect to OpenCPN, a dedicated data connection must be provided for each and each data connection must have a different DataPort.
-

- -

-UDP: is a method of transmitting data as simple “datagrams” without negotiating a connection between two endpoints. It involves no detection and retransmission of data lost in the network. Within a small home/boat network such data loss should not normally occur and in any case, NMEA data is generally updated by “talkers” on a regular basis. Unlike TCP which involves a connection between two endpoints, UDP data may be received by many “listeners”. -

- -

-An OpenCPN UDP data connection will listen for data destined for the specified DataPort on any system interface or the broadcast address of any connected network. If you don't need to receive multicast data or transmit any data, you may enter “0.0.0.0” in the “Address” box if you are unsure of what to enter there. Alternatively you may specify the address on which you intend to receive data. In both cases behavior will be the same. If you wish to receive multicast data you must enter the multicast address to which those data are being sent or the system will not see them. If you wish to transmit any data (“Output on this port” checked) you must put the address you wish to send data to in the “Address” box. In all cases (transmit, receive or both) the DataPort must be specified. For more information about broadcast and multicast, see Broadcast and Multicast below. -

- -

-GPSD: is a Unix/Linux gps server, which means that several different applications can share one gps receiver. Linux users have the choice between using serial or GPSD connections for their gps input. -

Ubuntu users take note! If gpsd is installed - use it. If you prefer a serial connection, un-install gpsd. The reason is that gpsd starts automatically when,for example, an USB gps is connected. This will block the serial port that the gps communicates with( /dev/ttyUSB0 in many cases), hence no separate serial connection to the gps is possible. So it's an either or situation.
-
OpenCPN also has support for Windows clients. So a windows computer should be able to connect to GPSD running somewhere on a network (testing), as an alternative to an UDP connection, described earlier. * Address: The network address to connect to. In the example above we used the broadcast address for convenience, but specifying host to send to, and host to receive from, works as well.
-

- -

-Port: The port to connect to on the network address. The default port for UDP is 10110. Port 10110 is designated by IANA for “NMEA-0183 Navigational Data”. There should not be any reason to change this port, but it is possible. See below. The default port for GPSD is 2947. Do not change this! -

For your own local connections use port-numbers greater than 1023 and avoid ports used by other applications. Ports in the range 49152 through 65535 are not assigned to other applications and should be OK. Make sure that no firewall is blocking the port you pick.
-

- -

Network GPSD connection

- -

-When connecting to GPSD, running on your local computer, use the settings shown above. -

- -

Connections Filter

- -

-For each source line in the data connection windows, it's possible to specify exactly which NMEA sentences to receive, and which ones to drop. Similarly it's possible to control exactly which sentences to send out to, for example, an autopilot. -

- -

-The applied filters for each connection are stated in in the “Filters” column in the Data Connection window. The default for a connection is no filters at all. * The set filters applies to both the core program and the plugins. -

- -

-Filtering can be observed in real time, through color coding in the Debug Window. -

- -

-Accept only sentences: Either base your filtering on stating which sentences to accept or which to ignore. -

- -

-Ignore sentences: Same as above. To select filters press the button. The dialog below becomes available. -

- -

-A lot of NMEA sentences are listed. Just tick the box to select a sentence. “Select All” or “Clear All” are also available. For sentences not listed press “Add”, and enter a new NMEA sentence. -

- -

-Your entry must conform to these rules. -

- -

-When you are finished, press “OK”, your new entry will appear at the bottom of the list of NMEA sentences to filter. It will already be ticked, so just press “OK” until you are back in the original Connections tab. Now press “Apply”. The implemented filtering should now be visible on the connection line. For more, see below -

- -

-Receive input on this port: This box should be ticked if you want to receive receive data on this connection. If the connection will only be used to output to other devices it should not be ticked. If you wish to broadcast UDP data for consumption by other devices or programs, leaving this box unticked will save you having to worry setting the priority of the connection to avoid data loops. -

- -

-Output on this port (as Autopilot or NMEA repeater ): Tick this box if the connection will be used for output. A common case is sending NMEA to an Autopilot. * APB bearing precision is greyed out unless “Output on this port” is checked. APB is the NMEA sentence “Autopilot Sentence 'B'”. The precision can be set to between 0 and 4 decimals, were 3 is the default. Some autopilots requires a different precision than the default, to work. Check your AP documentation and see Note below. -

- -

-OpenCPN creates and sends the NMEA ECRMB and ECRMC sentences to the A/P output port when a route is activated. If variation is not otherwise present, OpenCPN includes variation, coming from the WMM plugin, if installed and enabled. -

- -

-Note: The “APB bearing precision” (or NMEAAPBPrecision in Opencpn.ini file) setting is set in the Connections settings page for connections that have outgoing messages. The precision is applied in the src/nmea0183/ apb.cpp file and is applied to: -

CrossTrackErrorMagnitude
-
BearingOriginToDestination
-
BearingPresentPositionToDestination
-
HeadingToSteer
-
This change was made as some auto pilots are limited in the precision they can accept in the APB message. So all other messages and internally the precision is not changed. There is no change to the XTE message as that was not requested at the time. “XTE - Measured cross track error” NMEA message, that is a part of the APB message is not adjusted by the APB bearing precision setting.
-

- -

- -{{opencpn:manual:action-filter.jpg?nolink&28x30}} -

- -

Input Filtering

- -

-Some examples to illustrate how things works. -

- -

-Accepting the filter above leads to this in the filter column on the connection line: -

- -

-
-If “Ignore sentences” is marked instead, the line looks like this:
- -

- -

Output Filtering

- -

-Similar to input filtering above.
- - -

- -

-Transmitting three sentences.
- - -

- -

-Another Example of Output Filtering
- -
- -Feature: Can now select the NMEA talker ID of sentences output by OpenCPN on a given port. -

- -

-Situation: OpenCPN (correctly) outputs its NMEA sentences with the “EC” talker ID as is normal and expected behavior (see below). -

- -

-Problem : Some “temperamental” devices which should accept given sentences irrespective of the talker ID in fact only accept for example GPRMC and not ECRMC. -

- -

-Example: An Icom VHF is a such example. and because the multiplexer has been set to give precedence to nav info provided by OpenCPN, rather than the GPS, the result is that when OpenCPN is driving the autopilot, the VHF does not receive any position anymore for its DSC feature. Safety-wise, this is not desirable. -

- -

-Solution: Being able to either change the ECRMC sentences into GPRMC, or duplicate ECRMC on the output port should solve the issue. -

- -

Send to GPS

- -

-
- -Dropping them instead. -

- -

Connection Notes

- -

-If you already have an application connected to your gps, on a serial port, OpenCPN will not be able to connect to the same port. Two applications cannot use a port simultaneously . __On Linux use Gpsd in such a situation. Of course this only works if your “other application” supports the Gpsd. As an alternative on Linux you can use Kplex (also for Mac) or Muplex which can create pseudo terminals (“virtual serial ports”) to share NMEA data between applications. -

- -

-If a NMEA sentence is filtered on an input connection and “LegacyInputCOMPortFilterBehaviour=1” setting in opencpn.conf|ini, it will still enter the internal multiplexer. So, it will be available to output connections, unless it's filtered there as well. If “LegacyInputCOMPortFilterBehaviour=0” then the message will not be placed on the internal multiplexer. This will only work for serial connections. Echoing back a network connection, on the input port for output, will not work -

NMEA data can also come from the VDR plugin. They will be labeled as such in the Debug Window and have “0” priority.
-

- -

-No Flow Control on Serial Ports By nature NMEA doesn't do flow control. If a message gets lost, it gets lost… It will be repeated at some point, and buffering a delayed message that has lost it's meaning, when there is more current & accurate data available is not useful. f interfacing the NMEA-specified way, there is no path for hardware flow control. It's not compatible with NMEA in any way. -

- -

Sending an Active Route to an Autopilot

- -

-Autopilot APB and XTE precision settings are harmonized to always be the same. -

- -

-On Route activation, OpenCPN sends the ECRMB, ECRMC and ECAPB NMEA sentences to an Auto Pilot, if it is connected to a port, with output activated. -

Implement configurable NMEA Talker ID
-
To test that the ECRMB, ECRMC & ECAPB sentences are being sent, simply set up a port with output activated and
-

- -

-Right-click on the chart and select “Navigate to here”, then bring up the Options > Connections > Nmea Debug window and look at the Blue output sentences for ECRMB, ECRMC and ECAPB. Below is one example of output connection settings. -

- -

-In the example above we have used NavMonPC to read a previously recorded nmea file, and then set up a Virtual Com Port (Com14) which OpenCPN Options > Connections to a Serial Com14 port is then established to read the nmea data stream from NavMonPC. -

- -

-When you send to the autopilot you should see blue output sentences in the Nmea Debug window, once the Options Menu is closed (very important, because all data is frozen until this menu is closed.) * Another way to test for the EC sentences see “Send to GPS” below. -

- -

Broadcast and Multicast

- -

-UDP data may be delivered to more than one system when sent to certain special addresses -

- -

-A “broadcast address” is listened to by all devices on a network. It is normally formed by taking the network address (the first part of the IP address common to all systems on your local network) and setting the last part (the number which is different for every computer) to a value represented by all “1”s in binary. If all your devices' addresses start with “192.168.1”, your network's broadcast address will likely be 192.168.1.255 (255 is “11111111” in binary. This is why IPv4 addresses written like this never contain numbers higher than 255. Except for in the movie “The Net” and we don't talk about that). If you specify an address ending with “255”, OpenCPN assumes you mean a broadcast address. This is not always true but will result in desired behaviour in almost all cases. -

- -

-The special broadcast address “255.255.255.255” is also listened to by all devices. It should not normally be used to transmit data from OpenCPN. Use your local network's broadcast address instead. -

- -

-A “multicast address” is listened to only by devices which wish to receive information on that address. IPv4 addresses in the range 224.0.0.0 - 239.255.255.255 are multicast addresses. If you specify a multicast address for a UDP data connection, OpenCPN will tell your computer to listen for datagrams on that address. * More than one system may send data to broadcast or multicast addresses, so this is a “many to many” communications medium. * You cannot use broadcast or multicast addresses with TCP. TCP is a “one to one” connection. -

- -

-Devices must to some extent process all broadcast packets on the network whether they are interested in them or not. Multicast packets are normally only seen by devices which have registered an interest in a particular multicast address. Consequently multicast is more efficient than broadcast although this is usually of little consequence in a small network. Despite being used by NMEA-over-IP protocols such as IEC 61162-4 and the forthcoming NMEA OneNet, NMEA-0183 over IP multicast is far less widely supported in marine applications than NMEA-0183 over IP broadcast. -

- -

-There is no multicast address mandated for NMEA-0183 data in this context although you should avoid those addresses used by other protocols. -

- -

-When using multicast with OpenCPN it is suggested that an address be used in the range 239.192.0.0/14 specified by RFC 2365 as the “Organization Local Scope”. If in doubt, try 239.194.4.4. -

- -

-There is no mechanism in OpenCPN to specify the network interface through which multicast packets are sent or received. This will be determined by your system. In some cases it may be necessary to manually adjust your system's routing table to ensure that the desired network interface is used. Refer to your system's documentation if this proves necessary. -

- -

-If you transmit UDP broadcast or multicast, then you should set the priority of the “real” NMEA input to something higher than the UDP stream. If not, prepare for problems. The reason is that if you are broadcasting, then you yourself will get the UDP message as well, which again will be retransmitted…… Obviously, it duplicates the “real” incoming data. Thus we get source priority flip-flop on each message, since they have the same priority. For example set the UDP priority to “0” and real incoming connection to “1” or higher. Multicast loopback is not disabled for consistency with broadcast behaviour. This means that priorities must be set as detailed above when transmitting over multicast, but multicast communication between multiple instances of OpenCPN on the same system remains possible. * The firewalls on some systems (e.g. OpenSuSE linux) may block broadcast and multicast data that you wish to receive. Refer to your system's documentation to determine how to allow such data to reach OpenCPN. -

- -

-Also read about the “Activating Routes and Active Route Console” in Marks and Routes towards the bottom. It is essential to have turned on an Active Route in order to send waypoints to the Autopilot. -

- -

-Also read about “Route to Autopilot” in Advanced Features for more details. -

- -

Sending Routes and Waypoints to a GPS

- -

-The feature “Send to GPS”, which appears in the right click menus for waypoints and routes and in the Route Manager, is not linked to connections. The upload port does not even need to appear in the Datastream connections list. Its a completely separate concept. For this reason users must define a separate upload port, that is remembered by OpenCPN. The port can be changed by clicking the button in the Route Manager. -

- -

-NMEA provides no handshake protocol for Route and Waypoint upload. So, OpenCPN simply sends the Route/WP information out on the port, without having any way to know if there is actually a device connected to the port. -

- -

-The Garmin protocol does provide handshaking, so OpenCPN can be sure that the information is uploaded correctly. The Garmin protocol will fail if the device is not a Garmin. -

- -

-In the case of standard NMEA, the indication “Route successfully uploaded” is not very meaningful. You can say that it just means that a port was found, and writing to that port succeeded. -

- -

-In the case of “hockey puck” GPS receivers, they probably ignore Route and WP uploads, since there is nothing for them to do with this information anyway. -

- -

-The key to remember is that Route and Waypoint upload process is completely independent of normal running Datastream operation. They are two separate sub-systems. -

- -

-It does no harm to assign the Datastream GPS port as an output and input device together. Some users might reasonably expect that this would be required for Route and W/P uploads. Most GPS receivers would ignore input sentences other than Route and W/P uploads anyway. -

- -

-Then in the Chart window we hover over the temporary goto waypoint and right click, then select “Send to GPS (Serial Com 14)” and by quickly looking at the NMEA Debug window (Options > Connections > Check Nmea Debug Window, then be sure to CLOSE the Connections Menu leaving the Nmea Debug Window up, or nothing will happen!). Then you will see the sentences sent. See screenshot below. -

- -

Note the active route above was a 4 point route, but the active leg and active wp was the 3rd point for the above screen.
-

- -

Note the screenshot above is for the same Active Route, but the active waypoint is the 2nd point.
-
Note: There are many technigues for testing and simulation. Using NavMonPC to read a previously recorded file is one very good way. The other is to use OpenCPN's VDR_pi to read the nmea file, which is in some respects simpler for a new user.
-

- -

NOTES

- -

Win 8.1 com ports stop working

- -

-Refer to http://willkamp.com/opencpn/flyspray/index.php?do=details&task_id=1706 Check the cables and connectors and for USB Port timeout. How to Add or Remove “USB 3 Link Power Mangement” in Power Options in Windows 8 http://www.eightforums.com/tutorials/50276-power-options-add-remove-usb-3-link-power-mangement.html http://helpdeskgeek.com/windows-xp-tips/prevent-windows-from-powering-off-usb-device/ -

- -

UDP Protocol vs TCP Protocol

- -

-UDP is a method of transmitting data as simple “datagrams” without negotiating a connection between two endpoints. It involves no detection and retransmission of data lost in the network. Within a small home/boat network such data loss should not normally occur and in any case, NMEA data is generally updated by “talkers” on a regular basis. Unlike TCP which involves a connection between two endpoints, UDP data may be received by many “listeners”. -

- -

-UDP “For UDP mode the IP address 127.0.0.1 is also known as localhost and used when sending to a client on the same machine. The IP address of any other machine on the network may be given.” -

- -

-To reach all machines within a local network, like a wifi router, use the address 192.168.x.255 with the Protocol set at UDP. -

  Example for a local net where the router address is 192.168.1.0:
-  python VDRplayer.py Hakefjord.txt 192.168.1.255 10110 0.05 UDP
-  Any receiving machine can then use IP address 0.0.0.0 and port 10110 in the connection properties

- -

-TCP For TCP mode the IP address is the address of the machine running VDRplayer. It may be localhost or 127.0.0.1 if the client is running on the same machine. -

- -

-If VDRplayer is running on its own machine then give the IP address: of that machine that other clients can reach (e.g. 192.168.1.6 assuming that is the address of the machine running VDRplayer.py). -

- -

-The Port Number: 10110 is somewhat arbitrary but it is the “undocumented standard” for NMEA over IP and must match the client receiver port number. Any port number permitted by the local firewall will work. It is best not to use well known port numbers such as 80, 22, etc. -

- -

-The time delay of 0.05 (50mS) is the delay between each line in the file. -

- -

-UDP received When adding a network connection for UDP receive there is no need to specify the IP address. The port is required but not the IP address. The sending end needs to specify both IP address and port number. -

- -

- - -

- - + + + + + opencpn:opencpn_user_manual:options_setting:connections + + + + + + + + + + + + + + + + + + + + + +

+ + + +

The Connections

+ +

Features and Improvements

+ +

+NMEA Sentences moved to “Advanced Features” +

+ +

+OpenCPN version 3.2 featured a complete redesign of the NMEA message handling structure, including a new GUI and monitor window. This feature has been further improved and tuned in version 4.2. The current scheme provides extensive NMEA management capabilities, including: +

Input message filtering, by TALKER ID and/or message type.
+
Implement configurable NMEA Talker ID.
+
Virtually unlimited input port multiplexing, with shared I/O and individual data rate settings.
+
Selective message echo capability, similar to third-party mux applications.
+
Programmable output port messages, for e.g. autopilot interfaces.
+
Full Network input and output, including TCP, UDP, and GPSD services.
+
GPSD client support for Windows platforms.
+

+ +

+Linux Serial Connections
+ +Connections Window
+ +Example Data Connections Window
+ +Filter NMEA Course and Speed Data
+ +Show NMEA Debug Window
+ +Data Connections - Add and Remove
+ +Add a Serial Connection
+ +Add a Network Connection
+ +Network GPSD connection
+ +Connections Filter
+ +Input Filtering
+ +Output Filtering
+ +Connection Notes
+ +Sending an Active Route to an Autopilot
+ +Sending Routes and Waypoints to a GPS
+ +Broadcast and Multicast
+ +

+ +

Linux Serial Connections

+ +

+Make sure that you belong to the “dialout” group. To find out, run the “$groups” command. If you're not in “dialout”, add yourself with the command “$sudo usermod -a -G dialout $USER”. Logout of your current session for group changes to take effect. Check this straight away, it will save you from frustration later on. If there is a problem connecting the GPS to a physical port, such as /dev/ttyS0, the reason is probably that you don't belong to “dialout”. OpenCPN will display a warning, once per session, if you try to configure a serial connection, or starts the program with an active serial connection, and don't belong to the right group. +

+ +

+Red Hat based Linux versions are using the “uucp” group. Check what applies to your version of Linux, by using the return from the command stat -c %G `ls /dev/*|grep -m1 tty[A-Z,a-z][0] If the return is “root”, upgrade to a contemporary Linux version. +

+ +

Connections Window

+ +

+All this is different from the logic in earlier versions of OpenCPN. From version 3.2, there is no defined “autopilot” port. The autopilot is simply connected to any available output- enabled data-stream, and gets everything on the bus, subject to user specified output filtering. There is no specific “shared” AIS and GPS port, as all ports are shared. +

+ +

+
+ + +

+ +

+The key point to keep in mind with this new setup is the complete orthogonality between message sources, message destinations, and transport media. All messages come and go from an internal “bus”, and all internal modules have access to all messages. Any message can be received, and possibly re-transmitted according to the configuration established. If the messages get onto the bus, +

+ +

+OpenCPN will do the right thing. For example, if it is an AIS message, the AIS module will get the message and act accordingly. Plugins also get all messages. +

+ +

Example Data Connections Window

+ +

+To get a taste of what can be done, we start with a lab scenario. In the screen-shot above, four Data Ports are enabled. +

GPSD on localhost port 2947
+
/dev/ttyUSB1 as ais port
+
output port to a computer on the local network
+
San Fransisco AIS feed.
+

+ +

+Note that the connections are automatically sorted in order of the priority setting The picture is from a Linux computer, but the receiving box is an Win XP. Both boxes are configured to use the same broadcasting address '192.168.0.255' on the local network, using the default 10110 port. Note that UDP, and not TCP, is used. OpenCPN on the XP box receives and shows all info from the three first ports and even data from the VDR plugin, if it's running. All input sources are merged together and available to transmit to an external computer. Every computer on-board can be used as a repeater to the main box! +

+ +

+Note that in this scenario the UDP connection is output only. In previous releases of OpenCPN all UDP data connections would read data as well as write. This is a possible configuration in the current release but neither required nor generally desirable. If a broadcast connection is read/write, all data written will be read back leading to the potential for data loops. +

To avoid this, the priority of any read/write broadcast connection should be set lower than that of any other interface on which OpenCPN receives data for re-distribution over that interface.
+
For most purposes setting a broadcast connection to either read or write is the preferable solution.
+
The San Francisco AIS feed has now changed to ip address 76.103.90.196, also on port 9009.
+

+ +

+There is no advantage to using a broadcast address on the local network with just a few computers. It's as easy to just specify the addresses of the receiving computers as outgoing connections on the transmitting computer. The “receivers” specify the “transmitter” as address for a connection. +

+ +

+In real life, a common setup will include input from GPS, AIS and output to an Autopilot. If your GPS produces GPRMC, then this will be automatically shipped to the autopilot. +

Everything on the internal multiplex bus will be sent to the output port that the autopilot is connected to, even if a route is inactive.
+
If, a route is active, OpenCPN will create and send NMEA (EC)RMC sentences to output data ports.
+
The only reason OpenCPN “synthesize” an ECRMC sentence is to cover those odd cases when there is no other source of RMC in the system, and the Autopilot wants variation, SOG, etc. This might be the case if an older GPS produces GPGLL alone, for instance, which has no var. There is no “new” information in the transmitted, synthesized ECRMC.
+
The autopilot might be complaining that it is getting RMC information from two different talkers (GP and EC) at the same time, and cannot decide what to do. The easiest solution if don't like the ECRMC, is to filter it out of the output stream of the port connected to the autopilot. Or choose a filter to allow only GPRMC and ECRMB for this port.
+

+ +

Filter NMEA Course and Speed Data

+ +

+Providing a rolling average of COG/SOG, with configurable sampling period. This feature is useful, for example, if you find that course and speed from the gps is varying erratically due to the sea state. The Dashboard plugin is not affected by this setting - COG and SOG are updated about once per second. +

+ +

Show NMEA Debug Window

+ +

+If you check this box you will get a window that shows the NMEA data sentences coming into or going out from OpenCPN. In the picture above we can see the color-coding at work. Messages in red could occur as well, and indicates a transmit error. Connections Priority change messages, will also be printed to the NMEA Debug Window. The reason that AIVDM messages are both dropped and appear as “Output message”, is that there is more than one source for this message, and the filter just applies to one source. +

+ +

+Have a look at the page NMEA Sentences to see which messages are understood. OpenCPN generally does not care about the Talker ID, the first two letters in the message type. $GPGGA above, is the talker GP = the gps, sending a GGA = position message, for example. At the end of each sentence there is a “*” followed by a calculated checksum. +

+ +

+To see all messages it's important to close the Options dialog completely, while leaving the NMEA Debug window open. The ECAPB sentences etc, will not appear while the Connections dialog box is open as autopilot output is disabled during this time. +

+ +

+Known issues: The pause button only works if the main Options dialog is closed. In Linux, the debug window can only be closed by unticking the Show NMEA Debug Window box, unless the the main Options dialog is closed. +

+ +

+If there are NMEA sentences in the debug window, then OpenCPN has opened the port set in the Data Connections. Note that the source of each NMEA sentence is printed after the time stamp o each line. If your GPS port is configured, and there is no “red” boat, then the only reasons are: no gps fix or wrong sentence configuration from the GPS. +

+ +

+Messages originating from GPSD or the VDR (Voyage Data Recorder plugin) will also show up in the debug window. +

+ +

+For simple NMEA data stream debugging, add the following to your opencpn.ini file:Under [Settings] add a line DebugNMEA=1500 This will provide up to 1500 debug messages pertaining to NMEA traffic to the opencpn.log. +

+ +

+Format uploads for FurunoGP3Xinputfiltering: If the special Furuno gps protocol is needed, tick this box. The reason is that Furuno uses their own version of NMEA for uploading routes. Furuno GPS users take note. It is now allowed to use a numeric, two digit OpenCPN route name (e.g. 10, 21, etc). +

+ +

+Use GarminGRMN (Host) mode for uploads. Make sure that this box is ticked, if you have a Garmin GPS. The reason for this is that Garmin units cannot accept route uploads via standard NMEA0183. This is a “design feature” of all Garmin receivers. +

+ +

+Use magnetic bearings in output sentence ECAPB. Some autopilots, among them Simrad, require navigational bearings, contained in the APB sentence, to be transmitted as Magnetic bearings rather than as True bearings, OpenCPNs default. +

+ +

Data Connections - Add and Remove

+ +

+Two Buttons “Add Connections” and “Remove Connections”, to the right of the Connections window are the key to this whole tab. +

+ +

+The enable choice at the start of each connection line, is handy to organize connections, but still only use those that are needed for the moment. Tick or un-tick, and then press “Apply”, to activate the setting. +

+ +

+A connection can be used for input and output at the same time, with the reservation that they have to use the same Baud rate. For more details, read on. +

+ +

+When pressing “Add Connections” two basic choices are given, a serial or a network connection. +

+ +

Add a Serial Connection

+ +

+DataPort: Pick a port by pressing the \/ o the right side of the field. If the port you are looking for does not appear in the selection, write the correct port yourself in this field. +

+ +

+Baud Rate: This is normally 4800 for GPS and 38400 for AIS, but check the documentation for the connected device. It's important to get this right and not just guess. +

+ +

+Protocol: For future use, as only NMEA 0183 works, for now. +

+ +

+Priority: Higher number equals Higher priority. The priority is set for each NMEA sentence individually. As long as a higher priority stream is available it's used. If this fails the next stream in line, with lower priority, kicks in and is used, until a higher priority stream appears. The present filter does not handle the case where, for example position messages, are received from different sentences.As an example, GPGLL and GPRMC both transmits the position information. The last received of either message will be used. +

+ +

+Control Checksum. At the end of each NMEA sentence is a checksum, that makes sure that sentences are correctly received. This box is ticked by default, as OpenCPN calculates the checksum and compares it to the received checksum. Only sentences with a valid checksum are passed through. Un-ticking may help, if an application calculates checksums incorrectly or if the checksums are missing. +

+ +

+Use Garmin(GRMN) mode for input: Make sure that this box is ticked, if you have a Garmin GPS set to this mode. The reason is that Garmin uses their own serial protocol. +

+ +

+Receive input on this Port Greyed out here as it only applies to a network connection. see more below. +

+ +

+Output on this port (as Autopilot or NMEA repeater ): Tick this box if the connection will be used for output. A common case is sending NMEA to an Autopilot. * Talker ID solves the problem where some “temperamental” devices, which should accept given sentences irrespective of the talker ID, in fact only accept for example GPRMC and not ECRMC +

+ +

+APB bearing precision is greyed out unless “Output on this port” is checked. APB is the NMEA sentence “Autopilot Sentence 'B'”. The precision can be set to between 0 and 4 decimals, were 3 is the default. Some autopilots requires a different precision than the default, to work. Check your AP documentation. +

Note: The APB bearing precision (or NMEAAPBPrecision in Opencpn.ini file) setting is set in the Options > Connections settings page for connections that have outgoing messages. The precision is applied in the src/nmea0183/ apb.cpp file and is applied to:
+
- CrossTrackErrorMagnitude
  +
- BearingOriginToDestination
  +
- BearingPresentPositionToDestination
  +
- HeadingToSteer
  +
+
This change was made as some auto pilots are limited in the precision they can accept in the APB message. So all other messages and internally the precision is not changed. There is no change to the XTE message as that was not requested at the time. “XTE - Measured cross track error” NMEA message, that is a part of the APB message is not adjusted by the APB bearing precision setting.
+

+ +

Add a Network Connection

+ +

Protocol : There are three choices of protocols TCP, UDP and GPSD.

+ +

+TCP: is a “connection-oriented” protocol which provides a reliable link between two network endpoints. TCP ensures that any network packets lost in transit are re-transmitted. Internet AIS servers normally accept TCP connections as do many serial-to-network/wifi devices. +

+ +

+To make a connection to a remote TCP server, enter its IP address or hostname in the “Address” box and the TCP port on which the server listens in the “DataPort” box. Many devices use a non-standard TCP port rather than OpenCPN's standard 10110, so do check the server's documentation. If “0.0.0.0” is entered in the Address box, OpenCPN will act as a TCP server accepting a connection from a remote TCP client. OpenCPN will listen on all its host computer's network interfaces for TCP connections to the port specified in the “DataPort” field. There should normally be no reason to select a “DataPort” value other than the standard 10110 unless multiple servers are required: +

In the current implementation a single data connection can accept only one client.
+
If multiple clients wish to connect to OpenCPN, a dedicated data connection must be provided for each and each data connection must have a different DataPort.
+

+ +

+UDP: is a method of transmitting data as simple “datagrams” without negotiating a connection between two endpoints. It involves no detection and retransmission of data lost in the network. Within a small home/boat network such data loss should not normally occur and in any case, NMEA data is generally updated by “talkers” on a regular basis. Unlike TCP which involves a connection between two endpoints, UDP data may be received by many “listeners”. +

+ +

+An OpenCPN UDP data connection will listen for data destined for the specified DataPort on any system interface or the broadcast address of any connected network. If you don't need to receive multicast data or transmit any data, you may enter “0.0.0.0” in the “Address” box if you are unsure of what to enter there. Alternatively you may specify the address on which you intend to receive data. In both cases behavior will be the same. If you wish to receive multicast data you must enter the multicast address to which those data are being sent or the system will not see them. If you wish to transmit any data (“Output on this port” checked) you must put the address you wish to send data to in the “Address” box. In all cases (transmit, receive or both) the DataPort must be specified. For more information about broadcast and multicast, see Broadcast and Multicast below. +

+ +

+GPSD: is a Unix/Linux gps server, which means that several different applications can share one gps receiver. Linux users have the choice between using serial or GPSD connections for their gps input. +

Ubuntu users take note! If gpsd is installed - use it. If you prefer a serial connection, un-install gpsd. The reason is that gpsd starts automatically when,for example, an USB gps is connected. This will block the serial port that the gps communicates with( /dev/ttyUSB0 in many cases), hence no separate serial connection to the gps is possible. So it's an either or situation.
+
OpenCPN also has support for Windows clients. So a windows computer should be able to connect to GPSD running somewhere on a network (testing), as an alternative to an UDP connection, described earlier. * Address: The network address to connect to. In the example above we used the broadcast address for convenience, but specifying host to send to, and host to receive from, works as well.
+

+ +

+Port: The port to connect to on the network address. The default port for UDP is 10110. Port 10110 is designated by IANA for “NMEA-0183 Navigational Data”. There should not be any reason to change this port, but it is possible. See below. The default port for GPSD is 2947. Do not change this! +

For your own local connections use port-numbers greater than 1023 and avoid ports used by other applications. Ports in the range 49152 through 65535 are not assigned to other applications and should be OK. Make sure that no firewall is blocking the port you pick.
+

+ +

Network GPSD connection

+ +

+When connecting to GPSD, running on your local computer, use the settings shown above. +

+ +

Connections Filter

+ +

+For each source line in the data connection windows, it's possible to specify exactly which NMEA sentences to receive, and which ones to drop. Similarly it's possible to control exactly which sentences to send out to, for example, an autopilot. +

+ +

+The applied filters for each connection are stated in in the “Filters” column in the Data Connection window. The default for a connection is no filters at all. * The set filters applies to both the core program and the plugins. +

+ +

+Filtering can be observed in real time, through color coding in the Debug Window. +

+ +

+Accept only sentences: Either base your filtering on stating which sentences to accept or which to ignore. +

+ +

+Ignore sentences: Same as above. To select filters press the button. The dialog below becomes available. +

+ +

+A lot of NMEA sentences are listed. Just tick the box to select a sentence. “Select All” or “Clear All” are also available. For sentences not listed press “Add”, and enter a new NMEA sentence. +

+ +

+Your entry must conform to these rules. +

+ +

+When you are finished, press “OK”, your new entry will appear at the bottom of the list of NMEA sentences to filter. It will already be ticked, so just press “OK” until you are back in the original Connections tab. Now press “Apply”. The implemented filtering should now be visible on the connection line. For more, see below +

+ +

+Receive input on this port: This box should be ticked if you want to receive receive data on this connection. If the connection will only be used to output to other devices it should not be ticked. If you wish to broadcast UDP data for consumption by other devices or programs, leaving this box unticked will save you having to worry setting the priority of the connection to avoid data loops. +

+ +

+Output on this port (as Autopilot or NMEA repeater ): Tick this box if the connection will be used for output. A common case is sending NMEA to an Autopilot. * APB bearing precision is greyed out unless “Output on this port” is checked. APB is the NMEA sentence “Autopilot Sentence 'B'”. The precision can be set to between 0 and 4 decimals, were 3 is the default. Some autopilots requires a different precision than the default, to work. Check your AP documentation and see Note below. +

+ +

+OpenCPN creates and sends the NMEA ECRMB and ECRMC sentences to the A/P output port when a route is activated. If variation is not otherwise present, OpenCPN includes variation, coming from the WMM plugin, if installed and enabled. +

+ +

+Note: The “APB bearing precision” (or NMEAAPBPrecision in Opencpn.ini file) setting is set in the Connections settings page for connections that have outgoing messages. The precision is applied in the src/nmea0183/ apb.cpp file and is applied to: +

CrossTrackErrorMagnitude
+
BearingOriginToDestination
+
BearingPresentPositionToDestination
+
HeadingToSteer
+
This change was made as some auto pilots are limited in the precision they can accept in the APB message. So all other messages and internally the precision is not changed. There is no change to the XTE message as that was not requested at the time. “XTE - Measured cross track error” NMEA message, that is a part of the APB message is not adjusted by the APB bearing precision setting.
+

+ +

+{{opencpn:manual:action-filter.jpg?nolink&28x30}} +

+ +

Input Filtering

+ +

+Some examples to illustrate how things works. +

+ +

+Accepting the filter above leads to this in the filter column on the connection line: +

+ +

+
+If “Ignore sentences” is marked instead, the line looks like this:
+ +

+ +

Output Filtering

+ +

+Similar to input filtering above.
+ + +

+ +

+Transmitting three sentences.
+ + +

+ +

+Another Example of Output Filtering
+ +
+ +Feature: Can now select the NMEA talker ID of sentences output by OpenCPN on a given port. +

+ +

+Situation: OpenCPN (correctly) outputs its NMEA sentences with the “EC” talker ID as is normal and expected behavior (see below). +

+ +

+Problem : Some “temperamental” devices which should accept given sentences irrespective of the talker ID in fact only accept for example GPRMC and not ECRMC. +

+ +

+Example: An Icom VHF is a such example. and because the multiplexer has been set to give precedence to nav info provided by OpenCPN, rather than the GPS, the result is that when OpenCPN is driving the autopilot, the VHF does not receive any position anymore for its DSC feature. Safety-wise, this is not desirable. +

+ +

+Solution: Being able to either change the ECRMC sentences into GPRMC, or duplicate ECRMC on the output port should solve the issue. +

+ +

Send to GPS

+ +

+
+ +Dropping them instead. +

+ +

Connection Notes

+ +

+If you already have an application connected to your gps, on a serial port, OpenCPN will not be able to connect to the same port. Two applications cannot use a port simultaneously . __On Linux use Gpsd in such a situation. Of course this only works if your “other application” supports the Gpsd. As an alternative on Linux you can use Kplex (also for Mac) or Muplex which can create pseudo terminals (“virtual serial ports”) to share NMEA data between applications. +

+ +

+If a NMEA sentence is filtered on an input connection and “LegacyInputCOMPortFilterBehaviour=1” setting in opencpn.conf|ini, it will still enter the internal multiplexer. So, it will be available to output connections, unless it's filtered there as well. If “LegacyInputCOMPortFilterBehaviour=0” then the message will not be placed on the internal multiplexer. This will only work for serial connections. Echoing back a network connection, on the input port for output, will not work +

NMEA data can also come from the VDR plugin. They will be labeled as such in the Debug Window and have “0” priority.
+

+ +

+No Flow Control on Serial Ports By nature NMEA doesn't do flow control. If a message gets lost, it gets lost… It will be repeated at some point, and buffering a delayed message that has lost it's meaning, when there is more current & accurate data available is not useful. f interfacing the NMEA-specified way, there is no path for hardware flow control. It's not compatible with NMEA in any way. +

+ +

Sending an Active Route to an Autopilot

+ +

+Autopilot APB and XTE precision settings are harmonized to always be the same. +

+ +

+On Route activation, OpenCPN sends the ECRMB, ECRMC and ECAPB NMEA sentences to an Auto Pilot, if it is connected to a port, with output activated. +

Implement configurable NMEA Talker ID
+
To test that the ECRMB, ECRMC & ECAPB sentences are being sent, simply set up a port with output activated and
+

+ +

+Right-click on the chart and select “Navigate to here”, then bring up the Options > Connections > Nmea Debug window and look at the Blue output sentences for ECRMB, ECRMC and ECAPB. Below is one example of output connection settings. +

+ +

+In the example above we have used NavMonPC to read a previously recorded nmea file, and then set up a Virtual Com Port (Com14) which OpenCPN Options > Connections to a Serial Com14 port is then established to read the nmea data stream from NavMonPC. +

+ +

+When you send to the autopilot you should see blue output sentences in the Nmea Debug window, once the Options Menu is closed (very important, because all data is frozen until this menu is closed.) * Another way to test for the EC sentences see “Send to GPS” below. +

+ +

Broadcast and Multicast

+ +

+UDP data may be delivered to more than one system when sent to certain special addresses +

+ +

+A “broadcast address” is listened to by all devices on a network. It is normally formed by taking the network address (the first part of the IP address common to all systems on your local network) and setting the last part (the number which is different for every computer) to a value represented by all “1”s in binary. If all your devices' addresses start with “192.168.1”, your network's broadcast address will likely be 192.168.1.255 (255 is “11111111” in binary. This is why IPv4 addresses written like this never contain numbers higher than 255. Except for in the movie “The Net” and we don't talk about that). If you specify an address ending with “255”, OpenCPN assumes you mean a broadcast address. This is not always true but will result in desired behaviour in almost all cases. +

+ +

+The special broadcast address “255.255.255.255” is also listened to by all devices. It should not normally be used to transmit data from OpenCPN. Use your local network's broadcast address instead. +

+ +

+A “multicast address” is listened to only by devices which wish to receive information on that address. IPv4 addresses in the range 224.0.0.0 - 239.255.255.255 are multicast addresses. If you specify a multicast address for a UDP data connection, OpenCPN will tell your computer to listen for datagrams on that address. * More than one system may send data to broadcast or multicast addresses, so this is a “many to many” communications medium. * You cannot use broadcast or multicast addresses with TCP. TCP is a “one to one” connection. +

+ +

+Devices must to some extent process all broadcast packets on the network whether they are interested in them or not. Multicast packets are normally only seen by devices which have registered an interest in a particular multicast address. Consequently multicast is more efficient than broadcast although this is usually of little consequence in a small network. Despite being used by NMEA-over-IP protocols such as IEC 61162-4 and the forthcoming NMEA OneNet, NMEA-0183 over IP multicast is far less widely supported in marine applications than NMEA-0183 over IP broadcast. +

+ +

+There is no multicast address mandated for NMEA-0183 data in this context although you should avoid those addresses used by other protocols. +

+ +

+When using multicast with OpenCPN it is suggested that an address be used in the range 239.192.0.0/14 specified by RFC 2365 as the “Organization Local Scope”. If in doubt, try 239.194.4.4. +

+ +

+There is no mechanism in OpenCPN to specify the network interface through which multicast packets are sent or received. This will be determined by your system. In some cases it may be necessary to manually adjust your system's routing table to ensure that the desired network interface is used. Refer to your system's documentation if this proves necessary. +

+ +

+If you transmit UDP broadcast or multicast, then you should set the priority of the “real” NMEA input to something higher than the UDP stream. If not, prepare for problems. The reason is that if you are broadcasting, then you yourself will get the UDP message as well, which again will be retransmitted…… Obviously, it duplicates the “real” incoming data. Thus we get source priority flip-flop on each message, since they have the same priority. For example set the UDP priority to “0” and real incoming connection to “1” or higher. Multicast loopback is not disabled for consistency with broadcast behaviour. This means that priorities must be set as detailed above when transmitting over multicast, but multicast communication between multiple instances of OpenCPN on the same system remains possible. * The firewalls on some systems (e.g. OpenSuSE linux) may block broadcast and multicast data that you wish to receive. Refer to your system's documentation to determine how to allow such data to reach OpenCPN. +

+ +

+Also read about the “Activating Routes and Active Route Console” in Marks and Routes towards the bottom. It is essential to have turned on an Active Route in order to send waypoints to the Autopilot. +

+ +

+Also read about “Route to Autopilot” in Advanced Features for more details. +

+ +

Sending Routes and Waypoints to a GPS

+ +

+The feature “Send to GPS”, which appears in the right click menus for waypoints and routes and in the Route Manager, is not linked to connections. The upload port does not even need to appear in the Datastream connections list. Its a completely separate concept. For this reason users must define a separate upload port, that is remembered by OpenCPN. The port can be changed by clicking the button in the Route Manager. +

+ +

+NMEA provides no handshake protocol for Route and Waypoint upload. So, OpenCPN simply sends the Route/WP information out on the port, without having any way to know if there is actually a device connected to the port. +

+ +

+The Garmin protocol does provide handshaking, so OpenCPN can be sure that the information is uploaded correctly. The Garmin protocol will fail if the device is not a Garmin. +

+ +

+In the case of standard NMEA, the indication “Route successfully uploaded” is not very meaningful. You can say that it just means that a port was found, and writing to that port succeeded. +

+ +

+In the case of “hockey puck” GPS receivers, they probably ignore Route and WP uploads, since there is nothing for them to do with this information anyway. +

+ +

+The key to remember is that Route and Waypoint upload process is completely independent of normal running Datastream operation. They are two separate sub-systems. +

+ +

+It does no harm to assign the Datastream GPS port as an output and input device together. Some users might reasonably expect that this would be required for Route and W/P uploads. Most GPS receivers would ignore input sentences other than Route and W/P uploads anyway. +

+ +

+Then in the Chart window we hover over the temporary goto waypoint and right click, then select “Send to GPS (Serial Com 14)” and by quickly looking at the NMEA Debug window (Options > Connections > Check Nmea Debug Window, then be sure to CLOSE the Connections Menu leaving the Nmea Debug Window up, or nothing will happen!). Then you will see the sentences sent. See screenshot below. +

+ +

Note the active route above was a 4 point route, but the active leg and active wp was the 3rd point for the above screen.
+

+ +

Note the screenshot above is for the same Active Route, but the active waypoint is the 2nd point.
+
Note: There are many technigues for testing and simulation. Using NavMonPC to read a previously recorded file is one very good way. The other is to use OpenCPN's VDR_pi to read the nmea file, which is in some respects simpler for a new user.
+

+ +

NOTES

+ +

Win 8.1 com ports stop working

+ +

+Refer to http://willkamp.com/opencpn/flyspray/index.php?do=details&task_id=1706 Check the cables and connectors and for USB Port timeout. How to Add or Remove “USB 3 Link Power Mangement” in Power Options in Windows 8 http://www.eightforums.com/tutorials/50276-power-options-add-remove-usb-3-link-power-mangement.html http://helpdeskgeek.com/windows-xp-tips/prevent-windows-from-powering-off-usb-device/ +

+ +

UDP Protocol vs TCP Protocol

+ +

+UDP is a method of transmitting data as simple “datagrams” without negotiating a connection between two endpoints. It involves no detection and retransmission of data lost in the network. Within a small home/boat network such data loss should not normally occur and in any case, NMEA data is generally updated by “talkers” on a regular basis. Unlike TCP which involves a connection between two endpoints, UDP data may be received by many “listeners”. +

+ +

+UDP “For UDP mode the IP address 127.0.0.1 is also known as localhost and used when sending to a client on the same machine. The IP address of any other machine on the network may be given.” +

+ +

+To reach all machines within a local network, like a wifi router, use the address 192.168.x.255 with the Protocol set at UDP. +

  Example for a local net where the router address is 192.168.1.0:
+  python VDRplayer.py Hakefjord.txt 192.168.1.255 10110 0.05 UDP
+  Any receiving machine can then use IP address 0.0.0.0 and port 10110 in the connection properties

+ +

+TCP For TCP mode the IP address is the address of the machine running VDRplayer. It may be localhost or 127.0.0.1 if the client is running on the same machine. +

+ +

+If VDRplayer is running on its own machine then give the IP address: of that machine that other clients can reach (e.g. 192.168.1.6 assuming that is the address of the machine running VDRplayer.py). +

+ +

+The Port Number: 10110 is somewhat arbitrary but it is the “undocumented standard” for NMEA over IP and must match the client receiver port number. Any port number permitted by the local firewall will work. It is best not to use well known port numbers such as 80, 22, etc. +

+ +

+The time delay of 0.05 (50mS) is the delay between each line in the file. +

+ +

+UDP received When adding a network connection for UDP receive there is no need to specify the IP address. The port is required but not the IP address. The sending end needs to specify both IP address and port number. +

+ +

+ + +

+ + diff -Nru opencpn-doc-4.8.10129.2/doc/options_setting/display.html opencpn-doc-4.8.2.0/doc/options_setting/display.html --- opencpn-doc-4.8.10129.2/doc/options_setting/display.html 2018-01-30 12:28:30.000000000 +0000 +++ opencpn-doc-4.8.2.0/doc/options_setting/display.html 2018-02-07 14:43:14.000000000 +0000 @@ -1,539 +1,539 @@ - - - - - opencpn:opencpn_user_manual:options_setting:display - - - - - - - - - - - - - - - - - - - - - -

- - - -

The Display

- -

General

- -

Navigation Modes

- -

North Up /Course Up

- -

-North Up is the normal way charts are shown, with north at the top. Course Up rotates the chart so what you see in front of the boat in real life is above the Own Ship icon on the display. -

- -

Lookahead Mode

- -

-The Own Ship icon will be offset from the center of the screen so that more of the chart is in front of Own Ship than behind. Read more in Auto Follow and Display Orientation -

- -

Chart Display

- -

Enable Chart Quilting

- -

-The screen shows several charts seamlessly stitched together. More in Chart Quilting . -

- -

Preserve scale when switching charts

- -

-Normally when switching charts OpenCPN will open the new chart scaled close to it's natural scale, the zoom factor stays the same. With this box ticked OpenCPN will keep the scale from the last chart as close as possible when switching. The zoom-factor will increase as you switch to smaller scale charts. -

- -

Controls

- -

Smooth Panning/Zooming

- -

-This works best together with OpenGL. Test to see how it works with your graphic card. If you are using OpenGL, tick this box as well. -

- -

Zoom to Cursor

- -

-With this box ticked the display is centered at the location of the mouse pointer when you zoom using the mouse wheel. When the box is not ticked the center of the display remains the same when you zoom with the mouse wheel just as it does when you zoom with the + and - keys or the zoom icons on the toolbar. In either case, if you click on the screen the point where you clicked will be moved to the center of the display. -

- -

Zoom to Cursor Summary

Keyboard, Menubar, and Toolbar zooms always zoom to center screen.
-
Wheel zoom behaviour changes depending on ZTC (Zoom to Cursor) and SmoothZoom settings.
-
ZTC (Zoom to Cursor) applies only to wheel zooms.
-

- -

Display Features

- -

Show Grid

- -

-Activate a latitude and longitude layer on the display. This feature only works if the display is in North Up mode. The grid is handy on vector charts, that normally lack this feature. -

- -

Show Chart Outlines

- -

-The borders of the available charts are shown. -

Vector charts are green
-
Raster charts are red
-
CM93 available larger scale charts are purple.
-

- -

-The CM93 chart outlines are not shown if using quilting mode. As a safety precaution, the outlines of isolated dangers with large scale charts available, are shown in CM93 even if “Show Chart Outlines” is off, provided that quilting is not used and the scale is large enough. At a scale of 1:200.000 or larger these isolated islands and dangers will be shown. Hence it is recommended not to use quilting with CM93 when on a longer offshore passage. Read more on Installing Charts -

- -

-Show Depth Units Shows the charts' depth units on the screen in embossed letters in the upper right corner. When in quilt mode, depth units are only shown if all charts in the quilt have the same depth unit. -

- -

Units

- -

-Choose the units that suit your way of navigating. These settings apply to everything in the core program. The exception is Radar rings, where the unit for distance between rings is selected separately. -

- -

-Plugins have their own settings for units. -

- -

Distance

- -

-The options are: Nautical miles, Statute miles, Kilometers, and Meters. Short distances are less than 0.1 mile or 0.1 kilometer. If nautical miles or kilometers are selected short distances are shown in meters. If statute miles are selected short distances are shown in feet. -

- -

Speed

- -

-The options are: Knots, Mph, km/h, and m/s. -

- -

Depth

- -

-The options are: Feet, Meters and Fathoms. -

- -

Lat/Long

- -

-The options are: Degrees, Decimal Minutes; Decimal Degrees; and Degrees, Minutes, Seconds -

- -

Bearings

- -

-If “Show Magnetic bearings and headings” is ticked OpenCPN will use magnetic courses and bearings. By default OpenCPN uses true courses and bearings etc. Note that OpenCPN knows nothing about deviation. All magnetic courses and bearings will have an (M) suffix to show they are magnetic. -

- -

-If BOTH “Show magnetic bearings and headings” and “Show true bearings and headings” are ticked you will get both values displayed. -

- -

-The following settings will be affected: Bearings and Courses in the Route Properties dialog, route leg rollovers, and Active Route console will show true and (M). COG displayed on the bottom status line will be true COG and COG(M). AIS target reports will show target true COG and COG(M). -

- -

-Variation will be calculated at Own Ship's position, if possible. AIS targets however, will use the targets position for variation, if possible. -

- -

-OpenCPN is looking for the variation in the the following order. -

If a GPS receiver that reports variation as part of HDG sentence is available, and if the HDG message also contains the E/W flags then O will use that.
-
If a GPS receiver that reports variation as part of RMC sentence, is available, this value will be used.
-
Otherwise, if the WMM plugin is activated, it will supply the variation, unless the user has selected the variation manually in options.
-
-
Lacking the above alternatives, the manually entered “Assumed Magnetic variation”, will be used for all calculations.
-

- -

Assumed Magnetic variation

- -

-This value will be used if variation is not available through the GPS or the WMM plugin. The default value is 0°. Positive values denote easterly variation, negative values denote westerly variation. -

- -

Advanced

- -

Chart Display

- -

Show skewed raster charts as North-up

- -

-Skewed chart are normally shown as intended by the cartographer, “Chart up”. If this option is selected they are rotated to show North-Up. If you are looking for speed, don't tick this box. It slows down the screen rendering. Skewed charts are a common along the US Inter-coastal Waterway. More here: Auto Follow and Display Orientation -

- -

Disable Full Screen Quilting:

- -

-By default all visible charts of an appropriate scale are used in the quilt. With this box checked only charts that overlap the center of the screen are used in the quilt. Checking this box is easier on the system and may give a performance boost in certain circumstances. -

- -

Suppress blur/fog effect on overzoom

- -

-Charts are commonly based on surveys that are twice the scale of the charts natural scale. For example a chart in 1:50,000 would be based in a survey in 1:25,000. Once a vector chart is zoomed in to a factor 2, the data do not support any more details. OpenCPN makes the navigator aware of this fact in a few different ways. -

- -

-This screen-shot shows an example how overzoom warnings are shown. -

- -

-At a zoom factor of 4 the embossed OverZoom warning will be displayed in the NW part of the screen. This applies to vector charts and raster charts using the Mercator projection. -

- -

-From a factor 10 to 30 a blur or gentle bluish fog will be overlaid on vector charts. Overzoom blurring is performed only for those systems with modern and fully capable OpenGL drivers/cards. Otherwise, a very gentle “fog” is applied to extreme overzoom displays, as a visual que to the user that the chart is highly overzoomed. From a factor 10, lines and depth numbers on vector charts will be scaled and appear bigger, to further indicate the imprecision of chart features at high overzoom. This imitates what happens with a raster chart, when the individual pixels gets bigger and bigger. -

- -

-If “Suppress blur/fog effects on overzoom” is selected the blurring or bluish fog, will be turned off. -

- -

Suppress scaled vector charts on over-zoom

- -

-If this option is selected the scaling of lines and numbers on vector charts will be turned off. -

- -

-Note that the blurring effect and scaled vector charts does not apply to single chart mode, so these effects can be turned off temporarily by toggling the “Q” hotkey. -

- -

-Below is how it looks like with both the above options activated. -

- -

Chart Rotation Averaging Time

- -

-Chart Rotation Smoothing. Course-Up Mode Display Update Period (old title) Controls how often the entire displayed chart is updated when Look Ahead and/or Course-Up mode are activated. The Own Ship and AIS icons are still updated every second. The default value is 15 seconds. A “zero” value is allowed! The default mode is North-up. It's easy to switch between the two modes through the right-click menu or Display Orientation Icon next to the GPS Status Icon located upper right corner. -

- -

Chart Zoom/Scale Weighting

- -

-This option has a short description, on screen. Here are some further notes. The slider applies to zoom operation dynamics, not to static chart selection. The option really asks you this question. “On zooming in, when do we switch to a smaller scale chart if available?” Your answer may depend on your screen resolution and other preferences. The slider affects zoom-in operations most directly. Setting the slider to -5 delays switching to smaller scale to improve performance and visibility. Setting the slider to 0 restore the default behavior. Setting the slider to +5 switches sooner to a smaller scale chart to show more detail. It ias not intended that a user exercise this control very often. Maybe experiment, set it to your liking for average charts in your area, and leave it set. -

- -

Controls

- -

Lock Waypoints (Unless waypoint property dialog visible)

- -

-Locks waypoints and prevents accidentally moving them unless a waypoint property dialog is visible. Selecting this option reduces the risk of accidentally altering routes and waypoints but makes editing them more cumbersome. -

- -

Confirm deletion of tracks and routes

- -

-If selected this option provides a safeguard against deleting important data by mistake. -

- -

Physical Screen Width

- -

-If set to “Auto”, the default setting, OpenCPN will use the size that the operating system reports. Unfortunately this is not always correct, leading to an incorrect scale on screen for the charts. The OpenCPN log will state what your operating system thinks about your screen size. -

- - - -

19:03:44 CET: Detected display size: 338 mm

- -

-You can manually enter the width of your screen by selecting “Manual” and entering the width in millimeters. The value shown is from a sample 17“ screen. -

- -

Graphics

- -

Use Accelerated Graphics (OpenGL)

- -

-The net effect of full OpenGL optimization on raster charts with compatible hardware is nothing short of amazing, especially with low-spec, low-power systems. Unfortunately the support for OpenGL on Windows is sometimes problematic. Intel's OpenGL graphics drivers on Windows are very buggy, for example. Read more on the OpenGL page!If you have started OpenCPN without OpenGL support, this option will be greyed out. -

- -

Options

- -

-The standard Option dialog looks like this -

- -

-An expert version is available by adding a line to the opencpn.ini (opencpn.conf) file. -

[Settings]
-....
-OpenGLExpert=1

- -

-To turn the expert version off, change the value from “1” to “0”, or delete the line. -

- -

Use Accelerated Panning

- -

-Works if your graphics card supports Frame Buffer Objects. -

- -

Texture Compression

- -

-Greatly improves the speed of raster chart display. It works by treating raster charts as compressed textures instead of bitmaps, and these textures are loaded and displayed much more efficiently by the graphics hardware. They also consume much less GPU memory space. -

- -

Texture Compression with Caching

- -

-A further improvement to raster chart display loading and panning. This option uses the system hard drive to store pre-calculated raster chart compressed images in a way that is optimized for direct loading into the graphics card. When enabled, the texture cache is created dynamically, as charts are visited in normal navigation. Depending on the OpenGL hardware capabilities, there may be some slight, but noticeable, delay as a chart is accessed the very first time while the textures are created, compressed, and written to disk. Once a particular chart section has been cached, subsequent accesses are very fast. If the OpenGL hardware texture buffer is capable, then rendering on-screen is virtually instantaneous. -

The cache understands color scheme changes. Cache entries are automatically created for each of the 4 possible BSB color schemes, as they are encountered in normal operation.
-
The cache understands chart Edition Dates. So, if one manually updates a chart (thus changing the chart's Edition Date), the old cache contents will be discarded, and a new cache will be built automatically as the new chart(s) are visited.
-
Using compressed texture caching retains all the benefits described earlier. It is very much faster on low spec hardware, at the expense of more disk space usage.
-
There is a command line option which will build/update your compressed texture cache. You may execute opencpn like this: opencpn /rebuild_gl_raster_cache (-rebuild_gl_raster_cache on linux)
-
“Texture Compression” and “Texture compression caching” may actually slow down some machines, depending on the capabilities of the video system.
-
If you are using OpenGL on a low-spec machine, you will have better performance if you
-
1. disable texture caching, or
  -
2. Pre-build the texture cache in a region of interest. That is, move the boat to say Dover. Then do Options→openGLOptions→Build Texture Cache. You do not need to wait the entire time, which may be hours for a large chart set. “Skip” out when the distance reported is 100 miles or so. Eventually, after steady use, your texture cache will be filled automatically in the background, and performance Show FPS will increase steadily.
  -
-

- -

The size of the current "Texture Cache"

- -

-Appears just to the right of the button “Clear Texture Cache”. In the picture above this value is 101.8 MB. -

- -

Show FPS FPS stands for Frames Per Second, and is one way measure OpenGL performance. The number appears in the lower right hand corner of the display, to the right of “Scale”. Above you see “26 fps”. If you report a graphical problem, expect the devolopers to ask you about this figure.
-
Enable Transparent Toolbar. This option is grayed out in OpenGL mode, as the feature only works in traditional mode. On Linux it is necessary to activate a window manager compositing system, such as Compiz or GNOME Shell, to have a transparent toolbar.
-

- -

- - -

- - + + + + + opencpn:opencpn_user_manual:options_setting:display + + + + + + + + + + + + + + + + + + + + + +

+ + + +

The Display

+ +

General

+ +

Navigation Modes

+ +

North Up /Course Up

+ +

+North Up is the normal way charts are shown, with north at the top. Course Up rotates the chart so what you see in front of the boat in real life is above the Own Ship icon on the display. +

+ +

Lookahead Mode

+ +

+The Own Ship icon will be offset from the center of the screen so that more of the chart is in front of Own Ship than behind. Read more in Auto Follow and Display Orientation +

+ +

Chart Display

+ +

Enable Chart Quilting

+ +

+The screen shows several charts seamlessly stitched together. More in Chart Quilting . +

+ +

Preserve scale when switching charts

+ +

+Normally when switching charts OpenCPN will open the new chart scaled close to it's natural scale, the zoom factor stays the same. With this box ticked OpenCPN will keep the scale from the last chart as close as possible when switching. The zoom-factor will increase as you switch to smaller scale charts. +

+ +

Controls

+ +

Smooth Panning/Zooming

+ +

+This works best together with OpenGL. Test to see how it works with your graphic card. If you are using OpenGL, tick this box as well. +

+ +

Zoom to Cursor

+ +

+With this box ticked the display is centered at the location of the mouse pointer when you zoom using the mouse wheel. When the box is not ticked the center of the display remains the same when you zoom with the mouse wheel just as it does when you zoom with the + and - keys or the zoom icons on the toolbar. In either case, if you click on the screen the point where you clicked will be moved to the center of the display. +

+ +

Zoom to Cursor Summary

Keyboard, Menubar, and Toolbar zooms always zoom to center screen.
+
Wheel zoom behaviour changes depending on ZTC (Zoom to Cursor) and SmoothZoom settings.
+
ZTC (Zoom to Cursor) applies only to wheel zooms.
+

+ +

Display Features

+ +

Show Grid

+ +

+Activate a latitude and longitude layer on the display. This feature only works if the display is in North Up mode. The grid is handy on vector charts, that normally lack this feature. +

+ +

Show Chart Outlines

+ +

+The borders of the available charts are shown. +

Vector charts are green
+
Raster charts are red
+
CM93 available larger scale charts are purple.
+

+ +

+The CM93 chart outlines are not shown if using quilting mode. As a safety precaution, the outlines of isolated dangers with large scale charts available, are shown in CM93 even if “Show Chart Outlines” is off, provided that quilting is not used and the scale is large enough. At a scale of 1:200.000 or larger these isolated islands and dangers will be shown. Hence it is recommended not to use quilting with CM93 when on a longer offshore passage. Read more on Installing Charts +

+ +

+Show Depth Units Shows the charts' depth units on the screen in embossed letters in the upper right corner. When in quilt mode, depth units are only shown if all charts in the quilt have the same depth unit. +

+ +

Units

+ +

+Choose the units that suit your way of navigating. These settings apply to everything in the core program. The exception is Radar rings, where the unit for distance between rings is selected separately. +

+ +

+Plugins have their own settings for units. +

+ +

Distance

+ +

+The options are: Nautical miles, Statute miles, Kilometers, and Meters. Short distances are less than 0.1 mile or 0.1 kilometer. If nautical miles or kilometers are selected short distances are shown in meters. If statute miles are selected short distances are shown in feet. +

+ +

Speed

+ +

+The options are: Knots, Mph, km/h, and m/s. +

+ +

Depth

+ +

+The options are: Feet, Meters and Fathoms. +

+ +

Lat/Long

+ +

+The options are: Degrees, Decimal Minutes; Decimal Degrees; and Degrees, Minutes, Seconds +

+ +

Bearings

+ +

+If “Show Magnetic bearings and headings” is ticked OpenCPN will use magnetic courses and bearings. By default OpenCPN uses true courses and bearings etc. Note that OpenCPN knows nothing about deviation. All magnetic courses and bearings will have an (M) suffix to show they are magnetic. +

+ +

+If BOTH “Show magnetic bearings and headings” and “Show true bearings and headings” are ticked you will get both values displayed. +

+ +

+The following settings will be affected: Bearings and Courses in the Route Properties dialog, route leg rollovers, and Active Route console will show true and (M). COG displayed on the bottom status line will be true COG and COG(M). AIS target reports will show target true COG and COG(M). +

+ +

+Variation will be calculated at Own Ship's position, if possible. AIS targets however, will use the targets position for variation, if possible. +

+ +

+OpenCPN is looking for the variation in the the following order. +

If a GPS receiver that reports variation as part of HDG sentence is available, and if the HDG message also contains the E/W flags then O will use that.
+
If a GPS receiver that reports variation as part of RMC sentence, is available, this value will be used.
+
Otherwise, if the WMM plugin is activated, it will supply the variation, unless the user has selected the variation manually in options.
+
+
Lacking the above alternatives, the manually entered “Assumed Magnetic variation”, will be used for all calculations.
+

+ +

Assumed Magnetic variation

+ +

+This value will be used if variation is not available through the GPS or the WMM plugin. The default value is 0°. Positive values denote easterly variation, negative values denote westerly variation. +

+ +

Advanced

+ +

Chart Display

+ +

Show skewed raster charts as North-up

+ +

+Skewed chart are normally shown as intended by the cartographer, “Chart up”. If this option is selected they are rotated to show North-Up. If you are looking for speed, don't tick this box. It slows down the screen rendering. Skewed charts are a common along the US Inter-coastal Waterway. More here: Auto Follow and Display Orientation +

+ +

Disable Full Screen Quilting:

+ +

+By default all visible charts of an appropriate scale are used in the quilt. With this box checked only charts that overlap the center of the screen are used in the quilt. Checking this box is easier on the system and may give a performance boost in certain circumstances. +

+ +

Suppress blur/fog effect on overzoom

+ +

+Charts are commonly based on surveys that are twice the scale of the charts natural scale. For example a chart in 1:50,000 would be based in a survey in 1:25,000. Once a vector chart is zoomed in to a factor 2, the data do not support any more details. OpenCPN makes the navigator aware of this fact in a few different ways. +

+ +

+This screen-shot shows an example how overzoom warnings are shown. +

+ +

+At a zoom factor of 4 the embossed OverZoom warning will be displayed in the NW part of the screen. This applies to vector charts and raster charts using the Mercator projection. +

+ +

+From a factor 10 to 30 a blur or gentle bluish fog will be overlaid on vector charts. Overzoom blurring is performed only for those systems with modern and fully capable OpenGL drivers/cards. Otherwise, a very gentle “fog” is applied to extreme overzoom displays, as a visual que to the user that the chart is highly overzoomed. From a factor 10, lines and depth numbers on vector charts will be scaled and appear bigger, to further indicate the imprecision of chart features at high overzoom. This imitates what happens with a raster chart, when the individual pixels gets bigger and bigger. +

+ +

+If “Suppress blur/fog effects on overzoom” is selected the blurring or bluish fog, will be turned off. +

+ +

Suppress scaled vector charts on over-zoom

+ +

+If this option is selected the scaling of lines and numbers on vector charts will be turned off. +

+ +

+Note that the blurring effect and scaled vector charts does not apply to single chart mode, so these effects can be turned off temporarily by toggling the “Q” hotkey. +

+ +

+Below is how it looks like with both the above options activated. +

+ +

Chart Rotation Averaging Time

+ +

+Chart Rotation Smoothing. Course-Up Mode Display Update Period (old title) Controls how often the entire displayed chart is updated when Look Ahead and/or Course-Up mode are activated. The Own Ship and AIS icons are still updated every second. The default value is 15 seconds. A “zero” value is allowed! The default mode is North-up. It's easy to switch between the two modes through the right-click menu or Display Orientation Icon next to the GPS Status Icon located upper right corner. +

+ +

Chart Zoom/Scale Weighting

+ +

+This option has a short description, on screen. Here are some further notes. The slider applies to zoom operation dynamics, not to static chart selection. The option really asks you this question. “On zooming in, when do we switch to a smaller scale chart if available?” Your answer may depend on your screen resolution and other preferences. The slider affects zoom-in operations most directly. Setting the slider to -5 delays switching to smaller scale to improve performance and visibility. Setting the slider to 0 restore the default behavior. Setting the slider to +5 switches sooner to a smaller scale chart to show more detail. It ias not intended that a user exercise this control very often. Maybe experiment, set it to your liking for average charts in your area, and leave it set. +

+ +

Controls

+ +

Lock Waypoints (Unless waypoint property dialog visible)

+ +

+Locks waypoints and prevents accidentally moving them unless a waypoint property dialog is visible. Selecting this option reduces the risk of accidentally altering routes and waypoints but makes editing them more cumbersome. +

+ +

Confirm deletion of tracks and routes

+ +

+If selected this option provides a safeguard against deleting important data by mistake. +

+ +

Physical Screen Width

+ +

+If set to “Auto”, the default setting, OpenCPN will use the size that the operating system reports. Unfortunately this is not always correct, leading to an incorrect scale on screen for the charts. The OpenCPN log will state what your operating system thinks about your screen size. +

+ + + +

19:03:44 CET: Detected display size: 338 mm

+ +

+You can manually enter the width of your screen by selecting “Manual” and entering the width in millimeters. The value shown is from a sample 17“ screen. +

+ +

Graphics

+ +

Use Accelerated Graphics (OpenGL)

+ +

+The net effect of full OpenGL optimization on raster charts with compatible hardware is nothing short of amazing, especially with low-spec, low-power systems. Unfortunately the support for OpenGL on Windows is sometimes problematic. Intel's OpenGL graphics drivers on Windows are very buggy, for example. Read more on the OpenGL page!If you have started OpenCPN without OpenGL support, this option will be greyed out. +

+ +

Options

+ +

+The standard Option dialog looks like this +

+ +

+> +

+ +

+An expert version is available by adding a line to the opencpn.ini (opencpn.conf) file. +

[Settings]
+....
+OpenGLExpert=1

+ +

+To turn the expert version off, change the value from “1” to “0”, or delete the line. +

+ +

Use Accelerated Panning

+ +

+Works if your graphics card supports Frame Buffer Objects. +

+ +

Texture Compression

+ +

+Greatly improves the speed of raster chart display. It works by treating raster charts as compressed textures instead of bitmaps, and these textures are loaded and displayed much more efficiently by the graphics hardware. They also consume much less GPU memory space. +

+ +

Texture Compression with Caching

+ +

+A further improvement to raster chart display loading and panning. This option uses the system hard drive to store pre-calculated raster chart compressed images in a way that is optimized for direct loading into the graphics card. When enabled, the texture cache is created dynamically, as charts are visited in normal navigation. Depending on the OpenGL hardware capabilities, there may be some slight, but noticeable, delay as a chart is accessed the very first time while the textures are created, compressed, and written to disk. Once a particular chart section has been cached, subsequent accesses are very fast. If the OpenGL hardware texture buffer is capable, then rendering on-screen is virtually instantaneous. +

The cache understands color scheme changes. Cache entries are automatically created for each of the 4 possible BSB color schemes, as they are encountered in normal operation.
+
The cache understands chart Edition Dates. So, if one manually updates a chart (thus changing the chart's Edition Date), the old cache contents will be discarded, and a new cache will be built automatically as the new chart(s) are visited.
+
Using compressed texture caching retains all the benefits described earlier. It is very much faster on low spec hardware, at the expense of more disk space usage.
+
There is a command line option which will build/update your compressed texture cache. You may execute opencpn like this: opencpn /rebuild_gl_raster_cache (-rebuild_gl_raster_cache on linux)
+
“Texture Compression” and “Texture compression caching” may actually slow down some machines, depending on the capabilities of the video system.
+
If you are using OpenGL on a low-spec machine, you will have better performance if you
+
1. disable texture caching, or
  +
2. Pre-build the texture cache in a region of interest. That is, move the boat to say Dover. Then do Options→openGLOptions→Build Texture Cache. You do not need to wait the entire time, which may be hours for a large chart set. “Skip” out when the distance reported is 100 miles or so. Eventually, after steady use, your texture cache will be filled automatically in the background, and performance Show FPS will increase steadily.
  +
+

+ +

The size of the current "Texture Cache"

+ +

+Appears just to the right of the button “Clear Texture Cache”. In the picture above this value is 101.8 MB. +

+ +

Show FPS FPS stands for Frames Per Second, and is one way measure OpenGL performance. The number appears in the lower right hand corner of the display, to the right of “Scale”. Above you see “26 fps”. If you report a graphical problem, expect the devolopers to ask you about this figure.
+
Enable Transparent Toolbar. This option is grayed out in OpenGL mode, as the feature only works in traditional mode. On Linux it is necessary to activate a window manager compositing system, such as Compiz or GNOME Shell, to have a transparent toolbar.
+

+ +

+ + +

+ + diff -Nru opencpn-doc-4.8.10129.2/doc/options_setting/plugins.html opencpn-doc-4.8.2.0/doc/options_setting/plugins.html --- opencpn-doc-4.8.10129.2/doc/options_setting/plugins.html 2018-01-30 12:28:30.000000000 +0000 +++ opencpn-doc-4.8.2.0/doc/options_setting/plugins.html 2018-02-07 14:43:14.000000000 +0000 @@ -1,76 +1,76 @@ - - - - - opencpn:opencpn_user_manual:options_setting:plugins - - - - - - - - - - - - - - - - - - - - - -

- - - -

The Plugins

- -

-The Plugin tab is treated on these pages: -

- -

-Plugins
-Install and Enable Plugins
-Dashboard Plugin
-Grib Weather Plugin
-WMM Plugin
-Chart Downloader Plugin -

- -

-
- -

- -

- - -

- - + + + + + opencpn:opencpn_user_manual:options_setting:plugins + + + + + + + + + + + + + + + + + + + + + +

+ + + +

The Plugins

+ +

+The Plugin tab is treated on these pages: +

+ +

+Plugins
+Install and Enable Plugins
+Dashboard Plugin
+Grib Weather Plugin
+WMM Plugin
+Chart Downloader Plugin +

+ +

+
+ +

+ +

+ + +

+ + diff -Nru opencpn-doc-4.8.10129.2/doc/options_setting/ships.html opencpn-doc-4.8.2.0/doc/options_setting/ships.html --- opencpn-doc-4.8.10129.2/doc/options_setting/ships.html 2018-01-30 12:28:30.000000000 +0000 +++ opencpn-doc-4.8.2.0/doc/options_setting/ships.html 2018-02-07 14:43:14.000000000 +0000 @@ -1,536 +1,536 @@ - - - - - opencpn:opencpn_user_manual:options_setting:ships - - - - - - - - - - - - - - - - - - - - - -

- - - -

The Ships

- -

Own Ship

- -

Display Options

- -

COG Predictor Length (min)

- -

-Shows a red dashed line in front of your own boat, with present COG and ends in a small square, which represents where you will be in the set number of minutes, with the present speed. 6 minutes is a good starting value for piloting. If your vessel has a SOG of 10 knots the dashed line will be 1 nautical mile long. 60 minutes makes sense on a coastal passage and 24 x 60=1440 minutes on longer blue water passages. -

- -

Heading Predictor Length

- -

-If a heading sensor is available and outputs an nmea data stream, this is shown as a finer line with shorter dashes ending in an open small circle. The length is set in Nautical miles. -

- -

-The width of the COG Predictor can be adjusted in the opencpn.ini configuration file. Find the line below and adjust the value. -

- -

-OwnshipCOGPredictorWidth=3 -

- -

-Warning: Don't edit the opencpn.ini (opencpn.conf) file when OpenCPN is running. -

- -

Ship Icon Type

- -

-The following options are available for Ownship: -

- -

Default

- -

-This will use the icon that comes with OpenCPN, unless you have installed your own icon, “ownship.jpg”. More about installing your own icons in Marks and Routes . -

- -

Real Scale Bitmap

- -

-This option will adjust the size of the default icon, depending on your settings. When using this setting, the dialog expands and five more options related to the size of “ownship” become available. See picture below -

- -

Length Over All (m)

- -

-The overall length of Own Ship in meters -

- -

Width Over All (m)

- -

-The overall width of Own Ship in meters -

- -

GPS Offset from Bow (m)

- -

-The distance in meters from the bow of Own Ship to its GPS antenna -

- -

GPS Offset from Midship (m)

- -

-The distance in meters from Own Ship's center line to its GPS antenna. Use a positive value for an offset to starboard and a negative value for an offset to port. -

- -

Minimum Screen Size(mm)

- -

-The size of the Own Ship icon on the screen. Default is set to 1mm. -

- -

Real Scale Vector

- -

-Works the same as the previous option with the exception that ownship is a somewhat boxy, computer rendered ship. It's currently not possible to change the vector-own-ship. -

- -

-The dot represents the set location of the GPS. -

- -

Show radar rings

- -

-These show up as red rings centered on your gps position and can be useful in different circumstances, such as keeping clear of dangers. The settings are, hopefully, intuitive. -

- -

-Once the number of radar rings are selected, and not equal to “None” the dialog expands, and shows more settings. The Distance Unit for Radar rings is set here, and does not follow the the global settings in Options→Display→Units. The choices are Nautical Miles and Kilometers -

- -

Tracks

- -

Automatic Daily Tracks

- -

-Automatic Daily Tracking ensures that the track-points collected throughout a single day (midnight to midnight in local zone time) are stored and managed as a single (possibly multi-segment) track. -

- -

-If the Automatic Daily Tracking check-box is selected, the “Toggle Tracking” tool will turn tracking on and off. However, on turning it off, the accumulated track will be extended with the previous one if it does not extend into yesterday. Disjoint segments are kept separate, time-adjacent segments are merged into a single segment. Disjointed track segments can be joined through the right-click menu when they are selected in the Route Managers Tracks Tab. -

- -

-Every Midnight the tracking is turned off and on again automatically to ensure that the track does not span dates. If Automatic Daily Tracking is selected during the day, when some tracks have already been created, only the last one will be merged with future daily tracks. -

- -

-Assuming Automatic Daily Tracking is on, normally during tracking periods there will be two tracks visible in the Route Manager: the current track (red color track-points on the chart) and the previously accumulated track for the day. After toggling tracking off there will be just one track for this day. -

- -

-If the timezone needs to be changed, it is a good idea to close OpenCPN application before. -

- -

-With the manual capability of splitting and extending, the daily tracks can be easily managed at any time. -

- -

-The daily tracks will be automatically named with the date in the local Time Zone, but can of course be changed manually. -

- -

-The Automatic Daily Tracks follow the settings in Tracking Precision, see below. -

- -

-Without Automatic Daily Tracks selected, OpenCPN handles tracks as before. -

- -

Highlight Tracks

- -

-Shows a 7 to 10m wide highlighting on either side of the track. This is not selectable for individual tracks. The idea of the highlighting is to remind us that following a previous track exposes us to the inherent inaccuracy of GPS, and that the real track followed is most likely within the highlight region, but not necessarily in the middle. And this says nothing about the accuracy of the underlying cartography. For many charts it is prudent to assume at least 1.5 mm inaccuracy using the nominal scale of the chart. For a chart in scale 1:20,000 this translates to 30m. -

- -

Tracking Precision

- -

-With track button in the ToolBar activated this setting affects the size of the data saved. It also affects the “smoothness” of the track, though this is only visible when zoomed in to a very large scale. OpenCPN uses smart dynamic tracking, and only uses those track points that actually contributes anything to the track. A straight line track for example is only represented by it's endpoints. This is done by analyzing the track just behind the boat. The process is visible in real time, close to Own Ship. The end result is good track accuracy while keeping the size small. -

Low: Good for offshore passages.
-
Medium: Very good for all normal uses.
-
High: Only necessary when very tight maneuvering needs documenting.
-

- -

Routes

- -

Waypoint Arrival Circle Radius

- -

-Gives an answer to this question. When following a Route with the autopilot engaged at what distance from the upcoming waypoint should OpenCPN tell the autopilot to change to the next waypoint? The default is 0.05 nautical miles. This is equal to about 93 meters or 300 feet. The default setting does not fit all circumstances. A number of factors are involved, for example, -

the type of navigation,
-
the waypoint selected,
-
Own Ship's turning radius and speed.
-

- -

-Find what settings suit your boat by testing. -

- -

-The arrival radius can also be set individually for each waypoint in the Waypoint Properties dialog. -

- -

Advance route waypoint on arrival only

- -

-Routes are explained in Marks and Routes . With an active route, the Dialog “This Leg” is visible near the upper right corner of the screen. This dialog contains “RNG”, the “actual range”, or distance to the next waypoint. The “normal range” is different. It is the distance from ownship to a line which passes through the destination waypoint and is at right angles to the current route segment. The actual range is always equal to or greater than the normal range. When the difference is greater than 10% both values are shown in “RNG” (Shown in the Active Route Console The “normal” range is the second number shown. 1.88 in this case. -When following a Route OpenCPN normally decides to advance to the next waypoint if at least one of the following two conditions apply. -

The “normal range” is less than the declared arrival radius.
-
Own Ship is moving away from the target waypoint, and has been for more than two seconds.
-

- -

-With Advance route waypoint on arrival only activated, OpenCPN only advances the route to the next waypoint, if condition 1 above is true. Condition 2 is ignored. -

- -

-This feature is useful when sailing and you can't lay the next mark and are forced to tack a few times to reach it. It allows a ship to move away from waypoint without automatically advancing to next waypoint. This ensures that the next waypoint stays active until you either reach it, or you reach a line through it, which is perpendicular to the marked route. In the latter case you have a cross track error greater than the arrival radius. -

- -

-On the other hand…. Option 2 helps you if you really want to cut a corner by a large distance in such a way that the “normal range” will never be less than the arrival radius. We want to automatically advance the route in this case. -

- -

AIS Targets

- -

-Read more about AIS . -

- -

MMSI Properties

- -

-Maritime Mobile Service Identifier (MMSI) is a number identifying a ship in communication. MMSI consists of nine digits. All VHF units using Digital Selective Call (DSC), are programmed with the vessels MMSI. The same applies for AIS and EPIRBs. For more about MMSI from Miltech -

- -

-MMSI numbers, individual targets, can be handled in a few preset ways. Below we have set 970000099 as an MMSI that should be tracked as a MOB. The number could for example belong to a crew member's Personal Locator Beacon. -

- -

-Several MMSI IDs below are set to never show their tracks. This can be used on frequent targets in your neighborhood, like ferries etc. The MMSI 219000368 is set to never be shown. Be aware that neither this target nor its track will ever be seen on your screen. -

- -

-The MMSI 219010183 is set as “Follower”. This is a buddy and no AIS Alert is shown. The “MMSI Properties” popup becomes available when right-clicking. Doubleclicking on the MMSI bypasses the popup an takes you directly to the Properties edit dialog. -

- -

Add a new target to track

- -

MMSI:

- -

-Enter the MMSI number that the new action should apply to. -

- -

-Note: An MMSI Id used to be nine digits. A warning message will be shown if the entry is more or less. -

- -

-If you for some reason, wish to save a non-nine-digit number click “OK”, otherwise “Cancel” will take you back to edit the number. -

- -

MMSI Tracking

- -

Default tracking

- -

-This is the normal tracking controlled by Options→Ships “OwnShip” and “AIS Targets” tabs. -

- -

Always track and Never track

- -

-The MMSI Properties dialog allows one to preset the tracking behavior of a particular MMSI target, even if the target is not presently visible. Always track a friend or a ship you are interested in. Ignore that ferry that just clutters your screen. Just a few examples. -

- -

Ignore this MMSI

- -

-The target will not show at all on the screen. -

- -

Handle this MMSI as SART/PLB MOB.

- -

-With this setting a MOB from your ownship will be signalled immediately. Special Search and Rescue Transponders, SARTs, are now available, using the AIS system. Personal Locator Beacons transmitting on the AIS frequencies are also available. These are sometimes called Personal AIS MOB Devices. Don't confuse these with the more common personal EPIRB, that cannot be tracked by OpenCPN. -

- -

-Entering the the MMSI number makes it possible to use these devices as an onboard emergency MOB tracking system. Setting off a device alarms all vessels that can receive the signal but it tells you that this emergency is directly related to your vessel. OpenCPN will now treat this MMSI as a standard MOB. Read more Man OverBoard . -

- -

-The alarm is entered in Options → Ships→ AIS Targets →“Play Sound on CPA/TCPA and DSC/SART emergencies.” Have a look at AIS SART to see how OpenCPN reacts to an alarm. -

- -

Convert AIVDM to AIVDO for this MMSI

AIVDM NMEA 0183 sentence → AIS position reports from other vessels
-
AIVDO NMEA 0183 sentence → AIS position reports from own vessel
-

- -

-The setting is intended for the following very specific scenario: -

You have an AIS transponder, not connected to your computer.
-
You have a separate AIS receiver, used to monitor your own AIS signal, as well as all other traffic.
-
You desire not to collide with yourself, virtually.
-

- -

-So you instruct O to convert the AIVDM for your MMSI coming in via your AIS receiver into AIVDO, or Own Ship. Thus, no collision. -

- -

-The option is also handy to clear a non-sense “ownship” AIS icon from the screen when the AIS transponder is misconfigured. -

- -

-Note that the option Ignore this MMSI can be used to achive the same result -

- -

This MMSI is my follower – No CPA Alert

- -

-When this option is active no AIS Alert will be shown for that target. This can be used for a buddy sailing close to you and you don't wont a CPA alert message for that target but still for other ships coming too close. -

- -

Ships name

- -

-The Ship name connected to a MMSI ID will be added to the list once the new ID is saved or edited. The ship name is automatically printed provided that the actual ship is present on screen or has previously been and was saved in the AIS ship name file. In either case the ship name will be added first time the boat is present in OpenCPN. -

- -

- - -

- - + + + + + opencpn:opencpn_user_manual:options_setting:ships + + + + + + + + + + + + + + + + + + + + + +

+ + + +

The Ships

+ +

Own Ship

+ +

Display Options

+ +

COG Predictor Length (min)

+ +

+Shows a red dashed line in front of your own boat, with present COG and ends in a small square, which represents where you will be in the set number of minutes, with the present speed. 6 minutes is a good starting value for piloting. If your vessel has a SOG of 10 knots the dashed line will be 1 nautical mile long. 60 minutes makes sense on a coastal passage and 24 x 60=1440 minutes on longer blue water passages. +

+ +

Heading Predictor Length

+ +

+If a heading sensor is available and outputs an nmea data stream, this is shown as a finer line with shorter dashes ending in an open small circle. The length is set in Nautical miles. +

+ +

+The width of the COG Predictor can be adjusted in the opencpn.ini configuration file. Find the line below and adjust the value. +

+ +

+OwnshipCOGPredictorWidth=3 +

+ +

+Warning: Don't edit the opencpn.ini (opencpn.conf) file when OpenCPN is running. +

+ +

Ship Icon Type

+ +

+The following options are available for Ownship: +

+ +

Default

+ +

+This will use the icon that comes with OpenCPN, unless you have installed your own icon, “ownship.jpg”. More about installing your own icons in Marks and Routes . +

+ +

Real Scale Bitmap

+ +

+This option will adjust the size of the default icon, depending on your settings. When using this setting, the dialog expands and five more options related to the size of “ownship” become available. See picture below +

+ +

Length Over All (m)

+ +

+The overall length of Own Ship in meters +

+ +

Width Over All (m)

+ +

+The overall width of Own Ship in meters +

+ +

GPS Offset from Bow (m)

+ +

+The distance in meters from the bow of Own Ship to its GPS antenna +

+ +

GPS Offset from Midship (m)

+ +

+The distance in meters from Own Ship's center line to its GPS antenna. Use a positive value for an offset to starboard and a negative value for an offset to port. +

+ +

Minimum Screen Size(mm)

+ +

+The size of the Own Ship icon on the screen. Default is set to 1mm. +

+ +

Real Scale Vector

+ +

+Works the same as the previous option with the exception that ownship is a somewhat boxy, computer rendered ship. It's currently not possible to change the vector-own-ship. +

+ +

+The dot represents the set location of the GPS. +

+ +

Show radar rings

+ +

+These show up as red rings centered on your gps position and can be useful in different circumstances, such as keeping clear of dangers. The settings are, hopefully, intuitive. +

+ +

+Once the number of radar rings are selected, and not equal to “None” the dialog expands, and shows more settings. The Distance Unit for Radar rings is set here, and does not follow the the global settings in Options→Display→Units. The choices are Nautical Miles and Kilometers +

+ +

Tracks

+ +

Automatic Daily Tracks

+ +

+Automatic Daily Tracking ensures that the track-points collected throughout a single day (midnight to midnight in local zone time) are stored and managed as a single (possibly multi-segment) track. +

+ +

+If the Automatic Daily Tracking check-box is selected, the “Toggle Tracking” tool will turn tracking on and off. However, on turning it off, the accumulated track will be extended with the previous one if it does not extend into yesterday. Disjoint segments are kept separate, time-adjacent segments are merged into a single segment. Disjointed track segments can be joined through the right-click menu when they are selected in the Route Managers Tracks Tab. +

+ +

+Every Midnight the tracking is turned off and on again automatically to ensure that the track does not span dates. If Automatic Daily Tracking is selected during the day, when some tracks have already been created, only the last one will be merged with future daily tracks. +

+ +

+Assuming Automatic Daily Tracking is on, normally during tracking periods there will be two tracks visible in the Route Manager: the current track (red color track-points on the chart) and the previously accumulated track for the day. After toggling tracking off there will be just one track for this day. +

+ +

+If the timezone needs to be changed, it is a good idea to close OpenCPN application before. +

+ +

+With the manual capability of splitting and extending, the daily tracks can be easily managed at any time. +

+ +

+The daily tracks will be automatically named with the date in the local Time Zone, but can of course be changed manually. +

+ +

+The Automatic Daily Tracks follow the settings in Tracking Precision, see below. +

+ +

+Without Automatic Daily Tracks selected, OpenCPN handles tracks as before. +

+ +

Highlight Tracks

+ +

+Shows a 7 to 10m wide highlighting on either side of the track. This is not selectable for individual tracks. The idea of the highlighting is to remind us that following a previous track exposes us to the inherent inaccuracy of GPS, and that the real track followed is most likely within the highlight region, but not necessarily in the middle. And this says nothing about the accuracy of the underlying cartography. For many charts it is prudent to assume at least 1.5 mm inaccuracy using the nominal scale of the chart. For a chart in scale 1:20,000 this translates to 30m. +

+ +

Tracking Precision

+ +

+With track button in the ToolBar activated this setting affects the size of the data saved. It also affects the “smoothness” of the track, though this is only visible when zoomed in to a very large scale. OpenCPN uses smart dynamic tracking, and only uses those track points that actually contributes anything to the track. A straight line track for example is only represented by it's endpoints. This is done by analyzing the track just behind the boat. The process is visible in real time, close to Own Ship. The end result is good track accuracy while keeping the size small. +

Low: Good for offshore passages.
+
Medium: Very good for all normal uses.
+
High: Only necessary when very tight maneuvering needs documenting.
+

+ +

Routes

+ +

Waypoint Arrival Circle Radius

+ +

+Gives an answer to this question. When following a Route with the autopilot engaged at what distance from the upcoming waypoint should OpenCPN tell the autopilot to change to the next waypoint? The default is 0.05 nautical miles. This is equal to about 93 meters or 300 feet. The default setting does not fit all circumstances. A number of factors are involved, for example, +

the type of navigation,
+
the waypoint selected,
+
Own Ship's turning radius and speed.
+

+ +

+Find what settings suit your boat by testing. +

+ +

+The arrival radius can also be set individually for each waypoint in the Waypoint Properties dialog. +

+ +

Advance route waypoint on arrival only

+ +

+Routes are explained in Marks and Routes . With an active route, the Dialog “This Leg” is visible near the upper right corner of the screen. This dialog contains “RNG”, the “actual range”, or distance to the next waypoint. The “normal range” is different. It is the distance from ownship to a line which passes through the destination waypoint and is at right angles to the current route segment. The actual range is always equal to or greater than the normal range. When the difference is greater than 10% both values are shown in “RNG” (Shown in the Active Route Console The “normal” range is the second number shown. 1.88 in this case. +When following a Route OpenCPN normally decides to advance to the next waypoint if at least one of the following two conditions apply. +

The “normal range” is less than the declared arrival radius.
+
Own Ship is moving away from the target waypoint, and has been for more than two seconds.
+

+ +

+With Advance route waypoint on arrival only activated, OpenCPN only advances the route to the next waypoint, if condition 1 above is true. Condition 2 is ignored. +

+ +

+This feature is useful when sailing and you can't lay the next mark and are forced to tack a few times to reach it. It allows a ship to move away from waypoint without automatically advancing to next waypoint. This ensures that the next waypoint stays active until you either reach it, or you reach a line through it, which is perpendicular to the marked route. In the latter case you have a cross track error greater than the arrival radius. +

+ +

+On the other hand…. Option 2 helps you if you really want to cut a corner by a large distance in such a way that the “normal range” will never be less than the arrival radius. We want to automatically advance the route in this case. +

+ +

AIS Targets

+ +

+Read more about AIS . +

+ +

MMSI Properties

+ +

+Maritime Mobile Service Identifier (MMSI) is a number identifying a ship in communication. MMSI consists of nine digits. All VHF units using Digital Selective Call (DSC), are programmed with the vessels MMSI. The same applies for AIS and EPIRBs. For more about MMSI from Miltech +

+ +

+MMSI numbers, individual targets, can be handled in a few preset ways. Below we have set 970000099 as an MMSI that should be tracked as a MOB. The number could for example belong to a crew member's Personal Locator Beacon. +

+ +

+Several MMSI IDs below are set to never show their tracks. This can be used on frequent targets in your neighborhood, like ferries etc. The MMSI 219000368 is set to never be shown. Be aware that neither this target nor its track will ever be seen on your screen. +

+ +

+The MMSI 219010183 is set as “Follower”. This is a buddy and no AIS Alert is shown. The “MMSI Properties” popup becomes available when right-clicking. Doubleclicking on the MMSI bypasses the popup an takes you directly to the Properties edit dialog. +

+ +

Add a new target to track

+ +

MMSI:

+ +

+Enter the MMSI number that the new action should apply to. +

+ +

+Note: An MMSI Id used to be nine digits. A warning message will be shown if the entry is more or less. +

+ +

+If you for some reason, wish to save a non-nine-digit number click “OK”, otherwise “Cancel” will take you back to edit the number. +

+ +

MMSI Tracking

+ +

Default tracking

+ +

+This is the normal tracking controlled by Options→Ships “OwnShip” and “AIS Targets” tabs. +

+ +

Always track and Never track

+ +

+The MMSI Properties dialog allows one to preset the tracking behavior of a particular MMSI target, even if the target is not presently visible. Always track a friend or a ship you are interested in. Ignore that ferry that just clutters your screen. Just a few examples. +

+ +

Ignore this MMSI

+ +

+The target will not show at all on the screen. +

+ +

Handle this MMSI as SART/PLB MOB.

+ +

+With this setting a MOB from your ownship will be signalled immediately. Special Search and Rescue Transponders, SARTs, are now available, using the AIS system. Personal Locator Beacons transmitting on the AIS frequencies are also available. These are sometimes called Personal AIS MOB Devices. Don't confuse these with the more common personal EPIRB, that cannot be tracked by OpenCPN. +

+ +

+Entering the the MMSI number makes it possible to use these devices as an onboard emergency MOB tracking system. Setting off a device alarms all vessels that can receive the signal but it tells you that this emergency is directly related to your vessel. OpenCPN will now treat this MMSI as a standard MOB. Read more Man OverBoard . +

+ +

+The alarm is entered in Options → Ships→ AIS Targets →“Play Sound on CPA/TCPA and DSC/SART emergencies.” Have a look at AIS SART to see how OpenCPN reacts to an alarm. +

+ +

Convert AIVDM to AIVDO for this MMSI

AIVDM NMEA 0183 sentence → AIS position reports from other vessels
+
AIVDO NMEA 0183 sentence → AIS position reports from own vessel
+

+ +

+The setting is intended for the following very specific scenario: +

You have an AIS transponder, not connected to your computer.
+
You have a separate AIS receiver, used to monitor your own AIS signal, as well as all other traffic.
+
You desire not to collide with yourself, virtually.
+

+ +

+So you instruct O to convert the AIVDM for your MMSI coming in via your AIS receiver into AIVDO, or Own Ship. Thus, no collision. +

+ +

+The option is also handy to clear a non-sense “ownship” AIS icon from the screen when the AIS transponder is misconfigured. +

+ +

+Note that the option Ignore this MMSI can be used to achive the same result +

+ +

This MMSI is my follower – No CPA Alert

+ +

+When this option is active no AIS Alert will be shown for that target. This can be used for a buddy sailing close to you and you don't wont a CPA alert message for that target but still for other ships coming too close. +

+ +

Ships name

+ +

+The Ship name connected to a MMSI ID will be added to the list once the new ID is saved or edited. The ship name is automatically printed provided that the actual ship is present on screen or has previously been and was saved in the AIS ship name file. In either case the ship name will be added first time the boat is present in OpenCPN. +

+ +

+ + +

+ + diff -Nru opencpn-doc-4.8.10129.2/doc/options_setting/user_interface.html opencpn-doc-4.8.2.0/doc/options_setting/user_interface.html --- opencpn-doc-4.8.10129.2/doc/options_setting/user_interface.html 1970-01-01 00:00:00.000000000 +0000 +++ opencpn-doc-4.8.2.0/doc/options_setting/user_interface.html 2018-02-07 14:43:14.000000000 +0000 @@ -0,0 +1,370 @@ + + + + + opencpn:opencpn_user_manual:options_setting:user_interface + + + + + + + + + + + + + + + + + + + + + +

+ + + +

The User Interface

+ +

Languages:

+ +

+The following languages are available in OpenCPN: +

Brazilian Portuguese
+
Catalan
+
Chinese
+
Traditional
+
Czech
+
Danish
+
Dutch
+
English
+
Estonian
+
Finnish
+
French
+
Galician
+
German
+
Greek
+
Hungarian
+
Italian
+
Norwegian Bokmaal
+
Polish
+
Portuguese
+
Russian
+
Spanish
+
Swedish
+
Turkish
+

+ +

+Choose your language here. Make sure your selected language has the support files installed on your computer (Linux). Default language is US English. +

+ +

+Remark: Changing the language will reset the font settings. +

+ +

+Toolbar and Window Style Menubar. The alternatives are described in Toolbar Buttons and Windows/Mac style MenuBar +

+ +

Fonts

+ +

+On a new installation OpenCPN uses the operating system's default fonts. This can be changed to suit the user through this dialog. Fonts can be selected for many elements on the display. Selecting the right size of font can have a dramatic impact on how values are presented. It's well worth playing around with these settings if you think that something is difficult to read for example. Note that even the text displayed on vector charts can be adjusted. +

+ +

Pick from the Dropdown List

AIS Target Name - Target List font size
+
AIS target List uses the “Dialog” font key.
+
AISRollover - Yellow rollover font size
+
AISTargetAlert - Popup alert font size
+
AISTargetQuery -Query Popup
+
ChartTexts -
+
Console Legend - Active Route Console XTE, Bearing, etc (upper right black box, see below)
+
Console Value - Active Route Console - Font Size of the data presented.
+
CurrentValue -
+
Dialog - AIS Target List
+
ExtendedTideIcon -
+
Marks - Properties font size
+
Menu - Main menu font size
+
ObjectQuery -Object Query font size
+
OD_PathLegInfoRollover - OD Plugin Yellow Rollover font size
+
OD_PointInfoRollover - OD Plugin Yellow Rollover font size
+
RouteLegInfoRollever - Route Leg Yellow Rollover font size
+
StatusBar - Status Font at bottom
+
TideCurrentGraphRollover -
+
ToolTips -
+

+ +

+The result of adjusting the “Console Value” font size. +

+ +

+There is a side effect of the Font management module, which is worth noting. One must actually display something in a particular Font List category (ChartText, Console Legend, Console Value, etc.) in order for the item to appear in the list for the first time. Thereafter, the item should stay in the list and be available for editing. For Example: You may not see the Font List entry for “AIS Rollover” unless you have actually displayed an AIS Rollover message at least once. Of course, if you re-install OpenCPN or start with a new config file there may be limited entries in the FontList. +

+ +

Change Font Color

+ +

+To suit your taste. +

+ +

Show Status Bar

+ +

+The status bar at the bottom of the display contains a lot of navigation information. If you have this info available elsewhere turning this setting off increases the available space for the chart. +

+ +

Show Menu Bar

+ +

+Show/Hide the Menu Bar. More about MenuBar
+Short Cut: “Alt” +

+ +

Show Chart Bar

+ +

+Show/Hide the Chart Bar. More info available on the Chart Status Bar page.
+Short Cut: “Ctrl + B” +

+ +

Show Compass/GPS Status Window

+ +

+ Show/Hide the Compass/GPS Status Window. More info on the GPS Status page.
+Short Cut: “Ctrl + I” +

+ +

Enable Toolbar Auto Hide

+ +

+Enter number of seconds for the Toolbar to automatically hide. +

+ +

Play ship bells

+ +

+Every half-hour the traditional ship's bell will be heard. Refer to https://en.wikipedia.org/wiki/Ship%27s_bell if you are not familiar with them. +

+ +

Enable Touchscreen Interface

+ +

Touch Screen Tablets

+ +

+Read more at Touch Screen Tablets +

+ +

Enable Graphical User Interface

+ +

+Enable [Responsive] Graphical User Interface for Touchscreens and Tablets. +

+ +

+Enlarges Toolbar Buttons & other elements for touch purposes. +

+ +

+The option is intended for small (~8“) tablets with high definition displays. What it does is adjust the various graphic elements such as menus, icons, etc. so that they meet the best practice size standards for Win8/Android system displays. This makes them “big enough” to facilitate touching, dragging, etc with normal human fingers. You should not see much difference when selecting this option for normal desktop or laptop systems. +

+ +

Use settings for InlandECDIS 2.2

+ +

+Use Settings for InlandECDIS 2.2 Switch to compliance mode for Europe Inland Waterways ECDIS in information mode. Read more at InlandECDIS +

+ +

+If either of the Graphical User Interface boxes are checked, the slider “User Interface scale factor” changes the size of the Tool Bar, Chart Bar and the GPS status icon. +

+ +

+If the “Enable Tablet Scaled Graphics interface” is checked, the slider “Chart Object scale factor” changes the size of chart objects including: Marks, Routes, Buoys, Daybeacons, Wrecks, Rocks, and Depths. +

+ +

+Note: selecting “Use Settings for InlandECDIS Version 2.3” will have effect on your Toolbar Icons!
+Only 7 of the 17 available Toolbar Icons will be visible.
+ +

+ +

+You can select other Toolbar Icons, but your changes will not be saved when you exit OpenCPN.
+ +
+ +

+ +

Three Scale Factors

+ +

+ Three Scales +

+ +

User Interface Scale Factor

+ +

+If either of the Graphical User Interface boxes are checked, the slider “User Interface scale factor” changes the size of the Tool Bar, Chart Bar and the GPS status icon. Useful to adjust the size of the UI. +

+ +

Chart Object Scale Factor

+ +

+If the “Enable Tablet Scaled Graphics interface” is checked, the slider “Chart Object scale factor” changes the size of chart objects including: Depth Soundings, Marks, Routes, Buoys, Daybeacons, Wrecks and Rocks. +

+ +

Ship & AIS Scale Factor

+ +

+If the “Enable Tablet Scaled Graphics interface” is checked, the slider “Ship scale factor” changes the size of chart objects including: Ship Icon, AIS & ATON Symbols. +

+ +

+We do not reduce the ownship size below effective value of 0, so to be sure of always finding the ship on the screen. A user safety point. +

+ +

+ + +

+ + diff -Nru opencpn-doc-4.8.10129.2/doc/options_setting.html opencpn-doc-4.8.2.0/doc/options_setting.html --- opencpn-doc-4.8.10129.2/doc/options_setting.html 2018-01-30 12:28:30.000000000 +0000 +++ opencpn-doc-4.8.2.0/doc/options_setting.html 2018-02-07 14:43:14.000000000 +0000 @@ -1,158 +1,158 @@ - - - - - opencpn:opencpn_user_manual:options_setting - - - - - - - - - - - - - - - - - - - - - -

- - - -

OPTIONS Setting

- -

-Click the icon to open the Options Dialog which has 6 tabs, as seen below. All Settings that are not context sensitive are set in Options. The Settings are persistent, meaning that settings entered in one session will still be there on restart. -

- -

Quick links to content on other pages.

- -

-The Display
- - General
- - Units
- - Advanced
- -
- -The Chart
- - Chart Files
- - Vector Charts Display
- - Chart Groups
- - Tides and Currents
- -
- -The Connections
- - Linux Serial Connections
- - Connections Window
- - Example Data Connections Window
- - Filter NMEA Course and Speed Data
- - Show NMEA Debug Window
- - Data Connections - Add and Remove
- - Add a Serial Connection
- - Add a Network Connection
- - Network GPSD connection
- - Connections Filter
- - Input Filtering
- - Output Filtering
- - Connection Notes
- - Sending an Active Route to an Autopilot
- - Sending Routes and Waypoints to a GPS
- - Broadcast and Multicast
- -

- -

-
- -The Ships
- - Own Ship
- - AIS Targets
- - MMSI Properties
- -
- -The User Interface
- - Graphical User Interface
- - Touch Screen Tablets
- - InlandECDIS
- -
- -The Plugins
- - Plugins
- -
- -Click the icon to open the Options Dialog which has 6 tabs, as seen above. All Settings that are not context sensitive are set in Options. The Settings are persistent, meaning that settings entered in one session will still be there on restart. -

- -

- - -

- - + + + + + opencpn:opencpn_user_manual:options_setting + + + + + + + + + + + + + + + + + + + + + +

+ + + +

OPTIONS Setting

+ +

+Click the icon to open the Options Dialog which has 6 tabs, as seen below. All Settings that are not context sensitive are set in Options. The Settings are persistent, meaning that settings entered in one session will still be there on restart. +

+ +

Quick links to content on other pages.

+ +

+The Display
+ + General
+ + Units
+ + Advanced
+ +
+ +The Chart
+ + Chart Files
+ + Vector Charts Display
+ + Chart Groups
+ + Tides and Currents
+ +
+ +The Connections
+ + Linux Serial Connections
+ + Connections Window
+ + Example Data Connections Window
+ + Filter NMEA Course and Speed Data
+ + Show NMEA Debug Window
+ + Data Connections - Add and Remove
+ + Add a Serial Connection
+ + Add a Network Connection
+ + Network GPSD connection
+ + Connections Filter
+ + Input Filtering
+ + Output Filtering
+ + Connection Notes
+ + Sending an Active Route to an Autopilot
+ + Sending Routes and Waypoints to a GPS
+ + Broadcast and Multicast
+ +

+ +

+
+ +The Ships
+ + Own Ship
+ + AIS Targets
+ + MMSI Properties
+ +
+ +The User Interface
+ + Graphical User Interface
+ + Touch Screen Tablets
+ + InlandECDIS
+ +
+ +The Plugins
+ + Plugins
+ +
+ +Click the icon to open the Options Dialog which has 6 tabs, as seen above. All Settings that are not context sensitive are set in Options. The Settings are persistent, meaning that settings entered in one session will still be there on restart. +

+ +

+ + +

+ + diff -Nru opencpn-doc-4.8.10129.2/doc/plugins/included_plugins/dashboard.html opencpn-doc-4.8.2.0/doc/plugins/included_plugins/dashboard.html --- opencpn-doc-4.8.10129.2/doc/plugins/included_plugins/dashboard.html 2018-01-30 12:28:30.000000000 +0000 +++ opencpn-doc-4.8.2.0/doc/plugins/included_plugins/dashboard.html 2018-02-07 14:43:14.000000000 +0000 @@ -1,503 +1,503 @@ - - - - - opencpn:opencpn_user_manual:plugins:included_plugins:dashboard - - - - - - - - - - - - - - - - - - - - - -

- - - -

Dashboard

- -

-The Dashboard plugin is able to show quite a few instruments. -The Dashboard plugin is always distributed with OpenCPN, no separate download is required. -

- -

-If the data is available to OpenCPN in the NMEA0183 data stream the different instruments will display relevant data; but the plugin won't tell what is available. It is assumed that the user knows what is connected. It is of course possible to activate all instruments and see what works. -

- -

The Dashboard in action

- -

-There are two Dashboards, one vertical and one horizontal. -

- -

-Grab the top Caption bar with the cursor and drag the Dashboard as far as possible to the right or left. Let go the cursor, and the Dashboard will dock, the chart display will adjust, no part of the chart will be hidden. Horizontal Dashboards can in a similar way be docked top or bottom. -This process is reversible. Just grab the Dashboard dialog bar with the cursor, an pull towards the middle of the screen, and the Dashboard will become floating. -

- -

-The same Dashboards docked left and bottom. -

- -

-There is a grab handle in the SE corner of each Dashboard. Use it to resize each dialog. -The graphics will change size, but not the text, which is handled separately. See further down. -

- -

The Dashboard Tab

- -

-Once the Dashboard plugin is activated in the plugin tab, the Dashboard Icon will be available in the ToolBar and will work as an on/off toggle. The Preference button works exactly the same as described under “Dashboard Settings” below. -

- -

-The “Enable” Button activates the plugin and shows the icon in the ToolBar. -Once enabled, the “Disable” Button is displayed, as show above. -If you press the “Preference” Button the Dashboard preferences dialog becomes available. -

- -

Dashboard settings

- -

-Right click anywhere in a Dashboard and a few options are displayed, in a small dialog. -Above we have clicked on the vertical Dashboard. Make this Dashboard horizontal by clicking the “Horizontal” radio button. Stop displaying it by un-ticking the box in front of the first “Dashboard” line. Get it back by right clicking on the other Dashboard and tick the same box again. -

- -

Preferences

- -

The Dashboard Tab

- -

-The Icons in the narrow pane to the left, represents the available instances. Click on an instance and the configured instruments shows in the “Instruments” pane. -

- -

-“+” and “-“ Add or delete a Dashboard instance. Note, that an active Dashboard can not be deleted as the ”-” will be grayed out. Configure a new instance by “Add”-ing instruments in the “Instrument” pane. -

- -

-Show this Dashboard If ticked just that Dashboard is shown. Toggling the icon displays all Dashboards. -

- -

-Caption changes the name of the DashBoard from the default “Dashboard” to the Caption value. -Due to a wxWidgets bug, this change is not instant, and requires docking the Dashboard or restarting OpenCPN, to work. -

- -

-Orientation A dash board can be either Vertical or Horizontal. -Vertical can be docked left or right, Horizontal can be docked top or bottom. -

- -

-The “Instruments” pane. Shows the Instruments that are “active”, that will show up in that particular Dashboard .The instruments are selected with the buttons to the right. -

- -

-Add. This button brings up the “Add Instrument” dialog where the available instruments can be highlighted and added to the Instruments Window. -

- -

40 Instruments Available

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

Position (text)

SOG (text) -Speed Over Ground

Speedometer (dial)

COG(text) - Course Over Ground

GPS Compass(dial)

STW(text) Speed Through Water

True HDG(text) Heading

Apparent WindAngle & Speed(dial) See MWV

App. Wind speed(text)

App. Wind speed(dial)

True Wind Angle & Speed(dial)

Depth(text)¹

Depth(dial)¹

Water Temp(text)

VMG(text)- Velocity Made Good to a waypoint

VMG(dial)

Rudder Angle(text)

Rudder Angle(dial)

GPS in view(text)- the number of satellites detected²

GPS status(dial)²

Cursor, shows the position of the cursor.

Clock, showing UTC from the NMEA stream, in most cases this is the gps time.

Sunrise/Sunset

Moon phase

Air Temp

App. Wind angle

True Wind angle

True Wind direction

True Wind Speed

True Wind Direction and speed

Magnetic Hdg

True Compass

Wind History

Trip Log

Sum Log

Barometric Pressure (dial)

Barometric Pressure (text)

Barometric History

From Ownship. Shows the vector from Ownship to the cursor.

Magnetic COG²
-

- -

-1. The DPT sentence is used, and transducer offset will be added to depth value, if available.
- -2. Linux note: GPS satellite info is not available if using gpsd. -The same informations is however available through the “xgps” command. -

- -

Delete

- -

-Highlight an entry in the Instrument Window to delete it. -

- -

Up / Down

- -

-Highlight an entry in the Instrument Window and change the order between the selected instruments. This order will also be the order between the instruments in the Dashboard dialog. -

- -

The Appearance Tab

- -

-Use this tab to set fonts. -

- -

Dampen SOG and COG (IR Filter)

- -

-There are 2 parameters in the Dashboard→Preferences→Appearance dialog for damping of SOG and COG. -A value of 1 means no filtering. Higher values mean ever slower response of the instrument. -The max filter value is 100 which is pretty slow. This filter works almost exactly like a mechanical filter that uses an oil damped indicator dial. It will respond gradually to a change in course or speed. A typical filter value of 10 seems to work pretty well. -

- -

Units Selection

- -

-Select these parameters as suits your use. These controls together enable the user to adjust the view of the dashboard to suit individual needs. -

- -

-Units Ranges and Formats -Set the units to use, and the range of the speed dial. -

- -

-
- -

- -

Wind History

- -

-The Wind History Instrument needs some further explanations. -

- -

-The “wind history” instrument is meant to be run as a standalone (vertical) instrument.
- -Just define a separate dashboard and add it as the only instrument. -

- -

-You can resize the Instrument with the mouse. -

- -

-In real conditions, it monitors around 40 min of wind direction (red), as well as wind speed (blue), showing a vertical time line every 5 min (the example screen shot is a full-speed VDR replay). -

- -

-The text on the top shows the current values, as it is displayed in the standard instruments (blue = wind speed data, TWS=True Wind Speed, red = direction, TWD = True Wind Direction). -

- -

-Here is an explanation of the text line, left side (see screen shot):
- -TWS 7.5: true Wind Speed currently 7.5 kts
- -Max 22.3 kts since 18:50: this is the max Wind speed in the visible graphs, i.e. the last ~40 mins
- -Overall 22.3: the max wind speed since OpenCPN was started. -

- -

-Right side above: -TWD 357 degrees: True wind direction currently 357 degrees -

- -

-The thin red/blue curves are the real direction/speed values, the thicker curves are smoothed values. Makes it easier to see trends. -

- -

-There is some logic included : -The instruments zooms automatically as much as possible, always trying to show the whole visible curve;
- -Wind speed curve:
- -if your max (visible) wind speed is 10 kts, then your scale is from 0…11 kts (rounded upwards to the next full knot).
- -In the screen shot we had a mx of 22.3kts –> scale is 0…23 kts.
- -Wind direction:
- -The instrument scale shows +/- 90 degrees of the currently visible data values, but is limited to a total of 360 degrees.
- -If the wind is shifting through North (from 350, 355, 359, 002, 010, …) we're shifting the curve as well, meaning that there is NO vertical jump in the data from 360 degrees –> 0 degrees, and we do NOT loose all the continuity in the smoothed curves ! -

- -

-If you should happen to have more than a full 360 degrees cycle of wind direction in the recorded data (if you sail through a couple of dust devils ), I limited the max scale to 360 degrees, meaning that the curve will run out of the visible area on bottom or on top of the instrument. -

- -

-Please note that you don't have to have the instrument “open” all the time. -Once activated as initially described, you can close it, and simply reopen it on demand. You don't loose the curves, the instrument continues to collect the data. -To make it visible again simply right click on an existing standard-dashboard, and click the “Wind History” Dashboard. -

- -

Night time Mode

- -

-In Windows, Night, F5, mode. The title bar on the floating dashboard window is a bit glaring (this mode is controlled by windows by way of a theme and is not possible to change from an application) . Dock the Dashboard into “docked mode” it will be less glaring. The best solution is to simply “dock” the dashboard window at night, either left or right. This brings the window decorations back under OCPN control, and we recently added logic to dim it in this mode. -

- -

Dashboard Time

- -

- -Drafting !! -

GPS clock - same as old Clock
-
Local GPS clock - GPS clock with offset (see more below)
-
Local CPU clock - Local CPU clock obtained from operating system
-

- -

-Local GPS clock has 2 options for time zone. On the appearance tab of the Dashboard preferences there is a new setting for “Local offset from UTC”. The default is 00:00. When the 00:00 is selected then Local GPS clock will display time in the time zone of the computer running OpenCPN. If that is not what you want then you can selected any other offset in 30 minute increments up to +/- 12 hours. That offset will be added to the GPS UTC time and the local computer time zone will be ignored. -

- -

Sunrise - Sunset

- -

-Sunrise/sunset are computed based on the date and lat/long from the GPS NMEA input data. They are not computed from the CPU clock or the ship's position. So unless you have a GPS connected then the times of sunrise/sunset are probably not going to be right. It has always been thus. -

- -

- - -

- - + + + + + opencpn:opencpn_user_manual:plugins:included_plugins:dashboard + + + + + + + + + + + + + + + + + + + + + +

+ + + +

Dashboard

+ +

+The Dashboard plugin is able to show quite a few instruments. +The Dashboard plugin is always distributed with OpenCPN, no separate download is required. +

+ +

+If the data is available to OpenCPN in the NMEA0183 data stream the different instruments will display relevant data; but the plugin won't tell what is available. It is assumed that the user knows what is connected. It is of course possible to activate all instruments and see what works. +

+ +

The Dashboard in action

+ +

+There are two Dashboards, one vertical and one horizontal. +

+ +

+Grab the top Caption bar with the cursor and drag the Dashboard as far as possible to the right or left. Let go the cursor, and the Dashboard will dock, the chart display will adjust, no part of the chart will be hidden. Horizontal Dashboards can in a similar way be docked top or bottom. +This process is reversible. Just grab the Dashboard dialog bar with the cursor, an pull towards the middle of the screen, and the Dashboard will become floating. +

+ +

+The same Dashboards docked left and bottom. +

+ +

+There is a grab handle in the SE corner of each Dashboard. Use it to resize each dialog. +The graphics will change size, but not the text, which is handled separately. See further down. +

+ +

The Dashboard Tab

+ +

+Once the Dashboard plugin is activated in the plugin tab, the Dashboard Icon will be available in the ToolBar and will work as an on/off toggle. The Preference button works exactly the same as described under “Dashboard Settings” below. +

+ +

+The “Enable” Button activates the plugin and shows the icon in the ToolBar. +Once enabled, the “Disable” Button is displayed, as show above. +If you press the “Preference” Button the Dashboard preferences dialog becomes available. +

+ +

Dashboard settings

+ +

+Right click anywhere in a Dashboard and a few options are displayed, in a small dialog. +Above we have clicked on the vertical Dashboard. Make this Dashboard horizontal by clicking the “Horizontal” radio button. Stop displaying it by un-ticking the box in front of the first “Dashboard” line. Get it back by right clicking on the other Dashboard and tick the same box again. +

+ +

Preferences

+ +

The Dashboard Tab

+ +

+The Icons in the narrow pane to the left, represents the available instances. Click on an instance and the configured instruments shows in the “Instruments” pane. +

+ +

+“+” and “-“ Add or delete a Dashboard instance. Note, that an active Dashboard can not be deleted as the ”-” will be grayed out. Configure a new instance by “Add”-ing instruments in the “Instrument” pane. +

+ +

+Show this Dashboard If ticked just that Dashboard is shown. Toggling the icon displays all Dashboards. +

+ +

+Caption changes the name of the DashBoard from the default “Dashboard” to the Caption value. +Due to a wxWidgets bug, this change is not instant, and requires docking the Dashboard or restarting OpenCPN, to work. +

+ +

+Orientation A dash board can be either Vertical or Horizontal. +Vertical can be docked left or right, Horizontal can be docked top or bottom. +

+ +

+The “Instruments” pane. Shows the Instruments that are “active”, that will show up in that particular Dashboard .The instruments are selected with the buttons to the right. +

+ +

+Add. This button brings up the “Add Instrument” dialog where the available instruments can be highlighted and added to the Instruments Window. +

+ +

40 Instruments Available

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Position (text)

SOG (text) -Speed Over Ground

Speedometer (dial)

COG(text) - Course Over Ground

GPS Compass(dial)

STW(text) Speed Through Water

True HDG(text) Heading

Apparent WindAngle & Speed(dial) See MWV

App. Wind speed(text)

App. Wind speed(dial)

True Wind Angle & Speed(dial)

Depth(text)¹

Depth(dial)¹

Water Temp(text)

VMG(text)- Velocity Made Good to a waypoint

VMG(dial)

Rudder Angle(text)

Rudder Angle(dial)

GPS in view(text)- the number of satellites detected²

GPS status(dial)²

Cursor, shows the position of the cursor.

Clock, showing UTC from the NMEA stream, in most cases this is the gps time.

Sunrise/Sunset

Moon phase

Air Temp

App. Wind angle

True Wind angle

True Wind direction

True Wind Speed

True Wind Direction and speed

Magnetic Hdg

True Compass

Wind History

Trip Log

Sum Log

Barometric Pressure (dial)

Barometric Pressure (text)

Barometric History

From Ownship. Shows the vector from Ownship to the cursor.

Magnetic COG²
+

+ +

+1. The DPT sentence is used, and transducer offset will be added to depth value, if available.
+ +2. Linux note: GPS satellite info is not available if using gpsd. +The same informations is however available through the “xgps” command. +

+ +

Delete

+ +

+Highlight an entry in the Instrument Window to delete it. +

+ +

Up / Down

+ +

+Highlight an entry in the Instrument Window and change the order between the selected instruments. This order will also be the order between the instruments in the Dashboard dialog. +

+ +

The Appearance Tab

+ +

+Use this tab to set fonts. +

+ +

Dampen SOG and COG (IR Filter)

+ +

+There are 2 parameters in the Dashboard→Preferences→Appearance dialog for damping of SOG and COG. +A value of 1 means no filtering. Higher values mean ever slower response of the instrument. +The max filter value is 100 which is pretty slow. This filter works almost exactly like a mechanical filter that uses an oil damped indicator dial. It will respond gradually to a change in course or speed. A typical filter value of 10 seems to work pretty well. +

+ +

Units Selection

+ +

+Select these parameters as suits your use. These controls together enable the user to adjust the view of the dashboard to suit individual needs. +

+ +

+Units Ranges and Formats +Set the units to use, and the range of the speed dial. +

+ +

+
+ +

+ +

Wind History

+ +

+The Wind History Instrument needs some further explanations. +

+ +

+The “wind history” instrument is meant to be run as a standalone (vertical) instrument.
+ +Just define a separate dashboard and add it as the only instrument. +

+ +

+You can resize the Instrument with the mouse. +

+ +

+In real conditions, it monitors around 40 min of wind direction (red), as well as wind speed (blue), showing a vertical time line every 5 min (the example screen shot is a full-speed VDR replay). +

+ +

+The text on the top shows the current values, as it is displayed in the standard instruments (blue = wind speed data, TWS=True Wind Speed, red = direction, TWD = True Wind Direction). +

+ +

+Here is an explanation of the text line, left side (see screen shot):
+ +TWS 7.5: true Wind Speed currently 7.5 kts
+ +Max 22.3 kts since 18:50: this is the max Wind speed in the visible graphs, i.e. the last ~40 mins
+ +Overall 22.3: the max wind speed since OpenCPN was started. +

+ +

+Right side above: +TWD 357 degrees: True wind direction currently 357 degrees +

+ +

+The thin red/blue curves are the real direction/speed values, the thicker curves are smoothed values. Makes it easier to see trends. +

+ +

+There is some logic included : +The instruments zooms automatically as much as possible, always trying to show the whole visible curve;
+ +Wind speed curve:
+ +if your max (visible) wind speed is 10 kts, then your scale is from 0…11 kts (rounded upwards to the next full knot).
+ +In the screen shot we had a mx of 22.3kts –> scale is 0…23 kts.
+ +Wind direction:
+ +The instrument scale shows +/- 90 degrees of the currently visible data values, but is limited to a total of 360 degrees.
+ +If the wind is shifting through North (from 350, 355, 359, 002, 010, …) we're shifting the curve as well, meaning that there is NO vertical jump in the data from 360 degrees –> 0 degrees, and we do NOT loose all the continuity in the smoothed curves ! +

+ +

+If you should happen to have more than a full 360 degrees cycle of wind direction in the recorded data (if you sail through a couple of dust devils ), I limited the max scale to 360 degrees, meaning that the curve will run out of the visible area on bottom or on top of the instrument. +

+ +

+Please note that you don't have to have the instrument “open” all the time. +Once activated as initially described, you can close it, and simply reopen it on demand. You don't loose the curves, the instrument continues to collect the data. +To make it visible again simply right click on an existing standard-dashboard, and click the “Wind History” Dashboard. +

+ +

Night time Mode

+ +

+In Windows, Night, F5, mode. The title bar on the floating dashboard window is a bit glaring (this mode is controlled by windows by way of a theme and is not possible to change from an application) . Dock the Dashboard into “docked mode” it will be less glaring. The best solution is to simply “dock” the dashboard window at night, either left or right. This brings the window decorations back under OCPN control, and we recently added logic to dim it in this mode. +

+ +

Dashboard Time

+ +

GPS clock - same as old Clock
+
Local GPS clock - GPS clock with offset (see more below)
+
Local CPU clock - Local CPU clock obtained from operating system
+

+ +

+Local GPS clock has 2 options for time zone. On the appearance tab of the Dashboard preferences there is a new setting for “Local offset from UTC”. The default is 00:00. When the 00:00 is selected then Local GPS clock will display time in the time zone of the computer running OpenCPN. If that is not what you want then you can selected any other offset in 30 minute increments up to +/- 12 hours. That offset will be added to the GPS UTC time and the local computer time zone will be ignored. +

+ +

Sunrise - Sunset

+ +

+Sunrise/sunset are computed based on the date and lat/long from the GPS NMEA input data. They are not computed from the CPU clock or the ship's position. So unless you have a GPS connected then the times of sunrise/sunset are probably not going to be right. It has always been thus. +

+ +

+ + +

+ + diff -Nru opencpn-doc-4.8.10129.2/doc/plugins/included_plugins/grib_weather/mail_servers.html opencpn-doc-4.8.2.0/doc/plugins/included_plugins/grib_weather/mail_servers.html --- opencpn-doc-4.8.10129.2/doc/plugins/included_plugins/grib_weather/mail_servers.html 2018-01-30 12:28:30.000000000 +0000 +++ opencpn-doc-4.8.2.0/doc/plugins/included_plugins/grib_weather/mail_servers.html 2018-02-07 14:43:14.000000000 +0000 @@ -1,556 +1,556 @@ - - - - - opencpn:opencpn_user_manual:plugins:included_plugins:grib_weather:mail_servers - - - - - - - - - - - - - - - - - - - - - -

- -

Mail Servers

- -

Warning!

- -

-This is an Advanced subject, that is not necessary for running the grib plugin.
- -Do not try these setups unless you are familiar with your operating system, comfortable with handling the command line interface and editing configuration files.
- -Do not expect these instructions to work without some customization. -

- -

-This page contains detailed instructions on how to set up mailservers to automatically send grib request mails to Sail Docs.
- -“Ptizef” & “rgleason” have compiled the instructions for Windows/Thunderbird
- -“Ptizef” has compiled the instructions for Linux/SSMTP.
- -“Cagney” has compiled the instructions for Linux/Exim4.
- -“CarCode” has compiled the instructions for Mac OS X/PostFix . -

- -

Windows MAPI Mail Server Setup

- -

-The plugin's email request depends on the user's selection of the default MAPI email program which is dependent on the Operating System conventions. Linux, Windows and Mac are all different. If the plugin does not find a default MAPI program, an appropriate message will show in the plugin menu: -

 Request can't be sent. Please verify your email system parameters.
- You should also have a look at your log file.
- Save or Cancel to finish...

- -

-and there will be an error message in the opencpn.log similar to: -

 10:55:47 PM: MAIL Error: Failed to logon to MAPI using a shared session, Error:3

- -

-To fix this problem use a google search, and find links such as Fix CLS Send, MAPI or Runtime Error in Email -

- -

Windows 10 or 8.1 and Thunderbird

- -

-For example, if you use Thunderbird exclusively with Win10 or Win8.1, this should fix the problem -

 Start > Control Panel > Default Programs > Set your Default Programs,  Then pick Thunderbird.

- -

Windows Vista or XP and Thunderbird

- -

-- Outside OpenCPN there is nothing more to do except to ensure that there is a mail system (mine is thunderbird) correctly configured and set as “main” on the device.
- -also verify if the mapi32.dll is present in c:/windows/system32 (or equivalent for 64b) (otherwise an error message will be the result). -

- -

-- Inside OpenCPN, there is nothing to do; the sender mail address can be entered, but will not be used. Just don't forget to enter the zyGRIB login and password. -

- -

-When clicking on “send” button :
- -if the “main” mail system is not open, OpenCPN opens it and the waiting messages are received.
- -remark : if there are many waiting messages, it could take a while. That is why it would be better to create a specific address for this purpose.
- -Then a new mail page is opened with all mail elements already written thus ready to be sent. -

- -

Linux

- -

Using SSMTP

- -

-How to install and configure sSMTP: -

- -

-- 1) Install the ssmtp package.
- -If another MTA is already installed, you may be asked to uninstall it before installing ssmtp. -

- -

-Once it's done you can test it by typing this command:
- -“whereis sendmail” -

- -

-The answer should be something like “/usr/sbin/sendmail”. -

- -

-Use that answer in the next command:
- -“ls -la /usr/sbin/sendmail” -

- -

-If everything is OK you should get this answer:
- -“/usr/sbin/sendmail → ssmtp”
- -showing that Sendmail function is now connected to ssmtp. -

- -

-- 2) Now there are two files to set: -

- -

-the first file : /etc/ssmtp/ssmtp.conf ( with root rights )
- -
- -The typical setting should be:
- -root=postmaster
- -AuthUser=yourlogin to your ISP access
- -AuthPass=yourpasseword to your ISP access
- -mailhub=yourISPserveurname.yourdomain (for example smtp.orange.fr)
- -rewriteDomain=yourdomain
- -FromLineOverride=YES
- -hostname= the full host-name ( normally automatically entered, but if not you can type the command : “hostname” to get it)
- -
- -For ISP requiring a TLS connection , it could be necessary to add the line UseTLS=YES or UseSTARTTLS=YES
- -
- -the second file : /etc/ssmtp/revaliases (with root rights)
- -
- -Enter this line.
- -root:yourlogin@yourdomain:yourISPserveurname.yourd omainort
- -
- -the default port was 25 but now many ISP refuse it and use 587. If you have a mail system, you will find the right value in it.sudo dpkg-reconfigure exim4-config
- -Sendmail/Postfix install for Mac
- -- Inside OpenCPN :You must enter the sender address : your entire mail address, the one you will use to send mails and receive answers
- -
- -When you click on the “send” button, the mail is directly sent. You can find the log here : /var/log/mail.log
- -

- -

Using Exim4

- -

-First install Exim4
- -$sudo apt-get install exim4
- -then configure it (again).
- -$sudo dpkg-reconfigure exim4-config
- -This is a very simple setup where exim is just used to forward mail to the ISP:s smtp server. Local system mail is also available. -

- -

-
- -It's important to use the choice above. -

- -

-
- -I just use “localhost”. -

- -

-
- -We have no incoming connections. -

- -

-
- -We are not using this. -

- -

-
- -We are not using this. -

- -

-
- -This is important. It must point to your Internet Service Providers SMTP server. -

- -

-
- -Your choice! -

- -

-
- -RTFM and make up your mind. Not a big deal for this simple setup. -

- -

-
- -RTFM. -

- -

-
- -Your Choice, but no point in splitting this simple setup. -

- -

-Edit /etc/exim4/passwd.client so it contains your username and password to your ISP:s mail server. -

- - - -

# password file used when the local exim is authenticating to a remote_PARATABLE_INS_# host as a client._PARATABLE_INS_#_PARATABLE_INS_# see exim4_passwd_client(5) for more documentation_PARATABLE_INS_#_PARATABLE_INS_# Example:_PARATABLE_INS_### target.mail.server.example:login:password_PARATABLE_INS_# for OpenCPN you can use *:login:password_PARATABLE_INS_*:fakexyz123:madeupXYZ123

- -

-(Re)start Exim4
- -$ /etc/init.d/exim4 {start|stop|restart|reload|status|what|force-stop}
- -Start testing
- -
- -
- -
- -

- -

Mac OS X

- -

Using Sendmail/Postfix

- -

-
- -It is not so easy to install this on a Mac since you will need some experience with terminal using. The example below uses an googlemail account and nano as editor:
- -
- -Step 1
- -Type in terminal these 6 lines one after another with return:
- -sudo mkdir -p /Library/Server/Mail/Data/spool
- -
- -sudo gzip /usr/share/man/man1/{postalias.1,postcat.1,postconf.1,postdrop.1,postf ix.1,postkick.1,postlock.1,postlog.1,postmap.1,pos tmulti.1,postqueue.1,postsuper.1,sendmail.1}
- -
- -sudo gzip /usr/share/man/man5/{access.5,aliases.5,bounce.5,canonical.5,cidr_tabl e.5,generic.5,header_checks.5,ldap_table.5,master. 5,mysql_table.5,nisplus_table.5,pcre_table.5,pgsql _table.5,postconf.5,postfix-wrapper.5,regexp_table.5,relocated.5,tcp_table.5,t ransport.5,virtual.5}
- -
- -sudo gzip /usr/share/man/man8/{anvil.8,bounce.8,cleanup.8,discard.8,error.8,flus h.8,local.8,master.8,oqmgr.8,pickup.8,pipe.8,proxy map.8,qmgr.8,qmqpd.8,scache.8,showq.8,smtp.8,smtpd .8,spawn.8,tlsmgr.8,trivial-rewrite.8,verify.8,virtual.8}
- -
- -sudo /usr/sbin/postfix set-permissions
- -
- -sudo chmod 700 /Library/Server/Mail/Data/mta
- -
- -Step 2
- -Type in terminal another command to start the nano editor with this file:
- -sudo nano /etc/postfix/sasl_passwd
- -
- -Type into the nano editor:
- -smtp.googlemail.com:587 YourAccountname@googlemail.com:YourPassword
- -
- -Substitute YourAccountname and YourPassword with your data.
- -Save the file in nano with Ctrl-O and exit with Ctrl-X.
- -
- -Step 3
- -Publicate the new file in terminal with this command:
- -sudo postmap /etc/postfix/sasl_passwd
- -
- -Step 4
- -You have to edit the main config file and add at the end the following lines with
- -this command in Terminal:
- -sudo nano /etc/postfix/main.cf
- -
- -This to add:
- -# Minimum Postfix-specific configurations.
- -mydomain_fallback = localhost
- -mail_owner = _postfix
- -setgid_group = _postdrop
- -relayhost=smtp.googlemail.com:587
- -
- -# Enable SASL authentication in the Postfix SMTP client.
- -smtp_sasl_auth_enable=yes
- -smtp_sasl_password_maps=hash:/etc/postfix/sasl_passwd
- -smtp_sasl_security_options=
- -
- -# Enable Transport Layer Security (TLS), i.e. SSL.
- -smtp_use_tls=yes
- -smtp_tls_security_level=encrypt
- -tls_random_source=dev:/dev/urandom
- -
- -Save the file and exit nano as in step 2.
- -
- -Step 5
- -Now you can start postfix in terminal with:
- -sudo postfix start
- -
- -If an error occurs correct main.cf and start again with:
- -sudo postfix reload
- -
- -Step 6
- -Now you can test your work in terminal with:
- -date | mail -s test YourAccountname@googlemail.com
- -
- -
- -Done.
- -Supplemental
- -If you want to have started sendmail/postfix each time you start you start
- -your machine you can add these lines to the launch daemon:
- -<key>RunAtLoad</key>
- -<true/>
- -
- -Do this with this command in terminal:
- -sudo nano /System/Library/LaunchDaemons/org.postfix.master.plist
- -
- -After that this file should look like this:
- -<?xml version=“1.0” encoding=“UTF-8”?>
- -<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
- -<plist version=“1.0”>
- -<dict>
- -<key>Label«/key>
- -<string>org.postfix.master</string>
- -<key>Program</key>
- -<string>/usr/libexec/postfix/master</string>
- -<key>ProgramArguments</key>
- -<array>
- -<string>master</string>
- -<string>-e</string>
- -<string>60</string>
- -</array>
- -<key>QueueDirectories</key>
- -<array>
- -<string>/var/spool/postfix/maildrop</string>
- -</array>
- -<key>AbandonProcessGroup</key>
- -<true/>
- -<key>OnDemand/lt;/key>
- -<true/>
- -<key>RunAtLoad</key>
- -<true/>
- -</dict>
- -</plist>
- -

- -

-Instead of googlemail in this example you may use any other mail server. -

- -

- - -

- - + + + + + opencpn:opencpn_user_manual:plugins:included_plugins:grib_weather:mail_servers + + + + + + + + + + + + + + + + + + + + + +

+ +

Mail Servers

+ +

Warning!

+ +

+This is an Advanced subject, that is not necessary for running the grib plugin.
+ +Do not try these setups unless you are familiar with your operating system, comfortable with handling the command line interface and editing configuration files.
+ +Do not expect these instructions to work without some customization. +

+ +

+This page contains detailed instructions on how to set up mailservers to automatically send grib request mails to Sail Docs.
+ +“Ptizef” & “rgleason” have compiled the instructions for Windows/Thunderbird
+ +“Ptizef” has compiled the instructions for Linux/SSMTP.
+ +“Cagney” has compiled the instructions for Linux/Exim4.
+ +“CarCode” has compiled the instructions for Mac OS X/PostFix . +

+ +

Windows MAPI Mail Server Setup

+ +

+The plugin's email request depends on the user's selection of the default MAPI email program which is dependent on the Operating System conventions. Linux, Windows and Mac are all different. If the plugin does not find a default MAPI program, an appropriate message will show in the plugin menu: +

 Request can't be sent. Please verify your email system parameters.
+ You should also have a look at your log file.
+ Save or Cancel to finish...

+ +

+and there will be an error message in the opencpn.log similar to: +

 10:55:47 PM: MAIL Error: Failed to logon to MAPI using a shared session, Error:3

+ +

+To fix this problem use a google search, and find links such as Fix CLS Send, MAPI or Runtime Error in Email +

+ +

Windows 10 or 8.1 and Thunderbird

+ +

+For example, if you use Thunderbird exclusively with Win10 or Win8.1, this should fix the problem +

 Start > Control Panel > Default Programs > Set your Default Programs,  Then pick Thunderbird.

+ +

Windows Vista or XP and Thunderbird

+ +

+- Outside OpenCPN there is nothing more to do except to ensure that there is a mail system (mine is thunderbird) correctly configured and set as “main” on the device.
+ +also verify if the mapi32.dll is present in c:/windows/system32 (or equivalent for 64b) (otherwise an error message will be the result). +

+ +

+- Inside OpenCPN, there is nothing to do; the sender mail address can be entered, but will not be used. Just don't forget to enter the zyGRIB login and password. +

+ +

+When clicking on “send” button :
+ +if the “main” mail system is not open, OpenCPN opens it and the waiting messages are received.
+ +remark : if there are many waiting messages, it could take a while. That is why it would be better to create a specific address for this purpose.
+ +Then a new mail page is opened with all mail elements already written thus ready to be sent. +

+ +

Linux

+ +

Using SSMTP

+ +

+How to install and configure sSMTP: +

+ +

+- 1) Install the ssmtp package.
+ +If another MTA is already installed, you may be asked to uninstall it before installing ssmtp. +

+ +

+Once it's done you can test it by typing this command:
+ +“whereis sendmail” +

+ +

+The answer should be something like “/usr/sbin/sendmail”. +

+ +

+Use that answer in the next command:
+ +“ls -la /usr/sbin/sendmail” +

+ +

+If everything is OK you should get this answer:
+ +“/usr/sbin/sendmail → ssmtp”
+ +showing that Sendmail function is now connected to ssmtp. +

+ +

+- 2) Now there are two files to set: +

+ +

+the first file : /etc/ssmtp/ssmtp.conf ( with root rights )
+ +
+ +The typical setting should be:
+ +root=postmaster
+ +AuthUser=yourlogin to your ISP access
+ +AuthPass=yourpasseword to your ISP access
+ +mailhub=yourISPserveurname.yourdomain (for example smtp.orange.fr)
+ +rewriteDomain=yourdomain
+ +FromLineOverride=YES
+ +hostname= the full host-name ( normally automatically entered, but if not you can type the command : “hostname” to get it)
+ +
+ +For ISP requiring a TLS connection , it could be necessary to add the line UseTLS=YES or UseSTARTTLS=YES
+ +
+ +the second file : /etc/ssmtp/revaliases (with root rights)
+ +
+ +Enter this line.
+ +root:yourlogin@yourdomain:yourISPserveurname.yourdomain + +
+ +the default port was 25 but now many ISP refuse it and use 587. If you have a mail system, you will find the right value in it.sudo dpkg-reconfigure exim4-config
+ +Sendmail/Postfix install for Mac
+ +- Inside OpenCPN :You must enter the sender address : your entire mail address, the one you will use to send mails and receive answers
+ +
+ +When you click on the “send” button, the mail is directly sent. You can find the log here : /var/log/mail.log
+ +

+ +

Using Exim4

+ +

+First install Exim4
+ +$sudo apt-get install exim4
+ +then configure it (again).
+ +$sudo dpkg-reconfigure exim4-config
+ +This is a very simple setup where exim is just used to forward mail to the ISP:s smtp server. Local system mail is also available. +

+ +

+
+ +It's important to use the choice above. +

+ +

+
+ +I just use “localhost”. +

+ +

+
+ +We have no incoming connections. +

+ +

+
+ +We are not using this. +

+ +

+
+ +We are not using this. +

+ +

+
+ +This is important. It must point to your Internet Service Providers SMTP server. +

+ +

+
+ +Your choice! +

+ +

+
+ +RTFM and make up your mind. Not a big deal for this simple setup. +

+ +

+
+ +RTFM. +

+ +

+
+ +Your Choice, but no point in splitting this simple setup. +

+ +

+Edit /etc/exim4/passwd.client so it contains your username and password to your ISP:s mail server. +

+ + + +

+ +

+(Re)start Exim4
+ +$ /etc/init.d/exim4 {start|stop|restart|reload|status|what|force-stop}
+ +Start testing
+ +
+ +
+ +
+ +

+ +

Mac OS X

+ +

Using Sendmail/Postfix

+ +

+
+ +It is not so easy to install this on a Mac since you will need some experience with terminal using. The example below uses an googlemail account and nano as editor:
+ +
+ +Step 1
+ +Type in terminal these 6 lines one after another with return:
+ +sudo mkdir -p /Library/Server/Mail/Data/spool
+ +
+ +sudo gzip /usr/share/man/man1/{postalias.1,postcat.1,postconf.1,postdrop.1,postf ix.1,postkick.1,postlock.1,postlog.1,postmap.1,pos tmulti.1,postqueue.1,postsuper.1,sendmail.1}
+ +
+ +sudo gzip /usr/share/man/man5/{access.5,aliases.5,bounce.5,canonical.5,cidr_tabl e.5,generic.5,header_checks.5,ldap_table.5,master. 5,mysql_table.5,nisplus_table.5,pcre_table.5,pgsql _table.5,postconf.5,postfix-wrapper.5,regexp_table.5,relocated.5,tcp_table.5,t ransport.5,virtual.5}
+ +
+ +sudo gzip /usr/share/man/man8/{anvil.8,bounce.8,cleanup.8,discard.8,error.8,flus h.8,local.8,master.8,oqmgr.8,pickup.8,pipe.8,proxy map.8,qmgr.8,qmqpd.8,scache.8,showq.8,smtp.8,smtpd .8,spawn.8,tlsmgr.8,trivial-rewrite.8,verify.8,virtual.8}
+ +
+ +sudo /usr/sbin/postfix set-permissions
+ +
+ +sudo chmod 700 /Library/Server/Mail/Data/mta
+ +
+ +Step 2
+ +Type in terminal another command to start the nano editor with this file:
+ +sudo nano /etc/postfix/sasl_passwd
+ +
+ +Type into the nano editor:
+ +smtp.googlemail.com:587 YourAccountname@googlemail.com:YourPassword
+ +
+ +Substitute YourAccountname and YourPassword with your data.
+ +Save the file in nano with Ctrl-O and exit with Ctrl-X.
+ +
+ +Step 3
+ +Publicate the new file in terminal with this command:
+ +sudo postmap /etc/postfix/sasl_passwd
+ +
+ +Step 4
+ +You have to edit the main config file and add at the end the following lines with
+ +this command in Terminal:
+ +sudo nano /etc/postfix/main.cf
+ +
+ +This to add:
+ +# Minimum Postfix-specific configurations.
+ +mydomain_fallback = localhost
+ +mail_owner = _postfix
+ +setgid_group = _postdrop
+ +relayhost=smtp.googlemail.com:587
+ +
+ +# Enable SASL authentication in the Postfix SMTP client.
+ +smtp_sasl_auth_enable=yes
+ +smtp_sasl_password_maps=hash:/etc/postfix/sasl_passwd
+ +smtp_sasl_security_options=
+ +
+ +# Enable Transport Layer Security (TLS), i.e. SSL.
+ +smtp_use_tls=yes
+ +smtp_tls_security_level=encrypt
+ +tls_random_source=dev:/dev/urandom
+ +
+ +Save the file and exit nano as in step 2.
+ +
+ +Step 5
+ +Now you can start postfix in terminal with:
+ +sudo postfix start
+ +
+ +If an error occurs correct main.cf and start again with:
+ +sudo postfix reload
+ +
+ +Step 6
+ +Now you can test your work in terminal with:
+ +date | mail -s test YourAccountname@googlemail.com
+ +
+ +
+ +Done.
+ +Supplemental
+ +If you want to have started sendmail/postfix each time you start you start
+ +your machine you can add these lines to the launch daemon:
+ +<key>RunAtLoad</key>
+ +<true/>
+ +
+ +Do this with this command in terminal:
+ +sudo nano /System/Library/LaunchDaemons/org.postfix.master.plist
+ +
+ +After that this file should look like this:
+ +<?xml version=“1.0” encoding=“UTF-8”?>
+ +<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+ +<plist version=“1.0”>
+ +<dict>
+ +<key>Label«/key>
+ +<string>org.postfix.master</string>
+ +<key>Program</key>
+ +<string>/usr/libexec/postfix/master</string>
+ +<key>ProgramArguments</key>
+ +<array>
+ +<string>master</string>
+ +<string>-e</string>
+ +<string>60</string>
+ +</array>
+ +<key>QueueDirectories</key>
+ +<array>
+ +<string>/var/spool/postfix/maildrop</string>
+ +</array>
+ +<key>AbandonProcessGroup</key>
+ +<true/>
+ +<key>OnDemand/lt;/key>
+ +<true/>
+ +<key>RunAtLoad</key>
+ +<true/>
+ +</dict>
+ +</plist>
+ +

+ +

+Instead of googlemail in this example you may use any other mail server. +

+ +

+ + +

+ + diff -Nru opencpn-doc-4.8.10129.2/doc/plugins/included_plugins/grib_weather.html opencpn-doc-4.8.2.0/doc/plugins/included_plugins/grib_weather.html --- opencpn-doc-4.8.10129.2/doc/plugins/included_plugins/grib_weather.html 2018-01-30 12:28:30.000000000 +0000 +++ opencpn-doc-4.8.2.0/doc/plugins/included_plugins/grib_weather.html 2018-02-07 14:43:14.000000000 +0000 @@ -1,829 +1,823 @@ - - - - - opencpn:opencpn_user_manual:plugins:included_plugins:grib_weather - - - - - - - - - - - - - - - - - - - - - -

- - - -

Grib Weather

- -

-OpenCPN has a grib weather file viewer plugin, aimed at being useful while under way.
- -The grib plugin is always distributed with OpenCPN, no separate download is required. -

- -

What is a grib file?

- -

-If you are not familiar with grib weather files, make sure you understand the basics, before you start to use them. It is essential to understand the limitations of weather forecasts that are distributed in the grib format.
- -It is also worth pointing out that gribs are not reliable near tropical systems.
- -Send a blank mail to GribWarning@saildocs.com. Read the mail you get back carefully.
- -To get started with gribs and to find sources for downloads, check Franks-Weather.
- -A very good, up to date book, is “Modern Marine Weather, second edition” by David Burch, with a thorough treatment of the subject.
- -A few files including lectures on tropical weather and gribs are available here. -

- -

Types of Grib files.

- -

-OpenCPN can read both the original gribfile format, known as Grib1, as well as the new Grib2 format, with the .grb2 or .grib2 file-extension. -

- -

Get started

- -

-To display grib files as an overlay on your normal charts you have to first activate the grib icon
- -Go to find the plugin tab. Click on the Grib plugin, then the “Enable” button. The “Preferences” Button brings up a small dialog. The settings in this dialog rarely needs changing after the initial setup.
- -

- -

Grib Preference

- -

-Use High Definition Graphics. The setting only concerns the barbed wind arrows.Tick the “Use High Definition Graphics” box, unless you are on old hardware. Not ticking the “High Definition Graphics” box can help to speed up the grib display on a slow computer.
- -Use Gradual Colors. This setting applies to all colored overlay maps. On many installations the difference in rendering is very small. The overlay maps built in color variation plays a part.
- -Copy First Cumulative Missing Record. This is about rainfall and cloud cover records .
- -As these records are “cumulative” the first one does not exist in files from zyGrib and Saildocs. With this parameter unchecked, there will be neither rainfall and nor cloud cover displayed for the first date/time of the file. Ticking the box fixes the problem.
- -Copy Missing Wave Records. This only concerns wave records from zyGrib delivers files from two models ; FNMOC (WW3-…) for waves and GFS for all other parameters. These two forecast models does not have the same time spacing. For some dates/times, the wave data do not exist.This parameter allows this missing data to be reconstructed and avoiding the overlay (if set) to flicker.
- -

- -

Load File Options

- -

-Load the More Recent File in Directory. Loads the newest file in the grib directory on start.
- -Load the Last Open File. Loads the grib file used last time.
- -

- -

Start options

- -

-Start at the first forecast in GRIB file
- -Start at the nearest forecast to current time
- -Authorize interpolation to start at current time.
- -

- -

Time Options

- -

-Local Time
- -UTC
- -

- -

The Grib Display Controls

- -

The Standard Display Control

- -

-To start the Grib plugin press the button in the tool-bar. The “GRIB Display Control” then pops up. -

- -

-Hide Data at Cursor -

- -

-This is a smart and compact dialog. For a quick start press the “Open File” button and navigate to your grib file directory and press the file to be displayed.
- -Previous/Next Go to the previous or the next record in the gribfile. This corresponds to the time “interval” chosen when the grib file was downloaded.
- -Data valid at The time of validity for all grib data on screen.
- -Open Grib file The name of the grib file in use.
- -Now Displays the record, nearest in time to “now” according to the Start option you have selected: (“Start at the nearest forecast to current time” or “Authorize interpolation to start at current time”).
- -Select Geopotential Height If grib data for geopotential height is available, selection will be between Std, 500.
- -Zoom to Center This button will home in on the loaded area that the loaded grib file covers.
- -Play Goes through all records in turn, with the animation speed controlled in the “Grib Settings” dialog.
- -Hide Cursor Data Hides Grib which normally appears in the data windows. Data windows are hidden.
- -Progress Slider Just to the right of the “Play” button is a slider that is just another way of going through the grip records.
- -Open File Activates the operating systems standard file selector dialog to select a grib file. The plugin remembers the directory of this grib. This is used next time you start OpenCPN and activates the Grib plugin. See settings in the “Grib Preferences” dialog above.
- -Settings is where to control how the different grib data will be displayed. See more below.
- -Request Download grib files via email. More below.
- -GRIB Data at Cursor. This is where the “smart” part kicks in.
- -Only entries for the data contained in the active grib file will be displayed. For example, if there is no wave data in the current grib file, there will be no signs of wave data at all. In the case above, where the the wave data is N/A, the grib file includes wave data, but not for the area where the cursor is. Compare with the picture below, where the grib only contains current data.
- -The tick boxes next to each data entry, are used to activate the data-display on the screen.
- -Exactly what will be shown is controlled in the “Grib Settings” dialog, which is reached by pressing the “Settings” button.
- -Don't activate to many display features at the same time. The display quickly becomes very cluttered. -

- -

-
- -

- -

-The “GRIB Display Control” loaded with a grib file only containing current data. -

- -

-Advanced GRIB Data at Cursor. The display options for all the data shown, can be reached by right.clicking on the little squares where the “ticks” are shown. For the meaning of all these options, read on. -

- -

-
- -

- -

-Right-clicking the “Air Temp” option square. -

- -

The Advanced Display Control

- -

-The plugin has an advanced mode were altitude data can be displayed. This mode requires some more knowledge than plain gribs.
- -A good start is to read "Mariner's Guide to the 500--Millibar Chart".
- -If a grib file includes altitude data, the control will automatically include more options. See below. -

- -

-
- -

- -

-If the dialog looks normal except for an extra selection box under “GRIB Data at Cursor”, like this, -

- -

-then the grib file contains altitude data. Selecting one of the altitudes, for example 500, changes the dialog to what you see above.
- -The advanced data are displayed against a yellow background.
- -Wind. These are the wind data valid for the selected altitude level.
- -Grib Data at 500 hPa. The values at the selected level. -

- -

Weather Tables

- -

-Once a grib file is loaded in the current session, the “Weather table” appears in the right click menu. -

- -

-Click the entry, and a Weather Table, valid at the cursor point, pops up. All available data in the current grib file, for the whole time span, are shown. -

- -

-
- -

- -

-NOTE: To change the Wind & Wave Arrows to Degrees, just hit the Dir switch. -

- -

-
- -

- -

Settings

- -

-…controls how the grib files are displayed on the screen, and units used in the Grib Display control. Things like overlay colors, animation time interval and speed and much more. -The basic dialog looks like this. -

- -

-Typical DATA TAB
- -
- -Note the Fixed or Minimum Spacing (pixels) selection. This is a typical setting. -

- -

-Typical GUI TAB
- - -

- -

-Typical PLAYBACK TAB
- -
- - -

- -

Playback

- -

-The Loop Mode controls what happens when “Play” is pressed in the Grib Display Control. -

- -

-Loop Mode. Sets the “Play” function into a loop mode. Otherwise, playback will stop when reaching the end of the file.
- -Loop Start. Were to start the loop. The option “Current time forecast” makes sure that only data now or in the future are shown
- -Updates per Second. Controls the speed of “play”.
- -Loop Start. The loop can start either at the start of the grib file or from the current time forecast.
- -Interpolate between gribs. If you select this option, you will be able to choose your own time interval, but you have to consider that it can decrease data accuracy. To remind you, this info will pop up.
- -

- -

-
- -Time Interval. This is the time interval used for interpolation. The entry is only visible if “Interpolate between gribs” is ticked. This is connected tho the chosen time interval when requesting a grib file.
- -

- -

Display

- -

-The lower part of the Grib Settings Dialog, under the Display heading is really 10 different controls. The controls are activated by the choosing one of the items in the selection menu below. -

- -

-Many of the entries are repeated, so let's first have a closer look at the the most important one, the Wind. Entries on the same line are connected. -

- -

- -
- - -
- -

- -

-Units refers to the choice of units for the selected record. -
- -For wind speed the choices are. -

- -

-
- -Barbed Arrows Display the traditional barbed arrows, showing wind direction and wind speed.
- -Range refers to the distance between displayed arrows (not working 3.3.1117).
- -Default Color/Controlled Colors Default is dark brown while “Controlled” varies from blue for very light winds to red for very strong winds. -
- -

- -

- -
- -Always visible This option only exists for “Wind” and “Pressure”. When ticked the object is shown regardless of what is ticked in the “Settings Control”. The idea is to be able to Show wind and/or pressure at the same time as other options. Use with Rainfall, for example, to help identifying fronts. -
- -Display Isotachs shows contour lines connecting points with the same wind speed. -
- -Spacing controls which wind speed Isotachs will be shown. Use knots for units and 10 for spacing and isotach contours will be shown at 10 kts, 20kts and so on. -
- -OverlayMap Depending on your system capability,if you use “Accelerated Graphics (OpenGL)” (see General Options/Display/Advanced), the overlay will be visible at all scales. But if you don't, the overlay will only be visible at small scales. A small yellow pop up at the bottom left of the screen will inform you. Zoom out to a scale of 1:13 millions, or smaller to see them. -
- -Colors is another selection menu containing pre-set color schemes. The idea is to use the scheme with the same name as the control, but this is just a hint, nothing more. -
- -

- -

-Numbers shows the wind speed in small square boxes. Minimum Spacing refers to the spacing between these boxes.
- -Particle Map is a kind of animation of the wind field. It is created by letting “particles”, or dots, move in the wind direction and leave a trail. The trail is colored after the wind strength, and each particle has a limited “life span”.
- -The Density slider creates particle trails that are shorter but closer together with increased value, which is the same as further to the right. The particle Map below clearly shows a convergence zone with stronger winds (red). This is probably a cold front.
-Performance Warning: Note that high density Particle Maps on Low Powered Machines and Large Files may slow your machine to a crawl. First test on small files.
- -

- -

-Overlay Transparency works as expected.
- -

- -

-All the controls for Wind Gust, Rainfall and Cloud Cover, have similar entries; only the units differ. -

- -

- -
- - -

- -

-The pressure display has no overlays, only the options of isobars and numbers. -Overlay Transparency is redundant. -

- -

- -
- - -

- -

-Waves and Current have a more or less similar display. A Particle Map is available for currents. See the descripion above for wind Particle Maps. Once again different units.
- -There is a choice between three different display arrows shown in two sizes.
- -If wave height, direction and wave period is present in the grib file it will be displayed in the Display Control like this: -
- - -
- - -
- - -

- -

-Air Temperature and Sea Temperature looks the same. -

- -

- -
- - -

- -

-Convective Available Potential Energy (CAPE) has these settings -

- -

- -
- - -
- -Altitude and Relative Humidity have a simple one choice entry. -

- -

The Grib-file Request Button

Grib files can be requested directly from the plugin. The request is in the form of an email to SailDocs or ZyGrib. The requested grib file is also delivered via email as an attachment.
-
The area for which data is requested defaults to the area visible on the screen, but the request area can be selected by other means as well. See more below.
-
It's possible to request gribs from 4 different Grib prediction models when using Saildocs GFS, COAMPS, RTOFS and indirectly WW3. When you request “Waves” in GFS, Saildocs merge wavedata from WW3 into the delivered grib.
-
The ZyGrib option can only deliver GFS gribs, which is the “standard” model for gribs.
-
RTOFS gribs only contains current and water temperature data.
-
COAMPS delivers wind and pressure with a higher resolution than GFS
-
The minimum times between grib records are 3h for GFS and 6h for COAMPS & RTOFS.
-
GFS can be requested for 8 days ahead. An extended GFS request up to 16 days ahead is possible. This warning will pop up.
-

- -

- -
- -The same value for COAMPS is 3 days and RTOFS 6 days. -
- -

- -

-There are two layouts of this dialog, depending on whether it is a request to SaiDocs or to ZyGrib. Some alternatives are only available from SailDocs, and some are only available from zyGrib. Alternatives not available are grayed out. -
- -
- -

- -

SailDocs Request Form

- -

-
- - -

- -

-Compose the request by picking parameters and data. Not all data are available for all choices of parameters.
- -For example, in the picture above “Wind Gusts” and “Current” are grayed out, as the are not available with GFS from SailDocs. -
- -When selecting “Moving Grib” the dialog expands and makes it possible to choose a speed and course. The selected grib forecast area will move, using these values, for each grib interval. The idea behind this is to minimize the download while still covering a longer passage.
- -Moving grib files are incompatible with interpolation, so if a “moving file” is detected a warning is displayed. Interpolation, if set is deactivated, but only for moving file, the settings as such, are not modified. -
- -Resolution The choices are 0.5, 1.0 or 2.0. A recent upgrade to gribs makes it possible to download even 0.25° resolution. This is not yet an alternative in the plugin and requires editing the email manually before sending. In the picture above …|0.5,0.5|… should instead look like …|0.25,0.25|… -
- -The default geographical coverage of the requested grib file is the area you can see on the screen. A manual Selection Mode is also available.
- -When the Area Selection → Manual Selection box is ticked the dialog expands -
- -

- -

-Choose the limiting Latitude and Longitude for the grib-file manually or press “Start graphic Sel.” button. -
- -

- -

-Press the left mouse-button and draw a rectangle around the required area. -

- -

-When selecting “Pressure Altitude” and the GFS forecast model, the dialog expands and makes it possible to choose forecasts for different altitude levels. The SailDocs dialog only supports the 500 mb altitude, while zyGrib suports all options. -
- -When you are ready press “Send”. -
- -This message will show in the “Mail” window instead of the “send” request: -
- -

   Your request is ready. An email is prepared in your email environment.
-   You have just to verify and send it...
-   Save or Cancel to finish...or Continue...

- -

-
- -As stated, a mail is composed for you and ready to send with your normal mailing program. -
- -This is the standard way of getting a new grib in Windows and Linux. (Mac ??) -
- -

- -

-To get a grib, just press “Send”, and wait for a return mail. -
- -
- -

- -

zyGrib Request Form

- -

-
- -Note that the Login is longer the first page of the website. The URL for the login is http://www.zygrib.org/index.php?page=gribauto This is where you login to recieve the special code that allows download for two months. -
- - -
- -

- -

Configuration of Default Email Server

- -

-If after hitting “Send”, the “Mail” window shows this message, instead of the “send” request: -

 Request can't be sent. Please verify your email system parameters.
- You should also have a look at your log file.
- Save or Cancel to finish...

- -

-Configuration of the user's default Mail Server for the particular Operating System is required. -

- -

-There is an advanced alternative for Mac OSX, Linux (and BSD). Install and configure a mail server. Instructions are on the Grib Weather Mail Servers Page. Following these instructions to enable the mail server will enable automatic transmission of a grib request to SailDocs. -

- -

-After installing and configuring a mail server, there is one more step. Open “opencpn.conf” and add the line below. As always, do not run OpenCPN when editing opencpn.conf. -

   [PlugIns/GRIB]\\
-   SendMailMethod=1

- -

-Setting “SendMailMethod” to “0” restores the default. -
- -

- -

ZyGrib Server Registration

- -

-When ZyGrib is selected as the download server, there are User and Code fields that can be completed. This requires subscription or registration to the ZyGrib Forum. -

- -

-ZyGrib allows registration to the zyGrib forum and permits use of the user/password to obtain a two month code for registered zyGrib downloads. Limitations: Maximum 16 emails per user and per 24 hours. Maximum size of 4 MB per grib file. -

- -

Load two Grib Files Concurrently (Wind + Current)

- -

-Combine separate Saildocs GFS Wind + RTOFS Current grib files. -(Note: Only applies to OpenCPN v4.2.x and forward) -
- -Using Windows, Click on the “Open a File” to browse grib file. -

Highlight two grib files (Ctrl and pick the two files with a mouse left click.)
-
The pick Open and the two grib files will be opened.
-
Both grib files will be used by Weather_routing.
-
In grib_pi settings I always use the “Current” “Proportional Arrow”
-
Refer to Weather_Routing_pi: Two Grib Files (Wind + Current)
-

- -

- -
- -

- -

More to know

- -

-There are many aspects to the use of grib files which lead to the use of other companion programs or plugins. -
- -

ZyGrib is a free and open-source software (FOSS) dedicated grib viewer. Grib files can be downloaded by ZyGrib and then opened in OpenCPN.
-
Weather-Routing tools use Grib_pi and Grib data to create optimized routing based on boat performance files.
-
Weather Routing Plugin OpenCPN has an excellent weather_routing plugin which works in concert with grib_pi and climatology_pi concurrently, so that grib files are extended by Climatology's monthly averages for planning long voyages.
-
QtVlm, is another FOSS weather routing program, combines a grib file with boat polar data, and produces an optimized route.
-

- -

-
- -These are very good tools to use in routing decisions, but they all have the same limitations as all grib-data. -
- -

- -

Grib File Notes & WARNINGS

- -

-(These notes are from the SailDocs Grib Server) -

- -

-This grib file is extracted from a computer forecast model. While such computer data can provide useful guidance for general wind flow, there are limitations which must be understood. -

- -

-What you are receiving is a weather prediction generated by a computer run by NOAA/NCEP (GFS, WW3 models) or the US Navy (comaps, nogaps) and downloaded and processed by Saildocs (a service of Sailmail). -

- -

-The network is complex, and any computer network is subject to hardware and software failures or human error -which can effect accuracy or availability of data. -

In particular, if our servers were not able to download a current data file then the grib-file may be based on old data. The file information is shown above and also contained in the file itself. Also remember that grib data is not reviewed by forecasters before being made available.
-
You are getting a small part of the raw model data that the forecasters themselves use when writing a forecast, and it is your responsibility to make sure that the data is consistent with your local conditions and with the professionally-generated forecasts (e.g. text bulletins and weather-fax charts).
-
Grib data also has limitations along shore, where local effects often dominate and may not be adequately modeled.
-
In addition these models cannot provide adequate prediction for
-
- tropical systems,
  -
- frontal activity or convergence zones.
  -
- For example, while global models can provide useful data on the likely track of hurricanes, they grossly underestimate the strength of hurricanes because of their small size compared to the model grid.
  -
-
For hurricane/cyclone forecasts, carefully monitor the appropriate warning messages and do not rely on grib data from any source.
-

- -

-Grib data can provide useful guidance not available elsewhere. Understand the limitations and use the data carefully. Grib data should be considered supplemental to other forecasts, and not be relied upon in lieu of professionally-generated charts or forecasts. -

- -

- - -

- - + + + + + opencpn:opencpn_user_manual:plugins:included_plugins:grib_weather + + + + + + + + + + + + + + + + + + + + + +

+ + + +

Grib Weather

+ +

+OpenCPN has a grib weather file viewer plugin, aimed at being useful while under way.
+ +The grib plugin is always distributed with OpenCPN, no separate download is required. +

+ +

What is a grib file?

+ +

+If you are not familiar with grib weather files, make sure you understand the basics, before you start to use them. It is essential to understand the limitations of weather forecasts that are distributed in the grib format.
+ +It is also worth pointing out that gribs are not reliable near tropical systems.
+ +Send a blank mail to GribWarning@saildocs.com. Read the mail you get back carefully.
+ +To get started with gribs and to find sources for downloads, check Franks-Weather.
+ +A very good, up to date book, is “Modern Marine Weather, second edition” by David Burch, with a thorough treatment of the subject.
+ +A few files including lectures on tropical weather and gribs are available here. +

+ +

Types of Grib files.

+ +

+OpenCPN can read both the original gribfile format, known as Grib1, as well as the new Grib2 format, with the .grb2 or .grib2 file-extension. +

+ +

Get started

+ +

+To display grib files as an overlay on your normal charts you have to first activate the grib icon
+ +Go to find the plugin tab. Click on the Grib plugin, then the “Enable” button. The “Preferences” Button brings up a small dialog. The settings in this dialog rarely needs changing after the initial setup.
+ +

+ +

Grib Preference

+ +

+Use High Definition Graphics. The setting only concerns the barbed wind arrows.Tick the “Use High Definition Graphics” box, unless you are on old hardware. Not ticking the “High Definition Graphics” box can help to speed up the grib display on a slow computer.
+ +Use Gradual Colors. This setting applies to all colored overlay maps. On many installations the difference in rendering is very small. The overlay maps built in color variation plays a part.
+ +Copy First Cumulative Missing Record. This is about rainfall and cloud cover records .
+ +As these records are “cumulative” the first one does not exist in files from zyGrib and Saildocs. With this parameter unchecked, there will be neither rainfall and nor cloud cover displayed for the first date/time of the file. Ticking the box fixes the problem.
+ +Copy Missing Wave Records. This only concerns wave records from zyGrib delivers files from two models ; FNMOC (WW3-…) for waves and GFS for all other parameters. These two forecast models does not have the same time spacing. For some dates/times, the wave data do not exist.This parameter allows this missing data to be reconstructed and avoiding the overlay (if set) to flicker.
+ +

+ +

Load File Options

+ +

+Load the More Recent File in Directory. Loads the newest file in the grib directory on start.
+ +Load the Last Open File. Loads the grib file used last time.
+ +

+ +

Start options

+ +

+Start at the first forecast in GRIB file
+ +Start at the nearest forecast to current time
+ +Authorize interpolation to start at current time.
+ +

+ +

Time Options

+ +

+Local Time
+ +UTC
+ +

+ +

The Grib Display Controls

+ +

The Standard Display Control

+ +

+To start the Grib plugin press the button in the tool-bar. The “GRIB Display Control” then pops up. +

+ +

+Hide Data at Cursor +

+ +

+This is a smart and compact dialog. For a quick start press the “Open File” button and navigate to your grib file directory and press the file to be displayed.
+ +Previous/Next Go to the previous or the next record in the gribfile. This corresponds to the time “interval” chosen when the grib file was downloaded.
+ +Data valid at The time of validity for all grib data on screen.
+ +Open Grib file The name of the grib file in use.
+ +Now Displays the record, nearest in time to “now” according to the Start option you have selected: (“Start at the nearest forecast to current time” or “Authorize interpolation to start at current time”).
+ +Select Geopotential Height If grib data for geopotential height is available, selection will be between Std, 500.
+ +Zoom to Center This button will home in on the loaded area that the loaded grib file covers.
+ +Play Goes through all records in turn, with the animation speed controlled in the “Grib Settings” dialog.
+ +Hide Cursor Data Hides Grib which normally appears in the data windows. Data windows are hidden.
+ +Progress Slider Just to the right of the “Play” button is a slider that is just another way of going through the grip records.
+ +Open File Activates the operating systems standard file selector dialog to select a grib file. The plugin remembers the directory of this grib. This is used next time you start OpenCPN and activates the Grib plugin. See settings in the “Grib Preferences” dialog above.
+ +Settings is where to control how the different grib data will be displayed. See more below.
+ +Request Download grib files via email. More below.
+ +GRIB Data at Cursor. This is where the “smart” part kicks in.
+ +Only entries for the data contained in the active grib file will be displayed. For example, if there is no wave data in the current grib file, there will be no signs of wave data at all. In the case above, where the the wave data is N/A, the grib file includes wave data, but not for the area where the cursor is. Compare with the picture below, where the grib only contains current data.
+ +The tick boxes next to each data entry, are used to activate the data-display on the screen.
+ +Exactly what will be shown is controlled in the “Grib Settings” dialog, which is reached by pressing the “Settings” button.
+ +Don't activate to many display features at the same time. The display quickly becomes very cluttered. +

+ +

+
+ +

+ +

+The “GRIB Display Control” loaded with a grib file only containing current data. +

+ +

+Advanced GRIB Data at Cursor. The display options for all the data shown, can be reached by right.clicking on the little squares where the “ticks” are shown. For the meaning of all these options, read on. +

+ +

+
+ +

+ +

+Right-clicking the “Air Temp” option square. +

+ +

The Advanced Display Control

+ +

+The plugin has an advanced mode were altitude data can be displayed. This mode requires some more knowledge than plain gribs.
+ +A good start is to read "Mariner's Guide to the 500--Millibar Chart".
+ +If a grib file includes altitude data, the control will automatically include more options. See below. +

+ +

+
+ +

+ +

+If the dialog looks normal except for an extra selection box under “GRIB Data at Cursor”, like this, +

+ +

+then the grib file contains altitude data. Selecting one of the altitudes, for example 500, changes the dialog to what you see above.
+ +The advanced data are displayed against a yellow background.
+ +Wind. These are the wind data valid for the selected altitude level.
+ +Grib Data at 500 hPa. The values at the selected level. +

+ +

Weather Tables

+ +

+Once a grib file is loaded in the current session, the “Weather table” appears in the right click menu. +

+ +

+Click the entry, and a Weather Table, valid at the cursor point, pops up. All available data in the current grib file, for the whole time span, are shown. +

+ +

+ Grib Table Arrows
+ +

+ +

+NOTE: To change the Wind & Wave Arrows to Degrees, just hit the Dir switch. +

+ +

+ Grib Table Degrees
+ +

+ +

Settings

+ +

+…controls how the grib files are displayed on the screen, and units used in the Grib Display control. Things like overlay colors, animation time interval and speed and much more. +The basic dialog looks like this. +

+ +

+Typical DATA TAB
+ +
+ +Note the Fixed or Minimum Spacing (pixels) selection. This is a typical setting. +

+ +

+Typical GUI TAB
+ + +

+ +

+Typical PLAYBACK TAB
+ +
+ + +

+ +

Playback

+ +

+The Loop Mode controls what happens when “Play” is pressed in the Grib Display Control. +

+ +

+Loop Mode. Sets the “Play” function into a loop mode. Otherwise, playback will stop when reaching the end of the file.
+ +Loop Start. Were to start the loop. The option “Current time forecast” makes sure that only data now or in the future are shown
+ +Updates per Second. Controls the speed of “play”.
+ +Loop Start. The loop can start either at the start of the grib file or from the current time forecast.
+ +Interpolate between gribs. If you select this option, you will be able to choose your own time interval, but you have to consider that it can decrease data accuracy. To remind you, this info will pop up.
+ +

+ +

+
+ +Time Interval. This is the time interval used for interpolation. The entry is only visible if “Interpolate between gribs” is ticked. This is connected tho the chosen time interval when requesting a grib file.
+ +

+ +

Display

+ +

+The lower part of the Grib Settings Dialog, under the Display heading is really 10 different controls. The controls are activated by the choosing one of the items in the selection menu below. +

+ +

+Many of the entries are repeated, so let's first have a closer look at the the most important one, the Wind. Entries on the same line are connected. +

+ +

+ +
+ + +
+ +

+ +

+Units refers to the choice of units for the selected record. +
+ +For wind speed the choices are. +

+ +

+
+ +Barbed Arrows Display the traditional barbed arrows, showing wind direction and wind speed.
+ +Range refers to the distance between displayed arrows (not working 3.3.1117).
+ +Default Color/Controlled Colors Default is dark brown while “Controlled” varies from blue for very light winds to red for very strong winds. +
+ +

+ +

+ +
+ +Always visible This option only exists for “Wind” and “Pressure”. When ticked the object is shown regardless of what is ticked in the “Settings Control”. The idea is to be able to Show wind and/or pressure at the same time as other options. Use with Rainfall, for example, to help identifying fronts. +
+ +Display Isotachs shows contour lines connecting points with the same wind speed. +
+ +Spacing controls which wind speed Isotachs will be shown. Use knots for units and 10 for spacing and isotach contours will be shown at 10 kts, 20kts and so on. +
+ +OverlayMap Depending on your system capability,if you use “Accelerated Graphics (OpenGL)” (see General Options/Display/Advanced), the overlay will be visible at all scales. But if you don't, the overlay will only be visible at small scales. A small yellow pop up at the bottom left of the screen will inform you. Zoom out to a scale of 1:13 millions, or smaller to see them. +
+ +Colors is another selection menu containing pre-set color schemes. The idea is to use the scheme with the same name as the control, but this is just a hint, nothing more. +
+ +

+ +

+Numbers shows the wind speed in small square boxes. Minimum Spacing refers to the spacing between these boxes.
+ +Particle Map is a kind of animation of the wind field. It is created by letting “particles”, or dots, move in the wind direction and leave a trail. The trail is colored after the wind strength, and each particle has a limited “life span”.
+ +The Density slider creates particle trails that are shorter but closer together with increased value, which is the same as further to the right. The particle Map below clearly shows a convergence zone with stronger winds (red). This is probably a cold front.
+Performance Warning: Note that high density Particle Maps on Low Powered Machines and Large Files may slow your machine to a crawl. First test on small files.
+ +

+ +

+Overlay Transparency works as expected.
+ +

+ +

+All the controls for Wind Gust, Rainfall and Cloud Cover, have similar entries; only the units differ. +

+ +

+ +
+ + +

+ +

+The pressure display has no overlays, only the options of isobars and numbers. +Overlay Transparency is redundant. +

+ +

+ +
+ + +

+ +

+Waves and Current have a more or less similar display. A Particle Map is available for currents. See the descripion above for wind Particle Maps. Once again different units.
+ +There is a choice between three different display arrows shown in two sizes.
+ +If wave height, direction and wave period is present in the grib file it will be displayed in the Display Control like this: +
+ + +
+ + +
+ + +

+ +

+Air Temperature and Sea Temperature looks the same. +

+ +

+ +
+ + +

+ +

+Convective Available Potential Energy (CAPE) has these settings +

+ +

+ +
+ + +
+ +Altitude and Relative Humidity have a simple one choice entry. +

+ +

The Grib-file Request Button

Grib files can be requested directly from the plugin. The request is in the form of an email to SailDocs or ZyGrib. The requested grib file is also delivered via email as an attachment.
+
The area for which data is requested defaults to the area visible on the screen, but the request area can be selected by other means as well. See more below.
+
It's possible to request gribs from 4 different Grib prediction models when using Saildocs GFS, COAMPS, RTOFS and indirectly WW3. When you request “Waves” in GFS, Saildocs merge wavedata from WW3 into the delivered grib.
+
The ZyGrib option can only deliver GFS gribs, which is the “standard” model for gribs.
+
RTOFS gribs only contains current and water temperature data.
+
COAMPS delivers wind and pressure with a higher resolution than GFS
+
The minimum times between grib records are 3h for GFS and 6h for COAMPS & RTOFS.
+
GFS can be requested for 8 days ahead. An extended GFS request up to 16 days ahead is possible. This warning will pop up.
+

+ +

+ +
+ +The same value for COAMPS is 3 days and RTOFS 6 days. +
+ +

+ +

+There are two layouts of this dialog, depending on whether it is a request to SaiDocs or to ZyGrib. Some alternatives are only available from SailDocs, and some are only available from zyGrib. Alternatives not available are grayed out. +
+ +
+ +

+ +

SailDocs Request Form

+ +

+
+ + +

+ +

+Compose the request by picking parameters and data. Not all data are available for all choices of parameters.
+ +For example, in the picture above “Wind Gusts” and “Current” are grayed out, as the are not available with GFS from SailDocs. +
+ +When selecting “Moving Grib” the dialog expands and makes it possible to choose a speed and course. The selected grib forecast area will move, using these values, for each grib interval. The idea behind this is to minimize the download while still covering a longer passage.
+ +Moving grib files are incompatible with interpolation, so if a “moving file” is detected a warning is displayed. Interpolation, if set is deactivated, but only for moving file, the settings as such, are not modified. +
+ +Resolution The choices are 0.5, 1.0 or 2.0. A recent upgrade to gribs makes it possible to download even 0.25° resolution. This is not yet an alternative in the plugin and requires editing the email manually before sending. In the picture above …|0.5,0.5|… should instead look like …|0.25,0.25|… +
+ +The default geographical coverage of the requested grib file is the area you can see on the screen. A manual Selection Mode is also available.
+ +When the Area Selection → Manual Selection box is ticked the dialog expands +
+ +

+ +

+Choose the limiting Latitude and Longitude for the grib-file manually or press “Start graphic Sel.” button. +
+ +

+ +

+Press the left mouse-button and draw a rectangle around the required area. +

+ +

+When selecting “Pressure Altitude” and the GFS forecast model, the dialog expands and makes it possible to choose forecasts for different altitude levels. The SailDocs dialog only supports the 500 mb altitude, while zyGrib suports all options. +
+ +When you are ready press “Send”. +
+ +This message will show in the “Mail” window instead of the “send” request: +
+ +

   Your request is ready. An email is prepared in your email environment.
+   You have just to verify and send it...
+   Save or Cancel to finish...or Continue...

+ +

+
+ +As stated, a mail is composed for you and ready to send with your normal mailing program. +
+ +This is the standard way of getting a new grib in Windows and Linux. (Mac ??) +
+ +

+ +

+To get a grib, just press “Send”, and wait for a return mail. +
+ +
+ +

+ +

zyGrib Request Form

+ +

+
+ +Note that the Login is longer the first page of the website. The URL for the login is http://www.zygrib.org/index.php?page=gribauto This is where you login to recieve the special code that allows download for two months. +
+ + +
+ +

+ +

Configuration of Default Email Server

+ +

+If after hitting “Send”, the “Mail” window shows this message, instead of the “send” request: +

 Request can't be sent. Please verify your email system parameters.
+ You should also have a look at your log file.
+ Save or Cancel to finish...

+ +

+Configuration of the user's default Mail Server for the particular Operating System is required. +

+ +

+There is an advanced alternative for Mac OSX, Linux (and BSD). Install and configure a mail server. Instructions are on the Grib Weather Mail Servers Page. Following these instructions to enable the mail server will enable automatic transmission of a grib request to SailDocs. +

+ +

+After installing and configuring a mail server, there is one more step. Open “opencpn.conf” and add the line below. As always, do not run OpenCPN when editing opencpn.conf. +

   [PlugIns/GRIB]\\
+   SendMailMethod=1

+ +

+Setting “SendMailMethod” to “0” restores the default. +
+ +

+ +

ZyGrib Server Registration

+ +

+When ZyGrib is selected as the download server, there are User and Code fields that can be completed. This requires subscription or registration to the ZyGrib Forum. +

+ +

+ZyGrib allows registration to the zyGrib forum and permits use of the user/password to obtain a two month code for registered zyGrib downloads. Limitations: Maximum 16 emails per user and per 24 hours. Maximum size of 4 MB per grib file. +

+ +

Load two Grib Files Concurrently (Wind + Current)

+ +

+Combine separate Saildocs GFS Wind + RTOFS Current grib files. +(Note: Only applies to OpenCPN v4.2.x and forward) +
+ +Using Windows, Click on the “Open a File” to browse grib file. +

Highlight two grib files (Ctrl and pick the two files with a mouse left click.)
+
The pick Open and the two grib files will be opened.
+
Both grib files will be used by Weather_routing.
+
In grib_pi settings I always use the “Current” “Proportional Arrow”
+

+ +

+ +
+ +

+ +

More to know

+ +

+There are many aspects to the use of grib files which lead to the use of other companion programs or plugins. +
+ +

ZyGrib is a free and open-source software (FOSS) dedicated grib viewer. Grib files can be downloaded by ZyGrib and then opened in OpenCPN.
+
QtVlm, is another FOSS weather routing program, combines a grib file with boat polar data, and produces an optimized route.
+

+ +

+
+ +These are very good tools to use in routing decisions, but they all have the same limitations as all grib-data. +
+ +

+ +

Grib File Notes & WARNINGS

+ +

+(These notes are from the SailDocs Grib Server) +

+ +

+This grib file is extracted from a computer forecast model. While such computer data can provide useful guidance for general wind flow, there are limitations which must be understood. +

+ +

+What you are receiving is a weather prediction generated by a computer run by NOAA/NCEP (GFS, WW3 models) or the US Navy (comaps, nogaps) and downloaded and processed by Saildocs (a service of Sailmail). +

+ +

+The network is complex, and any computer network is subject to hardware and software failures or human error +which can effect accuracy or availability of data. +

In particular, if our servers were not able to download a current data file then the grib-file may be based on old data. The file information is shown above and also contained in the file itself. Also remember that grib data is not reviewed by forecasters before being made available.
+
You are getting a small part of the raw model data that the forecasters themselves use when writing a forecast, and it is your responsibility to make sure that the data is consistent with your local conditions and with the professionally-generated forecasts (e.g. text bulletins and weather-fax charts).
+
Grib data also has limitations along shore, where local effects often dominate and may not be adequately modeled.
+
In addition these models cannot provide adequate prediction for
+
- tropical systems,
  +
- frontal activity or convergence zones.
  +
- For example, while global models can provide useful data on the likely track of hurricanes, they grossly underestimate the strength of hurricanes because of their small size compared to the model grid.
  +
+
For hurricane/cyclone forecasts, carefully monitor the appropriate warning messages and do not rely on grib data from any source.
+

+ +

+Grib data can provide useful guidance not available elsewhere. Understand the limitations and use the data carefully. Grib data should be considered supplemental to other forecasts, and not be relied upon in lieu of professionally-generated charts or forecasts. +

+ +

+ + +

+ + diff -Nru opencpn-doc-4.8.10129.2/doc/plugins/navigation.html opencpn-doc-4.8.2.0/doc/plugins/navigation.html --- opencpn-doc-4.8.10129.2/doc/plugins/navigation.html 2018-01-30 12:28:30.000000000 +0000 +++ opencpn-doc-4.8.2.0/doc/plugins/navigation.html 2018-02-07 14:43:14.000000000 +0000 @@ -53,39 +53,37 @@

-Celestial Navigation
+Celestial Navigation (view online)
Plugin to record Sextant Sights and show Circles of Position to obtain a Fix

-Route Great Circle
+Route Great Circle (view online)
A short introduction to to the Great Circle part of the Route Plugin. Route Plotting, Great Circle routes, Limited Circle Routes and Rhumb lines.

-DR Dead Reckoning
+DR Dead Reckoning (view online)
Add DR positions to a GPX file exported from OpenCPN

-sQuiddio
+sQuiddio (view online)
Global user-sourced and user-maintained repository of sailing destinations (marinas, anchorages, yacht clubs, docks, fuel stations etc.) available as waypoints in OpenCPN through a plugin.

-Google Earth** -

+Google Earth**
-

Links a Google Earth satellite image to the area of chart being explored.

-GE2KAP
+GE2KAP (view online)
(a companion piece of software, not a plugin)
@@ -93,13 +91,13 @@

-ODraw 1.4 (Ocpn Draw)
+ODraw 1.4 (Ocpn Draw) (view online)
Drawing tools, Boundaries, EBL & VRM, link to Watchdog for keep in & out alarms.

-oTCurrent
+oTCurrent (view online)
Display tidal current arrows for times other than the present

diff -Nru opencpn-doc-4.8.10129.2/doc/plugins/weather.html opencpn-doc-4.8.2.0/doc/plugins/weather.html --- opencpn-doc-4.8.10129.2/doc/plugins/weather.html 2018-01-30 12:28:30.000000000 +0000 +++ opencpn-doc-4.8.2.0/doc/plugins/weather.html 2018-02-07 14:43:14.000000000 +0000 @@ -53,13 +53,13 @@

-Weatherfax
+Weatherfax (view online)
Read weather fax encoded data as audio or image and Overlay on top of charts.

-IACfleet
+IACfleet (view online)
IAC Fleet Code visualizes the encoded data issued as part of the weather bulletins. The IAC Fleet Code provides size effective encoded synoptic charts for several areas of the world, especially useful with slow and limited connection to the Internet. Coverage areas:

@@ -73,15 +73,15 @@

-Climatology
+Climatology (view online)
Manage and view monthly gridded climate data.

-Weather Routing
+Weather Routing (view online)
-Establish an estimate of optimal weather routing using Grib Plugin and Climatology. For additional information about weather routing see the QtVLM page. +Establish an estimate of optimal weather routing using Grib Plugin and Climatology. For additional information about weather routing see the QtVLM page (view online)

diff -Nru opencpn-doc-4.8.10129.2/doc/plugins.html opencpn-doc-4.8.2.0/doc/plugins.html --- opencpn-doc-4.8.10129.2/doc/plugins.html 2018-01-30 12:28:30.000000000 +0000 +++ opencpn-doc-4.8.2.0/doc/plugins.html 2018-02-07 14:43:14.000000000 +0000 @@ -62,11 +62,11 @@ Plugin Messaging between ODraw , Watchdog and Weather_routing.
-Download Page for all version 4.2 & 4.4 plugins that are regarded as stable. +Download Page for all version 4.2 & 4.4 plugins that are regarded as stable. (plugins online)

-Developers need your help testing! Developer Beta Plugins +Developers need your help testing! Developer Beta Plugins (view online)

		Class A	Class B

Static Data		6min	6min

Dynamic Data	< 3kn moored	3min
	upto 2kn	10s	3min
	> 2kn		30s
	< 14kn (turning)	10s (3.33s)
	< 23kn (turning)	6s (2s)
	> 23kn	2s

Informaton	Ais_Icon	Information
An active AIS SART and is a distress call equal to a “Mayday”transmission. More about AIS SART.	..	The V-shape stern indicates a Class B target. Tugboats and pilot boats very often carry Class B transponders. These are often designed specifically for small commercial boats, fishing boats and pleasure crafts.
Icon displayed when testing an AIS-SART device.		Targets is complying with the Euro AIS Inland specification.
Aircraft participating in Search and Rescue.		This vessel has the “Inland Blue Flag” set, it's a part of the European, Inland AIS standard. The “Blue Flag” signal, commonly seen on inland waters, indicates that the vessel requests a “stbd-stbd” passage or crossing. This Blue Signal is manually switched on/off, by the target.
Potential Danger.		Aton, Aid to Navigation, for example a Lighthouse or a Buoy with an AIS transmitter.
No Danger. Not Identified (Voyage data not received)		Aton, Aid to Navigation, that is off it's suposed position. For example a buoy equiped with AIS that has come adrift.
No Danger. Not Identified (Name from cached data)		Virtual Aton, Virtual Aid to Navigation, not a real marker. Can be useful for a range of situations. A new wreck, is one example. Further explanations.
No Danger. Identified		Virtual Aton, off position. Actually seen in the wild, but may be a user config error.
Lost Target		AIS Base Station
Ship which has lost fix - position unavailable. Displayed at the last known position.		The following tagets only displays if DSC messages, GpsGate mesages, Radar or APRS messages are mixed in to the incomming AIS stream, by using, for example a multiplexer. More on the following pages.
Vessel not under command.		DSC Station. Only the DSC message received. The position contains only degrees and minutes of Latitude and Longitude.
Vessel restricted in ability to manoeuvre.		DSC Station. DSC and DSE messages received. The DSE message contains the missing decimals of minutes of Latitude and Longitude. The result is a much more accurate position.
Vessel constrained by draft.		DSC Station transmitting a distress signal. Treat this as a “Mayday” call.
Vessel aground.		GpsGate Buddy target.
Vessel engaged in fishing.		ARPA Target
High Speed- and Wing In Ground- crafts. This includes Hydrofoils, Hovercrafts and low flying crafts utilising the ground effect.		APRS Target
Anchored or moored. Displayed when the transmitted “Navigation status” is “at anchor” or “Moored”. There is no guarantee that this status is correct, as it is set manually on the transmitting ship…		…illustrated by this ship. Note the black line on the yellow circle. This indicates that the vessel is turning to port (left), also illustrated by the lag in the display update. ROT - Rate Of Turn is available in the “Ais Target Query” dialog, through the right click menu.

		Class A	Class B

Static Data		6min	6min

Dynamic Data	< 3kn moored	3min
	upto 2kn	10s	3min
	> 2kn		30s
	< 14kn (turning)	10s (3.33s)
	< 23kn (turning)	6s (2s)
	> 23kn	2s

Informaton	Ais_Icon	Information
An active AIS SART and is a distress call equal to a “Mayday”transmission. More about AIS SART.	..	The V-shape stern indicates a Class B target. Tugboats and pilot boats very often carry Class B transponders. These are often designed specifically for small commercial boats, fishing boats and pleasure crafts.
Icon displayed when testing an AIS-SART device.		Targets is complying with the Euro AIS Inland specification.
Aircraft participating in Search and Rescue.		This vessel has the “Inland Blue Flag” set, it's a part of the European, Inland AIS standard. The “Blue Flag” signal, commonly seen on inland waters, indicates that the vessel requests a “stbd-stbd” passage or crossing. This Blue Signal is manually switched on/off, by the target.
Potential Danger.		Aton, Aid to Navigation, for example a Lighthouse or a Buoy with an AIS transmitter.
No Danger. Not Identified (Voyage data not received)		Aton, Aid to Navigation, that is off it's suposed position. For example a buoy equiped with AIS that has come adrift.
No Danger. Not Identified (Name from cached data)		Virtual Aton, Virtual Aid to Navigation, not a real marker. Can be useful for a range of situations. A new wreck, is one example.
No Danger. Identified		Virtual Aton, off position. Actually seen in the wild, but may be a user config error.
Lost Target		AIS Base Station
Ship which has lost fix - position unavailable. Displayed at the last known position.		The following tagets only displays if DSC messages, GpsGate mesages, Radar or APRS messages are mixed in to the incomming AIS stream, by using, for example a multiplexer. More on the following pages.
Vessel not under command.		DSC Station. Only the DSC message received. The position contains only degrees and minutes of Latitude and Longitude.
Vessel restricted in ability to manoeuvre.		DSC Station. DSC and DSE messages received. The DSE message contains the missing decimals of minutes of Latitude and Longitude. The result is a much more accurate position.
Vessel constrained by draft.		DSC Station transmitting a distress signal. Treat this as a “Mayday” call.
Vessel aground.		GpsGate Buddy target.
Vessel engaged in fishing.		ARPA Target
High Speed- and Wing In Ground- crafts. This includes Hydrofoils, Hovercrafts and low flying crafts utilising the ground effect.		APRS Target
Anchored or moored. Displayed when the transmitted “Navigation status” is “at anchor” or “Moored”. There is no guarantee that this status is correct, as it is set manually on the transmitting ship…		…illustrated by this ship. Note the black line on the yellow circle. This indicates that the vessel is turning to port (left), also illustrated by the lag in the display update. ROT - Rate Of Turn is available in the “Ais Target Query” dialog, through the right click menu.

UNITED STATES TIME ZONE CODES	UTC OFFSET
AST	ATLANTIC STANDARD TIME	UTC - 4
EST	EASTERN STANDARD TIME	UTC - 5
EDT	EASTERN DAYLIGHT TIME	UTC - 4
CST	CENTRAL STANDARD TIME	UTC - 6
CDT	CENTRAL DAYLIGHT TIME	UTC - 5
MST	MOUNTAIN STANDARD TIME	UTC - 7
MDT	MOUNTAIN DAYLIGHT TIME	UTC - 6
PST	PACIFIC STANDARD TIME	UTC - 8
PDT	PACIFIC DAYLIGHT TIME	UTC - 7
AKST	ALASKA TIME	UTC - 9
AKDT	ALASKA DAYLIGHT TIME	UTC - 8
HAST	HAWAII-ALEUTIAN STANDARD TIME	UTC - 10
HADT	HAWAII-ALEUTIAN DAYLIGHT TIME	UTC - 9
SST	SAMOA STANDARD TIME	UTC - 11
SDT	SAMOA DAYLIGHT TIME	UTC - 10
CHST	CHAMORRO STANDARD TIME	UTC +10

Configuration File

Configuration File

Network Repeater

Opencpn network/RJ45 (Ethernet) cable

Networking

Network Repeater

Opencpn network/RJ45 (Ethernet) cable

Networking

Route to Autopilot

Send a Route to the Autopilot, the basics

Waypoint Advance

Simulation & Testing - Short description

Autopilots and Routes, the details.

Route to Autopilot

Send a Route to the Autopilot, the basics

Waypoint Advance

Simulation & Testing - Short description

Autopilots and Routes, the details.

User Icons

A user can install his or her own icons to use with marks and "own ship".

Icons contributed by users of OpenCPN

General Icons by S/V Revelations

Own ship Icons by "S/V Revelations"

User Icons

A user can install his or her own icons to use with marks and "own ship".

Advanced Features

Advanced Features

Chart Downloader Tab

Chart Downloader

A Few Basic Concepts

Chart Catalogs

Chart Downloader Tab

Using the Chart Downloader

Adding a chart source

Updating the catalogs

Selecting charts for download

Downloading charts

After the download

Checking the downloaded charts

The Preferences

Chart Downloader Tab

Chart Downloader

A Few Basic Concepts

Chart Catalogs

Chart Downloader Tab

Using the Chart Downloader

Adding a chart source

Updating the catalogs

Selecting charts for download

Downloading charts

After the download

Checking the downloaded charts

The Preferences

Chart Files Tab

Installing Charts

Background Chart

Where do I keep my charts ?

Installing Charts

Check your charts after installation

Start using your charts

Loading Vector Charts

Updating Vector Charts

CM93 Charts

Chart Files Tab

Installing Charts

Background Chart

Where do I keep my charts ?

Installing Charts

Check your charts after installation

Start using your charts

Loading Vector Charts

Updating Vector Charts

CM93 Charts

Chart Formats

OpenCPN supported chart formats

Raster Charts

Vector Charts

Pictures of charts, can be converted, and used.

Not supported formats that can be converted.

WCI charts