sony-camera-remote 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aeb620a8b307adabd51dd98244f0b151c6145414
+  data.tar.gz: 4667ae3c570441c343c3390cb234e0917564e7bc
+SHA512:
+  metadata.gz: 5ee13de0fdac63aa8cf5d32abb75c2f008722d9bda2c91200b8f0f6a5c3113d48a7e24123d3e5fd99767da370e0e18c757d8f32a18eb340fcfca9a0b1bf864be
+  data.tar.gz: 987a756c1c49a3caaa6244d8600ed5773b8f90535d14aa5f14975da4e169463f257e6ef93f7d07736c6cb2227c7756c01dc9808fecd051bdf818d7b4a70f957a

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0

data/CONTRIBUTING.markdown

@@ -0,0 +1,7 @@
+# Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sony-camera-remote.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,12 @@
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard 'minitest' do
+  watch(%r|^test/unit/test_(.*)\.rb|){|m| "test/unit/test_#{m[1]}.rb"}
+  watch(%r|^lib/*\.rb|){'test/unit'}
+  watch(%r|^lib/.*/*\.rb|){'test/unit'}
+  watch(%r{^lib/.*/([^/]+)\.rb$}){|m| "test/unit/test_#{m[1]}.rb"}
+  watch(%r|^test/helper\.rb|){'test/unit'}
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nicholas E. Rabenau
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,52 @@
+# SonyCameraRemote
+
+[![Build Status](https://secure.travis-ci.org/nerab/sony-camera-remote.png?branch=master)](http://travis-ci.org/nerab/sony-camera-remote)
+
+Provides a Ruby wrapper around the API for cameras that support the Sony [Camera Remote API](http://developer.sony.com/develop/cameras/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sony-camera-remote'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sony-camera-remote
+
+## Usage
+
+    require 'sony_camera_remote'
+
+    # Discover cameras and their services using UPnP
+    Discovery::Client.new.discover
+    # => ['http://10.0.0.1:10000/sony/camera']
+
+    cam = Camera.new('http://10.0.0.1:10000/sony/camera')
+    img_uri = cam.shoot
+    # => http://10.0.0.1:60152/pict140119_1923230000.JPG?%211234%21http%2dget%3a%2a%3aimage%2fjpeg%3a%2a%21%21%21%21%21
+
+## Command-line client
+
+    # Assuming that the camera is in photo mode
+    $ sonycam shoot
+    http://10.0.0.1:60152/pict140119_1923230000.JPG?%211234%21http%2dget%3a%2a%3aimage%2fjpeg%3a%2a%21%21%21%21%21
+
+    # Shoot and open browser with the returned image URL
+    $ open $(sonycam)     # Mac
+    $ xdg-open $(sonycam) # GNOME
+
+## Manually testing the Camera Remote API
+
+    # Discover devices using UPnP
+    bin/search-nex.py
+
+    # Fetch the endpoint URLs manually
+    curl http://10.0.0.1:64321/DmsRmtDesc.xml | xmllint --format -
+
+    # take a picture manually
+    curl -v -X POST -H "Content-Type: application/json" -d '{"method":"actTakePicture", "params":[], "id":1, "version":"1.0"}' http://10.0.0.1:10000/sony/camera

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |test|
+  test.libs << 'lib' << 'test' << 'test/unit'
+  test.pattern = 'test/unit/test_*.rb'
+end
+
+task :default => :test

data/TODO.markdown

@@ -0,0 +1,73 @@
+# Test private APIs from http://chdk.setepontos.com/index.php?topic=10736.0
+
+  camera/setFlashMode
+  camera/getFlashMode
+  camera/getSupportedFlashMode
+  camera/getAvailableFlashMode
+  camera/setExposureCompensation
+  camera/getExposureCompensation
+  camera/getSupportedExposureCompensation
+  camera/getAvailableExposureCompensation
+  camera/setSteadyMode
+  camera/getSteadyMode
+  camera/getSupportedSteadyMode
+  camera/getAvailableSteadyMode
+  camera/setViewAngle
+  camera/getViewAngle
+  camera/getSupportedViewAngle
+  camera/getAvailableViewAngle
+  camera/setMovieQuality
+  camera/getMovieQuality
+  camera/getSupportedMovieQuality
+  camera/getAvailableMovieQuality
+  camera/setFocusMode
+  camera/getFocusMode
+  camera/getSupportedFocusMode
+  camera/getAvailableFocusMode
+  camera/setStillSize
+  camera/getStillSize
+  camera/getSupportedStillSize
+  camera/getAvailableStillSize
+  camera/setBeepMode
+  camera/getBeepMode
+  camera/getSupportedBeepMode
+  camera/getAvailableBeepMode
+  camera/setCameraFunction
+  camera/getCameraFunction
+  camera/getSupportedCameraFunction
+  camera/getAvailableCameraFunction
+  camera/setLiveviewSize
+  camera/getLiveviewSize
+  camera/getSupportedLiveviewSize
+  camera/getAvailableLiveviewSize
+  camera/setTouchAFPosition
+  camera/getTouchAFPosition
+  camera/cancelTouchAFPosition
+  camera/setFNumber
+  camera/getFNumber
+  camera/getSupportedFNumber
+  camera/getAvailableFNumber
+  camera/setShutterSpeed
+  camera/getShutterSpeed
+  camera/getSupportedShutterSpeed
+  camera/getAvailableShutterSpeed
+  camera/setIsoSpeedRate
+  camera/getIsoSpeedRate
+  camera/getSupportedIsoSpeedRate
+  camera/getAvailableIsoSpeedRate
+  camera/setExposureMode
+  camera/getExposureMode
+  camera/getSupportedExposureMode
+  camera/getAvailableExposureMode
+  camera/setWhiteBalance
+  camera/getWhiteBalance
+  camera/getSupportedWhiteBalance
+  camera/getAvailableWhiteBalance
+  camera/setProgramShift
+  camera/getSupportedProgramShift
+  camera/getStorageInformation
+  camera/startLiveviewWithSize
+  camera/startIntervalStillRec
+  camera/stopIntervalStillRec
+  camera/actFormatStorage
+  system/setCurrentTime

data/bin/search-nex.py

@@ -0,0 +1,25 @@
+#!/usr/bin/python
+
+# from https://github.com/crquan/work-on-sony-apis/blob/master/search-nex.py
+# Added bind() in order to specify which local address (interface) to use
+
+import sys
+import socket
+import time
+
+SSDP_ADDR = "239.255.255.250";
+SSDP_PORT = 1900;
+SSDP_MX = 1;
+SSDP_ST = "urn:schemas-sony-com:service:ScalarWebAPI:1";
+
+ssdpRequest = "M-SEARCH * HTTP/1.1\r\n" + \
+              "HOST: %s:%d\r\n" % (SSDP_ADDR, SSDP_PORT) + \
+              "MAN: \"ssdp:discover\"\r\n" + \
+              "MX: %d\r\n" % (SSDP_MX, ) + \
+              "ST: %s\r\n" % (SSDP_ST, ) + "\r\n";
+
+sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+sock.bind(("10.0.1.1", 0))
+
+sock.sendto(ssdpRequest, (SSDP_ADDR, SSDP_PORT))
+print sock.recv(1000)

data/bin/sonycam

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'sony_camera_remote'
+require 'yaml'
+include SonyCameraRemote
+
+config_file = File.join(ENV['HOME'], '.' << File.basename(__FILE__))
+
+if File.exist?(config_file)
+  config = YAML::load(File.read(config_file))
+else
+  config = {:verbose => true}
+end
+
+verbose = config[:verbose]
+method = ARGV[0] || 'shoot'
+
+begin
+  camera_uris = config[:uris]
+
+  if camera_uris.nil? || camera_uris.empty?
+    # Discover and save endpoints
+    camera_uris = Discovery::Client.new.discover.map do |device|
+      if camera_service = device.services['camera']
+        STDERR.puts "#{device.name} has camera service at #{camera_service.base_uri}." if verbose
+        camera_service.base_uri.to_s
+      else
+        STDERR.puts "Error: #{device.name} has no camera service."
+      end
+    end.compact
+
+    config[:uris] = camera_uris
+    File.open(config_file, 'w'){|f| YAML.dump(config, f)}
+  end
+
+  camera_uris.each do |uri|
+    puts Camera.new(uri).send(method)
+  end
+rescue
+  STDERR.puts("Error: #{$!}")
+
+  if verbose
+    $!.backtrace.each do |b|
+      STDERR.puts(b)
+    end
+  end
+end

data/lib/sony_camera_remote.rb

@@ -0,0 +1,5 @@
+require 'require_all'
+require_rel 'sony_camera_remote'
+
+module SonyCameraRemote
+end

data/lib/sony_camera_remote/camera.rb

@@ -0,0 +1,61 @@
+require 'httparty'
+require 'json'
+
+module SonyCameraRemote
+  class Camera
+    API_VERSION = '2.0.0'
+
+    include HTTParty
+
+    DEFAULT_OPTIONS = {:version => '1.0', :params => [], :id => 1}
+
+    class ApplicationInfo < Struct.new(:name, :api_version)
+      def to_s
+        "#{name} v#{api_version}"
+      end
+    end
+
+    class IncompatibleAPIVersion < StandardError
+      attr_reader :supported, :actual
+
+      def initialize(supported, actual)
+        super("The camera provides API version #{actual}, but this library only supports #{supported}.")
+        @supported, @actual = supported, actual
+      end
+    end
+
+    def initialize(uri)
+      self.class.base_uri(URI(uri).to_s)
+
+      ai = application_info
+      raise IncompatibleAPIVersion(API_VERSION, ai.api_version) if API_VERSION != ai.api_version
+    end
+
+    def shootmode
+      options = {:body => DEFAULT_OPTIONS.merge({:method => 'getShootMode'}).to_json}
+      self.class.post('', options)['result'].first
+    end
+
+    def supported_shootmodes
+      options = {:body => DEFAULT_OPTIONS.merge({:method => 'getSupportedShootMode'}).to_json}
+      self.class.post('', options)['result'].first
+    end
+
+    def application_info
+      options = {:body => DEFAULT_OPTIONS.merge({:method => 'getApplicationInfo'}).to_json}
+      result = self.class.post('', options)['result']
+      ApplicationInfo.new(result.first, result.last)
+    end
+
+    def available_methods
+      options = {:body => DEFAULT_OPTIONS.merge({:method => 'getAvailableApiList'}).to_json}
+      self.class.post('', options)['result'].first
+    end
+
+    # blocking
+    def shoot
+      options = {:body => DEFAULT_OPTIONS.merge({:method => 'actTakePicture'}).to_json}
+      self.class.post('', options)['result'].first
+    end
+  end
+end

data/lib/sony_camera_remote/device.rb

@@ -0,0 +1,19 @@
+module SonyCameraRemote
+  class Model < Struct.new(:name, :description, :url)
+  end
+
+  class Manufacturer < Struct.new(:name, :url)
+  end
+
+  class Device < Struct.new(:name, :manufacturer, :model)
+    attr_reader :services
+
+    def initialize
+      @services = {}
+    end
+  end
+
+  class ScalarWebAPIDevice < Device
+    attr_accessor :version, :imaging_device
+  end
+end

data/lib/sony_camera_remote/discovery/client.rb

@@ -0,0 +1,90 @@
+require 'socket'
+require 'system/getifaddrs'
+require 'timeout'
+
+module SonyCameraRemote
+  module Discovery
+    class Client
+      include Socket::Constants
+
+      class UnknownInterface < StandardError
+        def initialize(offending, available)
+          super("The interface '#{offending}' is not known. Possible values are #{available.join(', ')}.")
+        end
+      end
+
+      SSDP_ADDR = {
+        nil => '239.255.255.250',
+        :ipv6_link_local => 'FF02::C',
+        :ipv6_subnet => 'FF03::C',
+        :ipv6_administrative => 'FF04::C',
+        :ipv6_site_local => 'FF05::C',
+        :ipv6_global => 'FF0E::C',
+      }
+
+      SSDP_PORT = 1900
+
+      # TODO Move the enumeration and address lookup to its own class. This class does too much.
+      def initialize(local_addrs = nil, timeout = 10, scope = nil)
+        if local_addrs.nil?
+          # Use all of the system's IP addresses
+          @local_addrs = ip_addresses
+        elsif local_addrs !~ /\b(?:\d{1,3}\.){3}\d{1,3}\b/ # http://www.regular-expressions.info/examples.html
+          # Not exactly an IP address, so we treat it as interface name
+          # TODO Support not just one, but a list of interfaces
+          # TODO System.get_ifaddrs seems to return IPv4 addresses only
+          if_addr = System.get_ifaddrs.fetch(local_addrs.to_sym) do |ip|
+            raise UnknownInterface.new(ip, System.get_ifaddrs.keys)
+          end[:inet_addr]
+
+          @local_addrs = addr_info(if_addr)
+        else
+          @local_addrs = addr_info(local_addrs)
+        end
+
+        @addr = SSDP_ADDR[@scope]
+        @timeout = timeout
+      end
+
+      def discover
+        Array(@local_addrs).map do |local_addr|
+          begin
+            DeviceInfo.fetch(inquire(local_addr).location)
+          rescue Errno::EADDRNOTAVAIL
+            # TODO Notify observers instead of writing to STDOUT
+            STDOUT.puts("Warning: Could not bind to #{local_addr.ip_address}.")
+          rescue Errno::EINVAL
+            STDOUT.puts("Warning: Address #{local_addr.ip_address} not supported.")
+          rescue Timeout::Error
+            STDOUT.puts("Warning: Timeout binding to #{local_addr.ip_address}.")
+          end
+        end.compact
+      end
+
+      private
+
+      def inquire(local_addr)
+        if local_addr.ipv4?
+          socket = UDPSocket.new
+        else
+          socket = UDPSocket.new(Socket::AF_INET6)
+        end
+
+        socket.bind(local_addr.ip_address, 0)
+        socket.send(Request.new(@addr, SSDP_PORT, @timeout).to_s, 0, @addr, SSDP_PORT)
+
+        Timeout::timeout(@timeout) do
+          Response.new(socket.recv(1000))
+        end
+      end
+
+      def ip_addresses
+        Socket.ip_address_list.reject{|a| a.ipv4_loopback? || a.ipv6_loopback? || a.ipv6_linklocal?}
+      end
+
+      def addr_info(if_addr)
+        Addrinfo.new(Socket.sockaddr_in(SSDP_PORT, if_addr))
+      end
+    end
+  end
+end