Types

class n2k.types.ProductInformation(*, n2k_version: int | None, product_code: int | None, n2k_model_id: str | None, n2k_sw_code: str | None, n2k_model_version: str | None, n2k_model_serial_code: str | None, certification_level: int | None, load_equivalency: int | None) → None

Bases: object

n2k_version: int | None

product_code: int | None

n2k_model_id: str | None

n2k_sw_code: str | None

n2k_model_version: str | None

n2k_model_serial_code: str | None

certification_level: int | None

load_equivalency: int | None

__init__(*, n2k_version: int | None, product_code: int | None, n2k_model_id: str | None, n2k_sw_code: str | None, n2k_model_version: str | None, n2k_model_serial_code: str | None, certification_level: int | None, load_equivalency: int | None) → None

class n2k.types.ConfigurationInformation(*, manufacturer_information: str, installation_description1: str, installation_description2: str) → None

Bases: object

manufacturer_information: str

installation_description1: str

installation_description2: str

__init__(*, manufacturer_information: str, installation_description1: str, installation_description2: str) → None

class n2k.types.CANSendFrame(*, id: int, length: int, buffer: bytearray) → None

Bases: object

id: int

length: int

buffer: bytearray

__init__(*, id: int, length: int, buffer: bytearray) → None

class n2k.types.N2kNavigationDirection(*values)

Bases: IntEnum

forward = 0

reverse = 1

reserved1 = 2

reserved2 = 3

reserved3 = 4

reserved4 = 5

error = 6

unknown = 7

class n2k.types.N2kHeadingReference(*values)

Bases: IntEnum

true = 0

magnetic = 1

error = 2

Unavailable = 3

class n2k.types.N2kDistanceCalculationType(*values)

Bases: IntEnum

GreatCircle = 0

RhumbLine = 1

class n2k.types.N2kXTEMode(*values)

Bases: IntEnum

Autonomous = 0

Differential = 1

Estimated = 2

Simulator = 3

Manual = 4

class n2k.types.N2kGNSSType(*values)

Bases: IntEnum

GPS = 0

GLONASS = 1

GPS_GLONASS = 2

GPS_SBAS_WAAS = 3

GPS_SBAS_WAAS_GLONASS = 4

Chayka = 5

integrated = 6

surveyed = 7

Galileo = 8

class n2k.types.N2kGNSSMethod(*values)

Bases: IntEnum

NoGNSS = 0

GNSS_fix = 1

DGNSS = 2

PreciseGNSS = 3

RTKFixed = 4

RTKFloat = 5

Error = 14

Unavailable = 15

class n2k.types.N2kGNSSDOPmode(*values)

Bases: IntEnum

Vertical = 0

1D

Horizontal = 1

2D

Positional = 2

3D

Auto = 3

Reserved = 4

Reserved2 = 5

Error = 6

Unavailable = 7

class n2k.types.N2kTempSource(*values)

Bases: IntEnum

SeaTemperature = 0

OutsideTemperature = 1

InsideTemperature = 2

EngineRoomTemperature = 3

MainCabinTemperature = 4

LiveWellTemperature = 5

BaitWellTemperature = 6

RefrigerationTemperature = 7

HeatingSystemTemperature = 8

DewPointTemperature = 9

ApparentWindChillTemperature = 10

TheoreticalWindChillTemperature = 11

HeatIndexTemperature = 12

FreezerTemperature = 13

ExhaustGasTemperature = 14

ShaftSealTemperature = 15

class n2k.types.N2kHumiditySource(*values)

Bases: IntEnum

InsideHumidity = 0

OutsideHumidity = 1

class n2k.types.N2kPressureSource(*values)

Bases: IntEnum

Atmospheric = 0

Water = 1

Steam = 2

CompressedAir = 3

Hydraulic = 4

Filter = 5

AltimeterSetting = 6

Oil = 7

Fuel = 8

Reserved = 253

Error = 254

Unavailable = 255

class n2k.types.N2kTimeSource(*values)

Bases: IntEnum

GPS = 0

GLONASS = 1

RadioStation = 2

LocalCesiumClock = 3

LocalRubidiumClock = 4

LocalCrystalClock = 5

class n2k.types.N2kFluidType(*values)

Bases: IntEnum

Fuel = 0

Water = 1

GrayWater = 2

LiveWell = 3

Oil = 4

BlackWater = 5

FuelGasoline = 6

Error = 14

Unavailable = 15

class n2k.types.N2kWindReference(*values)

Bases: IntEnum

