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

Updated HamShield Library Reference (markdown)

Morgan Redfield 2019-03-15 12:33:37 -07:00
parent 4fcecd9b55
commit 6c1d951239
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
HamShield-Library-Reference.md

@ -8,9 +8,9 @@ In our method examples, we will be using the object 'radio'. You do not need to
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(ncs_pin, clk_pin, dat_pin, mic_pin);
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. If you want to use non-standard pins for the HamShield, you can pass the pins you're using here.
#### radio.initalize(); #### radio.initalize();
@ -49,9 +49,9 @@ radio.setChanMode(12.5KHZ);
Returns the current channel mode as a uint16_t. Returns the current channel mode as a uint16_t.
#### radio.setRfPower(0-8); #### radio.setRfPower(0-15);
Sets the output power for TX. A setting of 0 is lowest, a setting of 8 will give highest power output. Sets the output power for TX. A setting of 0 is lowest, a setting of 15 will give highest power output.
![RF Power](http://support.hamshield.com/uploads/default/original/1X/23d46859a6f450334c7cdacfaae448c52cb5e12e.png)[Spectrum RF 446 mhz](http://support.hamshield.com/uploads/default/original/1X/f4c1226f812c8631da6a7f8d46bc5ac3dcee6b55.jpg) ![RF Power](http://support.hamshield.com/uploads/default/original/1X/23d46859a6f450334c7cdacfaae448c52cb5e12e.png)[Spectrum RF 446 mhz](http://support.hamshield.com/uploads/default/original/1X/f4c1226f812c8631da6a7f8d46bc5ac3dcee6b55.jpg)
#### radio.setModeTransmit(); #### radio.setModeTransmit();