N2kTypes.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019-2024 Timo Lappalainen, Kave Oy, www.kave.fi
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
*/
 
/*************************************************************************/
#ifndef _N2kTypes_H_
#define _N2kTypes_H_
 
#include "NMEA2000StdTypes.h"
 
/*************************************************************************/
enum tN2kNavigationDirection {
                            N2kdir_forward=0,     
                            N2kdir_reverse=1,     
                            N2kdir_reserved1=2,   
                            N2kdir_reserved2=3,   
                            N2kdir_reserved3=4,   
                            N2kdir_reserved4=5,   
                            N2kdir_error=6,       
                            N2kdir_unknown=7      
                              };
/*************************************************************************/
enum tN2kHeadingReference {
                            N2khr_true=0,         
                            N2khr_magnetic=1,     
                            N2khr_error=2,        
                            N2khr_Unavailable=3   
                          };
 
/*************************************************************************/
enum tN2kDistanceCalculationType {
                            N2kdct_GreatCircle=0,     
                            N2kdct_RhumbLine=1        
                          };
/*************************************************************************/
enum tN2kXTEMode  {
                            N2kxtem_Autonomous=0,     
                            N2kxtem_Differential=1,   
                            N2kxtem_Estimated=2,      
                            N2kxtem_Simulator=3,      
                            N2kxtem_Manual=4          
                          };
 
/*************************************************************************/
enum tN2kGNSStype {
                            N2kGNSSt_GPS=0,                   
                            N2kGNSSt_GLONASS=1,               
                            N2kGNSSt_GPSGLONASS=2,            
                            N2kGNSSt_GPSSBASWAAS=3,           
                            N2kGNSSt_GPSSBASWAASGLONASS=4,    
                            N2kGNSSt_Chayka=5,                
                            N2kGNSSt_integrated=6,            
                            N2kGNSSt_surveyed=7,              
                            N2kGNSSt_Galileo=8                
                          };
/*************************************************************************/
enum tN2kGNSSmethod {
                            N2kGNSSm_noGNSS=0,        
                            N2kGNSSm_GNSSfix=1,       
                            N2kGNSSm_DGNSS=2,         
                            N2kGNSSm_PreciseGNSS=3,   
                            N2kGNSSm_RTKFixed=4,      
                            N2kGNSSm_RTKFloat=5,      
                            N2kGNSSm_Error=14,        
                            N2kGNSSm_Unavailable=15   
                          };
/*************************************************************************/
enum tN2kGNSSDOPmode {
                            N2kGNSSdm_1D=0,               
                            N2kGNSSdm_2D=1,               
                            N2kGNSSdm_3D=2,               
                            N2kGNSSdm_Auto=3,             
                            N2kGNSSdm_Reserved=4,         
                            N2kGNSSdm_Reserved2=5,        
                            N2kGNSSdm_Error=6,            
                            N2kGNSSdm_Unavailable=7       
                          };
/*************************************************************************/
enum tN2kTempSource {
                            N2kts_SeaTemperature=0,                         
                            N2kts_OutsideTemperature=1,                     
                            N2kts_InsideTemperature=2,                      
                            N2kts_EngineRoomTemperature=3,                  
                            N2kts_MainCabinTemperature=4,                   
                            N2kts_LiveWellTemperature=5,                    
                            N2kts_BaitWellTemperature=6,                    
                            N2kts_RefridgerationTemperature=7,              
                            N2kts_HeatingSystemTemperature=8,               
                            N2kts_DewPointTemperature=9,                    
                            N2kts_ApparentWindChillTemperature=10,          
                            N2kts_TheoreticalWindChillTemperature=11,       
                            N2kts_HeatIndexTemperature=12,                  
                            N2kts_FreezerTemperature=13,                    
                            N2kts_ExhaustGasTemperature=14,                 
                            N2kts_ShaftSealTemperature=15                   
                          };
/*************************************************************************/
enum tN2kHumiditySource {
                            N2khs_InsideHumidity=0,       
                            N2khs_OutsideHumidity=1,      
                            N2khs_Undef=0xff              
                          };
