Simple RPG Library

Dependents:   Audio_Player Wav_player_RPG_menu lcd_menu Lab3 ... more

Embed: (wiki syntax)

« Back to documentation index

RPG Class Reference

RPG Class Reference

Constructor(Channel A input pin, Channel B input pin, Pushbutton input pin) More...

#include <RPG.h>

Public Member Functions

 RPG (PinName pA, PinName pB, PinName pPB)
 ============================================================================= Rotary Pulse Generator class (Version 0.0.1) ============================================================================= Copyright (c) 2012 Christopher Anderson
 ~RPG ()
 Destructor.
int dir ()
 Determines direction of rotation returns: 1 for clockwise -1 for counter-clockwise 0 for no rotation.
bool pb ()
 reads and debounces push button returns bool result

Detailed Description

Constructor(Channel A input pin, Channel B input pin, Pushbutton input pin)

Definition at line 35 of file RPG.h.


Constructor & Destructor Documentation

RPG ( PinName  pA,
PinName  pB,
PinName  pPB 
)

============================================================================= Rotary Pulse Generator class (Version 0.0.1) ============================================================================= Copyright (c) 2012 Christopher Anderson

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. ============================================================================= Constructor(Channel A input pin, Channel B input pin, Pushbutton input pin)

Definition at line 33 of file RPG.cpp.

~RPG (  )

Destructor.

Definition at line 46 of file RPG.cpp.


Member Function Documentation

int dir (  )

Determines direction of rotation returns: 1 for clockwise -1 for counter-clockwise 0 for no rotation.

Definition at line 69 of file RPG.cpp.

bool pb (  )

reads and debounces push button returns bool result

Definition at line 52 of file RPG.cpp.