naming changes

Author: AmirmohammadZarif

AVISEngine.py

@@ -1,5 +1,5 @@
 '''
-@ 2022, Copyright AVIS Engine
+@ 2023, Copyright AVIS Engine
 '''
 
 import cv2
@@ -11,17 +11,17 @@
 import utils
 
 __author__ = "Amirmohammad Zarif"
-__email__ = "amirmohammadzarif@avisengine.com"
+__email__ = "amir@avisengine.com"
 
 
 class Car():
     '''
-    AVIS Engine Main car class
+    AVIS Engine Main Car class
     
     Attributes
     ----------
 
-    Private:
+    Public:
         steering_value
         speed_value
         sensor_status

Example.py

@@ -1,67 +1,67 @@
 '''
-@ 2022, Copyright AVIS Engine
-Example Compatible with AVISEngine version 2.0.1 or higher
+@ 2023, Copyright AVIS Engine
+- An Example Compatible with AVISEngine version 2.0.1 or higher
 ''' 
-import AVISEngine
+import avisengine
 import config
 import time
 import cv2
 
-#Calling the class
-car = AVISEngine.Car()
+# Creating an instance of the Car class
+car = avisengine.Car()
 
-#connecting to the server (Simulator)
+# Connecting to the server (Simulator)
 car.connect(config.SIMULATOR_IP, config.SIMULATOR_PORT)
 
-#Counter variable
+# Counter variable
 counter = 0
 
 debug_mode = False
 
-#Sleep for 3 seconds to make sure that client connected to the simulator 
+# Sleep for 3 seconds to make sure that client connected to the simulator 
 time.sleep(3)
 
 try:
     while(True):
-        #Counting the loops
-        
+        # Counting the loops
         counter = counter + 1
 
-        #Set the power of the engine the car to 20, Negative number for reverse move, Range [-100,100]
+        # Set the power of the engine the car to 20, Negative number for reverse move, Range [-100,100]
         car.setSpeed(20)
 
-        #Set the Steering of the car -10 degree from center
+        # Set the Steering of the car -10 degree from center, results the car to steer to the left
         car.setSteering(-10)
 
-        #Set the angle between sensor rays to 30 degrees, Use this only if you want to set it from python client
+        # Set the angle between sensor rays to 30 degrees, Use this only if you want to set it from python client
         car.setSensorAngle(40) 
 
-        #Get the data. Need to call it every time getting image and sensor data
+        # Get the data. Need to call it every time getting image and sensor data
         car.getData()
 
-        #Start getting image and sensor data after 4 loops. for unclear some reason it's really important 
+        # Start getting image and sensor data after 4 loops
         if(counter > 4):
 
-            #returns a list with three items which the 1st one is Left sensor data, the 2nd one is the Middle Sensor data, and the 3rd is the Right one.
+            # Returns a list with three items which the 1st one is Left sensor data\
+            # the 2nd one is the Middle Sensor data, and the 3rd is the Right one.
             sensors = car.getSensors() 
-            #EX) sensors[0] returns an int for left sensor data in cm
 
-            #returns an opencv image type array. if you use PIL you need to invert the color channels.
+            # Returns an opencv image type array. if you use PIL you need to invert the color channels.
             image = car.getImage()
 
-            #returns an integer which is the real time car speed in KMH
+            # Returns an integer which is the real time car speed in KMH
             carSpeed = car.getSpeed()
 
-            #Don't print data for better performance
             if(debug_mode):
-                print("Speed : ",carSpeed) 
-                print("Left : " + str(sensors[0]) + "   |   " + "Middle : " + str(sensors[1])  +"   |   " + "Right : " + str(sensors[2]))
-
-            #Showing the opencv type image
+                print(f"Speed : {carSpeed}") 
+                print(f'Left : {str(sensors[0])} | Middle : {str(sensors[1])} | Right : {str(sensors[2])}')
+            
+            # Showing the opencv type image
             cv2.imshow('frames', image)
-            #Break the loop when q pressed
+
+
             if cv2.waitKey(10) == ord('q'):
                 break
+
             time.sleep(0.001)
 
 finally:

utils.py

@@ -1,13 +1,12 @@
 '''
 @ 2022, Copyright AVIS Engine
 '''
-#Utils and Extra Functions for AVISEngine Class
+# Utils for AVISEngine Class
 import base64
 import cv2
 import numpy as np
 from PIL import Image
 import io
-import json
 
 
 __author__ = "Amirmohammad Zarif"