update documentation #84
Closed
Conversation
This file contains 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
These changes were tested on Arduino Uno with and without the __attribute__, and using SoftwareSerial for the rx_datum and rx_data tests, and Serial for the tx_data/datum tests, to ensure they didn't change behavior. They were tested on ESP32 Feather to check that the test failed without the __attribute__ and passed with it. HardwareSeral(1) was used instead of Serial1. Then the esp32-specific (and for Uno, the SoftwareSerial-specific) changes were backed out, leaving only the __attribute__ change. These changes address issue PowerBroker2#51 in pySerialTransfer, by fixing TestStruct in SerialTransfer. Another pull request will make the corresponding changes to examples in pySerialTransfer.
|
The second push to this branch fixes the attribute((packed)) issue described in pySerialTransfer issue 51 in this repo. |
|
Ping. Respectfully, do you have an interest in getting this code documented with doxygen? |
|
Ping. Respectfully, this pull request fixes the examples so they work on esp32 by adding the attribute((packed)), and updates the Readme with details about callbacks. I did considerable testing on both Arduino Uno and ESP32 with pySerial on linux to ensure I didn't break anything. Is it suitable for merging? Or is there overhead that makes you want to accumulate more changes before you merge and release? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fix issue #83
Adds documentation of SerialTransfer data members which are not valid when a callback function runs, and explains limitations on the non-blocking feature.