SerialTransfer icon indicating copy to clipboard operation
SerialTransfer copied to clipboard

Published 20 hours ago • verified publisher icon PowerBroker2

update documentation

Open PaulBouchier opened this issue 3 years ago • 3 comments

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.

PaulBouchier avatar Feb 15 '22 11:02 PaulBouchier

The second push to this branch fixes the attribute((packed)) issue described in pySerialTransfer issue 51 in this repo.

PaulBouchier avatar Feb 18 '22 00:02 PaulBouchier

Ping. Respectfully, do you have an interest in getting this code documented with doxygen?

PaulBouchier avatar Mar 05 '22 17:03 PaulBouchier

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?

PaulBouchier avatar Mar 05 '22 17:03 PaulBouchier