GY-63_MS5611/libraries/DEVFULL/README.md

91 lines
2.7 KiB
Markdown
Raw Normal View History

2022-03-11 04:15:31 -05:00
[![Arduino CI](https://github.com/RobTillaart/DEVFULL/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
[![Arduino-lint](https://github.com/RobTillaart/DEVFULL/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/DEVFULL/actions/workflows/arduino-lint.yml)
[![JSON check](https://github.com/RobTillaart/DEVFULL/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/DEVFULL/actions/workflows/jsoncheck.yml)
2023-10-24 09:28:25 -04:00
[![GitHub issues](https://img.shields.io/github/issues/RobTillaart/DEVFULL.svg)](https://github.com/RobTillaart/DEVFULL/issues)
2022-03-11 04:15:31 -05:00
[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/DEVFULL/blob/master/LICENSE)
[![GitHub release](https://img.shields.io/github/release/RobTillaart/DEVFULL.svg?maxAge=3600)](https://github.com/RobTillaart/DEVFULL/releases)
2023-10-24 09:28:25 -04:00
[![PlatformIO Registry](https://badges.registry.platformio.org/packages/robtillaart/library/DEVFULL.svg)](https://registry.platformio.org/libraries/robtillaart/DEVFULL)
2022-03-11 04:15:31 -05:00
# DEVFULL
Arduino library for a /dev/full stream.
## Description
The experimental library implements a stream class that mimics the **/dev/full**
device of a Linux system. You can write nothing to it as it is always full.
2022-07-02 06:50:15 -04:00
Every read data will return the value zero, just like **/dev/zero**.
2022-03-11 04:15:31 -05:00
Calls to **print()** and **println()** will be split up in multiple calls to **write()**.
This causes a return value of n x -28 ==> mostly a number in the 65xxx range
See - https://en.wikipedia.org/wiki//dev/full
2023-10-24 09:28:25 -04:00
#### Related
- https://github.com/RobTillaart/DEVFULL
- https://github.com/RobTillaart/DEVNULL
- https://github.com/RobTillaart/DEVRANDOM
2022-03-11 04:15:31 -05:00
## Interface
2023-10-24 09:28:25 -04:00
```cpp
#include "DEVFULL.h"
```
2022-03-11 04:15:31 -05:00
- **DEVFULL()** constructor, sets the timeout to zero.
2022-07-02 06:50:15 -04:00
- **int available()** always return INT_MAX = platform dependant.
2022-03-11 04:15:31 -05:00
- **int peek()** always returns 0.
- **int read()** always returns 0.
- **void flush()** does nothing but keeps some compilers happy.
- **size_t write(const uint8_t data)** always returns -28 (ENOSPC).
- **size_t write(const uint8_t \*buffer, size_t size)** implements print interface.
Always returns -28 (ENOSPC).
## Error code
| value | name | description |
|:------|:--------|:------------|
| -28 | ENOSPC | No space available for writing onto the "storage device". |
## Operation
Use with care.
See examples.
## Future
2023-10-24 09:28:25 -04:00
#### Must
2022-03-11 04:15:31 -05:00
- improve documentation
2023-10-24 09:28:25 -04:00
#### Should
2022-03-11 04:15:31 -05:00
- improve code
2023-10-24 09:28:25 -04:00
- test different platforms.
#### Could
#### 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,
2022-03-11 04:15:31 -05:00