Add LEACH routing protocol

examples/manetrouting/leach/LeachExample.ned

@@ -0,0 +1,37 @@
+//
+// SPDX-License-Identifier: LGPL-3.0-or-later
+//
+
+package inet.examples.manetrouting.leach;
+
+import inet.networklayer.configurator.ipv4.Ipv4NetworkConfigurator;
+import inet.node.contract.INetworkNode;
+import inet.node.inet.SensorNode;
+import inet.physicallayer.wireless.common.contract.packetlevel.IRadioMedium;
+import inet.visualizer.contract.IIntegratedVisualizer;
+import inet.environment.common.PhysicalEnvironment;
+
+network LeachExample
+{
+    parameters:
+        int numNodes;
+        @display("bgb=200,200;bgg=100,1,grey95");
+        @figure[title](type=label; pos=0,-1; anchor=sw; color=darkblue);
+
+    submodules:
+        configurator: Ipv4NetworkConfigurator {
+            @display("p=100,100");
+        }
+        radioMedium: <default("UnitDiskRadioMedium")> like IRadioMedium {
+            @display("p=100,100");
+        }
+        physicalEnvironment: PhysicalEnvironment {
+            @display("p=100,100");
+        }
+        host[numNodes]: <default("WirelessHost")> like INetworkNode {
+            @display("i=misc/sensor2");
+        }
+        baseStation: <default("WirelessHost")> like INetworkNode {
+            @display("p=50,50;i=misc/sensorgateway");
+        }
+}

examples/manetrouting/leach/address.xml

@@ -0,0 +1,4 @@
+<config> 
+	<interface hosts="baseStation" names="wlan0" address="10.0.0.1"/>
+	<interface hosts="**" address="10.x.x.x" netmask="255.x.x.x"/>
+</config>

examples/manetrouting/leach/omnetpp.ini

@@ -0,0 +1,84 @@
+[General]
+network = LeachExample
+
+num-rngs = 2
+seed-0-mt= 4900 # used for node layout generation (can set any preferred value)
+seed-1-mt = 7 # used for threshold comparison (can set any preferred value)
+
+**.arp.typename = "GlobalArp"
+
+*.radioMedium.typename = "Ieee802154NarrowbandScalarRadioMedium"
+*.radioMedium.backgroundNoise.typename = "IsotropicScalarBackgroundNoise"
+*.radioMedium.backgroundNoise.power = -100dBm
+*.radioMedium.mediumLimitCache.centerFrequency = 2GHz
+
+*.host*.hasStatus = true
+*.visualizer.energyStorageVisualizer.displayEnergyStorages = true
+
+*.configurator.config = xmldoc ("address.xml")
+
+*.baseStation.typename = "LeachBS"
+*.host*.typename = "LeachNode"
+
+*.numNodes = 100 #100
+*.host*.mobility.typename = "StationaryMobility"
+*.host*.mobility.rng-0 = 0	# random number generator mapping
+
+*.host[*].mobility.initFromDisplayString = false
+
+**.constraintAreaMinX = 1m			
+**.constraintAreaMaxX = 100m	
+**.constraintAreaMinY = 1m				
+**.constraintAreaMaxY = 100m			
+
+*.host*.wlan[0].typename = "Ieee802154NarrowbandInterface"
+*.host*.wlan[0].radio.typename = "ApskScalarRadio"
+*.host*.wlan[0].radio.centerFrequency = 2.5GHz # based on TI CC2520	 	
+*.host*.wlan[0].radio.bandwidth = 2MHz
+*.host*.wlan[0].radio.transmitter.power = 60.5mW # determines communication range - based on CC2520
+*.host*.wlan[0].radio.transmitter.preambleDuration = 192us # based on TI CC2520		
+*.host*.wlan[0].radio.transmitter.headerLength = 6B # based on TI CC2520		
+*.host*.wlan[0].radio.receiver.sensitivity = -98dBm # based on TI CC2520
+*.host*.wlan[0].radio.receiver.energyDetection = -85dBm
+*.host*.wlan[0].radio.receiver.snirThreshold = 4dB 
+*.host*.wlan[0].radio.displayCommunicationRange = true
+
+
+*.baseStation.wlan[0].typename = "Ieee802154NarrowbandInterface"
+*.baseStation.wlan[0].radio.typename = "ApskScalarRadio"
+*.baseStation.wlan[0].radio.centerFrequency = 2.5GHz		
+*.baseStation.wlan[0].radio.bandwidth = 2MHz
+*.baseStation.wlan[0].radio.transmitter.power = 60.5mW				
+*.baseStation.wlan[0].radio.transmitter.preambleDuration = 192us	
+*.baseStation.wlan[0].radio.transmitter.headerLength = 6B
+*.baseStation.wlan[0].radio.receiver.sensitivity = -98dBm
+*.baseStation.wlan[0].radio.receiver.energyDetection = -85dBm
+*.baseStation.wlan[0].radio.receiver.snirThreshold = 4dB
+*.baseStation.wlan[0].radio.displayCommunicationRange = true
+
+*.host*.**.bitrate = 250kbps # based on TI CC2520	
+*.baseStation.**.bitrate = 250kbps	
+
+[Config LeachPower]
+extends = General
+
+*.host*.energyStorage.typename = "SimpleCcBattery"
+*.host*.energyStorage.nominalCapacity = 7200C # calculated for 2 x AA cells				
+*.host*.energyStorage.initialCapacity = 7100C				
+*.host*.energyStorage.nominalVoltage = 1.5V
+*.host*.energyStorage.internalResistance = 0.1Ohm
+
+*.host*.wlan[0].radio.energyConsumer.typename = "StateBasedCcEnergyConsumer"
+*.host*.wlan[0].radio.energyConsumer.offCurrentConsumption = 0A
+*.host*.wlan[0].radio.energyConsumer.switchingCurrentConsumption = 1mA
+*.host*.wlan[0].radio.energyConsumer.receiverIdleCurrentConsumption = 18.8mA				# based on CC2520
+*.host*.wlan[0].radio.energyConsumer.receiverBusyCurrentConsumption = 24.8mA				# based on CC2520
+*.host*.wlan[0].radio.energyConsumer.receiverReceivingCurrentConsumption = 26.3mA			# based on CC2520
+*.host*.wlan[0].radio.energyConsumer.transmitterIdleCurrentConsumption = 25.8mA				# based on CC2520
+*.host*.wlan[0].radio.energyConsumer.transmitterTransmittingCurrentConsumption = 33.6mA		# based on CC2520
+
+[Config LeachPathLoss]
+extends = General
+
+*.host*.wlan[0].radio.displayInterferenceRange = true
+*.radioMedium.pathLoss.typename = "LogNormalShadowing"

