search

stm32duino / ISM330DHCX

Arduino library to support the ISM330DHCX 3D accelerometer and 3D gyroscope
BSD 3-Clause "New" or "Revised" License
8 stars 8 forks source link

document the units #10

Closed jerabaul29 closed 2 years ago

jerabaul29 commented 2 years ago

Add a section to the readme and some description in the header file to document the units used, and how to convert from raw to scaled values. This will solve #8 .

I understand that the conventions used are "obvious / as expected" for people with in-depth embedded experience, but I think / hope that for people without so much embedded experience, which are often the target of *duino ecosystem, a bit of extra documentation / examples may be useful :) .

jerabaul29 commented 2 years ago

I am not sure of the formatting rules, looks like a trailing space was causing formatting lint error, fixed it now; if you have more tips on what formatting should be modified if there are still lint errors, feel free to point / explain :) .

cparata commented 2 years ago

Thanks a lot for the contribution @jerabaul29 , PR integrated in the main branch. ;-)