diff --git a/README.md b/README.md index 643a3e3..c5e116a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ # ShiftRegister 74HC595 Arduino Library -This library simplifies shift registers usage. It allows, for instance, to set shift register pins just like normal Arduino pins: `sr.set(1, HIGH)`. -The **documentation** is available at http://shiftregister.simsso.de/. +This library simplifies the usage of shift registers. For instance, it allows to set pins of the shift register just like normal Arduino pins: +``` +sr.set(1, HIGH) +``` -An **example** sketch can be found in this repository at [/examples/example/example.ino](https://github.com/Simsso/ShiftRegister74HC595/blob/master/examples/example/example.ino). \ No newline at end of file +Please find the detailed **documentation** at https://timodenk.com/blog/shift-register-arduino-library/. + +An **example** sketch can be found in this repository at [/examples/example/example.ino](https://github.com/Simsso/ShiftRegister74HC595/blob/master/examples/example/example.ino). diff --git a/examples/example/example.ino b/examples/example/example.ino index 9b65006..5a45844 100644 --- a/examples/example/example.ino +++ b/examples/example/example.ino @@ -1,7 +1,7 @@ /* ShiftRegister74HC595 - Library for simplified control of 74HC595 shift registers. - Created by Timo Denk (www.timodenk.com), Nov 2014. - Additional information is available at http://shiftregister.simsso.de/ + Developed and maintained by Timo Denk and contributers, since Nov 2014. + Additional information is available at https://timodenk.com/blog/shift-register-arduino-library/ Released into the public domain. */ diff --git a/keywords.txt b/keywords.txt index 1220da7..4711e16 100755 --- a/keywords.txt +++ b/keywords.txt @@ -1,9 +1,10 @@ ShiftRegister74HC595 KEYWORD1 setAll KEYWORD2 +setAll_P KEYWORD2 +getAll KEYWORD2 set KEYWORD2 +setNoUpdate KEYWORD2 +updateRegisters KEYWORD2 setAllLow KEYWORD2 setAllHigh KEYWORD2 get KEYWORD2 -getAll KEYWORD2 -setNoUpdate KEYWORD2 -updateRegisters KEYWORD2 diff --git a/library.properties b/library.properties index c62536a..0b311d5 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ name=ShiftRegister74HC595 -version=1.3.0 +version=1.3.1 author=Timo Denk (timodenk.com) maintainer=Timo Denk (timodenk.com) sentence=Simplifies usage of shift registers, designed for the 74HC595. paragraph=Allows to set individual pins and takes care of shifting out the bytes. Can be used in combination with multiple shift registers which are stacked in serial. category=Device Control -url=https://shiftregister.simsso.de/ +url=https://timodenk.com/blog/shift-register-arduino-library/ architectures=* includes=ShiftRegister74HC595.h diff --git a/src/ShiftRegister74HC595.cpp b/src/ShiftRegister74HC595.cpp index f19f631..a3a27c1 100755 --- a/src/ShiftRegister74HC595.cpp +++ b/src/ShiftRegister74HC595.cpp @@ -1,10 +1,9 @@ /* ShiftRegister74HC595.cpp - Library for simplified control of 74HC595 shift registers. - Created by Timo Denk (www.timodenk.com), Nov 2014. - Additional information is available at http://shiftregister.simsso.de/ + Developed and maintained by Timo Denk and contributers, since Nov 2014. + Additional information is available at https://timodenk.com/blog/shift-register-arduino-library/ Released into the public domain. */ #include - #include "ShiftRegister74HC595.h" diff --git a/src/ShiftRegister74HC595.h b/src/ShiftRegister74HC595.h index e3e64c2..ac78fdf 100755 --- a/src/ShiftRegister74HC595.h +++ b/src/ShiftRegister74HC595.h @@ -1,7 +1,7 @@ /* ShiftRegister74HC595.h - Library for simplified control of 74HC595 shift registers. - Created by Timo Denk (www.timodenk.com), Nov 2014. - Additional information is available at http://shiftregister.simsso.de/ + Developed and maintained by Timo Denk and contributers, since Nov 2014. + Additional information is available at https://timodenk.com/blog/shift-register-arduino-library/ Released into the public domain. */ diff --git a/src/ShiftRegister74HC595.hpp b/src/ShiftRegister74HC595.hpp index e3ac9ba..cb88886 100644 --- a/src/ShiftRegister74HC595.hpp +++ b/src/ShiftRegister74HC595.hpp @@ -1,11 +1,12 @@ /* ShiftRegister74HC595.hpp - Library for simplified control of 74HC595 shift registers. - Created by Timo Denk (www.timodenk.com), Nov 2014. - Additional information is available at http://shiftregister.simsso.de/ + Developed and maintained by Timo Denk and contributers, since Nov 2014. + Additional information is available at https://timodenk.com/blog/shift-register-arduino-library/ Released into the public domain. */ // ShiftRegister74HC595 constructor +// Size is the number of shiftregisters stacked in serial template ShiftRegister74HC595::ShiftRegister74HC595(const uint8_t serialDataPin, const uint8_t clockPin, const uint8_t latchPin) { @@ -71,7 +72,7 @@ void ShiftRegister74HC595::set(const uint8_t pin, const uint8_t value) } // Updates the shift register pins to the stored output values. -// This is the function that actually writes data into the shift registers of the 74HC595 +// This is the function that actually writes data into the shift registers of the 74HC595. template void ShiftRegister74HC595::updateRegisters() {