vlcSim 0.3.1__tar.gz → 0.3.2__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vlcSim
-Version: 0.3.1
+Version: 0.3.2
 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.3.1 → vlcSim-0.3.2}/setup.py

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

{vlcSim-0.3.1 → vlcSim-0.3.2}/test/test_scenario.py

@@ -93,16 +93,16 @@ class TestScenario:
         assert totalPower == pytest.approx(1.333598176601676)
 
         snr = scenario.snrVled(receiver, vled1)
-        assert snr == pytest.approx(7.365185165012038e07)
+        assert snr == pytest.approx(7.361724628127821e07)
 
         snr = scenario.snrVled(receiver, vled2)
-        assert snr == pytest.approx(2.072547626391976e06)
+        assert snr == pytest.approx(2.071573464407198e06)
 
         snr = scenario.snrVled(receiver, vled3)
-        assert snr == pytest.approx(2.072547626391976e06)
+        assert snr == pytest.approx(2.071573464407198e06)
 
         snr = scenario.snrVled(receiver, vled4)
-        assert snr == pytest.approx(4.185333357837867e05)
+        assert snr == pytest.approx(4.183366036825221e05)
 
         rf = RF(0, 0, 0.85)
         receiver = Receiver(

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vlcSim
-Version: 0.3.1
+Version: 0.3.2
 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.3.1 → vlcSim-0.3.2}/vlcsim/controller.py

@@ -21,6 +21,8 @@ class Connection:
         :type id: int
         :param receiver: The receiver of this connection.
         :type receiver: :class:`vlcsim.scene.Receiver`
+        :param time: The time when this connection was created the first time.
+        :type time: float
         :return: :class:`vlcsim.controller.Connection` object
         :rtype: :class:`vlcsim.controller.Connection`
         """
@@ -36,15 +38,25 @@ class Connection:
         self.__snr = sys.float_info.min
 
     @property
-    def snr(self):
+    def snr(self) -> float:
+        """Signal to Noise Ratio
+
+        :return: Signal to Noise Ratio
+        :rtype: float
+        """
         return self.__snr
 
     @snr.setter
-    def snr(self, value):
+    def snr(self, value: float):
         self.__snr = value
 
     @property
     def capacityRequired(self) -> float:
+        """Capacity required in bps
+
+        :return: capacity required in bps
+        :rtype: float
+        """
         return self.__capacityRequired
 
     @capacityRequired.setter
@@ -52,7 +64,12 @@ class Connection:
         self.__capacityRequired = value
 
     @property
-    def time(self):
+    def time(self) -> float:
+        """The time when this connection arrived to simulation
+
+        :return: time when this connection arrived to simulation
+        :rtype: float
+        """
         return self.__time
 
     @time.setter
@@ -60,7 +77,12 @@ class Connection:
         self.__time = value
 
     @property
-    def goalTime(self):
+    def goalTime(self) -> float:
+        """Total effective time that the connection will be using the channel, depending of the capacity required and the capacity given by the channel.
+
+        :return: Effective time
+        :rtype: float
+        """
         return self.__goalTime
 
     @goalTime.setter
@@ -69,31 +91,69 @@ class Connection:
 
     @property
     def frameSlice(self):
+        """List of lists containing the tuples [frame, slice] that this connection will use
+
+        :return: Tuples frame,slice that the connection will use
+        """
         return self.__frameSlice
 
     @frameSlice.setter
     def frameSlice(self, value):
         self.__frameSlice = value
 
-    def getNextTime(self):
+    def getNextTime(self) -> float:
+        """Gets the next time when this connection will start to transmit again
+
+        :return: the next time
+        :rtype: float
+        """
         return self.__timesAssigned.pop(0)
 
-    def insertTime(self, time):
+    def insertTime(self, time: float):
+        """function in charge of defininfg the times when this connection will be used. It works with the simulation FEL
+
+        :param time: List of times that this connection will start the transmission
+        :type time: float
+        """
+
         for i in range(len(self.__timesAssigned)):
             if self.__timesAssigned[i] > time:
                 self.__timesAssigned.insert(i, time)
                 break
         self.__timesAssigned.append(time)
 
-    def assignFrameSlice(self, frame, slice):
+    def assignFrameSlice(self, frame: int, slice: int):
+        """Assigns a frame and an slice to this connection.
+
+        :param frame: frame number
+        :type frame: int
+        :param slice: slice number
+        :type slice: int
+        """
         self.__frameSlice.append([frame, slice])
 
     def numberOfSlicesNeeded(
         self, capacityRequired: float, capacityFromAP: float
     ) -> int:
+        """Determinates the number of slices needed by this connection depending of the capacity required and the AP capacity
+
+        :param capacityRequired: Capacity required
+        :type capacityRequired: float
+        :param capacityFromAP: capacity given
+        :type capacityFromAP: float
+        :return: The number of slices needed by tis connection
+        :rtype: int
+        """
         return math.ceil(capacityRequired / capacityFromAP)
 
-    def nextSliceInAPWhenArriving(self, ap):
+    def nextSliceInAPWhenArriving(self, ap: AccessPoint) -> int:
+        """When a new connection arrives, this funciont gives the position of the next slot depending of the arriving time for an AP
+
+        :param ap: _description_
+        :type ap: :class:`vlcsim.scene.AccessPoint`
+        :return: the slot position
+        :rtype: int
+        """
         return math.ceil(self.__time / ap.sliceTime) % ap.slicesInFrame
 
     @property
@@ -261,7 +321,8 @@ class Controller:
         if self.__allocationStatus == Controller.status.ALLOCATED:
             index = self.APPosition(connection.AP)
             self.__numberActiveConnections[index] += 1
-            actualSlice = connection.nextSliceInAPWhenArriving(connection.AP) - 1
+            actualSlice = connection.nextSliceInAPWhenArriving(
+                connection.AP) - 1
             actualTime = (
                 (time // (connection.AP.slicesInFrame * connection.AP.sliceTime))
                 * connection.AP.slicesInFrame
@@ -373,7 +434,7 @@ class Controller:
 
     def init(self):
         """
