Welcome to VLCsim’s documentation!

VLCSim is an Event-Oriented simulator package for Visible Light Communication.

Note

This project is under active development.

Features

• Dynamic Environment with in/out connections

• Flexible resource allocation algorithm

• Flexible VLC/room parameters

Events

The simulator has 5 Type of events:

• ARRIVE: Every time when a connection arrives to the system

• RESUME: When a connection begin the transmission

• PAUSE: When a Connection PAUSES the transmission

• DEPARTURE: When a connectin ends its transmission

• RETRYING: WHen a connection is not allocated, and uses a WAIT status, it makes a new attepmt to connect.

Contents

• Usage
  • Installation
  • Custom allocation algorithm
• API
  • vlcsim
    • vlcsim.controller
      • vlcsim.controller.Connection
        • Connection
          • Connection.__init__()
          • Connection.AP
          • Connection.allocated
          • Connection.assignFrameSlice()
          • Connection.capacityRequired
          • Connection.frameSlice
          • Connection.getNextTime()
          • Connection.goalTime
          • Connection.id
          • Connection.insertTime()
          • Connection.nextSliceInAPWhenArriving()
          • Connection.numberOfSlicesNeeded()
          • Connection.receiver
          • Connection.snr
          • Connection.time
      • vlcsim.controller.Controller
        • Controller
          • Controller.__init__()
          • Controller.APPosition()
          • Controller.activeConnections
          • Controller.allocationStatus
          • Controller.allocator
          • Controller.assignConnection()
          • Controller.assignSlice()
          • Controller.framesState()
          • Controller.init()
          • Controller.nextStatus
            • Controller.nextStatus.PAUSE
            • Controller.nextStatus.FINISH
            • Controller.nextStatus.RESUME
            • Controller.nextStatus.IDLE
            • Controller.nextStatus.RND_WAIT
          • Controller.numberOfActiveConnections()
          • Controller.pauseConnection()
          • Controller.resumeConnection()
          • Controller.scenario
          • Controller.status
            • Controller.status.ALLOCATED
            • Controller.status.NOT_ALLOCATED
            • Controller.status.WAIT
          • Controller.unassignConnection()
    • vlcsim.scene
      • vlcsim.scene.AccessPoint
        • AccessPoint
          • AccessPoint.__init__()
          • AccessPoint.B
          • AccessPoint.ID
          • AccessPoint.position
          • AccessPoint.setBUSY()
          • AccessPoint.setIDLE()
          • AccessPoint.sliceTime
          • AccessPoint.slicesInFrame
          • AccessPoint.state
          • AccessPoint.stateap
          • AccessPoint.x
          • AccessPoint.y
          • AccessPoint.z
      • vlcsim.scene.RF
        • RF
          • RF.__init__()
          • RF.A
          • RF.Af
          • RF.B
          • RF.BERf
          • RF.Ef
          • RF.ID
          • RF.N_rf
          • RF.R_awgn
          • RF.bf
          • RF.nFactor_rf
          • RF.numberOfRFs
          • RF.pf
          • RF.pif
          • RF.position
          • RF.setBUSY()
          • RF.setIDLE()
          • RF.sliceTime
          • RF.slicesInFrame
          • RF.state
          • RF.stateap
          • RF.x
          • RF.y
          • RF.z
      • vlcsim.scene.Receiver
        • Receiver
          • Receiver.__init__()
          • Receiver.ID
          • Receiver.a
          • Receiver.aDet
          • Receiver.b
          • Receiver.capacityFromAP
          • Receiver.cb
          • Receiver.fov
          • Receiver.fr
          • Receiver.gm
          • Receiver.goalTime
          • Receiver.gv
          • Receiver.i1
          • Receiver.i2
          • Receiver.ibg
          • Receiver.index
          • Receiver.n
          • Receiver.position
          • Receiver.q
          • Receiver.receiversCreated
          • Receiver.s
          • Receiver.timeActive
          • Receiver.timeFinished
          • Receiver.timeFirstConnected
          • Receiver.ts
          • Receiver.x
          • Receiver.y
          • Receiver.z
      • vlcsim.scene.Scenario
        • Scenario
          • Scenario.__init__()
          • Scenario.addRF()
          • Scenario.addVLed()
          • Scenario.capacityRf()
          • Scenario.capacityVled()
          • Scenario.end_x
          • Scenario.end_y
          • Scenario.getPowerInPointFromVled()
          • Scenario.getPowerInPointFromWalls()
          • Scenario.height
          • Scenario.length
          • Scenario.numberOfAPs
          • Scenario.numberOfRFs
          • Scenario.numberOfVLeds
          • Scenario.rfs
          • Scenario.rfsPositions
          • Scenario.snrRf()
          • Scenario.snrVled()
          • Scenario.start_x
          • Scenario.start_y
          • Scenario.vleds
          • Scenario.vledsPositions
          • Scenario.width
      • vlcsim.scene.VLed
        • VLed
          • VLed.__init__()
          • VLed.B
          • VLed.ID
          • VLed.ledPower
          • VLed.ml
          • VLed.nLedsX
          • VLed.nLedsY
          • VLed.numberOfLeds
          • VLed.numberOfVLeds
          • VLed.position
          • VLed.setBUSY()
          • VLed.setIDLE()
          • VLed.sliceTime
          • VLed.slicesInFrame
          • VLed.state
          • VLed.stateap
          • VLed.theta
          • VLed.totalPower
          • VLed.x
          • VLed.y
          • VLed.z
    • vlcsim.simulator
      • vlcsim.simulator.Event
        • Event
          • Event.__init__()
          • Event.connection
          • Event.event
            • Event.event.ARRIVE
            • Event.event.DEPARTURE
            • Event.event.PAUSE
            • Event.event.RESUME
            • Event.event.NEXT_CONNECTION_TRY
          • Event.id_connection
          • Event.time
          • Event.type
      • vlcsim.simulator.Simulator
        • Simulator
          • Simulator.__init__()
          • Simulator.aggregated_metrics()
          • Simulator.default_values()
          • Simulator.event_routine()
          • Simulator.get_Blocking_Probability()
          • Simulator.goalConnections
          • Simulator.init()
          • Simulator.lambdaS
          • Simulator.lower_capacity_required
          • Simulator.lower_random_wait
          • Simulator.mu
          • Simulator.print_initial_info()
          • Simulator.print_row()
          • Simulator.run()
          • Simulator.scenario
          • Simulator.seedCapacityRequired
          • Simulator.seedRandomWait
          • Simulator.seedX
          • Simulator.seedY
          • Simulator.seedZ
          • Simulator.set_allocation_algorithm()
          • Simulator.time_duration()
          • Simulator.upper_capacity_required
          • Simulator.upper_random_wait

Indices and tables

• Index

• Module Index

• Search Page