sat-lora-example.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014 Magister Solutions
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Bastien Tauran <bastien.tauran@viveris.fr>
19  *
20  */
21 
22 #include "ns3/applications-module.h"
23 #include "ns3/config-store-module.h"
24 #include "ns3/core-module.h"
25 #include "ns3/internet-module.h"
26 #include "ns3/network-module.h"
27 #include "ns3/satellite-module.h"
28 #include "ns3/traffic-module.h"
29 
30 using namespace ns3;
31 
39 NS_LOG_COMPONENT_DEFINE("sat-lora-example");
40 
41 int
42 main(int argc, char* argv[])
43 {
44  // Variables
45  std::string beams = "3 4 5 6";
46  // std::string beams = "8";
47  uint32_t nbGwUser = 1;
48  uint32_t nbUtsPerBeam = 100;
49  uint32_t nbEndUsersPerUt = 1;
50 
51  Time appStartTime = Seconds(0.001);
52  Time simLength = Seconds(15.0);
53 
54  uint32_t packetSize = 24;
55  Time loraInterval = Seconds(10);
56  std::string interval = "10s";
57 
58  double frameAllocatedBandwidthHz = 15000;
59  double frameCarrierAllocatedBandwidthHz = 15000;
60  double frameCarrierRollOff = 0.22;
61  double frameCarrierSpacing = 0;
62  uint32_t frameSpreadingFactor = 256;
63 
64  bool interferenceModePerPacket = true;
65  bool displayTraces = true;
66 
67  Time firstWindowDelay = MilliSeconds(1500);
68  Time secondWindowDelay = Seconds(2);
69  Time firstWindowDuration = MilliSeconds(400);
70  Time secondWindowDuration = MilliSeconds(400);
71  Time firstWindowAnswerDelay = Seconds(1);
72  Time secondWindowAnswerDelay = Seconds(2);
73 
74  Ptr<SimulationHelper> simulationHelper = CreateObject<SimulationHelper>("example-lora");
75 
76  // read command line parameters given by user
77  CommandLine cmd;
78  cmd.AddValue("modelPP", "interferenceModePerPacket", interferenceModePerPacket);
79  cmd.AddValue("traces", "displayTraces", displayTraces);
80  cmd.AddValue("utsPerBeam", "Number of UTs per spot-beam", nbUtsPerBeam);
81  cmd.AddValue("simLength", "Simulation duration in seconds", simLength);
82  cmd.AddValue("packetSize", "Constant packet size in bytes", packetSize);
83  cmd.AddValue("loraInterval",
84  "Interval between two transmissions for each UT in seconds",
85  loraInterval);
86  cmd.AddValue("frameAllocatedBandwidthHz",
87  "Allocated bandwidth in Hz",
88  frameAllocatedBandwidthHz);
89  cmd.AddValue("frameCarrierAllocatedBandwidthHz",
90  "Allocated carrier bandwidth in Hz",
91  frameCarrierAllocatedBandwidthHz);
92  cmd.AddValue("frameCarrierRollOff", "Roll-off factor", frameCarrierRollOff);
93  cmd.AddValue("frameCarrierSpacing", "Carrier spacing factor", frameCarrierSpacing);
94  cmd.AddValue("frameSpreadingFactor", "Carrier spreading factor", frameSpreadingFactor);
95 
96  cmd.AddValue("firstWindowDelay",
97  "Delay between end of transmission and opening of first window on End Device",
98  firstWindowDelay);
99  cmd.AddValue("secondWindowDelay",
100  "Delay between end of transmission and opening of second window on End Device",
101  secondWindowDelay);
102  cmd.AddValue("firstWindowDuration", "First window duration on End Device", firstWindowDuration);
103  cmd.AddValue("secondWindowDuration",
104  "Second window duration on End Device",
105  secondWindowDuration);
106  cmd.AddValue("firstWindowAnswerDelay",
107  "Delay between end of reception and start of ack on first window on Gateway",
108  firstWindowAnswerDelay);
109  cmd.AddValue("secondWindowAnswerDelay",
110  "Delay between end of reception and start of ack on second window on Gateway",
111  secondWindowAnswerDelay);
112  simulationHelper->AddDefaultUiArguments(cmd);
113  cmd.Parse(argc, argv);
114 
116  Config::SetDefault("ns3::SatConf::ForwardLinkRegenerationMode",
117  EnumValue(SatEnums::TRANSPARENT));
118  Config::SetDefault("ns3::SatConf::ReturnLinkRegenerationMode",
119  EnumValue(SatEnums::TRANSPARENT));
120 
121  // Enable Lora
122  Config::SetDefault("ns3::SatHelper::Standard", EnumValue(SatEnums::LORA));
123  Config::SetDefault("ns3::LorawanMacEndDevice::DataRate", UintegerValue(5));
124  Config::SetDefault("ns3::LorawanMacEndDevice::MType",
125  EnumValue(LorawanMacHeader::CONFIRMED_DATA_UP));
126  Config::SetDefault("ns3::SatLorawanNetDevice::ForwardToUtUsers", BooleanValue(true));
127 
128  // Config::SetDefault ("ns3::SatLoraConf::Standard", EnumValue (SatLoraConf::EU863_870));
129  Config::SetDefault("ns3::SatLoraConf::Standard", EnumValue(SatLoraConf::SATELLITE));
130 
131  Config::SetDefault("ns3::LorawanMacEndDeviceClassA::FirstWindowDelay",
132  TimeValue(firstWindowDelay));
133  Config::SetDefault("ns3::LorawanMacEndDeviceClassA::SecondWindowDelay",
134  TimeValue(secondWindowDelay));
135  Config::SetDefault("ns3::LorawanMacEndDeviceClassA::FirstWindowDuration",
136  TimeValue(firstWindowDuration));
137  Config::SetDefault("ns3::LorawanMacEndDeviceClassA::SecondWindowDuration",
138  TimeValue(secondWindowDuration));
139  Config::SetDefault("ns3::LoraNetworkScheduler::FirstWindowAnswerDelay",
140  TimeValue(firstWindowAnswerDelay));
141  Config::SetDefault("ns3::LoraNetworkScheduler::SecondWindowAnswerDelay",
142  TimeValue(secondWindowAnswerDelay));
143 
144  // Defaults
145  Config::SetDefault("ns3::SatEnvVariables::EnableSimulationOutputOverwrite", BooleanValue(true));
146  Config::SetDefault("ns3::SatHelper::PacketTraceEnabled", BooleanValue(true));
147 
148  // Superframe configuration
149  Config::SetDefault("ns3::SatConf::SuperFrameConfForSeq0",
150  EnumValue(SatSuperframeConf::SUPER_FRAME_CONFIG_4));
151  Config::SetDefault("ns3::SatSuperframeConf4::FrameConfigType",
152  EnumValue(SatSuperframeConf::CONFIG_TYPE_4));
153  Config::SetDefault("ns3::SatSuperframeConf4::Frame0_AllocatedBandwidthHz",
154  DoubleValue(frameAllocatedBandwidthHz));
155  Config::SetDefault("ns3::SatSuperframeConf4::Frame0_CarrierAllocatedBandwidthHz",
156  DoubleValue(frameCarrierAllocatedBandwidthHz));
157  Config::SetDefault("ns3::SatSuperframeConf4::Frame0_CarrierRollOff",
158  DoubleValue(frameCarrierRollOff));
159  Config::SetDefault("ns3::SatSuperframeConf4::Frame0_CarrierSpacing",
160  DoubleValue(frameCarrierSpacing));
161  Config::SetDefault("ns3::SatSuperframeConf4::Frame0_SpreadingFactor",
162  UintegerValue(frameSpreadingFactor));
163 
164  // CRDSA only
165  Config::SetDefault("ns3::SatLowerLayerServiceConf::DaServiceCount", UintegerValue(4));
166  Config::SetDefault("ns3::SatLowerLayerServiceConf::DaService0_ConstantAssignmentProvided",
167  BooleanValue(false));
168  Config::SetDefault("ns3::SatLowerLayerServiceConf::DaService0_RbdcAllowed",
169  BooleanValue(false));
170  Config::SetDefault("ns3::SatLowerLayerServiceConf::DaService0_VolumeAllowed",
171  BooleanValue(false));
172  Config::SetDefault("ns3::SatLowerLayerServiceConf::DaService1_ConstantAssignmentProvided",
173  BooleanValue(false));
174  Config::SetDefault("ns3::SatLowerLayerServiceConf::DaService1_RbdcAllowed",
175  BooleanValue(false));
176  Config::SetDefault("ns3::SatLowerLayerServiceConf::DaService1_VolumeAllowed",
177  BooleanValue(false));
178  Config::SetDefault("ns3::SatLowerLayerServiceConf::DaService2_ConstantAssignmentProvided",
179  BooleanValue(false));
180  Config::SetDefault("ns3::SatLowerLayerServiceConf::DaService2_RbdcAllowed",
181  BooleanValue(false));
182  Config::SetDefault("ns3::SatLowerLayerServiceConf::DaService2_VolumeAllowed",
183  BooleanValue(false));
184  Config::SetDefault("ns3::SatLowerLayerServiceConf::DaService3_ConstantAssignmentProvided",
185  BooleanValue(false));
186  Config::SetDefault("ns3::SatLowerLayerServiceConf::DaService3_RbdcAllowed",
187  BooleanValue(false));
188  Config::SetDefault("ns3::SatLowerLayerServiceConf::DaService3_VolumeAllowed",
189  BooleanValue(false));
190 
191  // Configure RA
192  Config::SetDefault("ns3::SatGeoHelper::FwdLinkErrorModel",
193  EnumValue(SatPhyRxCarrierConf::EM_AVI));
194  Config::SetDefault("ns3::SatGeoHelper::RtnLinkErrorModel",
195  EnumValue(SatPhyRxCarrierConf::EM_AVI));
196  Config::SetDefault("ns3::SatBeamHelper::RandomAccessModel", EnumValue(SatEnums::RA_MODEL_ESSA));
197  if (interferenceModePerPacket)
198  {
199  Config::SetDefault("ns3::SatBeamHelper::RaInterferenceModel",
200  EnumValue(SatPhyRxCarrierConf::IF_PER_PACKET));
201  }
202  else
203  {
204  Config::SetDefault("ns3::SatBeamHelper::RaInterferenceModel",
205  EnumValue(SatPhyRxCarrierConf::IF_PER_FRAGMENT));
206  }
207  Config::SetDefault("ns3::SatBeamHelper::RaInterferenceEliminationModel",
208  EnumValue(SatPhyRxCarrierConf::SIC_RESIDUAL));
209  Config::SetDefault("ns3::SatBeamHelper::RaCollisionModel",
210  EnumValue(SatPhyRxCarrierConf::RA_COLLISION_CHECK_AGAINST_SINR));
211  Config::SetDefault("ns3::SatBeamHelper::ReturnLinkLinkResults", EnumValue(SatEnums::LR_LORA));
212  Config::SetDefault("ns3::SatWaveformConf::DefaultWfId", UintegerValue(2));
213  Config::SetDefault("ns3::SatHelper::RtnLinkWaveformConfFileName",
214  StringValue("loraWaveforms.txt"));
215 
216  Config::SetDefault("ns3::SatPhyRxCarrierPerWindow::WindowDuration", StringValue("600ms"));
217  Config::SetDefault("ns3::SatPhyRxCarrierPerWindow::WindowStep", StringValue("200ms"));
218  Config::SetDefault("ns3::SatPhyRxCarrierPerWindow::WindowDelay", StringValue("0s"));
219  Config::SetDefault("ns3::SatPhyRxCarrierPerWindow::FirstWindow", StringValue("0s"));
220  Config::SetDefault("ns3::SatPhyRxCarrierPerWindow::WindowSICIterations", UintegerValue(5));
221  Config::SetDefault("ns3::SatPhyRxCarrierPerWindow::SpreadingFactor", UintegerValue(1));
222  Config::SetDefault("ns3::SatPhyRxCarrierPerWindow::DetectionThreshold", DoubleValue(0));
223  Config::SetDefault("ns3::SatPhyRxCarrierPerWindow::EnableSIC", BooleanValue(false));
224 
225  // Set random access parameters
226  Config::SetDefault("ns3::SatLowerLayerServiceConf::RaService0_MaximumUniquePayloadPerBlock",
227  UintegerValue(3));
228  Config::SetDefault("ns3::SatLowerLayerServiceConf::RaService0_MaximumConsecutiveBlockAccessed",
229  UintegerValue(6));
230  Config::SetDefault("ns3::SatLowerLayerServiceConf::RaService0_MinimumIdleBlock",
231  UintegerValue(2));
232  Config::SetDefault("ns3::SatLowerLayerServiceConf::RaService0_BackOffTimeInMilliSeconds",
233  UintegerValue(50));
234  Config::SetDefault("ns3::SatLowerLayerServiceConf::RaService0_BackOffProbability",
235  UintegerValue(1));
236  Config::SetDefault("ns3::SatLowerLayerServiceConf::RaService0_HighLoadBackOffProbability",
237  UintegerValue(1));
238  Config::SetDefault(
239  "ns3::SatLowerLayerServiceConf::RaService0_AverageNormalizedOfferedLoadThreshold",
240  DoubleValue(0.99));
241  Config::SetDefault("ns3::SatLowerLayerServiceConf::RaService0_NumberOfInstances",
242  UintegerValue(3));
243  Config::SetDefault("ns3::SatLowerLayerServiceConf::RaService0_SlottedAlohaAllowed",
244  BooleanValue(false));
245  Config::SetDefault("ns3::SatLowerLayerServiceConf::RaService0_CrdsaAllowed",
246  BooleanValue(false));
247  Config::SetDefault("ns3::SatLowerLayerServiceConf::RaService0_EssaAllowed", BooleanValue(true));
248 
249  // Traffics
250  simulationHelper->SetSimulationTime(simLength);
251 
252  simulationHelper->SetGwUserCount(nbGwUser);
253  simulationHelper->SetUtCountPerBeam(nbUtsPerBeam);
254  simulationHelper->SetUserCountPerUt(nbEndUsersPerUt);
255  simulationHelper->SetBeams(beams);
256 
257  simulationHelper->CreateSatScenario();
258 
259  Config::SetDefault("ns3::CbrApplication::Interval", StringValue(interval));
260  Config::SetDefault("ns3::CbrApplication::PacketSize", UintegerValue(packetSize));
261 
262  simulationHelper->InstallLoraTrafficModel(SimulationHelper::LORA_CBR,
263  loraInterval,
264  packetSize,
265  appStartTime,
266  simLength,
267  Seconds(1));
268 
269  /*simulationHelper->InstallLoraTrafficModel (
270  SimulationHelper::PERIODIC,
271  loraInterval,
272  packetSize,
273  appStartTime, simLength, Seconds (1));*/
274 
275  // Outputs
276  simulationHelper->EnableProgressLogs();
277 
278  std::string outputPath = Singleton<SatEnvVariables>::Get()->LocateDirectory(
279  "contrib/satellite/data/sims/example-lora");
280  Config::SetDefault("ns3::ConfigStore::Filename",
281  StringValue(outputPath + "/output-attributes.xml"));
282  Config::SetDefault("ns3::ConfigStore::FileFormat", StringValue("Xml"));
283  Config::SetDefault("ns3::ConfigStore::Mode", StringValue("Save"));
284  ConfigStore outputConfig;
285  outputConfig.ConfigureDefaults();
286 
287  if (displayTraces)
288  {
289  Ptr<SatStatsHelperContainer> s = simulationHelper->GetStatisticsContainer();
290 
291  s->AddGlobalFeederEssaPacketError(SatStatsHelper::OUTPUT_SCALAR_FILE);
292  s->AddGlobalFeederEssaPacketError(SatStatsHelper::OUTPUT_SCATTER_FILE);
293  s->AddPerUtFeederEssaPacketError(SatStatsHelper::OUTPUT_SCALAR_FILE);
294  s->AddPerUtFeederEssaPacketError(SatStatsHelper::OUTPUT_SCATTER_FILE);
295 
296  s->AddGlobalFeederEssaPacketCollision(SatStatsHelper::OUTPUT_SCALAR_FILE);
297  s->AddGlobalFeederEssaPacketCollision(SatStatsHelper::OUTPUT_SCATTER_FILE);
298  s->AddPerUtFeederEssaPacketCollision(SatStatsHelper::OUTPUT_SCALAR_FILE);
299  s->AddPerUtFeederEssaPacketCollision(SatStatsHelper::OUTPUT_SCATTER_FILE);
300 
301  s->AddGlobalRtnFeederWindowLoad(SatStatsHelper::OUTPUT_SCALAR_FILE);
302  s->AddGlobalRtnFeederWindowLoad(SatStatsHelper::OUTPUT_SCATTER_FILE);
303  s->AddPerBeamRtnFeederWindowLoad(SatStatsHelper::OUTPUT_SCALAR_FILE);
304  s->AddPerBeamRtnFeederWindowLoad(SatStatsHelper::OUTPUT_SCATTER_FILE);
305 
306  s->AddGlobalRtnAppThroughput(SatStatsHelper::OUTPUT_SCALAR_FILE);
307  s->AddGlobalRtnFeederMacThroughput(SatStatsHelper::OUTPUT_SCALAR_FILE);
308  s->AddGlobalRtnAppThroughput(SatStatsHelper::OUTPUT_SCATTER_FILE);
309  s->AddGlobalRtnFeederMacThroughput(SatStatsHelper::OUTPUT_SCATTER_FILE);
310 
311  s->AddPerUtRtnAppThroughput(SatStatsHelper::OUTPUT_SCALAR_FILE);
312  s->AddPerUtRtnFeederMacThroughput(SatStatsHelper::OUTPUT_SCALAR_FILE);
313  s->AddPerUtRtnAppThroughput(SatStatsHelper::OUTPUT_SCATTER_FILE);
314  s->AddPerUtRtnFeederMacThroughput(SatStatsHelper::OUTPUT_SCATTER_FILE);
315 
316  s->AddPerUtRtnAppDelay(SatStatsHelper::OUTPUT_SCALAR_FILE);
317  s->AddPerUtRtnMacDelay(SatStatsHelper::OUTPUT_SCALAR_FILE);
318  s->AddPerUtRtnAppDelay(SatStatsHelper::OUTPUT_SCATTER_FILE);
319  s->AddPerUtRtnMacDelay(SatStatsHelper::OUTPUT_SCATTER_FILE);
320 
321  s->AddGlobalRtnCompositeSinr(SatStatsHelper::OUTPUT_SCALAR_FILE);
322  s->AddGlobalRtnCompositeSinr(SatStatsHelper::OUTPUT_SCATTER_FILE);
323  s->AddPerUtRtnCompositeSinr(SatStatsHelper::OUTPUT_SCALAR_FILE);
324  s->AddPerUtRtnCompositeSinr(SatStatsHelper::OUTPUT_SCATTER_FILE);
325 
326  s->AddGlobalRtnFeederLinkSinr(SatStatsHelper::OUTPUT_SCALAR_FILE);
327  s->AddGlobalRtnFeederLinkSinr(SatStatsHelper::OUTPUT_SCATTER_FILE);
328  s->AddGlobalRtnUserLinkSinr(SatStatsHelper::OUTPUT_SCALAR_FILE);
329  s->AddGlobalRtnUserLinkSinr(SatStatsHelper::OUTPUT_SCATTER_FILE);
330 
331  s->AddGlobalRtnFeederLinkRxPower(SatStatsHelper::OUTPUT_SCALAR_FILE);
332  s->AddGlobalRtnFeederLinkRxPower(SatStatsHelper::OUTPUT_SCATTER_FILE);
333  s->AddGlobalRtnUserLinkRxPower(SatStatsHelper::OUTPUT_SCALAR_FILE);
334  s->AddGlobalRtnUserLinkRxPower(SatStatsHelper::OUTPUT_SCATTER_FILE);
335 
336  s->AddPerUtFwdAppThroughput(SatStatsHelper::OUTPUT_SCALAR_FILE);
337  s->AddPerUtFwdUserMacThroughput(SatStatsHelper::OUTPUT_SCALAR_FILE);
338  s->AddPerUtFwdAppThroughput(SatStatsHelper::OUTPUT_SCATTER_FILE);
339  s->AddPerUtFwdUserMacThroughput(SatStatsHelper::OUTPUT_SCATTER_FILE);
340 
341  s->AddGlobalFwdAppThroughput(SatStatsHelper::OUTPUT_SCALAR_FILE);
342  s->AddGlobalFwdUserMacThroughput(SatStatsHelper::OUTPUT_SCALAR_FILE);
343  s->AddGlobalFwdAppThroughput(SatStatsHelper::OUTPUT_SCATTER_FILE);
344  s->AddGlobalFwdUserMacThroughput(SatStatsHelper::OUTPUT_SCATTER_FILE);
345 
346  s->AddPerUtFwdAppDelay(SatStatsHelper::OUTPUT_SCALAR_FILE);
347  s->AddPerUtFwdMacDelay(SatStatsHelper::OUTPUT_SCALAR_FILE);
348  s->AddPerUtFwdAppDelay(SatStatsHelper::OUTPUT_SCATTER_FILE);
349  s->AddPerUtFwdMacDelay(SatStatsHelper::OUTPUT_SCATTER_FILE);
350  }
351 
352  simulationHelper->RunSimulation();
353 
354  return 0;
355 
356 } // end of `int main (int argc, char *argv[])`
ns3::SatLoraConf::SATELLITE
@ SATELLITE
For Satellite.
Definition: satellite-lora-conf.h:40
ns3::SatSuperframeConf::SUPER_FRAME_CONFIG_4
@ SUPER_FRAME_CONFIG_4
SUPER_FRAME_CONFIG_4.
Definition: satellite-frame-conf.h:527
ns3::SatSuperframeConf::CONFIG_TYPE_4
@ CONFIG_TYPE_4
Configuration type 4 (ESSA)
Definition: satellite-frame-conf.h:544
ns3
SatArqSequenceNumber is handling the sequence numbers for the ARQ process.
Definition: sat-link-results-plot.cc:40