prremote 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9069bbf984dd62c31390570c934396581e816ad884511d248ebdf3a40657ae9d
-  data.tar.gz: 853acaa0a69a126503b90ce6726958d194cd56fd5abaf559ff759284d26bf1a6
+  metadata.gz: b5d636b2157c9ef1ede45b69b9df264da77cb142529f0c93d0857e23cb681bca
+  data.tar.gz: e2683165f9b9c91ab1c063295eb06fa3c04b062ab8fbe7f2b574b3dc1593dfe5
 SHA512:
-  metadata.gz: dff7ed500809d4d457b68ae7483e4d47632c5ced344d0c01237bcec981b589b57794a086508ac99ae7ac28f1b2f351e25dc3c3498b99fb87dac172c43720ebc9
-  data.tar.gz: 58fe0f9d4911c33c8ed9456810cef1405784ab9d778d8bb14502fb9832611877e897880ebfbbd84c29b6c69a82bf42add2f020037534fe809908816cff3409ef
+  metadata.gz: 57617c04aa3320602e05f2f3080c4abad1cbc2639ad3a2c1017f90747ff3c5653b588280984cc0a617e0560072059ae89bb2389a460e172cfe41bb926b5589ec
+  data.tar.gz: 16c446180dda99c3a61a80145281cad1732321aa94016e260c6e05fba30775f874cfad3b8e3ea945cb5cc3aff0079b6beb9751fa4c2d349213966fc6bdda2511

data/README.md