/*************************************************************************/
 enum tN2kPressureSource {
                            N2kps_Atmospheric = 0,        
                            N2kps_Water = 1,              
                            N2kps_Steam = 2,              
                            N2kps_CompressedAir = 3,      
                            N2kps_Hydraulic = 4,          
                            N2kps_Filter = 5,             
                            N2kps_AltimeterSetting = 6,   
                            N2kps_Oil = 7,                
                            N2kps_Fuel = 8,               
                            N2kps_Reserved = 253,         
                            N2kps_Error = 254,            
                            N2kps_Unavailable = 255       
                          };
/*************************************************************************/
enum tN2kTimeSource {
                            N2ktimes_GPS=0,                 
                            N2ktimes_GLONASS=1,             
                            N2ktimes_RadioStation=2,        
                            N2ktimes_LocalCesiumClock=3,    
                            N2ktimes_LocalRubidiumClock=4,  
                            N2ktimes_LocalCrystalClock=5    
                          };
/*************************************************************************/
enum tN2kFluidType {
                            N2kft_Fuel=0,             
                            N2kft_Water=1,            
                            N2kft_GrayWater=2,        
                            N2kft_LiveWell=3,         
                            N2kft_Oil=4,              
                            N2kft_BlackWater=5,       
                            N2kft_FuelGasoline=6,     
                            N2kft_Error=14,           
                            N2kft_Unavailable=15      
                          };
 
/*************************************************************************/
enum tN2kWindReference {
                            N2kWind_True_North=0,     
                            N2kWind_Magnetic=1,       
                            N2kWind_Apparent=2,       
                            N2kWind_Apprent=2,        
                            N2kWind_True_boat=3,      
                            N2kWind_True_water=4,     
                            N2kWind_Error=6,          
                            N2kWind_Unavailable=7     
                          };
/*************************************************************************/
enum tN2kSpeedWaterReferenceType {
                            N2kSWRT_Paddle_wheel=0,     
                            N2kSWRT_Pitot_tube=1,       
                            N2kSWRT_Doppler_log=2,      
                            N2kSWRT_Ultra_Sound=3,      
                            N2kSWRT_Electro_magnetic=4, 
                            N2kSWRT_Error=254,          
                            N2kSWRT_Unavailable=255     
                          };
/*************************************************************************/
enum tN2kRudderDirectionOrder {
                            N2kRDO_NoDirectionOrder=0,  
                            N2kRDO_MoveToStarboard=1,   
                            N2kRDO_MoveToPort=2,        
                            N2kRDO_Unavailable=7        
                          };
/*************************************************************************/
enum tN2kDCType {
                            N2kDCt_Battery=0,           
                            N2kDCt_Alternator=1,        
                            N2kDCt_Converter=2,         
                            N2kDCt_SolarCell=3,         
                            N2kDCt_WindGenerator=4      
                          };
/*************************************************************************/
enum tN2kBatType  {
                            N2kDCbt_Flooded=0,          
                            N2kDCbt_Gel=1,              
                            N2kDCbt_AGM=2               
                          };
/*************************************************************************/
enum tN2kBatEqSupport  {
                            N2kDCES_No=0,         
                            N2kDCES_Yes=1,        
                            N2kDCES_Error=2,      
                            N2kDCES_Unavailable=3 
                          };
/*************************************************************************/
enum tN2kBatChem {
                            N2kDCbc_LeadAcid=0,   
                            N2kDCbc_LiIon=1,      
                            N2kDCbc_NiCad=2,      
                            N2kDCbc_ZnO=3,        
                            N2kDCbc_NiMh=4        
                          };
/*************************************************************************/
enum tN2kBatNomVolt {
                            N2kDCbnv_6v=0,    
                            N2kDCbnv_12v=1,   
                            N2kDCbnv_24v=2,   
                            N2kDCbnv_32v=3,   
                            N2kDCbnv_62v=4,   
                            N2kDCbnv_42v=5,   
                            N2kDCbnv_48v=6    
                          };
/*************************************************************************/
enum tN2kTransmissionGear {
                            N2kTG_Forward=0,  
                            N2kTG_Neutral=1,  
                            N2kTG_Reverse=2,  
                            N2kTG_Unknown=3,  
                          };
/*************************************************************************/
enum tN2kAISRepeat {
                            N2kaisr_Initial=0,  
                            N2kaisr_First=1,    
                            N2kaisr_Second=2,   
                            N2kaisr_Final=3,    
                          };
 
/*************************************************************************/
enum tN2kAISVersion {
                            N2kaisv_ITU_R_M_1371_1=0,   
                            N2kaisv_ITU_R_M_1371_3=1,   
                          };
 
