Class IFrame

Information Frame

Hierarchy

OutgoingAbstract
- IFrame

Constructors

constructor

new IFrame(args: IFrameConstructor): IFrame
Parameters
- args: IFrameConstructor
Returns IFrame
Overrides OutgoingAbstract.constructor
- Defined in frames/outgoing/information.ts:63

Properties

destinationReservedBitOne

destinationReservedBitOne: boolean

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

destinationReservedBitTwo

destinationReservedBitTwo: boolean

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

sourceReservedBitOne

sourceReservedBitOne: boolean

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

sourceReservedBitTwo

sourceReservedBitTwo: boolean

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

`Readonly`subtype

subtype: FrameSubtype

The specific type of frame being represented (UI, I, SABM, etc.)

See

FrameSubtype

Returns

the string name of the frame type.

`Readonly`type

type: "information" | "supervisory" | "unnumbered"

Whether the frame is an unnumbered, supervisory, or information frame.

Accessors

commandOrResponse

get commandOrResponse(): "command" | "response"
Whether the frame is a command frame or a response frame if it is using the latest version of the AX.25 protocol. If not, then it is using the legacy protocol.

Returns "command" | "response"
string 'command', 'response', or 'legacy'
Inherited from UAFrame.commandOrResponse
- Defined in frames/outgoing/outgoingabstract.ts:230
set commandOrResponse(commandOrResponse: "command" | "response"): void
Whether the frame is a command frame or a response frame if it is using the latest version of the AX.25 protocol. If not, then it is using the legacy protocol.
Parameters
- commandOrResponse: "command" | "response"
Returns void
string 'command', 'response', or 'legacy'
Inherited from UAFrame.commandOrResponse
- Defined in frames/outgoing/outgoingabstract.ts:234

destinationCallsign

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

Returns string
Throws
InvalidCallsignError on frames where this is mutable and an attempt was made to set an invalid callsign.
Inherited from REJFrame.destinationCallsign
- Defined in frames/outgoing/outgoingabstract.ts:176
set destinationCallsign(callsign: string): void
The destination station's amateur radio callsign. Valid callsigns are 1 to 6 characters (inclusive), all uppercase.
Parameters
- callsign: string
Returns void
Throws
InvalidCallsignError on frames where this is mutable and an attempt was made to set an invalid callsign.
Inherited from REJFrame.destinationCallsign
- Defined in frames/outgoing/outgoingabstract.ts:179

destinationCommandBit

get destinationCommandBit(): boolean
Determines in conjunction with the sourceCommandBit if the frame is a command, response, or legacy type frame.

Returns boolean
Inherited from REJFrame.destinationCommandBit
- Defined in frames/outgoing/outgoingabstract.ts:196
set destinationCommandBit(value: boolean): void
Determines in conjunction with the sourceCommandBit if the frame is a command, response, or legacy type frame.
Parameters
- value: boolean
Returns void
Inherited from REJFrame.destinationCommandBit
- Defined in frames/outgoing/outgoingabstract.ts:199

destinationSsid

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

Returns number
Throws
InvalidSsidError on frames where this is mutable and an attempt was made to set an invalid SSID.
Inherited from REJFrame.destinationSsid
- Defined in frames/outgoing/outgoingabstract.ts:187
set destinationSsid(ssid: number): void
The destination station's SSID. Valid SSIDs are integers 0 to 15 (inclusive).
Parameters
- ssid: number
Returns void
Throws
InvalidSsidError on frames where this is mutable and an attempt was made to set an invalid SSID.
Inherited from REJFrame.destinationSsid
- Defined in frames/outgoing/outgoingabstract.ts:190

isCommand

get isCommand(): boolean
Whether the frame is a command frame.

Returns boolean
Inherited from OutgoingAbstract.isCommand
- Defined in frames/outgoing/outgoingabstract.ts:245

isLegacy

get isLegacy(): boolean
Whether the frame is a legacy frame.

Returns boolean
Inherited from OutgoingAbstract.isLegacy
- Defined in frames/outgoing/outgoingabstract.ts:253

isResponse

get isResponse(): boolean
Whether the frame is a response frame.

Returns boolean
Inherited from OutgoingAbstract.isResponse
- Defined in frames/outgoing/outgoingabstract.ts:249

modulo

get modulo(): 8 | 128
Returns 8 | 128
Overrides DISCFrame.modulo
- Defined in frames/outgoing/information.ts:74
set modulo(modulo: 8 | 128): void
Parameters
- modulo: 8 | 128
Returns void
Overrides DISCFrame.modulo
- Defined in frames/outgoing/information.ts:77

payload

get 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.

