Class MessageSchema

The shape of one message: its id, name, seed, and fields.

Index

Constructors

Accessors

crcExtra fields id name wireLen

Methods

Constructors

constructor

new MessageSchema(): MessageSchema

Returns MessageSchema

Accessors

crcExtra

get crcExtra(): number
The CRC_EXTRA seed a frame carrying this message folds into its checksum.

Returns number
- Defined in index.d.ts:923

fields

get fields(): MavlinkFieldInfo[]
The fields in wire order: the base fields largest first, then any extensions.

Returns MavlinkFieldInfo[]
- Defined in index.d.ts:927

id

get id(): number
The id of the message this schema describes.

Returns number
- Defined in index.d.ts:919

name

get name(): string
The name of the message this schema describes.

Returns string
- Defined in index.d.ts:921

wireLen

get wireLen(): number
The length of the message on the wire, in bytes, extensions included.

Returns number
- Defined in index.d.ts:925

Methods

`Static`forId

forId(msgid: number): MessageSchema
Returns the shape of a message the engine types, by id.
Parameters
- msgid: number
  The message id to look up.
Returns MessageSchema
The shape.

Throws
If this build does not type that id, which is what a builder is for.
- Defined in index.d.ts:909

`Static`forName

forName(name: string): MessageSchema
Returns the shape of a message the engine types, by name.
Parameters
- name: string
  The message name, such as GLOBAL_POSITION_INT.
Returns MessageSchema
The shape.

Throws
If this build does not type that name.
- Defined in index.d.ts:917