mirror of
https://github.com/RobTillaart/Arduino.git
synced 2024-09-20 00:55:58 -04:00
97 lines
3.1 KiB
Markdown
97 lines
3.1 KiB
Markdown
|
|
[](https://github.com/marketplace/actions/arduino_ci)
|
|
[](https://github.com/RobTillaart/PrintSize/actions/workflows/arduino-lint.yml)
|
|
[](https://github.com/RobTillaart/PrintSize/actions/workflows/jsoncheck.yml)
|
|
[](https://github.com/RobTillaart/PrintSize/issues)
|
|
|
|
[](https://github.com/RobTillaart/PrintSize/blob/master/LICENSE)
|
|
[](https://github.com/RobTillaart/PrintSize/releases)
|
|
[](https://registry.platformio.org/libraries/robtillaart/PrintSize)
|
|
|
|
|
|
# PrintSize
|
|
|
|
Arduino library to determine the length of print statements.
|
|
|
|
|
|
## Description
|
|
|
|
PrintSize is a minimal library to determine the length of a variable when printed.
|
|
This includes printing of floats, integers in decimal or hex notation.
|
|
|
|
Works for **print()**, **println()** and if supported **printf()** e.g. ESP32.
|
|
|
|
Finally since **0.2.0** it has a total counter to add up the characters "printed" since
|
|
the last **reset()** call. (see example)
|
|
|
|
|
|
#### Related
|
|
|
|
- https://github.com/RobTillaart/PrintCharArray (captures data in a char buffer)
|
|
- https://github.com/RobTillaart/PrintSize (counts length of a number of print commands)
|
|
- https://github.com/RobTillaart/PrintString (captures data in a String)
|
|
|
|
|
|
## Interface
|
|
|
|
```cpp
|
|
#include "PrintSize.h"
|
|
```
|
|
|
|
- **PrintSize()** Constructor
|
|
- **size_t write(uint8_t c)** core.
|
|
Note: gives a warning unused parameter.
|
|
- **size_t write(uint8_t \* str, uint8_t length)**
|
|
Note: gives a warning unused parameter.
|
|
- **void reset()** reset the total counter.
|
|
- **uint32_t total()** total bytes "printed".
|
|
|
|
|
|
## Operational
|
|
|
|
Example shows the right alignment of 10 random numbers.
|
|
|
|
Example shows (elementary) line fitting.
|
|
|
|
|
|
## Applications
|
|
|
|
Can be used to calculate the needed space.
|
|
- to properly do a right alignment e.g. for numbers or variable text.
|
|
- do left alignment and overwrite previous output with just enough spaces.
|
|
- centring of numbers.
|
|
- see if output will fit into a line / display.
|
|
- see if a string fits in EEPROM or any other storage medium.
|
|
- see if a string fits in a communication buffer.
|
|
|
|
|
|
## Future
|
|
|
|
#### Must
|
|
|
|
#### Should
|
|
|
|
- add examples
|
|
- add a function to handle **tab** char correctly e.g.
|
|
could add more than one char. Interferes with the **write(str, length)**.
|
|
- setTabSize(2, 4, 6, 8...);
|
|
- getTabSize();
|
|
- uint8_t \_tabSize = 4;
|
|
|
|
#### Could
|
|
|
|
- PRINTSIZE_LIB_VERSION ?
|
|
|
|
#### Wont
|
|
|
|
|
|
## 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,
|
|
|
|
|