Canboat ts-pgns
    Preparing search index...

    Type Alias Definition

    Represents the definition of a PGN (Parameter Group Number), including metadata, configuration, and field definitions.

    type Definition = {
        Complete: boolean;
        Description: string;
        Explanation?: string;
        Fallback?: boolean;
        FieldCount?: number;
        Fields: Field[];
        Id: string;
        Length?: number;
        MinLength?: number;
        Missing?: string[];
        PGN: number;
        Priority: number;
        RepeatingFieldSet1CountField?: number;
        RepeatingFieldSet1Size?: number;
        RepeatingFieldSet1StartField?: number;
        RepeatingFieldSet2CountField?: number;
        RepeatingFieldSet2Size?: number;
        RepeatingFieldSet2StartField?: number;
        TransmissionInterval?: number;
        TransmissionIrregular?: boolean;
        Type: Type;
        URL?: string;
    }
    Index

    Properties

    Complete Description Explanation? Fallback? FieldCount? Fields Id Length? MinLength? Missing? PGN Priority RepeatingFieldSet1CountField? RepeatingFieldSet1Size? RepeatingFieldSet1StartField? RepeatingFieldSet2CountField? RepeatingFieldSet2Size? RepeatingFieldSet2StartField? TransmissionInterval? TransmissionIrregular? Type URL?

    Properties

    Complete: boolean

    Indicates if the PGN definition is complete.

    Description: string

    Human-readable description of the PGN.

    Explanation?: string

    Optional detailed explanation of the PGN.

    Fallback?: boolean

    Indicates if fallback is allowed for this PGN.

    FieldCount?: number

    Optional number of fields in the PGN.

    Fields: Field[]

    Array of field definitions for the PGN.

    Id: string

    Unique string identifier for the PGN.

    Length?: number

    Optional fixed length of the PGN in bytes.

    MinLength?: number

    Optional minimum length of the PGN in bytes.

    Missing?: string[]

    Optional list of missing fields or elements.

    PGN: number

    The numeric identifier for the PGN.

    Priority: number

    Transmission priority of the PGN.

    RepeatingFieldSet1CountField?: number

    Optional count field for the first repeating field set.

    RepeatingFieldSet1Size?: number

    Optional size of the first repeating field set.

    RepeatingFieldSet1StartField?: number

    Optional start index for the first repeating field set.

    RepeatingFieldSet2CountField?: number

    Optional count field for the second repeating field set.

    RepeatingFieldSet2Size?: number

    Optional size of the second repeating field set.

    RepeatingFieldSet2StartField?: number

    Optional start index for the second repeating field set.

    TransmissionInterval?: number

    Optional transmission interval in milliseconds.

    TransmissionIrregular?: boolean

    Indicates if transmission interval is irregular.

    Type: Type

    Type of PGN, as defined by Type.

    URL?: string

    Optional reference URL for documentation.

    Settings

    Member Visibility

    On This Page

    Properties