FreeDATA/README.md

# FreeDV-JATE
## FreeDV- Just Another TNC Experiment
My first attempt to learn more about FreeDV and how to create a TNC which gets data from a TCP/IP socket 


## Credits

David Rowe and the FreeDV team for developing the modem and libraries
FreeDV Codec 2 : https://github.com/drowe67/codec2
This software has been heavily inspired by https://github.com/xssfox/freedv-tnc/

## ToDo

- [x] ARQ: Stop-And-Wait
- [x] ARQ: Go-Back-N
- [x] ARQ: Selective repeating of lost arq frames
- [x] ARQ: Dynamic number of frames per burst
- [ ] ARQ: Set frames per burst automatically by channel quality
- [ ] SETTING: Callsign with selective receiveing
- [ ] SETTING: Own grid locator
- [ ] SOCKET: Set settings & commands via command socket
- [ ] SOCKET: Receive data via data socket
- [ ] TRX: Control radio via hamlib
- [ ] MODE: Beacon
- [ ] MODE: Broadcast
- [ ] MODE: ARQ AX25
- [ ] MODE: Gear shifting ARQ
- [ ] TNC: CLI GUI for basic settings


## Setup
Install FreeDV-Socket-TNC directly to home folder and compile codec2 automatically
```
sudo apt install portaudio19-dev build-essential cmake
wget https://raw.githubusercontent.com/DJ2LS/FreeDV-Socket-TNC/dev/install_socket_tnc.sh -O ~/install_socket_tnc.sh
chmod +x ~/install_socket_tnc.sh
./install_socket_tnc.sh
```

## Usage main program
```
./main.py --port 3000 --tx 1 --rx 1
```

## Usage testclient
```
./socketclient.py --port 3000 --data "BC: hello"
```


## Socket Commands

Send a simple broadcast
```
BC:<DATA>    
```
Send an ARQ like frame which will ask the receiver for acknowledgement
```
ACK:<DATA>    
```


## Other stuff

### Audio sinkhole
Send real audio without external devices or sound cards
```
sudo modprobe snd-aloop index=1,2 enable=1,1 pcm_substreams=1,1 id=CHAT1,CHAT2 
```
### TNC 1
```
./main.py --port 3000 --tx 1 --rx 1
```
### TNC 2
```
./main.py --port 3001 --tx 2 --rx 2
```