1 /*
2  *  Copyright (c) 2016, The OpenThread Authors.
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 are met:
7  *  1. Redistributions of source code must retain the above copyright
8  *     notice, this list of conditions and the following disclaimer.
9  *  2. Redistributions in binary form must reproduce the above copyright
10  *     notice, this list of conditions and the following disclaimer in the
11  *     documentation and/or other materials provided with the distribution.
12  *  3. Neither the name of the copyright holder nor the
13  *     names of its contributors may be used to endorse or promote products
14  *     derived from this software without specific prior written permission.
15  *
16  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  *  POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 /**
30  * @file
31  *   This file includes definitions for responding to Energy Scan Requests.
32  */
33 
34 #ifndef ENERGY_SCAN_SERVER_HPP_
35 #define ENERGY_SCAN_SERVER_HPP_
36 
37 #include "openthread-core-config.h"
38 
39 #include "coap/coap.hpp"
40 #include "common/locator.hpp"
41 #include "common/non_copyable.hpp"
42 #include "common/notifier.hpp"
43 #include "common/timer.hpp"
44 #include "net/ip6_address.hpp"
45 #include "net/udp6.hpp"
46 #include "thread/thread_tlvs.hpp"
47 
48 namespace ot {
49 
50 /**
51  * This class implements handling Energy Scan Requests.
52  *
53  */
54 class EnergyScanServer : public InstanceLocator, private NonCopyable
55 {
56     friend class ot::Notifier;
57 
58 public:
59     /**
60      * This constructor initializes the object.
61      *
62      */
63     explicit EnergyScanServer(Instance &aInstance);
64 
65 private:
66     static constexpr uint32_t kScanDelay   = 1000; ///< SCAN_DELAY (milliseconds)
67     static constexpr uint32_t kReportDelay = 500;  ///< Delay before sending a report (milliseconds)
68 
69     static void HandleRequest(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo);
70     void        HandleRequest(Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo);
71 
72     static void HandleScanResult(Mac::EnergyScanResult *aResult, void *aContext);
73     void        HandleScanResult(Mac::EnergyScanResult *aResult);
74 
75     static void HandleTimer(Timer &aTimer);
76     void        HandleTimer(void);
77 
78     void HandleNotifierEvents(Events aEvents);
79 
80     void SendReport(void);
81 
82     Ip6::Address mCommissioner;
83     uint32_t     mChannelMask;
84     uint32_t     mChannelMaskCurrent;
85     uint16_t     mPeriod;
86     uint16_t     mScanDuration;
87     uint8_t      mCount;
88     bool         mActive;
89 
90     int8_t  mScanResults[OPENTHREAD_CONFIG_TMF_ENERGY_SCAN_MAX_RESULTS];
91     uint8_t mScanResultsLength;
92 
93     TimerMilli mTimer;
94 
95     Coap::Resource mEnergyScan;
96 };
97 
98 /**
99  * @}
100  */
101 
102 } // namespace ot
103 
104 #endif // ENERGY_SCAN_SERVER_HPP_
105