Skip to content

docs(sdo): configure aligned write buffering for block downloads #682

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
timothyanderson096-ocdealcheck wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(sdo): configure aligned write buffering for block downloads #682

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions doc/sdo.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,9 @@ server supports it. This is done through the file object interface::
FIRMWARE_PATH = '/path/to/firmware.bin'
FILESIZE = os.path.getsize(FIRMWARE_PATH)

with open(FIRMWARE_PATH, 'rb') as infile,
node.sdo['Firmware'].open('wb', size=FILESIZE, block_transfer=True) as outfile:
with open(FIRMWARE_PATH, 'rb') as infile, \
node.sdo['Firmware'].open('wb', size=FILESIZE, block_transfer=True,
buffering=7 * 1024) as outfile:

# Iteratively transfer data without having to read all into memory
while True:
Expand All @@ -99,6 +100,10 @@ server supports it. This is done through the file object interface::
break
outfile.write(data)

For block downloads, use a write buffer size divisible by seven, since each
block segment carries seven data bytes. The input chunk size can remain 1024
bytes as shown above; it does not need to match the write buffer size.

.. warning::
Block transfer is still in experimental stage!

Expand Down