Hall Switch  2.1.0
C++ library of Infineon single Hall-effect switch family for magnetic sensing applications
hall-speed-ino.hpp
Go to the documentation of this file.
1 
10 #ifndef HALL_SPEED_INO_HPP_
11 #define HALL_SPEED_INO_HPP_
12 
13 #include "config/hall-conf.hpp"
14 
15 #if (HALL_SWITCH_FRAMEWORK == HALL_SWITCH_FRMWK_ARDUINO)
16 #if (HALL_SPEED_ENABLED == 1)
17 
18 #include "corelib/hall-speed.hpp"
20 
27 {
28  public:
29 
30  HallSpeedIno (uint8_t outputPin,
31  uint8_t polesNum = 1,
33  HallSpeed::CBackSpd_t cBack = NULL,
34  uint8_t powerPin = UNUSED_PIN);
35  HallSpeedIno (PlatformIno_t hwPlatf,
36  uint8_t polesNum = 1,
38  HallSpeed::CBackSpd_t cBack = NULL);
39  ~HallSpeedIno ();
40  int begin ();
41  int end ();
42  double getSpeed ();
43 
44  private:
45  HallSpeed sp;
46 };
49 #endif
50 #endif
51 #endif
Definition: hall-speed.hpp:33
Arduino Hardware Platform Pins.
Definition: hall-platf-ino.hpp:25
HallSpeedIno(uint8_t outputPin, uint8_t polesNum=1, HallSpeed::SpeedUnit_t units=HallSpeed::HERTZ, HallSpeed::CBackSpd_t cBack=NULL, uint8_t powerPin=UNUSED_PIN)
Hall Speed Ino Constructor.
Definition: hall-speed-ino.cpp:37
void(* CBackSpd_t)(double)
Callback function type for interrupt mode.
Definition: hall-speed.hpp:44
int end()
Ends the speed sensor.
Definition: hall-speed-ino.cpp:111
Hall Speed API.
~HallSpeedIno()
Hall Speed Ino Destructor.
Definition: hall-speed-ino.cpp:82
Definition: hall-speed.hpp:23
int begin()
Begins the speed sensor.
Definition: hall-speed-ino.cpp:93
Definition: hall-speed-ino.hpp:26
double getSpeed()
Gets the speed value.
Definition: hall-speed-ino.cpp:129
SpeedUnit_t
Definition: hall-speed.hpp:31
Hall Switch Library Configuration.
Hall Arduino Hardware Platforms.