Add comments, some standardizing

This commit is contained in:
nick6x 2016-08-13 19:25:46 -07:00
parent 06cb3f24ed
commit 7a07bd3056
10 changed files with 102 additions and 25 deletions

View File

@ -1,3 +1,17 @@
/* Hamshield
* Example: AX25 Receive
* This example receives AFSK test data. You will need seperate
* AFSK equipment to send data for this example.
* Connect the HamShield to your Arduino. Screw the antenna
* into the HamShield RF jack. Plug a pair of headphones into
* the HamShield. Connect the Arduino to wall power and then to
* your computer via USB. After uploading this program to your
* adruino, open the Serial Monitor so you will see the AFSK
* packet. Send AFSK packet from AFSK equipment at 145.01MHz.
* Note: add message receive code
*/
#include <HamShield.h> #include <HamShield.h>
#define PWM_PIN 3 #define PWM_PIN 3

View File

@ -1,3 +1,15 @@
/* Hamshield
* Example: Crystal Calibration
* This example allows you to calibrate the crystal clock
* through the Arduino Serial Monitor.
* Connect the HamShield to your Arduino. Screw the antenna
* into the HamShield RF jack. Connect the Arduino to wall
* power and then to your computer via USB. After uploading
* this program to your adruino, open the Serial Monitor.
* Type 'h' into the bar at the top of the Serial Monitor
* and click the "Send" button for more instructions.
*/
#define DDS_REFCLK_DEFAULT 38400 #define DDS_REFCLK_DEFAULT 38400
#define DDS_REFCLK_OFFSET 0 #define DDS_REFCLK_OFFSET 0
#define DDS_DEBUG_SERIAL #define DDS_DEBUG_SERIAL

View File

