Skip to content
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.

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

adjust writeFast docs #866

Merged
merged 1 commit into from
Sep 1, 2022
Merged

adjust writeFast docs #866

merged 1 commit into from
Sep 1, 2022

Conversation

2bndy5
Copy link
Member

@2bndy5 2bndy5 commented Sep 1, 2022

Also amends an outdated comment in the definition.

New doc output:
image

Related to user experience described in #865

Also amends an outdated comment in the definition.
@github-actions
Copy link
Contributor

github-actions bot commented Sep 1, 2022

Memory usage change @ e8b4fc6

Board flash % RAM for global variables %
ATTinyCore:avr:attinyx5 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
arduino:avr:nano 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
arduino:samd:mkrzero 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
Click for full report table
Board examples/rf24_ATTiny/rf24ping85
flash
% examples/rf24_ATTiny/rf24ping85
RAM for global variables
% examples/rf24_ATTiny/timingSearch3pin
flash
% examples/rf24_ATTiny/timingSearch3pin
RAM for global variables
% examples/GettingStarted
flash
% examples/GettingStarted
RAM for global variables
% examples/AcknowledgementPayloads
flash
% examples/AcknowledgementPayloads
RAM for global variables
% examples/ManualAcknowledgements
flash
% examples/ManualAcknowledgements
RAM for global variables
% examples/StreamingData
flash
% examples/StreamingData
RAM for global variables
% examples/MulticeiverDemo
flash
% examples/MulticeiverDemo
RAM for global variables
% examples/InterruptConfigure
flash
% examples/InterruptConfigure
RAM for global variables
% examples/scanner
flash
% examples/scanner
RAM for global variables
% examples/encodeRadioDetails
flash
% examples/encodeRadioDetails
RAM for global variables
%
ATTinyCore:avr:attinyx5 0 0.0 0 0.0 0 0.0 0 0.0
arduino:avr:nano 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0
arduino:samd:mkrzero 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0
Click for full report CSV
Board,examples/rf24_ATTiny/rf24ping85<br>flash,%,examples/rf24_ATTiny/rf24ping85<br>RAM for global variables,%,examples/rf24_ATTiny/timingSearch3pin<br>flash,%,examples/rf24_ATTiny/timingSearch3pin<br>RAM for global variables,%,examples/GettingStarted<br>flash,%,examples/GettingStarted<br>RAM for global variables,%,examples/AcknowledgementPayloads<br>flash,%,examples/AcknowledgementPayloads<br>RAM for global variables,%,examples/ManualAcknowledgements<br>flash,%,examples/ManualAcknowledgements<br>RAM for global variables,%,examples/StreamingData<br>flash,%,examples/StreamingData<br>RAM for global variables,%,examples/MulticeiverDemo<br>flash,%,examples/MulticeiverDemo<br>RAM for global variables,%,examples/InterruptConfigure<br>flash,%,examples/InterruptConfigure<br>RAM for global variables,%,examples/scanner<br>flash,%,examples/scanner<br>RAM for global variables,%,examples/encodeRadioDetails<br>flash,%,examples/encodeRadioDetails<br>RAM for global variables,%
ATTinyCore:avr:attinyx5,0,0.0,0,0.0,0,0.0,0,0.0
arduino:avr:nano,,,,,,,,,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:samd:mkrzero,,,,,,,,,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0

@2bndy5
Copy link
Member Author

2bndy5 commented Sep 1, 2022

Also, see the rendered output at RTD for this PR: https://rf24--866.org.readthedocs.build/en/866/classRF24.html#_CPPv4N4RF249writeFastEPKv7uint8_t

@TMRh20 TMRh20 merged commit f85cd06 into master Sep 1, 2022
@2bndy5 2bndy5 deleted the ammend-writeFast-docs branch September 1, 2022 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants