aca-device-modules 1.0.4 → 1.0.5

data/modules/biamp/nexia.rb

@@ -5,141 +5,162 @@ module Biamp; end
 # TELNET port 23
 
 class Biamp::Nexia
-	include ::Orchestrator::Constants
+    include ::Orchestrator::Constants
     include ::Orchestrator::Transcoder
-	
-	def on_load
-		self[:fader_min] = -36		# specifically for tonsley
-		self[:fader_max] = 12
+    
+    def on_load
+        self[:fader_min] = -36        # specifically for tonsley
+        self[:fader_max] = 12
 
-		# max +12
-		# min -100
+        # max +12
+        # min -100
 
-		config({
-			tokenize: true,
-			delimiter: /\xFF\xFE\x01|\r\n/
-		})
-	end
-	
-	def on_unload
-	end
-	
-	def on_update
-	end
-	
-	
-	def connected
-		send("\xFF\xFE\x01")	# Echo off
-		do_send('GETD', 0, 'DEVID')
-		
-		@polling_timer = schedule.every('60s') do
-			do_send('GETD', 0, 'DEVID')
-		end
-	end
-	
-	def disconnected
-		@polling_timer.cancel unless @polling_timer.nil?
-		@polling_timer = nil
-	end
-	
-	
-	def preset(number)
-		#
-		# Recall Device 0 Preset number 1001
-		# Device Number will always be 0 for Preset strings
-		# 1001 == minimum preset number
-		#
-		do_send('RECALL', 0, 'PRESET', number)
-	end
+        config({
+            tokenize: true,
+            delimiter: /\xFF\xFE\x01|\r\n/
+        })
+    end
+    
+    def on_unload
+    end
+    
+    def on_update
+    end
+    
+    
+    def connected
+        send("\xFF\xFE\x01")    # Echo off
+        do_send('GETD', 0, 'DEVID')
+        
+        @polling_timer = schedule.every('60s') do
+            do_send('GETD', 0, 'DEVID')
+        end
+    end
+    
+    def disconnected
+        @polling_timer.cancel unless @polling_timer.nil?
+        @polling_timer = nil
+    end
+    
+    
+    def preset(number)
+        #
+        # Recall Device 0 Preset number 1001
+        # Device Number will always be 0 for Preset strings
+        # 1001 == minimum preset number
+        #
+        do_send('RECALL', 0, 'PRESET', number)
+    end
 
-	# {1 => [2,3,5], 2 => [2,3,6]}, true
-	# Supports Matrix and Automixers
-	def mixer(id, inouts, mute = false)
-		value = is_affirmative?(mute) ? 
+    # {1 => [2,3,5], 2 => [2,3,6]}, true
+    # Supports Matrix and Automixers
+    def mixer(id, inouts, mute = false)
+        value = is_affirmative?(mute) ? 1 : 0
 
-		if inouts.is_a? Hash
-			inouts.each_key do |input|
-				outputs = inouts[input]
-				outs = outputs.is_a?(Array) ? outputs : [outputs]
+        if inouts.is_a? Hash
+            inouts.each_key do |input|
+                outputs = inouts[input]
+                outs = outputs.is_a?(Array) ? outputs : [outputs]
 
-				outs.each do |output|
-					do_send('SETD', self[:device_id], 'MMMUTEXP', id, input, output, value)
-				end
-			end
-		else # assume array (auto-mixer)
-			inouts.each do |input|
-				do_send('SETD', self[:device_id], 'AMMUTEXP', id, input, value)
-			end
-		end
-	end
-	
-	def fader(fader_id, level, index = 1)
-		# value range: -100 ~ 12
-		do_send('SETD', self[:device_id], 'FDRLVL', fader_id, index, level)
-	end
-	
-	def mute(fader_id, val = true, index = 1)
-		actual = val ? 1 : 0
-		do_send('SETD', self[:device_id], 'FDRMUTE', fader_id, index, actual)
-	end
-	
-	def unmute(fader_id, index = 1)
-		mute(fader_id, false, index)
-	end
+                outs.each do |output|
+                    do_send('SETD', self[:device_id], 'MMMUTEXP', id, input, output, value)
+                end
+            end
+        else # assume array (auto-mixer)
+            inouts.each do |input|
+                do_send('SETD', self[:device_id], 'AMMUTEXP', id, input, value)
+            end
+        end
+    end
 
-	def query_fader(fader_id, index = 1)
-		send("GET #{self[:device_id]} FDRLVL #{fader_id} #{index} \n") do |data|
-			if data.start_with?('-ERR')
-				:abort
-			else
-				self[:"fader#{fader_id}_#{index}"] = data.to_i
-				:success
-			end
-		end
-	end
+    FADERS = {
+        fader: 'FDRLVL',
+        matrix_in: 'MMLVLIN',
+        matrix_out: 'MMLVLOUT',
+        matrix_crosspoint: 'MMLVLXP'
+    }
+    
+    def fader(fader_id, level, index = 1, type = :level_fader)
+        fad_type = FADERS[type.to_sym]
 
-	def query_mute(fader_id, index = 1)
-		send("GET #{self[:device_id]} FDRMUTE #{fader_id} #{index} \n") do |data|
-			if data.start_with?('-ERR')
-				:abort
-			else
-				self[:"fader#{fader_id}_#{index}_mute"] = data.to_i == 1
-				:success
-			end
-		end
-	end
-	
-	
-	def received(data, resolve, command)
-		if data.start_with?('-ERR')
-			logger.debug "Nexia returned #{data} for #{command[:data]}" if command
-			return :abort
-		end
-		
-		#--> "#SETD 0 FDRLVL 29 1 0.000000 +OK"
-		data = data.split(' ')
-		unless data[2].nil?
-			case data[2].to_sym
-			when :FDRLVL, :VL
-				self[:"fader#{data[3]}_#{data[4]}"] = data[5].to_i
-			when :FDRMUTE
-				self[:"fader#{data[3]}_#{data[4]}_mute"] = data[5] == "1"
-			when :DEVID
-				# "#GETD 0 DEVID 1 "
-				self[:device_id] = data[-2].to_i
-			end
-		end
-		
-		return :success
-	end
-	
-	
-	
-	private
-	
-	
-	def do_send(*args)
-		send("#{args.join(' ')} \n")
-	end
+        # value range: -100 ~ 12
+        faders = fader_id.is_a?(Array) ? fader_id : [fader_id]
+        faders.each do |fad|
+            do_send('SETD', self[:device_id], fad_type, fad, index, level)
+        end
+    end
+    
+    def mute(fader_id, val = true, index = 1)
+        actual = val ? 1 : 0
+        faders = fader_id.is_a?(Array) ? fader_id : [fader_id]
+        faders.each do |fad|
+            do_send('SETD', self[:device_id], 'FDRMUTE', fad, index, actual)
+        end
+    end
+    
+    def unmute(fader_id, index = 1)
+        mute(fader_id, false, index)
+    end
+
+    def query_fader(fader_id, index = 1)
+        fad = fader_id.is_a?(Array) ? fader_id[0] : fader_id
+
+        send("GET #{self[:device_id]} FDRLVL #{fad} #{index} \n") do |data|
+            if data.start_with?('-ERR')
+                :abort
+            else
+                self[:"fader#{fad}_#{index}"] = data.to_i
+                :success
+            end
+        end
+    end
+
+    def query_mute(fader_id, index = 1)
+        fad = fader_id.is_a?(Array) ? fader_id[0] : fader_id
+        
+        send("GET #{self[:device_id]} FDRMUTE #{fad} #{index} \n") do |data|
+            if data.start_with?('-ERR')
+                :abort
+            else
+                self[:"fader#{fad}_#{index}_mute"] = data.to_i == 1
+                :success
+            end
+        end
+    end
+    
+    
+    def received(data, resolve, command)
+        if data.start_with?('-ERR')
+            logger.debug "Nexia returned #{data} for #{command[:data]}" if command
+            return :abort
+        end
+        
+        #--> "#SETD 0 FDRLVL 29 1 0.000000 +OK"
+        data = data.split(' ')
+        unless data[2].nil?
+            case data[2].to_sym
+            when :FDRLVL, :VL
+                self[:"fader#{data[3]}_#{data[4]}"] = data[5].to_i
+            when :FDRMUTE
+                self[:"fader#{data[3]}_#{data[4]}_mute"] = data[5] == "1"
+            when :DEVID
+                # "#GETD 0 DEVID 1 "
+                self[:device_id] = data[-2].to_i
+            when :MMLVLIN
+                self[:"matrix_in#{data[3]}_#{data[4]}"] = data[5].to_i
+            end
+        end
+        
+        return :success
+    end
+    
+    
+    
+    private
+    
+    
+    def do_send(*args)
+        send("#{args.join(' ')} \n")
+    end
 end
 

data/modules/bss/blu100.rb

@@ -6,7 +6,7 @@ class Bss::Blu100
     include ::Orchestrator::Constants
     include ::Orchestrator::Transcoder
     
-	def on_load
+    def on_load
         defaults({
             :wait => false
         })
@@ -17,14 +17,14 @@ class Bss::Blu100
         })
 
         on_update
-	end
-	
-	def on_unload
-	end
-	
-	def on_update
+    end
+    
+    def on_unload
+    end
+    
+    def on_update
         @type_lookup ||= {}
-	end
+    end
 
     def connected
         subscribe_percent(1, 60000)

data/modules/chiyu/cyt.rb

@@ -30,13 +30,18 @@ class Chiyu::Cyt
     def on_update
     end
     
-    # No keep alive required as the device polls us
     def connected
         do_send(:state)
         do_send(:auto_report)
+
+        @polling_timer = schedule.every('60s') do
+            do_send(:state)
+        end
     end
     
     def disconnected
+        @polling_timer.cancel unless @polling_timer.nil?
+        @polling_timer = nil
     end
 
 

data/modules/clipsal/c_bus.rb

@@ -3,13 +3,13 @@ module Clipsal; end
 
 #
 # Common Headers
-# 	0x03 == point - point -multipoint, low pri
-# 	0x05 == point - multipoint, low pri
-# 	0x06 == point - point, low pri
+#     0x03 == point - point -multipoint, low pri
+#     0x05 == point - multipoint, low pri
+#     0x06 == point - point, low pri
 #
-# 	11xxx110  (x == reserved)
-# 	-- Priority, 11 == high, 00 == low
-# 	     --- Destination, 011 = P-P-M, 101 = P-M, 110 = P-P
+#     11xxx110  (x == reserved)
+#     -- Priority, 11 == high, 00 == low
+#          --- Destination, 011 = P-P-M, 101 = P-M, 110 = P-P
 #
 #
 # Commands are formatted as: \ + Header + 00 + Data + checksum + <cr>
@@ -22,235 +22,233 @@ module Clipsal; end
 
 
 class Clipsal::CBus
-	include ::Orchestrator::Constants
+    include ::Orchestrator::Constants
     include ::Orchestrator::Transcoder
