A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
uan-6lowpan-example.cc
Go to the documentation of this file.
1/*
2 *
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License version 2 as
5 * published by the Free Software Foundation;
6 *
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
11 *
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15 *
16 * Author: Hossam Khader <hossamkhader@gmail.com>
17 */
18
19#include "ns3/acoustic-modem-energy-model-helper.h"
20#include "ns3/basic-energy-source-helper.h"
21#include "ns3/core-module.h"
22#include "ns3/energy-source-container.h"
23#include "ns3/internet-module.h"
24#include "ns3/mobility-helper.h"
25#include "ns3/mobility-model.h"
26#include "ns3/node-container.h"
27#include "ns3/sixlowpan-helper.h"
28#include "ns3/sixlowpan-net-device.h"
29#include "ns3/uan-channel.h"
30#include "ns3/uan-helper.h"
31
32using namespace ns3;
33
34/**
35 * \ingroup uan
36 *
37 * This example shows the usage of UDP over 6LoWPAN to transfer data.
38 * Two nodes are sending their remaining energy percentage (1 byte)
39 * to a gateway node, that prints the received data.
40 * The transmissions are scheduled at random times to avoid collisions
41 *
42 */
43
44NS_LOG_COMPONENT_DEFINE("Uan6lowpanExample");
45
47{
48 public:
50
51 /**
52 * Set the UAN nodes position
53 */
54 void SetupPositions();
55
56 /**
57 * Set the UAN nodes energy
58 */
59 void SetupEnergy();
60
61 /**
62 * Set the UAN nodes communication channels
63 */
65
66 /**
67 * Set the UAN nodes communication channels
68 */
69 void SetupApplications();
70
71 /**
72 * Send a packet from all the nodes
73 */
74 void SendPackets();
75
76 /**
77 * Send a packet from one of the nodes
78 * \param node The sending node
79 * \param pkt The packet
80 * \param dst the destination
81 */
83
84 /**
85 * Print the received packet
86 * \param socket The receiving socket
87 */
89
90 /**
91 * Prepare the experiment
92 */
93 void Prepare();
94
95 /**
96 * Teardown the experiment
97 */
98 void Teardown();
99
100 private:
101 NodeContainer m_nodes; //!< UAN nodes
102 std::map<Ptr<Node>, Ptr<Socket>> m_sockets; //!< send and receive sockets
103};
104
106{
107}
108
109void
111{
112 MobilityHelper mobilityHelper;
113 mobilityHelper.SetMobilityModel("ns3::ConstantPositionMobilityModel");
114 mobilityHelper.Install(m_nodes);
115 m_nodes.Get(0)->GetObject<MobilityModel>()->SetPosition(Vector(0, 0, 0));
116 m_nodes.Get(1)->GetObject<MobilityModel>()->SetPosition(Vector(100, 0, 0));
117 m_nodes.Get(2)->GetObject<MobilityModel>()->SetPosition(Vector(-100, 0, 0));
118}
119
120void
122{
123 BasicEnergySourceHelper energySourceHelper;
124 energySourceHelper.Set("BasicEnergySourceInitialEnergyJ", DoubleValue(900000));
125 energySourceHelper.Install(m_nodes);
126}
127
128void
130{
131 Ptr<UanChannel> channel = CreateObject<UanChannel>();
132 UanHelper uanHelper;
133 NetDeviceContainer netDeviceContainer = uanHelper.Install(m_nodes, channel);
134 EnergySourceContainer energySourceContainer;
135 auto node = m_nodes.Begin();
136 while (node != m_nodes.End())
137 {
138 energySourceContainer.Add((*node)->GetObject<EnergySourceContainer>()->Get(0));
139 node++;
140 }
141 AcousticModemEnergyModelHelper acousticModemEnergyModelHelper;
142 acousticModemEnergyModelHelper.Install(netDeviceContainer, energySourceContainer);
143
144 SixLowPanHelper sixLowPanHelper;
145 NetDeviceContainer sixlowpanNetDevices = sixLowPanHelper.Install(netDeviceContainer);
146
147 InternetStackHelper internetStackHelper;
148 internetStackHelper.Install(m_nodes);
149
150 Ipv6AddressHelper ipv6AddressHelper;
151 ipv6AddressHelper.SetBase(Ipv6Address("2002::"), Ipv6Prefix(64));
152 ipv6AddressHelper.Assign(sixlowpanNetDevices);
153
154 node = m_nodes.Begin();
155 while (node != m_nodes.End())
156 {
157 (*node)->GetObject<Icmpv6L4Protocol>()->SetAttribute("DAD", BooleanValue(false));
158 (*node)->GetObject<Icmpv6L4Protocol>()->SetAttribute("ReachableTime",
159 TimeValue(Seconds(3600)));
160 (*node)->GetObject<Icmpv6L4Protocol>()->SetAttribute("RetransmissionTime",
161 TimeValue(Seconds(1000)));
162 node++;
163 }
164}
165
166void
168{
169 Address srcAddress;
170 while (socket->GetRxAvailable() > 0)
171 {
172 Ptr<Packet> packet = socket->RecvFrom(srcAddress);
173 uint8_t energyReading;
174 packet->CopyData(&energyReading, 1);
175
177 {
178 NS_LOG_UNCOND("Time: " << Simulator::Now().GetHours() << "h"
179 << " | Node: "
180 << Inet6SocketAddress::ConvertFrom(srcAddress).GetIpv6()
181 << " | Energy: " << +energyReading << "%");
182 }
183 }
184}
185
186void
188{
189 auto node = m_nodes.Begin();
190 while (node != m_nodes.End())
191 {
192 m_sockets[*node] =
193 Socket::CreateSocket(*node, TypeId::LookupByName("ns3::UdpSocketFactory"));
194 if ((*node)->GetObject<Ipv6>())
195 {
197 m_sockets[*node]->Bind(ipv6_local);
198 }
199
200 m_sockets[*node]->SetRecvCallback(MakeCallback(&UanExperiment::PrintReceivedPacket, this));
201 node++;
202 }
203}
204
205void
207{
208 Ptr<UniformRandomVariable> uniformRandomVariable = CreateObject<UniformRandomVariable>();
209
210 auto node = m_nodes.Begin();
211 Ipv6Address dst =
212 (*node)->GetObject<Ipv6L3Protocol>()->GetInterface(1)->GetAddress(1).GetAddress();
213 node++;
214 while (node != m_nodes.End())
215 {
216 uint8_t energy =
217 ((*node)->GetObject<EnergySourceContainer>()->Get(0)->GetEnergyFraction()) * 100;
218
219 Ptr<Packet> pkt = Create<Packet>(&energy, 1);
220
221 double time = uniformRandomVariable->GetValue(0, 60);
222 Simulator::Schedule(Seconds(time), &UanExperiment::SendSinglePacket, this, *node, pkt, dst);
223 node++;
224 }
226}
227
228void
230{
231 NS_LOG_UNCOND(Simulator::Now().GetHours() << "h"
232 << " packet sent to " << dst);
234 m_sockets[node]->SendTo(pkt, 0, ipv6_destination);
235}
236
237void
239{
240 m_nodes.Create(3);
242 SetupEnergy();
245 SendPackets();
246}
247
248void
250{
251 for (auto socket = m_sockets.begin(); socket != m_sockets.end(); socket++)
252 {
253 socket->second->Close();
254 }
255}
256
257int
258main(int argc, char* argv[])
259{
260 CommandLine cmd(__FILE__);
261 cmd.Parse(argc, argv);
262
264 experiment.Prepare();
265
269
270 experiment.Teardown();
271
272 return 0;
273}
This example shows the usage of UDP over 6LoWPAN to transfer data.
void Teardown()
Teardown the experiment.
void PrintReceivedPacket(Ptr< Socket > socket)
Print the received packet.
NodeContainer m_nodes
UAN nodes.
void Prepare()
Prepare the experiment.
void SendSinglePacket(Ptr< Node > node, Ptr< Packet > pkt, Ipv6Address dst)
Send a packet from one of the nodes.
void SendPackets()
Send a packet from all the nodes.
void SetupCommunications()
Set the UAN nodes communication channels.
void SetupPositions()
Set the UAN nodes position.
std::map< Ptr< Node >, Ptr< Socket > > m_sockets
send and receive sockets
void SetupApplications()
Set the UAN nodes communication channels.
void SetupEnergy()
Set the UAN nodes energy.
Assign AcousticModemEnergyModel to uan devices.
a polymophic address class
Definition: address.h:101
Creates a BasicEnergySource object.
void Set(std::string name, const AttributeValue &v) override
AttributeValue implementation for Boolean.
Definition: boolean.h:37
Parse command-line arguments.
Definition: command-line.h:232
DeviceEnergyModelContainer Install(Ptr< NetDevice > device, Ptr< EnergySource > source) const
This class can be used to hold variables of floating point type such as 'double' or 'float'.
Definition: double.h:42
Holds a vector of ns3::EnergySource pointers.
Ptr< EnergySource > Get(uint32_t i) const
Get the i-th Ptr<EnergySource> stored in this container.
void Add(EnergySourceContainer container)
EnergySourceContainer Install(Ptr< Node > node) const
An implementation of the ICMPv6 protocol.
An Inet6 address class.
static Inet6SocketAddress ConvertFrom(const Address &addr)
Convert the address to a InetSocketAddress.
static bool IsMatchingType(const Address &addr)
If the address match.
aggregate IP/TCP/UDP functionality to existing Nodes.
void Install(std::string nodeName) const
Aggregate implementations of the ns3::Ipv4, ns3::Ipv6, ns3::Udp, and ns3::Tcp classes onto the provid...
Helper class to auto-assign global IPv6 unicast addresses.
void SetBase(Ipv6Address network, Ipv6Prefix prefix, Ipv6Address base=Ipv6Address("::1"))
Set the base network number, network prefix, and base interface ID.
Ipv6InterfaceContainer Assign(const NetDeviceContainer &c)
Allocate an Ipv6InterfaceContainer with auto-assigned addresses.
Describes an IPv6 address.
Definition: ipv6-address.h:49
static Ipv6Address GetAny()
Get the "any" (::) Ipv6Address.
static Ipv6Address ConvertFrom(const Address &address)
Convert the Address object into an Ipv6Address ones.
Access to the IPv6 forwarding table, interfaces, and configuration.
Definition: ipv6.h:82
Ipv6Address GetAddress() const
Get the IPv6 address.
IPv6 layer implementation.
Ipv6InterfaceAddress GetAddress(uint32_t interfaceIndex, uint32_t addressIndex) const override
Get an address.
Describes an IPv6 prefix.
Definition: ipv6-address.h:455
Helper class used to assign positions and mobility models to nodes.
void Install(Ptr< Node > node) const
"Layout" a single node according to the current position allocator type.
void SetMobilityModel(std::string type, Ts &&... args)
Keep track of the current position and velocity of an object.
holds a vector of ns3::NetDevice pointers
keep track of a set of node pointers.
Iterator End() const
Get an iterator which indicates past-the-last Node in the container.
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.
Iterator Begin() const
Get an iterator which refers to the first Node in the container.
Ptr< Node > Get(uint32_t i) const
Get the Ptr<Node> stored in this container at a given index.
Ptr< T > GetObject() const
Get a pointer to the requested aggregated Object.
Definition: object.h:522
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:77
static EventId Schedule(const Time &delay, FUNC f, Ts &&... args)
Schedule an event to expire after delay.
Definition: simulator.h:571
static void Destroy()
Execute the events scheduled with ScheduleDestroy().
Definition: simulator.cc:142
static Time Now()
Return the current simulation virtual time.
Definition: simulator.cc:208
static void Run()
Run the simulation.
Definition: simulator.cc:178
static void Stop()
Tell the Simulator the calling event should be the last one executed.
Definition: simulator.cc:186
Setup a sixlowpan stack to be used as a shim between IPv6 and a generic NetDevice.
NetDeviceContainer Install(NetDeviceContainer c)
Install the SixLoWPAN stack on top of an existing NetDevice.
static Ptr< Socket > CreateSocket(Ptr< Node > node, TypeId tid)
This method wraps the creation of sockets that is performed on a given node by a SocketFactory specif...
Definition: socket.cc:72
AttributeValue implementation for Time.
Definition: nstime.h:1413
static TypeId LookupByName(std::string name)
Get a TypeId by name.
Definition: type-id.cc:836
UAN configuration helper.
Definition: uan-helper.h:42
NetDeviceContainer Install(NodeContainer c) const
This method creates a simple ns3::UanChannel (with a default ns3::UanNoiseModelDefault and ns3::UanPr...
Definition: uan-helper.cc:145
void experiment(std::string queue_disc_type)
#define NS_LOG_UNCOND(msg)
Output the requested message unconditionally.
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1326
Time Days(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1290
Time Hours(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1302
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Callback< R, Args... > MakeCallback(R(T::*memPtr)(Args...), OBJ objPtr)
Build Callbacks for class method members which take varying numbers of arguments and potentially retu...
Definition: callback.h:704