jsax25
    Preparing search index...

    Interface IFrameConstructor

    Information Frame Constructor

    interface IFrameConstructor {
        destinationCallsign: string;
        destinationReservedBitOne?: boolean;
        destinationReservedBitTwo?: boolean;
        destinationSsid: number;
        modulo?: 8 | 128;
        payload: any;
        pid?: number;
        pollOrFinal?: boolean;
        receivedSequence: number;
        repeaters?: Repeater[];
        sendSequence: number;
        sourceCallsign: string;
        sourceReservedBitOne?: boolean;
        sourceReservedBitTwo?: boolean;
        sourceSsid: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    destinationCallsign: string

    The destination station's amateur radio callsign. Valid callsigns are 1 to 6 characters (inclusive), all uppercase.

    destinationReservedBitOne?: boolean

    Reserved bit that may be used in an agreed-upon manner in individual networks.

    false
    
    destinationReservedBitTwo?: boolean

    Reserved bit that may be used in an agreed-upon manner in individual networks.

    false
    
    destinationSsid: number

    The destination station's SSID. Valid SSIDs are integers 0 to 15 (inclusive).

    modulo?: 8 | 128

    Determines the number of outstanding information frames allowed per layer 2 connection at one time.

    Only change this to 128 on supervisory and information frames when you are sure that you are using modulo 128, as setting it incorrectly will cause frames not to decode.

    8
    
    payload: any

    The data or "body" being carried by the frame.

    Non-objects are stringified then encoded using TextEncoder. Objects are first run though JSON.stringify(), then encoded using TextEncoder. Exceptions are Uint8Array and Uint8ClampedArray objects, which are pushed directly to the payload without transformation. Use this format to transmit raw binary data.

    pid?: number

    A number indicating which layer 3 protocol is in use according to the AX25 spec. Found on information (I) and unnumbered information (UI) frames. Otherwise undefined.

    Valid values are integers 0 to 255 inclusive.

    240
    
    pollOrFinal?: boolean

    Used in all types of frames. The P/F bit is also used in a command (poll) mode to request an immediate reply to a frame. The reply to this poll is indicated by setting the response (final) bit in the appropriate frame.

    false
    
    receivedSequence: number

    Exists on information and supervisory frames. Otherwise undefined. Prior to sending an information or supervisory frame, this variable is updated to equal that of the received state variable, thus implicitly acknowledging the proper reception of all frames up to and including receivedSequence - 1.

    Valid values are integers 0 to 7 inclusive when using modulo 8, or integers 0 to 127 inclusive when using modulo 127.

    repeaters?: Repeater[]

    The repeaters/digipeaters that the frame is addressed to travel through.

    []
    
    sendSequence: number

    Found in the control field of all information frames. Otherwise undefined. It contains the sequence number of the information frame being sent. Just prior to the transmission of the information frame, it is updated to equal the send state variable.

    Valid values are integers 0 to 7 inclusive when using modulo 8, or integers 0 to 127 inclusive when using modulo 127.

    sourceCallsign: string

    The sending station's amateur radio callsign. Valid callsigns are 1 to 6 characters (inclusive), all uppercase.

    sourceReservedBitOne?: boolean

    Reserved bit that may be used in an agreed-upon manner in individual networks.

    false
    
    sourceReservedBitTwo?: boolean

    Reserved bit that may be used in an agreed-upon manner in individual networks.

    false
    
    sourceSsid: number

    The sending station's SSID. Valid SSIDs are integers 0 to 15 (inclusive).