examples/ns3_wifi_hidden_terminal.py

   1 #!/usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3
   4 #
   5 # Experiment Topology:
   6 #
   7 #  n1 --- n2 --- n3
   8 #
   9 #
  10 # This example is based on the ns-3 wifi-hidden-terminal.cc example.
  11 #
  12
  13 from nepi.core.design import ExperimentDescription, FactoriesProvider
  14 from nepi.core.execute import ExperimentController
  15 import tempfile
  16 import time
  17
  18 def create_node(ns3_desc):
  19     node = ns3_desc.create("ns3::Node")
  20     ipv4 = ns3_desc.create("ns3::Ipv4L3Protocol")
  21     arp  = ns3_desc.create("ns3::ArpL3Protocol")
  22     icmp = ns3_desc.create("ns3::Icmpv4L4Protocol")
  23     udp = ns3_desc.create("ns3::UdpL4Protocol")
  24     tcp = ns3_desc.create("ns3::TcpL4Protocol")
  25     node.connector("protos").connect(ipv4.connector("node"))
  26     node.connector("protos").connect(arp.connector("node"))
  27     node.connector("protos").connect(icmp.connector("node"))
  28     node.connector("protos").connect(udp.connector("node"))
  29     node.connector("protos").connect(tcp.connector("node"))
  30     mobility = ns3_desc.create("ns3::ConstantPositionMobilityModel")
  31     node.connector("mobility").connect(mobility.connector("node"))
  32
  33     return (node, mobility)
  34
  35 def create_wifi_device(ns3_desc, node, channel):
  36     dev = ns3_desc.create("ns3::WifiNetDevice")
  37     node.connector("devs").connect(dev.connector("node"))
  38     manager = ns3_desc.create("ns3::ConstantRateWifiManager")
  39     manager.set_attribute_value("DataMode", "DsssRate2Mbps")
  40     manager.set_attribute_value("ControlMode", "DsssRate1Mbps")
  41     dev.connector("manager").connect(manager.connector("dev"))
  42
  43     mac = ns3_desc.create("ns3::AdhocWifiMac")
  44     mac.set_attribute_value("Standard",  "WIFI_PHY_STANDARD_80211b")
  45     mac.set_attribute_value("QosSupported", False)
  46     dev.connector("mac").connect(mac.connector("dev"))
  47
  48     phy = ns3_desc.create("ns3::YansWifiPhy")
  49     phy.set_attribute_value("Standard",  "WIFI_PHY_STANDARD_80211b")
  50     dev.connector("phy").connect(phy.connector("dev"))
  51     channel.connector("phys").connect(phy.connector("chan"))
  52     error = ns3_desc.create("ns3::NistErrorRateModel")
  53     phy.connector("err").connect(error.connector("phy"))
  54
  55     return dev
  56
  57 root_dir = tempfile.mkdtemp()
  58
  59 exp_desc = ExperimentDescription()
  60
  61 testbed_id = "ns3"
  62 ns3_provider = FactoriesProvider(testbed_id)
  63 ns3_desc = exp_desc.add_testbed_description(ns3_provider)
  64 ns3_desc.set_attribute_value("homeDirectory", root_dir)
  65 #ns3_desc.set_attribute_value("SimulatorImplementationType", "ns3::RealtimeSimulatorImpl")
  66 #ns3_desc.set_attribute_value("ChecksumEnabled", True)
  67
  68 # 0. Enable or disable CTS/RTS
  69 # ??
  70
  71 # 1 & 2 & 6. Create 3 nodes with their mobility models, and Install TCP/IP stack & assign IP addresses
  72 (node1, mob1) = create_node(ns3_desc)
  73 (node2, mob2) = create_node(ns3_desc)
  74 (node3, mob3) = create_node(ns3_desc)
  75
  76 #  3. Create propagation loss matrix
  77 matrix = ns3_desc.create("ns3::MatrixPropagationLossModel")
  78 matrix.set_attribute_value("DefaultLoss", 200.0)
  79
  80 mp1 = ns3_desc.create("ns3::Nepi::MobilityPair")
  81 mp1.connector("matrix").connect(matrix.connector("mobpair"))
  82 mp1.set_attribute_value("Loss", 50.0)
  83 mp1.connector("ma").connect(mob1.connector("mp"))
  84 mp1.connector("mb").connect(mob2.connector("mp"))
  85
  86 mp2 = ns3_desc.create("ns3::Nepi::MobilityPair")
  87 mp2.connector("matrix").connect(matrix.connector("mobpair"))
  88 mp2.set_attribute_value("Loss", 50.0)
  89 mp2.connector("ma").connect(mob3.connector("mp"))
  90 mp2.connector("mb").connect(mob2.connector("mp"))
  91
  92 # 4. Create & setup wifi channel
  93 channel = ns3_desc.create("ns3::YansWifiChannel")
  94 channel.connector("loss").connect(matrix.connector("chan"))
  95 delay = ns3_desc.create("ns3::ConstantSpeedPropagationDelayModel")
  96 channel.connector("delay").connect(delay.connector("chan"))
  97
  98 # 5. Install wireless devices
  99
 100 dev1 = create_wifi_device(ns3_desc, node1, channel)
 101 ip1 = dev1.add_address()
 102 ip1.set_attribute_value("Address", "10.0.0.1")
 103 ip1.set_attribute_value("NetPrefix", 8)
 104
 105 dev2 = create_wifi_device(ns3_desc, node2, channel)
 106 ip2 = dev2.add_address()
 107 ip2.set_attribute_value("Address", "10.0.0.2")
 108 ip2.set_attribute_value("NetPrefix", 8)
 109
 110 dev3 = create_wifi_device(ns3_desc, node3, channel)
 111 ip3 = dev3.add_address()
 112 ip3.set_attribute_value("Address", "10.0.0.3")
 113 ip3.set_attribute_value("NetPrefix", 8)
 114
 115 app = ns3_desc.create("ns3::V4Ping")
 116 app.set_attribute_value("Remote", "10.0.0.2")
 117 app.set_attribute_value("Verbose", True)
 118 app.set_attribute_value("StartTime", "0s")
 119 app.set_attribute_value("StopTime", "20s")
 120
 121 app.connector("node").connect(node1.connector("apps"))
 122
 123 xml = exp_desc.to_xml()
 124
 125 controller = ExperimentController(xml, root_dir)
 126 controller.start()
 127
 128 while not controller.is_finished(app.guid):
 129     time.sleep(0.5)
 130
 131 controller.stop()
 132 controller.shutdown()