Admin at 18:39, 17 January 2017

2017-01-17T18:39:44Z

Admin: Created page with "= Action = Reads pulses from a rotary encoder. ..."

2013-02-09T14:21:34Z

Created page with "= Action = Reads pulses from a rotary encoder. ..."

New page

= Action =

Reads pulses from a rotary encoder.

 

 

= Syntax =

Var = ENCODER( pin1, pin2, LeftLabel, RightLabel , wait)

 

 

= Remarks =
<div style="padding: 0px; margin: 0px 0px 0px 4px;">
{| width="604" cellspacing="0" cellpadding="1" border="1" style="border: 2px solid rgb(0, 0, 0); border-spacing: 0px; border-collapse: collapse;"
|- style="vertical-align: top;"
| valign="top" width="20%" style="width: 118px; border: 1px solid rgb(0, 0, 0);" |
Var

| valign="top" width="83%" style="width: 477px; border: 1px solid rgb(0, 0, 0);" |
The target variable that is assigned with the result

|- style="vertical-align: top;"
| valign="top" width="20%" style="width: 118px; border: 1px solid rgb(0, 0, 0);" |
Pin1 and pin2

| valign="top" width="83%" style="width: 477px; border: 1px solid rgb(0, 0, 0);" |
These are the names of the PIN registers to which the output of the encoder is connected. Both pins must be on the same PIN register. So Pinb.0 and Pinb.7 is valid while PinB.0 and PinA.0 is not.

|- style="vertical-align: top;"
| valign="top" width="20%" style="width: 118px; border: 1px solid rgb(0, 0, 0);" |
LeftLabel

| valign="top" width="83%" style="width: 477px; border: 1px solid rgb(0, 0, 0);" |
The name of the label that will be called/executed when a transition to the left is encoded.

|- style="vertical-align: top;"
| valign="top" width="20%" style="width: 118px; border: 1px solid rgb(0, 0, 0);" |
RightLabel

| valign="top" width="83%" style="width: 477px; border: 1px solid rgb(0, 0, 0);" |
The name of the label that will be called/executed when a transition to the right is encountered.

|- style="vertical-align: top;"
| valign="top" width="20%" style="width: 118px; border: 1px solid rgb(0, 0, 0);" |
wait

| valign="top" width="83%" style="width: 477px; border: 1px solid rgb(0, 0, 0);" |
A value of 0 will only check for a rotation/pulse. While a value of 1 will wait until a user actual turns the encoder. A value of 1 will thus halt your program.

|}
</div>
 

There are some conditions you need to fulfill :
<div style="padding: 0px; margin: 0px 0px 0px 35px;">
{| border="0" cellpadding="0" cellspacing="0"
|- valign="baseline" style="vertical-align: baseline;"
| width="13" | •
| The label that is called by the encoder must be terminated by a RETURN statement.
|}
</div><div style="padding: 0px; margin: 0px 0px 0px 35px;">
{| border="0" cellpadding="0" cellspacing="0"
|- valign="baseline" style="vertical-align: baseline;"
| width="13" | •
| The pin must work in the input mode. By default all pins work in input mode.
|}
</div><div style="padding: 0px; margin: 0px 0px 0px 35px;">
{| border="0" cellpadding="0" cellspacing="0"
|- valign="baseline" style="vertical-align: baseline;"
| width="13" | •
| The pull up resistors must be activated by writing a logic 1 to the port registers as the example shows.
|}
</div>
 

 

Rotary encoders come in many flavors. Some encoders also have a build in switch.

 

A sample of an encoder

 

[[File:Rotary encoder.gif|center|Rotary encoder.gif]]

[[File:Rotary2.gif|center|Rotary2.gif]]

 

 

 

Since the microprocessor has internal pull up resistors, you do not need external pull up resistors for most encoders.

An encoder has 2 output pins which change state when you turn the knob. For one 'click' you can get one or more pulses. This depends on the model of the encoder. Both output pins are sampled and compared with their previous value.

 

[[File:Encoder state.png|center]]

 

The table above show the states when rotating left and right. For example, when you turn left, the encoder will change state from 00 to 10 to 11 to 01 to 00 etc.

The software loads the pin values and compares the value with the previous value.

Only if you turn the knob there will be a different value.

Next the old state nibbles are swapper so that for example state 0000_0011 becomes 0011_0000 and the new state is added to this value. For a left rotation you get the values 2,35,49 and 16. In all other cases, the rotation was right.

 

When you call the encoder routine often enough, you will not miss any pulses. Most new processors support the pin change  interrupt. This means that an interrupt occurs when the logic level of a pin changes. you can use this interrupt to call the encoder function. This way you can be sure you will not miss a pulse.

 

 

 

= Example =

 <source lang="bascomavr">
'-----------------------------------------------------------------------------------------
'name : encoder.bas
'copyright : (c) 1995-2005, MCS Electronics
'purpose : demonstration of encoder function
'micro : Mega128
'suited for demo : yes
'commercial addon needed : no
'An encoder has 2 outputs and a ground
'We connect the outputs to pinb.0 and pinb.1
'You may choose different pins as long as they are at the same PORT
'The pins must be configured to work as input pins
'This function works for all PIN registers
'-----------------------------------------------------------------------------------------

$regfile = "m128def.dat" ' specify the used micro
$crystal = 4000000 ' used crystal frequency
$baud = 19200 ' use baud rate
$hwstack = 32 ' default use 32 for the hardware stack
$swstack = 10 ' default use 10 for the SW stack
$framesize = 40 ' default use 40 for the frame space

Print "Encoder test"
Dim B As Byte
'we have dimmed a byte because we need to maintain the state of the encoder

Portb = &B11 ' activate pull up registers

Do
B = Encoder(pinb.0 , Pinb.1 , Links , Rechts , 1)
' ^--- 1 means wait for change which blocks programflow
' ^--------^---------- labels which are called
' ^-------^---------------------------- port PINs
Print B
Waitms 10
Loop
End

'so while you can choose PINB0 and PINB7,they must be both member of PINB
'this works on all PIN registers

Links:
Print "left rotation"
Return

Rechts:
Print "right rotation"
Return
End
</source> {{Languages}}

[[Category:BASCOM Language Reference]]

@@ Line 107: / Line 107: @@
 &nbsp;
-[[File:Encoder state.png|center]]
+[[File:Encoder state.png|center|Encoder state.png]]
 &nbsp;
@@ Line 125: / Line 125: @@
 &nbsp;
-<span style="font-family: Arial;">&nbsp;</span>
+The example will just show the direction but the idea is that you can increase or decrease a variable in these routines. For example for volume.&nbsp;
 <span style="font-family: Arial;">&nbsp;</span>

ENCODER - Revision history

Admin at 18:39, 17 January 2017

Admin: Created page with "= Action = Reads pulses from a rotary encoder. ..."