A python3 implementation of an ACARS server, storing and displaying ACARS messages.
This is a real deployment of the application, displaying reatime data as received by my station at home (Palaio Falioro, Athens, Greece).
Visit mylk.wtf/acars-server.
The setup is, an acars-server "client" running on my home computer (may not be always online) connected with the required equipment (described below) that decodes the ACARS messages and sends them to a remote acars-server "listener" that parses and stores them in order to be displayed on the web interface.
In aviation, ACARS (Aircraft Communications Addressing and Reporting System) is the transmission system of short messages between aircrafts and ground stations via radio (VHF or HF), directly or via sattelite.
ACARS messages are transmited on specific frequencies based the ground station and aircraft locations.
Messages may be about air traffic control in order to request or provide clearances, OOOI events (are described below), flight plans, status of connecting flights, weather information, equipment health (faults and abnormal events). This gives an importart role to ACARS on air incidents and accidents.
A major function of ACARS is to detect and report major flight phases, called OOOI events (Out of the gate, Off the ground, On the ground, and Into the gate) using input from aircraft sensors mounted on doors, parking brakes and struts. Such ACARS messages describe the flight phase, the time it occurred and other related information such as the amount of fuel on board or the flight origin and destination.
Ping messages can also be sent through ACARS. If an aircraft has been silent for longer than a preset time interval, the ground station can ping the aircraft. A ping response indicates a healthy ACARS communication.
Manual messages can also be sent. ACARS interfaces with interactive display units in the cockpit, which flight crews can use to send and receive technical messages and reports, such as weather information, clearances or the status of connecting flights.
Messages can also be about airline administrative control, for communication between aircrafts with their airline.
ACARS messages are either standardized according to the ARINC Standard 633, or user-defined in accordance with the ARINC Standard 618.
Hear an example of an ACARS message.
This project consists of three application components:
-
client
usesacarsdecto decode ACARS messages and send them to the listener component. -
listener
receives messages from the ACARS client, parses them to usable information and stores it to the databse, requests aircraft images to get downloaded. -
web interface
produces a web interface to display the ACARS messages and other related information. -
image downloader
downloads aircraft images.
If you wish to receive ACARS messages, there is required equipment, as they are transfered via radio. I use the RTL-SDR which is SDR (Software Defined Radio) equipment. SDR is a software radio communication component which traditionally was implemented by multiple hardware components (amplifiers, modulators / demodulators, detectors, etc.).
acarsdec is required to be installed, if you wish to receive ACARS messages, as well as the required equipment described above. Python3 is also required to run this application.
The installation procedure depends whether you will run the application using Docker or not. Anyway, you have to clone this repository:
git clone https://github.com/mylk/acars-server
If you plan to use docker, the installation process is over for you. Otherwise, continue with the following.
Check if your system has the required system dependencies (acarsdec installed).
make deps_sys
Install python package dependencies:
make deps
Install the python packages used for image manipulation (optimizing aircraft images):
make deps_image_downloader
Create the database:
make db_migrate
If you want to run the acars-server using Docker:
docker-compose -f docker-composer.yml -f docker-compose.prod.yml up
This will start all the components, which means that the application expects that you have the required equipment. Otherwise you can use the "fake" client, so you won't need an antenna:
docker-compose -f docker-composer.yml -f docker-compose.dev.yml client up
This also means that you have to start the other components manually:
docker-compose -f docker-composer.yml -f docker-compose.prod.yml listener up
docker-compose -f docker-composer.yml -f docker-compose.prod.yml web up
docker-compose -f docker-composer.yml -f docker-compose.prod.yml image_downloader up
Note that, currently, the web interface has to be hosted along with the listener component, as they share a local embeded database.
Continue with the following if you won't use Docker.
If you own the required equipment, you can run the client yourself:
ENV=production make client
The client assumes a local instance of acars-server listener runs and sends the messages there. In case that the listener component is installed on a remote machine, edit the file acars-server/acarsserver/config/environments/production.py and change listener_host and listener_port settings to the values that fit your needs.
By default, the client scans the European ACARS radio frequencies. In case you want to change them, please advice this document for the appropriate frequencies of your location and then change them in acars-server/acarsserver/config/settings.py.
Run the listener to receive the messages from the client:
ENV=production make listener
Run the web interface:
ENV=production make web
Note that, currently, the web interface has to be hosted along with the listener component, as they share a local embeded database.
acars-server is open source and of course you can contribute. Just fork the project, have fun and then create a pull request.
But first, you need to install the development dependencies:
make deps_dev
You don't need an SDR for development. You can simulate the client component by running the fake client which will send fake ACARS messages to the listener component:
ENV=development make client_fake
- acarsdec - The utility that decodes the ACARS messages and sends them to the
acars-server. - bottle - The python web framework used to create the web component.
SemVer is used for versioning. For the versions available, see the tags.
See the list of contributors.
This project is licensed under the GPLv2 License - see the LICENSE file for details.