Pilot Control
Download Pilot.ocx Visual Studio Control

The NMEA Sage Pilot ActiveX Control conforms to the NMEA $..APA and $..APB sentences [Autopilot Sentence "A" and the newer Autopilot Sentence "B"] via the APA and APB Methods. This will show Cross Tract Error (XTE), the waypoint name, bearing to waypoint, heading of vessel, and other piloting information. One may also ignore these two Methods and set the control's Properties with similar data.

NOTE:
It is very important to note that the APA sentence shows bearing to waypoint from the origin (when the auto pilot was engaged) and not from where the vessel currently is. Sentence APB, however, shows bearing to waypoint from the vessel's current position. Sentence APA also does not have the vessel's heading; Sentence APB does: you may plug in the vessel's heading using the control's Heading Property.

The control resizes via the Width Property: the control's height, and all of its internal components, will resize to retain the control's original width-to-height ratio.

When the Heading Property and/or the BearingToDestination Property are unknown, these two Properties should be set to the value of "-1" to denote that status; otherwise, these two Properties must be set from 0 to 360.

If the BiasNorth Property is set to False, the Bearing will always point straight up; the Heading will show the deviation, if any, away from that Bearing.

If the BiasNorth Property is set to True, the compass will show North at the top (pointing "Up") and the Bearing and Heading, if any, will reflect that northern bias. This is useful for use with printed nautical charts.

A positive Cross Tract Error value to the Property XTE means one should steer left to get back on course; a negative value to the Property XTE means one should steer right. The control shows how many units (nautical miles or kilometers) one is off the track.

The BearingStyle Property may be set to Dot or Triangle. Colors for the Heading arrow and Bearing indicator may be changed via the HeadingColor and BearingColor Properties.

The control has several Properties to tell it how you want the Cross Tract Error display to function. Using the XTETolerance Property, a vessel may be off its tract by a given margin before the large warning arrow (left or right) shows up. That arrow will remain "solid" (not flash) until the Cross Tract Error (XTE) exceeds the XTEFlashThreshold Property's value. You may also disable the flashing via the XTEFlashEnabled Property.

The FlashSpeed Property may be set to four different intervals.

When the vessel comes close to the waypoint, the autopilot will send an "Arrival Circle Entered" flag into the NMEA stream. When this occurs, the control will trigger the ArrivalCircleEntered Event, and the rim of the compass will flash red. The ArrivalCircle Property will be set to True.
A vessel may pass a waypoint by a large margin when it is off-course. A plot on the vessel's heading that misses the waypoint by a large margin will cause the autopilot to inject into the NMEA stream a flag denoting "Perpendicular passed at waypoint" when this occurs. When the NMEA Sage Pilot Control sees that flag it will set the PerpendicularPassed Property to True and trigger the PerpendicularPassed Event.
The control uses the same color scheme for the Night and Twilight Properties as in all of the NMEA Sage controls. This method gives the programmer a simple way of setting the control to a non-annoying, less-bright display when at night or during dawn and dusk.
The control's background color may be set via the BackColor Property.

The colors of the arrows may be set via the LeftArrowColor and RightArrowColor Properties.

Events:

ArrivalCircleEntered
PerpendicularPassed
PilotError

Methods:

Cls
APA
APB

Properties:

ArrivalCircle
BackColor
BearingColor
BearingStyle
BearingToDestinationUnit
BearingToDestination
BiasNorth
BorderStyle
DirectionToSteer
ErrorDescription
ErrorNumber
FlashSpeed
Heading
HeadingColor
LeftArrowColor
Night
PerpendicularPassed
RightArrowColor
ShowBearing
ShowDirectionToSteer
ShowHeading
Twilight
WaypointID
XTE
XTEFlashEnabled
XTEFlashThreshold
XTETolerance
XTEUnits

Error Codes

0 - No Current Error
1 - Bearing To Destination must be equal to -1, or from 0 to 360.
2 - Heading must be equal to -1, or from 0 to 360.
3 - Waypoint ID must be six characters or fewer.
4 - XTE Tolerance must be from 0.1 to 9.7.
5 - XTE Flash Threashold must be from 0.1 to 9.8.
6 - XTE must be from -9.9 to 9.9.
7 - NMEA Sentence passed to APA was empty.
8 - NMEA Sentence passed to APA appears malformed.
9 - NMEA Sentence passed to APB was empty.
10 - NMEA Sentence passed to APB appears malformed.
NMEA Sage Home Page

The Banded Compass Control
The Compass Control
The North Biased Compass Control
The Goto Control
Course and Speed (Ground)
The Position Control
Engine RPM Control
The Rudder Control
The GPS Satellite Health Control
The GPS Satellite Elevation Control
Set and Drift control
The NMEA Talker Control
Depth and Water Temperature Control
The Wind Control
The Cross Track Alarm Control
The Pilot Control
Waypoint Plotter Control
Radar Control
Goto Simple Control