Domoticz

Code: Select all

# Date: 2018 01 12 Original version
#       2018 02 28 Added read csv with link: switch id TO domoticz idx
#		  Read serial line and add to log as 'respons'
#       2018 03 16 Added 'C' telegram mapped to 'Stop' (for devices Venitian Blinds EU)
#	       19 Added Dict for Commands
#		  Made path to devices.csv relative
#		  Added counter for devices table
#	       30 Added different behaviour for Blinds. SwitchType will be checked first
#
from socket import * 
from threading import Thread
import logging
import serial
import time
import sys
import os
import csv
import json, urllib, urllib2

ser = None

allClients = []
BUFSIZ = 1024
serialDevice = None


def serialReader():
  global ser
  global allClients
  global serialDevice
  global domoticzIP
  global domoticzPort
  global pairingFile

  line = []
  oldLine = ''
  oldTime = time.time()
  allDevices = {}
  CommandMap = {'A':'On','B':'Off','C':'Stop','D':'Off'}
  CommandMapBlind = {'A':'Off','B':'On','C':'Stop','D':'Off'}

  while 1:
    try:
      # configure the serial connections (the parameters differs on the device you are connecting to)
      ser = serial.Serial(
	port=serialDevice,
	baudrate=57600,
	parity=serial.PARITY_NONE,
	stopbits=serial.STOPBITS_ONE,
	bytesize=serial.EIGHTBITS
      )

      ser.isOpen()
      logging.info('Serial port opened %s', ser)

      # load device table from csv file
      logging.info('Device table being loaded in dictionnary.')
      ifile = open(pairingFile, "rU")
      logging.info('Device table being opened.')
      reader = csv.reader(ifile, delimiter=";")
      allDevices = dict([(row[0],row[1]) for row in reader])
      ifile.close()
      logging.info('Device table being closed.')
      logging.info('Device table loaded in dictionnary. Number of devices loaded: %d ' % len(allDevices))

      # main listener loop
      while 1:
	out = ser.read(1)
	line.append(out)
	# wait till '\r' as end of line char
	if out == '\r':
		myLine = ''.join(line)
		myTime = time.time()
		logging.info('Serial respons : %s', myLine)
		# if myLine starts with REC :split line use second part as key in dict and lauch json call
		if myLine[0:3] == 'REC':
		   if allDevices.get(myLine[4:10]) is None:
		      # transmitter not in devices.csv
		      logging.info('Warning : unknown physical RF transmitter: %s  Please add to device table with corresponding idx', myLine[4:10])
		   else:
      			# Check with Domoticz what kind of switch we are dealing with
		   	result_load = json.load(urllib2.urlopen("http://%s:%s/json.htm?type=devices&rid=%s" % ( domoticzIP, domoticzPort, allDevices.get(myLine[4:10])), timeout=5))
			if result_load["result"][0]["SwitchTypeVal"] is None:
			  logging.info("Warning : Key :  %s is linked to idx: %s but its not a Switch "%  (myLine[4:10],allDevices.get(myLine[4:10])))
			else:
			 if result_load["result"][0]["SwitchTypeVal"] == 15:
	       		    myCommand = CommandMapBlind.get(myLine[11])
			 else:
	       		    myCommand = CommandMap.get(myLine[11])
 	  		 # known physical RF transmitter linked to switch
  			 if myCommand is None:
			    logging.info('Warning : unknown Command from physical transmitter: ' + myLine[11])
		   	 else:
 			    logging.info('Key : ' + myLine[4:10] + ' Mapped to : ' +  allDevices.get(myLine[4:10]) + ' Telegram : ' + myLine[11] + ' mapped to Command : ' + myCommand)
		   	    # switches may bounce and emit rapidly 2 to 5 times the same command: debounce by comparing content and time lapse (more than 1 sec apart)
			    if myLine <> oldLine or myTime - oldTime > 1: 
		       		# transfer received command to Domoticz
			       	result_load = json.load(urllib2.urlopen("http://%s:%s/json.htm?type=command&param=switchlight&idx=%s&switchcmd=%s&level=0" % (domoticzIP, domoticzPort, allDevices.get(myLine[4:10]), myCommand), timeout=5))
		       		logging.info('Respons domoticz : %s', str(result_load))
				# arm debounce mechanism
		       		oldTime = myTime
		       		oldLine = myLine
		else:
		   # respons is not from physical switch
		   # write line to all clients
		   for elem in line:
		       for client in allClients:
 		  	   client.send(elem)
		# Clear line
		line = []
    except:
      # Wait a while then try again
      logging.debug('Error on serial port')
      if ser is not None:
	ser.close()
      ser = None
      time.sleep(10)

def handler(clientsock,addr):
  global ser
  global allClients
  logging.info('connected from: %s', addr)
  allClients.append(clientsock)
  while 1:
    data = clientsock.recv(BUFSIZ)
    if not data: 
      break 
    if not (ser is None):
      ser.write(data)
      logging.info('Message received: %s ', data)
  logging.info('disconnected from: %s', addr)
  allClients.remove(clientsock)
  clientsock.close()

