paper-lowrate-iot/ns3-simulations/simulate.org

• Run simulations
  • Experiments
    • Bandwidth
    • Latency
    • Number of sensors
    • Number of Hop
  • Single Run
• Logs Analysis
  • R Scripts
    • Generate all plots script
    • R Utils
  • Plots -> PDF
  • Log -> CSV

Run simulations

To run all the simulations, execute the following call:

Experiments

Bandwidth

  <<singleRun>>
  simKey="BW"
  for sensorsNumber in $(seq 1 15)
  do
      for linksBandwidth in $(seq 10 20 100)
      do
          run
      done      
  done

Latency

  <<singleRun>>
  simKey="LATENCY"
  for sensorsNumber in $(seq 1 15)
  do
      for linksLatency in $(seq 1 1 10)
      do
          run
      done      
  done

Number of sensors

  <<singleRun>>
  simKey="NBSENSORS"
  for sensorsNumber in $(seq 1 5)
  do
      run
  done

Number of Hop

  <<singleRun>>
  simKey="NBHOP"
  for sensorsNumber in $(seq 1 15)
  do
      for nbHop in $(seq 1 10)
      do
          run
      done
  done

Single Run

  simulator="simulator/simulator"
  parseEnergyScript="./parseEnergy.awk"
  parseDelayScript="./parseDelay.awk"
  logFolder="logs/"
  export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${NS3_PATH}/build/lib

  # Default Parameters
  sensorsSendInterval=10
  sensorsPktSize=5 # 1 byte temperature (-128 à +128 °C) and 4Byte sensorsId
  sensorsNumber=10
  nbHop=10 # Cf paper AC/Yunbo
  linksBandwidth=10
  linksLatency=2
  simKey="NOKEY"

  run () {
      logFile="${logFolder}/${simKey}_${sensorsSendInterval}SSI_${sensorsPktSize}SPS_${sensorsNumber}SN_${nbHop}NH_${linksBandwidth}LB_${linksLatency}LL.org"
      [ -f "$logFile" ] && return
      simCMD="$simulator --sensorsSendInterval=${sensorsSendInterval} --sensorsPktSize=${sensorsPktSize} --sensorsNumber=${sensorsNumber} --nbHop=${nbHop} --linksBandwidth=${linksBandwidth} --linksLatency=${linksLatency} 2>&1"
      log=$(bash -c "$simCMD")

      # Compute some metrics
      energyLog=$(echo "$log" | $parseEnergyScript)
      avgDelay=$(echo "$log" | $parseDelayScript)
      totalEnergy=$(echo "$energyLog"| awk 'BEGIN{power=0;FS=","}NR!=1{power+=$2}END{print(power)}')
      nbPacketCloud=$(echo "$log"|grep -c "CloudSwitch receive")
      nbNodes=$(echo "$log"|awk '/Simulation used/{print($3)}')
      ns3Version=$(echo "$log"|awk '/NS-3 Version/{print($3)}')

      # Save logs
      echo -e "#+TITLE: $(date) ns-3 (version ${ns3Version}) simulation\n" > $logFile
      echo "* Environment Variables" >> $logFile
      env >> $logFile
      echo "* Full Command" >> $logFile
      echo "$simCMD" >> $logFile
      echo "* Output" >> $logFile
      echo "$log" >> $logFile
      echo "* Energy CSV (negative nodeId = WIFI, 0 = AP (Wireless+Wired), positive nodeId = ECOFEN" >> $logFile
      echo "$energyLog" >> $logFile
      echo "* Metrics" >> $logFile
      echo "-METRICSLINE- sensorsSendInterval:${sensorsSendInterval} sensorsPktSize:${sensorsPktSize} sensorsNumber:${sensorsNumber} nbHop:${nbHop} linksBandwidth:${linksBandwidth} linksLatency:${linksLatency} totalEnergy:$totalEnergy nbPacketCloud:$nbPacketCloud nbNodes:$nbNodes avgDelay:${avgDelay} ns3Version:${ns3Version} simKey:${simKey}" >> $logFile

  }

Logs Analysis

To Generate all the plots, please execute the following line:

R Scripts

Generate all plots script

Available variables:

Name

sensorsSendInterval

sensorsPktSize

sensorsNumber

nbHop

linksBandwidth

linksLatency

totalEnergy

nbPacketCloud

nbNodes

