StepperUNO Library 1.1: Difference between revisions

From lechacal
Jump to navigation Jump to search
Line 14: Line 14:
==Keypad==
==Keypad==
===uint8_t ReadKey();===
===uint8_t ReadKey();===
Return which key is currently pressed.
Keys are defined as below:
#define BUTTON_NONE              0  //
#define BUTTON_RIGHT              1  //
#define BUTTON_UP                2  //
#define BUTTON_DOWN              3  //
#define BUTTON_LEFT              4  //
#define BUTTON_SELECT            5  //
===bool RstReadKey();===
===bool RstReadKey();===
===bool buttonJustPressed;===   
===bool buttonJustPressed;===   

Revision as of 16:23, 23 June 2017

under construction...

Installation

Download the zip file.
Copy the StepperUNO folder in the sketchbook/library directory.


Configuration

Open the config.h file in the library/stepperUNO folder.
Change the KEYPAD_VERSION value as needed. Value should be 1 or 2. If you do not know just try one or the other and see how the button reacts.

Function list

Keypad

uint8_t ReadKey();

Return which key is currently pressed.

Keys are defined as below:

#define BUTTON_NONE               0  // 
#define BUTTON_RIGHT              1  // 
#define BUTTON_UP                 2  // 
#define BUTTON_DOWN               3  // 
#define BUTTON_LEFT               4  // 
#define BUTTON_SELECT             5  //

bool RstReadKey();

bool buttonJustPressed;

//this will be true after a ReadButtons() call if triggered

bool buttonJustReleased;

//this will be true after a ReadButtons() call if triggered

bool rstbuttonJustPressed;

//this will be true after a ReadButtons() call if triggered

bool rstbuttonJustReleased;

//this will be true after a ReadButtons() call if triggered

bool rstbuttonLongPress;

Motor Control

void speed(int speed_m1);

void setDirection(bool dir);

void enable();

void disable();

void step();

void stop();

uint8_t address;

void begin(uint8_t _address);

bool running;

bool direction;

State variables