mirror of
https://github.com/RobTillaart/Arduino.git
synced 2024-10-03 18:09:02 -04:00
198 lines
5.3 KiB
Markdown
198 lines
5.3 KiB
Markdown
|
|
[](https://github.com/marketplace/actions/arduino_ci)
|
|
[](https://github.com/RobTillaart/weight/actions/workflows/arduino-lint.yml)
|
|
[](https://github.com/RobTillaart/weight/actions/workflows/jsoncheck.yml)
|
|
[](https://github.com/RobTillaart/weight/issues)
|
|
|
|
[](https://github.com/RobTillaart/weight/blob/master/LICENSE)
|
|
[](https://github.com/RobTillaart/weight/releases)
|
|
[](https://registry.platformio.org/libraries/robtillaart/weight)
|
|
|
|
|
|
# Weight
|
|
|
|
Arduino library to convert weight units.
|
|
|
|
|
|
## Description
|
|
|
|
Weight.h is a library containing weight conversion functions.
|
|
|
|
Open for additions, including obscure weight metrics or
|
|
weight related math functions and constants.
|
|
|
|
|
|
#### Overview of conversions:
|
|
|
|
```
|
|
stone - lbs - ounce
|
|
| | |
|
|
kilo kilo - gram
|
|
|
|
|
|
kilo - (stone, lbs, ounce)
|
|
```
|
|
|
|
|
|
#### Related
|
|
|
|
- https://github.com/RobTillaart/AtomicWeight
|
|
- https://github.com/RobTillaart/VolumeConverter
|
|
- https://github.com/RobTillaart/HX711
|
|
- https://github.com/RobTillaart/HX711_MP
|
|
|
|
|
|
## Interface
|
|
|
|
```cpp
|
|
#include "weight.h"
|
|
```
|
|
|
|
Functions are straightforward.
|
|
|
|
- **float lbs2kilo(float lbs)**
|
|
- **float kilo2lbs(float kilos)**
|
|
- **float ounce2gram(float ounce)**
|
|
- **float gram2ounce(float gram)**
|
|
- **float gram2kilo(float gram)**
|
|
- **float kilo2gram( float kilo)**
|
|
- **float lbs2ounce(float lbs)**
|
|
- **float ounce2lbs(float ounce)**
|
|
- **float stone2lbs(float stone)**
|
|
- **float lbs2stone(float lbs)**
|
|
- **float stone2kilo(float stone)**
|
|
- **float kilo2stone(float kilo)**
|
|
- **float US2metric(float stone, float lbs, float ounce)**
|
|
- **float metric2US(float kilo, float &stone, float &lbs, float &ounce)**
|
|
|
|
|
|
## Operation
|
|
|
|
See examples
|
|
|
|
----
|
|
|
|
# weightConverter class
|
|
|
|
Since version 0.2.0 a weight convertor class is added to convert to and from
|
|
other (less known) weight scales.
|
|
The idea is to set a value in one scale and retrieve it in the other.
|
|
As the converter holds the last value set, multiple conversions of the same
|
|
weight are easy.
|
|
|
|
New conversions are possible by providing a setXYZ and getXYZ() function.
|
|
These two should convert to and from grams respectively.
|
|
Additions are welcome, please open an issue.
|
|
|
|
Internal representation is the gram as it the ISO standard.
|
|
|
|
Since version 0.3.0 the converter can also add different units.
|
|
|
|
|
|
## Interface
|
|
|
|
```cpp
|
|
#include "weight.h"
|
|
```
|
|
|
|
#### Constructor
|
|
|
|
- **weightConverter()**
|
|
|
|
#### Setters
|
|
|
|
- **void setKilogram(float value = 0)**
|
|
- **void setGram(float value = 0)**
|
|
- **void setLBS(float value = 0)**
|
|
- **void setStone(float value = 0)**
|
|
- **void setOunce(float value = 0)**
|
|
- **void setLongTonUK(float value = 0)**
|
|
- **void setShortTonUS(float value = 0)**
|
|
- **void setQuarterUK(float value = 0)**
|
|
- **void setQuarterUS(float value = 0)**
|
|
- **void setSlug(float value = 0)**
|
|
- **void setTroyPound(float value = 0)**
|
|
- **void setTroyOunce(float value = 0)**
|
|
- **void setRobie(float value = 0)**
|
|
- **void setDram(float value = 0)**
|
|
- **void setDrachme(float value = 0)**
|
|
- **void setPoint(float value = 0)**
|
|
- **void setGrain(float value = 0)**
|
|
- **void setCarat(float value = 0)**
|
|
|
|
#### Adders
|
|
|
|
- **void addKilogram(float value = 0)**
|
|
- **void addGram(float value = 0)**
|
|
- **void addLBS(float value = 0)**
|
|
- **void addStone(float value = 0)**
|
|
- **void addOunce(float value = 0)**
|
|
- **void addLongTonUK(float value = 0)**
|
|
- **void addShortTonUS(float value = 0)**
|
|
- **void addQuarterUK(float value = 0)**
|
|
- **void addQuarterUS(float value = 0)**
|
|
- **void addSlug(float value = 0)**
|
|
- **void addTroyPound(float value = 0)**
|
|
- **void addTroyOunce(float value = 0)**
|
|
- **void addRobie(float value = 0)**
|
|
- **void addDram(float value = 0)**
|
|
- **void addDrachme(float value = 0)**
|
|
- **void addPoint(float value = 0)**
|
|
- **void addGrain(float value = 0)**
|
|
- **void addCarat(float value = 0)**
|
|
|
|
#### Getters
|
|
|
|
- **float getKilogram()**
|
|
- **float getGram()**
|
|
- **float getLBS()**
|
|
- **float getStone()**
|
|
- **float getOunce()**
|
|
- **float getLongTonUK()**
|
|
- **float getShortTonUS()**
|
|
- **float getQuarterUK()**
|
|
- **float getQuarterUS()**
|
|
- **float getSlug()**
|
|
- **float getTroyPound()**
|
|
- **float getTroyOunce()**
|
|
- **float getRobie()**
|
|
- **float getDram()**
|
|
- **float getDrachme()**
|
|
- **float getPoint()**
|
|
- **float getGrain()**
|
|
- **float getCarat()**
|
|
|
|
|
|
## Future
|
|
|
|
#### Must
|
|
|
|
- improve documentation
|
|
- where are units used
|
|
|
|
#### Should
|
|
|
|
|
|
#### Could
|
|
|
|
- create data types of stone lbs kilo etc.?
|
|
- should float be double?
|
|
|
|
#### Won't (unless)
|
|
|
|
- large masses - sun planets ? (see relativity library)
|
|
- gravity constants of planets REL or ABS eg REL_GRAVITY_EARTH 1.0
|
|
- molarity functions
|
|
- mass of common substances.
|
|
|
|
|
|
## Support
|
|
|
|
If you appreciate my libraries, you can support the development and maintenance.
|
|
Improve the quality of the libraries by providing issues and Pull Requests, or
|
|
donate through PayPal or GitHub sponsors.
|
|
|
|
Thank you,
|
|
|
|
|