com.mbientlab.metawear.module

Interface Timer

All Superinterfaces:

MetaWearBoard.Module

public interface Timer
extends MetaWearBoard.Module

On-board scheduler for executing MetaWear commands in the future

Author:

Eric Tsai

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Timer.ScheduledTask A task comprising of MetaWear commands programmed to run on-board at a certain times

Method Summary

Modifier and Type	Method and Description
Timer.ScheduledTask	lookupScheduledTask(byte id) Find the Timer.ScheduledTask object corresponding to the given id
Task<Timer.ScheduledTask>	scheduleAsync(int period, boolean delay, CodeBlock mwCode) Schedule a task to be indefinitely executed on-board at fixed intervals
Task<Timer.ScheduledTask>	scheduleAsync(int period, short repetitions, boolean delay, CodeBlock mwCode) Schedule a task to be executed on-board at fixed intervals for a specific number of repetitions

Method Detail

scheduleAsync

Task<Timer.ScheduledTask> scheduleAsync(int period,
                                        boolean delay,
                                        CodeBlock mwCode)

Schedule a task to be indefinitely executed on-board at fixed intervals

Parameters:

period - How often to execute the task, in milliseconds

delay - True if first execution should be delayed by one delay

mwCode - MetaWear commands composing the task

Returns:

Task holding the result of the scheduled request

See Also:

Timer.ScheduledTask

scheduleAsync

Task<Timer.ScheduledTask> scheduleAsync(int period,
                                        short repetitions,
                                        boolean delay,
                                        CodeBlock mwCode)

Schedule a task to be executed on-board at fixed intervals for a specific number of repetitions

Parameters:

period - How often to execute the task, in milliseconds

repetitions - How many times to execute the task

delay - True if first execution should be delayed by one delay

mwCode - MetaWear commands composing the task

Returns:

Task holding the result of the scheduled task

See Also:

Timer.ScheduledTask

lookupScheduledTask

Timer.ScheduledTask lookupScheduledTask(byte id)

Find the Timer.ScheduledTask object corresponding to the given id

Parameters:

id - Task id to lookup

Returns:

Schedule task matching the id, null if no matches