ky-040.h

/*
 * ky-040.h
 * 
 * Copyright 2016 Bill Williams <wlwilliams1952@gmail.com, github/Billwilliams1952>
 *
 * Library to interface with the KY-040 rotary encoder. This library
 * supports the Arduino Uno, Pro, Mini, Nano, Micro, Leonardo, and Mega.
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301, USA.
 * 
 * 
 */
#ifndef __KY040__

#define __KY040__

#include "Arduino.h"
#include <stdlib.h>			// malloc call

#define CURRENT_ID		255	// Only ID you cannot declare

/*
 * !!! DON'T DEFINE THIS UNLESS YOU'VE COMPLETELY DEBUGGED YOUR CODE !!!
 * Almost all runtime sanity checks are removed.  I added this for those
 * who may run low on program memory. You'll have to modify your Arduino
 * code to remove some return checking or you'll get compile errors.
 */
//#define	SMALLEST_CODESIZE


typedef struct encoderP {
	uint8_t id;
	int16_t currentVal;
	int16_t minVal;
	int16_t maxVal;
	int16_t inc;
	bool rollOver, changed;
} encoderParams;
	
class ky040 {

public:
	
	ky040 ( uint8_t interruptClkPin, uint8_t dtPin, uint8_t switchPin,
			uint8_t maxRotarys = 1 );

#if !defined ( SMALLEST_CODESIZE )
	bool AddRotaryCounter(uint8_t id, int16_t currentVal, int16_t minVal,
			int16_t maxVal, int16_t inc = 1, bool rollOver = true);

	bool AddRotaryCounter(uint8_t id, int16_t maxVal, bool rollOver = false );

	bool SetRotary ( uint8_t id );
#else // Minimize code size - remove most sanity / error checking
	void AddRotaryCounter(uint8_t id, int16_t currentVal, int16_t minVal,
			int16_t maxVal, int16_t inc = 1, bool rollOver = true);

	void AddRotaryCounter(uint8_t id, int16_t maxVal, bool rollOver = false );

	void SetRotary ( uint8_t id );
#endif

	bool HasRotaryValueChanged ( uint8_t id = CURRENT_ID );

	void SetChanged ( uint8_t id = CURRENT_ID );
	
	int16_t GetRotaryValue ( uint8_t id = CURRENT_ID );

	void SetMaxValueOnRotary ( int16_t maxVal, uint8_t id = CURRENT_ID );

	bool IsActive ( uint8_t id );

	bool SwitchPressed ( void );

private:
	
	uint8_t	maxRotaries = 0,	// maximum allowed rotaries
			numRotaries = 0,	// how many have been added
			clkPin,				// pin definitions for the encoder
			dtPin,
			swPin,
			currentID;			// which rotary is active
		
	encoderParams *params;
	volatile encoderParams *currentRotaryParams;
#if !defined ( SMALLEST_CODESIZE )
	bool GetParamsFromID ( uint8_t id );
#else
	void GetParamsFromID ( uint8_t id );
#endif

	static volatile encoderParams * params_2, *params_3;
	static uint8_t dtPin_2, dtPin_3;
	static void RotaryClkInterruptOn_2 ( void );
	static void RotaryClkInterruptOn_3 ( void );
	
#if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
	static volatile encoderParams *params_18, *params_19, *params_20,
								  *params_21;
	static uint8_t dtPin_18, dtPin_19, dtPin_20, dtPin_21;
	static void RotaryClkInterruptOn_18 ( void );
	static void RotaryClkInterruptOn_19 ( void );
	static void RotaryClkInterruptOn_20 ( void );
	static void RotaryClkInterruptOn_21 ( void );
#endif

#if defined(__AVR_ATmega32U4__) || defined(__AVR_ATmega16U4__)
	static volatile encoderParams *params_0, *params_1, *params_7;
	static uint8_t dtPin_0, dtPin_1, dtPin_7;
	static void RotaryClkInterruptOn_0 ( void );
	static void RotaryClkInterruptOn_1 ( void );
	static void RotaryClkInterruptOn_7 ( void );
#endif

	static void UpdateRotaryCount ( uint8_t pin, volatile encoderParams * params );
};

#endif // ifndef __KY040__