@ -1,10 +1,19 @@
/* /* Hamshield
* Example: Gauges
Gauges * This example prints Signal, Audio In, and Audio Rx ADC
* Peak strength to the Serial Monitor in a graphical manner.
Simple gauges for the radio receiver. * Connect the HamShield to your Arduino. Screw the antenna
* into the HamShield RF jack. Plug a pair of headphones into
* the HamShield. Connect the Arduino to wall power and then
* to your computer via USB. After uploading this program to
* your adruino, open the Serial Monitor. You will see a
* repeating display of different signal strengths. Ex:
*
* [....|....] -73
* Signal
*
* Uncheck the "Autoscroll" box at the bottom of the Serial
* Monitor to manually control the view of the Serial Monitor.
*/ */
#include <HamShield.h> #include <HamShield.h>
@ -35,7 +44,7 @@ void setup() {
digitalWrite(RESET_PIN, HIGH); digitalWrite(RESET_PIN, HIGH);
analogReference(DEFAULT); analogReference(DEFAULT);
Serial.begin(115200); Serial.begin(9600);
Serial.print("Radio status: "); Serial.print("Radio status: ");
int result = radio.testConnection(); int result = radio.testConnection();

View File

@ -1,4 +1,18 @@
/* Simple DTMF controlled HAM Radio Robot */ /* Hamshield
* Example: HAMBot
* Simple DTMF controlled HAM Radio Robot. You will need
* seperate DTMF equipment as well as robot for this
* example.
* Connect the HamShield to your Arduino. Screw the antenna
* into the HamShield RF jack. Connect the Arduino to wall
* power and then to your computer via USB. After uploading
* this program to your adruino, you can send commands from
* your DTMF equipment using the following list:
* '4' => turn robot left
* '6' => turn robot right
* '2' => move robot forward
* '5' => tell robot to send morse code identity
/*
#include <ArduinoRobot.h> // include the robot library #include <ArduinoRobot.h> // include the robot library
#include <HamShield.h> #include <HamShield.h>

View File

@ -15,6 +15,7 @@
* attached to the HamShield. Key up on the HamShield by * attached to the HamShield. Key up on the HamShield by
* holding the button. * holding the button.
*/ */
#include <HamShield.h> #include <HamShield.h>
// create object for radio // create object for radio

View File

@ -1,4 +1,15 @@
/* Just Transmit */ /* Hamshield
* Example: Just Transmit
* This example continuously transmits.
* Connect the HamShield to your Arduino. Screw the antenna
* into the HamShield RF jack. Plug a pair of headphones with
* built-in mic into the HamShield. Connect the Arduino to
* wall power and then to your computer via USB. After
* uploading this program to your adruino, open the Serial
* Monitor to monitor the program's progress. After setup is
* complete, tune a HandyTalkie (HT) to 144.025MHz. Listen on
* the HT for the HamShield broadcasting from the mic.
*/
#include <HamShield.h> #include <HamShield.h>
@ -33,7 +44,7 @@ void setup() {
void loop() { void loop() {
radio.bypassPreDeEmph(); radio.bypassPreDeEmph();
radio.frequency(144000); radio.frequency(144025);
// radio.setTxSourceNone(); // radio.setTxSourceNone();
radio.setModeTransmit(); radio.setModeTransmit();
for(;;) { } for(;;) { }

View File

@ -1,9 +1,15 @@
/* /* Hamshield
* Example: Parrot
Record sound and then plays it back a few times. * Record sound and then plays it back a few times. Very low
Very low sound quality @ 2KHz 0.75 seconds * sound quality @ 2KHz 0.75 seconds. A bit robotic and weird.
A bit robotic and weird * You will need a HandyTalkie (HT) to test the output of this
* example.
* Connect the HamShield to your Arduino. Screw the antenna
* into the HamShield RF jack. Plug a pair of headphones with
* built-in mic into the HamShield. Connect the Arduino to
* wall power and then to your computer via USB. To test the
* output, tune you HT to 446MHz. Recording should be repeated
* ten times.
*/ */
#include <HamShield.h> #include <HamShield.h>

View File

@ -1,7 +1,7 @@
/* Hamshield /* Hamshield
* Example: SSTV * Example: SSTV
* This program will transmit a test pattern. You will need * This program will transmit a test pattern. You will need
* SSTV receive equipment to test the output. * SSTV equipment to test the output.
* Connect the HamShield to your Arduino. Screw the antenna * Connect the HamShield to your Arduino. Screw the antenna
* into the HamShield RF jack. Connect the Arduino to wall * into the HamShield RF jack. Connect the Arduino to wall
* power and then to your computer via USB. After uploading * power and then to your computer via USB. After uploading

View File

@ -1,7 +1,7 @@
/* Hamshield /* Hamshield
* Example: SSTV M1 Static * Example: SSTV M1 Static
* This program will transmit a static image. You will need * This program will transmit a static image. You will need
* SSTV receive equipment to test the output. * SSTV equipment to test the output.
* Connect the HamShield to your Arduino. Screw the antenna * Connect the HamShield to your Arduino. Screw the antenna
* into the HamShield RF jack. Connect the Arduino to wall * into the HamShield RF jack. Connect the Arduino to wall
* power and then to your computer via USB. After uploading * power and then to your computer via USB. After uploading

View File

@ -1,8 +1,18 @@
/* /* Hamshield
* Example: Signal Test
Plays back the current signal strength level and morses out it's call sign at the end. * Plays back the current signal strength level and morses out
* it's call sign at the end. You will need a HandyTalkie (HT)
* to test the output of this example.
* Connect the HamShield to your Arduino. Screw the antenna
* into the HamShield RF jack. Plug a pair of headphones into
* the HamShield. Connect the Arduino to wall power and then
* to your computer via USB. After uploading this program to
* your adruino, open the Serial Monitor. HamShield will print
* the results of its signal test to the Serial Monitor. To
* test with another HandyTalkie (HT), tune in to 446MHz and
* listen for the call sign. Then key up on your HT and make
* sure you can hear it through the headphones attached to the
* HamShield.
*/ */
#define DOT 100 #define DOT 100