Interface: tos.chips.atm128.timer.HplAtm128Capture

interface HplAtm128Capture<typedef size_type>

HPL Interface to Atmega128 capture capabilities.

Parameters:
size_type - Integer type of capture register
Author:
Martin Turon <mturon@xbow.com>

Commands
command size_type get() Get the time to be captured.
command bool isOn() Is capture interrupt on?
command void reset() Clear the capture interrupt flag.
command void set(size_type t) Set the time to be captured.
command void setEdge(bool up) Sets the capture edge.
command void start() Enable the capture interrupt.
command void stop() Turn off capture interrupts.
command bool test() Did a capture interrupt occur?

Events
event void captured(size_type t) Signalled on capture interrupt.

Commands - Details

get

command size_type get()

Get the time to be captured.

Returns:
the capture time

isOn

command bool isOn()

Is capture interrupt on?

Returns:
TRUE if capture enabled, FALSE otherwise

reset

command void reset()

Clear the capture interrupt flag. *

set

command void set(size_type t)

Set the time to be captured.

Parameters:
t - the time of the next capture event

setEdge

command void setEdge(bool up)

Sets the capture edge.

Parameters:
up - TRUE = detect rising edge, FALSE = detect falling edge

start

command void start()

Enable the capture interrupt. *

stop

command void stop()

Turn off capture interrupts. *

test

command bool test()

Did a capture interrupt occur?

Returns:
TRUE if capture triggered, FALSE otherwise

Events - Details

captured

event void captured(size_type t)

Signalled on capture interrupt.

Parameters:
t - the time of the capture event