src/inet/node/leach/LeachBS.ned

@@ -0,0 +1,29 @@
+//
+// SPDX-License-Identifier: LGPL-3.0-or-later
+//
+
+package inet.node.leach;
+
+import inet.node.inet.AdhocHost;
+import inet.routing.leach.LeachBS;
+
+//
+// This module provides Low-Energy Adaptive Clustering Hierarchy (LEACH) 
+// routing protocol for the data sink/base station. 
+// This implementation is designed to use a a single wireless interface and run on
+// the IEEE 802.15.4 standard for MAC and Physical layers.
+// This module simply receives data from the sensor nodes.
+//
+// For more information on the algorithm, see the LEACH paper
+// https://ieeexplore.ieee.org/document/926982
+//
+module LeachBS extends AdhocHost
+{
+    submodules:
+        LeachBS: LeachBS {
+            @display("p=825,226");
+        }
+    connections:
+        LeachBS.ipOut --> tn.in++;
+        LeachBS.ipIn <-- tn.out++;
+}

src/inet/node/leach/LeachNode.ned

@@ -0,0 +1,31 @@
+//
+// SPDX-License-Identifier: LGPL-3.0-or-later
+//
+
+package inet.node.leach;
+
+import inet.node.inet.AdhocHost;
+import inet.routing.leach.Leach;
+
+//
+// This module provides Low-Energy Adaptive Clustering Hierarchy (LEACH) 
+// routing protocol for sensor nodes. 
+// LEACH is a hierachical adhoc routing protocol for Wireless Sensor Networks. 
+// This implementation is designed to use a a single wireless interface and run on
+// the IEEE 802.15.4 standard for MAC and Physical layers.
+// Therefore the standard TDMA scheduling system has been implemented 
+// with delayed time slots due to the use of CSMA in the 802.15.4 standard.
+//
+// For more information on the algorithm, see the LEACH paper
+// https://ieeexplore.ieee.org/document/926982
+//
+module LeachNode extends AdhocHost
+{
+    submodules:
+        LeachNode: Leach {
+            @display("p=825,226");
+        }
+    connections:
+        LeachNode.ipOut --> tn.in++;
+        LeachNode.ipIn <-- tn.out++;
+}