/** * This file is part of license combination gpl version 3 license and eCos. * The corresponding license terms are below. * * gpl version 3 Licence: * * The file were developed during the student thesis "Datensammlung in Wireless * Sensor Networks fuer Autonomic Home NetworkingÒ of Thomas Kothmayr and is * included in the dissertation "Secure Data Transmission in Wireless * Sensor Networks" by Corinna Schmitt during employment at the Technische * UniversitŠt MŸnchen, Department Computer Science, Chair Network * Architectures and Services (Germany). * Copyright (C) 2013 * Authors: Thomas Kothmayr and Corinna Schmitt (schmitt[at]net.in.tum.de) * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, version 3 of the License * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . * * * eCos Licence: (http://ecos.sourceware.org) * * This file is part of eCos, the Embedded Configurable Operating System. * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, * 2007, 2008, 2009 Free Software Foundation, Inc. * * eCos is free software; you can redistribute it and/or modify it under * the terms of the GNU General Public License as published by the Free * Software Foundation; either version 3 any later version. * * eCos is distributed in the hope that it will be useful, but WITHOUT ANY * WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for * more details. * * You should have received a copy of the GNU General Public License along * with eCos; if not, write to the Free Software Foundation, Inc., 51 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * * As a special exception, if other files instantiate templates or use * macros or inline functions from this file, or you compile this file and * link it with other works to produce a work based on this file, this file * does not by itself cause the resulting work to be covered by the GNU * General Public License. However the source code for this file must still * be made available in accordance with section (3) of the GNU General * Public License v2. * * This exception does not invalidate any other reasons why a work based on * this file might be covered by the GNU General Public License. * */ Interface: tos.chips.atm128.adc.Atm128AdcSingle

Interface: tos.chips.atm128.adc.Atm128AdcSingle

interface Atm128AdcSingle

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

Author:
Hu Siquan <husq@xbow.com>
David Gay

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

cancel

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.

getData

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

dataReady

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.