Hall Switch  2.1.0
C++ library of Infineon single Hall-effect switch family for magnetic sensing applications
hall-switch-ino.hpp
Go to the documentation of this file.
1 
10 #ifndef HALL_SWITCH_INO_HPP_
11 #define HALL_SWITCH_INO_HPP_
12 
13 #include "config/hall-conf.hpp"
14 
15 #if (HALL_SWITCH_FRAMEWORK == HALL_SWITCH_FRMWK_ARDUINO)
16 
17 #include "corelib/hall-switch.hpp"
19 
26 {
27  public:
28 
29 
30  HallSwitchIno (uint8_t outputPin,
31  HallSwitch::CBack_t cBack = NULL,
32  uint8_t powerPin = UNUSED_PIN);
34  HallSwitch::CBack_t cBack = NULL);
35  ~HallSwitchIno ();
36  int begin ();
37  int end ();
38  int getBField ();
39 
40 
41  private:
42  HallSwitch sw;
43 };
44 
47 #endif
48 #endif
Hall Switch API.
int begin()
Begins the switch.
Definition: hall-switch-ino.cpp:71
~HallSwitchIno()
Hall Switch Ino Destructor.
Definition: hall-switch-ino.cpp:60
Arduino Hardware Platform Pins.
Definition: hall-platf-ino.hpp:25
int end()
Ends the switch.
Definition: hall-switch-ino.cpp:89
void(* CBack_t)(Result_t)
Callback function type for interrupt mode.
Definition: hall-switch.hpp:91
Definition: hall-switch.hpp:22
int getBField()
Gets the switch output value.
Definition: hall-switch-ino.cpp:108
HallSwitchIno(uint8_t outputPin, HallSwitch::CBack_t cBack=NULL, uint8_t powerPin=UNUSED_PIN)
Hall Switch Ino Constructor.
Definition: hall-switch-ino.cpp:31
Definition: hall-switch-ino.hpp:25
Hall Switch Library Configuration.
Hall Arduino Hardware Platforms.