Returns any
Throws
TypeError if attempting to set a symbol or a Promise as a payload. Symbols are not serializable and promises should be resolved to a value before setting them as the payload.
Overrides REJFrame.payload
- Defined in frames/outgoing/information.ts:102
set payload(payload: any): void
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.
Parameters
- payload: any
Returns void
Throws
TypeError if attempting to set a symbol or a Promise as a payload. Symbols are not serializable and promises should be resolved to a value before setting them as the payload.
Overrides REJFrame.payload
- Defined in frames/outgoing/information.ts:105

pid

get pid(): number
Returns number
Overrides REJFrame.pid
- Defined in frames/outgoing/information.ts:95
set pid(pid: number): void
Parameters
- pid: number
Returns void
Overrides REJFrame.pid
- Defined in frames/outgoing/information.ts:98

pollOrFinal

get pollOrFinal(): boolean
Returns boolean
Overrides DISCFrame.pollOrFinal
- Defined in frames/outgoing/information.ts:67
set pollOrFinal(pollOrFinal: boolean): void
Parameters
- pollOrFinal: boolean
Returns void
Overrides DISCFrame.pollOrFinal
- Defined in frames/outgoing/information.ts:70

receivedSequence

get receivedSequence(): number
Returns number
Overrides DISCFrame.receivedSequence
- Defined in frames/outgoing/information.ts:81
set receivedSequence(receivedSequence: number): void
Parameters
- receivedSequence: number
Returns void
Overrides DISCFrame.receivedSequence
- Defined in frames/outgoing/information.ts:84

repeaters

get repeaters(): Repeater[]
The repeaters/digipeaters that the frame is addressed to travel through.

Returns Repeater[]
an array of Repeater objects

See
Repeater

Throws
InvalidCallsignError and/or InvalidSsidError on frames where this is mutable and an attempt was made to set a repeater with an invalid callsign or SSID.
Inherited from REJFrame.repeaters
- Defined in frames/outgoing/outgoingabstract.ts:257
set repeaters(repeaters: Repeater[]): void
The repeaters/digipeaters that the frame is addressed to travel through.
Parameters
- repeaters: Repeater[]
Returns void
an array of Repeater objects

See
Repeater

Throws
InvalidCallsignError and/or InvalidSsidError on frames where this is mutable and an attempt was made to set a repeater with an invalid callsign or SSID.
Inherited from REJFrame.repeaters
- Defined in frames/outgoing/outgoingabstract.ts:260

sendSequence

get sendSequence(): number
Returns number
Overrides REJFrame.sendSequence
- Defined in frames/outgoing/information.ts:88
set sendSequence(sendSequence: number): void
Parameters
- sendSequence: number
Returns void
Overrides REJFrame.sendSequence
- Defined in frames/outgoing/information.ts:91

sourceCallsign

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

Returns string
Throws
InvalidCallsignError on frames where this is mutable and an attempt was made to set an invalid callsign.
Inherited from REJFrame.sourceCallsign
- Defined in frames/outgoing/outgoingabstract.ts:203
set sourceCallsign(callsign: string): void
The sending station's amateur radio callsign. Valid callsigns are 1 to 6 characters (inclusive), all uppercase.
Parameters
- callsign: string
Returns void
Throws
InvalidCallsignError on frames where this is mutable and an attempt was made to set an invalid callsign.
Inherited from REJFrame.sourceCallsign
- Defined in frames/outgoing/outgoingabstract.ts:206

sourceCommandBit

get sourceCommandBit(): boolean
Determines in conjunction with the destinationCommandBit if the frame is a command, response, or legacy type frame.

Returns boolean
Inherited from REJFrame.sourceCommandBit
- Defined in frames/outgoing/outgoingabstract.ts:223
set sourceCommandBit(value: boolean): void
Determines in conjunction with the destinationCommandBit if the frame is a command, response, or legacy type frame.
Parameters
- value: boolean
Returns void
Inherited from REJFrame.sourceCommandBit
- Defined in frames/outgoing/outgoingabstract.ts:226

sourceSsid

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

Returns number
Throws
InvalidSsidError on frames where this is mutable and an attempt was made to set an invalid SSID.
Inherited from REJFrame.sourceSsid
- Defined in frames/outgoing/outgoingabstract.ts:214
set sourceSsid(ssid: number): void
The sending station's SSID. Valid SSIDs are integers 0 to 15 (inclusive).
Parameters
- ssid: number
Returns void
Throws
InvalidSsidError on frames where this is mutable and an attempt was made to set an invalid SSID.
Inherited from REJFrame.sourceSsid
- Defined in frames/outgoing/outgoingabstract.ts:217

