VendServer/VendingMachine.py

   1 # vim:ts=4
   2 import re
   3 from CRC import do_crc
   4 from select import select
   5 import socket, logging
   6 from time import time, sleep
   7 from MIFAREClient import MIFAREClient
   8
   9 asynchronous_responses = [      '400', '401', # door open/closed
  10                                 '610',        # switches changed
  11                                 '200', '201', '202', '203', '204', '205', '206',
  12                                 '207', '208', '209', '211', # key presses
  13                          ]
  14 DOOR = 1
  15 SWITCH = 2
  16 KEY = 3
  17 TICK = 4
  18 MIFARE = 5
  19
  20 class VendingException(Exception): pass
  21
  22 class VendingMachine:
  23         def __init__(self, rfh, wfh, use_mifare):
  24                 self.events = []
  25                 # Secret
  26                 self.secret = 'SN4CKZ0RZZZZZZZZ'
  27                 self.rfh = rfh
  28                 self.wfh = wfh
  29                 self.challenge = None
  30                 # Initialise ourselves into a known state
  31                 self.wfh.write('\n')
  32                 self.await_prompt()
  33                 self.wfh.write('echo off\n')
  34                 self.await_prompt()
  35                 self.wfh.write('PING\n')
  36                 code = ''
  37                 while code != '000':
  38                         code = self.get_response()[0]
  39                 self.get_switches()
  40                 if use_mifare:
  41                         self.mifare = MIFAREClient()
  42                         self.mifare_timeout = 0
  43                 else:
  44                         self.mifare = None
  45
  46         def await_prompt(self):
  47                 self.wfh.flush()
  48                 state = 1
  49                 timeout = 0.5
  50                 prefix = ''
  51                 s = ''
  52                 # mtearle - vending machine was dying wait for a response from
  53                 # the hardware, suspect it was missing characters
  54                 #
  55                 # fixed by migration to pyserial - but future good place to start
  56                 while True:
  57                         try:
  58                                 s = self.rfh.read(1)
  59                         except socket.error:
  60                                 raise VendingException('failed to read input from vending machine')
  61                         if s == '': raise VendingException('nothing read!')
  62                         if (s != '#' and s != '%') and state == 1: prefix += s
  63                         if s == '\n' or s == '\r':
  64                                 state = 1
  65                                 prefix = ''
  66                         if (s == '#' or s == '%') and state == 1: state = 2
  67                         if s == ' ' and state == 2:
  68                                 if prefix == '':
  69                                         self.challenge = None
  70                                         return
  71                                 if re.search('^[0-9a-fA-F]{4}$', prefix):
  72                                         self.challenge = int(prefix, 16)
  73                                         return
  74
  75         def get_response(self, async = False):
  76                 self.wfh.flush()
  77                 while True:
  78                         s = ''
  79                         while s == '':
  80                                 s = self.rfh.readline()
  81                                 if s == '':
  82                                         raise VendingException('Input socket has closed!')
  83                                 s = s.strip('\r\n')
  84                         code = s[0:3]
  85                         text = s[4:]
  86                         if code in asynchronous_responses:
  87                                 self.handle_event(code, text)
  88                                 if async: return None
  89                         else:
  90                                 self.await_prompt()
  91                                 return (code, text)
  92
  93         def get_switches(self):
  94                 self.wfh.write('S\n')
  95                 (code, text) = self.get_response()
  96                 if code != '600':
  97                         return (False, code, text)
  98                 self.interpret_switches(text)
  99                 return (True, code, text)
 100
 101         def interpret_switches(self, text):
 102                 self.switches = (int(text[0:2], 16) << 8) | int(text[3:5], 16)
 103
 104         def handle_event(self, code, text):
 105                 if code == '400':
 106                         self.events.append((DOOR, 1))
 107                 elif code == '401':
 108                         self.events.append((DOOR, 0))
 109                 elif code == '610':
 110                         # NOP this. Nothing handles this yet.
 111                         #self.events.append((SWITCH, None))
 112                         self.interpret_switches(text)
 113                 elif code[0] == '2':
 114                         self.events.append((KEY, int(code[1:3])))
 115                 else:
 116                         logging.warning('Unhandled event! (%s %s)\n'%(code,text))
 117
 118         def authed_message(self, message):
 119                 print 'self.challenge = %04x' % self.challenge
 120                 if self.challenge == None:
 121                         return message
 122                 crc = do_crc('%c%c'%(self.challenge >> 8, self.challenge & 0xff))
 123                 crc = do_crc(self.secret, crc)
 124                 crc = do_crc(message, crc)
 125                 print 'output = "%s|%04x"' % (message, crc)
 126                 return message+'|'+('%04x'%crc)
 127
 128         def ping(self):
 129                 self.wfh.write('PING\n')
 130                 (code, string) = self.get_response()
 131                 return (code == '000', code, string)
 132
 133         def vend(self, item):
 134                 if not re.search('^[0-9][0-9]$', item):
 135                         return (False, 'Invalid item requested (%s)'%item)
 136                 self.wfh.write(self.authed_message(('V%s'%item))+'\n')
 137                 (code, string) = self.get_response()
 138                 return (code == '100', code, string)
 139
 140         def beep(self, duration = None, synchronous = True):
 141                 msg = 'B'
 142                 if synchronous: msg += 'S'
 143                 if duration != None:
 144                         if duration > 255: duration = 255
 145                         if duration < 1: duration = 1
 146                         msg += '%02x'%duration
 147                 self.wfh.write(msg+'\n')
 148                 (code, string) = self.get_response()
 149                 return (code == '500', code, string)
 150
 151         def silence(self, duration = None, synchronous = True):
 152                 msg = 'C'
 153                 if synchronous: msg += 'S'
 154                 if duration != None:
 155                         if duration > 255: duration = 255
 156                         if duration < 1: duration = 1
 157                         msg += '%02x'%duration
 158                 self.wfh.write(msg+'\n')
 159                 (code, string) = self.get_response()
 160                 return (code == '501', code, string)
 161
 162         def display(self, string):
 163                 # display first ten characters of string, left aligned
 164                 self.wfh.write('D%-10.10s\n' % string)
 165
 166                 (code, string) = self.get_response()
 167                 return (code == '300', code, string)
 168
 169         def next_event(self, timeout = None):
 170                 # we don't want to buffer in the serial port, so we get all the events
 171                 # we can ASAP.
 172
 173                 # Never have no timeout...
 174                 if timeout == None: timeout = 60*60*24*365
 175
 176                 # Make sure we go through the loop at least once.
 177                 if timeout < 0: timeout = 0
 178
 179                 while timeout >= 0:
 180                         this_timeout = min(timeout, 0.2)
 181                         timeout -= this_timeout
 182
 183                         (r, _, _) = select([self.rfh], [], [], this_timeout)
 184                         if r:
 185                                 self.get_response(async = True)
 186                                 timeout = 0
 187
 188                         if self.mifare:
 189                                 now = time()
 190                                 if now > self.mifare_timeout:
 191                                         self.mifare_timeout = now + 0.5
 192                                         mifare_uid = self.mifare.get_card_id()
 193                                         if mifare_uid != None:
 194                                                 logging.info('Got MIFARE card id %s'%(repr(mifare_uid)))
 195                                                 self.events.append((MIFARE, mifare_uid))
 196                                                 timeout = 0
 197                         if timeout == 0:
 198                                 break
 199
 200                 if len(self.events) == 0: return (TICK, time())
 201                 ret = self.events[0]
 202                 del self.events[0]
 203                 return ret