foscam-ruby 0.0.3 → 0.1.0

data/lib/foscam/constants.rb

@@ -0,0 +1,144 @@
+module Foscam
+	# DDNS_STATUS
+	DDNS_STATUS = {
+		0 => "No Action",
+		1 => "It's connecting...",
+		2 => "Can't connect to the Server",
+		3 => "Dyndns Succeed",
+		4 => "DynDns Failed: Dyndns.org Server Error",
+		5 => "DynDns Failed: Incorrect User or Password",
+		6 => "DynDns Failed: Need Credited User",
+		7 => "DynDns Failed: Illegal Host Format",
+		8 => "DynDns Failed: The Host Does not Exist",
+		9 => "DynDns Failed: The Host Does not Belong to You",
+		10 => "DynDns Failed: Too Many or Too Few Hosts",
+		11 => "DynDns Failed: The Host is Blocked for Abusing",
+		12 => "DynDns Failed: Bad Reply from Server",
+		13 => "DynDns Failed: Bad Reply from Server",
+		14 => "Oray Failed: Bad Reply from Server",
+		15 => "Oray Failed: Incorrect User or Password",
+		16 => "Oray Failed: Incorrect Hostname",
+		17 => "Oray Succeed"
+	}
+
+	# UPNP_STATUS
+	UPNP_STATUS = {
+		0 => "No Action",
+		1 => "Succeed",
+		2 => "Device System Error",
+		3 => "Errors in Network Communication",
+		4 => "Errors in Chat with UPnP Device",
+		5 => "Rejected by UPnP Device, Maybe Port Conflict"
+	}
+
+	# ALARM_STATUS
+	ALARM_STATUS = {
+		0 => "No alarm",
+		1 => "Motion alarm",
+		2 => "Input Alarm"
+	}
+
+	# CAMERA_PARAMS_MODE
+	CAMERA_PARAMS_MODE = {
+		0 => "50hz",
+		1 => "60hz",
+		2 => "outdoor"
+	}
+
+	# CAMERA_CONTROL_MODE
+	CAMERA_CONTROL_MODE = CAMERA_PARAMS_MODE.inject({}){|memo,(k,v)| memo[v.to_sym] = k; memo}
+
+	# CAMERA_PARAMS_ORIENTATION
+	CAMERA_PARAMS_ORIENTATION = {
+		0 => "default",
+		1 => "flip",
+		2 => "mirror",
+		3 => "flip+mirror"
+	}
+
+	# CAMERA_CONTROL_ORIENTATION
+	CAMERA_CONTROL_ORIENTATION = CAMERA_PARAMS_ORIENTATION.inject({}){|memo,(k,v)| memo[v.to_sym] = k; memo}
+
+	# CAMERA_PARAMS_RESOLUTION
+	CAMERA_PARAMS_RESOLUTION = {
+		8 => "qvga",
+		32 => "vga"
+	}
+
+	# CAMERA_CONTROL_RESOLUTION
+	CAMERA_CONTROL_RESOLUTION = CAMERA_PARAMS_RESOLUTION.inject({}){|memo,(k,v)| memo[v.to_sym] = k; memo}
+
+	# CAMERA_CONTROLS
+	CAMERA_CONTROLS = {
+		:resolution => 0,
+		:brightness => 1,
+		:contrast 	=> 2,
+		:mode 		=> 3,
+		:flip 		=> 5
+	}
+
+	# DECODER_CONTROLS
+	DECODER_CONTROLS = {
+		:up  => 0,
+		:stop => 1,
+		:stop_up => 1,
+		:down => 2,
+		:stop_down => 3,
+		:left => 4,
+		:stop_left => 5,
+		:right => 6,
+		:stop_right => 7,
+		:center => 25,
+		:vertical_patrol => 26,
+		:stop_vertical_patrol => 27,
+		:horizon_patrol => 28,
+		:stop_horizon_patrol => 29,
+		:io_output_high => 94,
+		:io_output_low => 95,
+	}
+
+	# USER_PERMISSIONS
+	USER_PERMISSIONS = {
+		0 => :visitor,
+		1 => :operator,
+		2 => :administrator
+	}
+
+	# USER_PERMISSIONS_ID
+	USER_PERMISSIONS_ID = USER_PERMISSIONS.invert
+
+	# PTZ_AUTO_PATROL_TYPE
+	PTZ_AUTO_PATROL_TYPE = {
+		0 => :none,
+		1 => :horizontal,
+		2 => :vertical,
+		3 => :"horizontal+vertical"
+	}
+
+	# PTZ_AUTO_PATROL_TYPE_ID
+	PTZ_AUTO_PATROL_TYPE_ID = PTZ_AUTO_PATROL_TYPE.invert
+
+	# LED_MODE
+	LED_MODE = {
+		0 => :mode1,
+		1 => :mode2,
+		2 => :disabled
+	}
+
+	# LED_MODE_ID
+	LED_MODE_ID = LED_MODE.invert
+	
+	# DECODER_BAUD
+	DECODER_BAUD = {
+		9 => :B1200,
+		11 => :B2400,
+		12 => :B4800,
+		13 => :B9600,
+		14 => :B19200,
+		15 => :B38400,
+		4097 => :B57600,
+		4098 => :B115200
+	}
+	# DECODER_BAUD_ID
+	DECODER_BAUD_ID = DECODER_BAUD.invert
+end

