Skip to content

Commit

Permalink
upd ref
Browse files Browse the repository at this point in the history
  • Loading branch information
FilipDominec committed Jan 30, 2025
1 parent a6aae06 commit 1daef60
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 5 deletions.
2 changes: 1 addition & 1 deletion c_code_parser.py
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ def analyze_c_firmware():
if arg_name not in ('data_count', 'data_bitwidth'):
report_docstring += f" * **{arg_name}** {':' if arg_comment else ''} {arg_comment.strip()} \n"
elif arg_name == 'data_count':
report_docstring += f" * **data** : as a list of integers. \n"
report_docstring += f" * **data** : Bulk payload as a list of integers. \n"

report_names[command_code] = command_name
report_lengths[command_code] = report_length
Expand Down
6 changes: 2 additions & 4 deletions docs/PYTHON_REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,7 @@ Mostly for internal use: confirms the RP2DAQ device is up and has matching firmw
***Report returns:***

* **report_code** : 0
* **data_count**
* **data_bitwidth**
* **data** : as a list of integers.



Expand Down Expand Up @@ -215,8 +214,7 @@ almost immediate or delayed, depending on block size and timing.*
***Report returns:***

* **report_code** : 6
* **data_count**
* **data_bitwidth**
* **data** : as a list of integers.
* **start_time_us** : Microsecond timestamp when ADC started this block acquisition.
* **end_time_us** : Microsecond timestamp when ADC finished this block acquisition.
* **start_sync_value** : Stepper[0] nanoposition when ADC started this block acquisition. (Will be configurable in future.)
Expand Down

0 comments on commit 1daef60

Please sign in to comment.