2021-01-29 06:31:58 -05:00
|
|
|
|
|
|
|
|
[](https://github.com/marketplace/actions/arduino_ci)
|
2021-12-17 09:14:55 -05:00
|
|
|
[](https://github.com/RobTillaart/FastShiftIn/actions/workflows/arduino-lint.yml)
|
|
|
|
|
[](https://github.com/RobTillaart/FastShiftIn/actions/workflows/jsoncheck.yml)
|
2023-11-01 07:23:10 -04:00
|
|
|
[](https://github.com/RobTillaart/FastShiftIn/issues)
|
|
|
|
|
|
2021-01-29 06:31:58 -05:00
|
|
|
[](https://github.com/RobTillaart/FastShiftIn/blob/master/LICENSE)
|
|
|
|
|
[](https://github.com/RobTillaart/FastShiftIn/releases)
|
2023-11-01 07:23:10 -04:00
|
|
|
[](https://registry.platformio.org/libraries/robtillaart/FastShiftIn)
|
2021-01-29 06:31:58 -05:00
|
|
|
|
2021-12-17 09:14:55 -05:00
|
|
|
|
2020-11-27 05:16:22 -05:00
|
|
|
# FastShiftIn
|
2014-02-09 13:35:40 -05:00
|
|
|
|
2021-12-17 09:14:55 -05:00
|
|
|
Arduino library for **AVR** optimized shiftIn - e.g. for 74HC165.
|
|
|
|
|
|
2022-11-16 10:07:44 -05:00
|
|
|
Related libraries
|
|
|
|
|
- https://github.com/RobTillaart/FastShiftOut
|
|
|
|
|
- https://github.com/RobTillaart/FastShiftInOut
|
|
|
|
|
- https://github.com/RobTillaart/ShiftInSlow
|
|
|
|
|
- https://github.com/RobTillaart/ShiftOutSlow
|
2020-11-27 05:16:22 -05:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Description
|
|
|
|
|
|
|
|
|
|
FastShiftIn is a class that has optimized code (AVR only) to shift in data faster
|
2021-12-17 09:14:55 -05:00
|
|
|
than the normal **shiftIn()** function.
|
2020-11-27 05:16:22 -05:00
|
|
|
It speeds up the shift using low level ports and masks. These are predetermined
|
|
|
|
|
in the constructor of the FastShiftIn object.
|
|
|
|
|
|
|
|
|
|
If not an **ARDUINO_ARCH_AVR** or **ARDUINO_ARCH_MEGAAVR** the class falls back
|
|
|
|
|
to the default shiftIn() implementation.
|
|
|
|
|
|
2023-02-20 11:23:35 -05:00
|
|
|
Since 0.3.2 read16(), read24() and read32() are added.
|
|
|
|
|
These are experimental and not fully tested yet.
|
|
|
|
|
|
2021-12-17 09:14:55 -05:00
|
|
|
|
2020-11-27 05:16:22 -05:00
|
|
|
## Performance
|
|
|
|
|
|
|
|
|
|
The performance of **read()** is substantially faster than the default Arduino
|
|
|
|
|
**shiftIn()**, but not as fast as HW SPI.
|
|
|
|
|
Exact how big the performance gain is can be seen with the example sketch.
|
|
|
|
|
It does a comparison and shows how the class is to be used.
|
|
|
|
|
|
2023-02-20 11:23:35 -05:00
|
|
|
Time in microseconds, Arduino UNO
|
|
|
|
|
|
|
|
|
|
| function | 0.2.3 | 0.3.2 |
|
|
|
|
|
|:---------------------|---------:|---------:|
|
|
|
|
|
| read() | 19.30 | 20.49 |
|
|
|
|
|
| read16() | | 41.04 |
|
|
|
|
|
| read24() | | 62.91 |
|
|
|
|
|
| read32() | | 83.95 |
|
|
|
|
|
| readLSBFIRST() | 19.04 | 19.92 |
|
|
|
|
|
| readMSBFIRST() | 19.04 | 19.92 |
|
|
|
|
|
| reference shiftIn() | 107.82 | 108.20 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
0.3.2 is a bit slower (incl. reference) than 0.2.3 but still much
|
|
|
|
|
faster than the reference.
|
2022-11-05 07:41:07 -04:00
|
|
|
|
|
|
|
|
|
2021-12-17 09:14:55 -05:00
|
|
|
|
2020-11-27 05:16:22 -05:00
|
|
|
## Interface
|
|
|
|
|
|
2023-02-20 11:23:35 -05:00
|
|
|
```cpp
|
|
|
|
|
#include "FastShiftIn.h"
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
#### Functions
|
|
|
|
|
|
|
|
|
|
- **FastShiftIn(uint8_t dataIn, uint8_t clockPin, uint8_t bitOrder = LSBFIRST)** Constructor
|
|
|
|
|
- **uint16_t read(void)** reads a new value, 8 bit.
|
|
|
|
|
- **uint16_t read16(void)** reads a new value, 16 bit.
|
|
|
|
|
- **uint32_t read24(void)** reads a new value, 24 bit.
|
|
|
|
|
- **uint32_t read32(void)** reads a new value, 32 bit.
|
|
|
|
|
- **uint32_t lastRead()** returns last value read.
|
|
|
|
|
- **bool setBitOrder(uint8_t bitOrder)** set LSBFIRST or MSBFIRST.
|
|
|
|
|
Returns false for other values.
|
|
|
|
|
- **uint8_t getBitOrder(void)** returns LSBFIRST or MSBFIRST.
|
|
|
|
|
- **uint16_t readLSBFIRST(void)** optimized LSB read(), 8 bit.
|
|
|
|
|
- **uint16_t readMSBFIRST(void)** optimized MSB read(), 8 bit.
|
|
|
|
|
|
2020-11-27 05:16:22 -05:00
|
|
|
|
2023-02-20 11:23:35 -05:00
|
|
|
#### Byte order
|
|
|
|
|
|
|
|
|
|
It might be that **read16/24/32** has bytes not in the right order.
|
|
|
|
|
Then you should use multiple calls to **read()** and merge these
|
|
|
|
|
bytes in the order you want them.
|
2021-12-17 09:14:55 -05:00
|
|
|
|
2020-11-27 05:16:22 -05:00
|
|
|
|
|
|
|
|
## Notes
|
|
|
|
|
|
|
|
|
|
- The optimizations are AVR only for now, other platforms may follow.
|
|
|
|
|
- The 74HC165 needs 0.1uF caps and the data and clock lines may need
|
|
|
|
|
pull up resistors, especially if wires are exceeding 10 cm (4").
|
|
|
|
|
|
2021-12-17 09:14:55 -05:00
|
|
|
|
2023-02-20 11:23:35 -05:00
|
|
|
## Future
|
2020-11-27 05:16:22 -05:00
|
|
|
|
2023-02-20 11:23:35 -05:00
|
|
|
#### Must
|
2014-02-09 13:35:40 -05:00
|
|
|
|
2023-02-20 11:23:35 -05:00
|
|
|
#### Should
|
2021-12-17 09:14:55 -05:00
|
|
|
|
2023-02-20 11:23:35 -05:00
|
|
|
- extend unit tests
|
|
|
|
|
|
|
|
|
|
#### Could
|
2021-12-17 09:14:55 -05:00
|
|
|
|
|
|
|
|
- esp32 optimization readLSBFIRST readMSBFIRST
|
|
|
|
|
- **read(uint8_t \* arr, uint8_t nr)** ??
|
|
|
|
|
- example schema
|
2023-02-20 11:23:35 -05:00
|
|
|
- would it be interesting to make a fastShiftIn16() etc?
|
|
|
|
|
- squeeze performance but more maintenance.?
|
|
|
|
|
|
|
|
|
|
#### Wont
|
|
|
|
|
|
2021-12-17 09:14:55 -05:00
|
|
|
|
2023-11-01 07:23:10 -04:00
|
|
|
## 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,
|
