mirror of
https://github.com/RobTillaart/Arduino.git
synced 2024-10-03 18:09:02 -04:00
102 lines
3.4 KiB
Markdown
102 lines
3.4 KiB
Markdown
|
|
[](https://github.com/marketplace/actions/arduino_ci)
|
|
[](https://github.com/RobTillaart/ShiftOutSlow/actions/workflows/arduino-lint.yml)
|
|
[](https://github.com/RobTillaart/ShiftOutSlow/actions/workflows/jsoncheck.yml)
|
|
[](https://github.com/RobTillaart/ShiftOutSlow/blob/master/LICENSE)
|
|
[](https://github.com/RobTillaart/ShiftOutSlow/releases)
|
|
|
|
|
|
# ShiftOutSlow
|
|
|
|
Arduino library for shiftOut with build-in delay - e.g. for 74HC595
|
|
|
|
Related libraries
|
|
- https://github.com/RobTillaart/FastShiftIn
|
|
- https://github.com/RobTillaart/FastShiftOut
|
|
- https://github.com/RobTillaart/FastShiftInOut
|
|
- https://github.com/RobTillaart/ShiftInSlow
|
|
- https://github.com/RobTillaart/ShiftOutSlow
|
|
|
|
|
|
## Description
|
|
|
|
|
|
ShiftOutSlow is an experimental library that has a build in delay (in microseconds) that allows tuning the time per bit.
|
|
This allows one to improve reliability e.g. when using longer lines.
|
|
|
|
The data pin and clock pin are set in the constructor, the delay can be set per byte send to be able to optimize runtime.
|
|
|
|
ShiftOutSlow implements the print interface.
|
|
|
|
|
|
## Performance
|
|
|
|
The performance of **write()** with a delay of 0 microseconds is slower than the default Arduino
|
|
**shiftOut()** due to some overhead.
|
|
|
|
The delay requested is divided by two to minimize disruption of the duty cycle of the clock pulse,
|
|
resulting in "better" pulses.
|
|
|
|
|
|
## Interface
|
|
|
|
```cpp
|
|
#include "ShiftOutSlow.h"
|
|
```
|
|
|
|
#### Functions
|
|
|
|
The interface exists of the following functions:
|
|
|
|
- **ShiftOutSlow(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder = LSBFIRST)** constructor.
|
|
- **size_t write(uint8_t data)** writes a new value.
|
|
Returns the bytes written.
|
|
- **size_t write(const uint8_t \*buffer, size_t size)** writes an array of size over shift out.
|
|
Uses **write(uint8_t)** so expect about equal performance.
|
|
Returns the bytes written.
|
|
- **uint8_t lastWritten()** returns last value written.
|
|
- **void setDelay(uint16_t microSeconds = 0)** set delay per **bit** from 0 .. 65535 microseconds.
|
|
Note: the delay is not the time per bit but an additional time per bit.
|
|
Note: the delay can be set runtime per write / print call.
|
|
- **uint16_t getDelay()** returns the set delay in microseconds.
|
|
- **bool setBitOrder(uint8_t bitOrder = LSBFIRST)** set LSBFIRST or MSBFIRST.
|
|
Returns false for other values.
|
|
Note: bit order can be changed runtime per write / print call.
|
|
- **uint8_t getBitOrder()** returns LSBFIRST or MSBFIRST (typical 0 and 1).
|
|
|
|
|
|
### Print interface
|
|
|
|
As this library implements the print interface one can use:
|
|
|
|
- **size_t print(any)** print any data type.
|
|
- **size_t println(any)** print any data type followed by a newline "\n".
|
|
|
|
|
|
## Operation
|
|
|
|
See examples.
|
|
|
|
|
|
## Future
|
|
|
|
#### Must
|
|
|
|
- improve documentation
|
|
|
|
#### Should
|
|
|
|
- add examples
|
|
- adaptive speed example?
|
|
|
|
#### Could
|
|
- Add a select pin to be more SPI alike?
|
|
- increase max delay uint32_t ?
|
|
|
|
#### Wont
|
|
|
|
- set delay in terms of frequency - delay is 'wave length'
|
|
- set delay in terms of max total time the read may cost.
|
|
- get set dutyCycle(0 .. 99%)
|
|
- optimize the place to yield() ?
|