com.mbientlab.metawear.api.util

Enum LoggingTrigger

java.lang.Object

java.lang.Enum<LoggingTrigger>

com.mbientlab.metawear.api.util.LoggingTrigger

All Implemented Interfaces:

Logging.Trigger, java.io.Serializable, java.lang.Comparable<LoggingTrigger>

public enum LoggingTrigger
extends java.lang.Enum<LoggingTrigger>
implements Logging.Trigger

Collection of predefined triggers for the logging module. These triggers can also be used for the DataProcessor class.

Author:

Eric Tsai

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCELEROMETER_MOTION Logs free fall or motion events
ACCELEROMETER_ORIENTATION Logs the orientation data
ACCELEROMETER_SHAKE Logs shake events
ACCELEROMETER_TAP Logs tap events
ACCELEROMETER_X_AXIS Logs the X axis values of the accelerometer data output
ACCELEROMETER_XY_AXIS Logs the X and Y axis of the accelerometer
ACCELEROMETER_Y_AXIS Logs the Y axis values of the accelerometer data output
ACCELEROMETER_YZ_AXIS Logs the Y and Z axis of the accelerometer
ACCELEROMETER_Z_AXIS Logs the Z axis values of the accelerometer data output
SWITCH Logs events for the push button switch
TEMPERATURE Logs data from the temperature sensor

Method Summary

Methods

Modifier and Type	Method and Description
byte	index() Controls which module index to log i.e.
byte	length() Number of bytes required by the trigger data.
static Logging.Trigger	lookupTrigger(byte[] triggerBytes) Converts bytes describing a trigger to its corresponding enum entry
byte	offset() Position in the register byte array to start logging from
static LoggingTrigger	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static LoggingTrigger[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.mbientlab.metawear.api.controller.Logging.Trigger

register

Enum Constant Detail

SWITCH

public static final LoggingTrigger SWITCH

Logs events for the push button switch

TEMPERATURE

public static final LoggingTrigger TEMPERATURE

Logs data from the temperature sensor

ACCELEROMETER_X_AXIS

public static final LoggingTrigger ACCELEROMETER_X_AXIS

Logs the X axis values of the accelerometer data output

ACCELEROMETER_XY_AXIS

public static final LoggingTrigger ACCELEROMETER_XY_AXIS

Logs the X and Y axis of the accelerometer

ACCELEROMETER_Y_AXIS

public static final LoggingTrigger ACCELEROMETER_Y_AXIS

Logs the Y axis values of the accelerometer data output

ACCELEROMETER_YZ_AXIS

public static final LoggingTrigger ACCELEROMETER_YZ_AXIS

Logs the Y and Z axis of the accelerometer

ACCELEROMETER_Z_AXIS

public static final LoggingTrigger ACCELEROMETER_Z_AXIS

Logs the Z axis values of the accelerometer data output

ACCELEROMETER_ORIENTATION

public static final LoggingTrigger ACCELEROMETER_ORIENTATION

Logs the orientation data

ACCELEROMETER_MOTION

public static final LoggingTrigger ACCELEROMETER_MOTION

Logs free fall or motion events

ACCELEROMETER_SHAKE

public static final LoggingTrigger ACCELEROMETER_SHAKE

Logs shake events

ACCELEROMETER_TAP

public static final LoggingTrigger ACCELEROMETER_TAP

Logs tap events

Method Detail

values

public static LoggingTrigger[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LoggingTrigger c : LoggingTrigger.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LoggingTrigger valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

lookupTrigger

public static Logging.Trigger lookupTrigger(byte[] triggerBytes)

Converts bytes describing a trigger to its corresponding enum entry

Parameters:

triggerBytes - Bytes describing a trigger

Returns:

Corresponding enum entry, or null if none is found

index

public byte index()

Description copied from interface: Logging.Trigger

Controls which module index to log i.e. a specific GPIO pin or NeoPixel strand ID.

Specified by:

index in interface Logging.Trigger

Returns:

Module index being logged, or 0xff is unused

offset

public byte offset()

Description copied from interface: Logging.Trigger

Position in the register byte array to start logging from

Specified by:

offset in interface Logging.Trigger

Returns:

Data offset

length

public byte length()

Description copied from interface: Logging.Trigger

Number of bytes required by the trigger data.

Specified by:

length in interface Logging.Trigger

Returns:

Data length