/*************************************************************************/
enum tN2kAISNavStatus {
                            N2kaisns_Under_Way_Motoring=0,                  
                            N2kaisns_At_Anchor=1,                           
                            N2kaisns_Not_Under_Command=2,                   
                            N2kaisns_Restricted_Manoeuverability=3,         
                            N2kaisns_Constrained_By_Draught=4,              
                            N2kaisns_Moored=5,                              
                            N2kaisns_Aground=6,                             
                            N2kaisns_Fishing=7,                             
                            N2kaisns_Under_Way_Sailing=8,                   
                            N2kaisns_Hazardous_Material_High_Speed=9,       
                            N2kaisns_Hazardous_Material_Wing_In_Ground=10,  
                            N2kaisns_AIS_SART=14,                           
                          };
/*************************************************************************/
enum tN2kAISDTE {
                            N2kaisdte_Ready=0,      
                            N2kaisdte_NotReady=1,   
                          };
/*************************************************************************/
enum tN2kAISUnit {
                            N2kaisunit_ClassB_SOTDMA=0,   
                            N2kaisunit_ClassB_CS=1,       
                          };
/*************************************************************************/
enum tN2kAISMode {
                            N2kaismode_Autonomous=0,    
                            N2kaismode_Assigned=1,      
                          };
/*************************************************************************/
enum tN2kAISTransceiverInformation {
                           N2kaischannel_A_VDL_reception=0,         
                           N2kaischannel_B_VDL_reception=1,         
                           N2kaischannel_A_VDL_transmission=2,      
                           N2kaischannel_B_VDL_transmission=3,      
                           N2kaisown_information_not_broadcast=4    
                          };
/*************************************************************************/
enum tN2kMagneticVariation {
                            N2kmagvar_Manual=0,     
                            N2kmagvar_Chart=1,      
                            N2kmagvar_Table=2,      
                            N2kmagvar_Calc=3,       
                            N2kmagvar_WMM2000=4,    
                            N2kmagvar_WMM2005=5,    
                            N2kmagvar_WMM2010=6,    
                            N2kmagvar_WMM2015=7,    
                            N2kmagvar_WMM2020=8,    
                          };
/*************************************************************************/
enum tN2kOnOff  {
                            N2kOnOff_Off=0,         
                            N2kOnOff_On=1,          
                            N2kOnOff_Error=2,       
                            N2kOnOff_Unavailable=3  
                          };
 
/*************************************************************************/
enum tN2kChargeState  {
                            N2kCS_Not_Charging=0,     
                            N2kCS_Bulk=1,             
                            N2kCS_Absorption=2,       
                            N2kCS_Overcharge=3,       
                            N2kCS_Equalise=4,         
                            N2kCS_Float=5,            
                            N2kCS_No_Float=6,         
                            N2kCS_Constant_VI=7,      
                            N2kCS_Disabled=8,         
                            N2kCS_Fault=9,            
                            N2kCS_Unavailable=15      
                          };
 
/*************************************************************************/
enum tN2kChargerMode {
                            N2kCM_Standalone=0,   
                            N2kCM_Primary=1,      
                            N2kCM_Secondary=2,    
                            N2kCM_Echo=3,         
                            N2kCM_Unavailable=15  
                          };
 
/*************************************************************************/
enum tN2kSteeringMode {
                            N2kSM_MainSteering=0,               
                            N2kSM_NonFollowUpDevice=1,          
                            N2kSM_FollowUpDevice=2,             
                            N2kSM_HeadingControlStandalone=3,   
                            N2kSM_HeadingControl=4,             
                            N2kSM_TrackControl=5,               
                            N2kSM_Unavailable=7                 
                          };
                          
/*************************************************************************/
enum tN2kTurnMode {
                            N2kTM_RudderLimitControlled=0,      
                            N2kTM_TurnRateControlled=1,         
                            N2kTM_RadiusControlled=2,           
                            N2kTM_Unavailable=7                 
                          };
/*************************************************************************/
enum tN2kMOBStatus {
                            MOBEmitterActivated=0,                
                            ManualOnBoardMOBButtonActivation=1,   
                            TestMode=2,                           
                            MOBNotActive=3                        
                          };
