third-party
/
HamShield
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated HamShield Library Reference (markdown)

spaceneedle 2015-07-06 17:03:41 -07:00
parent 2cda91165f
commit 878398ea28
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
HamShield-Library-Reference.md

@ -2,19 +2,19 @@ _Advanced Users: Inside the Arduino library, you will find many methods that are
--- ---
In our method examples, we will be using the object 'radio'. You do not need to worry about what this all means, but just make sure you are using ***HAMShield radio;*** at the top of your sketch. In our method examples, we will be using the object 'radio'. You do not need to worry about what this all means, but just make sure you are using ***HamShield radio;*** at the top of your sketch.
#### HAMShield radio(); #### HamShield radio();
Creates the HAMShield radio object. This must exist in every HAMShield sketch outside of __loop()__ and __setup()__. You may also call __radio__ any other name if you would like. For example, if we wanted our object called __amateur__, we would use __HAMShield amateur()__. Then, to issue commmands to the HAMShield, we would have to use __amateur.frequency(446000)__. Confusing? We thought so too. Just use __radio__. Creates the HamShield radio object. This must exist in every HamShield sketch outside of __loop()__ and __setup()__. You may also call __radio__ any other name if you would like. For example, if we wanted our object called __amateur__, we would use __HamShield amateur()__. Then, to issue commmands to the HamShield, we would have to use __amateur.frequency(446000)__. Confusing? We thought so too. Just use __radio__.
#### HAMShield radio(shield identifier); #### HamShield radio(shield identifier);
If you have two HAMShields, this allows you to select which shield you would like to use. Please see the tricks and tips section on how to use this. If you have two HamShields or an I2C address conflict, this allows you to select the radio SoC after modifying a resistor. Please see the tricks and tips section on how to use this.
#### radio.initalize(); #### radio.initalize();
This performs some basic initialization steps on the HAMShield. It performs required radio IC initialization commands and sets the radio to its default configuration state: This performs some basic initialization steps on the HamShield. It performs required radio IC initialization commands and sets the radio to its default configuration state:
* Frequency: 446.000MHz * Frequency: 446.000MHz
* Volume: 100% * Volume: 100%
@ -51,7 +51,7 @@ Returns the current channel mode as a uint16_t.
#### radio.setModeTransmit(); #### radio.setModeTransmit();
Turns on the transmitter, as long as it is within a United States HAM radio band. See .dangerousMode() to override. Turns on the transmitter, as long as it is within a United States ham radio band. See .dangerousMode() to override.
#### radio.setModeReceive(); #### radio.setModeReceive();