Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix install deps, move nfc_uid to __init__, remove shell commands #6

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix install deps, move nfc_uid to __init__, remove shell commands #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0bba337
Rename nfc_uid.py to __init__.py, to match convention
tutacat May 16, 2024
0f9ae98
Redirect nfc_uid.nfc_uid to __init__, add deprecation warning
tutacat May 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
142 changes: 142 additions & 0 deletions nfc_uid/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
import time
from packaging.version import parse as parse_version
import os
from smartcard.CardType import AnyCardType # pyscard
from smartcard.CardRequest import CardRequest
from smartcard.Exceptions import CardRequestTimeoutException
from smartcard.util import toHexString
import requests # urllib3
import keyboard as Keyboard
from smartcard.CardType import AnyCardType
from smartcard.CardRequest import CardRequest
from smartcard.Exceptions import CardRequestTimeoutException
from smartcard.util import toHexString

class NFC_UID:
__version = "0.5"
__name="nfc-uid"
pypi_version="0.5"
logging = True
last_chip = ""
loop = True

def __init__(self, logging=True):
self.logging=logging
if self.__is_pypi_version_newer() and self.logging:
if self.pypi_version!=None:
print(f"Update is available! You have [{self.__version}] but should have [{self.pypi_version}]")
else:
print("Update is available")
def __is_pypi_version_newer(self):
try:
response = requests.get(f"https://pypi.org/pypi/{self.__name}/json")
response.raise_for_status()
data = response.json()
latest_version = data["info"]["version"]
self.pypi_version = latest_version
return parse_version(latest_version) > parse_version(self.__version)
except (requests.RequestException, KeyError):
return False
def read(self, output=True, keyboardType=False, connectTimeout=120, maxRetrys=8, cooldown=2):
"""
Returns UID of NFC Chip/Card
Set ouput to False if no print/output is required default is True
output -> def = True | Output for success/feedback etc. will be enabled
connectTimeout -> def = 120/2min | Sets timeout in seconds. Timeout for scan card.
maxRetrys -> def 8 | Sets maximum read trys befor break. Set to None for infinite
retryCooldown -> def 2 | Sets timeout in seconds for read retry
"""
counter = 0
while maxRetrys==None or counter<maxRetrys:
try:
if output:
print("Waiting for NFC-Card..")
getuid = [0xFF, 0xCA, 0x00, 0x00, 0x00]
act = AnyCardType()
cr = CardRequest(timeout=connectTimeout, cardType=act)
cs = cr.waitforcard()
cs.connection.connect()
data, sw1, sw2 = cs.connection.transmit(getuid)
data = toHexString(data)
data = data.replace(" ", "")
if data and data != self.last_chip or True:
self.last_chip = data
if output:
print(f"Success in reading chip..\nUID: {data}")
if keyboardType:
if self.logging:
print("Output send to keyboard")
Keyboard.write(f"{data}")
else:
return data
break
cs = None
except CardRequestTimeoutException:
if self.logging:
print("Connection timed out... New request starting")
except Exception as x:
if self.logging:
print(f"Error: {x}")
counter+=1
time.sleep(cooldown)

def nfc_reader(self, debug=True ,output=True, keyboard_output=False, set_timeout=120, set_cooldown = 3):
"""
Returns UID of NFC Chip/Card
Set ouput to False if no output is required default is True
debug -> def = True | Output for errors etc. will be enabled
output -> def = True | Output for success/feedback etc. will be enabled
keyboard_output -> def False | Types output like typing it
set_timeout -> def 120/2min | Sets timeout in seconds. Timeout for scan card.
"""
if self.logging:
print("Function nfc_read is depricated! Please change to read")

while True:
try:
if output:
print("Waiting for Card..")
getuid=[0xFF, 0xCA, 0x00, 0x00, 0x00]
act = AnyCardType()
cr = CardRequest( timeout=set_timeout, cardType=act )
cs = cr.waitforcard()
cs.connection.connect()
data, sw1, sw2 = cs.connection.transmit(getuid)
data = toHexString(data)
data = data.replace(" ", "")
if data and data != self.last_chip or True:
self.last_chip = data
if output:
print(f"Success in reading chip..\nUID: {data}")
if keyboard_output:
if debug:
print("Output send to keyboard")
Keyboard.write(f"{data}")
else:
return data
time.sleep(set_cooldown)
break
cs=None
except CardRequestTimeoutException:
if debug:
print("Connection timed out... New request starting")
except Exception as x:
if debug:
print(f"Error: {x}")

def looped_read(self, output=True, keyboardType=False, connectTimeout=120, maxRetrys=8, cooldown=2):
"""
While loop for NFC_UID.read
Will be looped until Enviroment.__loop__ is False
USE WITH THREAD ONLY!
output -> def = True | Output for success/feedback etc. will be enabled
connectTimeout -> def = 120/2min | Sets timeout in seconds. Timeout for scan card.
maxRetrys -> def 8 | Sets maximum read trys befor break. Set to None for infinite
retryCooldown -> def 2 | Sets timeout in seconds for read retry
"""
while self.loop:
self.read(output=output, keyboardType=keyboardType, connectTimeout=connectTimeout, maxRetrys=maxRetrys, cooldown=cooldown)

