File Information
Library: IoT/Devices
Package: Devices
Header: IoT/Devices/Magnetometer.h
Description
The interface for three-axis Magnetometers.
Inheritance
Direct Base Classes: Device
All Base Classes: Device
Member Summary
Member Functions: fieldStrength
Inherited Functions: getFeature, getPropertyBool, getPropertyDouble, getPropertyInt, getPropertyInt16, getPropertyInt64, getPropertyString, getPropertyTimestamp, hasFeature, hasProperty, setFeature, setPropertyBool, setPropertyDouble, setPropertyInt, setPropertyInt16, setPropertyInt64, setPropertyString, setPropertyTimestamp
Constructors
Magnetometer
Magnetometer();
Creates the Magnetometer.
Destructor
~Magnetometer 
~Magnetometer();
Destroys the Magnetometer.
Member Functions
fieldStrength
virtual MagneticFieldStrength fieldStrength() const = 0;
Returns the most recently measured field strength values.
Variables
fieldStrengthChanged
Poco::BasicEvent < const MagneticFieldStrength > fieldStrengthChanged;
Fired when new magnetic field strength values are available.
Actual behavior of this event (e.g., minimum interval between fires) are implementation specific and can be configured via properties.