Artemis::Devices::Magnetometer::magbeacon Struct Reference

The magnetometer beacon structure. More...

#include <artemis_devices.h>

Public Attributes
BeaconType	type = BeaconType::MagnetometerBeacon
	The type of the beacon.
uint32_t	deci = 0
	A decimal identifier for the beacon.
float	magx = 0
	The magnetometer reading for the x axis.
float	magy = 0
	The magnetometer reading for the y axis.
float	magz = 0
	The magnetometer reading for the z axis.

Detailed Description

The magnetometer beacon structure.

This defines the structure of the magnetometer beacon.

The magnetometer beacon consists of five members: the type of beacon (type), the decimal identifier (deci), and the magnetometer values for the x, y, and z axes (magx, magy, magz).A diagram of the struct is included below.

 1 byte   4 bytes  4 bytes  4 bytes  4 bytes
+--------+--------+--------+--------+--------+
|  type  |  deci  |  magx  |  magy  |  magz  |
+--------+--------+--------+--------+--------+

Member Data Documentation

deci

uint32_t Artemis::Devices::Magnetometer::magbeacon::deci = 0

A decimal identifier for the beacon.

This value is the current uptime of the Teensy in milliseconds. By default, it is zero.

type

BeaconType Artemis::Devices::Magnetometer::magbeacon::type = BeaconType::MagnetometerBeacon

The type of the beacon.

The BeaconType of the beacon, which is set to MagnetometerBeacon.

---

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

• include/artemis_devices.h