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

Update the Battery documenation #342

Closed
valegagge opened this issue Mar 15, 2024 · 4 comments · Fixed by #344
Closed

Update the Battery documenation #342

valegagge opened this issue Mar 15, 2024 · 4 comments · Fixed by #344
Assignees

Comments

@valegagge
Copy link
Member

After the changes decided here robotology/icub-firmware#476 (comment) in order to satisfy this request https://github.com/icub-tech-iit/tickets/issues/3343,

we need to update the documentation accordingly.

Dod

Documentation updated

@MSECode
Copy link
Member

MSECode commented Mar 19, 2024

Documentation in update here: https://github.com/MSECode/documentation/tree/fix/batteryDocs

@MSECode
Copy link
Member

MSECode commented Mar 20, 2024

I've updated the branch aligning what decided on the fw and sw side and fixing the timing that were wrong with respect to the code.
Please, @valegagge, take a look to it and if it looks good to you I'll open the PR together with the others for the sw and fw.

@valegagge
Copy link
Member Author

Hi @MSECode ,
I fix a typo in the this commit.

Your work is ok, but I suggest you add some improvements in order to make the documentation more clear.

  1. change the title.
  2. explain that the data of battery are related to the system (robot).
  3. create a page with the output of yarp port for BMS. (For the user could be useful have the list of the info exposed by bms and bat even if the device is the same.)
  4. add a section for the firmware and out the outcoming data.

I already started updating the documentation in this commit, but it is only a draft. Please update it and fix my work. Thanks! 😸

Obviously, I am available for a chat!

@MSECode
Copy link
Member

MSECode commented Mar 22, 2024

Hi @valegagge, I've updated the documentation adding new page for BMS with all info, data and tables useful to the reader and updating the BAT page documentation.
Check it out.

@pattacini pattacini linked a pull request Mar 25, 2024 that will close this issue
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 a pull request may close this issue.

3 participants