Updated internal DLL and changed code conventions and comments

Author: CardsApp

.gitignore

@@ -0,0 +1 @@
+cards/__pycache__

Cards/CardDetails.py

@@ -2,4 +2,3 @@ class CardDetails:
     """Card Details Class"""
     def __init__(self, user_id):
         self.user_id = user_id
-		

Cards/CardReader.py

@@ -1,39 +1,40 @@
-from Cards.ReaderSettings import ReaderSettings
-from Cards.ReaderCredentials import ReaderCredentials
-from Cards.NativeBaseDriver import *
-from Cards.CardDetails import CardDetails
-from Cards.CardTapResponse import CardTapResponse
+from cards.ReaderSettings import ReaderSettings
+from cards.ReaderCredentials import ReaderCredentials
+from cards.NativeBaseDriver import *
+from cards.CardDetails import CardDetails
+from cards.CardTapResponse import CardTapResponse
+
 
 class ReaderStatus:
-	"""Card Tap Error Enum"""
-	Disconnected = 1
-	Connected = 2
-	AlreadyInUse = 3
+    """Card Tap Error Enum"""
+    Disconnected = 1
+    Connected = 2
+    AlreadyInUse = 3
+
 
 class CardReader:
-	def __init__(self, reader_settings, reader_credentials):
-		self.__instance = c_void_p(0)
-		self.reader_credentials = reader_credentials
-		self.on_card_tap = None
-		self.on_status_change = None
-		
-		if reader_settings is None:
-			self.reader_settings = ReaderSettings(get_devices_list()[0])
-		else:
-			self.reader_settings = reader_settings
-			
-		create_instance_by_name(addressof(self.__instance), self.reader_settings.device_name, self.reader_credentials.api_key)
-		
-	def __del__(self):
-		destroy_instance(self.__instance)
-	
-	def listen(self):
-		run_on_card_present(self.__instance, self.__get_internal_card_tap_handler(), self.on_status_change)
-	
-	def __get_internal_card_tap_handler(self):
-		def internal_card_tap_handler(card_tap_response):
-			response = CardTapResponse(card_tap_response.isSuccess, card_tap_response.errorCode, CardDetails(card_tap_response.uid[:24].decode()))
-		
-			self.on_card_tap(response)
-		
-		return internal_card_tap_handler
+    def __init__(self, reader_settings, reader_credentials):
+        self.reader_credentials = reader_credentials
+        self.on_card_tap = None
+        self.on_status_change = None
+
+        if reader_settings is None:
+            self.reader_settings = ReaderSettings(get_devices_list()[0])
+        else:
+            self.reader_settings = reader_settings
+
+        self.__instance = create_instance_by_name(self.reader_settings.device_name, self.reader_credentials.api_key)
+
+    def __del__(self):
+        destroy_instance(self.__instance)
+
+    def listen(self):
+        run_on_card_present(self.__instance, self.__get_internal_card_tap_handler(), self.on_status_change)
+
+    def __get_internal_card_tap_handler(self):
+        def internal_card_tap_handler(card_tap_response):
+            response = CardTapResponse(card_tap_response.isSuccess, card_tap_response.errorCode, CardDetails(card_tap_response.uid[:24].decode()))
+
+            self.on_card_tap(response)
+
+        return internal_card_tap_handler

Cards/CardTapResponse.py

@@ -1,18 +1,19 @@
 class CardTapError:
-	"""Card Tap Error Enum"""
-	InternetError = 1
-	ApiKeyInvalid = 2
-	TransactionTokenInvalid = 3
-	UserNotAssociatedWithCardReader = 4
-	NoSuchTPID = 5
-	TransactionTokenMissing = 6
-	TransactionTokenDoesntExist = 7
-	TransactionTokenAlreadyUsed = 8
-	TransactionTokenAlreadyValidated = 9
-	
+    """Card Tap Error Enum"""
+    InternetError = 1
+    ApiKeyInvalid = 2
+    TransactionTokenInvalid = 3
+    UserNotAssociatedWithCardReader = 4
+    NoSuchTPID = 5
+    TransactionTokenMissing = 6
+    TransactionTokenDoesntExist = 7
+    TransactionTokenAlreadyUsed = 8
+    TransactionTokenAlreadyValidated = 9
+
+
 class CardTapResponse:
