Initial Commit

Author: chrislarkee

.gitignore

@@ -6,6 +6,11 @@ __pycache__/
 # C extensions
 *.so
 
+#custom docs & stuff
+Pyjector/
+Docs/
+tests/
+
 # Distribution / packaging
 .Python
 build/

README.md

@@ -1,2 +1,41 @@
 # CaveControl
- A simple Python GUI to control groups of projectors in a Cave
+ One day in late 2020, upon returning to campus, I was disappointed to discover that the Crestron touchscreen that I use to control the 10 projectors in [The Marquette University Visualization Lab](https://www.eng.mu.edu/vizlab/) had died after months of neglect during the Covid-19 shutdown. Instead of replacing the unit, I decided to make a simple Python GUI to trigger the most common daily tasks of the Cave: powering on/off, opening/closing shutters, enabling/disabling stereoscopic 3D mode, and enabling/disabling the floor projectors.
+ 
+ ![Screenshot](screenshot.png "CaveControl Screenshot")
+
+ The program is made in Python 3.9, and the GUI is made in TKinter with TTK. It is designed to be simple and cross-platform, and so it uses standard libraries exclusively and has no additional dependencies. "Build.bat" is an included shortcut that will build a standalone executable using PyInstaller, if desired.
+ 
+ In order to be useful for other Caves, some modification to the code will be required. The IPs and available commands are coded into christie.py. To discover additional commands or their parameters, consult the serial command API reference, ["M Series Serial API Commands Tech Ref.pdf"](https://www.christiedigital.com/globalassets/resources/public/020-100224-11-christie-lit-tech-ref-m-series-serial-commands.pdf), from Christie's website. The program is designed for use with Christie WU7K-M projectors, but should work similarly with other makes and models with slight adjustment to the commands.
+ 
+ Special Thanks to [jmusarra](https://github.com/jmusarra), whose [Pyjector](https://github.com/chrislarkee/Pyjector) was useful for emulating the projectors while working from home.
+ 
+ Written by Chris Larkee, 4/29/21.
+
+## Instructions
+
+### For the command line:
+- Type "python christie.py" to see a list of available commands.
+- Type "python christie.py on" , for example, to turn on all 10 projectors.
+
+```
+$ python christie.py
+Valid Commands:
+ on             Turn on all projectors
+ off            Turn off all projects
+ open           Open shutters (unmute video)
+ close          Close shutters (mute video)
+ floorOn        Enable floor projectors
+ floorOff       Disable floor projectors
+ 3d             Enable frame-packed stereo
+ 2d             Disable stereo
+ ping           Query power state
+ test           Secret debug command
+```
+
+### For the GUI:
+- Run "python caveControl.py" , or CaveControl.exe. 
+- Click on a command's radio button to send the command to all 10 projectors. Status text will appear at the bottom when all tasks are complete.
+- Press ESCAPE to quit, or close the window.
+
+## License
+[GNU GPL v3](LICENSE.md)

build.bat

@@ -0,0 +1,3 @@
+REM This batch file is a record of how the executable was built.
+REM This requires PyInstaller, of course.
+python -OO -m PyInstaller -w -F -a -i cubeicon.ico caveControl.py

caveControl.py

@@ -0,0 +1,86 @@
+#a tool to remotely control a group of Christie WU7K-M projectors using their network interfaces. This is the GUI version.
+
+import tkinter as tk
+from tkinter import ttk
+from christie import transmit
+
+class App(tk.Frame):
+    def __init__(self, master=None):
+        super().__init__(master)
+        self.master = master
+        root.title('Marquette Visualization Lab Control')
+        root.geometry("450x470")
+
+        s = ttk.Style()
+        s.theme_use('vista')
+        s.configure('Heading.TLabel', font=('Helvetica Bold', 14))
+        #s.configure('TLabel', font=('Helvetica', 11))
+    
+    def create_widgets(self):
+        #header
+        header = tk.Frame(root)
+        ttk.Label(header, text='Marquette Visualization Lab Control', style='Heading.TLabel').pack()
+        ttk.Label(header, text='Select a command').pack()
+        ttk.Separator(header).pack(expand=True, fill='x', pady=10)
+        header.pack(expand=False, fill='x', pady=10)
+
+        #main area layout
+        f = tk.Frame(root)
+        ttk.Label(f, text='Power:').grid(row=0, column=0)
+        ttk.Radiobutton(f, text='On', variable=p_power, value="on").grid(row=0, column=1, sticky="W")
+        ttk.Radiobutton(f, text='Off', variable=p_power, value="off").grid(row=0, column=2, sticky="W")
+
+        ttk.Label(f, text='Shutters:').grid(row=1, column=0)
+        ttk.Radiobutton(f, text='Open', variable=p_shutters, value="open").grid(row=1, column=1, sticky="W")
+        ttk.Radiobutton(f, text='Closed', variable=p_shutters, value="close").grid(row=1, column=2, sticky="W")
+        
+        ttk.Label(f, text='Stereo:').grid(row=2, column=0)
+        ttk.Radiobutton(f, text='Frame Doubled', variable=p_3d, value="3d").grid(row=2, column=1, sticky="W")
+        ttk.Radiobutton(f, text='Disabled', variable=p_3d, value="2d").grid(row=2, column=2, sticky="W")
+
+        ttk.Label(f, text='Floor:').grid(row=3, column=0)
+        ttk.Radiobutton(f, text='Normal', variable=p_floor, value="floorOn").grid(row=3, column=1, sticky="W")
+        ttk.Radiobutton(f, text='Disabled', variable=p_floor, value="floorOff").grid(row=3, column=2, sticky="W")
+
+        f.columnconfigure(0, pad=0, weight=2)
+        f.columnconfigure(1, pad=0, weight=1)
+        f.columnconfigure(2, pad=0, weight=1)
+        f.rowconfigure(0, pad=20)
+        f.rowconfigure(1, pad=20)
+        f.rowconfigure(2, pad=20)
+        f.rowconfigure(3, pad=20)
+        f.pack(expand=False, fill='x', padx=10, pady=0)        
+
+        #footer
+        footer = tk.Frame(root)
+        ttk.Separator(footer).pack(expand=True, fill='x', pady=5)
+        ttk.Label(footer, textvariable=p_info).pack(pady=5)
+        footer.pack(expand=False, fill='x', pady=0)
+
+def onclick(s):
+    p_info.set("Please wait...");
+    app.update()
+    p_info.set(transmit(s));
+    
+if __name__ == "__main__":
+    root = tk.Tk()
+    app = App(master=root)
+    
+    #state variables & callbacks
+    p_power = tk.StringVar()
+    p_shutters = tk.StringVar()
+    p_3d = tk.StringVar()
+    p_floor = tk.StringVar()
+    p_command = tk.StringVar()
+    p_info = tk.StringVar(value="")
+    p_power.trace_add('write', lambda *args: p_command.set(p_power.get()))
+    p_shutters.trace_add('write', lambda *args: p_command.set(p_shutters.get()))
+    p_3d.trace_add('write', lambda *args: p_command.set(p_3d.get()))
+    p_floor.trace_add('write', lambda *args: p_command.set(p_floor.get()))
+    p_command.trace_add('write', lambda *args: onclick(p_command.get()))
+    
+    #keyboard shortcuts
+    root.bind('<Escape>', lambda x: root.destroy())
+    
+    app.create_widgets()
+    app.mainloop()

christie.py

@@ -0,0 +1,83 @@
+#a tool to remotely control a group of Christie WU7K-M projectors using their network interfaces. This is the command-line utility that works as a back-end to a GUI.
+
+import socket
+from sys import exit
+from sys import argv
+
+from threading import Thread, active_count
+#from time import sleep
+#import random
+
+statusreport = ""
+
+def transmit(request):
+	#translate friendly commands into the API's language
+	if request == "on":
+		command = "($PWR1)"
+	elif request == "off":
+		command = "($PWR0)"
+	elif request == "open":
+		command = "($SHU0)"
+	elif request == "close":
+		command = "($SHU1)"
+	elif request == "3d":
+		command = "($TDM+MAIN2)"
+	elif request == "2d":
+		command = "($TDM+MAIN0)"
+	elif request == "floorOn":
+		command = "(9PWR1)(10PWR1)"
+	elif request == "floorOff":
+		command = "(9PWR0)(10PWR0)"
+	elif request == "ping":
+		command = "(#PWR?)"
+	elif request == "test":
+		command = "(#SHU?)"
+	else:
+		print("Command not found.")
+		exit(127)
+	
+	global statusreport
+	statusreport = ""
+	for projector in range(1, 11):
+		thr = Thread(target=transmitThread, args=(projector, command))
+		thr.start()
+		
+	while active_count() > 1:
+		sleep(0.5)
+	statusreport += "Transmission complete."
+	return statusreport
+				
+def transmitThread(id, command):
+	global statusreport
+	ip = "172.22.1.1" + str(id)
+	#sleep(random.randrange(5,50)/10.0)
+	#statusreport += str(id) + " is ok.\n"
+	s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+	s.settimeout(10.0)
+	s.connect((ip, 3002))
+	s.send(command.encode())
+	response = s.recv(1024)
+	s.close()
+	statusreport += str(id) + ": " + response.decode() + "\n"
+
+def printHelp():
+	print("Valid Commands:",\
+		"on\t\tTurn on all projectors",\
+		"off\t\tTurn off all projects",\
+		"open\t\tOpen shutters (unmute video)",\
+		"close\t\tClose shutters (mute video)",\
+		"floorOn\tEnable floor projectors",\
+		"floorOff\tDisable floor projectors",\
+		"3d\t\tEnable frame-packed stereo",\
+		"2d\t\tDisable stereo",
+		"ping\t\tQuery power state",
+		"test\t\tSecret debug command",sep='\n ')
+	exit(0)
+
+if __name__ == '__main__':
+	if len(argv) == 1: 
+		printHelp()
+	
+	#ok go
+	print(transmit(argv[1]))
+	exit(0)