TrueNorth = 0

Magnetic = 1

Apparent = 2

TrueBoat = 3

TrueWater = 4

Error = 6

Unavailable = 7

class n2k.types.N2kSpeedWaterReferenceType(*values)

Bases: IntEnum

PaddleWheel = 0

PitotTube = 1

DopplerLog = 2

Ultrasound = 3

Electromagnetic = 4

Error = 254

Unavailable = 255

class n2k.types.N2kRudderDirectionOrder(*values)

Bases: IntEnum

NoDirectionOrder = 0

MoveToStarboard = 1

MoveToPort = 2

Unavailable = 7

class n2k.types.N2kDCType(*values)

Bases: IntEnum

Battery = 0

Alternator = 1

Converter = 2

SolarCell = 3

WindGenerator = 4

class n2k.types.N2kBatType(*values)

Bases: IntEnum

Flooded = 0

Gel = 1

AGM = 2

class n2k.types.N2kBatEqSupport(*values)

Bases: IntEnum

No = 0

Yes = 1

Error = 2

Unavailable = 3

class n2k.types.N2kBatChem(*values)

Bases: IntEnum

LeadAcid = 0

LiIon = 1

NiCad = 2

Zn0 = 3

NiMh = 4

class n2k.types.N2kBatNomVolt(*values)

Bases: IntEnum

Volt_6 = 0

Volt_12 = 1

Volt_24 = 2

Volt_32 = 3

Volt_36 = 4

Volt_42 = 5

Volt_48 = 6

class n2k.types.N2kTransmissionGear(*values)

Bases: IntEnum

Forward = 0

Neutral = 1

Reverse = 2

Unknown = 3

class n2k.types.N2kAISRepeat(*values)

Bases: IntEnum

Initial = 0

First = 1

Second = 2

Final = 3

class n2k.types.N2kAISVersion(*values)

Bases: IntEnum

ITU_R_M_1371_1 = 0

ITU_R_M_1371_3 = 1

class n2k.types.N2kAISNavStatus(*values)

Bases: IntEnum

Under_Way_Motoring = 0

At_Anchor = 1

Not_Under_Command = 2

Restricted_Maneuverability = 3

Constrained_By_Draught = 4

Moored = 5

Aground = 6

Fishing = 7

Under_Way_Sailing = 8

Hazardous_Material_High_Speed = 9

Hazardous_Material_Wing_In_Ground = 10

AIS_SART = 14

class n2k.types.N2kAISDTE(*values)

Bases: IntEnum

Ready = 0

NotReady = 1

class n2k.types.N2kAISUnit(*values)

Bases: IntEnum

ClassB_SOTDMA = 0

ClassB_CS = 1

class n2k.types.N2kAISMode(*values)

Bases: IntEnum

Autonomous = 0

Assigned = 1

class n2k.types.N2kAISTransceiverInformation(*values)

Bases: IntEnum

Channel_A_VDL_reception = 0

Channel_B_VDL_reception = 1

Channel_A_VDL_transmission = 2

Channel_B_VDL_transmission = 3

Own_information_not_broadcast = 4

Reserved = 5

class n2k.types.N2kAISMessageID(*values)

Bases: IntEnum

Scheduled_Class_A_position_report = 1

Assigned_scheduled_Class_A_position_report = 2

Interrogated_Class_A_position_report = 3

Base_station_report = 4

Static_and_voyage_related_data = 5

Binary_addressed_message = 6

Binary_acknowledgement = 7

Binary_broadcast_message = 8

Standard_SAR_aircraft_position_report = 9

UTC_date_inquiry = 10

UTC_date_response = 11

Safety_related_addressed_message = 12

Safety_related_acknowledgement = 13

Safety_related_broadcast_message = 14

Interrogation = 15

Assignment_mode_command = 16

DGNSS_broadcast_binary_message = 17

Standard_Class_B_position_report = 18

Extended_Class_B_position_report = 19

Data_link_management_message = 20

ATON_report = 21

Channel_management = 22

Group_assignment_command = 23

Static_data_report = 24

Single_slot_binary_message = 25

Multiple_slot_binary_message = 26

Position_report_for_long_range_applications = 27

class n2k.types.N2kMagneticVariation(*values)

Bases: IntEnum

Manual = 0

Chart = 1

Table = 2

Calc = 3

WMM2000 = 4

WMM2005 = 5

WMM2010 = 6

WMM2015 = 7

WMM2020 = 8

class n2k.types.N2kOnOff(*values)