/*************************************************************************/
enum tN2kMOBPositionSource {
                           PositionEstimatedByVessel=0,           
                           PositionReportedByMOBEmitter=1,        
                          };
/*************************************************************************/
enum tN2kMOBEmitterBatteryStatus {
                           Good=0,    
                           Low=1,     
                          };
 
//*****************************************************************************
// Aliases for N2K standard types.
//*****************************************************************************
 
using tN2kEngineDiscreteStatus1 = tN2kDD206;
using tN2kEngineDiscreteStatus2 = tN2kDD223;
 
using tN2kGenericStatusPair = tN2kDD002;
                // Enum type members:
                  // N2kDD002_No=0
                  // N2kDD002_Yes=1
                  // N2kDD002_Error=2
                  // N2kDD002_Unavailable=3
                  // N2kDD002_Off=N2kDD002_No
                  // N2kDD002_Disabled=N2kDD002_No
                  // N2kDD002_Reset=N2kDD002_No
                  // N2kDD002_0=N2kDD002_No
                  // N2kDD002_On=N2kDD002_Yes
                  // N2kDD002_Enabled=N2kDD002_Yes
                  // N2kDD002_Set=N2kDD002_Yes
                  // N2kDD002_1=N2kDD002_Yes
                  // N2kDD002_Unknown=N2kDD002_Unavailable                         
 
using tN2kDataMode = tN2kDD025;
            // Enum type members:
                  // N2kDD025_Autonomous=0,
                  // N2kDD025_Differential=1,
                  // N2kDD025_Estimated=2,
                  // N2kDD025_Simulator=3,
                  // N2kDD025_Manual=4,
                  // N2kDD025_Error=0xe,
                  // N2kDD025_Unavailable=0xf
 
using tN2kRangeResidualMode = tN2kDD072;
                  // N2kDD072_RangeResidualsWereUsedToCalculateData=0,
                  // N2kDD072_RangeResidualsWereCalculatedAfterPosition=1,
                  // N2kDD072_Error=2,
                  // N2kDD072_Unavailable=3
 
using tN2kPRNUsageStatus = tN2kDD124;                           
                  // N2kDD124_NotTracked=0,
                  // N2kDD124_TrackedButNotUsedInSolution=1,
                  // N2kDD124_UsedInSolutionWithoutDifferentialCorrections=2,
                  // N2kDD124_DifferentialCorrectionsAvailable=3,
                  // N2kDD124_TrackedWithDifferentialCorrections=4,
                  // N2kDD124_UsedWithDifferentialCorrections=5,
                  // N2kDD124_Error=14,
                  // N2kDD124_Unavailable=15,
 
using tN2kAISAtoNType = tN2kDD305;
                // Enum type members:
                // N2kAISAtoN_not_specified=0,
                // N2kAISAtoN_reference_point=1,
                // N2kAISAtoN_RACON=2,
                // N2kAISAtoN_fixed_structure=3,
                // N2kAISAtoN_emergency_wreck_marking_buoy=4,
                // N2kAISAtoN_light_without_sectors=5,
                // N2kAISAtoN_light_with_sectors=6,
                // N2kAISAtoN_leading_light_front=7,
                // N2kAISAtoN_leading_light_rear=8,
                // N2kAISAtoN_beacon_cardinal_N=9,
                // N2kAISAtoN_beacon_cardinal_E=10,
                // N2kAISAtoN_beacon_cardinal_S=11,
                // N2kAISAtoN_beacon_cardinal_W=12,
                // N2kAISAtoN_beacon_port_hand=13,
                // N2kAISAtoN_beacon_starboard_hand=14,
                // N2kAISAtoN_beacon_preferred_ch_port_hand=15,
                // N2kAISAtoN_beacon_preferred_ch_starboard_hand=16,
                // N2kAISAtoN_beacon_isolated_danger=17,
                // N2kAISAtoN_beacon_safe_water=18,
                // N2kAISAtoN_beacon_special_mark=19,
                // N2kAISAtoN_cardinal_mark_N=20,
                // N2kAISAtoN_cardinal_mark_E=21,
                // N2kAISAtoN_cardinal_mark_S=22,
                // N2kAISAtoN_cardinal_mark_W=23,
                // N2kAISAtoN_port_hand_mark=24,
                // N2kAISAtoN_starboard_hand_mark=25,
                // N2kAISAtoN_preferred_channel_port_hand=26,
                // N2kAISAtoN_preferred_channel_starboard_hand=27,
                // N2kAISAtoN_isolated_danger=28,
                // N2kAISAtoN_safe_water=29,
                // N2kAISAtoN_special_mark=30,
                // N2kAISAtoN_light_vessel_lanby_rigs=31,
 
