Updates to CubeCell example sketch and Readme to be more friendly to first timers

helium / longfi-arduino

Apache License 2.0

63 stars 48 forks source link

Updates to CubeCell example sketch and Readme to be more friendly to first timers #25

Closed leroyle closed 4 years ago

leroyle commented 4 years ago

Added some things to the example sketch and readme to hopefully help new comers avoid the startup issues other have seen when using these the first time.

Updated the example sketch:

to dump a Serial out warning if ADR is turned on they may see a decrease in DR/SF
check uplink count (FCnt), if 65534, force a re-initialization/rejoin to the network to reset the count.

Updated Readme:

added info about the manual changes that might be required to the runtime, depends on the version and when they are pulled into the Arduino/Platformio install images.
- make sure DataRate is DR_3 or less
- make sure preamble size is set to 8
- added suggested settings for remaining LoRaWan board settings to ensure ADR is turned off, uplinkmode to unconfirmed, etc until user is familiar with their uses.

leroyle commented 4 years ago

I apologize for this latest change, I had intended it to be a draft pull request, I need to learn how to do that.... This change adds a Platformio sample.

The change creates an Arduino-IDE subdir and moves the existing Arduino sample there

and creates a new Platformio directory containing the same sample built with Platformio. It's safe to pull in, I'm just missing a README to go along with the Platformio sampe.

leroyle commented 4 years ago

We should wait on this as it does move the sample. It occurred to me that we have other Docs that link to the Arduino IDE sample that will need to be updated else we have broken links. I'll see about adding updates to those here as well.

leroyle commented 4 years ago

In addition to the sample update this change moved the Arduino IDE sample to a subdir so we could add a platformio IDE sample as well. Turns out this was poorly planned as it occurred to me that we need to update the Cubcell documentation within devdocs as it contains a pointer to the Arduino IDE sample. That was not done and will require coordination,

I'm just going to close this pull till I better understand how to add the platformio sample, perhaps post doc rework.

I will create another pull with just the Arduino IDE sample updates as I think they will be helpful.