@@ -6,11 +6,17 @@
 
 Inspired by [mpremote](https://docs.micropython.org/en/latest/reference/mpremote.html) for MicroPython.
 
+
+[![Gem Version](https://img.shields.io/gem/v/prremote)](https://rubygems.org/gems/prremote)
+[![CI](https://github.com/lumbermill/prremote/actions/workflows/ci.yml/badge.svg)](https://github.com/lumbermill/prremote/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Ruby](https://img.shields.io/badge/ruby-3.4%20%7C%204.0-red)](https://github.com/lumbermill/prremote)
+
 ---
 
 ## Requirements
 
-- Ruby 3.x or later
+- Ruby 3.4 or later
 - Raspberry Pi Pico W
 - `mrbc` (mruby 4.x) for `run`, `deploy`, and `eval`
   - macOS: `brew install mruby`
@@ -63,25 +69,34 @@ Put the device into BOOTSEL mode (hold BOOTSEL, connect USB, release) when promp
 
 ---
 
-### `run FILE`
+### `run FILE [FILE ...]`
 
-Compile a local `.rb` file to mruby bytecode and run it on the device immediately (one-shot).
+Compile one or more local `.rb` files to mruby bytecode and run them on the device immediately (one-shot).
 
 ```bash
 prremote run app.rb
 prremote run blink.rb --port /dev/tty.usbmodem101
 ```
 
+Multiple files are compiled in order into a single `.mrb`. Classes and methods defined in earlier files are available to later ones — this is the recommended alternative to `require`, which is not available in mruby/c.
+
+```bash
+prremote run lib.rb main.rb
+```
+
 The device responds with `RUNNING`, streams any output, then `DONE`.
 
+You can find some examples in [test/samples](test/samples/).
+
 ---
 
-### `deploy FILE`
+### `deploy FILE [FILE ...]`
 
-Compile a local `.rb` file and save it to the device's flash. The script runs automatically on every boot.
+Compile one or more local `.rb` files and save them to the device's flash. The script runs automatically on every boot.
 
 ```bash
 prremote deploy app.rb
+prremote deploy lib.rb main.rb
 ```
 
 The device responds with `DEPLOYED` when the write is complete.
@@ -119,15 +134,16 @@ prremote reset
 
 ---
 
-### `watch FILE`
+### `watch FILE [FILE ...]`
 
-Watch a local file for changes and automatically re-run it on the device on every save.
+Watch one or more local files for changes and automatically re-run them on the device on every save.
 
 ```bash
 prremote watch app.rb
+prremote watch lib.rb main.rb
 ```
 
-Useful during development — save your file and the device immediately runs the updated code.
+Useful during development — save any watched file and the device immediately runs the updated code.
 
 ---
 
@@ -147,9 +163,9 @@ Show the gem version, mrbc version, and the connected device's runtime version.
 
 ```bash
 prremote version
-# prremote: 0.1.1
-# mrbc:     3.3.0 (/usr/local/bin/mrbc)
-# runtime:  0.1.3
+# prremote: 0.1.5
+# runtime:  0.1.5 (/dev/tty.usbmodem101)
+# mrbc: mruby 4.0.0 (2026-04-20) (/opt/homebrew/bin/mrbc)
 ```
 
 ---

data/VERSION

@@ -0,0 +1 @@
+0.1.5

data/lib/prremote/cli.rb

@@ -7,6 +7,7 @@ require_relative 'runtime_manager'
 require_relative 'commands/install'
 require_relative 'commands/deploy'
 require_relative 'commands/undeploy'
+require_relative 'commands/ls'
 require_relative 'commands/run'
 require_relative 'commands/eval_cmd'
 require_relative 'commands/watch'
@@ -23,10 +24,10 @@ module Prremote
     remove_command :tree
 
     desc 'install', 'Flash prremote runtime firmware to Pico W or Pico'
-    option :version, type: :string, desc: "Firmware version to install (default: #{RUNTIME_VERSION})"
+    option :version, type: :string, desc: "Firmware version to install (default: #{VERSION})"
     option :board, type: :string, desc: 'Board type: pico or picow (default: picow)'
     def install
-      version = options[:version] || RUNTIME_VERSION
+      version = options[:version] || VERSION
       board = options[:board] || 'picow'
       unless RuntimeManager::BOARDS.include?(board)
         raise Thor::Error, "Unknown board '#{board}'. Valid values: #{RuntimeManager::BOARDS.join(', ')}"
@@ -37,19 +38,31 @@ module Prremote
       raise Thor::Error, e.message
     end
 
-    desc 'run FILE', 'Compile and run a Ruby script on the device (one-shot)'
-    def run_script(file)
+    desc 'run FILE [FILE ...]', 'Compile and run Ruby scripts on the device (one-shot)'
+    def run_script(*files)
+      raise Thor::Error, 'At least one file is required.' if files.empty?
+
       port = resolve_port
-      Commands::Run.new(port: port, baud: options[:baud]).call(file)
+      Commands::Run.new(port: port, baud: options[:baud]).call(*files)
     rescue StandardError => e
       raise Thor::Error, e.message
     end
     map 'run' => :run_script
 
-    desc 'deploy FILE', 'Compile and save a Ruby script to flash (auto-runs on boot)'
-    def deploy(file)
+    desc 'deploy FILE [FILE ...]', 'Compile and save Ruby scripts to flash (auto-runs on boot)'
+    def deploy(*files)
+      raise Thor::Error, 'At least one file is required.' if files.empty?
+
       port = resolve_port
-      Commands::Deploy.new(port: port, baud: options[:baud]).call(file)
+      Commands::Deploy.new(port: port, baud: options[:baud]).call(*files)
+    rescue StandardError => e
+      raise Thor::Error, e.message
+    end
+
+    desc 'ls', 'Show the script deployed to flash (use `reset` first if a script is running)'
+    def ls
+      port = resolve_port
+      Commands::Ls.new(port: port, baud: options[:baud]).call
     rescue StandardError => e
       raise Thor::Error, e.message
     end
@@ -70,10 +83,12 @@ module Prremote
       raise Thor::Error, e.message
     end
 
-    desc 'watch FILE', 'Watch a Ruby file for changes and re-run on the device automatically'
-    def watch(file)
+    desc 'watch FILE [FILE ...]', 'Watch Ruby files for changes and re-run on the device automatically'
+    def watch(*files)
+      raise Thor::Error, 'At least one file is required.' if files.empty?
+
       port = resolve_port
-      Commands::Watch.new(port: port, baud: options[:baud]).call(file)
+      Commands::Watch.new(port: port, baud: options[:baud]).call(*files)
     rescue StandardError => e
       raise Thor::Error, e.message
     end
@@ -104,10 +119,11 @@ module Prremote
     desc 'version', 'Show prremote, mrbc, and device firmware version'
     def version
       puts "prremote: #{VERSION}"
+      puts "runtime:  #{fetch_runtime_version}"
 
       begin
         major = Mrbc.major_version
-        puts "mrbc:     #{Mrbc.version} (#{Mrbc.bin})"
+        puts "mrbc: #{Mrbc.version} (#{Mrbc.bin})"
         unless major && major >= Mrbc::REQUIRED_MAJOR
           puts "  ** mrbc is too old (need #{Mrbc::REQUIRED_MAJOR}.x) **"
           puts "  Hint: the path can be set via MRBC environment variable."
@@ -115,8 +131,6 @@ module Prremote
       rescue StandardError => e
         puts "mrbc:     (#{e.message})"
       end
-
-      puts "runtime:  #{fetch_runtime_version}"
     end
 
     private
@@ -160,7 +174,7 @@ module Prremote
           next
         end
 
-        return ::Regexp.last_match(1) if buf =~ %r{READY prremote-runtime/([\d.]+)}
+        return "#{::Regexp.last_match(1)} (#{port})" if buf =~ %r{READY prremote-runtime/([\d.]+)}
         return '(not responding)' if Time.now > deadline
 
         sleep 0.05

data/lib/prremote/commands/deploy.rb

@@ -1,34 +1,38 @@
 require 'open3'
 require 'tempfile'
 require_relative '../mrbc'
+require_relative 'serial_helpers'
 
 module Prremote
   module Commands
     class Deploy
+      include SerialHelpers
+
       DEPLOY_MAGIC = 'DPLY'.freeze
+      META_MAGIC   = 'META'.freeze
 
       def initialize(port:, baud:)
         @port = port
         @baud = baud
       end
 
-      def call(rb_path)
-        raise "File not found: #{rb_path}" unless File.exist?(rb_path)
+      def call(*rb_paths)
+        rb_paths.each { |f| raise "File not found: #{f}" unless File.exist?(f) }
 
-        warn "Compiling #{rb_path}..."
-        mrb_data = compile(rb_path)
+        warn "Compiling #{rb_paths.map { |f| File.basename(f) }.join(', ')}..."
+        mrb_data = compile(*rb_paths)
 
         warn 'Deploying to flash...'
-        deploy_to_device(mrb_data)
+        deploy_to_device(mrb_data, rb_paths)
         warn 'Deployed. Script will run automatically on next boot.'
       end
 
       private
 
-      def compile(rb_path)
+      def compile(*rb_paths)
         Mrbc.check_version!
         tmp = Tempfile.new(['prremote', '.mrb'])
-        out, status = Open3.capture2e(Mrbc.bin, '-o', tmp.path, rb_path)
+        out, status = Open3.capture2e(Mrbc.bin, '-o', tmp.path, *rb_paths)
         raise "mrbc failed:\n#{out.chomp}" unless status.success?
 
         File.binread(tmp.path)
@@ -36,19 +40,23 @@ module Prremote
         tmp&.close!
       end
 
-      def deploy_to_device(mrb_data)
+      def deploy_to_device(mrb_data, rb_paths)
         serial = Serial.new(@port, @baud)
-        sleep 0.5
-        serial.read(4096)
-
-        serial.write(DEPLOY_MAGIC + mrb_data)
-        debug "sent DPLY + #{mrb_data.bytesize} bytes"
-
+        wait_for_ready(serial)
+        serial.write(DEPLOY_MAGIC + build_meta_packet(rb_paths) + mrb_data)
         wait_for_deployed(serial)
       ensure
         serial&.close
       end
 
+      def build_meta_packet(rb_paths)
+        names_bytes = rb_paths.map { |f| File.basename(f) }.join(' ').encode('UTF-8').b
+        name_len    = [names_bytes.bytesize, 240].min
+        ts          = Time.now.to_i
+        debug "meta: #{name_len} bytes, ts=#{ts}"
+        META_MAGIC + [name_len].pack('C') + names_bytes[0, name_len] + [ts].pack('N')
+      end
+
       def wait_for_deployed(serial)
         buf = +''
         deadline = Time.now + 30
@@ -64,10 +72,6 @@ module Prremote
         end
       end
 
-      def normalize(str)
-        str.gsub("\r\n", "\n").gsub("\r", '')
-      end
-
       def debug(msg)
         warn "[debug] #{msg}" if ENV['PRREMOTE_DEBUG']
       end

data/lib/prremote/commands/install.rb

@@ -3,7 +3,7 @@ require 'fileutils'
 module Prremote
   module Commands
     class Install
-      def initialize(version: RUNTIME_VERSION, board: 'picow')
+      def initialize(version: VERSION, board: 'picow')
         @version = version
         @board = board
       end

data/lib/prremote/commands/ls.rb

@@ -0,0 +1,61 @@
+require_relative 'serial_helpers'
+
+module Prremote
+  module Commands
+    class Ls
+      include SerialHelpers
+
+      QUERY_MAGIC = 'QURY'.freeze
+
+      def initialize(port:, baud:)
+        @port = port
+        @baud = baud
+      end
+
+      def call
+        result = query_device
+        if result
+          ts_str = if result[:timestamp].positive?
+                     Time.at(result[:timestamp]).strftime('%Y-%m-%d %H:%M:%S')
+                   else
+                     '(unknown)'
+                   end
+          puts 'Deployed script:'
+          puts "  Files:    #{result[:names]}"
+          puts "  Deployed: #{ts_str}"
+        else
+          puts 'No script deployed.'
+        end
+      end
+
+      private
+
+      def query_device
+        serial = Serial.new(@port, @baud)
+        wait_for_ready(serial)
+        serial.write(QUERY_MAGIC)
+
+        buf = +''
+        deadline = Time.now + 5
+        loop do
+          chunk = normalize(serial.read(256) || '')
+          buf << chunk
+
+          if (m = buf.match(/^DEPLOYED (\d+) (.+)\n/))
+            return { timestamp: m[1].to_i, names: m[2].strip }
+          end
+          return nil if buf.include?("NONE\n")
+
+          if Time.now > deadline
+            raise 'Timeout waiting for device response. ' \
+                  'If a script is running, use `prremote reset` first.'
+          end
+
+          sleep 0.05
+        end
+      ensure
+        serial&.close
+      end
+    end
+  end
+end

data/lib/prremote/commands/run.rb

@@ -1,31 +1,36 @@
 require 'open3'
 require 'tempfile'
 require_relative '../mrbc'
+require_relative 'serial_helpers'
 
 module Prremote
   module Commands
     class Run
+      include SerialHelpers
+
       def initialize(port:, baud:)
         @port = port
         @baud = baud
       end
 
-      def call(rb_path)
-        raise "File not found: #{rb_path}" unless File.exist?(rb_path)
+      def call(*rb_paths)
+        rb_paths.each { |f| raise "File not found: #{f}" unless File.exist?(f) }
 
-        warn "Compiling #{rb_path}..."
-        mrb_data = compile(rb_path)
+        warn "Compiling #{rb_paths.map { |f| File.basename(f) }.join(', ')}..."
+        mrb_data = compile(*rb_paths)
 
         warn 'Running...'
         run_on_device(mrb_data)
+      rescue Interrupt
+        warn ''
       end
 
       private
 
-      def compile(rb_path)
+      def compile(*rb_paths)
         Mrbc.check_version!
         tmp = Tempfile.new(['prremote', '.mrb'])
-        out, status = Open3.capture2e(Mrbc.bin, '-o', tmp.path, rb_path)
+        out, status = Open3.capture2e(Mrbc.bin, '-o', tmp.path, *rb_paths)
         raise "mrbc failed:\n#{out.chomp}" unless status.success?
 
         File.binread(tmp.path)
@@ -35,15 +40,17 @@ module Prremote
 
       def run_on_device(mrb_data)
         serial = Serial.new(@port, @baud)
-        sleep 0.5
-        drained = serial.read(4096) || ''
-        debug "drained #{drained.bytesize} bytes: #{drained.inspect}"
+        wait_for_ready(serial)
 
         serial.write(mrb_data)
         debug "sent #{mrb_data.bytesize} bytes (first 4: #{mrb_data[0, 4].inspect})"
 
         post_running = wait_for_running(serial)
         stream_until_done(serial, post_running)
+      rescue Interrupt
+        serial&.write("\x03")
+        sleep 0.1
+        raise
       ensure
         serial&.close
       end
@@ -91,10 +98,6 @@ module Prremote
         end
       end
 
-      def normalize(str)
-        str.gsub("\r\n", "\n").gsub("\r", '')
-      end
-
       def debug(msg)
         warn "[debug] #{msg}" if ENV['PRREMOTE_DEBUG']
       end

data/lib/prremote/commands/serial_helpers.rb

@@ -0,0 +1,21 @@
+module Prremote
+  module Commands
+    module SerialHelpers
+      def wait_for_ready(serial)
+        buf = +''
+        deadline = Time.now + 10
+        loop do
+          buf << normalize(serial.read(256) || '')
+          return if buf.include?('READY ')
+          raise 'Timeout waiting for device. Run `prremote reset` if a script is running.' if Time.now > deadline
+
+          sleep 0.05
+        end
+      end
+
+      def normalize(str)
+        str.gsub("\r\n", "\n").gsub("\r", '')
+      end
+    end
+  end
+end

data/lib/prremote/commands/watch.rb

@@ -10,21 +10,22 @@ module Prremote
         @baud = baud
       end
 
-      def call(rb_path)
-        raise "File not found: #{rb_path}" unless File.exist?(rb_path)
+      def call(*rb_paths)
+        rb_paths.each { |f| raise "File not found: #{f}" unless File.exist?(f) }
 
-        warn "Watching #{rb_path} (Ctrl+C to stop)..."
-        last_mtime = File.mtime(rb_path)
-        run(rb_path)
+        label = rb_paths.map { |f| File.basename(f) }.join(', ')
+        warn "Watching #{label} (Ctrl+C to stop)..."
+        mtimes = rb_paths.map { |f| File.mtime(f) }
+        run(*rb_paths)
 
         loop do
           sleep POLL_INTERVAL
-          mtime = File.mtime(rb_path)
-          next if mtime == last_mtime
+          new_mtimes = rb_paths.map { |f| File.mtime(f) }
+          next if new_mtimes == mtimes
 
-          last_mtime = mtime
-          warn "\n--- #{rb_path} changed, re-running ---"
-          run(rb_path)
+          mtimes = new_mtimes
+          warn "\n--- #{label} changed, re-running ---"
+          run(*rb_paths)
         end
       rescue Interrupt
         warn "\nStopped watching."
@@ -32,8 +33,8 @@ module Prremote
 
       private
 
-      def run(rb_path)
-        Run.new(port: @port, baud: @baud).call(rb_path)
+      def run(*rb_paths)
+        Run.new(port: @port, baud: @baud).call(*rb_paths)
       rescue StandardError => e
         warn "Error: #{e.message}"
       end

data/lib/prremote/version.rb

@@ -1,4 +1,3 @@
 module Prremote
-  VERSION         = '0.1.2'
-  RUNTIME_VERSION = '0.1.3'
+  VERSION = File.read(File.expand_path('../../VERSION', __dir__)).strip
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prremote
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.5
 platform: ruby
 authors:
 - ITO Yosei
@@ -103,13 +103,16 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- VERSION
 - bin/prremote
 - lib/prremote.rb
 - lib/prremote/cli.rb
 - lib/prremote/commands/deploy.rb
 - lib/prremote/commands/eval_cmd.rb
 - lib/prremote/commands/install.rb
+- lib/prremote/commands/ls.rb
 - lib/prremote/commands/run.rb
+- lib/prremote/commands/serial_helpers.rb
 - lib/prremote/commands/undeploy.rb
 - lib/prremote/commands/watch.rb
 - lib/prremote/detector.rb