-	"""Card Tap Response Class"""
-	def __init__(self, is_success, error, card_details):
-		self.is_success = is_success
-		self.error = error
-		self.card_details = card_details
+    """Card Tap Response Class"""
+    def __init__(self, is_success, error, card_details):
+        self.is_success = is_success
+        self.error = error
+        self.card_details = card_details

Cards/CardsBase.dll

@@ -1,9 +1,11 @@
 from ctypes import *
 
+
 class DevicesList(Structure):
     _fields_ = [("names", POINTER(c_char_p)),
                 ("count", c_int)]
 
+
 class CardTapResponse(Structure):
     _fields_ = [("isSuccess", c_int),
                 ("errorCode", c_int),
@@ -19,41 +21,34 @@ class CardTapResponse(Structure):
 freeDevicesList = CardsBase.freeDevicesList
 
 getDevicesList.restype = DevicesList
-createInstanceByName.restype = c_int
+createInstanceByName.restype = c_void_p
 destroyInstance.restype = c_int
 runOnCardPresent.restype = None
 freeDevicesList.restype = None
 
 CARD_TAP_FUNC = WINFUNCTYPE(None, CardTapResponse)
 STATUS_CHANGE_FUNC = WINFUNCTYPE(None, c_int)
 
+
 def get_devices_list():
     devices_list_struct = getDevicesList()
     devices_list = []
 
     for i in range(devices_list_struct.count):
-    	devices_list.append(devices_list_struct.names[i].decode())
+        devices_list.append(devices_list_struct.names[i].decode())
 
     freeDevicesList(devices_list_struct)
-    
+
     return devices_list
 
-# instance = addressof, a pointer to the instance (address of c_void_p)
-# device_name = str
-# api_key = str
-def create_instance_by_name(instance, device_name, api_key):
-    return createInstanceByName(instance, c_char_p(device_name.encode()), c_char_p(api_key.encode()))
 
-# instance = c_void_p
-def destroy_instance(instance): 
+def create_instance_by_name(device_name, api_key):
+    return createInstanceByName(c_char_p(device_name.encode()), c_char_p(api_key.encode()))
+
+
+def destroy_instance(instance):
     return destroyInstance(instance)
 
-# instance = c_void_p
-# card_tap_handler = CARD_TAP_FUNC
-# status_change_handler = STATUS_CHNAGE_FUNC
+
 def run_on_card_present(instance, card_tap_handler, status_change_handler):
     runOnCardPresent(instance, CARD_TAP_FUNC(card_tap_handler), STATUS_CHANGE_FUNC(status_change_handler))
-
-    
-    
-

Cards/NativeBaseDriver.py

@@ -1,4 +1,4 @@
 class ReaderCredentials:
     """Reader Credentials Class"""
     def __init__(self, api_key):
-        self.api_key = api_key
+        self.api_key = api_key

Cards/ReaderCredentials.py

@@ -1,4 +1,4 @@
 class ReaderSettings:
     """Reader Settings Class"""
     def __init__(self, device_name):
-        self.device_name = device_name
+        self.device_name = device_name

Cards/ReaderSettings.py

@@ -1,6 +1,7 @@
-from Cards.CardReader import ReaderStatus, CardReader
-from Cards.ReaderCredentials import ReaderCredentials
-from Cards.ReaderSettings import ReaderSettings
-from Cards.CardTapResponse import CardTapResponse, CardTapError
+from cards.CardReader import ReaderStatus, CardReader
+from cards.ReaderCredentials import ReaderCredentials
+from cards.ReaderSettings import ReaderSettings
+from cards.CardTapResponse import CardTapResponse, CardTapError
 
-__all__ = ['ReaderStatus' ,'CardReader', 'ReaderCredentials', 'ReaderSettings', 'CardTapResponse']
+
+__all__ = ['ReaderStatus', 'CardReader', 'ReaderCredentials', 'ReaderSettings', 'CardTapResponse']

Cards/__init__.py

@@ -1,43 +1,58 @@
-from Cards import *
+from cards import *
 
- 
-#Handle Card Tap event. This event is raised when a user taps his phone on the reader. 
-#Note that Cards must be installed on the phone.
+
+"""Handles Card Tap event.
+This event is raised when a user taps his phone on the reader.
+"""
 def card_tap_handler(card_info):
-	if not card_info.is_success:
-		print('Error reading card, Error: {0}'.format(card_info.error))
-		return
-	
-	print('Card read, user id: {0}'.format(card_info.card_details.user_id))
-	
-	'''Your code goes here!
-	Do whatever you want with the accepted User ID!
-
-	-----------------------
-	Example: Open the door, if the user is authorized
-	-----------------------
-	if YourSystem.IsAuthorizedToOpenDoor(card_info.card_details.user_id, Doors.Hallway):
-		YourSystem.OpenDoor(Doors.Hallway)
-	
-	-----------------------
-	Example: Remove balance
-	----------------------
-	YourSystem.Users.ChangeBalance(card_info.card_details.user_id, -10);'''
-	
-#Handles reader status change. 	
+    if not card_info.is_success:
+        print('Error reading card, Error: %d' % card_info.error)
+        return
+
+    print('Card read, user id: %s' % card_info.card_details.user_id)
+
+    '''
+    Your code goes here!
+    Do whatever you want with the accepted User ID!
+
+    -----------------------
+    Example: Open the door, if the user is authorized
+    -----------------------
+    if YourSystem.IsAuthorizedToOpenDoor(card_info.card_details.user_id, Doors.Hallway):
+        YourSystem.OpenDoor(Doors.Hallway)
+
+    -----------------------
+    Example: Remove balance
+    ----------------------
+    YourSystem.Users.ChangeBalance(card_info.card_details.user_id, -10);
+    '''
+
+
+"""Handles reader status change."""
 def status_change_handler(status):
-	if status is ReaderStatus.Disconnected:
-		print('Card reader has been disconnected')
-	elif status is ReaderStatus.Connected:
-		print('Card reader has been connected')
+    if status is ReaderStatus.Disconnected:
+        print('Card reader has been disconnected')
+    elif status is ReaderStatus.Connected:
+        print('Card reader has been connected')
+    else:
+        print('Error: unknown status change')
+
+
+def main():
+    # Initialize the ReaderCredentials and ReaderSettings objects with wanted / needed parameters
+    reader_credentials = ReaderCredentials('ABCD1234ABCD1234ABCD1234')
+    reader_settings = ReaderSettings('ACS - ACR122U PICC Interface')
 
+    # Initialize the CardReader object with ReaderCredentials and ReaderSettings.
+    card_reader = CardReader(reader_settings, reader_credentials)
 
-reader_credentials = ReaderCredentials('ABCD1234ABCD1234ABCD1234')
-reader_settings = ReaderSettings('ACS - ACR122U PICC Interface')
+    # Set the on_card_tap and on_status_change events
+    card_reader.on_card_tap = card_tap_handler
+    card_reader.on_status_change = status_change_handler
 
-card_reader = CardReader(reader_settings, reader_credentials)
+    # Start listening
+    card_reader.listen()
 
-card_reader.on_card_tap = card_tap_handler
-card_reader.on_status_change = status_change_handler
 
-card_reader.listen()
+if __name__ == "__main__":
+    main()