New open_door method

Author: pawl

README.md

@@ -9,6 +9,7 @@ Main Features
 -----
 
 - Programmatically add and remove users to/from the access control system
+- Programmatically trigger the relay to open the door
 - Convert the 10-digit format RFID numbers to comma format or vice versa
 
 Hardware Requirement
@@ -57,13 +58,22 @@ Remove user (using 10-digit format RFID number):
 
 	client.remove_user(badge)
 
+Open door #1:
+
+	from rfid import RFIDClient
+
+	ip_address = '192.168.1.20'
+	controller_serial = 123106461
+	client = RFIDClient(ip_address, controller_serial)
+
+	client.open_door(1)
+	
 TODO
 -----
 - Add an optional name parameter to add_user. The access controller also stores the user's name.
 - The controller also stores the user's 2-factor pin for when the keypad is enabled. Need to add an optional parameter to add_user for a pin.
 - Add a get_users method to RFIDClient that outputs a list of all the users currently in the controller.
 - Add a get_logs method to RFIDClient which outputs the card swipe logs.
-- Add an open_door method to RFIDClient.
 
 Special Thanks
 -----

examples/open_door.py

@@ -0,0 +1,7 @@
+from rfid import RFIDClient
+
+ip_address = '192.168.1.20'
+controller_serial = 123106461
+client = RFIDClient(ip_address, controller_serial)
+
+client.open_door(1)

rfid.py

@@ -128,6 +128,21 @@ def remove_user(self, badge):
 		recv_data =  binascii.b2a_hex(self.s.recv(1024))
 		if (recv_data[:4] != '2321'):
 			raise Exception("Unexpected Result Received: %s" % recv_data)
+			
+	def open_door(self, door_number):
+		if not isinstance(door_number, int):
+			raise TypeError("RFID number must be set to an integer")
+		if not (1 <= door_number <= 4):
+			raise Exception("door_number must be 1 to 4")
+				
+		door_number = str(door_number - 1).zfill(2)
+		
+		open_door_packet = self.CRC_16_IBM("2040" + self.source_port + "0500000000000000" + self.controller_serial + "0000020001000000ffffffffffffffff" + door_number + "000000").decode('hex')
+		self.s.send(self.start_transaction)
+		self.s.send(open_door_packet)
+		recv_data =  binascii.b2a_hex(self.s.recv(1024))
+		if (recv_data[:4] != '2041'):
+			raise Exception("Unexpected Result Received: %s" % recv_data)
 
 	def __del__(self):
 		"""

setup.py

@@ -10,14 +10,14 @@
 
 setup(
     name='Chinese-RFID-Access-Control-Library',
-    version='0.0.4',
+    version='0.0.5',
     description='A library for interfacing with one of the most common RFID Access Control System sold in China.',
     long_description=readme,
     author='Paul Brown',
     author_email='paul90brown@gmail.com',
     url='https://github.com/pawl/Chinese-RFID-Access-Control-Library',
     license=license,
-	download_url = ['https://github.com/pawl/Chinese-RFID-Access-Control-Library/tarball/master#egg=package-0.0.4'],
+	download_url = ['https://github.com/pawl/Chinese-RFID-Access-Control-Library/tarball/master#egg=package-0.0.5'],
 	keywords = ['rfid', 'access control'],
     py_modules = ['rfid']
 )