Skip to content
Arduino library for Grove Encoder v1.2
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples/encoderTest
GroveEncoder.cpp
GroveEncoder.h
LICENSE
README.md
keywords.txt
library.properties

README.md

GroveEncoder Library

A project to enable the Grove Encoder v1.2 hardware to work simply on Arduino. You can find information about the Grove Encoder here. The library included by the manufacturer didn't run on my Arduino101, so I wrote this new one from scratch.

Hardware requirements

  • Arduino101/Genuino101
  • Grove Shield and a cable
  • Grove Rotary Encoder v1.2

Recommended hardware setup

  1. Put the Grove Kit Shield in the Arduino101
  2. Plug one side of the cable into the D7 port on the Grove Shield
  3. Plug the other side of the cable into the Grove Rotary Encoder v1.2
  4. You're done! Power it on and start programming.

Installation

Download the ZIP and install using the Arduino IDE. Alternative installation instructions may be found here.

Usage

The GroveEncoder library makes it possible to read the value off of an encoder. When the knob is turned clockwise, the value will increment. When the knob is turned counterclockwise, the number will decrement. This value is a 32 bit signed integer.

You can use this library via polling, or attach an interrupt handler if you're an advanced user. Please see the examples directory.

Polling

Simply create a GroveEncoder object and pass NULL as the second parameter.

#include <GroveEncoder.h>

void loop() {
  GroveEncoder myEncoder(7, NULL);
  while (1)
  {
    int value = myEncoder.getValue();
    // getValue returns the number currently on the encoder.
    Serial.print(value, HEX);
  }
}

Interrupts

Create a GroveEncoder object and pass it a pin as well as a callback.

#include <GroveEncoder.h>

void myCallback(int newValue) {
  Serial.print(newValue, HEX);
  Serial.print("\n");
}

void loop() {
  // Create a GroveEncoder
  GroveEncoder myEncoder(7, &myCallback);
  while (1)
  {
    // do something else
  }
}

Limitations

  • Currently you can only use one GroveEncoder per platform.
  • This has only been tested on Arduino101. However, I haven't done anything specifically to prevent this from working on other Arduino versions.

License

See LICENSE.

You can’t perform that action at this time.