From f9457aab0632516c073bf162fb763a528e8a817b Mon Sep 17 00:00:00 2001 From: alanbjohnston Date: Sat, 15 Feb 2020 05:49:22 -0500 Subject: [PATCH] Update README.md --- README.md | 101 ++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 98 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index dbd30aa7..80605fee 100644 --- a/README.md +++ b/README.md @@ -8,18 +8,113 @@ Requires: - git See the Wiki Software Install page for more details: https://github.com/alanbjohnston/CubeSatSim/wiki/Software-Install. To build and run the software on a Raspberry Pi 3B, 3B+, or Pi Zero W: +Requires: +- Raspbian Stretch or Buster, full desktop or Lite +- wiringpi +- git +- libasound2-dev +- pi-power-button +- Direwolf +- rpitx + +See the Wiki Software Install page for more details: https://github.com/alanbjohnston/CubeSatSim/wiki/Software-Install. To build and run the software on a Raspberry Pi 3B, 3B+, or Pi Zero W (Does NOT work on a Pi 4 since rpitx does not work on it yet): + +`sudo apt-get install -y wiringpi git libasound2-dev i2c-tools` + +Run raspi-config and enable the I2C bus by selecting Option 5 Interfacing Options and then Option 5 I2C and selecting Y to enable the ARM I2C bus: + +`sudo raspi-config` + +Select Finish at the bottom to exit raspi-config. Then type: + +`sudo cp /boot/config.txt /bootconfig.txt.0` + +`sudo nano /boot/config.txt` + +Use the down arrow key to go down in the file until you find this line: + +`# Additional overlays and parameters are documented /boot/overlays/README ` + +Add the following two lines under it: + +`dtoverlay=i2c-gpio` + +`dtparam=i2c_vc=on` + +Press Ctrl-X then type `y` then hit Enter to save the file and exit the editor. You should back at the pi@... prompt. Reboot by typing: + +`sudo reboot` + +after logging back into the Pi, type: + +`ls -a /dev/i2c*` + +you should see three I2C buses: + +`i2c-0 i2c-1 i2c-3` + +Continue the install by typing: + +`cd` + +Then type: `git clone http://github.com/alanbjohnston/CubeSatSim.git` `cd CubeSatSim` -Edit the afsk/main.c file to set your amateur radio callsign, then +`git checkout fox-v4` + +Edited the sim.cfg file to set your amateur radio callsign, then `make rebuild` -To hear AFSK telemetry (X.25 data), your radio or SDR to 434.9 MHz FM, and you should receive telemetry from the CubeSat Sim: +`git clone https://www.github.com/wb2osz/direwolf` + +`cd direwolf` + +`make -j` + +(takes a while) + +`sudo make install` + +`make install-rpi` + +Note that this last command may fail if you are using Raspbian Lite since there is no Desktop. + +`cd ~/CubeSatSim` + +`git clone https://github.com/F5OEO/rpitx.git` + +`cd rpitx` + +`./install.sh` + +(Takes a while). It will prompt you if you want to modify /boot/config.txt file. Type a `y` and the script will complete. + +`cd ~/CubeSatSim` + +`git clone https://github.com/Howchoo/pi-power-button.git` + +`cd pi-power-button` + +`cp ../python/listen-for-shutdown.py listen-for-shutdown.py` + +`./script/install` + +To make the demo.sh script run automatically on boot: + +`sudo cp /CubeSatSim/systemd/cubesatsim.service /etc/systemd/system/cubesatsim.service` + +`sudo systemctl enable cubesatsim` + +Now reboot for all the changes to take effect: + +`sudo reboot now` + +After rebooting, to hear AFSK telemetry (X.25 data), tune your radio or SDR to 434.9 MHz FM, and you should receive telemetry from the CubeSat Sim: -`./radioafsk` This code uses the Brandenburg Tech Digital Transceiver, based on DigitalTxRxRP https://brandenburgtech.wordpress.com/ If you don't have the SPI Interface enabled and the board plugged in, you will get an error.