scriptcomm.py library

git-svn-id: http://svn.code.sf.net/p/rts-2/code/trunk/rts-2@10331 65ab8f4e-f147-0410-b3a9-f14133ecfe55

ChangeLog

@@ -1,3 +1,6 @@
+2012-05-04
+ * Python libraries - scriptcomm.py
+
 2012-04-24
  * time on sky statistics
 

Makefile.am

@@ -6,8 +6,10 @@ SUBDIRS =	include \
 		doc	\
 		man	\
 		contrib \
+		python  \
 		scripts \
-		conf
+		conf   
+
 
 EXTRA_DIST = autogen.sh RUN rts2.initd \
 	INSTALL INSTALL.alta INSTALL.fli INSTALL.paramount INSTALL.andor \

configure.ac

@@ -18,6 +18,8 @@ AC_PROG_LIBTOOL
 AC_PROG_MAKE_SET
 AC_PROG_RANLIB
 
+AM_PATH_PYTHON
+
 # check for lang
 AC_LANG_CPLUSPLUS
 
@@ -815,6 +817,8 @@ AC_OUTPUT([Makefile
 	   lib/rts2fits/Makefile
 	   lib/rts2db/Makefile
 	   lib/rts2script/Makefile
+	   python/Makefile
+	   python/lib/Makefile
 	   src/libindi/Makefile 
 	   scripts/Makefile
 	   src/Makefile

python/Makefile.am

@@ -0,0 +1 @@
+SUBDIRS = lib

python/lib/Makefile.am

@@ -0,0 +1 @@
+pkgpython_PYTHON = __init__.py scriptcomm.py

python/lib/__init__.py

@@ -0,0 +1,17 @@
+# RTS2 libraries
+# (C) 2009-2012 Petr Kubanek <petr@kubanek.net>
+# (C) 2010-2012 Petr Kubanek, Institute of Physics
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

python/lib/scriptcomm.py

@@ -0,0 +1,312 @@
+#!/usr/bin/python
+#
+# RTS2 script communication
+# (C) 2009,2010 Petr Kubanek <petr@kubanek.net>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+import sys
+import time
+import re
+
+# constants for device types
+DEVICE_TELESCOPE   = "TELESCOPE"
+DEVICE_CCD         = "CCD"
+DEVICE_DOME        = "DOME"
+DEVICE_WEATHER     = "WEATHER"
+DEVICE_PHOT        = "PHOT"
+DEVICE_PLAN        = "PLAN"
+DEVICE_FOCUS       = "FOCUS"
+DEVICE_CUPOLA      = "CUPOLA"
+DEVICE_FW          = "FW"
+DEVICE_SENSOR      = "SENSOR"
+
+# constants for dataypes
+
+DT_RA              = "DT_RA"
+DT_DEC             = "DT_DEC"
+DT_DEGREES         = "DT_DEGREES"
+DT_DEG_DIST        = "DT_DEG_DIST"
+DT_PERCENTS        = "DT_PERCENTS"
+DT_ROTANG          = "DT_ROTANG"
+DT_HEX             = "DT_HEX"
+DT_BYTESIZE        = "DT_BYTESIZE"
+DT_KMG             = "DT_KMG"
+DT_INTERVAL        = "DT_INTERVAL"
+DT_ONOFF           = "DT_ONOFF"
+
+class Rts2Exception(Exception):
+	"""Thrown on exceptions on communicated over stdin/stdout connection."""
+	def __init__(self,message):
+		Exception.__init__(self,message)
+
+class Rts2NotActive(Exception):
+	def __init__(self):
+		Exception.__init__(self,'script is not active')
+
+class Rts2Comm:
+	"""Class for communicating with RTS2 in exe command."""
+	def __init__(self):
+		self.exception_re = re.compile('([!&]) (\S.*)')
+
+	def sendCommand(self,command,device = None):
+		"""Send command to device."""
+		if device is None:
+		  	print 'command',command
+		else:
+		  	print 'C',device,command
+		sys.stdout.flush()
+
+	def readline(self):
+		"""Reads single line from standard input. Checks for exceptions."""
+		ex = None
+		while True:
+			a = sys.stdin.readline().rstrip('\n')
+			# handle exceptions
+			m = self.exception_re.match(a)
+			if m:
+				if m.group(1) == '!':
+					self.log('W','exception from device: {0}'.format(m.group(2)))
+					ex = Rts2Exception(m.group(2))
+				elif m.group(1) == '&':
+					raise Rts2NotActive()
+			elif ex:
+				raise ex
+			else:
+				return a
+
+	def getValue(self,value,device = None):
+		"""Returns given value."""
+		if device is None:
+			print '?',value
+		else:
+			print 'G',device,value
+		sys.stdout.flush()
+		return self.readline()
+
+	def getLoopCount(self):
+		print 'loopcount'
+		sys.stdout.flush()
+		return int(self.readline())
+
+	def getRunDevice(self):
+		print 'run_device'
+		sys.stdout.flush()
+		return self.readline()
+
+	def getValueFloat(self,value,device = None):
+		"""Return value as float number."""
+		return float(self.getValue(value,device).split(" ")[0])
+
+	def getValueInteger(self,value,device = None):
+		return int(self.getValue(value,device).split(" ")[0])
+
+	def incrementValue(self,name,new_value,device = None):
+		if (device is None):
+			print "value",name,'+=',new_value
+		else:
+			print "V",device,name,'+=',new_value
+		sys.stdout.flush()
+
+	def incrementValueType(self,device,name,new_value):
+		print "VT",device,name,'+=',new_value
+		sys.stdout.flush()
+
+	def setValue(self,name,new_value,device = None):
+		if (device is None):
+			print "value",name,'=',new_value
+		else:
+			print "V",device,name,'=',new_value
+		sys.stdout.flush()
+
+	def setValueByType(self,device,name,new_value):
+		"""Set value for all devices of given type. Please use DEVICE_xx constants to specify device type."""
+		print "VT",device,name,'=',new_value
+		sys.stdout.flush()
+
+	def getState(self,device):
+		"""Retrieve device state"""
+		print 'S',device
+		sys.stdout.flush()
+		return int(self.readline())
+
+	def waitIdle(self,device,timeout):
+		"""Wait for idle state (with timeout)"""
+		print 'waitidle',device,timeout
+		sys.stdout.flush()
+		return int(self.readline())
+
+	def exposure(self, before_readout_callback = None, fileexpand = None, overwrite = False):
+		"""Start new exposure. Allow user to specify fallback function to call after end of exposure and expand pattern for new file.
+		Unless fileexpand parameter is provided, user is responsible to specify image treatment."""
+		if fileexpand:
+			if overwrite:
+				print "exposure_overwrite", fileexpand
+			else:
+				print "exposure_wfn", fileexpand
+		else:
+			print "exposure"
+		sys.stdout.flush()
+		a = self.readline()
+		if a == 'exposure_failed':
+			raise Rts2Exception("exposure failed")
+		if a != "exposure_end":
+			self.log('E', "invalid return from exposure - expected exposure_end, received " + a)
+		if not (before_readout_callback is None):
+			before_readout_callback()
+		a = self.readline()
+		image,fn = a.split()
+		return fn
+
+	def progressUpdate(self,expected_end,start=time.time()):
+		print "progress",start,expected_end
+		sys.stdout.flush()
+
+	def radec(self,ra,dec):
+		print "radec",ra,dec
+		sys.stdout.flush()
+
+	def newObs(self,ra,dec):
+		print "newobs",ra,dec
+		sys.stdout.flush()
+
+	def altaz(self,alt,az):
+		print "altaz",alt,az
+		sys.stdout.flush()
+
+	def newObsAltAz(self,alt,az):
+		print "newaltaz",alt,az
+		sys.stdout.flush()
+
+	def __imageAction(self,action,imagename):
+		print action,imagename
+		sys.stdout.flush()
+		return self.readline()
+
+	def rename(self,imagename,pattern):
+		print "rename",imagename,pattern
+		sys.stdout.flush()
+		return self.readline()
+
+	def move(self,imagename,pattern):
+		"""Move image to new path, delete it from the database."""
+		print "move",imagename, pattern
+		sys.stdout.flush()
+		return self.readline()
+
+	def toFlat(self,imagename):
+		return self.__imageAction("flat",imagename)
+
+	def toDark(self,imagename):
+		return self.__imageAction("dark",imagename)
+
+	def toArchive(self,imagename):
+		"""Move image at path to archive. Return new image path."""
+		return self.__imageAction("archive",imagename)
+
+	def toTrash(self,imagename):
+		"""Move image at path to trash. Return new image path."""
+		return self.__imageAction("trash",imagename)
+
+	def delete(self,imagename):
+		"""Delete image from disk."""
+		print "delete",imagename
+		sys.stdout.flush()
+
+	def process(self,imagename):
+		"""Put image to image processor queue."""
+		print "process",imagename
+		sys.stdout.flush()
+
+	def doubleValue(self,name,desc,value,rts2_type=0):
+		"""Add to device double value."""
+		print "double",name,'"{0}"'.format(desc),value,rts2_type
+		sys.stdout.flush()
+
+	def doubleVariable(self,name,desc,value):
+		"""Add to device double writable variable."""
+		print "double_w",name,'"{0}"'.format(desc),value
+		sys.stdout.flush()
+
+	def integerValue(self,name,desc,value):
+		"""Add to device integer value."""
+		print "integer",name,'"{0}"'.format(desc),value
+		sys.stdout.flush()
+
+	def integerVariable(self,name,desc,value):
+		"""Add to device integer writable variable."""
+		print "integer_w",name,'"{0}"'.format(desc),value
+		sys.stdout.flush()
+
+	def stringValue(self,name,desc,value):
+		"""Add to device string value."""
+		print "string",name,'"{0}"'.format(desc),value
+		sys.stdout.flush()
+
+	def stringVariable(self,name,desc,value):
+		"""Add to device string writable variable."""
+		print "string_w",name,'"{0}"'.format(desc),value
+		sys.stdout.flush()
+
+	def boolValue(self,name,desc,value):
+		"""Add to device boolean value."""
+		print "bool",name,'"{0}"'.format(desc),value
+		sys.stdout.flush()
+
+	def boolVariable(self,name,desc,value):
+		"""Add to device boolean writable variable."""
+		print "bool_w",name,'"{0}"'.format(desc),value
+		sys.stdout.flush()
+
+	def onoffValue(self,name,desc,value):
+		"""Add to device boolean value with on/off display type."""
+		print "onoff",name,'"{0}"'.format(desc),value
+		sys.stdout.flush()
+
+	def onoffVariable(self,name,desc,value):
+		"""Add to device boolean writable variable with on/off display type."""
+		print "onoff_w",name,'"{0}"'.format(desc),value
+		sys.stdout.flush()
+
+	def raDecValue(self,name,desc,ra,dec):
+		"""Add RA/DEC value pair"""
+		print "radec",name,'"{0}"'.format(desc),ra,dec
+		sys.stdout.flush()
+
+	def doubleArrayValue(self,name,desc,values):
+		print "double_array",name,'"{0}"'.format(desc),' '.join(map(str,values))
+		sys.stdout.flush()
+
+	def doubleArrayVariable(self,name,desc,values):
+		print "double_array_w",name,'"{0}"'.format(desc),' '.join(map(str,values))
+		sys.stdout.flush()
+
+	def doubleArrayAdd(self,name,values):
+		print "double_array_add",name,' '.join(map(str,values))
+		sys.stdout.flush()
+
+	def statAdd(self,name,desc,num,value):
+		"""Add to statistics boolean value."""
+		print "stat_add",name,'"{0}"'.format(desc),num,value
+		sys.stdout.flush()
+
+	def log(self,level,text):
+		print "log",level,text
+		sys.stdout.flush()
+
+	def isEvening(self):
+		"""Returns true if is evening - sun is on West"""
+		sun_az = self.getValueFloat('sun_az','centrald')
+		return sun_az < 180.0