vlcSim 0.2.6__tar.gz → 0.3.1__tar.gz

{vlcSim-0.2.6 → vlcSim-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vlcSim
-Version: 0.2.6
+Version: 0.3.1
 Summary: Python Package of Event-Oriented Simulation for visible light communication
 Home-page: https://gitlab.com/DaniloBorquez/simvlc/
 Author: Danilo Bórquez-Paredes

{vlcSim-0.2.6 → vlcSim-0.3.1}/setup.py

@@ -10,7 +10,7 @@ long_description = (this_directory / "README.md").read_text()
 
 setup(
     name="vlcSim",
-    version="0.2.6",
+    version="0.3.1",
     license="MIT",
     description="Python Package of Event-Oriented Simulation for visible light communication",
     author="Danilo Bórquez-Paredes",

{vlcSim-0.2.6 → vlcSim-0.3.1}/vlcSim.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vlcSim
-Version: 0.2.6
+Version: 0.3.1
 Summary: Python Package of Event-Oriented Simulation for visible light communication
 Home-page: https://gitlab.com/DaniloBorquez/simvlc/
 Author: Danilo Bórquez-Paredes

{vlcSim-0.2.6 → vlcSim-0.3.1}/vlcsim/controller.py

@@ -5,6 +5,7 @@ The :mod:`vlcsim.controller` module is in charge of managing the connections and
 from .scene import *
 from enum import Enum
 import math
+import sys
 
 
 class Connection:
@@ -32,6 +33,15 @@ class Connection:
         self.__goalTime = None
         self.__time = time
         self.__capacityRequired = None
+        self.__snr = sys.float_info.min
+
+    @property
+    def snr(self):
+        return self.__snr
+
+    @snr.setter
+    def snr(self, value):
+        self.__snr = value
 
     @property
     def capacityRequired(self) -> float:

{vlcSim-0.2.6 → vlcSim-0.3.1}/vlcsim/scene.py

@@ -1,15 +1,22 @@
 """
-This module work with the classes belonging to the Scene. It manages the physical sustrate.
+It manages the physical sustrate. 
 """
 
 import numpy as np
 import math as m
 from enum import Enum
+import warnings
 
 
 class AccessPoint:
     """
-    Class representing a generic access point
+    Class representing a generic access point. The :class:`vlcsim.scene.AccessPoint` class is in charge of managing the physical sustrate. It has the following attributes:
+
+    - **x**: **x** coordinate of the position of this VLed.
+    - **y**: **y** coordinate of the position of this VLed.
+    - **z**: **z** coordinate of the position of this VLed.
+    - **state**: Current state of the access point. Could be IDLE or BUSY.
+    - **sliceTime**: Time of the slice in [s]
     """
 
     stateap = Enum("state", "IDLE BUSY")
@@ -531,21 +538,21 @@ class Receiver:
         :param z: z coordinate of the object's coordinate.
         :param aDet: aDet value of the object's coordinate.
         :param ts: time of the object's coordinate. Default is 10 seconds.
-        :param index
+        :param index:
         :param fov: q of the object. Default is 1. 6e - 19.
-        :param q
+        :param q:
         :param s: ibg b - parameter of the Ib - Galactic model. Default i 5 seconds.
         :param b: c b - parameter of the Ib - Galactic model. Default is 5 seconds.
-        :param ibg
-        :param cb
-        :param tk
+        :param ibg:
+        :param cb:
+        :param tk:
         :param a: n n - prameter of the B - parameter. Default is 10 seconds.
-        :param gv
-        :param n
-        :param fr
-        :param gm
-        :param i1
-        :param i2
+        :param gv:
+        :param n:
+        :param fr:
+        :param gm:
+        :param i1:
+        :param i2:
         """
         self.__x = x
         self.__y = y
@@ -834,6 +841,9 @@ class Receiver:
 
 class Scenario:
     numberOfAPs = 0
+    warnings.filterwarnings(
+        "ignore", message="invalid value encountered in double_scalars"
+    )
 
     def __init__(
         self, width: float, length: float, height: float, nGrids: int, rho: float

{vlcSim-0.2.6 → vlcSim-0.3.1}/vlcsim/simulator.py

@@ -92,6 +92,9 @@ class Simulator:
         self.__upper_capacity_required = None
         self.__lower_capacity_required = None
 
+        self.__users_by_vlc = []
+        self.__users_by_rf = []
+
         self.default_values()
 
     def default_values(self):
@@ -273,7 +276,30 @@ class Simulator:
             )
         )
 
-        print("=" * 120)
+        print(f"Number of VLeds: {self.__controller.scenario.numberOfVLeds}")
+        print("Positions:")
+        print("        ID  |     X     |     Y    |     Z    |")
+        print("-" * 47)
+        for vled in self.__controller.scenario.vleds:
+            print(
+                "{:>10}  |  {:8.4f} | {:8.4f} | {:8.4f} |".format(
+                    vled.ID, vled.x, vled.y, vled.z
+                )
+            )
+        print()
+        print(f"Number of RFs: {self.__controller.scenario.numberOfRFs}")
+        print("Positions:")
+        print("        ID  |     X     |     Y    |     Z    |")
+        print("-" * 47)
+        for rf in self.__controller.scenario.rfs:
+            print(
+                "{:>10}  |  {:8.4f} | {:8.4f} | {:8.4f} |".format(
+                    rf.ID, rf.x, rf.y, rf.z
+                )
+            )
+        print()
+
+        print("=" * 146)
         print("|  Time  ", end="")
         print("|   Event   ", end="")
         print("|  Receiver   ", end="")
@@ -282,8 +308,10 @@ class Simulator:
         print("|    Z    ", end="")
         print("|  Access Point (A.C.) ", end="")
         print("|  Goal time  ", end="")
-        print("|  Elapsed time  |")
-        print("=" * 120)
+        print("|  Elapsed time  ", end="")
+        print("|    SNR     ", end="")
+        print("|  Req. Cap. |")
+        print("=" * 146)
 
     def print_row(self, event):
         text = ""
@@ -339,6 +367,8 @@ class Simulator:
         #               event.type,
         #               event.id_connection,
         #           )
+        text += "{:10.2e}".format(event.connection.snr) + "  |"
+        text += "{:10.2e}".format(event.connection.capacityRequired) + "  |"
         print(text)
 
     def event_routine(self):
@@ -395,6 +425,10 @@ class Simulator:
                 next_status == Controller.nextStatus.RESUME
                 or next_status == Controller.nextStatus.PAUSE
             ):
+                if type(connection.AP) == VLed:
+                    self.__users_by_vlc[connection.AP.ID] += 1
+                elif type(connection.AP) == RF:
+                    self.__users_by_rf[connection.AP.ID] += 1
                 self.__current_event.connection = connection
                 if next_status == Controller.nextStatus.RESUME:
                     for pos in range(len(self.__events) - 1, -1, -1):
@@ -545,6 +579,10 @@ class Simulator:
             and self.__controller.scenario.numberOfRFs == 0
         ):
             raise ("The scenario does not have any Vleds or RFs")
+        for _ in range(self.__controller.scenario.numberOfVLeds):
+            self.__users_by_vlc.append(0)
+        for _ in range(self.__controller.scenario.numberOfRFs):
+            self.__users_by_rf.append(0)
         return
 
     def run(self):
@@ -552,6 +590,7 @@ class Simulator:
         while self.__numberOfConnections <= self.__goalConnections:
             # for i in range(self.__goalConnections):
             self.event_routine()
+        self.aggregated_metrics()
 
     def time_duration(self):
         return self.__time_duration
@@ -568,3 +607,14 @@ class Simulator:
     @property
     def scenario(self):
         return self.__controller.scenario
+
+    def aggregated_metrics(self):
+        print("Number of users connected to each VLed")
+        for i in range(self.__controller.scenario.numberOfVLeds):
+            id = self.__controller.scenario.vleds[i].ID
+            print(f"VLed {id}: {self.__users_by_vlc[id]}")
+
+        print("Number of users connected to each RF")
+        for i in range(self.__controller.scenario.numberOfRFs):
+            id = self.__controller.scenario.rfs[i].ID
+            print(f"RF {id}: {self.__users_by_rf[id]}")