Skip to content

feat: Function to adjust SBD Session Timeout #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: Function to adjust SBD Session Timeout #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions src/IridiumSBD.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,24 @@ void IridiumSBD::adjustATTimeout(int seconds)
this->atTimeout = seconds;
}

// Tweak SBD Session Timeout
int IridiumSBD::adjustSBDSessionTimeout(int seconds)
{
if ((seconds >= this->atTimeout) || seconds == 0)
diagprint(F("SBD commands that do not complete before AT timeout will return ISBD_PROTOCOL_ERROR\r\n"));

if (!this->asleep)
{
send(F("AT+SBDST="), true, false);
send(seconds);
send(F("\r"), false);
if (!waitForATResponse())
return cancelled() ? ISBD_CANCELLED : ISBD_PROTOCOL_ERROR;
}
this->sbdSessionTimeout = seconds;
return ISBD_SUCCESS;
}

// Tweak Send/Receive SBDIX process timeout
void IridiumSBD::adjustSendReceiveTimeout(int seconds)
{
Expand Down Expand Up @@ -614,6 +632,21 @@ int IridiumSBD::internalBegin()
}
diagprint(F("MSSTM workaround is")); diagprint(msstmWorkaroundRequested ? F("") : F(" NOT")); diagprint(F(" enforced.\r\n"));

// Set SBD session timeout only if it has been changed from the default (to avoid regressions)
// ISU AT Command Reference: "The <timeout> setting is stored only while the SBD Modem is powered up, and defaults to zero (meaning infinite timeout) after a power-cycle."
if (this->sbdSessionTimeout != ISBD_DEFAULT_SBDSESSION_TIMEOUT)
{
ret = adjustSBDSessionTimeout(this->sbdSessionTimeout);
if (ret != ISBD_SUCCESS)
{
diagprint(F("adjustSBDSessionTimeout: failed\r\n"));
}
else
{
diagprint(F("adjustSBDSessionTimeout: success!\r\n"));
}
}

// Done!
diagprint(F("InternalBegin: success!\r\n"));
return ISBD_SUCCESS;
Expand Down
5 changes: 5 additions & 0 deletions src/IridiumSBD.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
#define ISBD_DEFAULT_AT_TIMEOUT 30
#define ISBD_MSSTM_RETRY_INTERVAL 10
#define ISBD_DEFAULT_SBDIX_INTERVAL 10
#define ISBD_DEFAULT_SBDSESSION_TIMEOUT 0
#define ISBD_USB_SBDIX_INTERVAL 30
#define ISBD_DEFAULT_SENDRECEIVE_TIME 300
#define ISBD_STARTUP_MAX_TIME 240
Expand Down Expand Up @@ -113,6 +114,7 @@ class IridiumSBD
typedef enum { DEFAULT_POWER_PROFILE = 0, USB_POWER_PROFILE = 1 } POWERPROFILE;
void setPowerProfile(POWERPROFILE profile); // 0 = direct connect (default), 1 = USB
void adjustATTimeout(int seconds); // default value = 30 seconds
int adjustSBDSessionTimeout(int seconds); // 0 = infinite (default)
void adjustSendReceiveTimeout(int seconds); // default value = 300 seconds
void adjustStartupTimeout(int seconds); // default value = 240 seconds
void useMSSTMWorkaround(bool useMSSTMWorkAround); // true to use workaround from Iridium Alert 5/7/13
Expand Down Expand Up @@ -147,6 +149,7 @@ class IridiumSBD
useSerial = true;
stream = &str;
sbdixInterval = ISBD_USB_SBDIX_INTERVAL;
sbdSessionTimeout = ISBD_DEFAULT_SBDSESSION_TIMEOUT;
atTimeout = ISBD_DEFAULT_AT_TIMEOUT;
sendReceiveTimeout = ISBD_DEFAULT_SENDRECEIVE_TIME;
startupTimeout = ISBD_STARTUP_MAX_TIME;
Expand Down Expand Up @@ -177,6 +180,7 @@ class IridiumSBD
wireport = &wirePort;
deviceaddress = deviceAddress;
sbdixInterval = ISBD_USB_SBDIX_INTERVAL;
sbdSessionTimeout = ISBD_DEFAULT_SBDSESSION_TIMEOUT;
atTimeout = ISBD_DEFAULT_AT_TIMEOUT;
sendReceiveTimeout = ISBD_DEFAULT_SENDRECEIVE_TIME;
startupTimeout = ISBD_STARTUP_MAX_TIME;
Expand Down Expand Up @@ -217,6 +221,7 @@ class IridiumSBD

// Timings
int sbdixInterval;
int sbdSessionTimeout;
int atTimeout;
int sendReceiveTimeout;
int startupTimeout;
Expand Down