Add comments, update to new HamShield library standard.

examples/AFSK-PacketTester/AFSK-PacketTester.ino

@@ -1,7 +1,15 @@
-/* Serial glue to send messages over APRS 
+/* Hamshield
- *  
+ * Example: AFSK Packet Tester
- *  To do: add message receive code
+ * This example sends AFSK test data. You will need a seperate 
- *  
+ * AFSK receiver to test the output of 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, open the Serial Monitor to 
+ * monitor the process of the HamShield. Check for output on 
+ * AFSK receiver.
+
+ *  Note: add message receive code
  */
 
 #define DDS_REFCLK_DEFAULT 9600

examples/AFSK-SerialMessenger/AFSK-SerialMessenger.ino

@@ -1,7 +1,15 @@
-/* Serial glue to send messages over APRS 
+/* Hamshield
- *  
+ * Example: AFSK Serial Messenger
- *  To do: add message receive code
+ * Serial glue to send messages over APRS. You will need a 
- *  
+ * seperate AFSK receiver to test the output of this example.
+ * Connect the HamShield to your Arduino. Screw the antenna 
+ * into the HamShield RF jack. After uploading this program 
+ * to your adruino, open the Serial Monitor to monitor. Type 
+ * a message under 254 characters into the bar at the top of 
+ * the monitor. Click the "Send" button. Check for output on 
+ * AFSK receiver.
+
+ *  NOTE: add message receive code
 */
 
 

examples/AX25Receive/AX25Receive.ino