data/lib/foscam/model/alarm_config.rb

@@ -0,0 +1,147 @@
+module Foscam
+	module Model
+		class AlarmConfig < Base
+			include Singleton
+
+			define_model_callbacks :save
+
+			attr_reader :motion_armed, :motion_sensitivity, :motion_compensation, :input_armed, :ioin_level, :iolinkage, :preset, :ioout_level, :mail, :upload_interval, :http, :http_url, :msn, :schedule_enable, :schedule
+
+
+			def motion_armed=(val)
+				motion_armed_will_change! unless val == @motion_armed
+				@motion_armed = val
+			end
+
+			def motion_sensitivity=(val)
+				motion_sensitivity_will_change! unless val == @motion_sensitivity
+				@motion_sensitivity = val
+			end
+
+			def motion_compensation=(val)
+				motion_compensation_will_change! unless val == @motion_compensation
+				@motion_compensation = val
+			end
+
+			def input_armed=(val)
+				input_armed_will_change! unless val == @input_armed
+				@input_armed = val
+			end
+
+			def ioin_level=(val)
+				ioin_level_will_change! unless val == @ioin_level
+				@ioin_level = val
+			end
+
+			def iolinkage=(val)
+				iolinkage_will_change! unless val == @iolinkage
+				@iolinkage = val
+			end
+
+			def preset=(val)
+				preset_will_change! unless val == @preset
+				@preset = val
+			end
+
+			def ioout_level=(val)
+				ioout_level_will_change! unless val == @ioout_level
+				@ioout_level = val
+			end
+
+			def mail=(val)
+				mail_will_change! unless val == @mail
+				@mail = val
+			end
+			
+
+			def upload_interval=(val)
+				upload_interval_will_change! unless val == @upload_interval
+				@upload_interval = val
+			end
+
+			def http=(val)
+				http_will_change! unless val == @http
+				@http = val
+			end
+
+			def http_url=(val)
+				http_url_will_change! unless val == @http_url
+				@http_url = val
+			end
+
+			def msn=(val)
+				msn_will_change! unless val == @msn
+				@msn = val
+			end
+
+			def schedule_enable=(val)
+				schedule_enable_will_change! unless val == @schedule_enable
+				@schedule_enable = val
+			end
+
+			def schedule=(val)
+				schedule_will_change! unless val == @schedule
+				@schedule = val
+			end
+
+			def client=(obj)
+				unless obj.nil?
+					AlarmConfig::client = obj
+					params = client.get_params
+					unless params.empty?
+						self.motion_armed = params[:alarm_motion_armed]
+						self.motion_sensitivity = params[:alarm_motion_sensitivity]
+						self.motion_compensation = params[:alarm_motion_compensation]
+						self.input_armed = params[:alarm_input_armed]
+						self.ioin_level = params[:alarm_ioin_level]
+						self.iolinkage = params[:alarm_iolinkage]
+						self.preset = params[:alarm_preset]
+						self.ioout_level = params[:alarm_ioout_level]
+						self.mail = params[:alarm_mail]
+						self.http = params[:alarm_http]
+						self.msn = params[:alarm_msn]
+						self.http_url = params[:alarm_http_url]	
+						self.schedule_enable = params[:alarm_schedule_enable]
+						self.schedule = params[:alarm_schedule]	
+					end
+				end
+			end
+
+			define_attribute_methods [:motion_armed, :motion_sensitivity, :motion_compensation, :input_armed, :ioin_level, :iolinkage, :preset, :ioout_level, :mail, :upload_interval, :http, :http_url, :msn, :schedule_enable, :schedule]
+
+			def save
+				run_callbacks :save do
+					flag = false
+					if changed? && is_valid?
+						@previously_changed = changes
+						flag = client.set_alarm(dirty_params_hash)
+						@changed_attributes.clear if flag
+					end
+					flag
+				end
+			end
+
+			private
+
+			def dirty_params_hash
+				h = {}
+				h.merge!({:motion_armed 		=> self.motion_armed }) if motion_armed_changed?
+				h.merge!({:motion_sensitivity 	=> self.motion_sensitivity }) if motion_sensitivity_changed?
+				h.merge!({:motion_compensation 	=> self.motion_compensation }) if motion_compensation_changed?
+				h.merge!({:input_armed 			=> self.input_armed }) if input_armed_changed?
+				h.merge!({:ioin_level 			=> self.ioin_level }) if ioin_level_changed?
+				h.merge!({:iolinkage 			=> self.iolinkage }) if iolinkage_changed?
+				h.merge!({:preset 				=> self.preset }) if preset_changed?
+				h.merge!({:ioout_level 			=> self.ioout_level }) if ioout_level_changed?
+				h.merge!({:mail 				=> self.mail }) if mail_changed?
+				h.merge!({:upload_interval		=> self.upload_interval }) if upload_interval_changed?
+				h.merge!({:http 				=> self.http }) if http_changed?
+				h.merge!({:msn 					=> self.msn }) if msn_changed?
+				# h.merge!({:http_url 			=> self.http_url }) if http_url_changed?
+				h.merge!({:schedule_enable 		=> self.schedule_enable }) if schedule_enable_changed?
+				# h.merge!({:schedule 			=> self.schedule }) if schedule_changed?
+				h
+			end
+		end
+	end
+end

