Input over TCP¶
AIS-catcher
-t
url
-gt
[setting value]
...
AIS-catcher
-t
host
port
-gt
[setting value]
...
AIS-catcher
-t
protocol
host
port
-gt
[setting value]
...
Input over TCP with various protocols can be done with -t followed by the URL of the server. As an example, to read raw NMEA from a TCP server we can use:
AIS-catcher -t txt://192.168.1.120:5011
Various protocols are supported as input. The table below lists the available protocols and their descriptions:
| Protocol | Description | Protocol | Description |
|---|---|---|---|
txt |
NMEA0183 | mqtt |
MQTT |
gpsd |
GPSD server | wsmqtt |
MQTT over WebSocket |
ws |
Plain WebSocket | rtltcp |
RTL-TCP server (raw I/Q) |
basestation |
BaseStation (ADS-B SBS-1) | beast |
Beast binary (ADS-B) |
raw1090 |
Raw 1090 MHz frames (ADS-B) |
Use the appropriate protocol based on your server's configuration and data format.
Summary Settings¶
| Setting (JSON key / CLI setting name) | Type | Default | Description |
|---|---|---|---|
| Generic Options | |||
| sample_rate | integer | 288K | Sampling rate in Hz (0-20,000,000) |
| bandwidth | integer | 0 | Tuner bandwidth in Hz (0-1,000,000) |
| freqoffset | integer | 0 | Frequency correction in PPM (-150 to +150) |
| Specific Options | |||
| host | string | - | Remote host address |
| port | string | - | Remote port number |
| protocol | string | rtltcp | Protocol (RTLTCP/MQTT/GPSD/WS/WSMQTT) |
| url | string | - | Complete URL including protocol and credentials |
| TCP Options | |||
| persist | boolean | true | Keep reconnecting after errors |
| keep_alive | boolean | false | Enable TCP keepalive |
| reset | integer | 0 | Reset connection after N minutes (0=never; range 0-3600) |
| timeout | integer | 0 | Connection timeout in seconds (range 0-3600) |
| WebSocket Options | |||
| protocols | string | mqtt | WebSocket sub-protocols |
| binary | boolean | on | Enable binary WebSocket mode |
| origin | string | - | Origin header for WebSocket |
| MQTT Options | |||
| topic | string | ais/data | MQTT topic |
| client_id | string | - | MQTT client identifier |
| username | string | - | MQTT username |
| password | string | - | MQTT password |
| qos | integer | 0 | MQTT QoS level (0-2) |
| subscribe | boolean | true | Subscribe to topic (vs publish-only) |
| RTLTCP Options | |||
| tuner | float | 33.0 | Tuner gain (0-50, auto) |
| rtlagc | boolean | false | Enable RTL AGC |
| frequency | integer | 0 | Frequency in Hz |