com.mbientlab.metawear.api.controller

Interface Event

All Superinterfaces:

MetaWearController.ModuleController

public interface Event
extends MetaWearController.ModuleController

Controller for the event module

Author:

Eric Tsai

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Event.Callbacks Callbacks for the event module
static interface	Event.Command Wrapper class encapsulating command information
static class	Event.Register

Method Summary

Methods

Modifier and Type	Method and Description
void	commandIdToObject(byte commandId) Read the attributes of a command id.
void	disableModule() Disable the event module
void	enableModule() Enable the event module
void	readCommandBytes(byte commandId) Read the bytes representing the command to be executed.
void	recordCommand(Register srcReg, byte index, byte[] extra) Experimental function for the Event module that can use variables in place of hardcoded values for a recorded command.
void	recordMacro(Register srcReg) Record a sequence of commands, to be executed when there is activity the given register.
void	recordMacro(Register srcReg, byte index) Record a sequence of commands to be executed when a notification is sent for the particular register and index.
void	removeCommand(byte commandId) Remove the command from the event handler
void	removeMacros() Remove all recorded macros
byte	stopRecord() Stop the macro recording

Method Detail

enableModule

void enableModule()

Enable the event module

disableModule

void disableModule()

Disable the event module

commandIdToObject

void commandIdToObject(byte commandId)

Read the attributes of a command id. When the data has been received, the Event.Callbacks.receivedCommandInfo(Event.Command) callback function will be called

Parameters:

commandId - ID of the command to lookup

readCommandBytes

void readCommandBytes(byte commandId)

Read the bytes representing the command to be executed. When the data has been received, the Event.Callbacks.receivedCommandBytes(byte[]) callback function will be called

Parameters:

commandId - ID of the command to lookup

recordMacro

void recordMacro(Register srcReg)

Record a sequence of commands, to be executed when there is activity the given register. Each command recorded will have its own id, which will be passed back via the Event.Callbacks.receivedCommandId(byte) function. This version of the function is for registers that do not require an additional index (i.e. GPIO pin, NeoPixel strand, filter id)

Parameters:

srcReg - Register to trigger the event

recordMacro

void recordMacro(Register srcReg,
               byte index)

Record a sequence of commands to be executed when a notification is sent for the particular register and index. Each command recorded will have its own id, which will be passed back via the Event.Callbacks.receivedCommandId(byte) function

Parameters:

srcReg - Register to trigger the event

index - Register index to trigger the event

recordCommand

void recordCommand(Register srcReg,
                 byte index,
                 byte[] extra)

Experimental function for the Event module that can use variables in place of hardcoded values for a recorded command. Currently, this method is for simply recording one command. The function is still WIP and will be further refined in later releases.

Parameters:

srcReg - Register to trigger the event

index - Register index to trigger the event

extra - Extra data to define the variable parameters

stopRecord

byte stopRecord()

Stop the macro recording

Returns:

Number of commands

removeMacros

void removeMacros()

Remove all recorded macros

removeCommand

void removeCommand(byte commandId)

Remove the command from the event handler

Parameters:

commandId - Id of the command to remove