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 implements the Energy Scan Client.
32 */
33
34 #include "energy_scan_client.hpp"
35
36 #if OPENTHREAD_CONFIG_COMMISSIONER_ENABLE && OPENTHREAD_FTD
37
38 #include "coap/coap_message.hpp"
39 #include "common/as_core_type.hpp"
40 #include "common/code_utils.hpp"
41 #include "common/debug.hpp"
42 #include "common/encoding.hpp"
43 #include "common/locator_getters.hpp"
44 #include "common/log.hpp"
45 #include "common/num_utils.hpp"
46 #include "instance/instance.hpp"
47 #include "meshcop/meshcop.hpp"
48 #include "meshcop/meshcop_tlvs.hpp"
49 #include "thread/thread_netif.hpp"
50 #include "thread/uri_paths.hpp"
51
52 namespace ot {
53
54 RegisterLogModule("EnergyScanClnt");
55
EnergyScanClient(Instance & aInstance)56 EnergyScanClient::EnergyScanClient(Instance &aInstance)
57 : InstanceLocator(aInstance)
58 {
59 }
60
SendQuery(uint32_t aChannelMask,uint8_t aCount,uint16_t aPeriod,uint16_t aScanDuration,const Ip6::Address & aAddress,otCommissionerEnergyReportCallback aCallback,void * aContext)61 Error EnergyScanClient::SendQuery(uint32_t aChannelMask,
62 uint8_t aCount,
63 uint16_t aPeriod,
64 uint16_t aScanDuration,
65 const Ip6::Address &aAddress,
66 otCommissionerEnergyReportCallback aCallback,
67 void *aContext)
68 {
69 Error error = kErrorNone;
70 Tmf::MessageInfo messageInfo(GetInstance());
71 Coap::Message *message = nullptr;
72
73 VerifyOrExit(Get<MeshCoP::Commissioner>().IsActive(), error = kErrorInvalidState);
74 VerifyOrExit((message = Get<Tmf::Agent>().NewPriorityMessage()) != nullptr, error = kErrorNoBufs);
75
76 SuccessOrExit(error = message->InitAsPost(aAddress, kUriEnergyScan));
77 SuccessOrExit(error = message->SetPayloadMarker());
78
79 SuccessOrExit(
80 error = Tlv::Append<MeshCoP::CommissionerSessionIdTlv>(*message, Get<MeshCoP::Commissioner>().GetSessionId()));
81
82 SuccessOrExit(error = MeshCoP::ChannelMaskTlv::AppendTo(*message, aChannelMask));
83
84 SuccessOrExit(error = Tlv::Append<MeshCoP::CountTlv>(*message, aCount));
85 SuccessOrExit(error = Tlv::Append<MeshCoP::PeriodTlv>(*message, aPeriod));
86 SuccessOrExit(error = Tlv::Append<MeshCoP::ScanDurationTlv>(*message, aScanDuration));
87
88 messageInfo.SetSockAddrToRlocPeerAddrTo(aAddress);
89 SuccessOrExit(error = Get<Tmf::Agent>().SendMessage(*message, messageInfo));
90
91 LogInfo("Sent %s", UriToString<kUriEnergyScan>());
92
93 mCallback.Set(aCallback, aContext);
94
95 exit:
96 FreeMessageOnError(message, error);
97 return error;
98 }
99
100 template <>
HandleTmf(Coap::Message & aMessage,const Ip6::MessageInfo & aMessageInfo)101 void EnergyScanClient::HandleTmf<kUriEnergyReport>(Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo)
102 {
103 uint32_t mask;
104 MeshCoP::EnergyListTlv energyListTlv;
105
106 VerifyOrExit(aMessage.IsConfirmablePostRequest());
107
108 LogInfo("Received %s", UriToString<kUriEnergyReport>());
109
110 SuccessOrExit(MeshCoP::ChannelMaskTlv::FindIn(aMessage, mask));
111
112 SuccessOrExit(MeshCoP::Tlv::FindTlv(aMessage, MeshCoP::Tlv::kEnergyList, sizeof(energyListTlv), energyListTlv));
113
114 mCallback.InvokeIfSet(mask, energyListTlv.GetEnergyList(), energyListTlv.GetEnergyListLength());
115
116 SuccessOrExit(Get<Tmf::Agent>().SendEmptyAck(aMessage, aMessageInfo));
117
118 LogInfo("Sent %s ack", UriToString<kUriEnergyReport>());
119
120 exit:
121 return;
122 }
123
124 } // namespace ot
125
126 #endif // OPENTHREAD_CONFIG_COMMISSIONER_ENABLE && OPENTHREAD_FTD
127
