n2kcatalog

package
v1.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 5, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package n2kcatalog owns Beacon's runtime view of the NMEA 2000 PGN and field catalog, including unit-scaled values for decoded messages.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type MessageMetadata

type MessageMetadata struct {
	Name             string   `json:"name,omitempty"`
	Variant          string   `json:"variant,omitempty"`
	Transport        string   `json:"transport,omitempty"`
	Complete         bool     `json:"complete"`
	Fallback         bool     `json:"fallback"`
	Missing          []string `json:"missing,omitempty"`
	ManufacturerCode *uint16  `json:"manufacturer_code,omitempty"`
}

func Describe

func Describe(message pgn.PGN, raw []byte) (MessageMetadata, map[string]PhysicalField)

func DescribeUnknown

func DescribeUnknown(number uint32, raw []byte) MessageMetadata

type PGN

type PGN struct {
	Number   uint32         `json:"pgn"`
	Variants []*pgn.PgnInfo `json:"variants"`
}

func List

func List() []PGN

func Lookup

func Lookup(number uint32) (PGN, bool)

type PhysicalField

type PhysicalField struct {
	Value            float64  `json:"value"`
	Unit             string   `json:"unit,omitempty"`
	PhysicalQuantity string   `json:"physical_quantity,omitempty"`
	Minimum          *float64 `json:"minimum,omitempty"`
	Maximum          *float64 `json:"maximum,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL