aca-device-modules 1.0.0

data/modules/epson/projector/esc_vp21.rb

@@ -0,0 +1,248 @@
+module Epson; end
+module Epson::Projector; end
+
+#
+# Port: 3629
+#
+class Epson::Projector::EscVp21
+	include ::Orchestrator::Constants
+    include ::Orchestrator::Transcoder
+
+	def on_load
+		#config({
+		#	tokenize: true,
+		#	delimiter: ":"
+		#})
+
+		self[:power] = false
+		self[:stable_state] = true  # Stable by default (allows manual on and off)
+		
+		# Meta data for inquiring interfaces
+		self[:type] = :projector
+	end
+
+	def on_update
+		
+	end
+	
+	def connected
+		# Have to init comms
+		send("ESC/VP.net\x10\x03\x00\x00\x00\x00")
+		do_poll
+		@polling_timer = schedule.every('52s', method(:do_poll))
+	end
+
+	def disconnected
+		self[:power] = false
+		@polling_timer.cancel unless @polling_timer.nil?
+        @polling_timer = nil
+	end
+	
+	
+	
+	#
+	# Power commands
+	#
+	def power(state, opt = nil)
+		self[:stable_state] = false
+		if is_affirmative?(state)
+			self[:power_target] = On
+			do_send(:PWR, :ON, {:timeout => 40000, :name => :power})
+			logger.debug "-- epson Proj, requested to power on"
+			do_send(:PWR, :name => :power_state)
+		else
+			self[:power_target] = Off
+			do_send(:PWR, :OFF, {:timeout => 10000, :name => :power})
+			logger.debug "-- epson Proj, requested to power off"
+			do_send(:PWR, :name => :power_state)
+		end
+	end
+
+	def power?(options = {}, &block)
+		options[:emit] = block if block_given?
+		options[:name] = :power_state
+		do_send(:PWR, options)
+	end
+	
+	
+	
+	#
+	# Input selection
+	#
+	INPUTS = {
+		:hdmi => 0x30 # TODO:: Might need to have a setting for configuring this
+	}
+	INPUTS.merge!(INPUTS.invert)
+	
+	
+	def switch_to(input)
+		input = input.to_sym
+		return unless INPUTS.has_key? input
+		
+		do_send(:SOURCE, INPUTS[input].to_s(16), {:name => :inpt_source})
+		do_send(:SOURCE, {:name => :inpt_query})
+		
+		logger.debug "-- epson LCD, requested to switch to: #{input}"
+		
+		self[:input] = input	# for a responsive UI
+	end
+	
+	
+	
+	#
+	# Volume commands are sent using the inpt command
+	#
+	def volume(vol, options = {})
+        vol = vol.to_i
+        vol = 0 if vol < 0
+        vol = 255 if vol > 255
+
+        do_send(:VOL, vol, options)
+    end
+	
+	
+	#
+	# Mute Audio and Video
+	#
+	def mute
+		logger.debug "-- epson Proj, requested to mute"
+		do_send(:MUTE, :ON, {:name => :video_mute})	# Audio + Video
+		do_send(:MUTE) # request status
+	end
+
+	def unmute
+		logger.debug "-- epson Proj, requested to mute"
+		do_send(:MUTE, :OFF, {:name => :video_mute})
+		do_send(:MUTE)
+	end
+	
+	
+	ERRORS = {
+		0 => '00: no error'.freeze,
+		1 => '01: fan error'.freeze,
+		3 => '03: lamp failure at power on'.freeze,
+		4 => '04: high internal temperature'.freeze,
+		6 => '06: lamp error'.freeze,
+		7 => '07: lamp cover door open'.freeze,
+		8 => '08: cinema filter error'.freeze,
+		9 => '09: capacitor is disconnected'.freeze,
+		10 => '0A: auto iris error'.freeze,
+		11 => '0B: subsystem error'.freeze,
+		12 => '0C: low air flow error'.freeze,
+		13 => '0D: air flow sensor error'.freeze,
+		14 => '0E: ballast power supply error'.freeze,
+		15 => '0F: shutter error'.freeze,
+		16 => '10: peltiert cooling error'.freeze,
+		17 => '11: pump cooling error'.freeze,
+		18 => '12: static iris error'.freeze,
+		19 => '13: power supply unit error'.freeze,
+		20 => '14: exhaust shutter error'.freeze,
+		21 => '15: obstacle detection error'.freeze,
+		22 => '16: IF board discernment error'.freeze
+	}
+	
+	#
+	# epson Response code
+	#
+	def received(data, resolve, command)		# Data is default received as a string
+		logger.debug "epson Proj sent: #{data}"
+
+		if data == ':'
+			return :success
+		end
+
+		data = data.split(/=|\r:/)
+		case data[0].to_sym
+		when :ERR
+			# Lookup error!
+			if data[1].nil?
+				warning = "Epson PJ sent error response"
+				warning << " for #{command[:data].inspect}" if command
+				logger.warn warning
+				return :abort
+			else
+				code = data[1].to_i(16)
+				self[:last_error] = ERRORS[code] || "#{data[1]}: unknown error code #{code}"
+				logger.warn "Epson PJ error was #{self[:last_error]}"
+				return :success
+			end
+		when :PWR
+			state = data[1].to_i
+			self[:power] = state < 3
+			self[:warming] = state == 2
+			self[:cooling] = state == 3
+			if self[:warming] || self[:cooling]
+				schedule.in('5s') do
+					power?({:priority => 0})
+				end
+			end
+			if !self[:stable_state] && self[:power_target] == self[:power]
+				self[:stable_state] = true
+			end
+
+		when :MUTE
+			self[:mute] = data[1] == 'ON'
+		when :VOL
+			self[:volume] = data[1].to_i
+		when :LAMP
+			self[:lamp] = data[1].to_i
+		when :SOURCE
+			self[:source] = INPUTS[data[1].to_i(16)] || :unknown
+		end
+
+		:success
+	end
+
+	def inspect_error
+		do_send(:ERR, priority: 0)
+	end
+	
+	
+	protected
+	
+	
+	def do_poll(*args)
+		power?({:priority => 0}) do
+			if self[:power]
+				if self[:stable_state] == false && self[:power_target] == Off
+					power(Off)
+				else
+					self[:stable_state] = true
+					do_send(:SOURCE, {
+						:name => :inpt_query,
+						:priority => 0
+					})
+					do_send(:MUTE, {
+						:name => :mute_query,
+						:priority => 0
+					})
+					do_send(:VOL, {
+						:name => :vol_query,
+						:priority => 0
+					})
+				end
+			elsif self[:stable_state] == false
+				if self[:power_target] == On
+					power(On)
+				else
+					self[:stable_state] = true
+				end
+			end
+		end
+		do_send(:LAMP, {:priority => 0})
+	end
+
+	def do_send(command, param = nil, options = {})
+		if param.is_a? Hash
+			options = param
+			param = nil
+		end
+
+		if param.nil?
+			send("#{command}?\x0D", options)
+		else
+			send("#{command} #{param}\x0D", options)
+		end
+	end
+end
+

