Skip to content

airframesio/acars-decoder-typescript

Repository files navigation

acars-decoder-typescript

NPM Version GitHub Actions Workflow Status Contributors Activity Discord

ACARS is an aircraft communications messaging protocol that has been in use worldwide for a few decades. This library exists to specifically decode the text portion of the ACARS message payload.

The library is built around research and discoveries from the ACARS Message Documentation, a community effort to document the details of the ACARS message label/text payload.

It has been written in TypeScript (which compiles to Javascript) and is published as an NPM package.

You are welcome to contribute (please see https://github.com/airframesio/acars-message-documentation where we collaborate to research and document the various types of messages), and while it was primarily developed to power Airframes and AcarsHub, you may use this library in your own applications freely.

Installation

Add the @airframes/acars-decoder library to your JavaScript or TypeScript project.

With yarn:

yarn add @airframes/acars-decoder

With npm:

npm install @airframes/acars-decoder

Usage

Documentation coming soon.

Contributions

Contributions are welcome! Please follow the ACARS Message Documentation when implementing. Most find that this makes things a lot easier. Submit a Pull Request and we will gratefully review and merge.

Contributors

Contributor Description
Kevin Elliott Primary Airframes contributor
Michael Johnson Decoder plugins, testing framework
Mark Bumiller Decoder plugins, tests, utilities