[![Arduino CI](https://github.com/RobTillaart/weight/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
[![Arduino-lint](https://github.com/RobTillaart/weight/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/weight/actions/workflows/arduino-lint.yml)
[![JSON check](https://github.com/RobTillaart/weight/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/weight/actions/workflows/jsoncheck.yml)
[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/weight/blob/master/LICENSE)
[![GitHub release](https://img.shields.io/github/release/RobTillaart/weight.svg?maxAge=3600)](https://github.com/RobTillaart/weight/releases)


# Weight

Library of weight conversion functions.


## Description

Weight.h is a library containing weight conversion functions.

Open for additions, including obscure weight metrics or 
weight related math functions and constants.


## Interface

Overview of conversions:

```
          stone - lbs - ounce
            |      |      |
           kilo   kilo - gram


           kilo - (stone, lbs, ounce)
```

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


## Future

#### must
- improve documentation

#### should
- a class like the temperature convertor and pressure convertor
  - internally grams?
  - getters setters

#### could
- create data types of stone lbs kilo etc.?

#### won't (unless)
- large masses - sun planets ?   (see relativity library)
- gravity constants of planets REL or ABS eg REL_GRAVITY_EARTH 1.0
- mass of all elements
  - an array of floats
  - a compressed format with access function (1 byte/ element)
  - constants e.g. MASS_OXYGEN
  - separate periodicTable.h file ?
- molarity functions
- mass of common substances.
- teaspoon
  - that is a volume unit.
  - volume conversion too?