button.hpp

Go to the documentation of this file.

/* SPDX-License-Identifier: Apache-2.0 */
/* Copyright 2018-2019 Peter A. Bigot */
 
#ifndef NRFCXX_SENSOR_BUTTON_HPP
#define NRFCXX_SENSOR_BUTTON_HPP
#pragma once
 
#include <nrfcxx/sensor/contact.hpp>
 
namespace nrfcxx {
namespace sensor {
 
class Button
{
public:
 
  static constexpr unsigned int EVT_RELEASE = 0;
 
  static constexpr unsigned int EVT_CLICK = 1;
 
  static constexpr unsigned int EVT_HOLD = 2;
 
  static constexpr unsigned int EVT_STUCK = 3;
 
  static const char* eventstr (unsigned int evt);
 
  using event_callback = std::function<void(unsigned int evt, uint64_t duration_utt)>;
 
  unsigned int state () const;
 
  unsigned int state (uint64_t& duration_utt) const;
 
  Button (uint8_t psel,
          const notifier_type& notify,
          event_callback callback,
          bool active_low = board::button_active_low);
 
  unsigned int debounce_utt () const
  {
    return debounce_utt_;
  }
 
  int debounce_utt (unsigned int utt);
 
  unsigned int hold_utt () const
  {
    return hold_utt_;
  }
 
  int hold_utt (unsigned int utt);
 
  unsigned int stuck_utt () const
  {
    return stuck_utt_;
  }
 
  int stuck_utt (unsigned int utt);
 
  void process ();
 
private:
  static constexpr bool state_xor = board::button_active_low;
 
  static void level_callback_ (Button* bp);
 
  static bool alarm_callback (clock::alarm& alarm);
 
  uint64_t process_ (contact::ordinal_type eo,
                     contact::timestamp_type ts);
 
  notifier_type notify_;
  contact contact_;
  periph::GPIOTE::sense_listener listener_;
  event_callback callback_;
 
  clock::alarm alarm_;
  contact::state_type snapshot_;
  uint64_t process_utt{};
  uint64_t press_utt{};
 
  unsigned int debounce_utt_ = clock::uptime::from_ms(80U);
  unsigned int hold_utt_ = clock::uptime::from_ms(500U);
  unsigned int stuck_utt_ = clock::uptime::from_ms(20000U);
 
  uint8_t state_ = 0;
};
 
} // ns sensor
} // ns nrfcxx
 
#endif /* NRFCXX_SENSOR_BUTTON_HPP */