riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc/driver-guide.md: add a note about float

Browse Source 
floating point variables should generally be avoided.
This commit is contained in:
Benjamin Valentin 2019-11-28 19:08:36 +01:00
parent c68470fc3d
commit a8b540adcf
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/doxygen/src/driver-guide.md
View File

@ -21,6 +21,10 @@ already converted values in some physical unit instead of RAW data, so that
users can work directly with data from different devices directly without having users can work directly with data from different devices directly without having
to care about device specific conversion. to care about device specific conversion.
However, please avoid the use of `float` or `double`. Instead, multiply to the
next SI (or appropriate) unit. E.g. if an ADC would return values like `1.23 V`,
chose to return `1230 mV` instead.
Additionally towards ease of use, all device drivers in RIOT should provide a Additionally towards ease of use, all device drivers in RIOT should provide a
similar 'look and feel'. They should behave similar concerning things like their similar 'look and feel'. They should behave similar concerning things like their
state after initialization, like their used data representation and so on. state after initialization, like their used data representation and so on.