data/modules/extron/mixer/dmp44.rb

@@ -0,0 +1,195 @@
+module Extron; end
+module Extron::Mixer; end
+
+
+# :title:Extron DSP 44
+#
+# Status information avaliable:
+# -----------------------------
+#
+# (built in)
+# connected
+#
+# (module defined)
+#
+
+
+class Extron::Mixer::Dmp44
+	include ::Orchestrator::Constants
+    include ::Orchestrator::Transcoder
+
+	
+	def on_load
+		#
+		# Setup constants
+		#
+		self[:output_volume_max] = 2168
+		self[:output_volume_min] = 1048
+		self[:mic_gain_max] = 2298
+		self[:mic_gain_min] = 1698
+
+		config({
+			:clear_queue_on_disconnect => true	# Clear the queue as we may need to send login
+		})
+	end
+
+	def connected
+		device_ready
+		@polling_timer = schedule.every('2m') do
+			logger.debug "-- Extron Maintaining Connection"
+			send('Q', :priority => 0)	# Low priority poll to maintain connection
+		end
+	end
+
+	def disconnected
+		#
+		# Disconnected may be called without calling connected
+		#	Hence the check if timer is nil here
+		#
+		@polling_timer.cancel unless @polling_timer.nil?
+		@polling_timer = nil
+	end
+
+
+	def call_preset(number)
+		if number < 0 || number > 32
+			number = 0	# Current configuration
+		end
+		send("#{number}.")	# No Carriage return for presents
+		# Response: Rpr#{number}
+	end
+
+	#
+	# Input control
+	#
+	def adjust_gain(input, value)	# \e == 0x1B == ESC key
+		input -= 1
+		do_send("\eG3000#{input}*#{value}AU")
+		# Response: DsG3000#{input}*#{value}
+	end
+
+	def adjust_gain_relative(input, value)	# \e == 0x1B == ESC key
+		input -= 1
+		current = do_send("\eG3000#{input}AU", :emit => "mic#{input + 1}_gain")
+		do_send("\eG3000#{input}*#{current + (value * 10)}AU")
+
+		# Response: DsG3000#{input}*#{value}
+	end
+
+	def mute_input(input)
+		input -= 1
+		do_send("\eM3000#{input}*1AU")
+		# Response: DsM3000#{input}*1
+	end
+
+	def unmute_input(input)
+		input -= 1
+		do_send("\eM3000#{input}*0AU")
+		# Response: DsM3000#{input}*0
+	end
+
+
+	#
+	# Group control
+	#
+	def mute_group(group)
+		do_send("\eD#{group}*1GRPM")
+		# Response:  GrpmD#{group}*+00001
+	end
+
+	def unmute_group(group)
+		do_send("\eD#{group}*0GRPM")
+		# Response:  GrpmD#{group}*+00000
+	end
+
+	def volume(group, value)	# \e == 0x1B == ESC key
+		do_send("\eD#{group}*#{value * 10}*GRPM")
+		# Response: GrpmD#{group}*#{value}*GRPM
+	end
+
+	def volume_relative(group, value)	# \e == 0x1B == ESC key
+
+		if value < 0
+			value = -value
+			do_send("\eD#{group}*#{value * 10}-GRPM")
+		else
+			do_send("\eD#{group}*#{value * 10}+GRPM")
+		end
+		# Response: GrpmD#{group}*#{value}*GRPM
+	end
+
+
+	def response_delimiter
+		[0x0D, 0x0A]	# Used to interpret the end of a message
+	end
+
+	#
+	# Sends copyright information
+	# Then sends password prompt
+	#
+	def received(data, resolve, command)
+		logger.debug "Extron DSP 44 sent #{data}"
+
+		if command.nil? && data =~ /Copyright/i
+			device_ready
+		else
+			case data[0..2].to_sym
+			when :Grp	# Mute or Volume
+				data = data.split('*')
+				if data[1][0] == '+'	# mute
+					self["ouput#{data[0][5..-1].to_i}_mute"] = data[1][-1] == '1'	# 1 == true
+				else
+					self["ouput#{data[0][5..-1].to_i}_volume"] = data[1].to_i
+				end
+			when :DsG	# Input gain
+				self["input#{data[7].to_i + 1}_gain"] = data[9..-1].to_i
+			when :DsM	# Input Mute
+				self["input#{data[7].to_i + 1}_mute"] = data[-1] == '1'	# 1 == true
+			when :Rpr	# Preset called
+				logger.debug "Extron DSP called preset #{data[3..-1]}"
+			else
+				if data == 'E22'	# Busy! We should retry this one
+					command[:delay_on_receive] = 1 unless command.nil?
+					return :failed
+				elsif data[0] == 'E'
+					logger.info "Extron Error #{ERRORS[data[1..2].to_i]}"
+					logger.info "- for command #{command[:data]}" unless command.nil?
+				end
+			end
+		end
+
+		return :success
+	end
+
+
+	private
+
+
+	ERRORS = {
+		10 => 'Invalid command',
+		11 => 'Invalid preset',
+		12 => 'Invalid port number',
+		13 => 'Invalid parameter (number is out of range)',
+		14 => 'Not valid for this configuration',
+		17 => 'System timed out',
+		23 => 'Checksum error (for file uploads)',
+		24 => 'Privilege violation',
+		25 => 'Device is not present',
+		26 => 'Maximum connections exceeded',
+		27 => 'Invalid event number',
+		28 => 'Bad filename or file not found'
+	}
+
+
+	def device_ready
+		do_send("\e3CV")	# Verbose mode and tagged responses
+	end
+
+
+
+
+	def do_send(data, options = {})
+		send(data << 0x0D, options)
+	end
+end
+

