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