1
0
mirror of https://github.com/sandeepmistry/arduino-LoRa.git synced 2025-07-31 10:24:22 +03:00

Update API documentation

This commit is contained in:
Sandeep Mistry
2016-10-22 15:55:58 -04:00
parent d879e50d33
commit 0db821227e
4 changed files with 198 additions and 32 deletions

View File

@ -297,9 +297,15 @@ void LoRaClass::sleep()
writeRegister(REG_OP_MODE, MODE_LONG_RANGE_MODE | MODE_SLEEP);
}
byte LoRaClass::random()
void LoRaClass::setTxPower(int level)
{
return readRegister(REG_RSSI_WIDEBAND);
if (level < 2) {
level = 2;
} else if (level > 17) {
level = 17;
}
writeRegister(REG_PA_CONFIG, PA_BOOST | (level - 2));
}
void LoRaClass::setFrequency(long frequency)
@ -313,17 +319,6 @@ void LoRaClass::setFrequency(long frequency)
writeRegister(REG_FRF_LSB, (uint8_t)(frf >> 0));
}
void LoRaClass::setTxPower(int level)
{
if (level < 2) {
level = 2;
} else if (level > 17) {
level = 17;
}
writeRegister(REG_PA_CONFIG, PA_BOOST | (level - 2));
}
void LoRaClass::setSpreadingFactor(int sf)
{
if (sf < 6) {
@ -385,7 +380,7 @@ void LoRaClass::setCodingRate4(int denominator)
writeRegister(REG_MODEM_CONFIG_1, (readRegister(REG_MODEM_CONFIG_1) & 0xf1) | (cr << 1));
}
void LoRaClass::setPreambleLength(unsigned long length)
void LoRaClass::setPreambleLength(long length)
{
writeRegister(REG_PREAMBLE_MSB, (uint8_t)(length >> 8));
writeRegister(REG_PREAMBLE_LSB, (uint8_t)(length >> 0));
@ -406,6 +401,11 @@ void LoRaClass::noCrc()
writeRegister(REG_MODEM_CONFIG_2, readRegister(REG_MODEM_CONFIG_2) & 0xfb);
}
byte LoRaClass::random()
{
return readRegister(REG_RSSI_WIDEBAND);
}
void LoRaClass::setPins(int ss, int reset, int dio0)
{
_ss = ss;

View File

@ -38,18 +38,18 @@ public:
void idle();
void sleep();
byte random();
void setFrequency(long frequency);
void setTxPower(int level);
void setFrequency(long frequency);
void setSpreadingFactor(int sf);
void setSignalBandwidth(long sbw);
void setCodingRate4(int denominator);
void setPreambleLength(unsigned long length);
void setPreambleLength(long length);
void setSyncWord(int sw);
void crc();
void noCrc();
byte random();
void setPins(int ss = LORA_DEFAULT_SS_PIN, int reset = LORA_DEFAULT_RESET_PIN, int dio0 = LORA_DEFAULT_DIO0_PIN);
void dumpRegisters(Stream& out);