data/lib/foscam/model/base.rb

@@ -0,0 +1,48 @@
+module Foscam
+	module Model
+		class Base
+			include ::ActiveModel::Dirty
+			include ::ActiveModel::Validations
+			include ::ActiveModel::Conversion
+			extend ::ActiveModel::Callbacks
+			extend ::ActiveModel::Naming
+			extend ::ActiveModel::Translation
+
+
+			# the Foscam client connection
+			cattr_accessor :client
+
+			define_model_callbacks :initialize, :only => [:after]
+			##
+			# @param params [Hash] Device attributes
+			# @option params [Fixnum] :resolution
+			# @option params [Fixnum] :brightness
+			# @option params [Fixnum] :contrast
+			# @option params [String] :orientation
+			def initialize(params ={})
+				# Check if it is a Hash
+				# get the parameters and set them to the attributes
+				run_callbacks :initialize do
+					params.each do |attr, value|
+						self.public_send("#{attr}=", value)
+					end if params
+				end
+				# Check if it is a Foscam::Client
+			end
+
+			##
+			# Connects to the foscam webcam
+			# @param url [String] The address to your camera
+			# @param username [String] username to authorize with the camera
+			# @param password [String] password to authorize with the camera
+			def connect(params)
+				client = ::Foscam::Client.new(params) if params.has_key?(:url)
+			end
+
+			#:nodoc
+			def persisted?
+				true
+			end
+		end
+	end
+end

data/lib/foscam/model/device.rb

