mirror of
https://github.com/RobTillaart/Arduino.git
synced 2024-10-03 18:09:02 -04:00
62 lines
2.0 KiB
Markdown
62 lines
2.0 KiB
Markdown
|
|
||
|
|
[](https://github.com/marketplace/actions/arduino_ci)
|
||
|
|
[](https://github.com/RobTillaart/DEVFULL/actions/workflows/arduino-lint.yml)
|
||
|
|
[](https://github.com/RobTillaart/DEVFULL/actions/workflows/jsoncheck.yml)
|
||
|
|
[](https://github.com/RobTillaart/DEVFULL/blob/master/LICENSE)
|
||
|
|
[](https://github.com/RobTillaart/DEVFULL/releases)
|
||
|
|
|
||
|
|
|
||
|
|
# 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.
|
||
|
|
Every read data will return the value zero, just like **/dev/zero**
|
||
|
|
|
||
|
|
The 0.1.0 version is a minimal implementation.
|
||
|
|
|
||
|
|
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
|
||
|
|
|
||
|
|
|
||
|
|
## Interface
|
||
|
|
|
||
|
|
- **DEVFULL()** constructor, sets the timeout to zero.
|
||
|
|
- **int available()** always return 32767.
|
||
|
|
- **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
|
||
|
|
|
||
|
|
- improve documentation
|
||
|
|
- improve code
|
||
|
|
- test different platforms.
|
||
|
|
|
||
|
|
|