def mainProgram():
  global serialDevice
  global port
  global domoticzIP
  global domoticzPort
  global pairingFile

  if len(sys.argv)>=8 and sys.argv[1] == '-p':
    writePidFile(sys.argv[2])
    del sys.argv[2]
    del sys.argv[1]
  if len(sys.argv) != 6:
    print ('usage: ' + sys.argv[0] + ' device port domoticzIP domoticzPort pairingFile')
    exit()

  print ('Logfile: /tmp/SerProxy.Log')
  logging.basicConfig(filename='/tmp/SerProxy.Log', filemode='w', format='%(asctime)s %(levelname)s:%(message)s', level=logging.DEBUG)

  serialDevice=sys.argv[1]
  port=int(sys.argv[2])
  domoticzIP=sys.argv[3]
  domoticzPort=sys.argv[4]
  pairingFile=sys.argv[5]

  print ('Version Serial Proxy: RX09v20180330')
  print ('Serial Device: ' + sys.argv[1])
  print ('Serial Port: ' + sys.argv[2])
  print ('Domoticz IP: ' + sys.argv[3])
  print ('Domoticz Port: ' + sys.argv[4])
  print ('Pairing File: ' + sys.argv[5])

  logging.info('Version Serial Proxy: RX09v20180330')
  logging.info('Serial Device: ' + sys.argv[1])
  logging.info('Serial Port: ' + sys.argv[2])  
  logging.info('Domoticz IP: ' + sys.argv[3])
  logging.info('Domoticz Port: ' + sys.argv[4])
  logging.info('Pairing File: ' + sys.argv[5])

  Thread(target=serialReader).start()

  ser = None
  allClients = []

  listenAddr = ('', port)
  try:
    serversock = socket(AF_INET, SOCK_STREAM)
    serversock.bind(listenAddr)
    serversock.listen(2)
    logging.info('waiting for connection')

    while 1:
      clientsock, addr = serversock.accept()
      Thread(target=handler, args=(clientsock, addr)).start()
  except KeyboardInterrupt:
    if not ser is None:
      ser.close()
    os._exit(0)

def writePidFile(pidfile):
    pid = str(os.getpid())
    f = open(pidfile, 'w')
    f.write(pid)
    f.close()

if __name__=='__main__':
    mainProgram()

Code: Select all

# Date: 2018 01 12 Original version
#       2018 02 28 Added read csv with link: switch id TO domoticz idx
#                  Read serial line and add to log as 'respons'
#       2018 03 16 Added 'C' telegram mapped to 'Stop' (for devices Venitian Blinds EU)
#               19 Added Dict for Commands
#                  Made path to devices.csv relative
#                  Added counter for devices table
#               30 Added different behaviour for Blinds. SwitchType will be checked first
#
from socket import * 
from threading import Thread
import logging
import serial
import time
import sys
import os
import csv
import json, urllib, urllib2

ser = None

allClients = []
BUFSIZ = 1024
serialDevice = None