@@ -37,8 +37,6 @@ void setup() {
   Serial.print(F(" / "));
   Serial.println(radio.getSQLoThresh());
   radio.setModeReceive();
-  Serial.print(F("RX? "));
-  Serial.println(radio.getRX());
   Serial.println(F("DDS Start"));
   delay(100);
   dds.start();

examples/CrystalCalibration/CrystalCalibration.ino

@@ -28,7 +28,7 @@ void setup() {
 
   radio.initialize();
   radio.setRfPower(0);
-  radio.setFrequency(145050);
+  radio.frequency(145050);
   
   dds.start();
   dds.setFrequency(1200);

examples/DDS/DDS.ino

@@ -1,5 +1,14 @@
-// Example sketch to show how to transmit arbitrary tones.
+/* Hamshield
-// In this case, the sketch alternates between 1200Hz and 2200Hz at 1s intervals.
+ * Example: DDS
+ * This is a simple example to show hot to transmit arbitrary 
+ * tones. In this case, the sketh alternates between 1200Hz 
+ * and 2200Hz at 1s intervals.
+ * 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. Upload this program 
+ * to your Arduino. To test, set a HandyTalkie to 438MHz. You 
+ * should hear two alternating tones.
+*/
 
 #define DDS_REFCLK_DEFAULT 9600
 #include <HamShield.h>

examples/FMBeacon/FMBeacon.ino

@@ -1,11 +1,19 @@
-/* 
+/* Hamshield
-Morse Code Beacon
+ * Example: Morse Code Beacon
+ * Test beacon will transmit and wait 30 seconds. 
+ * Beacon will check to see if the channel is clear before it 
+ * will transmit.
+ * 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 to 
+ * monitor the status of the beacon. To test, set a HandyTalkie 
+ * to 438MHz. You should hear the message " KC7IBT ARDUINO 
+ * HAMSHIELD" in morse code.
 
-Test beacon will transmit and wait 30 seconds. 
+ * NOTE: Radio chip audio AGC too slow in responding to tones, 
-Beacon will check to see if the channel is clear before it will transmit.
+ * worked around by playing a 6khz tone between actual dits/dahs.
-
+ * Should work on adjusting AGC to not require this.
-TO-DO: Radio chip audio AGC too slow in responding to tones, worked around by playing a 6khz tone between actual dits/dahs.
-Should work on adjusting AGC to not require this.
 */
 
 #define DDS_REFCLK_DEFAULT 9600

examples/FoxHunt/FoxHunt.ino

@@ -1,4 +1,13 @@
-/* Fox Hunt */
+/* Hamshield
+ * Example: Fox Hunt
+ * Plays a one minute tone at 10-13 minute intervals. Script 
+ * will check to see if the channel is clear before it will 
+ * transmit.
+ * 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. To test, set a HandyTalkie 
+ * to 438MHz. You should hear a one-minute tone every 10-13 minutes.
+*/
 
 #include <HamShield.h>
 

examples/FunctionalTest/FunctionalTest.ino

@@ -1,4 +1,13 @@
-/* HamShield Functional Test */
+/* Hamshield
+ * Example: Fox Hunt
+ * Plays a one minute tone at 10-13 minute intervals. Script 
+ * will check to see if the channel is clear before it will 
+ * transmit.
+ * 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. To test, set a HandyTalkie 
+ * to 438MHz. You should hear a one-minute tone every 10-13 minutes.
+*/
 
 #include <HamShield.h>
 

examples/Gauges/Gauges.ino

@@ -41,7 +41,7 @@ void setup() {
   int result = radio.testConnection();
   Serial.println(result,DEC); 
   radio.initialize();
-  radio.setFrequency(446000);
+  radio.frequency(446000);
   radio.setModeReceive();
   Serial.println("Entering gauges...");
   tone(9,1000);

examples/HandyTalkie/HandyTalkie.ino

@@ -1,4 +1,20 @@
-// Hamshield 
+/* Hamshield
+ * Example: HandyTalkie
+ * This is a simple example to demonstrate HamShield receive
+ * and transmit functionality.
+ * 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. Press the button on 
+ * the HamShield to begin setup. After setup is complete, type 
+ * your desired Tx/Rx frequency, in hertz, into the bar at the 
+ * top of the Serial Monitor and click the "Send" button. 
+ * To test with another HandyTalkie (HT), key up on your HT 
+ * and make sure you can hear it through the headphones 
+ * attached to the HamShield. Key up on the HamShield by 
+ * holding the button.
+*/
 
 #include <HamShield.h>
 

examples/JustTransmit/JustTransmit.ino

@@ -28,7 +28,7 @@ void setup() {
   Serial.println("Setting radio to its defaults..");
   radio.initialize();
   radio.setRfPower(0);
-  radio.setChanMode(3);
+  //radio.setChanMode(3);
 }
 
 void loop() {

examples/KISS/KISS.ino

@@ -1,3 +1,14 @@
+/* Hamshield
+ * Example: KISS
+ * This is a example configures the HamShield to be used as 
+ * a TNC/KISS device. You will need a KISS device to input 
+ * commands to the HamShield
+ * 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. Issue commands 
+ * via the KISS equipment.
+*/
+
 #include <HamShield.h>
 #include <KISS.h>
 

examples/PSK31Transmit/PSK31Transmit.ino

@@ -1,3 +1,15 @@
+/* Hamshield
+ * Example: PSK31Transmit
+ * This is a simple example to demonstrate HamShield PSK31 
+ * transmit functionality.
+ * 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, tune a PSK31 receiver and 
+ * wait to receive the message "Why hello there, friend. 
+ * Nice to meet you. Welcome to PSK31. 73, VE6SLP sk"
+*/
+
 #include <HamShield.h>
 #include "varicode.h"
 

examples/Parrot/Parrot.ino

@@ -37,7 +37,7 @@ void setup() {
   
   // int result = radio.testConnection();
   radio.initialize();
-  radio.setFrequency(446000);
+  radio.frequency(446000);
   setPwmFrequency(9, 1);
 }
 

examples/QPSK63Transmit/QPSK63Transmit.ino

@@ -1,3 +1,15 @@
+/* Hamshield
+ * Example: QPSK63Transmit
+ * This is a simple example to demonstrate HamShield QPSK63 
+ * transmit functionality.
+ * 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, tune a QPSK63 receiver and 
+ * wait to receive the message "Why hello there, friend. 
+ * Nice to meet you. Welcome to QPSK63. 73, VE6SLP sk"
+*/
+
 #include <HamShield.h>
 #include "varicode.h"
 

examples/SSTV/SSTV.ino

@@ -1,7 +1,13 @@
-/* 
+/* Hamshield
-
+ * Example: SSTV
-Sends an SSTV test pattern 
+ * This program will transmit a test pattern. You will need 
-
+ * SSTV receive equipment to test the output.
+ * 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 to 
+ * view the status of the program. Tune your SSTV to 
+ * 446MHz to receive the image output.
 */
 
 #define PWM_PIN 3

examples/SSTV_M1_Static/SSTV_M1_Static.ino

@@ -1,3 +1,15 @@
+/* Hamshield
+ * Example: SSTV M1 Static 
+ * This program will transmit a static image. You will need 
+ * SSTV receive equipment to test the output.
+ * 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 to 
+ * view the status of the program. Tune your SSTV to 
+ * 145.5MHz to receive the image output.
+*/
+
 // So the precalculated values will get stored
 #define DDS_REFCLK_DEFAULT (34965/2)
 

examples/SerialTransceiver/SerialTransceiver.ino

@@ -1,6 +1,13 @@
-/*
+/* Hamshield
-
+ * Example: Serial Tranceiver
-SerialTransceiver is TTL Serial port "glue" to allow desktop or laptop control of the HamShield
+ * SerialTransceiver is TTL Serial port "glue" to allow 
+ * desktop or laptop control of the HamShield.
+ * 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. Use the bar at the 
+ * top of the serial monitor to enter commands as seen below.
 
 Commands: