/** * 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.rf230.TrafficMonitorConfig

Interface: tos.chips.rf230.TrafficMonitorConfig

interface TrafficMonitorConfig

Commands
command uint16_t getChannelTime(message_t *msg) Returns the amount of time this message has occupied the channel.
command am_addr_t getSender(message_t *msg) Returns the sender address of the message so we can calculate the average number of neighbors that send messages per update period.
command uint16_t getUpdatePeriod() Returns the frequency (in milliseconds) when the traffic averages should be updated.
command void timerTick() This command is periodically called when the timer is fired and the averages are updated

Events
event void channelError() This event should be fired if we notice some anomalies in the operation of the channel, such as not receiving acknowledgements, missing sequence numbers or packets with corrupted CRC.
event uint8_t getErrorAverage() Returns the averaged error events during one update period.
event uint8_t getNeighborAverage() Returns the averaged (exponential decay) number of neighbors whose messages this component receives during one update period.
event uint16_t getReceiveAverage() Returns the averaged (exponential decay) receive channel time during one update period.
event uint16_t getTransmitAverage() Returns the averaged (exponential decay) transmit channel time during one update period.

Commands - Details

getChannelTime

command uint16_t getChannelTime(message_t *msg)

Returns the amount of time this message has occupied the channel.

getSender

command am_addr_t getSender(message_t *msg)

Returns the sender address of the message so we can calculate the average number of neighbors that send messages per update period.

getUpdatePeriod

command uint16_t getUpdatePeriod()

Returns the frequency (in milliseconds) when the traffic averages should be updated.

timerTick

command void timerTick()

This command is periodically called when the timer is fired and the averages are updated

Events - Details

channelError

event void channelError()

This event should be fired if we notice some anomalies in the operation of the channel, such as not receiving acknowledgements, missing sequence numbers or packets with corrupted CRC.

getErrorAverage

event uint8_t getErrorAverage()

Returns the averaged error events during one update period.

getNeighborAverage

event uint8_t getNeighborAverage()

Returns the averaged (exponential decay) number of neighbors whose messages this component receives during one update period.

getReceiveAverage

event uint16_t getReceiveAverage()

Returns the averaged (exponential decay) receive channel time during one update period.

getTransmitAverage

event uint16_t getTransmitAverage()

Returns the averaged (exponential decay) transmit channel time during one update period.