Contiki-NG
simple-energest.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018, RISE SICS.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the Institute nor the names of its contributors
14  * may be used to endorse or promote products derived from this software
15  * without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  */
30 
31 /**
32  * \addtogroup lib
33  * @{
34  *
35  * \defgroup simple-energest The Simple Energest module
36  * @{
37  */
38 
39  /**
40  * \file
41  * A process that periodically prints out the time spent in
42  * radio tx, radio rx, total time and duty cycle.
43  *
44  * \author Simon Duquennoy <simon.duquennoy@ri.se>
45  */
46 
47 #ifndef SIMPLE_ENERGEST_H_
48 #define SIMPLE_ENERGEST_H_
49 
50 /** \brief The period at which Energest statistics will be logged */
51 #ifdef SIMPLE_ENERGEST_CONF_PERIOD
52 #define SIMPLE_ENERGEST_PERIOD SIMPLE_ENERGEST_CONF_PERIOD
53 #else /* SIMPLE_ENERGEST_CONF_PERIOD */
54 #define SIMPLE_ENERGEST_PERIOD (CLOCK_SECOND * 60)
55 #endif /* SIMPLE_ENERGEST_CONF_PERIOD */
56 
57 /**
58  * Initialize the deployment module
59  */
60 void simple_energest_init(void);
61 
62 #endif /* SIMPLE_ENERGEST_H_ */
63 /**
64  * @}
65  * @}
66  */
void simple_energest_init(void)
Initialize the deployment module.