using tN2kDelaySource = tN2kDD374;
    //        N2kDD374_UserDefined=0,
    //        N2kDD374_MinimumDefined=1,
    //        N2kDD374_FactoryDefault=2,
    //        N2kDD374_MaximumSupported=3,
    //        N2kDD374_OutOfRange=14,
    //        N2kDD374_DataNotAvailable=15
 
using tN2kThrusterMotorEvents = tN2kDD471;
    // .Event.MotorOverTemperatureCutout = 0 | 1
    // .Event.MotorOverCurrentCutout = 0 | 1
    // .Event.LowOilLevelWarning = 0 | 1
    // .Event.OilOverTemperatureWarning = 0 | 1
    // .Event.ControllerUnderVoltageCutout = 0 | 1
    // .Event.ManufacturerDefined = 0 | 1
    // .Event.DataNotAvailable = 0 | 1
 
using tN2kThrusterDirectionControl = tN2kDD473;
    // N2kDD473_OFF=0
    // N2kDD473_ThrusterReady=1
    // N2kDD473_ThrusterToPORT=2
    // N2kDD473_ThrusterToSTARBOARD=3
 
using tN2kThrusterRetraction = tN2kDD474;
    // N2kDD474_OFF=0
    // N2kDD474_Extend=1
    // N2kDD474_Retract=2
 
using tN2kThrusterControlEvents = tN2kDD475;
    // .Event.AnotherDeviceControllingThruster = 0 | 1
    // .Event.BoatSpeedTooFast = 0 | 1
 
using tN2kWindlassMonitoringEvents = tN2kDD477;
                // Union type with fields:
                            // .Event.ControllerUnderVoltageCutout = 0 | 1
                            // .Event.ControllerOverCurrentCutout = 0 | 1
                            // .Event.ControllerOverTemperatureCutout = 0 | 1
 
using tN2kWindlassControlEvents = tN2kDD478;
                // Union type with field:
                            // .Event.AnotherDeviceControllingWindlass = 0 | 1
 
using tN2kWindlassMotionStates = tN2kDD480;
                // Enum type members:
                            // N2kDD480_WindlassStopped=0
                            // N2kDD480_DeploymentOccurring=1
                            // N2kDD480_RetrievalOccurring=2
                            // N2kDD480_Unavailable=3
 
using tN2kRodeTypeStates = tN2kDD481;
                // Enum type members:
                            // N2kDD481_ChainPresentlyDetected=0
                            // N2kDD481_RopePresentlyDetected=1
                            // N2kDD481_Error=2
                            // N2kDD481_Unavailable=3
 
using tN2kAnchorDockingStates = tN2kDD482;
                // Enum type members:
                            // N2kDD482_NotDocked=0
                            // N2kDD482_FullyDocked=1
                            // N2kDD482_Error=2
                            // N2kDD482_DataNotAvailable=3
 
using tN2kWindlassOperatingEvents = tN2kDD483;
                // Union type with fields:
                            // .Event.SystemError =  0 | 1
                            // .Event.SensorError = 0 | 1
                            // .Event.NoWindlassMotionDetected = 0 | 1
                            // .Event.RetrievalDockingDistanceReached = 0 | 1
                            // .Event.EndOfRodeReached = 0 | 1
 
using tN2kWindlassDirectionControl = tN2kDD484;
                // Enum type members:
                            // N2kDD484_Off=0
                            // N2kDD484_Down=1
                            // N2kDD484_Up=2
                            // N2kDD484_Reserved=3
 
using tN2kMotorPowerType = tN2kDD487;
    // N2kDD487_12VDC=0
    // N2kDD487_24VDC=1
    // N2kDD487_48VDC=2
    // N2kDD487_12VAC=3
    // N2kDD487_Hydraulic=4
 
using tN2kSpeedType = tN2kDD488;
                // Enum type members:
                            // N2kDD488_SingleSpeed=0
                            // N2kDD488_DualSpeed=1
                            // N2kDD488_ProportionalSpeed=2
                            // N2kDD488_DataNotAvailable=3
 
#endif