if __name__ == "__main__":
reader = NFC_UID()
reader.read()
161 changes: 3 additions & 158 deletions nfc_uid/nfc_uid.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,158 +1,3 @@
import time
from packaging.version import parse as parse_version
import os
try:
from smartcard.CardType import AnyCardType
from smartcard.CardRequest import CardRequest
from smartcard.Exceptions import CardRequestTimeoutException
from smartcard.util import toHexString
except ImportError:
os.system('python -m pip install pyscard')
try:
import requests
except ImportError:
os.system('python -m pip install requests')
os.system('python -m pip install urllib3==1.26.15')
try:
import keyboard as Keyboard
except ImportError:
os.system('python -m pip install keyboard')
try:
import keyboard as Keyboard
import requests
from smartcard.CardType import AnyCardType
from smartcard.CardRequest import CardRequest
from smartcard.Exceptions import CardRequestTimeoutException
from smartcard.util import toHexString
except Exception as x:
print(f"FATAL ERROR: We could not load all required libary's! -> {x}")
os._exit(1)

class NFC_UID:
__version = "0.5"
__name="nfc-uid"
pypi_version="0.5"
logging = True
last_chip = ""
loop = True

def __init__(self, logging=True):
self.logging=logging
if self.__is_pypi_version_newer() and self.logging:
if self.pypi_version!=None:
print(f"Update is available! You have [{self.__version}] but should have [{self.pypi_version}]")
else:
print("Update is available")
def __is_pypi_version_newer(self):
try:
response = requests.get(f"https://pypi.org/pypi/{self.__name}/json")
response.raise_for_status()
data = response.json()
latest_version = data["info"]["version"]
self.pypi_version = latest_version
return parse_version(latest_version) > parse_version(self.__version)
except (requests.RequestException, KeyError):
return False
def read(self, output=True, keyboardType=False, connectTimeout=120, maxRetrys=8, cooldown=2):
"""
Returns UID of NFC Chip/Card
Set ouput to False if no print/output is required default is True
output -> def = True | Output for success/feedback etc. will be enabled
connectTimeout -> def = 120/2min | Sets timeout in seconds. Timeout for scan card.
maxRetrys -> def 8 | Sets maximum read trys befor break. Set to None for infinite
retryCooldown -> def 2 | Sets timeout in seconds for read retry
"""
counter = 0
while maxRetrys==None or counter<maxRetrys:
try:
if output:
print("Waiting for NFC-Card..")
getuid = [0xFF, 0xCA, 0x00, 0x00, 0x00]
act = AnyCardType()
cr = CardRequest(timeout=connectTimeout, cardType=act)
cs = cr.waitforcard()
cs.connection.connect()
data, sw1, sw2 = cs.connection.transmit(getuid)
data = toHexString(data)
data = data.replace(" ", "")
if data and data != self.last_chip or True:
self.last_chip = data
if output:
print(f"Success in reading chip..\nUID: {data}")
if keyboardType:
if self.logging:
print("Output send to keyboard")
Keyboard.write(f"{data}")
else:
return data
break
cs = None
except CardRequestTimeoutException:
if self.logging:
print("Connection timed out... New request starting")
except Exception as x:
if self.logging:
print(f"Error: {x}")
counter+=1
time.sleep(cooldown)

def nfc_reader(self, debug=True ,output=True, keyboard_output=False, set_timeout=120, set_cooldown = 3):
"""
Returns UID of NFC Chip/Card
Set ouput to False if no output is required default is True
debug -> def = True | Output for errors etc. will be enabled
output -> def = True | Output for success/feedback etc. will be enabled
keyboard_output -> def False | Types output like typing it
set_timeout -> def 120/2min | Sets timeout in seconds. Timeout for scan card.
"""
if self.logging:
print("Function nfc_read is depricated! Please change to read")

while True:
try:
if output:
print("Waiting for Card..")
getuid=[0xFF, 0xCA, 0x00, 0x00, 0x00]
act = AnyCardType()
cr = CardRequest( timeout=set_timeout, cardType=act )
cs = cr.waitforcard()
cs.connection.connect()
data, sw1, sw2 = cs.connection.transmit(getuid)
data = toHexString(data)
data = data.replace(" ", "")
if data and data != self.last_chip or True:
self.last_chip = data
if output:
print(f"Success in reading chip..\nUID: {data}")
if keyboard_output:
if debug:
print("Output send to keyboard")
Keyboard.write(f"{data}")
else:
return data
time.sleep(set_cooldown)
break
cs=None
except CardRequestTimeoutException:
if debug:
print("Connection timed out... New request starting")
except Exception as x:
if debug:
print(f"Error: {x}")

def looped_read(self, output=True, keyboardType=False, connectTimeout=120, maxRetrys=8, cooldown=2):
"""
While loop for NFC_UID.read
Will be looped until Enviroment.__loop__ is False
USE WITH THREAD ONLY!
output -> def = True | Output for success/feedback etc. will be enabled
connectTimeout -> def = 120/2min | Sets timeout in seconds. Timeout for scan card.
maxRetrys -> def 8 | Sets maximum read trys befor break. Set to None for infinite
retryCooldown -> def 2 | Sets timeout in seconds for read retry
"""
while self.loop:
self.read(output=output, keyboardType=keyboardType, connectTimeout=connectTimeout, maxRetrys=maxRetrys, cooldown=cooldown)

if __name__ == "__main__":
reader = NFC_UID()
reader.read()
import sys
print("nfc_uid.nfc_uid is deprecated. Please use `import nfc_uid` instead.", file=sys.stderr)
from .__init__ import *
13 changes: 9 additions & 4 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
[build-system]
requires=['keyboard>=0.13.5',
'pyscard>=2.0.2',
'setuptools'
]
requires=["setuptools"]
build-backend = "setuptools.build_meta"

[project]
requires=[
"keyboard>=0.13.5",
"pyscard>=2.0.2",
"setuptools",
"urllib3",
]