hamnet70/impl/README.md
Thomas Kolb 899152a530 Remove config.h from Git; must be adapted by the user
A template for the config file is provided in src/config.h.template. It must be
copied to src/config.h and adapted for force users to set their own station
call sign.
2024-08-25 20:26:41 +02:00

23 lines
997 B
Markdown

# Hamnet70 Implementation
This directory contains an implementation of the Hamnet70 protocol.
Before you can compile and use this code, some additional steps are necessary:
1. Copy `src/config.h.template` to `src/config.h` and set the following variables:
- `MY_CALL`: the station call sign (i.e. your amateur radio call sign).
This will be encoded into the address fields of outgoing packets.
2. Install dependencies:
- _libliquid_ compiled with _libfec_ support
- _libfec_
- _fftw3_
- _libhackrf_
After everything is prepared, compile the code using `./make.sh`.
Parameters to this script are forwarded to `make` so you can speed things up a little with `./make.sh -j4` (on a CPU with 4 threads).
When compiled, you have two options for running Hamnet70:
1. In digipeater (base station) mode: `build/hamnet70 -c`. This will broadcast beacons and wait for clients to connect.
2. In client mode: `build/hamnet70`. This will wait for a beacon to arrive and connect to it.