pxt-rotary-encoder-ky040's Introduction

KY040 Rotary Encoder MakeCode Package

This is the MakeCode package for the KY-040 rotary encoder.

Hardware Setup

Connect the appropriate pins (CLK, DT, SW, GND) to the micro:bit.

Blocks

Initialise rotary encoder

Initialises the rotary encoder.

Sets up the micro:bit to use the rotary encoder.

RotaryEncoder.init(P0, P1, P2)

This block must be placed before any of the other blocks in this list.

On button pressed

Button push event.

Called whenever the button is pushed down.

RotaryEncoder.onPressEvent(() => {
    basic.showString("Button pressed!")
})

On rotate (left/right)

Rotation event.

Called whenever the encoder detects rotation.

RotaryEncoder.onRotateEvent(RotationDirection.Left, () => {
    basic.showString("<")
})

RotaryEncoder.onRotateEvent(RotationDirection.Right, () => {
    basic.showString(">")
})

Example: Number input

The follow code creates a number input that can be adjusted by turning the encoder.

RotaryEncoder.init(P0, P1, P2)
let item = 0
basic.showNumber(item)
RotaryEncoder.onRotateEvent(RotationDirection.Left, () => {
    item -= 1
    basic.showNumber(item)
})
RotaryEncoder.onRotateEvent(RotationDirection.Right, () => {
    item += 1
    basic.showNumber(item)
})
RotaryEncoder.onPressEvent(() => {
    basic.showString("selected!")
})

Supported targets

for PXT/microbit

pxt-rotary-encoder-ky040's People

Contributors

Stargazers

Watchers

pxt-rotary-encoder-ky040's Issues

MakeCode Compatibility

When I use MakeCode and add this module, my project doesn't seem to put thing in the order the readme intends. the init code is placed after the events code. I'm not sure if this is really my problem, but I can't get any events to fire that make sense.

Compatibility with micro:bit v2

Hi @tinkertanker,

As you might have seen from microsoft/pxt-microbit#3506 this extension is currently not compiling against the latest version of Micro:bit CODAL. This means it will not work with micro:bit V2.

Software for micro:bit V2 boards is built using CODAL rather than the DAL, and no longer includes the mbed layer. We’ve implemented the most frequently used mbed classes to support easy porting of existing extensions, but there may still be corner cases with this compatibility layer.

As your extension is currently not building, it will be disabled for micro:bit V2. People attempting to use your extension with a micro:bit V2 board will get error 929. This extension will only be re-enabled on micro:bit V2 once it is fixed.

There are details on how to ensure extensions work on both version of the micro:bit here (lancaster-university/codal-microbit-v2#31).

Looking at your extension source I believe that your extension falls under this category:

Use of mbed APIs that are in the compatibility layer, but no inclusion of mbed.h

/home/build/prjclone/pxtapp/ky040/ky040.cpp:3:9: error: 'vector' does not name a type
 typedef vector<Action> vA;
         ^~~~~~
/home/build/prjclone/pxtapp/ky040/ky040.cpp:31:25: error: 'InterruptIn' does not name a type
 uint32_t lri = 0, lbi=0;InterruptIn *ri; DigitalIn *dv, *dsw; Timer tsb; vA leftRotate, rightRotate, pressRotate;
                         ^~~~~~~~~~~
/home/build/prjclone/pxtapp/ky040/ky040.cpp:31:42: error: 'DigitalIn' does not name a type
 uint32_t lri = 0, lbi=0;InterruptIn *ri; DigitalIn *dv, *dsw; Timer tsb; vA leftRotate, rightRotate, pressRotate;
                                          ^~~~~~~~~
/home/build/prjclone/pxtapp/ky040/ky040.cpp:31:69: error: no matching function for call to 'codal::Timer::Timer()'
 uint32_t lri = 0, lbi=0;InterruptIn *ri; DigitalIn *dv, *dsw; Timer tsb; vA leftRotate, rightRotate, pressRotate;

Add icon.png

Add a icon.png image in the root folder. It will be used when displaying the package in the "Add package" dialog.

020 crash in MakeCode v2 and MakeCode beta (06.08.20)

This program crashes when the encoder is turned rapidly left or right.

https://makecode.microbit.org/_TqjJ4m2pV3Xc

Recommend Projects

tinkertanker / pxt-rotary-encoder-ky040 Goto Github PK