Add testing of rs232.SerialData #164

jamessynge · 2017-12-03T01:07:20Z

This is a re-do of PR #147 after merging in the big changes from develop.

fake devices.

feature that allows a handler to be used based on the url of the serial "device".

I think that the module is being loaded twice, once by test_rs232.py, and another time by serial.serial_for_url(). As a result, the buffers set by the test aren't visible to the BuffersSerial instance.

…rial. This shows how we can develop mock serial devices for testing.

wtgee · 2017-12-03T01:15:07Z

pocs/utils/rs232.py

+        # Properties have been set to reasonable values, ready to open the port.
+        self.ser.open()
+
+        # TODO(jamessynge): Consider eliminating this sleep period, or making


I still need to dig back through my notes about why the delay is there in the first place but would prefer to capture these TODOs in an Issue unless it will be resolved as part of this PR>

Ah. Sorry, I'm in the habit of capturing these things in the code where their context is readily apparent.

Issue added, TODO removed.

wtgee · 2017-12-03T01:15:58Z

pocs/utils/rs232.py

        """
+        assert not self._start_needed


I don't see where this comes from or get what it is doing.

wtgee · 2017-12-03T01:18:49Z

pocs/utils/rs232.py

+        # (i.e. toss out any buffered input, and then read the next full line...
+        # which likely requires tossing out a fragment of a line).
+        count = self.ser.in_waiting
+        self.ser.reset_input_buffer()
        # self.logger.debug('Cleared {} bytes from buffer'.format(count))


IIRC this was generating too many log entries and so was commented out. Could consider eliminating along with count variable above.

I can do so now if you like.

Yeah, let's get rid of it.

wtgee · 2017-12-03T01:19:44Z

pocs/utils/rs232.py

-
+        # Not worrying here about bytes arriving between reading in_waiting
+        # and calling reset_input_buffer().
+        # Note that Wilfred reports that the Arduino input can seriously lag behind


The lag of 10 seconds would probably apply more to the output buffer. Once it is lagging the only way to catch-up would be to clear output buffer.

output meaning writing from POCS to the Arduino? That sounds like a flush call needs to be made on the device to ensure it is making it out of buffers and into the OS.

Output meaning from the Arduino to POCS. Unless we connect to and start reading from the arduino immediately after it is reset the sensor readings lag behind.

Let's try to be specific when we use the words input and output (I wasn't sufficiently in the comment). So, "input from Arduino" rather than "Arduino input", which was ambiguous; or "POCS output to the mount".

I've updated the comment accordingly.

codecov · 2017-12-03T01:38:24Z

Codecov Report

Merging #164 into develop will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           develop    #164   +/-   ##
=======================================
  Coverage     80.6%   80.6%           
=======================================
  Files           36      36           
  Lines         2527    2527           
  Branches       319     319           
=======================================
  Hits          2037    2037           
  Misses         386     386           
  Partials       104     104

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a436f2a...1fd8969. Read the comment docs.

wtgee · 2017-12-03T06:43:11Z

With a big addition to this I would like to get into the habit of adding a quick user-friendly entry to the Changelog.md file. This should be added to the Unreleased section. Can you add something for the PR? Thanks!

jamessynge · 2017-12-03T13:55:25Z

Added Changelog.md. Will test and push.

jamessynge · 2017-12-03T17:43:27Z

PTAL

wtgee · 2017-12-04T00:23:39Z

Changelog.md

@@ -1,5 +1,12 @@
 ## [Unreleased]

+- PR#164 (no sha yet)


I guess we should first clarify what the purpose of the changelog is. I'm mostly following http://keepachangelog.com/en/0.3.0/

I don't think we care about the PR or the SHA. Things like "...doesn't hide exceptions..." also seem like too much detail for how I think about this.

wtgee

Thanks, LGTM

jamessynge added 10 commits November 27, 2017 18:03

wip - First step towards tests of serial attached devices, but with

1b18003

fake devices.

Beginnings of a test of pocs/utils/rs232.py, utilizing PySerial's

c454c59

feature that allows a handler to be used based on the url of the serial "device".

test_rs232.py works w.r.t. installing serial handler for test://

ba2a8c6

wip - Continuing effort to test uses of PySerial.

38ec2cc

wip - Added protocol_buffers.py, but it isn't quite working.

bb1279d

I think that the module is being loaded twice, once by test_rs232.py, and another time by serial.serial_for_url(). As a result, the buffers set by the test aren't visible to the BuffersSerial instance.

wip - Almost working now, except for the threaded case which is hanging.

6e4795d

Testing of rs232.SerialData, demonstrating how to hook (or mock) PySe…

a6764e3

…rial. This shows how we can develop mock serial devices for testing.

Fix formatting.

c6349af

Add some clarifying comments.

37a6be2

Merge branch 'alt-pyserial-test-handler' into new-pyserial-test-handler

169a202

wtgee reviewed Dec 3, 2017

View reviewed changes

Fix whitespace and comments.

86e7307

Applying requested review changes.

9df9bb7

wtgee reviewed Dec 4, 2017

View reviewed changes

Update Changelog.md

1fd8969

wtgee approved these changes Dec 4, 2017

View reviewed changes

wtgee merged commit b4e5b8d into panoptes:develop Dec 4, 2017

jamessynge deleted the new-pyserial-test-handler branch December 20, 2017 21:23

wtgee mentioned this pull request Dec 29, 2017

Release 0.6.0 #271

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add testing of rs232.SerialData #164

Add testing of rs232.SerialData #164

jamessynge commented Dec 3, 2017

wtgee Dec 3, 2017

jamessynge Dec 3, 2017

jamessynge Dec 3, 2017

wtgee Dec 3, 2017

jamessynge Dec 3, 2017

wtgee Dec 3, 2017

jamessynge Dec 3, 2017

wtgee Dec 3, 2017

jamessynge Dec 3, 2017

wtgee Dec 3, 2017

jamessynge Dec 3, 2017

wtgee Dec 3, 2017

jamessynge Dec 3, 2017

jamessynge Dec 3, 2017

codecov bot commented Dec 3, 2017 •

edited

Loading

wtgee commented Dec 3, 2017

jamessynge commented Dec 3, 2017

jamessynge commented Dec 3, 2017

wtgee Dec 4, 2017

jamessynge Dec 4, 2017

wtgee left a comment

Add testing of rs232.SerialData #164

Add testing of rs232.SerialData #164

Conversation

jamessynge commented Dec 3, 2017

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

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

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

codecov bot commented Dec 3, 2017 • edited Loading

Codecov Report

wtgee commented Dec 3, 2017

jamessynge commented Dec 3, 2017

jamessynge commented Dec 3, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wtgee left a comment

Choose a reason for hiding this comment

codecov bot commented Dec 3, 2017 •

edited

Loading