Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sdr-enthusiasts/docker-acarsdec

Docker Container to run acarsdec
https://github.com/sdr-enthusiasts/docker-acarsdec

acars acarsdec docker rtl-sdr sdr

Last synced: about 1 month ago
JSON representation

Docker Container to run acarsdec

Host: GitHub
URL: https://github.com/sdr-enthusiasts/docker-acarsdec
Owner: sdr-enthusiasts
License: mit
Created: 2021-12-31T17:25:37.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2024-04-14T06:38:46.000Z (9 months ago)
Last Synced: 2024-04-14T15:20:41.925Z (9 months ago)
Topics: acars, acarsdec, docker, rtl-sdr, sdr
Language: Dockerfile
Homepage:
Size: 215 KB
Stars: 8
Watchers: 1
Forks: 2
Open Issues: 10
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

# Docker acarsdec

![Banner](https://github.com/sdr-enthusiasts/docker-acarshub/blob/16ab3757986deb7c93c08f5c7e3752f54a19629c/Logo-Sources/ACARS%20Hub.png "banner")
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/fredclausen/docker-acarshub/Deploy%20to%20Docker%20Hub)](https://github.com/sdr-enthusiasts/docker-acarshub/actions?query=workflow%3A%22Deploy+to+Docker+Hub%22)
[![Docker Pulls](https://img.shields.io/docker/pulls/fredclausen/acarshub.svg)](https://hub.docker.com/r/fredclausen/acarshub)
[![Docker Image Size (tag)](https://img.shields.io/docker/image-size/fredclausen/acarshub/latest)](https://hub.docker.com/r/fredclausen/acarshub)
[![Discord](https://img.shields.io/discord/734090820684349521)](https://discord.gg/sTf9uYF)

Docker container for running [airframe's fork of acarsdec](https://github.com/airframesio/acarsdec) and forwarding the received JSON messages to another system or docker container. Best used alongside [ACARS Hub](https://github.com/fredclausen/acarshub).

Builds and runs on `amd64`, `arm64`.

Please note: **DUE TO LIBSDRPLAY, ARM32 IS NOT SUPPORTED**

## Required hardware

A computer host on a suitable architecture and one USB RTL-SDR dongle connected to an antenna.

## ACARS Hub integration

The default `SERVER` and `SERVER_PORT` values are suitable for automatically working with ACARS Hub, provided ACARS Hub is **on the same pi as the decoder**. If ACARS Hub is not on the same Pi, please provide the correct host name in the `SERVER` variable. Very likely you will not have to change the `SERVER_PORT`, but if you did change the port mapping on ACARS Router (and you will know if you did) please set the server port correctly as well.

## Deprecation Notice

`SERIAL` has been deprecated in favor of `SOAPYSDR`. Please update your configuration accordingly. If `SERIAL` is set the driver will be set to `rtlsdr` and the serial number will be set to the value of `SERIAL`.

## Up and running

```yaml
version: "2.0"

services:
acarsdec:
image: ghcr.io/sdr-enthusiasts/docker-acarsdec:latest
tty: true
container_name: acarsdec
restart: always
ports:
environment:
- TZ="America/Denver"
- SERIAL=13305
- FEED_ID=ACARS
- FREQUENCIES=130.025;130.450;131.125;131.550
- OUTPUT_SERVER_MODE=tcp
tmpfs:
- /run:exec,size=64M
- /var/log
device_cgroup_rules:
- 'c 189:* rwm'
volumes:
- /dev/bus/usb:/dev/bus/usb:ro
```

## Configuration options

| Variable | Description | Required | Default |
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------ |
| `TZ` | Your timezone | No | UTC |
| `SOAPYSDR` | The SoapySDR device string that identifies your dongle. See below for supported soapy sdr types. | No | Blank |
| `FEED_ID` | Used by the decoder to insert a unique ID in to the output message | Yes | Blank |
| `FREQUENCIES` | Semicolon-separated list of frequencies, to a maximum of 16, for the decoder to listen to | Yes | Blank |
| `PPM` | Parts per million correction of the decoder | No | 0 |
| `GAIN` | The gain applied to the RTL-SDR dongle. Recommended to leave at the default autogain. To set manually, gain in in db (0 to 49.6; >52 and -10 will result in AGC; default is AGC) | No | `-10` for autogain |
| `OUTPUT_SERVER` | The server where messages will be forwarded to. | No | `acars_router` |
| `OUTPUT_SERVER_PORT` | The port where the server will receive messages on. | No | `5550` |
| `OUTPUT_SERVER_MODE` | The output mode. `udp`, `tcp` and `zmq` are valid | No | `udp` |
| `MODE` | The output mode. `P` for planeplotter, `J` for JSON and `A` for acarsdec. | No | `J` |
| `QUIET_LOGS` | Mute log output to the bare minimum. Set to `false` to see all of the log messages. | No | `TRUE` |
| `ACARSDEC_COMMAND_EXTRA` | Additional arguments to pass to the decoder. | No | Blank |

## SoapySDR device string

The SoapySDR device string is used to identify your RTL-SDR dongle. The default value is `driver=rtlsdr` which is suitable for most users. If you are using a different SDR, you will need to provide the correct device string. For example, if you are using an Airspy Mini, you would set `SOAPYSDR=driver=airspy`. Pass any additional options for the SDR in via this option as well.

Supported Soapy Drivers:

- `rtlsdr`
- `rtltcp`
- `airspy`
- `sdrplay`

## Output modes

TL;DR: No change to your setup is necessary for continued functionality, but you should update your configuration to use the new variables and at least use TCP.

A recent change in the container has meant we are migrating from `SERVER`/`SERVER_PORT` to `OUTPUT_SERVER`/`OUTPUT_SERVER_PORT` as a better name for what the variable is representing. The old variables will continue to work for the time being, but please update your configuration to use the new variables. Simply replace `SERVER` with `OUTPUT_SERVER` and `SERVER_PORT` with `OUTPUT_SERVER_PORT`. If you do not have `SERVER`/`SERVER_PORT` set, you do not need to do anything and it will work as it did before.

Generally speaking for a proper migration, whatever your `SERVER` was before should be set in your compose as `OUTPUT_SERVER` and whatever your `SERVER_PORT` was before should be set as `OUTPUT_SERVER_PORT`. If `SERVER` was not set, you do not have to add in `OUTPUT_SERVER`. If you did not have `SERVER_PORT` set in your compose, you do not have to add in `OUTPUT_SERVER_PORT` unless you want to use `zmq`.

Additionally, the `OUTPUT_SERVER_MODE` variable has been added to allow for the output mode to be set. The default is `udp` and the container will function as it did before. `tcp` and `zmq` are also valid options and recommended over `udp` for reliability.

To use `tcp` with `acars_router` with the default ports it would have mapped, simply set `OUTPUT_SERVER_MODE=tcp` and leave the `OUTPUT_SERVER_PORT` as `5550` or unset.

If you wish to use `zmq` with `acars_router` with the default ports it would have mapped, simply set `OUTPUT_SERVER_MODE=zmq` and set `OUTPUT_SERVER_PORT` as `35550`.