Interface: tos.chips.atm128.adc.Atm128AdcSingle

interface Atm128AdcSingle

Hardware Abstraction Layer interface of Atmega128 for acquiring a single sample from a channel.

Commands

command bool cancel() Cancel an outstanding getData operation.

command bool getData(uint8_t channel, uint8_t refVoltage, bool leftJustify, uint8_t prescaler) Initiates an ADC conversion on a given channel.

Events

event void dataReady(uint16_t data, bool precise) Indicates a sample has been recorded by the ADC as the result of a getData() command.

Commands - Details

command bool cancel()

Cancel an outstanding getData operation. Use with care, to avoid problems with races between the dataReady event and cancel.

Returns:: TRUE if a conversion was in-progress or an interrupt was pending. dataReady will not be signaled. FALSE if the conversion was already complete. dataReady will be (or has already been) signaled.

command bool getData(uint8_t channel, uint8_t refVoltage, bool leftJustify, uint8_t prescaler)

Initiates an ADC conversion on a given channel.

Parameters:: channel - A/D conversion channel.; refVoltage - Select reference voltage for A/D conversion. See the ATM128_ADC_VREF_xxx constants in Atm128ADC.h; leftJustify - TRUE to place A/D result in high-order bits (i.e., shifted left by 6 bits), low to place it in the low-order bits; prescaler - Prescaler value for the A/D conversion clock. If you specify ATM128_ADC_PRESCALE, a prescaler will be chosen that guarantees full precision. Other prescalers can be used to get faster conversions. See the ATmega128 manual for details.
Returns:: TRUE if the conversion will be precise, FALSE if it will be imprecise (due to a change in refernce voltage, or switching to a differential input channel)

Events - Details

event void dataReady(uint16_t data, bool precise)

Indicates a sample has been recorded by the ADC as the result of a getData() command.

Parameters:: data - a 2 byte unsigned data value sampled by the ADC.; precise - if the conversion precise, FALSE if it wasn't. This values matches the result from the getData call.