Methods

encode

encode(): Uint8Array
Get the frame encoded for use with a KISS connection. This can be written to a Socket, SerialPort, etc.

Returns Uint8Array
a Uint8Array suitable for passing to Duplex.write().
Inherited from OutgoingAbstract.encode
- Defined in frames/outgoing/outgoingabstract.ts:365

toJSON

toJSON(): {
    commandOrResponse: "command"
    | "response"
    | "legacy";
    destinationCallsign: string;
    destinationCommandBit: boolean;
    destinationReservedBitOne: boolean;
    destinationReservedBitTwo: boolean;
    destinationSsid: number;
    isCommand: boolean;
    isLegacy: boolean;
    isResponse: boolean;
    modulo: 8 | 128;
    payload: any;
    pid: number | undefined;
    pollOrFinal: boolean;
    receivedSequence: number | undefined;
    repeaters: Repeater[];
    sendSequence: number | undefined;
    sourceCallsign: string;
    sourceCommandBit: boolean;
    sourceReservedBitOne: boolean;
    sourceReservedBitTwo: boolean;
    sourceSsid: number;
    subtype: FrameSubtype;
    type: "information" | "supervisory" | "unnumbered";
}
Returns a JSON representation of the frame.

Returns {
    commandOrResponse: "command" | "response" | "legacy";
    destinationCallsign: string;
    destinationCommandBit: boolean;
    destinationReservedBitOne: boolean;
    destinationReservedBitTwo: boolean;
    destinationSsid: number;
    isCommand: boolean;
    isLegacy: boolean;
    isResponse: boolean;
    modulo: 8 | 128;
    payload: any;
    pid: number | undefined;
    pollOrFinal: boolean;
    receivedSequence: number | undefined;
    repeaters: Repeater[];
    sendSequence: number | undefined;
    sourceCallsign: string;
    sourceCommandBit: boolean;
    sourceReservedBitOne: boolean;
    sourceReservedBitTwo: boolean;
    sourceSsid: number;
    subtype: FrameSubtype;
    type: "information" | "supervisory" | "unnumbered";
}
Inherited from OutgoingAbstract.toJSON
- Defined in frames/baseabstract.ts:148

toString

toString(): string
Returns a string representation of the frame.

Returns string
Inherited from OutgoingAbstract.toString
- Defined in frames/baseabstract.ts:177

`Protected` `Static`encodeAddressField

encodeAddressField(
    callsign: string,
    commandOrHasBeenRepeated: boolean,
    reservedBitOne: boolean,
    reservedBitTwo: boolean,
    ssid: number,
    finalAddress: boolean,
): number[]
Parameters
- callsign: string
- commandOrHasBeenRepeated: boolean
- reservedBitOne: boolean
- reservedBitTwo: boolean
- ssid: number
- finalAddress: boolean
Returns number[]
Inherited from OutgoingAbstract.encodeAddressField
- Defined in frames/outgoing/outgoingabstract.ts:121

`Protected` `Static`encodeControlField

encodeControlField(
    modulo: 8 | 128,
    bitsOne: string | number,
    pollFinal: boolean,
    bitsTwo: string | number,
): number | number[]
Parameters
- modulo: 8 | 128
- bitsOne: string | number
- pollFinal: boolean
- bitsTwo: string | number
Returns number | number[]
Inherited from OutgoingAbstract.encodeControlField
- Defined in frames/outgoing/outgoingabstract.ts:146

Class IFrame

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns IFrame

Properties

destinationReservedBitOne

destinationReservedBitTwo

sourceReservedBitOne

sourceReservedBitTwo

Readonlysubtype

See

Returns

Readonlytype

Accessors

commandOrResponse

Returns "command" | "response"

Parameters

Returns void

destinationCallsign

Returns string

Throws

Parameters

Returns void

Throws

destinationCommandBit

Returns boolean

Parameters

Returns void

destinationSsid

Returns number

Throws

Parameters

Returns void

Throws

isCommand

Returns boolean

isLegacy

Returns boolean

isResponse

Returns boolean

modulo

Returns 8 | 128

Parameters

Returns void

payload

Returns any

Throws

Parameters

Returns void

Throws

pid

Returns number

Parameters

Returns void

pollOrFinal

Returns boolean

Parameters

Returns void

receivedSequence

Returns number

Parameters

Returns void

repeaters

Returns Repeater[]

See

Throws

Parameters

Returns void

See

Throws

sendSequence

Returns number

Parameters

`Readonly`subtype

`Readonly`type

`Protected` `Static`encodeAddressField

`Protected` `Static`encodeControlField