alex/GY-63_MS5611
1
0
Fork 0
mirror of https://github.com/RobTillaart/Arduino.git synced 2024-09-19 16:46:11 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity
5eb07ec927
GY-63_MS5611/libraries/Currency
History
rob tillaart 5eb07ec927 0.1.3 Currency
2021-12-14 22:08:54 +01:00
..
.github/workflows 0.1.2 Currency 2021-10-20 11:24:55 +02:00
examples 0.1.3 Currency 2021-12-14 22:08:54 +01:00
test 0.1.3 Currency 2021-12-14 22:08:54 +01:00
.arduino-ci.yml 0.1.2 Currency 2021-10-20 11:24:55 +02:00
currency.h 0.1.3 Currency 2021-12-14 22:08:54 +01:00
keywords.txt 0.1.3 Currency 2021-12-14 22:08:54 +01:00
library.json 0.1.3 Currency 2021-12-14 22:08:54 +01:00
library.properties 0.1.3 Currency 2021-12-14 22:08:54 +01:00
LICENSE 0.1.3 Currency 2021-12-14 22:08:54 +01:00
README.md 0.1.3 Currency 2021-12-14 22:08:54 +01:00

README.md

Arduino CI Arduino-lint JSON check License: MIT GitHub release

Currency

Arduino library to help formatting integers for printing as currency

Warning: experimental

Description

The currency library contains a number of functions that help to print integers as currency.

The currency functions assume you do the currency math in integer units. For dollars and euro's this would be cents. For numbers with more decimals it is a smaller unit.

Using integers makes addition, subtraction and multiplication exact.

The library has experimental wrappers for float/double values. Not tested extensively yet.

Choosing int32_t as 'base' also means that there is a limit in terms of minimum and maximum values. When large amounts are needed one can use the currency64() or one of its derived formatters as this is based upon int64_t numbers.

There is a relation with the printHelpers class - https://github.com/RobTillaart/printHelpers When this currency library has matured it might be merged with printHelpers.

Interface

The following functions are implemented:

Core function

  • char * currency(int32_t value, uint8_t decimals, char decimalSeparator, char thousandSeparator, char symbol);
  • char * currency64(int64_t value, uint8_t decimals, char decimalSeparator, char thousandSeparator, char symbol);

int32 Wrapper functions

  • char * bitcoin(int32_t value)
  • char * dollar(int32_t value)
  • char * euro(int32_t value)
  • char * pound(int32_t value)
  • char * roubles(int32_t value)
  • char * yen(int32_t value)
  • char * yuan(int32_t value)

int64 Wrapper functions

  • char * bitcoin64(int64_t value)
  • char * dollar64(int64_t value)
  • char * euro64(int64_t value)
  • char * pound64(int64_t value)
  • char * roubles64(int64_t value)
  • char * yen64(int64_t value)
  • char * yuan64(int64_t value)

float Wrapper functions

Even more experimental - not tested

  • char * bitcoinf(double value)
  • char * dollarf(double value)
  • char * eurof(double value)
  • char * poundf(double value)
  • char * roublesf(double value)
  • char * yenf(double value)
  • char * yuanf(double value)

Operation

See examples

Future