roku-ecp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4596a3e8de44cf9e2828527b7c1db97b868226df2c142a939a673f6954bbeb5a
+  data.tar.gz: 445dd74fd2fea0890730b4daec31ce60ce0ec6eff4fa84a785b4a25ab0835a19
+SHA512:
+  metadata.gz: e3870be57187c600a341aac7d53598c4981f31156e7b7a1230cbac3534f7daa9ffe8c388f0e0053df0295e74d35e27a42dd194a54aa95808af6b816e9a3a0b4b
+  data.tar.gz: f88c5ff06c91c9e0ec8cc093b86b874b453d042507999c0c2cd033e7cc50da59c2af1064c881a30e94c6827e4b9dcf975fd827bc4dbd6280b7742d47e9e06a95

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,15 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    httparty (0.16.2)
+      multi_xml (>= 0.5.2)
+    multi_xml (0.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  httparty
+
+BUNDLED WITH
+   1.16.1

data/bin/console

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/roku'
+require 'irb'
+IRB.start

data/bin/roku

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/roku'
+
+Roku::Input.new.run

data/lib/roku/app.rb

@@ -0,0 +1,13 @@
+module Roku
+  App = Struct.new(:name, :id, :type, :version) do
+    def launch!
+      Client.launch(id)
+    end
+
+    class << self
+      def parse(hash)
+        App.new(*hash.values_at('__content__', 'id', 'type', 'version'))
+      end
+    end
+  end
+end

data/lib/roku/client.rb

@@ -0,0 +1,101 @@
+require 'httparty'
+
+module Roku
+  module Client
+    include HTTParty
+    format :xml
+
+    KEYS = %i[
+      Home
+      Rev
+      Fwd
+      Play
+      Select
+      Left
+      Right
+      Down
+      Up
+      Back
+      InstantReplay
+      Info
+      Backspace
+      Search
+      Enter
+      FindRemote
+      VolumeDown
+      VolumeMute
+      VolumeUp
+      PowerOff
+      InputTuner
+      InputHDMI1
+      InputHDMI2
+      InputHDMI3
+      InputHDMI4
+      InputAV1
+    ].freeze
+
+    class << self
+      def find_device!
+        address = Roku::Discover.search
+        base_uri(address)
+      end
+
+      def apps
+        get('/query/apps').parsed_response['apps']['app'].map do |app|
+          App.parse(app)
+        end
+      end
+
+      def active_app
+        app = get('/query/active-app').parsed_response['active_app']['app']
+        App.parse(app)
+      end
+
+      def device_info
+        get('/query/device-info').parsed_response['device_info']
+      end
+
+      def tv_channels
+        get('/query/tv-channels').parsed_response['tv_channels']
+      end
+
+      def tv_active_channel
+        get('/query/tv-active-channel').parsed_response['tv_channel']
+      end
+
+      def launch(app_id)
+        post("/launch/#{app_id}").success?
+      end
+
+      def install(app_id)
+        post("/install/#{app_id}").success?
+      end
+
+      def send_text(string)
+        string.split('').map do |c|
+          next if c == ' '
+          post("/keypress/#{c}").success?
+        end.all?
+      end
+
+      def keypress(key)
+        return unless KEYS.include?(key.to_sym)
+        post("/keypress/#{key}").success?
+      end
+
+      def keydown(key)
+        return unless KEYS.include?(key.to_sym)
+        post("/keydown/#{key}").success?
+      end
+
+      def keyup(key)
+        return unless KEYS.include?(key.to_sym)
+        post("/keyup/#{key}").success?
+      end
+
+      def input(options = {})
+        post('/input', options)
+      end
+    end
+  end
+end

data/lib/roku/discover.rb

@@ -0,0 +1,56 @@
+require 'socket'
+
+module Roku
+  module Discover
+    MULTICAST_ADDR = '239.255.255.250'.freeze
+    BIND_ADDR = '0.0.0.0'.freeze
+    PORT = 1900
+    REQUEST = "M-SEARCH * HTTP/1.1\n" \
+              "Host: 239.255.255.250:1900\n" \
+              "Man: \"ssdp:discover\"\n" \
+              "ST: roku:ecp\n\n".freeze
+
+    class << self
+      def search
+        bind
+        socket.send(REQUEST, 0, MULTICAST_ADDR, PORT)
+        parse_address(await_response)
+      end
+
+      def await_response
+        Timeout.timeout(5) do
+          loop do
+            response, = socket.recvfrom(1024)
+            if response.include?('LOCATION') && response.include?('200 OK')
+              return response
+            end
+          end
+        end
+      end
+
+      private
+
+      def bind
+        return if @bound
+        socket.bind(BIND_ADDR, PORT)
+        @bound = true
+      end
+
+      def parse_address(response)
+        response.scan(/LOCATION: (.*)\r/).first.first
+      end
+
+      def socket
+        @socket ||= UDPSocket.open.tap do |socket|
+          socket.setsockopt(:IPPROTO_IP, :IP_ADD_MEMBERSHIP, bind_address)
+          socket.setsockopt(:IPPROTO_IP, :IP_MULTICAST_TTL, 1)
+          socket.setsockopt(:SOL_SOCKET, :SO_REUSEPORT, 1)
+        end
+      end
+
+      def bind_address
+        IPAddr.new(MULTICAST_ADDR).hton + IPAddr.new(BIND_ADDR).hton
+      end
+    end
+  end
+end

data/lib/roku/input.rb

@@ -0,0 +1,61 @@
+require 'io/console'
+
+module Roku
+  class Input
+    def run
+      while (input = read_char)
+        case input
+        when ' '
+          Roku::Client.keypress(:Play)
+        when "\r"
+          Roku::Client.keypress(:Select)
+        when "\e[A"
+          Roku::Client.keypress(:Up)
+        when "\e[B"
+          Roku::Client.keypress(:Down)
+        when "\e[C"
+          Roku::Client.keypress(:Right)
+        when "\e[D"
+          Roku::Client.keypress(:Left)
+        when "\u007F"
+          Roku::Client.keypress(:Back)
+        when "\e[1;5A"
+          Roku::Client.keypress(:VolumeUp)
+        when "\e[1;5B"
+          Roku::Client.keypress(:VolumeDown)
+        when 'a'
+          query = prompt('Launch: ')
+          app = Roku::Client.apps.find { |a| a.name.casecmp(query) }
+          if app.nil?
+            print "\rNo app found."
+          else
+            print "\rLaunching #{app.name}."
+            app.launch!
+          end
+        when 'q', "\u0003"
+          break
+        else
+          puts input.inspect
+        end
+      end
+    end
+
+    private
+
+    def read_char
+      $stdin.raw do |stdin|
+        input = stdin.getc.chr
+        if input == "\e"
+          input << stdin.read_nonblock(3) rescue nil
+          input << stdin.read_nonblock(2) rescue nil
+        end
+        return input
+      end
+    end
+
+    def prompt(label)
+      print label
+      $stdin.gets.chomp
+    end
+  end
+end

data/lib/roku.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.push File.dirname(__FILE__)
+
+require 'roku/app'
+require 'roku/client'
+require 'roku/input'
+require 'roku/discover'
+
+module Roku
+end

data/readme.md

@@ -0,0 +1,43 @@
+Roku External Control Protocol
+==============================
+
+This library is a client for the Roku ECP, which allows you to control Roku
+devices on your local network via http.
+
+`Roku::Discover` allows you to find a Roku device on your network.
+
+`Roku::Client` allows you to interact with Roku devices.
+
+`Roku::Input` is a small terminal application that provides keyboard shortcuts
+for interacting.
+
+
+## Usage
+
+Find your Roku device and automatically configure the client to use it.
+
+```ruby
+Roku::Client.find_device!
+# => "http://192.168.0.106:8060/"
+```
+
+Begin interacting
+
+```ruby
+Roku::Client.active_app
+# => #<Struct:Roku::App:0x5611ec31c2a8
+#      id = "13535"
+#      name = "Plex"
+#      type = "appl"
+#      version = "5.3.4"
+
+Roku::Client.keypress(:Play)
+# => true
+```
+
+View lib/roku/client.rb for complete list of buttons presses.
+
+## Limitations / TODO
+
+This approach only supports one device at a time. I only have one device, so I
+can't test a scenario where multiple devices can be found on the network.

data/roku-ecp.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name     = 'roku-ecp'
+  spec.version  = '0.1.0'
+  spec.authors  = ['Jacob Evan Shreve']
+  spec.email    = ['github@shreve.io']
+
+  spec.summary  = 'A library for controlling Roku devices on your local network'
+  spec.homepage = 'https://github.com/shreve/roku-ecp'
+  spec.license  = 'MIT'
+
+  spec.files    = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = 'bin'
+  spec.executables   = ['roku']
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'httparty', '~> 0.16.2'
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: roku-ecp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jacob Evan Shreve
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+description: 
+email:
+- github@shreve.io
+executables:
+- roku
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- bin/console
+- bin/roku
+- lib/roku.rb
+- lib/roku/app.rb
+- lib/roku/client.rb
+- lib/roku/discover.rb
+- lib/roku/input.rb
+- readme.md
+- roku-ecp.gemspec
+homepage: https://github.com/shreve/roku-ecp
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A library for controlling Roku devices on your local network
+test_files: []