com.mbientlab.metawear.api

Enum Module

java.lang.Object

java.lang.Enum<Module>

com.mbientlab.metawear.api.Module

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Module>

public enum Module
extends java.lang.Enum<Module>

Enumeration of modules on the MetaWear board. A module can be thought of as a supported service by the MetaWear board. Each module is designed for a specific purpose and communicates with the user via a collection of registers.

Author:

Eric Tsai

See Also:

Register

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCELEROMETER 3-axis accelerometer
DATA_PROCESSOR Manipulates sensor data on the board
DEBUG Debug mode for testing purposes
EVENT Connection sensor activity with commands to be executed
GPIO General purpose I/O
HAPTIC Provides pulse width modulate for
I2C Communicate with sensors connected via I2C
IBEACON Configure IBeacon settings
LED Ultra-Bright RGB LED
LOGGING Offline logging for sensor data
MACRO Programs commands to the board's flash memory
MECHANICAL_SWITCH Miniature push button switch
NEO_PIXEL Controls NeoPixel strands connected to the board
SETTINGS Manipujlates the advertisement settings
TEMPERATURE Temperature sensor
TIMER Internal timer that sends periodic notifications

Field Summary

Fields

Modifier and Type	Field and Description
byte	opcode Opcode of the module

Method Summary

Methods

Modifier and Type	Method and Description
static Module	lookupModule(byte opcode) Find the Module with the opcode
Register	lookupRegister(byte opcode) Find the register belonging to the module with the specific opcode
static Module	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Module[]	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

Enum Constant Detail

MECHANICAL_SWITCH

public static final Module MECHANICAL_SWITCH

Miniature push button switch

LED

public static final Module LED

Ultra-Bright RGB LED

ACCELEROMETER

public static final Module ACCELEROMETER

3-axis accelerometer

TEMPERATURE

public static final Module TEMPERATURE

Temperature sensor

GPIO

public static final Module GPIO

General purpose I/O

NEO_PIXEL

public static final Module NEO_PIXEL

Controls NeoPixel strands connected to the board

IBEACON

public static final Module IBEACON

Configure IBeacon settings

HAPTIC

public static final Module HAPTIC

Provides pulse width modulate for

DATA_PROCESSOR

public static final Module DATA_PROCESSOR

Manipulates sensor data on the board

EVENT

public static final Module EVENT

Connection sensor activity with commands to be executed

LOGGING

public static final Module LOGGING

Offline logging for sensor data

TIMER

public static final Module TIMER

Internal timer that sends periodic notifications

I2C

public static final Module I2C

Communicate with sensors connected via I2C

MACRO

public static final Module MACRO

Programs commands to the board's flash memory

SETTINGS

public static final Module SETTINGS

Manipujlates the advertisement settings

DEBUG

public static final Module DEBUG

Debug mode for testing purposes

Field Detail

opcode

public final byte opcode

Opcode of the module

Method Detail

values

public static Module[] 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 (Module c : Module.values())
    System.out.println(c);

Returns:

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

valueOf

public static Module 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

lookupRegister

public Register lookupRegister(byte opcode)

Find the register belonging to the module with the specific opcode

Parameters:

opcode - Register opcode to search

Returns:

The register with the matching opcode, or null if no match is found

lookupModule

public static Module lookupModule(byte opcode)

Find the Module with the opcode

Parameters:

opcode - Module opcode to search

Returns:

Module with the matching opcode, or null if no match is found