avgDelay

simKey

  <<RUtils>>
  easyPlotGroup("linksLatency","totalEnergy", "LATENCY","sensorsNumber")
  easyPlotGroup("linksBandwidth","totalEnergy", "BW","sensorsNumber")
  easyPlot("sensorsNumber","totalEnergy", "NBSENSORS")
  easyPlotGroup("nbHop","totalEnergy", "NBHOP","sensorsNumber")

R Utils

RUtils is intended to load logs (data.csv) and providing simple plot function for them.

  library("tidyverse")

  # Fell free to update the following
  labels=c(nbNodes="Number of nodes",sensorsNumber="Number of sensors",totalEnergy="Total Energy (J)",
    nbHop="Number of hop (AP to Cloud)", linksBandwidth="Links Bandwidth (Mbps)",
    linksLatency="Links Latency (ms)")

  # Load Data
  data=read_csv("logs/data.csv")

  # Get label according to varName
  getLabel=function(varName){
    if(is.na(labels[varName])){
      return(varName)
    }
    return(labels[varName])
  }

  easyPlot=function(X,Y,KEY){
    curData=data%>%filter(simKey==KEY)
    stopifnot(NROW(curData)>0)
    ggplot(curData,aes_string(x=X,y=Y))+geom_point()+geom_line()+xlab(getLabel(X))+ylab(getLabel(Y))
    ggsave(paste0("plots/",KEY,"-",X,"_",Y,".png"))
  }

  easyPlotGroup=function(X,Y,KEY,GRP){
    curData=data%>%filter(simKey==KEY) %>% mutate(!!GRP:=as.character(UQ(rlang::sym(GRP)))) # %>%mutate(sensorsNumber=as.character(sensorsNumber))
    stopifnot(NROW(curData)>0)
    ggplot(curData,aes_string(x=X,y=Y,color=GRP,group=GRP))+geom_point()+geom_line()+xlab(getLabel(X))+ylab(getLabel(Y)) + labs(color = getLabel(GRP))
    ggsave(paste0("plots/",KEY,"-",X,"_",Y,".png"))
  }

Plots -> PDF

Merge all plots in plots/ folder into a pdf file.

  orgFile="plots/plots.org"
  <<singleRun>> # To get all default arguments

  # Write helper function
  function write {
      echo "$1" >> $orgFile
  }

  echo "#+TITLE: Analysis" > $orgFile
  write "#+LATEX_HEADER: \usepackage{fullpage}"
  write "#+OPTIONS: toc:nil"
  # Default arguments
  write '\begin{center}'
  write '\begin{tabular}{lr}'
  write 'Parameters & Values\\'
  write '\hline'
  write "sensorsPktSize & ${sensorsPktSize} bytes\\\\"
  write "sensorsSendInterval & ${sensorsSendInterval}s\\\\"
  write "sensorsNumber & ${sensorsNumber}\\\\"
  write "nbHop & ${nbHop}\\\\"
  write "linksBandwidth & ${linksBandwidth}Mbps\\\\"
  write "linksLatency & ${linksLatency}ms\\\\"
  write '\end{tabular}'
  write '\newline'
  write '\end{center}'

  for plot in $(find plots/ -type f -name "*.png")
  do
      write "\includegraphics[width=0.5\linewidth]{$(basename ${plot})}"
  done

  # Export to pdf
  emacs $orgFile --batch -f org-latex-export-to-pdf --kill

Log -> CSV

logToCSV extract usefull data from logs and put them into logs/data.csv.

  csvOutput="logs/data.csv"

  # First save csv header line
  aLog=$(find logs/ -type f -name "*.org"|head -n 1)
  metrics=$(cat $aLog|grep "\-METRICSLINE\-"|sed "s/-METRICSLINE-//g")
  echo $metrics | awk '{for(i=1;i<=NF;i++){split($i,elem,":");printf(elem[1]);if(i<NF)printf(",");else{print("")}}}' > $csvOutput

  # Second save all values
  for logFile in $(find logs/ -type f -name "*.org")
  do
      metrics=$(cat $logFile|grep "\-METRICSLINE\-"|sed "s/-METRICSLINE-//g")
      echo $metrics | awk '{for(i=1;i<=NF;i++){split($i,elem,":");printf(elem[2]);if(i<NF)printf(",");else{print("")}}}' >> $csvOutput
  done