'*********************************************************** ************************
' Rotary Encoder (KY040) Demonstrator
'
' MMBasic 4.5 or newer.
'
' (c) Peter Carnegie 2014
'
'
' The KY040 module contains a rotary encoder together with a push-switch on a small
' PCB with 5 Connections. The KY040 was developed for Arduino, but of course us uMite
' folk can use it as well, and the KY040 is incredibly cheap, US$2.0 inc P&P, just
' search eBay for KY040.
'
' Wiring it up
'
' KY040 Micromite
' ----- ---------
' CLK 2 ---> 0.1uF ---> Ov
' DT 3 ---> 0.1uF ---> Ov
' SW 4 ---> 0.1uF ---> Ov
' + 3V3
' Gnd 0V
'
' NB
' 1) It is VERY important to decouple the DT,CLK & SW pins to 0V
' using 0.1uF at the uMite end of the link wire.
' If you don't decouple these signals, severe contact bounce will be evident,
' eg one click will generate a dozen or more increment/decrements.
'
' 2) The KY040 module has on-board pullup resistors. You must supply 3V3 or less
' to the + pin of the KY040 module
'
' 3) This s/w works fine with just a standalone rotary encoder, but you will need
' to supply your own 10K pullups to 3V3. For a standalone encoder RA=CLK, RB=DT, & SW=SW
'
' When this software runs, each CLOCKwise step of the rotary encoder will result
' in an increase of the variable DisplayValue which will be printed to the Console.
' Each ANTI-clockwise step of the rotary encoder will result in a decrease of the
' variable DisplayValue which will be printed to the Console.
' Pushing the push-switch will clear the variable DisplayValue to 0.

' This demonstration s/w is Interrupt based for maximum responsiveness.

' This software improves on the snippet listed
' in the Micromite User Manual in that the count, DisplayValue
' increases/decreases more smoothly/accurately.
'
'*********************************************************** ************************


'Declare all Global Variables here

'Rotary Encoder Input pins
DIM CLK,DT
CLK=2
DT=3

'Push Switch Input Pin
DIM SW
SW=4

'Configure uMite pins
SETPIN DT, DIN
SETPIN CLK, INTH, REInt
SETPIN SW, INTH, SWInt

'Variable incremented/decremented by the Interrupt handling
'routine for the Rotary Encoder.Needs to be global so that
'REInt ISR can access it
DIM Value

'Var Display Value Inc/Decremented in Main Loop
'Cleared when Switch is pushed.Needs to be Global so that
'SWInt ISR can access it
DIM DispValue

'Set to 1 to request a refresh of the display.Needs to be Global so that
'SWInt ISR can access it
DIM DisplayRefresh

'Go run the Program
Main

END

SUB Main

LOCAL LastValue

LOCAL Change

'The Main Program Loop
DO

'Has there been any movement of the encoder ?
Change=Value-LastValue

'We've caught the change so prepare for next time round
LastValue=Value

'Was there any movement of the encoder ?
IF Change<>0 THEN

'If encoder is turning ANTI-clockwise, Decrement
IF Change<0 THEN
DispValue=DispValue-1
ENDIF

'If encoder is turning CLOCKwise, Increment
IF Change>0 THEN
DispValue=DispValue+1
ENDIF

'Request a Display Refresh
DisplayRefresh=1

ENDIF

'Update the Display ?
IF DisplayRefresh=1 THEN

'Reset the trigger
DisplayRefresh=0

'Display on the Console
PRINT STR$(DispValue)

ENDIF

LOOP

END SUB

'ISR for Rotary Encoder
'Here when the Rotary encoder moves
SUB REInt()

IF PIN(DT)=1 THEN

'Clockwise rotation
Value=Value+1

ELSE

'Anti-Clockwise rotation
Value=Value-1

ENDIF

END SUB


'ISR for Push-Switch
'Here when Switch changes state
SUB SWInt()

'Clear the Displayed Value
DispValue=0

'And trigger a DisplayRefresh of DispValue
DisplayRefresh=1

END SUB

LCD INIT 4, 5, 6, 7, 2, 3
LCD CLEAR
VALUE = 0
SETPIN 9, DIN 'PIN 9 = CLK
SETPIN 10, INTH, REI 'PIN 10 = DT
BUTTON = 14
SETPIN BUTTON, DIN
LONGPRESS = 15

