Toru OHTSUKA / MultiClick

You can use multiple clicks event with one button. This library supports follow events, Single click, Double click, over 3 times click, Long press.

Dependents:   multiclick_test

MultiClick.cpp@7:7d56935ba84d, 2016-06-16 (annotated)

Committer:
ohtsuka
Date:
Thu Jun 16 01:29:43 2016 +0000
Revision:
7:7d56935ba84d
Parent:
6:7f1142cc196a 
add file header(MIT License)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ohtsuka 7:7d56935ba84d 1 /*
ohtsuka 7:7d56935ba84d 2 MultiClick.cpp:
ohtsuka 7:7d56935ba84d 3 For one button operation.
ohtsuka 7:7d56935ba84d 4 This library suports these events,
ohtsuka 7:7d56935ba84d 5 * Single click
ohtsuka 7:7d56935ba84d 6 * Double click
ohtsuka 7:7d56935ba84d 7 * N times click (over 3 times click)
ohtsuka 7:7d56935ba84d 8 * Long press
ohtsuka 7:7d56935ba84d 9
ohtsuka 7:7d56935ba84d 10 The MIT License (MIT)
ohtsuka 7:7d56935ba84d 11
ohtsuka 7:7d56935ba84d 12 Copyright (c) 2016 Uematsu Electric Co.,Ltd. Toru OHTSUKA <t-ohtsuka@jupiter.ocn.ne.jp>
ohtsuka 7:7d56935ba84d 13
ohtsuka 7:7d56935ba84d 14 Permission is hereby granted, free of charge, to any person obtaining a copy
ohtsuka 7:7d56935ba84d 15 of this software and associated documentation files (the "Software"), to deal
ohtsuka 7:7d56935ba84d 16 in the Software without restriction, including without limitation the rights
ohtsuka 7:7d56935ba84d 17 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
ohtsuka 7:7d56935ba84d 18 copies of the Software, and to permit persons to whom the Software is
ohtsuka 7:7d56935ba84d 19 furnished to do so, subject to the following conditions:
ohtsuka 7:7d56935ba84d 20
ohtsuka 7:7d56935ba84d 21 The above copyright notice and this permission notice shall be included in
ohtsuka 7:7d56935ba84d 22 all copies or substantial portions of the Software.
ohtsuka 7:7d56935ba84d 23
ohtsuka 7:7d56935ba84d 24 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
ohtsuka 7:7d56935ba84d 25 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
ohtsuka 7:7d56935ba84d 26 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
ohtsuka 7:7d56935ba84d 27 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
ohtsuka 7:7d56935ba84d 28 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
ohtsuka 7:7d56935ba84d 29 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
ohtsuka 7:7d56935ba84d 30 THE SOFTWARE.
ohtsuka 7:7d56935ba84d 31 */
ohtsuka 7:7d56935ba84d 32
ohtsuka 0:9c5c674dcaea 33 #include "MultiClick.h"
ohtsuka 0:9c5c674dcaea 34
ohtsuka 0:9c5c674dcaea 35 MultiClick::MultiClick(PinName p, PinMode m)
ohtsuka 0:9c5c674dcaea 36 {
ohtsuka 0:9c5c674dcaea 37 _iin = new InterruptIn(p);
ohtsuka 0:9c5c674dcaea 38 _mode = m;
ohtsuka 0:9c5c674dcaea 39
ohtsuka 0:9c5c674dcaea 40 _iin->mode(_mode);
ohtsuka 1:67d677ad73e7 41
ohtsuka 0:9c5c674dcaea 42 if(_mode == PullUp) {
ohtsuka 1:67d677ad73e7 43 DBG_PRINT("isr fall.\r\n");
ohtsuka 1:67d677ad73e7 44 _iin->fall(this, &MultiClick::isr_pressed);
ohtsuka 0:9c5c674dcaea 45 } else {
ohtsuka 1:67d677ad73e7 46 DBG_PRINT("isr rise.\r\n");
ohtsuka 1:67d677ad73e7 47 _iin->rise(this, &MultiClick::isr_pressed);
ohtsuka 0:9c5c674dcaea 48 }
ohtsuka 0:9c5c674dcaea 49
ohtsuka 5:cb4d45f41e17 50 _click_detect_timeout = new Timeout();
ohtsuka 5:cb4d45f41e17 51 _press_check = new Ticker();
ohtsuka 0:9c5c674dcaea 52
ohtsuka 5:cb4d45f41e17 53 _press_check_interval_us = 25*1000;
ohtsuka 5:cb4d45f41e17 54 _shortpress_num = 1;
ohtsuka 5:cb4d45f41e17 55 _longpress_num = 20;
ohtsuka 1:67d677ad73e7 56 _click_interval_us = 300*1000;
ohtsuka 4:8d6883cdc3c8 57
ohtsuka 5:cb4d45f41e17 58 _pressed_count = 0;
ohtsuka 3:c7f97bebf2f7 59 _longpressed = false;
ohtsuka 0:9c5c674dcaea 60 }
ohtsuka 0:9c5c674dcaea 61
ohtsuka 1:67d677ad73e7 62 void MultiClick::isr_pressed( void )
ohtsuka 0:9c5c674dcaea 63 {
ohtsuka 5:cb4d45f41e17 64 DBG_PRINT("isr_pressed called:\r\n");
ohtsuka 5:cb4d45f41e17 65 fflush(stdout);
ohtsuka 4:8d6883cdc3c8 66
ohtsuka 5:cb4d45f41e17 67 if(_pressed_count > 0) { // 「プレス中のプレス」
ohtsuka 6:7f1142cc196a 68 DBG_PRINT("_[%d]", _pressed_count);
ohtsuka 5:cb4d45f41e17 69 press_check_func();
ohtsuka 5:cb4d45f41e17 70 } else { // 通常時
ohtsuka 7:7d56935ba84d 71 // プレス判定処理開始
ohtsuka 7:7d56935ba84d 72 _pressed_count = 0;
ohtsuka 7:7d56935ba84d 73 _press_check->detach();
ohtsuka 7:7d56935ba84d 74 _press_check->attach_us(this, &MultiClick::press_check_func, _press_check_interval_us );
ohtsuka 7:7d56935ba84d 75
ohtsuka 7:7d56935ba84d 76 _longpressed = false;
ohtsuka 3:c7f97bebf2f7 77 }
ohtsuka 2:6af39916a4a2 78 }
ohtsuka 2:6af39916a4a2 79
ohtsuka 5:cb4d45f41e17 80 void MultiClick::press_check_func( void )
ohtsuka 2:6af39916a4a2 81 {
ohtsuka 5:cb4d45f41e17 82 int curr_state;
ohtsuka 5:cb4d45f41e17 83 curr_state = _iin->read();
ohtsuka 4:8d6883cdc3c8 84
ohtsuka 5:cb4d45f41e17 85 if(curr_state == 0) { // 押されている場合
ohtsuka 5:cb4d45f41e17 86 DBG_PRINT(".");
ohtsuka 5:cb4d45f41e17 87 _pressed_count++;
ohtsuka 5:cb4d45f41e17 88 // 長押しチェック
ohtsuka 5:cb4d45f41e17 89 if(_pressed_count > _longpress_num) {
ohtsuka 5:cb4d45f41e17 90 if(_longpressed != true) {
ohtsuka 5:cb4d45f41e17 91 if(_c_callback_longpressed != 0) {
ohtsuka 5:cb4d45f41e17 92 (*_c_callback_longpressed)();
ohtsuka 5:cb4d45f41e17 93 }
ohtsuka 5:cb4d45f41e17 94 _longpressed = true;
ohtsuka 5:cb4d45f41e17 95 }
ohtsuka 5:cb4d45f41e17 96 }
ohtsuka 5:cb4d45f41e17 97 } else { // 押されていない場合
ohtsuka 5:cb4d45f41e17 98 DBG_PRINT("# _pressed_count=%d\r\n", _pressed_count);
ohtsuka 2:6af39916a4a2 99
ohtsuka 5:cb4d45f41e17 100 if(_pressed_count >= _shortpress_num) {
ohtsuka 5:cb4d45f41e17 101 _click_times++;
ohtsuka 5:cb4d45f41e17 102 }
ohtsuka 5:cb4d45f41e17 103 DBG_PRINT("# _click_times=%d\r\n", _click_times);
ohtsuka 5:cb4d45f41e17 104
ohtsuka 5:cb4d45f41e17 105 _press_check->detach(); // 　プレスチェックを停止
ohtsuka 6:7f1142cc196a 106 _pressed_count = 0;
ohtsuka 3:c7f97bebf2f7 107
ohtsuka 5:cb4d45f41e17 108 _click_detect_timeout->detach(); // マルチクリック検出用タイマーを設定
ohtsuka 5:cb4d45f41e17 109 _click_detect_timeout->attach_us(this, &MultiClick::click_detect_timeout, _click_interval_us );
ohtsuka 5:cb4d45f41e17 110
ohtsuka 5:cb4d45f41e17 111 }
ohtsuka 1:67d677ad73e7 112
ohtsuka 1:67d677ad73e7 113 }
ohtsuka 1:67d677ad73e7 114
ohtsuka 5:cb4d45f41e17 115 void MultiClick::click_detect_timeout( void )
ohtsuka 1:67d677ad73e7 116 {
ohtsuka 5:cb4d45f41e17 117 DBG_PRINT("-> click_detect T.O.\r\n");
ohtsuka 4:8d6883cdc3c8 118
ohtsuka 5:cb4d45f41e17 119 if(_longpressed) { // 長押し時は何もしない
ohtsuka 5:cb4d45f41e17 120 DBG_PRINT("-> skip n click C.B. \r\n");
ohtsuka 5:cb4d45f41e17 121 } else { // クリックイベントを通知
ohtsuka 5:cb4d45f41e17 122 switch( _click_times ) {
ohtsuka 5:cb4d45f41e17 123 case 0:
ohtsuka 6:7f1142cc196a 124 DBG_PRINT("error! 0 click\r\n");
ohtsuka 5:cb4d45f41e17 125 break;
ohtsuka 5:cb4d45f41e17 126
ohtsuka 5:cb4d45f41e17 127 case 1:
ohtsuka 5:cb4d45f41e17 128 if(_c_callback_clicked != 0) {
ohtsuka 5:cb4d45f41e17 129 (*_c_callback_clicked)();
ohtsuka 5:cb4d45f41e17 130 }
ohtsuka 5:cb4d45f41e17 131 break;
ohtsuka 4:8d6883cdc3c8 132
ohtsuka 5:cb4d45f41e17 133 case 2:
ohtsuka 5:cb4d45f41e17 134 if(_c_callback_doubleclicked != 0) {
ohtsuka 5:cb4d45f41e17 135 (*_c_callback_doubleclicked)();
ohtsuka 5:cb4d45f41e17 136 }
ohtsuka 5:cb4d45f41e17 137 break;
ohtsuka 5:cb4d45f41e17 138 default:
ohtsuka 5:cb4d45f41e17 139 if(_c_callback_n_clicked != 0) {
ohtsuka 5:cb4d45f41e17 140 (*_c_callback_n_clicked)(_click_times);
ohtsuka 5:cb4d45f41e17 141 }
ohtsuka 4:8d6883cdc3c8 142 }
ohtsuka 4:8d6883cdc3c8 143 }
ohtsuka 5:cb4d45f41e17 144
ohtsuka 5:cb4d45f41e17 145 _click_times = 0;
ohtsuka 5:cb4d45f41e17 146 _pressed_count = 0;
ohtsuka 0:9c5c674dcaea 147 }
ohtsuka 0:9c5c674dcaea 148
ohtsuka 3:c7f97bebf2f7 149 void MultiClick::attach_clicked(void (*function)(void) = 0) { _c_callback_clicked = function; }
ohtsuka 0:9c5c674dcaea 150
ohtsuka 0:9c5c674dcaea 151 void MultiClick::attach_doubleclicked(void (*function)(void) = 0) { _c_callback_doubleclicked = function; }
ohtsuka 0:9c5c674dcaea 152
ohtsuka 0:9c5c674dcaea 153 void MultiClick::attach_n_clicked(void (*function)(int) = 0) { _c_callback_n_clicked = function; }
ohtsuka 3:c7f97bebf2f7 154
ohtsuka 3:c7f97bebf2f7 155 void MultiClick::attach_longpressed(void (*function)(void) = 0) { _c_callback_longpressed = function; }