jtagulator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c34672f543ed66708e247abe5b3d8063c25c4c9b61b036cda1049832c2b4eb26
+  data.tar.gz: 1e54c6d0485918bbb0b38e5b6e3f4f5d8a506e71c7edc0fcbe537bd80a9cefdd
+SHA512:
+  metadata.gz: 929a1a97190d0f9e261af7b59832cdb83baf4ed6c1cf2cb89a6a6d20ad3a94b29622f3366cbf465d1aaafbf7fd1938516dc440d45171c9b3bfd6f56bcc0ed2f4
+  data.tar.gz: c9a0281e8a02c2a194ce43077183fafc2e1d43b75573d71b60ce9550d11257310d30ce528f5d697e1dbb2ce07c4c9a51680094a18b96aab0c2337e86f6943d48

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at drewlongdesign@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jtagulator.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rubocop", "~> 0.80"
+
+gem "serialport", "~> 1.3"
+
+gem "json", "~> 2.6"

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    jtagulator (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    colorize (1.1.0)
+    json (2.6.3)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    serialport (1.3.2)
+    unicode-display_width (1.8.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  colorize (~> 1.1)
+  json (~> 2.6)
+  jtagulator!
+  rake (~> 13.0)
+  rubocop (~> 0.80)
+  serialport (~> 1.3)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 datagoboom
+
+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.md

@@ -0,0 +1,49 @@
+# Ruby JTAGulator
+
+This is a simple ruby wrapper around the [JTAGulator](https://www.crowdsupply.com/grand-idea-studio/jtagulator) from [Grand Idea Studio](https://www.grandideastudio.com/). It is intended to be used as a library for automating hardware assessment using the JTAGulator. Currently, it only supports the following features:
+
+- UART
+  - Identify UART Pinout
+  - UART Passthrough
+- JTAG
+  - Identify JTAG Pinout (Default Mode)
+  - Identify JTAG pinout (IDCODE Scan)
+  - Identify JTAG pinout (BYPASS Scan)
+  - Identify RTCK (adaptive clocking)
+
+More to come. 
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jtagulator'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jtagulator
+
+## Usage
+
+Check out the examples folder for basic usage.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/datagoboom/jtagulator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/jtagulator/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Jtagulator project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/jtagulator/blob/master/CODE_OF_CONDUCT.md).
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "jtagulator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/jtag_examples.rb

@@ -0,0 +1,33 @@
+require_relative "../lib/jtagulator"
+
+def continuous_identify
+  jtag = Jtagulator::API::JTAG.new(port: "/dev/ttyUSB0", debug: true)
+  jtag.start_session
+  results = []
+  ["DEFAULT", "IDCODE", "BYPASS", "RTCK"].each do |mode|
+    puts jtag.identify(
+      id_mode: mode,  # Optional, defaults to "DEFAULT" (j option)
+      wait_limit: 5, # Optional, defaults to 120
+      options: {
+        start_pin: 0,
+        end_pin: 9,
+        bring_low: true, 
+        low_time: 100, 
+        high_time: 100,
+       
+        # You can optionally provide known pins for the BYPASS and RTCK modes
+        # For RTCK, only provide the tck pin (others will be ignored)
+       
+        known_pins: {
+        #  tdi: 0,
+        #  tdo: 1,
+          tck: 2,
+        #  tms: 3
+        }
+
+      }
+    )
+  end 
+end
+
+continuous_identify

data/examples/uart_examples.rb

@@ -0,0 +1,32 @@
+require "colorize"
+require "jtagulator"
+
+def continuous_identify
+  uart = Jtagulator::API::UART.new(port: "/dev/ttyUSB0", debug: true)
+  uart.start_session
+  results = []
+  while true 
+    puts uart.identify(
+      wait_limit: 30,
+      options: { 
+        bring_low: true, 
+        low_time: 100, 
+        high_time: 100,
+        start_pin: 0,
+        end_pin: 1,
+        output_str: "\\x0D"
+      }
+    ).to_s.green
+  end 
+end 
+
+def passthrough_test
+  uart = Jtagulator::API::UART.new(port: "/dev/ttyUSB0", debug: true)
+  uart.start_session
+  uart.start_passthrough
+  res = uart.send_command("1\n")
+  puts res
+  uart.stop_passthrough
+end
+
+continuous_identify

data/jtagulator.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "lib/jtagulator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jtagulator"
+  spec.version       = Jtagulator::VERSION
+  spec.authors       = ["datagoboom"]
+  spec.email         = ["andrew@datagoboom.com"]
+
+  spec.summary       = "Simple library for interacting with the Jtagulator hardware"
+  spec.description   = "Ruby library for interacting with the Jtagulator hardware, including functionality for JTAG, UART, GPIO, and SWD"
+  spec.homepage      = "https://github.com/datagoboom/jtagulator"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage + "/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+end

data/lib/jtagulator/client.rb

@@ -0,0 +1,138 @@
+module Jtagulator
+  module API
+    class Client
+      attr_reader :port
+
+      PARITY_OPTIONS = {
+        "none" => SerialPort::NONE,
+        "even" => SerialPort::EVEN,
+        "odd" => SerialPort::ODD,
+        "mark" => SerialPort::MARK,
+        "space" => SerialPort::SPACE
+      }.freeze
+
+      def initialize(port: "/dev/ttyUSB0", baud: 115_200, data_bits: 8, stop_bits: 1, parity: "none", debug: false)
+        log("Initializing UART")
+        parity_sym = PARITY_OPTIONS[parity] || SerialPort::NONE
+        @port = SerialPort.new(port, baud, data_bits, stop_bits, parity_sym)
+        @debug = debug
+      end
+
+      def start_session
+        log("Starting session")
+        @port.flush_input
+        @port.write(0x68)
+        @port.read_timeout = 2000 # timeout in milliseconds
+        res = safe_read
+        if res == "NO_RESPONSE_LIMIT_REACHED" || res.inspect.to_s.length < 5
+          log("Failed to start session, attempting to restart", error: true)
+          @port.write("\x04") # ctrl+d
+          sleep 1
+          start_session
+        end
+      end
+
+      def safe_read(wait_limit: 3)
+        reading = false
+        wait_time = 0
+        begin
+          @port.read_nonblock(1024)
+        rescue IO::WaitReadable
+          log("Waiting for response from board...") unless reading
+          sleep 0.1
+          reading = true
+          wait_time += 0.1
+          if wait_time > wait_limit
+            log("No response after #{wait_limit} seconds", error: true)
+            return "NO_RESPONSE_LIMIT_REACHED"
+          end
+          retry
+        end
+      end
+
+      def set_mode(mode)
+        log("Attempting to go to main menu")
+        go_to_main_menu
+        log("Setting device mode")
+        map = {
+          "j" => "JTAG",
+          "u" => "UART",
+          "g" => "GPIO",
+          "s" => "SWD"
+        }
+        begin
+          @port.write(mode + "\r")
+          sleep 1
+        rescue Errno::EIO
+          sleep 0.1
+          retry
+        end
+        begin
+          res = @port.read_nonblock(1024) # attempt to read up to 1024 bytes non-blocking
+          res = res.inspect.to_s.gsub('\r', "\r").gsub('\n', "\n")
+        rescue IO::WaitReadable
+          sleep 0.1
+          retry
+        end
+
+        unless res.include?(map[mode])
+          log(res, error: true)
+          send_key("m") 
+          set_mode(mode) 
+        end
+      end
+
+      def go_to_main_menu
+        3.times do
+          send_key("m")
+          sleep 0.25
+        end
+      end
+
+      def send_key(key)
+        @port.write("#{key}\r")
+        res = safe_read
+        log(res)
+        if res == ("?\r\r\n") || res.include?("Value out of range!")
+          return false 
+        else
+          return true
+        end
+      end
+
+      def log(message, error: false)
+        timestamp = Time.now.strftime("[%H:%M:%S]")
+        if @debug
+          if error
+            print timestamp
+            puts "[ERROR]  " + message
+          else
+            if message.include? "\r\r\n"
+              prev_input = message.split("\r\r\n")[0]
+              print timestamp
+              puts "[INPUT]  " + prev_input
+              msgs = message.split("\r\r\n")[1].split("\r\n")
+              msgs.each do |msg|
+                print timestamp
+                puts "[OUTPUT] " + msg.gsub("\r", "").gsub("\n", "")
+              end
+            else
+              print timestamp
+              puts "[LOG]    " + message
+            end
+          end
+        end
+      end
+
+      def collect_results_until_complete
+        results = []
+        until (response = safe_read).include?("complete")
+          result = response.strip
+          results << result unless result == "-" || result.empty?
+          log(response)
+        end
+        results
+      end
+    end
+  end
+end

data/lib/jtagulator/jtag.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module Jtagulator
+  module API
+    class JTAG
+      def initialize(port: "/dev/ttyUSB0", baud: 115_200, data_bits: 8, stop_bits: 1, parity: "none", debug: false)
+        @client = Jtagulator::API::Client.new(
+          port: port,
+          baud: baud,
+          data_bits: data_bits,
+          stop_bits: stop_bits,
+          parity: parity,
+          debug: debug
+        )
+        @port = @client.port
+      end
+
+      def start_session
+        @client.start_session
+      end
+
+      def identify(id_mode: "DEFAULT", wait_limit: 120, options: {})
+        @client.set_mode("j")
+        @client.log("Identifying JTAG pins, mode: #{id_mode}")
+        configure_identify(id_mode, wait_limit, options)
+        response = @client.safe_read(wait_limit: wait_limit)
+
+        results = @client.collect_results_until_complete
+      end
+
+      def configure_identify(id_mode, wait_limit, options)
+        default_options = {
+          voltage: 1.5,
+          start_pin: 0,
+          end_pin: 6,
+          bring_low: false,
+          low_time: 100,
+          high_time: 100
+        }
+
+        options = default_options.merge(options)
+
+        modes = {
+          "DEFAULT" => "j",
+          "IDCODE" => "i",
+          "BYPASS" => "b",
+          "RTCK" => "r"
+        }
+
+        keys = []
+
+        base_keys = [
+          "v",
+          options[:voltage].to_s,
+          modes[id_mode],
+          options[:start_pin].to_s,
+          options[:end_pin].to_s
+        ]
+
+        timing_keys = [
+          options[:low_time].to_s,
+          options[:high_time].to_s
+        ]
+
+        if id_mode == "BYPASS"
+          known = false 
+          known_pins = options[:known_pins]
+          if known_pins
+            known_pins.each do |k, v|
+              if v.to_i > 0 && v.to_i < 23
+                known = true
+              end
+            end
+            if known 
+              # Say yes to "Are any pins already known?"
+              base_keys.push("y")
+
+              # Pins that are unknown will be set to x
+              pins = {
+                tdi: "x",
+                tdo: "x",
+                tck: "x",
+                tms: "x",
+              }
+
+              # Adding known pins to pin list
+              pins.merge!(options[:known_pins]) if options[:known_pins]
+
+              pins.each do |k, v|
+                # Add pin definitions as answers
+                base_keys.push(v)
+              end
+            end 
+          else
+            # Say no to "Are any pins already known?"
+            base_keys.push("n")
+          end
+          
+        elsif id_mode == "RTCK"
+          known = false 
+          known_pins = options[:known_pins]
+          if known_pins
+            known = true if known_pins[:tck].to_i > 0 && known_pins[:tck].to_i < 23
+            if known 
+              # Say yes to "Is TCK already known?"
+              base_keys.push("y")
+              # Add pin definition as answer
+              base_keys.push(known_pins[:tck].to_s)
+            end 
+          end
+        end
+
+        if options[:bring_low]
+          base_keys.push("y")
+          keys = base_keys + timing_keys
+        else
+          base_keys.push("n")
+          keys = base_keys
+        end
+
+        keys.each do |key|
+          @client.send_key(key)
+        end
+        @port.write(" ")
+      end
+    end
+  end
+end
+

data/lib/jtagulator/uart.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+module Jtagulator
+  module API
+    class UART
+      def initialize(port: "/dev/ttyUSB0", baud: 115_200, data_bits: 8, stop_bits: 1, parity: "none", debug: false)
+        @client = Jtagulator::API::Client.new(
+          port: port,
+          baud: baud,
+          data_bits: data_bits,
+          stop_bits: stop_bits,
+          parity: parity,
+          debug: debug
+        )
+        @port = @client.port
+      end
+
+      def start_session
+        @client.start_session
+      end
+
+      def identify(wait_limit: 120, options: {})
+        @client.set_mode("u")
+        @client.log("Identifying UART pins")
+        configure_identify(options)
+
+        response = @client.safe_read(wait_limit: wait_limit)
+
+        results = @client.collect_results_until_complete
+        parsed_results = parse_results(results)
+
+        @client.log("UART pin identification complete")
+        @client.log("No results, is the target connected?", error: true) if results == []
+
+        parsed_results
+      end
+
+      def start_passthrough(options: {})
+        @client.set_mode("u")
+        @client.log("Starting UART passthrough")
+        configure_passthrough(options)
+      end
+
+      def send_command(command)
+        @client.send_key(command)
+        response = @client.safe_read
+        return "No response, timeout reached" if response == "NO_RESPONSE_LIMIT_REACHED"
+      end
+
+      def stop_passthrough
+        @client.log("Stopping UART passthrough")
+        @port.write("\x18") # ctrl+x
+      end
+
+      private
+
+      def configure_identify(options)
+        default_options = {
+          voltage: 1.5,
+          start_pin: 0,
+          end_pin: 1,
+          known_pins: false,
+          output_str: "\\x0D",
+          delay: 10,
+          ignore_non_printable: false,
+          bring_low: false,
+          low_time: 100,
+          high_time: 100
+        }
+
+        orig_opts = options
+        options = default_options.merge(options)
+
+        keys = [
+          "v", 
+          options[:voltage].to_s, 
+          "u",
+          options[:start_pin].to_s, 
+          options[:end_pin].to_s, "n",
+          options[:output_str], 
+          options[:delay].to_s, 
+          options[:ignore_non_printable] ? "y" : "n",
+          options[:bring_low] ? "y" : "n"
+        ]
+
+        keys.push(options[:low_time].to_s, options[:high_time].to_s) if options[:bring_low]
+
+        recovered = false
+
+        keys.each do |key|
+          success = @client.send_key(key)
+          unless success
+            @client.log("Invalid output, restarting", error: true)
+            configure_identify(orig_opts)
+            recovered = true
+            break
+          end
+        end
+        @port.write(" ") unless recovered
+      end
+
+      def configure_passthrough(options)
+        default_options = {
+          voltage: 1.5,
+          baud: 115_200,
+          tx_pin: 0,
+          rx_pin: 1,
+          local_echo: false
+        }
+
+        options = default_options.merge(options)
+
+        keys = [
+          "v", 
+          options[:voltage].to_s, 
+          "p", 
+          options[:tx_pin].to_s, 
+          options[:rx_pin].to_s, 
+          options[:baud].to_s, 
+          options[:local_echo] ? "y" : "n"
+        ]
+
+        keys.each do |key|
+          @client.send_key(key)
+        end
+      end
+
+      def parse_results(results)
+        parsed_data = []
+        current_data = {}
+
+        results.each do |result|
+          result.split("\r\n").each do |line|
+            if txd_match = line.match(/TXD: (\d+)/)
+              current_data[:txd] = txd_match[1]
+            end
+
+            if rxd_match = line.match(/RXD: (\d+)/)
+              current_data[:rxd] = rxd_match[1]
+            end
+
+            if baud_match = line.match(/Baud: (\d+)/)
+              if current_data.key?(:baud)
+                parsed_data.push(current_data)
+                current_data = { txd: current_data[:txd], rxd: current_data[:rxd], baud: baud_match[1] }
+              else
+                current_data[:baud] = baud_match[1]
+              end
+            end
+
+            next unless data_match = line.match(/\[ ([A-F0-9\s]+) \]/)
+
+            data_obj = {
+              raw: data_match[1].split(" ").map { |x| x.to_i(16) },
+              ascii: data_match[1].split(" ").map { |x| x.to_i(16) }.map { |x| hex_to_ascii(x) }.join
+            }
+            current_data[:data] = data_obj
+          end
+        end
+
+        parsed_data.push(current_data) if current_data.key?(:baud)
+
+        parsed_data
+      end
+
+      def hex_to_ascii(hex)
+        if hex >= 32 && hex <= 126
+          hex.chr
+        else
+          "."
+        end
+      end
+    end
+  end
+end

data/lib/jtagulator/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Jtagulator
+  VERSION = "0.1.0"
+end

data/lib/jtagulator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "serialport"
+require "colorize"
+require "json"
+require "jtagulator/client"
+require "jtagulator/jtag"
+require "jtagulator/uart"
+require "jtagulator/version"
+
+module Jtagulator
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: jtagulator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- datagoboom
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-11-08 00:00:00.000000000 Z
+dependencies: []
+description: Ruby library for interacting with the Jtagulator hardware, including
+  functionality for JTAG, UART, GPIO, and SWD
+email:
+- andrew@datagoboom.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/jtag_examples.rb
+- examples/uart_examples.rb
+- jtagulator.gemspec
+- lib/jtagulator.rb
+- lib/jtagulator/client.rb
+- lib/jtagulator/jtag.rb
+- lib/jtagulator/uart.rb
+- lib/jtagulator/version.rb
+homepage: https://github.com/datagoboom/jtagulator
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/datagoboom/jtagulator
+  source_code_uri: https://github.com/datagoboom/jtagulator
+  changelog_uri: https://github.com/datagoboom/jtagulator/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Simple library for interacting with the Jtagulator hardware
+test_files: []