udpate api documentation

[georgevigelette]

Create Updated API documentation.

[arhowe00]

Going to pass the review to @peterhollender on this one (with minor suggestions). Not going to be nit-picky about the API documentation of the hardware interface. We'll have to discover if anything needs to change with these docs when we have real plug and play with hardware.

One additional comment is whether it makes sense to duplicate documentation. If you can write sufficient docstrings in functions, lots of this formatted material can be made by auto docs generators, and it reduces the risk of forgetting to change things in multiple places. The "usage examples" may be useful being here, but I'd say lots of the text here could be specified elsewhere.

[peterhollender]

Tagging @georgevigelette for when he has time to tidy these up

[ebrahimebrahim]

• Rebase to main to fix the CI issues which are unrelated to this PR
• @georgevigelette Are you done with the cleanups? Can @arhowe00 do a final review?

[georgevigelette]

Yes, I should be ready to merge. Thank You, *George Vigelette* Principal Software Engineer Openwater 733 Front Street, Suite C1 San Francisco, CA 94111 www.openwater.cc ***@***.***

…

On Tue, Sep 2, 2025 at 10:17 AM Ebrahim Ebrahim ***@***.***> wrote: *ebrahimebrahim* left a comment (OpenwaterHealth/openlifu-python#359) <#359 (comment)> - Rebase to main to fix the CI issues which are unrelated to this PR - @georgevigelette <https://github.com/georgevigelette> Are you done with the cleanups? Can @arhowe00 <https://github.com/arhowe00> do a final review? — Reply to this email directly, view it on GitHub <#359 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/A3GROEOOJWX7QU3Q4QEPLPL3QWRHTAVCNFSM6AAAAACBKJK4ICVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTENBVGU2TGNRWHA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[ebrahimebrahim]

Heads up rebasing this to incorporate fix to CI

[arhowe00]

Changes look good. The updates to the existing docs for HVController and TxDevice add useful details. I'll proceed with a squash-merge to make it a single commit.