DO
IF PIN(Button) = 0 THEN GOSUB GetButton
IF ButtonPress = 2 THEN LONGBUTTON
IF ButtonPress = 1 THEN GOSUB SHORTBUTTON
LOOP



GetButton:
' Constant LONGPRESS determines LongPress Time
' ButtonPress=0 - No Press
' ButtonPress=1 - Short Press
' ButtonPress=2 - Long Press

ButtonPress=0
DO WHILE PIN(Button)=0
IF ButtonPress<255 THEN ButtonPress=ButtonPress+1
PAUSE 25 ' This is also our Debounce value
LOOP
IF ButtonPress>0 THEN
IF ButtonPress=>LongPress THEN
ButtonPress=2
ELSE
ButtonPress=1
ENDIF
ENDIF
RETURN

SUB LONGBUTTON
LCD 2,1," "
LCD 2,1,"LONG PRESS"
BUTTONPRESS = 0
END SUB

SHORTBUTTON:
LCD 2,1," "
LCD 2,1,"SHORT PRESS"
BUTTONPRESS = 0
RETURN

REI:
IF PIN(9)=1 THEN
VALUE = VALUE - 1
ELSE
VALUE = VALUE + 1
ENDIF
IF VALUE <= 0 THEN VALUE = 0 'SET MIN VALUE HERE
IF VALUE >= 20 THEN VALUE = 20 'SET MAX VALUE HERE
PRINT "VALUE = ";VALUE
LCD 1,1," "
LCD 1,1,STR$(VALUE)
IRETURN

'Interrupt Routine
'Here when the Rotary encoder moves
Sub RInt
Local Ratio
Local Gearing
Gearing=10

'Do gearing - change Gearing to suit your tastes
Ratio=Ratio+1
if Ratio>Gearing then
Ratio=0
IF PIN(RB)=1 THEN
'Clockwise rotation
Value=Value+1
End If
ELSE
'Anti-Clockwise rotation
Value=Value-1
END IF

End Sub

'Array of Possible Step Sizes in Hz
Dim StepHz(4)
StepHz(0)=1
StepHz(1)=10
StepHz(2)=100
StepHz(3)=1000

Dim StepHz(6)
StepHz(0)=1
StepHz(1)=10
StepHz(2)=100
StepHz(3)=1000
StepHz(4)=10000
StepHZ(5)=100000

'What to Add/Subtract from the Scaled tuning Word
'for each Encoder Up/Down
Dim StepTWord$(6) Length 24
'These TuningWord sizes were calculated using Double precision arithmetic
'in VB6, using 2^32/125.0
'
StepTWord$(0)="34359738" '1Hz 34359738.368
StepTWord$(1)="343597384" '10Hz 343597383.68
StepTWord$(2)="3435973837" '100Hz 3435973836.8
StepTWord$(3)="34359738368" '1000Hz 34359738368
StepTWord$(4)="343597383680" '10000Hz 343597383680
StepTWord$(5)="3435973836800" '100000Hz 3435973836800

Sub StepChange

CurStepIndex=CurStepIndex+1
'Roll round CurStepIndex if greater than 5
CurStepIndex=CurStepIndex Mod 6
'Load the CurStepTW with the Step in TW
LoadBCD CurStepTW(0),StepTWord$(CurStepIndex)

'Could display something on the LCD to indicate New Step in force
'eg Underline digit.

End Sub

line 98 SETPIN RSW, INTL, Roll

TO

Line 98 SETPIN RSW, INTL, StepChange

and delete
'=============================================
Roll:
StepCHANGE
IRETURN

'=========================================================
'Increment CurFreq() by Inc
'
'
SUB IncCurFreq(Inc)
LOCAL I,Cy

Cy=Inc
FOR I=0 TO 3
CurFreq(I)=CurFreq(I) + Cy

IF CurFreq(I)<1000 THEN
EXIT FOR
ELSE
Cy=CurFreq(I)\1000
CurFreq(I)=CurFreq(I) MOD 1000
ENDIF

NEXT I

END SUB

'=========================================================
'Decrement CurFreq() by Dec
'
'

SUB DecCurFreq(Dec)

LOCAL I, Bw

Bw=Dec
FOR I=0 TO 3
CurFreq(I)=CurFreq(I)+1000 - BW
BW=1 - (CurFreq(I) \ 1000)
CurFreq(I)=CurFreq(I) MOD 1000
NEXT I

END SUB