From 264a0a64c2400cb20e52e95c08f43385d1ac9eac Mon Sep 17 00:00:00 2001 From: alanbjohnston Date: Sun, 5 May 2019 06:59:07 -0400 Subject: [PATCH] Update README.md --- README.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 1ada0fb1..d752c19b 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,15 @@ -# CubeSatSim +The CubeSat Simulator is a low cost satellite emulator that run on solar panels and batteries, transmits UHF radio telemetry, has a 3D printed frame, and can be extended by additional sensors and modules. This project is sponsored by the not-for-profit [Radio Amateur Satellite Corporation, AMSAT®](https://amsat.org). -See the Wiki for more details. To build and run the software on a Raspberry Pi 3B, 3B+, or Pi Zero W: +# CubeSatSim code + +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: `git clone http://github.com/alanbjohnston/CubeSatSim.git` `cd CubeSatSim` +Edit the afsk/main.c file to set your amateur radio callsign, then + `make rebuild` To hear CW telemetry (Morse code), tune your radio or SDR to 435.297 MHz and enter: @@ -16,15 +20,18 @@ To stop, Ctrl-C. To hear AFSK telemetry (X.25 data), your radio or SDR to 440.3 `./radioafsk` -This code uses the Brandenburg Tech Digital Transceiver, based on DigitalTxRxRP - https://brandenburgtech.wordpress.com/- +This code uses the Brandenburg Tech Digital Transceiver, based on DigitalTxRxRP https://brandenburgtech.wordpress.com/- + +This repository contains: - - cw - Code that sends telemetry in CW (Morse code) using AO-7 format - - afsk - Code that sends telemetry in 1k2 AFSK X.25 format + - afsk - Code that sends telemetry in 1k2 AFSK X.25 format + - arduino - Sample Arduino sketches to show how payload sensors can be interfaced to CubeSat Simulator - ax5043 - Source for a library of functions to communicate with the AX5043 and configure the AX5043. + - cw - Code that sends telemetry in CW (Morse code) using AO-7 format - libs - External libraries - python - Python code for reading I2C sensors for current and temperature - - spreadsheet - Spreadsheets and macros for analyzing the Simulator telemetry + - spreadsheet - Spreadsheets for decoding and analyzing the Simulator telemetry (see https://github.com/alanbjohnston/CubeSatSim/wiki/Decoding-Telemetry for details) - wav - Wave audio files of CW or AFSK telemetry for listening or transmitting usng a CubeSat Simulator Lite + - demo.sh - a shell script to run the Simulator on boot using systemd (see https://github.com/alanbjohnston/CubeSatSim/wiki/Software-Install#autoboot-configuration for how to configure the Pi) See the Wiki for more details https://github.com/alanbjohnston/CubeSatSim/wiki