Skip to content

Commit

Permalink
Merge pull request #18 from Simsso/link-adjustments
Browse files Browse the repository at this point in the history
Documentation link adjustments
  • Loading branch information
Simsso committed Dec 20, 2019
2 parents cd2ae50 + 0bbb753 commit f93e313
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 18 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).
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).
4 changes: 2 additions & 2 deletions examples/example/example.ino
Original file line number Diff line number Diff line change
@@ -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.
*/

Expand Down
7 changes: 4 additions & 3 deletions keywords.txt
Original file line number Diff line number Diff line change
@@ -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
4 changes: 2 additions & 2 deletions library.properties
Original file line number Diff line number Diff line change
@@ -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
5 changes: 2 additions & 3 deletions src/ShiftRegister74HC595.cpp
Original file line number Diff line number Diff line change
@@ -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 <Arduino.h>

#include "ShiftRegister74HC595.h"
4 changes: 2 additions & 2 deletions src/ShiftRegister74HC595.h
Original file line number Diff line number Diff line change
@@ -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.
*/

Expand Down
7 changes: 4 additions & 3 deletions src/ShiftRegister74HC595.hpp
Original file line number Diff line number Diff line change
@@ -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<uint8_t Size>
ShiftRegister74HC595<Size>::ShiftRegister74HC595(const uint8_t serialDataPin, const uint8_t clockPin, const uint8_t latchPin)
{
Expand Down Expand Up @@ -71,7 +72,7 @@ void ShiftRegister74HC595<Size>::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<uint8_t Size>
void ShiftRegister74HC595<Size>::updateRegisters()
{
Expand Down

0 comments on commit f93e313

Please sign in to comment.