Full Setup Guide#
This full setup guide can be used to start your own network, have full control over all sensors and be able to create your own updates to integrate your own functionalities.
Server Setup#
You need two servers: one update and one C&C server. We recommend using two distinct URLs (e.g. 'myLeoCommonCnCServer.com' and 'myLeoCommonUpdateServer.com') and two separate servers or virtual boxes for this.
Update Server Setup#
- Clone the Hawkbit Project to get the code and follow the install instructions there. (Hawkbit is an external software, that we just use for updates. We do not claim being experts for this software.)
C&C Server Setup#
- Clone the LeoCommon Server Project (TODO: upload) and follow the install instructions in the README of the project. (The following steps are just a summary of the projects README.)
- Install the virtual environment and install the python-requirements.
- Install nginx & certbot.
- Install screen. (optional)
- Configure the http.conf:
- server_name (e.g. myLeoCommonUpdateServer.com)
- root
- Start the server by running the
startup.sh
Ground Station Hardware List#
- Iridium Antenna: Taoglas IMA.01.105111
- Mounting hardware for the Iridium Antenna:
- A 3⁄4 inch (metal) pipe to mount the antenna. (Length of the pipe depends on the location, the antenna should have a good 360° fiew of the sky.)
- Some zip-ties or pipe clamps to mount the pipe.
- Antenna extension cable (SMA-female to SMA-male connectors, length of the cable depends on the location, should be as short as possible, best without extension cable)
- HackRF One (including a USB-microUSB cable)
- Temperature controlled oscillator (TCXO) (Optional, e.g. 0.1 ppm or 0.5 ppm)
- Raspberry Pi 4 or 5 (with >= 4 GB RAM)
- Power Supply for Pi 4 (5.1 V, 3 A) or Pi 5 (5.1 V, 5 A)
- microSD card (with >= 16 GB)
- USB-Stick (with >= 8 GB)
- weather resistant box (size 25 X 15 X 11 cm, e.g. DRI-box size Medium)
- GPS antenna for USB
- for connectivity: LAN cable or WiFi or USB-LTE-stick (e.g. HUAWEI 4G Dongle E3372)
Ground Station Software Setup#
Build & Install OS Image#
TODO
Install the Config USB-Stick#
- Clone the Configuration stick repository (TODO:upload) to get the config files.
- Modify the config files:
configs/config.toml
: Insert sensor name, refresh-JWT, access-JWT and server url.config.hawkbit
: Add HAWKBIT_CONTROLLER_ID, HAWKBIT_SECURITY_TOKEN and HAWKBIT_SERVER_URL.eth0.nmconnection
: If necessary add a static IPv4 config. Default is DHCP.wlan0.nmconnection
: If necessary add a wifi-ssid and wifi-password.
- Insert the USB-stick
- Format the USB-stick in 'ext4' with the name 'leocommon-data' (e.g. via gparted)
- Use the
stick_setup.sh
in the repository to automatically create the config stick
or do the configuration manually, by following the next steps - Mount the USB-stick and create the following sub-directories on the USB-stick:
/config/apogee
/config/secrets
/config/system-connections
- Copy the modified config files into their target directory on the usb-stick:
- copy
config.toml
into the directory/config/apogee
- a: copy the
config.hawkbit
into the directory/config/secrets
b: inside the directory/config/secrets
rename theconfig.hawkbit
to.hawkbit
- copy
eth0.nmconnection
into the directory/config/system-connections
- copy
wlan0 .nmconnection
into the directory/config/system-connections
- copy
Ground Station Hardware Setup#
- Place the Iridium antenna.
- Find a place to mount the Iridium antenna: more free sky means a wider reception angle of the antenna.
- Mount the Iridium antenna there, using the mounting equipment. The cable of the antenna should exit the antenna on the downside (no rain should go into the antenna).
- If required attach an SMA extension cable to the antennas SMA cable. If so, wrap the connectors in tape to keep them dry or use a professional IP68 rated outdoor cable connector.
- (optional) Open the case of the HackRF One and connect the TCXO
- Connect the HackRF One to the SMA cable.
- Connect the HackRF One to the Pi (with the USB-microUSB cable).
- Connect the USB-GPS antenna to the Pi.
- Connect the LAN cable or USB-LTE stick to the Pi.
- Connect the USB stick to the Pi.
- Insert the microSD card in the Pi.
- Connect the power supply to the Pi.
- Put the Pi and the HackRF One in the weather resistant box.
- This cables should come out of the box: SMA antenna cable, GPS antenna, power cable, (LAN cable)
- Carefully close the weather resistant box (do not break any antenna cables)
- Place the box safely, so it does not fall down or is blown away by strong winds (maybe use some zip-ties).
- Place the GPS antenna. Usually the GPS-antenna can be placed inside, close to a window, still providing a good GPS reception.
- Plug in the Pis power supply (and the LAN cable). The Pi should now boot and connect automatically to the server.