@@ -0,0 +1,92 @@
+
+module Foscam
+	module Model
+		class Device < Base
+			include Singleton
+
+			define_model_callbacks :save
+
+			# attr_accessor :name (get_params, set_alias)
+			# attr_accessor :name (get_misc, set_misc)
+			attr_reader :resolution, :brightness, :contrast, :orientation
+
+			def resolution=(val)
+				resolution_will_change! unless val == @resolution
+				@resolution = val
+			end
+
+			def brightness=(val)
+				brightness_will_change! unless val == @brightness
+				@brightness = val
+			end
+
+			def contrast=(val)
+				contrast_will_change! unless val == @contrast
+				@contrast = val
+			end
+
+			def orientation=(val)
+				orientation_will_change! unless val == @orientation
+				@orientation = val
+			end
+
+			def client=(obj)
+				unless obj.nil?
+					Device::client = obj
+					cam_params = client.get_camera_params
+					unless cam_params.empty?
+						@resolution = cam_params[:resolution]
+						@brightness = cam_params[:brightness]
+						@contrast = cam_params[:contrast]
+						@orientation = cam_params[:flip]
+						# mode
+					end
+				end
+			end
+
+			define_attribute_methods [:resolution, :brightness, :contrast, :orientation]
+
+			##
+			# Save the current device
+			# @return [FalseClass, TrueClass] Whether or not the device was successfully saved
+			def save
+				run_callbacks :save do
+					flag = false
+					if changed? && is_valid?
+						@previously_changed = changes
+						flag = client.camera_control(dirty_params_hash)
+						@changed_attributes.clear if flag
+					end
+					flag
+				end
+			end
+
+			##
+			# Capture the current image
+			# @return [nil, ::MiniMagick::Image]
+			def capture
+				client.snapshot
+			end
+
+			##
+			# Preform a decoder action 
+			# @param value [Symbol] The desired motion action to be sent to the camera
+			# @return [FalseClass,TrueClass] whether the request was successful.
+			def action(value)
+				# have an action map to map some subset to the foscam set
+				client.decoder_control(value)
+			end
+
+			private
+
+			def dirty_params_hash
+				h = {}
+				h.merge!({:resolution => @resolution}) if resolution_changed?
+				h.merge!({:brightness => @brightness}) if brightness_changed?
+				h.merge!({:contrast => @contrast}) if contrast_changed?
+				h.merge!({:flip => @orientation}) if orientation_changed?
+				h
+			end
+		end
+	end
+end

data/lib/foscam/model/ftp_server.rb

@@ -0,0 +1,109 @@
+		# 	* :ftp_svr  (String)
+		# 	* :ftp_port  (String)
+		# 	* :ftp_user  (String)
+		# 	* :ftp_pwd  (String)
+		# 	* :ftp_dir  (String)
+		# 	* :ftp_mode  (String)
+		# 	* :ftp_upload_interval  (String)
+		# 	* :ftp_filename  (String)
+		# 	* :ftp_numberoffiles (Fixnum)
+		# 	* :ftp_schedule_enable (FalseClass, TrueClass)
+		# 	* :ftp_schedule (Fixnum)
+
+module Foscam
+	module Model
+		class FtpServer < Base
+
+			include Singleton
+
+
+			define_model_callbacks :save, :clear
+
+			attr_reader :dir, :username, :password, :address, :port, :upload_interval, :schedule
+
+
+			def dir=(val)
+				dir_will_change! unless val == @dir
+				@dir = val
+			end
+
+			def username=(val)
+				username_will_change! unless val == @username
+				@username = val
+			end
+
+			def password=(val)
+				password_will_change! unless val == @password
+				@password = val
+			end
+
+			def address=(val)
+				address_will_change! unless val == @address
+				@address = val
+			end
+
+			def port=(val)
+				port_will_change! unless val == @port
+				@port = val
+			end
+
+			def upload_interval=(val)
+				upload_interval_will_change! unless val == @upload_interval
+				@upload_interval = val
+			end
+
+
+			def client=(obj)
+				unless obj.nil?
+					FtpServer::client = obj
+					params = client.get_params
+					unless params.empty?
+						self.dir = params[:ftp_dir]
+						self.address = params[:ftp_svr]
+						self.port = params[:ftp_port]
+						self.username = params[:ftp_user]
+						self.password = params[:ftp_pwd]
+						self.upload_interval = params[:ftp_upload_interval]
+					end
+				end
+			end
+
+			define_attribute_methods [:dir, :username, :password, :address, :port, :upload_interval]
+
+			def save
+				run_callbacks :save do
+					flag = false
+					if changed? && is_valid?
+						@previously_changed = changes
+						flag = client.set_ftp(dirty_params_hash)
+						@changed_attributes.clear if flag
+					end
+					flag
+				end
+			end
+
+			def clear
+				run_callbacks :clear do
+					flag = false
+					params = {:dir => "", :user => "", :pwd => "", :svr => "", :port => 21, :upload_interval => 0}
+					flag = client.set_ftp(params)
+					@changed_attributes.clear if flag
+					flag
+				end
+			end
+
+			private
+
+			def dirty_params_hash
+				h = {}
+				h.merge!({:dir => self.dir}) if dir_changed?
+				h.merge!({:user => self.username}) if username_changed?
+				h.merge!({:pwd => self.password}) if password_changed?
+				h.merge!({:svr => self.address}) if address_changed?
+				h.merge!({:port => self.port}) if port_changed?
+				h.merge!({:upload_interval => self.upload_interval}) if upload_interval_changed?
+				h
+			end
+		end
+	end
+end