initial commit

Author: InfectedBytes

ShiftIn/examples/SingleShiftRegister/Layout1.png

@@ -0,0 +1,23 @@
+#include <ShiftIn.h>
+
+// Init ShiftIn instance with a single chip
+ShiftIn<1> shift;
+
+void setup() {
+	Serial.begin(9600);
+	// declare pins: pLoadPin, clockEnablePin, dataPin, clockPin
+	shift.begin(8, 9, 11, 12);
+}
+
+void displayValues() {
+	// print out all 8 buttons
+	for(int i = 0; i < shift.getDataWidth(); i++)
+		Serial.print( shift.state(i) ); // get state of button i
+	Serial.println();
+}
+
+void loop() {
+	if(shift.update()) // read in all values. returns true if any button has changed
+		displayValues();
+	delay(1);
+}

ShiftIn/examples/SingleShiftRegister/SingleShiftRegister.ino

@@ -0,0 +1,23 @@
+#include <ShiftIn.h>
+
+// Init ShiftIn instance with a two chips
+ShiftIn<2> shift;
+
+void setup() {
+	Serial.begin(9600);
+	// declare pins: pLoadPin, clockEnablePin, dataPin, clockPin
+	shift.begin(8, 9, 11, 12);
+}
+
+void displayValues() {
+	// print out all 16 buttons
+	for(int i = 0; i < shift.getDataWidth(); i++)
+		Serial.print( shift.state(i) ); // get state of button i
+	Serial.println();
+}
+
+void loop() {
+	if(shift.update()) // read in all values. returns true if any button has changed
+		displayValues();
+	delay(1);
+}

ShiftIn/examples/TwoShiftRegisters/Layout2.png

@@ -0,0 +1,10 @@
+name=ShiftIn
+version=1.0.0
+author=Henrik Heine
+maintainer=Henrik Heine <dev@infectedbytes.com>
+sentence=Arduino library that reads in values from an 8 bit shift register (74HC165).
+paragraph=You can daisy-chain several shift register in order to read in up to 64 buttons by only using 4 Arduino pins.
+category=Signal Input/Output
+url=https://github.com/InfectedBytes/ArduinoShiftIn
+architectures=avr
+includes=ShiftIn.h

ShiftIn/examples/TwoShiftRegisters/TwoShiftRegisters.ino

@@ -0,0 +1,122 @@
+/* ShiftIn.h - Arduino library that reads in values from an 8 bit shift register (74HC165).
+ * You can daisy-chain several shift register in order to read in up to 64 buttons by only using 4 Arduino pins.
+ *
+ * Created by Henrik Heine, July 24, 2016
+ *
+LICENSE
+The MIT License (MIT)
+
+Copyright (c) 2016 Henrik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+ */
+#ifndef ShiftIn_h
+#define ShiftIn_h
+
+#include "Arduino.h"
+
+template<byte chipCount, typename ShiftType>
+class _ShiftIn {
+private:
+	byte ploadPin;
+	byte clockEnablePin;
+	byte dataPin;
+	byte clockPin;
+
+	const uint16_t dataWidth;
+	uint8_t pulseWidth;
+
+	ShiftType lastState;
+	ShiftType currentState;
+public:
+	_ShiftIn() : dataWidth(chipCount * 8), pulseWidth(5), lastState(0), currentState(0) {}
+	
+	// setup all pins
+	void begin(int pload, int clockEN, int data, int clock) {
+		pinMode(ploadPin = pload, OUTPUT);
+		pinMode(clockEnablePin = clockEN, OUTPUT);
+		pinMode(dataPin = data, INPUT);
+		pinMode(clockPin = clock, OUTPUT);
+	}
+	
+	inline uint8_t getPulseWidth() { return pulseWidth; }
+	inline void setPulseWidth(uint8_t value) { pulseWidth = value; }
+	inline uint16_t getDataWidth() { return dataWidth; }
+	// whether some value has changed
+	inline boolean hasChanged() { return lastState != currentState; }
+	// whether the value with index 'id' has changed
+	inline boolean hasChanged(int id) { return state(id) != last(id); }
+	// returns the state from the last frame
+	inline ShiftType getLast() { return lastState; }
+	// returns the current state
+	inline ShiftType getCurrent() { return currentState; }
+	// whether button 'id' is pressed or not
+	inline boolean state(int id) { return bitRead(currentState, id); }
+	// whether button 'id' was pressed in the last frame
+	inline boolean last(int id) { return bitRead(lastState, id); }
+	// whether button 'id' is now pressed, but wasn't pressed in the last frame
+	inline boolean pressed(int id) { return !last(id) && state(id); }
+	// whether button 'id' is now released, but was pressed in the last frame
+	inline boolean released(int id) { return last(id) && !state(id); }
+	
+	// read in data from shift register and return the new value
+	ShiftType read() {
+		lastState = currentState;
+		ShiftType result = 0;
+
+		digitalWrite(clockEnablePin, HIGH);
+		digitalWrite(ploadPin, LOW);
+		delayMicroseconds(pulseWidth);
+		digitalWrite(ploadPin, HIGH);
+		digitalWrite(clockEnablePin, LOW);
+
+		for(int i = 0; i < dataWidth; i++) {
+			ShiftType value = digitalRead(dataPin);
+			result |= (value << ((dataWidth-1) - i));
+			digitalWrite(clockPin, HIGH);
+			delayMicroseconds(pulseWidth);
+			digitalWrite(clockPin, LOW);
+		}
+		currentState = result;
+		return result;
+	}
+	
+	// same as read, but it returns whether something has changed or not
+	boolean update() {
+		return read() != lastState;
+	}
+};
+
+// fallback with 64 bit state (up to 8 shift registers)
+template<byte chipCount>
+class ShiftIn : public _ShiftIn<chipCount, uint64_t> {};
+// single shift register (8 bit state)
+template<>
+class ShiftIn<1> : public _ShiftIn<1, uint8_t> {};
+// two shift registers (16 bit state)
+template<>
+class ShiftIn<2> : public _ShiftIn<2, uint16_t> {};
+// three shift registers (32 bit state)
+template<>
+class ShiftIn<3> : public _ShiftIn<3, uint32_t> {};
+// four shift registers (32 bit state)
+template<>
+class ShiftIn<4> : public _ShiftIn<4, uint32_t> {};
+
+#endif