Bases: IntEnum

Off = 0

On = 1

Error = 2

Unavailable = 3

class n2k.types.N2kChargeState(*values)

Bases: IntEnum

Not_Charging = 0

Bulk = 1

Absorption = 2

Overcharge = 3

Equalize = 4

Float = 5

No_Float = 6

Constant_VI = 7

Disabled = 8

Fault = 9

Error = 14

Unavailable = 15

class n2k.types.N2kChargerMode(*values)

Bases: IntEnum

Standalone = 0

Primary = 1

Secondary = 2

Echo = 3

Unavailable = 15

class n2k.types.N2kConvMode(*values)

Bases: IntEnum

Off = 0

LP_Mode = 1

Fault = 2

Bulk = 3

Absorption = 4

Float = 5

Storage = 6

Equalize = 7

Passthrough = 8

Inverting = 9

Assisting = 10

PSU_Mode = 11

Hub1 = 252

NotAvailable = 255

class n2k.types.N2kRippleState(*values)

Bases: IntEnum

OK = 0

Warning = 1

High = 2

NotAvailable = 3

class n2k.types.N2kDCVoltageState(*values)

Bases: IntEnum

OK = 0

Warning = 1

Low = 2

NotAvailable = 3

class n2k.types.N2kOverloadState(*values)

Bases: IntEnum

OK = 0

Warning = 1

Overload = 2

NotAvailable = 3

class n2k.types.N2kTemperatureState(*values)

Bases: IntEnum

OK = 0

Warning = 1

High = 2

NotAvailable = 3

class n2k.types.N2kChargingAlgorithm(*values)

Bases: IntEnum

Trickle = 0

CVCC = 1

TwoStage = 2

ThreeStage = 3

Error = 14

NotAvailable = 15

class n2k.types.N2kBattTempNoSensor(*values)

Bases: IntEnum

Cold = 0

Warm = 1

Hot = 2

Error = 14

NotAvailable = 15

class n2k.types.N2kSteeringMode(*values)

Bases: IntEnum

MainSteering = 0

NonFollowUpDevice = 1

FollowUpDevice = 2

HeadingControlStandalone = 3

HeadingControl = 4

TrackControl = 5

Unavailable = 7

class n2k.types.N2kTurnMode(*values)

Bases: IntEnum

RudderLimitControlled = 0

TurnRateControlled = 1

RadiusControlled = 2

Unavailable = 7

class n2k.types.N2kMOBStatus(*values)

Bases: IntEnum

MOBEmitterActivated = 0

ManualOnBoardMOBButtonActivation = 1

TestMode = 2

MOBNotActive = 3

class n2k.types.N2kMOBPositionSource(*values)

Bases: IntEnum

PositionEstimatedByVessel = 0

PositionReportedByMOBEmitter = 1

class n2k.types.N2kMOBEmitterBatteryStatus(*values)

Bases: IntEnum

Good = 0

Low = 1

class n2k.types.N2kPGNList(*values)

Bases: IntEnum

transmit = 0

receive = 1

class n2k.types.N2kTransmissionDiscreteStatus1(*, check_temperature: int = 0, over_temperature: int = 0, low_oil_pressure: int = 0, low_oil_level: int = 0, sail_drive: int = 0) → None

Bases: object

check_temperature: int = 0

over_temperature: int = 0

low_oil_pressure: int = 0

low_oil_level: int = 0

sail_drive: int = 0

property status: int

static from_status(value: int) → N2kTransmissionDiscreteStatus1

Return type:

N2kTransmissionDiscreteStatus1

__init__(*, check_temperature: int = 0, over_temperature: int = 0, low_oil_pressure: int = 0, low_oil_level: int = 0, sail_drive: int = 0) → None

class n2k.types.Waypoint(*, id: int | None, name: str | None, latitude: float | None, longitude: float | None) → None

Bases: object

id: int | None

name: str | None

latitude: float | None

longitude: float | None

__init__(*, id: int | None, name: str | None, latitude: float | None, longitude: float | None) → None

class n2k.types.SatelliteInfo(*, prn: int | None, elevation: float | None, azimuth: float | None, snr: float | None, range_residuals: float | None, usage_status: N2kDD124) → None

Bases: object

prn: int | None

elevation: float | None

azimuth: float | None

snr: float | None

range_residuals: float | None

usage_status: N2kDD124

__init__(*, prn: int | None, elevation: float | None, azimuth: float | None, snr: float | None, range_residuals: float | None, usage_status: N2kDD124) → None