robot-rust 0.2.1

The robot-rust project, bindings for wpilib, ctre, and rev in rust.
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

// Copyright (c) FIRST and other WPILib contributors.
// Open Source Software; you can modify and/or share it under the terms of
// the WPILib BSD license file in the root directory of this project.

#pragma once

#include <wpi/SymbolExports.h>
#include <wpi/timestamp.h>

#include "units/time.h"

namespace frc {
/**
 * A simple debounce filter for boolean streams.  Requires that the boolean
 * change value from baseline for a specified period of time before the filtered
 * value changes.
 */
class WPILIB_DLLEXPORT Debouncer {
 public:
  /**
   * Type of debouncing to perform.
   */
  enum DebounceType {
    /// Rising edge.
    kRising,
    /// Falling edge.
    kFalling,
    /// Both rising and falling edges.
    kBoth
  };

  /**
   * Creates a new Debouncer.
   *
   * @param debounceTime The number of seconds the value must change from
   *                     baseline for the filtered value to change.
   * @param type         Which type of state change the debouncing will be
   *                     performed on.
   */
  explicit Debouncer(units::second_t debounceTime,
                     DebounceType type = DebounceType::kRising);

  /**
   * Applies the debouncer to the input stream.
   *
   * @param input The current value of the input stream.
   * @return The debounced value of the input stream.
   */
  bool Calculate(bool input);

  /**
   * Sets the time to debounce.
   *
   * @param time The number of seconds the value must change from baseline
   *             for the filtered value to change.
   */
  constexpr void SetDebounceTime(units::second_t time) {
    m_debounceTime = time;
  }

  /**
   * Gets the time to debounce.
   *
   * @return The number of seconds the value must change from baseline
   *             for the filtered value to change.
   */
  constexpr units::second_t GetDebounceTime() const { return m_debounceTime; }

  /**
   * Set the debounce type.
   *
   * @param type Which type of state change the debouncing will be performed on.
   */
  constexpr void SetDebounceType(DebounceType type) {
    m_debounceType = type;

    m_baseline = m_debounceType == DebounceType::kFalling;
  }

  /**
   * Get the debounce type.
   *
   * @return Which type of state change the debouncing will be performed on.
   */
  constexpr DebounceType GetDebounceType() const { return m_debounceType; }

 private:
  units::second_t m_debounceTime;
  bool m_baseline;
  DebounceType m_debounceType;

  units::second_t m_prevTime;

  void ResetTimer();

  bool HasElapsed() const;
};
}  // namespace frc