data/modules/extron/mixer/dmp64.rb

@@ -0,0 +1,212 @@
+module Extron; end
+module Extron::Mixer; end
+
+
+# :title:Extron DSP
+#
+# Status information avaliable:
+# -----------------------------
+#
+# (built in)
+# connected
+#
+# (module defined)
+#
+#
+#
+# Volume outputs
+# 60000 == volume 1
+# 60003 == volume 4
+#
+# Pre-mix gain inputs
+# 40100 == Mic1
+# 40105 == Mic6
+#
+
+
+class Extron::Mixer::Dmp64
+	include ::Orchestrator::Constants
+    include ::Orchestrator::Transcoder
+
+	
+	def on_load
+		#
+		# Setup constants
+		#
+		self[:output_volume_max] = 2168
+		self[:output_volume_min] = 1048
+		self[:mic_gain_max] = 2298
+		self[:mic_gain_min] = 1698
+
+		config({
+			:clear_queue_on_disconnect => true	# Clear the queue as we may need to send login
+		})
+	end
+
+	def connected
+
+	end
+
+	def disconnected
+		#
+		# Disconnected may be called without calling connected
+		#	Hence the check if timer is nil here
+		#
+		@polling_timer.cancel unless @polling_timer.nil?
+		@polling_timer = nil
+	end
+
+
+	def call_preset(number)
+		if number < 0 || number > 32
+			number = 0	# Current configuration
+		end
+		send("#{number}.")	# No Carriage return for presents
+		# Response: Rpr#{number}
+	end
+
+	#
+	# Input control
+	#
+	def adjust_gain(mic, value)	# \e == 0x1B == ESC key
+		do_send("\eG4010#{mic}*#{value}AU")
+		# Response: DsG4010#{mic}*#{value}
+	end
+
+	def adjust_gain_relative(mic, value)	# \e == 0x1B == ESC key
+		current = do_send("\eG4010#{mic}AU", :emit => "mic#{mic}_gain")
+		do_send("\eG4010#{mic}*#{current + (value * 10)}AU")
+
+		# Response: DsG4010#{mic}*#{value}
+	end
+
+	def mute_mic(mic)
+		do_send("\eM4000#{mic}*1AU")	# 4000 (input gain), 4010 (pre-mixer gain)
+		# Response: DsM4010#{mic}*1
+	end
+
+	def unmute_mic(mic)
+		do_send("\eM4000#{mic}*0AU")
+		# Response: DsM4010#{mic}*0
+	end
+
+
+	#
+	# Output control
+	#
+	def mute_group(group)
+		do_send("\eD#{group}*1GRPM", :group_type => :mute)
+		# Response:  GrpmD#{group}*+00001
+	end
+
+	def unmute_group(group)
+		do_send("\eD#{group}*0GRPM", :group_type => :mute)
+		# Response:  GrpmD#{group}*+00000
+	end
+
+	def volume(group, value)	# \e == 0x1B == ESC key
+		do_send("\eD#{group}*#{value}GRPM", :group_type => :volume)
+		# Response: GrpmD#{group}*#{value}*GRPM
+	end
+	
+	def group_status(group, type)
+		do_send("\eD#{group}GRPM", :group_type => type)
+	end
+	
+	def volume_relative(group, value)	# \e == 0x1B == ESC key
+		if value < 0
+			value = -value
+			do_send("\eD#{group}*#{value}-GRPM")
+		else
+			do_send("\eD#{group}*#{value}+GRPM")
+		end
+		# Response: GrpmD#{group}*#{value}*GRPM
+	end
+
+
+	def response_delimiter
+		[0x0D, 0x0A]	# Used to interpret the end of a message
+	end
+
+	#
+	# Sends copyright information
+	# Then sends password prompt
+	#
+	def received(data, resolve, command)
+		logger.debug "Extron DSP sent #{data}"
+
+		if command.nil? && data =~ /Copyright/i
+			pass = setting(:password)
+			if pass.nil?
+				device_ready
+			else
+				do_send(pass)		# Password set
+			end
+		elsif data =~ /Login/i
+			device_ready
+		else
+			case data[0..2].to_sym
+			when :Grp	# Mute or Volume
+				data = data.split('*')
+				if command.present? && command[:group_type] == :mute
+					self["ouput#{data[0][5..-1].to_i}_mute"] = data[1][-1] == '1'	# 1 == true
+				elsif command.present? && command[:group_type] == :volume
+					self["ouput#{data[0][5..-1].to_i}_volume"] = data[1].to_i
+				else
+					return :failed
+				end
+			when :DsG	# Mic gain
+				self["mic#{data[7]}_gain"] = data[9..-1].to_i
+			when :DsM	# Mic Mute
+				self["mic#{data[7]}_mute"] = data[-1] == '1'	# 1 == true
+			when :Rpr	# Preset called
+				logger.debug "Extron DSP called preset #{data[3..-1]}"
+			else
+				if data == 'E22'	# Busy! We should retry this one
+					command[:delay_on_receive] = 1 unless command.nil?
+					return :failed
+				elsif data[0] == 'E'
+					logger.info "Extron Error #{ERRORS[data[1..2].to_i]}"
+					logger.info "- for command #{command[:data]}" unless command.nil?
+				end
+			end
+		end
+
+		return :success
+	end
+
+
+	private
+
+
+	ERRORS = {
+		1 => 'Invalid input number (number is too large)',
+		12 => 'Invalid port number',
+		13 => 'Invalid parameter (number is out of range)',
+		14 => 'Not valid for this configuration',
+		17 => 'System timed out',
+		23 => 'Checksum error (for file uploads)',
+		24 => 'Privilege violation',
+		25 => 'Device is not present',
+		26 => 'Maximum connections exceeded',
+		27 => 'Invalid event number',
+		28 => 'Bad filename or file not found'
+	}
+
+
+	def device_ready
+		do_send("\e3CV")	# Verbose mode and tagged responses
+		@polling_timer = schedule.every('2m') do
+			logger.debug "-- Extron Maintaining Connection"
+			send('Q', :priority => 0)	# Low priority poll to maintain connection
+		end
+	end
+
+
+
+
+	def do_send(data, options = {})
+		send(data << 0x0D, options)
+	end
+end
+