non blocking functions added #62

universam1 · 2017-11-17T10:48:48Z

the endPacket() is a blocking function that can take over 6 seconds depending on the radio settings. Here is a non blocking version added, tested successfully on ESP8266. Note the grace time required for the radio to properly update the registers.

sandeepmistry · 2017-11-21T22:06:31Z

@universam1 thanks for submitting!

Have you seen these API's in any other packet based Arduino libraries? Just wondering if there's existing API's we can leverage.

universam1 · 2017-11-22T09:06:38Z

Well, I would say it is actually more of a standard then exceptional to support non blocking calls (http://bfy.tw/FAaI)
There are even mcu's like ESP8266 that are built in an assumption that calls are
non blocking to happen. That's why my other PR #61 I would rather call a dirty workaround then a proper implementation.

So out of my head lets mention
https://github.com/sadr0b0t/stepper_h
arduino/Arduino#1240
http://www.epyon.be/2016/05/22/non-blocking-ethernet-example-teensy arduino/Arduino#1476
https://github.com/jrullan/neotimer
https://github.com/olewolf/DHT_nonblocking
and numerous other ones I came across.

Don't get me wrong, I consider your library is great, but non blocking functions are mandatory for me and turn a great library to professional.
Of course if you like different function names, no problem!

universam1 · 2018-02-14T20:58:52Z

Would like to get this moving and reach an agreement if you @sandeepmistry and @morganrallen are happy with this implementation or rather overload the existing function with an async parameter?

sandeepmistry · 2018-02-22T01:38:55Z

I'd like to take a look at how other existing Stream based Arduino libraries handle async. The links from #62 (comment) are not necessarily Stream based.

Maybe nothing exists yet?

universam1 · 2018-02-23T10:12:28Z

I agree a streaming support might be desirable at the long run! Though this would be a bigger step.
Following DevOps style it is normally preferable to release often but smaller.
If a feature can be implemented without breaking backward compatibility this can be considered good to deploy.
But of course it depends on your philosophy for this project!

sandeepmistry · 2018-02-26T00:34:14Z

Some API ideas:

have either endPacket (or beginPacket) have an optional API for async mode
then beginPacket fails (returns 0), if a packet is currently been sent by the radio.

universam1 · 2018-03-08T20:35:17Z

@sandeepmistry Implemented:

endPackt has the optional parameter bool async
and beginPacket fails if currently sending

Please review if that is fine, thanks

sandeepmistry

@universam1 Good progress!

I think this is good to merge after my two comments are addressed and the code style (mainly brackets) matches the existing code base. The API docs will also have to be updated.

sandeepmistry · 2018-03-12T00:15:33Z

examples/LoRaSenderNonBlocking/LoRaSenderNonBlocking.ino

+  while (!Serial)
+    ;
+
+  Serial.println("LoRa Sender");


Maybe adding "non-blocking" to the title here?

fine with me

sandeepmistry · 2018-03-12T00:16:21Z

src/LoRa.h

@@ -22,7 +22,8 @@ class LoRaClass : public Stream {
  void end();

  int beginPacket(int implicitHeader = false);
-  int endPacket();
+  int endPacket(bool async = false);
+  bool isTransmitting();


I'd prefer if this API was private for now.

@sandeepmistry Does this mean, leave int endPacket() in public and move int endPacket(bool async = false) private? Don't know C++ classes well enough to understand what this will accomplish.

@morganrallen I was thinking isTransmitting() should be private for now.

With the current PRbeginPacket(...), fails if there is a transmission in progress.

@morganrallen any thoughts on the above?

Ah right, thanks makes sense, missed this comment last week.

moved into private

morganrallen · 2018-07-30T18:02:51Z

I've checked this PR out and it appears to work so I'm inclined to merge it as it's an important feature. I'll address the comments and merge this evening if there are no objections.

@sandeepmistry @universam1

universam1 · 2018-07-30T20:27:42Z

fine with me 👍

sandeepmistry · 2018-07-30T23:19:44Z

API.md also needs to be updated accordingly for the new supported values.

universam1 · 2018-08-09T19:26:58Z

@morganrallen @sandeepmistry updated the PR accordingly, LGTM

sandeepmistry · 2018-08-12T23:41:22Z

API.md

@@ -103,6 +103,34 @@ LoRa.endPacket()

 Returns `1` on success, `0` on failure.

+## Sending data - non blocking


I don't think we should have a totally new section for non-blocking, rather modify the existing sending section, since there is really just a new parameter to endPacket and beginPacket has another reason to fail.

@morganrallen any thoughts on this?

universam1 · 2018-08-13T10:52:31Z

@sandeepmistry @morganrallen I've changed the API accordingly and removed the additional part merging now.
Please though LGTM, our review processes take way to long!

universam1 · 2018-08-19T14:17:00Z

all requests fullfilled, if no further objections @sandeepmistry I understand it's fine to merge

non blocking functions added

a73831b

universam1 mentioned this pull request Nov 17, 2017

Non blocking function to transmit #63

Closed

extendedTravis

caa21c2

DzikuVx added a commit to DzikuVx/QuadMeUp_Crossbow that referenced this pull request Dec 16, 2017

LoRa non-blocking endPacket from sandeepmistry/arduino-LoRa#62

a7c2e13

DzikuVx mentioned this pull request Dec 16, 2017

Non-blocking (async) LoRa end Packet DzikuVx/QuadMeUp_Crossbow#41

Merged

universam1 force-pushed the nonblocking branch 2 times, most recently from 8806e51 to 7efaf8c Compare March 8, 2018 20:28

lastchanges

12a9112

universam1 force-pushed the nonblocking branch from 7efaf8c to 12a9112 Compare March 8, 2018 20:30

universam1 force-pushed the nonblocking branch from 8130bc9 to b15ad8c Compare March 8, 2018 20:40

Repository owner deleted a comment from MauroMombelli Mar 8, 2018

sandeepmistry reviewed Mar 12, 2018

View reviewed changes

Repository owner deleted a comment from MauroMombelli Mar 12, 2018

morganrallen mentioned this pull request Jul 25, 2018

TxDone callback is not working #173

Closed

morganrallen self-assigned this Jul 30, 2018

gioblu mentioned this pull request Jul 30, 2018

Local bus going through walls / outdoors gioblu/PJON#222

Closed

universam1 force-pushed the nonblocking branch from b15ad8c to 74d1a50 Compare August 9, 2018 19:24

sandeepmistry reviewed Aug 12, 2018

View reviewed changes

Merge branch 'master' into nonblocking

d386218

universam1 force-pushed the nonblocking branch from 74d1a50 to d386218 Compare August 13, 2018 10:49

Code style and doc + example edits

9fa2e4f

sandeepmistry merged commit 9d2a8c9 into sandeepmistry:master Aug 19, 2018

giampiero7 mentioned this pull request Sep 14, 2018

isTransmitting() public #189

Open

paidforby mentioned this pull request Sep 16, 2018

packets sent from routers only occassionaly pass partial packet check sudomesh/disaster-radio-simulator#2

Closed

paidforby referenced this pull request in sudomesh/disaster-radio-simulator Oct 16, 2018

tx interrupt works, removed buffer delay related to discussion in #6

45099fb

morganrallen mentioned this pull request Feb 4, 2019

Next release(s) #225

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

non blocking functions added #62

non blocking functions added #62

universam1 commented Nov 17, 2017

sandeepmistry commented Nov 21, 2017

universam1 commented Nov 22, 2017

universam1 commented Feb 14, 2018

sandeepmistry commented Feb 22, 2018

universam1 commented Feb 23, 2018

sandeepmistry commented Feb 26, 2018

universam1 commented Mar 8, 2018

sandeepmistry left a comment

sandeepmistry Mar 12, 2018

universam1 Aug 9, 2018

sandeepmistry Mar 12, 2018

morganrallen Jul 30, 2018 •

edited

Loading

sandeepmistry Jul 30, 2018

sandeepmistry Aug 6, 2018

morganrallen Aug 7, 2018

universam1 Aug 9, 2018

morganrallen commented Jul 30, 2018

universam1 commented Jul 30, 2018

sandeepmistry commented Jul 30, 2018

universam1 commented Aug 9, 2018

sandeepmistry Aug 12, 2018

universam1 commented Aug 13, 2018

universam1 commented Aug 19, 2018

		@@ -103,6 +103,34 @@ LoRa.endPacket()

		Returns `1` on success, `0` on failure.

		## Sending data - non blocking

non blocking functions added #62

non blocking functions added #62

Conversation

universam1 commented Nov 17, 2017

sandeepmistry commented Nov 21, 2017

universam1 commented Nov 22, 2017

universam1 commented Feb 14, 2018

sandeepmistry commented Feb 22, 2018

universam1 commented Feb 23, 2018

sandeepmistry commented Feb 26, 2018

universam1 commented Mar 8, 2018

sandeepmistry left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

morganrallen Jul 30, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

morganrallen commented Jul 30, 2018

universam1 commented Jul 30, 2018

sandeepmistry commented Jul 30, 2018

universam1 commented Aug 9, 2018

Choose a reason for hiding this comment

universam1 commented Aug 13, 2018

universam1 commented Aug 19, 2018

morganrallen Jul 30, 2018 •

edited

Loading