A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
example-ping-lr-wpan-beacon.cc
Go to the documentation of this file.
1/*
2 * Copyright (c) 2020 Ritsumeikan University, Shiga, Japan
3 *
4 * SPDX-License-Identifier: GPL-2.0-only
5 *
6 * Author: Alberto Gallegos Ramonet <ramonet@fc.ritsumei.ac.jp>
7 */
8
9#include "ns3/core-module.h"
10#include "ns3/internet-apps-module.h"
11#include "ns3/internet-module.h"
12#include "ns3/lr-wpan-module.h"
13#include "ns3/mobility-module.h"
14#include "ns3/propagation-module.h"
15#include "ns3/sixlowpan-module.h"
16#include "ns3/spectrum-module.h"
17
18#include <fstream>
19
20using namespace ns3;
21using namespace ns3::lrwpan;
22
23static void
25{
26 // In the case of transmissions with the Ack flag activated, the transaction is only
27 // successful if the Ack was received.
28 if (params.m_status == MacStatus::SUCCESS)
29 {
30 std::cout << Simulator::Now().As(Time::S) << " | Node " << device->GetNode()->GetId()
31 << " | Transmission successfully sent\n";
32 }
33}
34
35int
36main(int argc, char** argv)
37{
38 bool verbose = false;
39
40 CommandLine cmd(__FILE__);
41 cmd.AddValue("verbose", "turn on log components", verbose);
42 cmd.Parse(argc, argv);
43
44 if (verbose)
45 {
48 LogComponentEnable("LrWpanCsmaCa", LOG_LEVEL_INFO);
49 LogComponentEnable("LrWpanHelper", LOG_LEVEL_ALL);
51 }
52
54 nodes.Create(2);
55
57 mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
58 mobility.SetPositionAllocator("ns3::GridPositionAllocator",
59 "MinX",
60 DoubleValue(0.0),
61 "MinY",
62 DoubleValue(0.0),
63 "DeltaX",
64 DoubleValue(20),
65 "DeltaY",
66 DoubleValue(20),
67 "GridWidth",
69 "LayoutType",
70 StringValue("RowFirst"));
71 mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
72 mobility.Install(nodes);
73
74 LrWpanHelper lrWpanHelper;
75 lrWpanHelper.SetPropagationDelayModel("ns3::ConstantSpeedPropagationDelayModel");
76 lrWpanHelper.AddPropagationLossModel("ns3::LogDistancePropagationLossModel");
77 // Add and install the LrWpanNetDevice for each node
78 NetDeviceContainer lrwpanDevices = lrWpanHelper.Install(nodes);
79
80 Ptr<LrWpanNetDevice> dev1 = lrwpanDevices.Get(0)->GetObject<LrWpanNetDevice>();
81 Ptr<LrWpanNetDevice> dev2 = lrwpanDevices.Get(1)->GetObject<LrWpanNetDevice>();
82
83 dev1->GetMac()->SetMcpsDataConfirmCallback(MakeBoundCallback(&DataSentMacConfirm, dev1));
84
85 dev2->GetMac()->SetMcpsDataConfirmCallback(MakeBoundCallback(&DataSentMacConfirm, dev2));
86
87 // Manual PAN association, coordinator assignment, short address assignment and initialization
88 // of beacon-enabled mode in 802.15.4-2011.
89 // Association using the MAC functions can also be used instead of a manual association.
90
91 // AssociateToBeaconPan (devices, PAN ID, Coordinator Address, Beacon Order, Superframe Order)
92
93 // Must be careful not setting the beacon order (BO) and the superframe order (SO) too far apart
94 // or the ping reply (ICMPV6 echo reply) can time out during the inactive period of the
95 // superframe. A full time table of the BO/SO time equivalence can be found at the end of this
96 // document. The current configuration is BO = 14, SO = 13 :
97
98 // Contention Access Period (CAP) Inactive
99 // (125.82912 secs) (125.82088)
100 // |---------------------------------------------|-------------------------------------------|
101 // Beacon Beacon
102 // Beacon Interval = 251.65 secs
103 // |-----------------------------------------------------------------------------------------|
104
105 // Manually set an associated PAN, Pan id = 1 the first device (dev1) is used as coordinator
106 lrWpanHelper.CreateAssociatedPan(lrwpanDevices, 5);
107
108 // Start the beacon mode from the MAC layer of the coordinator (dev1)
110 params.m_panCoor = true;
111 params.m_PanId = 5;
112 params.m_bcnOrd = 14;
113 params.m_sfrmOrd = 13;
114 params.m_logCh = 11;
115
116 Simulator::ScheduleWithContext(dev1->GetNode()->GetId(),
117 Seconds(0),
119 dev1->GetMac(),
120 params);
121
122 InternetStackHelper internetv6;
123 internetv6.Install(nodes);
124
125 SixLowPanHelper sixlowpan;
126 NetDeviceContainer devices = sixlowpan.Install(lrwpanDevices);
127
129 ipv6.SetBase(Ipv6Address("2001:2::"), Ipv6Prefix(64));
130 Ipv6InterfaceContainer deviceInterfaces;
131 deviceInterfaces = ipv6.Assign(devices);
132
133 // Send ping packets after the 2nd second of the simulation during the
134 // first 8 seconds of the CAP in the incoming superframe
135
136 uint32_t packetSize = 16;
137 uint32_t maxPacketCount = 5;
138 Time interPacketInterval = Seconds(1);
139 PingHelper ping(deviceInterfaces.GetAddress(1, 1));
140
141 ping.SetAttribute("Count", UintegerValue(maxPacketCount));
142 ping.SetAttribute("Interval", TimeValue(interPacketInterval));
143 ping.SetAttribute("Size", UintegerValue(packetSize));
144 ApplicationContainer apps = ping.Install(nodes.Get(0));
145
146 apps.Start(Seconds(2.0));
147 apps.Stop(Seconds(7.0));
148
149 AsciiTraceHelper ascii;
150 lrWpanHelper.EnableAsciiAll(ascii.CreateFileStream("Ping-6LoW-lr-wpan-beacon.tr"));
151 lrWpanHelper.EnablePcapAll(std::string("Ping-6LoW-lr-wpan-beacon"), true);
152
154
157
158 return 0;
159}
160
161// BO/SO values to time equivalence
162// These times are only valid for a 250kbps O-QPSK modulation,
163// times differ with other modulation configurations.
164
165// +------------------------+
166// | BO/SO | Time (secs) |
167// +------------------------+
168// | 0 | 0.01536 secs |
169// | 1 | 0.03072 secs |
170// | 2 | 0.06144 secs |
171// | 3 | 0.12288 secs |
172// | 4 | 0.24576 secs |
173// | 5 | 0.49152 secs |
174// | 6 | 0.98304 secs |
175// | 7 | 1.96608 secs |
176// | 8 | 3.93216 secs |
177// | 9 | 7.86432 secs |
178// | 10 | 15.72864 secs |
179// | 11 | 31.45728 secs |
180// | 12 | 62.91456 secs |
181// | 13 | 125.82912 secs |
182// | 14 | 251.65 secs |
183// +------------------------+
holds a vector of ns3::Application pointers.
void Start(Time start) const
Start all of the Applications in this container at the start time given as a parameter.
void Stop(Time stop) const
Arrange for all of the Applications in this container to Stop() at the Time given as a parameter.
void EnableAsciiAll(std::string prefix)
Enable ascii trace output on each device (which is of the appropriate type) in the set of all nodes c...
Manage ASCII trace files for device models.
Ptr< OutputStreamWrapper > CreateFileStream(std::string filename, std::ios::openmode filemode=std::ios::out)
Create and initialize an output stream object we'll use to write the traced bits.
Parse command-line arguments.
This class can be used to hold variables of floating point type such as 'double' or 'float'.
Definition double.h:31
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.
Keep track of a set of IPv6 interfaces.
Ipv6Address GetAddress(uint32_t i, uint32_t j) const
Get the address for the specified index.
Describes an IPv6 prefix.
helps to manage and create IEEE 802.15.4 NetDevice objects
void CreateAssociatedPan(NetDeviceContainer c, uint16_t panId)
Creates an PAN with associated nodes and assigned addresses(16 and 64) from the nodes in the node con...
NetDeviceContainer Install(NodeContainer c)
Install a LrWpanNetDevice and the associated structures (e.g., channel) in the nodes.
void SetPropagationDelayModel(std::string name, Ts &&... args)
void AddPropagationLossModel(std::string name, Ts &&... args)
Helper class used to assign positions and mobility models to nodes.
holds a vector of ns3::NetDevice pointers
Ptr< NetDevice > Get(uint32_t i) const
Get the Ptr<NetDevice> stored in this container at a given index.
keep track of a set of node pointers.
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.
Ptr< Node > Get(uint32_t i) const
Get the Ptr<Node> stored in this container at a given index.
void EnablePcapAll(std::string prefix, bool promiscuous=false)
Enable pcap output on each device (which is of the appropriate type) in the set of all nodes created ...
Create a ping application and associate it to a node.
Definition ping-helper.h:31
Smart pointer class similar to boost::intrusive_ptr.
static void Destroy()
Execute the events scheduled with ScheduleDestroy().
Definition simulator.cc:131
static void ScheduleWithContext(uint32_t context, const Time &delay, FUNC f, Ts &&... args)
Schedule an event with the given context.
Definition simulator.h:577
static Time Now()
Return the current simulation virtual time.
Definition simulator.cc:197
static void Run()
Run the simulation.
Definition simulator.cc:167
static void Stop()
Tell the Simulator the calling event should be the last one executed.
Definition simulator.cc:175
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.
Hold variables of type string.
Definition string.h:45
Simulation virtual time values and global simulation resolution.
Definition nstime.h:94
TimeWithUnit As(const Unit unit=Time::AUTO) const
Attach a unit to a Time, to facilitate output in a specific unit.
Definition time.cc:404
@ S
second
Definition nstime.h:105
Hold an unsigned integer type.
Definition uinteger.h:34
void MlmeStartRequest(MlmeStartRequestParams params) override
IEEE 802.15.4-2006, section 7.1.14.1 MLME-START.request Request to allow a PAN coordinator to initiat...
Network layer to device interface.
static void DataSentMacConfirm(Ptr< LrWpanNetDevice > device, McpsDataConfirmParams params)
auto MakeBoundCallback(R(*fnPtr)(Args...), BArgs &&... bargs)
Make Callbacks with varying number of bound arguments.
Definition callback.h:745
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition nstime.h:1308
NodeContainer nodes
devices
Definition first.py:31
Every class exported by the ns3 library is enclosed in the ns3 namespace.
void LogComponentEnable(const std::string &name, LogLevel level)
Enable the logging output associated with that log component.
Definition log.cc:291
LogLevel
Logging severity classes and levels.
Definition log.h:83
@ LOG_LEVEL_ALL
Print everything.
Definition log.h:105
@ LOG_PREFIX_FUNC
Prefix all trace prints with function.
Definition log.h:107
@ LOG_PREFIX_TIME
Prefix all trace prints with simulation time.
Definition log.h:108
@ LOG_PREFIX_NODE
Prefix all trace prints with simulation node.
Definition log.h:109
@ LOG_LEVEL_INFO
LOG_INFO and above.
Definition log.h:93
void LogComponentEnableAll(LogLevel level)
Enable the logging output for all registered log components.
Definition log.cc:309
mobility
Definition third.py:92
params
Fit Fluctuating Two Ray model to the 3GPP TR 38.901 using the Anderson-Darling goodness-of-fit ##.
bool verbose
static const uint32_t packetSize
Packet size generated at the AP.