search

icub-tech-iit / documentation

iCub Tech Docs
https://icub-tech-iit.github.io/documentation/
BSD 3-Clause "New" or "Revised" License
23 stars 34 forks source link

Update the Battery documenation #342

Closed valegagge closed 7 months ago

valegagge commented 7 months ago

After the changes decided here https://github.com/robotology/icub-firmware/issues/476#issuecomment-1980593096 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 commented 7 months ago

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

MSECode commented 7 months ago

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 commented 7 months ago

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 commented 7 months ago

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.