aboutsummaryrefslogtreecommitdiffstats
path: root/arduino/libraries/RotaryEncoder/SwRotaryEncoder.h
blob: 737251bed939d03a662f106955f7ffee56aa754b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
/**************************************************************************/
/*!
    @file     SwRotaryEncoder.h
    @author   hathach (tinyusb.org)

    @section LICENSE

    Software License Agreement (BSD License)

    Copyright (c) 2018, Adafruit Industries (adafruit.com)
    All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:
    1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
    2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
    3. Neither the name of the copyright holders nor the
    names of its contributors may be used to endorse or promote products
    derived from this software without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
    EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
    DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
    ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/**************************************************************************/
#ifndef SWROTARYENCODER_H_
#define SWROTARYENCODER_H_

#include "Arduino.h"

#define SW_ROTARY_ENCODER_MAX_INSTANCE    4

class SwRotaryEncoder
{
  public:
    typedef void (*callback_t) (int step);

    SwRotaryEncoder(void)
    {
      _pina = _pinb = 0;

      _a_last = 0;
      _last_read = _abs = 0;

      _cb = NULL;
    }

    bool begin(uint8_t pina, uint8_t pinb);
    void setCallback(callback_t fp);
    void stop(void);

    int32_t read(void);
    int32_t readAbs(void);
    void    writeAbs(int32_t value);
    void    clearAbs(void);

    // Internal API
    void _irq_handler(void);

  private:
    uint8_t _pina, _pinb;

    uint8_t _a_last;

    int32_t _abs;
    int32_t _last_read; // debouncing

    callback_t _cb;
};



#endif /* SWROTARYENCODER_H_ */