def serialReader():
  global ser
  global allClients
  global serialDevice
  global domoticzIP
  global domoticzPort
  global pairingFile

  line = []
  oldLine = ''
  oldTime = time.time()
  allDevices = {}
  CommandMap = {'A':'On','B':'Off','C':'Stop','D':'Off'}
  CommandMapBlind = {'A':'Off','B':'On','C':'Stop','D':'Off'}

  while 1:
    try:
      # configure the serial connections (the parameters differs on the device you are connecting to)
      ser = serial.Serial(
        port=serialDevice,
        baudrate=57600,
        parity=serial.PARITY_NONE,
        stopbits=serial.STOPBITS_ONE,
        bytesize=serial.EIGHTBITS
      )

      ser.isOpen()
      logging.info('Serial port opened %s', ser)

      # load device table from csv file
      logging.info('Device table being loaded in dictionnary.')
      ifile = open(pairingFile, "rU")
      logging.info('Device table being opened.')
      reader = csv.reader(ifile, delimiter=";")
      allDevices = dict([(row[0],row[1]) for row in reader])
      ifile.close()
      logging.info('Device table being closed.')
      logging.info('Device table loaded in dictionnary. Number of devices loaded: %d ' % len(allDevices))

      # main listener loop
      while 1:
        out = ser.read(1)
        line.append(out)
        # wait till '\r' as end of line char
        if out == '\r':
                myLine = ''.join(line)
                myTime = time.time()
                logging.info('Serial respons : %s', myLine)
                # if myLine starts with REC :split line use second part as key in dict and lauch json call
                if myLine[0:3] == 'REC':
                   if allDevices.get(myLine[4:10]) is None:
                      # transmitter not in devices.csv
                      logging.info('Warning : unknown physical RF transmitter: %s  Please add to device table with corresponding idx', myLine[4:10])
                   else:
                           # Check with Domoticz what kind of switch we are dealing with
                           result_load = json.load(urllib2.urlopen("http://%s:%s/json.htm?type=devices&rid=%s" % ( domoticzIP, domoticzPort, allDevices.get(myLine[4:10])), timeout=5))
                           if result_load["result"][0]["SwitchTypeVal"] is None:
                              logging.info("Warning : Key :  %s is linked to idx: %s but its not a Switch "%  (myLine[4:10],allDevices.get(myLine[4:10])))
                           else:
                              if result_load["result"][0]["SwitchTypeVal"] == 15:
                                 myCommand = CommandMapBlind.get(myLine[11])
                              else:
                                   myCommand = CommandMap.get(myLine[11])
                           # known physical RF transmitter linked to switch
                           if myCommand is None:
                              logging.info('Warning : unknown Command from physical transmitter: ' + myLine[11])
                           else:
                              logging.info('Key : ' + myLine[4:10] + ' Mapped to : ' +  allDevices.get(myLine[4:10]) + ' Telegram : ' + myLine[11] + ' mapped to Command : ' + myCommand)
                              # switches may bounce and emit rapidly 2 to 5 times the same command: debounce by comparing content and time lapse (more than 1 sec apart)
                              if myLine != oldLine or myTime - oldTime > 1: 
                                 # transfer received command to Domoticz
                                 result_load = json.load(urllib2.urlopen("http://%s:%s/json.htm?type=command&param=switchlight&idx=%s&switchcmd=%s&level=0" % (domoticzIP, domoticzPort, allDevices.get(myLine[4:10]), myCommand), timeout=5))
                                 logging.info('Respons domoticz : %s', str(result_load))
                                 # arm debounce mechanism
                                 oldTime = myTime
                                 oldLine = myLine
                else:
                   # respons is not from physical switch
                   # write line to all clients
                   for elem in line:
                       for client in allClients:
                              client.send(elem)
                # Clear line
                line = []
    except:
      # Wait a while then try again
      logging.debug('Error on serial port')
      if ser is not None:
       ser.close()
      ser = None
      time.sleep(10)

def handler(clientsock,addr):
  global ser
  global allClients
  logging.info('connected from: %s', addr)
  allClients.append(clientsock)
  while 1:
    data = clientsock.recv(BUFSIZ)
    if not data: 
      break 
    if not (ser is None):
      ser.write(data)
      logging.info('Message received: %s ', data)
  logging.info('disconnected from: %s', addr)
  allClients.remove(clientsock)
  clientsock.close()

def mainProgram():
  global serialDevice
  global port
  global domoticzIP
  global domoticzPort
  global pairingFile

  if len(sys.argv)>=8 and sys.argv[1] == '-p':
    writePidFile(sys.argv[2])
    del sys.argv[2]
    del sys.argv[1]
  if len(sys.argv) != 6:
    print ('usage: ' + sys.argv[0] + ' device port domoticzIP domoticzPort pairingFile')
    exit()

  print ('Logfile: /tmp/SerProxy.Log')
  logging.basicConfig(filename='/tmp/SerProxy.Log', filemode='w', format='%(asctime)s %(levelname)s:%(message)s', level=logging.DEBUG)

  serialDevice=sys.argv[1]
  port=int(sys.argv[2])
  domoticzIP=sys.argv[3]
  domoticzPort=sys.argv[4]
  pairingFile=sys.argv[5]

  print ('Version Serial Proxy: RX09v20180330')
  print ('Serial Device: ' + sys.argv[1])
  print ('Serial Port: ' + sys.argv[2])
  print ('Domoticz IP: ' + sys.argv[3])
  print ('Domoticz Port: ' + sys.argv[4])
  print ('Pairing File: ' + sys.argv[5])

  logging.info('Version Serial Proxy: RX09v20180330')
  logging.info('Serial Device: ' + sys.argv[1])
  logging.info('Serial Port: ' + sys.argv[2])  
  logging.info('Domoticz IP: ' + sys.argv[3])
  logging.info('Domoticz Port: ' + sys.argv[4])
  logging.info('Pairing File: ' + sys.argv[5])

  Thread(target=serialReader).start()

  ser = None
  allClients = []

  listenAddr = ('', port)
  try:
    serversock = socket(AF_INET, SOCK_STREAM)
    serversock.bind(listenAddr)
    serversock.listen(2)
    logging.info('waiting for connection')

    while 1:
      clientsock, addr = serversock.accept()
      Thread(target=handler, args=(clientsock, addr)).start()
  except KeyboardInterrupt:
    if not ser is None:
      ser.close()
    os._exit(0)

def writePidFile(pidfile):
    pid = str(os.getpid())
    f = open(pidfile, 'w')
    f.write(pid)
    f.close()

if __name__=='__main__':
    mainProgram()