Jump to content
Sign in to follow this  
NurseBob

GITHUB Library edit/update etiquette?

Recommended Posts

While working with Mikal Hart's IridiumSBD library I ran into a problem if I tried sending a message that exceeded 120 characters in length.  Considering I'd paid $250 for the transceiver which claims a 340 character message capability, I was a bit frustrated, to say the least. FWIW, Sparkfun support was responsive, though not clear on the solution. However, after spending time doing the requisite RTFM, coupled with examining the code, I realized that the library didn't check, or account for, two different versions of the AT+SBDWT command.  If the command AT+SBDWT= is issued, followed by a text string, the limit is 120 characters, and anything longer generates an "ERROR" response.  If, instead, an AT+SBDTW command, no "=" sign, is issued, the device responds with "READY" and expects a text string of up to 340 characters (within 60 seconds), and on success issues a "0" response.

Mikal's code doesn't check the length of the submitted string, and triggers an error, but with no other explanation.

I added a test for the string length (it's included in the function call) to select the appropriate command, as well as adding a new error code indicating a message length error.

Given that I consider my programming skils at the beginner+ level (it's been almost 20 years since I was a "professional"), I hesitate to update the library on github.

What's the best approach to save others the hours I spent tracking this down???

 

Bob

Share this post


Link to post
Share on other sites

While working with Mikal Hart's IridiumSBD library I ran into a problem if I tried sending a message that exceeded 120 characters in length.  Considering I'd paid $250 for the transceiver which claims a 340 character message capability, I was a bit frustrated, to say the least. FWIW, Sparkfun support was responsive, though not clear on the solution. However, after spending time doing the requisite RTFM, coupled with examining the code, I realized that the library didn't check, or account for, two different versions of the AT+SBDWT command.  If the command AT+SBDWT= is issued, followed by a text string, the limit is 120 characters, and anything longer generates an "ERROR" response.  If, instead, an AT+SBDTW command, no "=" sign, is issued, the device responds with "READY" and expects a text string of up to 340 characters (within 60 seconds), and on success issues a "0" response.

Mikal's code doesn't check the length of the submitted string, and triggers an error, but with no other explanation.

I added a test for the string length (it's included in the function call) to select the appropriate command, as well as adding a new error code indicating a message length error.

Given that I consider my programming skils at the beginner+ level (it's been almost 20 years since I was a "professional"), I hesitate to update the library on github.

What's the best approach to save others the hours I spent tracking this down???

 

Bob

You could fork the project and then start off on your own branch. Perhaps at some point contacting the github maintainer for a push. But you do not need any permission to just fork, and start off on your own branch. Assuming the software license permits.

 

Additionally, you could also just clone the git, and branch it locally, then get permission to push( merge ) your commits( branch ) back into the main project. Personally, I liek the first option better, but to be honest. I'm not sure if the first option is best for merging branches back into the main branch or not . . . I'm not exactly a git guru

 

EDIT:

 

By the way, these posts should probably be moved to a different section of the forum. As perhaps this library is Energia specific ? But the questions here have nothing to do with Energia.

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
Sign in to follow this  

×