Clean up serial comms code. #70
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
haydenroche5
force-pushed
the
cleanup_serial
branch
4 times, most recently
from
a01fb50 to
6ba782d
Compare
Closed
m-mcgowan
reviewed
Aug 30, 2023
notecard/notecard.py
Outdated
| if seg_len > CARD_REQUEST_SEGMENT_MAX_LEN: | ||
| seg_len = CARD_REQUEST_SEGMENT_MAX_LEN | ||
| def decorator(self, *args, **kwargs): | ||
| if use_serial_lock: |
Contributor
There was a problem hiding this comment.
Just a nitpick, I would have used a no-op lock to avoid the conditional. But that's me. No need to change if you prefer not to.
notecard/notecard.py
Outdated
|
|
||
| def _read_byte(self): | ||
| """Read a single byte from the Notecard.""" | ||
| if sys.implementation.name == 'micropython': |
Contributor
There was a problem hiding this comment.
How about initializing a member variable with an appropriate function to avoid the conditional on each read?
| transaction_timeout_secs = 30 | ||
| if txn_manager: | ||
| txn_manager.start(transaction_timeout_secs) | ||
| def serial_lock(fn): |
| self._transmit(req) | ||
|
|
||
| rsp_json = self.uart.readline() | ||
| if self._debug: |
Contributor
There was a problem hiding this comment.
This function acquires the lock for longer than needed. Might be worth separating out the comms part here into a new function _transmitAndReceive, and move the @serial_lock to _transmit and _transmitAndReceive.
haydenroche5
force-pushed
the
cleanup_serial
branch
4 times, most recently
from
5091d4e to
64a1e95
Compare
- Add a serial_lock decorator that can be used on functions that attempt to acquire a lock on the serial port. - Make serialReadByte, serialReset, serialCommand, and serialTransaction member functions of OpenSerial instead of being free functions. - Refactor serialCommand and serialTransaction (now renamed Command and Transaction, respectively) to unify common code in a new internal function, _transmit.
haydenroche5
force-pushed
the
cleanup_serial
branch
from
64a1e95 to
47f250a
Compare
Collaborator
Author
|
Ok, I think I addressed all the feedback. I'm all ears if you have cleaner/better ways of doing what I did, though, @m-mcgowan. |
haydenroche5
force-pushed
the
cleanup_serial
branch
from
47f250a to
8a42fc5
Compare
- Merge the functionality of _preprocess_req into _prepare_request. These are always used together, so it doesn't really make sense to have them as separate functions. Additionally, have _prepare_request do everything needed to transform the request data for transmission. Namely, encode the request string as UTF-8 bytes. Finally, make _prepare_request a method of Notecard. There's no reason for it to be a free function. - Refactor low-level serial comms by adding a new function, _transact. This replaces _transmit and _transmit_and_receive. It acquires the serial lock and uses the transaction manager. It will read a response from the Notecard if the rsp_expected parameter is True.
Collaborator
Author
|
Consolidating into this PR: #73 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
acquire a lock on the serial port.
functions of OpenSerial instead of being free functions.
Transaction, respectively) to unify common code in a new internal function,
_transmit.