-	
-	def on_load
-		defaults({
-			:wait => false
-		})
-
-		config({
-			tokenize: true,
-			delimiter: "\x0D"
-		})
-	end
-	
-	def on_unload
-	end
-	
-	def on_update
-		
-	end
-	
-	
-	def connected
-		send("|||\r", :wait => false)	# Ensure we are in smart mode
-		@polling_timer = schedule.every('60s') do
-			logger.debug "-- Polling CBUS"
-			send("|||\r", :wait => false)	# Ensure we are in smart mode
-		end
-	end
-	
-	def disconnected
-		@polling_timer.cancel unless @polling_timer.nil?
-		@polling_timer = nil
-	end
-	
-	
-	def lighting(group, state, application = 0x38)
-		group = group & 0xFF
-		application = application & 0xFF
-		
-		command = [0x05, application, 0x00]
-		if [On, 1, :on, 'on'].include?(state)
-			state = On
-			command << 0x79 # Group on
-		else
-			state = Off
-			command << 0x01 # Group off
-		end
-		command << group
-
-		self["lighting_group_#{group}"] = state
-		
-		do_send(command)
-	end
-	
-	
-	def lighting_ramp(group, level, rate = 0b0001, application = 0x38)
-		
-		#
-		# rates:
-		# => 0 == instant
-		# => 1 == 4sec
-		# => 2 == 8sec etc
-		#
-		rate = ((rate & 0x0F) << 3) | 0b010	# The command is structured as: 0b0 xxxx 010 where xxxx == rate
-		group = group & 0xFF
-		level = level & 0xFF
-		application = application & 0xFF
-		
-		lighting_term_ramp(group)
-		command = [0x05, application, 0x00, rate, group, level]
-		
-		do_send(command)
-	end
-
-
-
-	def blinds(group, action, application = 0x38)
-		group = group & 0xFF
-		application = application & 0xFF
-
-		command = [0x05, application, 0x00]
-		if is_affirmative?(action)
-			action = Down
-			command += [0x1A, group, 0x00]
-		else
-			command += [0x02, group]
-
-			if is_negatory?(action)
-				action = Up
-				command << 0xFF
-			else
-				# Stop (need to confirm this)
-				command << 0x05
-			end
-		end
-
-		do_send(command)
-	end
-	
-	
-	def trigger(group, action)
-		action = action.to_i
-		group = group.to_i
-		
-		group = group & 0xFF
-		action = action & 0xFF
-		command = [0x05, 0xCA, 0x00, 0x02, group, action]
-		
-		self["trigger_group_#{group}"] = action
-
-		do_send(command)
-	end
-	
-	
-	def trigger_kill(group)
-		group = group.to_i
-		
-		group = group & 0xFF
-		command = [0x05, 0xCA, 0x00, 0x01, group]
-		do_send(command)
-	end
-	
-	
-	def received(data, resolve, command)
-		# Debug here will sometimes have the \n char
-		# This is removed by the hex_to_byte function
-		logger.debug "CBus sent #{data}"
-		
-		data = str_to_array(hex_to_byte(data))
-		
-		if !check_checksum(data)
-			logger.debug "CBus checksum failed"
-			return :failed
-		end
-
-		# We are only looking at Point -> MultiPoint commands
-		return if data[0] != 0x05
-		# 0x03 == Point -> Point -> MultiPoint
-		# 0x06 == Point -> Point
-		
-		application = data[2]	# The application being referenced
-		commands = data[4..-2]	# Remove the header + checksum
-		
-		while commands.length > 0
-			current = commands.shift
-			
-			case application
-			when 0xCA			# Trigger group
-				case current
-				when 0x02			# Trigger Event (ex: 0504CA00 020101 29)
-					self["trigger_group_#{commands.shift}"] = commands.shift	# Action selector
-				when 0x01			# Trigger Min
-					self["trigger_group_#{commands.shift}"] = 0
-				when 0x79			# Trigger Max
-					self["trigger_group_#{commands.shift}"] = 0xFF
-				when 0x09			# Indicator Kill (ex: 0504CA00 0901 23)
-					commands.shift		# Group (turns off indicators of all scenes triggered by this group)
-				else
-					break	# We don't know what data is here
-				end
-			when 0x30..0x5F		# Lighting group
-				case current
-				when 0x01			# Group off (ex: 05043800 0101 0102 0103 0104 7905 33)
-					self["lighting_group_#{commands.shift}"] = Off
-				when 0x79			# Group on (ex: 05013800 7905 44)
-					self["lighting_group_#{commands.shift}"] = On
-				when 0x02 # Blinds up or stop
-					group = commands.shift
-					value = commands.shift
-					if value == 0xFF
-						self["blinds_group_#{group}"] = Up
-					elsif value == 0x05 # Value needs confirmation
-						self["blinds_group_#{group}"] = :stopped
-					end
-				when 0x1A # Blinds down
-					group = commands.shift
-					value = commands.shift
-					self["blinds_group_#{group}"] = Down if value == 0x00
-				when 0x09			# Terminate Ramp
-					commands.shift		# Group address
-				else
-					if (current & 0b10000101) == 0	# Ramp to level (ex: 05013800 0205FF BC)
-						commands.shift(2)	# Group address, level
-					else
-						break	# We don't know what data is here
-					end
-				end
-			else
-				break	# We haven't programmed this application
-			end
-		end
-		
-		return :success
-	end
-	
-	
-	protected
-	
-	
-	def lighting_term_ramp(group)
-		command = [0x05, 0x38, 0x00, 0x09, group]
-		do_send(command)
-	end
-	
-	
-	def checksum(data)
-		check = 0
-		data.each do |byte|
-			check += byte
-		end
-		check = check % 0x100
-		check = ((check ^ 0xFF) + 1) & 0xFF
-		return check
-	end
-	
-	def check_checksum(data)
-		check = 0
-		data.each do |byte|
-			check += byte
-		end
-		return (check % 0x100) == 0x00
-	end
-	
-	
-	def do_send(command, options = {})
-		string = byte_to_hex(array_to_str(command << checksum(command))).upcase
-		send("\\#{string}\r", options)
-		#logger.debug "CBus module sent #{string}"
-	end
+    
+    def on_load
+        defaults({
+            wait: false,
+            delay: 100    # NOTE:: maybe too much?
+        })
+
+        config({
+            tokenize: true,
+            delimiter: "\x0D"
+        })
+    end
+    
+    def on_unload
+    end
+    
+    def on_update
+        
+    end
+    
+    
+    def connected
+        send("|||\r", priority: 99)    # Ensure we are in smart mode
+        @polling_timer = schedule.every('60s') do
+            logger.debug "-- Polling CBUS"
+            send("|||\r", priority: 99)    # Ensure we are in smart mode
+        end
+    end
+    
+    def disconnected
+        @polling_timer.cancel unless @polling_timer.nil?
+        @polling_timer = nil
+    end
+    
+    
+    def lighting(group, state, application = 0x38)
+        group = group & 0xFF
+        application = application & 0xFF
+        
+        command = [0x05, application, 0x00]
+        if [On, 1, :on, 'on'].include?(state)
+            state = On
+            command << 0x79 # Group on
+        else
+            state = Off
+            command << 0x01 # Group off
+        end
+        command << group
+
+        self["lighting_group_#{group}"] = state
+        
+        do_send(command)
+    end
+    
+    
+    def lighting_ramp(group, level, rate = 0b0001, application = 0x38)
+        
+        #
+        # rates:
+        # => 0 == instant
+        # => 1 == 4sec
+        # => 2 == 8sec etc
+        #
+        rate = ((rate & 0x0F) << 3) | 0b010    # The command is structured as: 0b0 xxxx 010 where xxxx == rate
+        group = group & 0xFF
+        level = level & 0xFF
+        application = application & 0xFF
+        
+        lighting_term_ramp(group)
+        command = [0x05, application, 0x00, rate, group, level]
+        
+        do_send(command)
+    end
+
+
+
+    def blinds(group, action, application = 0x38)
+        group = group & 0xFF
+        application = application & 0xFF
+
+        command = [0x05, application, 0x00]
+        if is_affirmative?(action)
+            action = Down
+            command += [0x1A, group, 0x00]
+        else
+            command += [0x02, group]
+
+            if is_negatory?(action)
+                action = Up
+                command << 0xFF
+            else
+                # Stop (need to confirm this)
+                command << 0x05
+            end
+        end
+
+        do_send(command)
+    end
+    
+    
+    def trigger(group, action)
+        group = group.to_i & 0xFF
+        action = action.to_i & 0xFF
+        command = [0x05, 0xCA, 0x00, 0x02, group, action]
+        
+        self["trigger_group_#{group}"] = action
+
+        do_send(command)
+    end
+    
+    
+    def trigger_kill(group)
+        group = group.to_i
+        
+        group = group & 0xFF
+        command = [0x05, 0xCA, 0x00, 0x01, group]
+        do_send(command)
+    end
+    
+    
+    def received(data, resolve, command)
+        # Debug here will sometimes have the \n char
+        # This is removed by the hex_to_byte function
+        logger.debug "CBus sent #{data}"
+        
+        data = str_to_array(hex_to_byte(data))
+        
+        if !check_checksum(data)
+            logger.debug "CBus checksum failed"
+            return :failed
+        end
+
+        # We are only looking at Point -> MultiPoint commands
+        return if data[0] != 0x05
+        # 0x03 == Point -> Point -> MultiPoint
+        # 0x06 == Point -> Point
+        
+        application = data[2]    # The application being referenced
+        commands = data[4..-2]    # Remove the header + checksum
+        
+        while commands.length > 0
+            current = commands.shift
+            
+            case application
+            when 0xCA            # Trigger group
+                case current
+                when 0x02            # Trigger Event (ex: 0504CA00 020101 29)
+                    self["trigger_group_#{commands.shift}"] = commands.shift    # Action selector
+                when 0x01            # Trigger Min
+                    self["trigger_group_#{commands.shift}"] = 0
+                when 0x79            # Trigger Max
+                    self["trigger_group_#{commands.shift}"] = 0xFF
+                when 0x09            # Indicator Kill (ex: 0504CA00 0901 23)
+                    commands.shift        # Group (turns off indicators of all scenes triggered by this group)
+                else
+                    break    # We don't know what data is here
+                end
+            when 0x30..0x5F        # Lighting group
+                case current
+                when 0x01            # Group off (ex: 05043800 0101 0102 0103 0104 7905 33)
+                    self["lighting_group_#{commands.shift}"] = Off
+                when 0x79            # Group on (ex: 05013800 7905 44)
+                    self["lighting_group_#{commands.shift}"] = On
+                when 0x02 # Blinds up or stop
+                    group = commands.shift
+                    value = commands.shift
+                    if value == 0xFF
+                        self["blinds_group_#{group}"] = Up
+                    elsif value == 0x05 # Value needs confirmation
+                        self["blinds_group_#{group}"] = :stopped
+                    end
+                when 0x1A # Blinds down
+                    group = commands.shift
+                    value = commands.shift
+                    self["blinds_group_#{group}"] = Down if value == 0x00
+                when 0x09            # Terminate Ramp
+                    commands.shift        # Group address
+                else
+                    if (current & 0b10000101) == 0    # Ramp to level (ex: 05013800 0205FF BC)
+                        commands.shift(2)    # Group address, level
+                    else
+                        break    # We don't know what data is here
+                    end
+                end
+            else
+                break    # We haven't programmed this application
+            end
+        end
+        
+        return :success
+    end
+    
+    
+    protected
+    
+    
+    def lighting_term_ramp(group)
+        command = [0x05, 0x38, 0x00, 0x09, group]
+        do_send(command)
+    end
+    
+    
+    def checksum(data)
+        check = 0
+        data.each do |byte|
+            check += byte
+        end
+        check = check % 0x100
+        check = ((check ^ 0xFF) + 1) & 0xFF
+        return check
+    end
+    
+    def check_checksum(data)
+        check = 0
+        data.each do |byte|
+            check += byte
+        end
+        return (check % 0x100) == 0x00
+    end
+    
+    
+    def do_send(command, options = {})
+        string = byte_to_hex(command << checksum(command)).upcase
+        send("\\#{string}\r", options)
+        #logger.debug "CBus module sent #{string}"
+    end
 end