-        Initializatrion of this controller. This methods must be invoked before to start the simulation.
+        Initialization of this controller. This methods must be invoked before to start the simulation.
         """
         self.__activeConnections = []
         self.__numberActiveConnections = []
@@ -436,7 +497,18 @@ class Controller:
         """
         return self.__numberActiveConnections[self.APPosition(ap)]
 
-    def assignSlice(self, apIndex, frame, slice, connection):
+    def assignSlice(self, apIndex: int, frame: int, slice: int, connection: Connection):
+        """Assigns the connection to the AP, in the frame and slice given
+
+        :param apIndex: Index of the AP
+        :type apIndex: int
+        :param frame: frame to be used
+        :type frame: int
+        :param slice: sliec to be used
+        :type slice: int
+        :param connection: Connection to be assigned
+        :type connection: Connection
+        """
         numberOfFrames = len(self.__activeConnections[apIndex])
         if numberOfFrames < frame + 1:
             for _ in range(numberOfFrames, frame + 1):
@@ -455,5 +527,11 @@ class Controller:
         else:
             self.__activeConnections[apIndex][frame][slice] = connection
 
-    def framesState(self, ap):
+    def framesState(self, ap: AccessPoint):
+        """Return the set of frame/slices of the ap given.
+
+        :param ap: Access Point
+        :type ap: AccessPoint
+        :return: A list of lists containing the frames and slices of this AP
+        """
         return self.__activeConnections[self.APPosition(ap)]

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

@@ -520,7 +520,7 @@ class Receiver:
         s: float = 0.54,
         b: float = 10e6,
         ibg: float = 5.1e-3,
-        cb: float = 1.38e-23,
+        cb: float = 1.380649e-23,
         tk: float = 298.0,
         a: float = 1.0,
         gv: float = 10.0,
@@ -534,25 +534,45 @@ class Receiver:
         Initializes the object with the values. This is the constructor for the Schrodinger model
 
         :param x: x coordinate of the object
+        :type x: float
         :param y: y coordinate of the object's coordinate.
+        :type y: float
         :param z: z coordinate of the object's coordinate.
+        :type z: float
         :param aDet: aDet value of the object's coordinate.
+        :type aDet: float
         :param ts: time of the object's coordinate. Default is 10 seconds.
-        :param index:
-        :param fov: q of the object. Default is 1. 6e - 19.
-        :param q:
+        :type ts: float
+        :param index: order of Lambertian emission that depends on the half-angle at half illumination of the LED.
+        :type index: float
+        :param fov: width of the field of view.
+        :type fov: float
+        :param q: electronic load. Default is -1.602e-19 culombios
+        :type q: float
         :param s: ibg b - parameter of the Ib - Galactic model. Default i 5 seconds.
+        :type s: float
         :param b: c b - parameter of the Ib - Galactic model. Default is 5 seconds.
-        :param ibg:
-        :param cb:
-        :param tk:
+        :type b: float
+        :param ibg: background current. Default is 5.1e-3 Amperes.
+        :type ibg: float
+        :param cb: Boltzmann constant. Default is 1.380649e-23 J/K.
+        :type cb: float
+        :param tk: 380649
+        :type tk: float
         :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:
+        :type a: float
+        :param gv: Open-loop voltage gain. Default is 10
+        :type gv: float
+        :param n: Fixed capacitance of the PD per unit area. Default is 1.12e-6.
+        :type n: float
+        :param fr: FET channel noise factor. Default is 1.5
+        :type fr: float
+        :param gm: FET transconductance. Default is 3e-2.
+        :type gm: float
+        :param i1: constant experimental value. Default is 0.562.
+        :type i1: float
+        :param i2: constant experimental value. Default is 0.0868.
+        :type i2: float
         """
         self.__x = x
         self.__y = y