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

User guide corrections #22

Closed
CedricHirschi opened this issue Dec 6, 2024 · 2 comments
Closed

User guide corrections #22

CedricHirschi opened this issue Dec 6, 2024 · 2 comments
Assignees

Comments

@CedricHirschi
Copy link
Contributor

CedricHirschi commented Dec 6, 2024

I have come across some points in the user guide where some corrections could be made:

  • The USS configuration displayed in Figure 5.2 includes a wrong value: DC-DC turn on time [us] should be 100 for the actual time in microseconds, not this legacy ticks number. (Same goes for all USS config GUI screenshots actually)
  • Also, I think we should clarify that the channel numbers 1-8 in the schematic correspond to the IDs 0-7 in the GUI as a seperate Note.
    • The TX/RX config for pseudo-B-mode in Table 4.1 for example includes such an error, since the TX channels are specified as 0-8, which would rather be 0-7.
    • The waterbath demo also mentions to please wire the transducer to channel 8, and although this is mentioned later as channel number 8 (id = 7), this should be uniform in the whole user guide.

These are some more suggestions:

  • Could we add more example measurements, even though they may use transducers that are not readily available?
  • Add an errata part with the issues we have found up until now? Also manufacturing challenges?
@CedricHirschi
Copy link
Contributor Author

Changed:

  • Figures include correct DC-DC turn on time [us] of 100

Added:

  • Note in Section 4.1.2 about the channel numbering
  • Reminder to Section 4.1.2 in the waterbath experiment (Section 5.1)
  • Errata in Chapter 7

@Sergio5714
Copy link
Collaborator

We fixed this issue and merged the changes into the dev branch. The changes will be a part of the release 1.2.0.

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

No branches or pull requests

2 participants