Create a future to be used by asynchronous method begin(BeginFuture&). More...

#include <fastarduino/devices/hmc5883l.h>

Inheritance diagram for devices::magneto::HMC5883L< MANAGER >::BeginFuture:

Collaboration diagram for devices::magneto::HMC5883L< MANAGER >::BeginFuture:

Additional Inherited Members
Public Member Functions inherited from i2c::TWriteMultiRegisterFuture< MANAGER, T, REGISTERS >
	TWriteMultiRegisterFuture (std::initializer_list< T > values, future::FutureNotification notification=future::FutureNotification::NONE)
	Create a TWriteMultiRegisterFuture future. More...

Static Public Attributes inherited from i2c::TWriteMultiRegisterFuture< MANAGER, T, REGISTERS >
static constexpr uint8_t	NUM_WRITES = sizeof...(REGISTERS)
	Number of write commands to use inside the complete I2C transaction in order to perform this multiple registers write. More...

static constexpr uint8_t	WRITE_SIZE = sizeof(T) + 1
	The number of bytes to write for each register command in the I2C transaction. More...

Detailed Description

template<typename MANAGER>
class devices::magneto::HMC5883L< MANAGER >::BeginFuture

Create a future to be used by asynchronous method begin(BeginFuture&).

This is used by begin() to pass input settings, and it shall be used by the caller to determine when the I2C transaction is finished, hence when you may use other methods such as magnetic_fields() to get sensors measurements from the device.

Parameters

mode	the `OperatingMode` to operate this chip
gain	the `Gain` to use to increase measured magnetic fields
rate	the `DataOutput` rate to use in `OperatingMode::CONTINUOUS` mode
samples	the `SamplesAveraged` to use for each measurement
measurement	the `MeasurementMode` to use on the chip sensors

See also: begin(BeginFuture&)

Definition at line 286 of file hmc5883l.h.

The documentation for this class was generated from the following file:

fastarduino/devices/hmc5883l.h

Additional Inherited Members

Detailed Description