Add configureSleepPin and setSleepPin as weak functions

Author: PaulZC

keywords.txt

@@ -45,6 +45,8 @@ getIMEI	KEYWORD2
 isConnected	KEYWORD2
 passThruI2Cread	KEYWORD2
 passThruI2Cwrite	KEYWORD2
+configureSleepPin	KEYWORD2
+setSleepPin	KEYWORD2
 
 #######################################
 # Constants (LITERAL1)

library.properties

@@ -1,5 +1,5 @@
 name=IridiumSBDi2c
-version=3.0.2
+version=3.0.3
 author=Mikal Hart and Paul Clark (PaulZC)
 maintainer=SparkFun Electronics <sparkfun.com>
 sentence=This library supports satellite data transmissions from anywhere on earth using the RockBLOCK family of Iridium 9602 and 9603 modems.

src/IridiumSBD.cpp

@@ -1101,7 +1101,11 @@ void IridiumSBD::power(bool on)
       }
       else
       {
-          pinMode(this->sleepPin, OUTPUT); // Make the sleep pin an output
+          if (this->sleepPinConfigured == false)
+          {
+             configureSleepPin();
+             this->sleepPinConfigured = true;
+          }
       }
    }
 
@@ -1110,15 +1114,14 @@ void IridiumSBD::power(bool on)
       diagprint(F("Powering on modem...\r\n"));
       if (this->useSerial)
       {
-         digitalWrite(this->sleepPin, HIGH); // HIGH = awake
+         setSleepPin(HIGH); // HIGH = awake
       }
       else
       {
          enable9603(true);
       }
       lastPowerOnTime = millis();
    }
-
    else
    {
       // Best Practices Guide suggests waiting at least 2 seconds
@@ -1130,7 +1133,7 @@ void IridiumSBD::power(bool on)
       diagprint(F("Powering off modem...\r\n"));
       if (this->useSerial)
       {
-         digitalWrite(this->sleepPin, LOW); // LOW = asleep
+         setSleepPin(LOW); // LOW = asleep
       }
       else
       {
@@ -1139,6 +1142,22 @@ void IridiumSBD::power(bool on)
    }
 }
 
+void IridiumSBD::configureSleepPin()
+{
+   pinMode(this->sleepPin, OUTPUT); // Make the sleep pin an output
+   diagprint(F("configureSleepPin: sleepPin configured\r\n"));
+}
+
+void IridiumSBD::setSleepPin(uint8_t enable)
+{
+   digitalWrite(this->sleepPin, enable); // HIGH = awake, LOW = asleep
+   diagprint(F("setSleepPin: sleepPin set "));
+   if (enable == HIGH)
+      diagprint(F("HIGH\r\n"));
+   else
+      diagprint(F("LOW\r\n"));
+}
+
 void IridiumSBD::send(FlashString str, bool beginLine, bool endLine)
 {
    if (beginLine)

src/IridiumSBD.h

@@ -134,6 +134,10 @@ class IridiumSBD
    int passThruI2Cread(uint8_t *rxBuffer, size_t &rxBufferSize, size_t &numBytes);
    int passThruI2Cwrite(uint8_t *txBuffer, size_t &txBufferSize);
 
+   // Weak functions to configure and set the sleep pin - user can overwrite with a custom functions if required
+   void configureSleepPin() __attribute__((weak));
+   void setSleepPin(uint8_t enable) __attribute__((weak));
+
    IridiumSBD(Stream &str, int sleepPinNo = -1, int ringPinNo = -1)
    {
       useSerial = true;
@@ -146,6 +150,7 @@ class IridiumSBD
       asleep = true;
       reentrant = false;
       sleepPin = sleepPinNo;
+      sleepPinConfigured = false;
       ringPin = ringPinNo;
       msstmWorkaroundRequested = true;
       ringAlertsEnabled = {ringPinNo != -1};
@@ -175,6 +180,7 @@ class IridiumSBD
       asleep = true;
       reentrant = false;
       sleepPin = -1;
+      sleepPinConfigured = false;
       ringPin = -1;
       msstmWorkaroundRequested = false;
       ringAlertsEnabled = true;
@@ -218,6 +224,7 @@ class IridiumSBD
    bool asleep;
    bool reentrant;
    int  sleepPin;
+   bool sleepPinConfigured;
    int  ringPin;
    bool msstmWorkaroundRequested;
    bool ringAlertsEnabled;