binterm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a84eb7d8ac7f03f2dcaa13287feff82070dc2d36d2a499c2d9a9575753aac127
+  data.tar.gz: c94056307427d15787fef8fe57f9c0206398cf03d8b7f31ca137fdbe0a6d8b54
+SHA512:
+  metadata.gz: ce0e99343222b63659c1cb31ce114da07ffb894d49610f17a61c34fcd207ed197c9f33b6bb71e165f47f0a475d236d2ab929bee4fd353b0b0c3e7968c2892754
+  data.tar.gz: 59567ebe2eae3c7c05a9739add2f5682790c92a43bf71ac62603bcd170a47f8180a664dba7472ef9cce6d4a80f4aa1a80f3553e8b334f9e7af204ef928249d93

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.idea/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at aarontc@aarontc.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in binterm.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    binterm (0.1.0)
+      optimist (~> 3)
+      rubyserial (~> 0.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ffi (1.9.25)
+    minitest (5.11.3)
+    optimist (3.0.0)
+    rake (10.5.0)
+    rubyserial (0.6.0)
+      ffi (~> 1.9, >= 1.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  binterm!
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Aaron Ten Clay
+
+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,44 @@
+# Binterm
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/binterm`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'binterm'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install binterm
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/binterm. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 Binterm project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/binterm/blob/master/CODE_OF_CONDUCT.md).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+	t.libs << 'test'
+	t.libs << 'lib'
+	t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "binterm"
+
+# 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/binterm.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'binterm/version'
+
+Gem::Specification.new do |spec|
+	spec.name = 'binterm'
+	spec.version = BinTerm::VERSION
+	spec.authors = ['Aaron Ten Clay']
+	spec.email = ['binterm-gem@aarontc.com']
+
+	spec.summary = %q{A simple binary terminal interface for development/troubleshooting.}
+	spec.description = %q{A simple binary terminal interface for development/troubleshooting. Proof of concept.}
+	spec.homepage = 'https://aarontc.com/projects/binterm'
+	spec.license = 'MIT'
+
+	# 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('..', __FILE__)) do
+		`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+	end
+	spec.bindir = 'exe'
+	spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+	spec.require_paths = ['lib']
+
+	spec.add_dependency 'optimist', '~> 3'
+	spec.add_dependency 'rubyserial', '~> 0.6'
+
+	spec.add_development_dependency 'bundler', '~> 1.16'
+	spec.add_development_dependency 'rake', '~> 10.0'
+	spec.add_development_dependency 'minitest', '~> 5.0'
+end

data/exe/binterm

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+require 'optimist'
+
+require_relative '../lib/binterm/bin_term'
+require_relative '../lib/binterm/version'
+
+options = Optimist.options do
+	version "BinTerm #{BinTerm::VERSION} (c) 2018 Aaron Ten Clay"
+	banner <<-EOS
+This is a simple proof-of-concept for a binary terminal interface.
+
+Usage:
+	binterm [options] <serial device>
+
+where [options] are:
+	EOS
+
+	opt :baud, 'Baud rate', default: 115200, type: :integer
+end
+options[:device_path] = ARGV[0]
+options.delete :help
+options.delete :version
+
+Optimist.educate unless options[:device_path]
+
+
+BinTerm::BinTerm.new(**options).run

data/lib/binterm/bin_term.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+require 'rubyserial'
+
+module BinTerm
+	class BinTerm
+		def initialize(device_path:, baud:)
+			@device_path = device_path
+			@baud = baud
+
+		end
+
+
+		def run
+			@connection = Serial.new @device_path, @baud
+
+			launch_read_thread
+			$stdout.sync = true
+
+			while (line = $stdin.gets)
+				begin
+					line.strip!
+					bytes = line.split(' ').map do |b|
+						value = 0
+						b.unpack('C*').reverse.each_with_index do |character_code, index|
+							decimal = ascii_hex_value character_code
+							value += decimal * 16 ** index
+						end
+						value
+					end
+
+					@connection.write bytes.pack('C*')
+				rescue => e
+					puts "ERR: #{e}"
+				end
+			end
+		end
+
+
+		private
+
+
+		def ascii_hex_value(value)
+			case value
+				# 0 - 9
+				when 48..57
+					value - 48
+				# a - f
+				when 97..102
+					value - 87
+				# A - F
+				when 65..70
+					value - 55
+				else
+					raise "Invalid hex character: #{value.chr.inspect}"
+			end
+		end
+
+
+		def launch_read_thread
+			Thread.new do
+				loop do
+					begin
+						data = @connection.read 1024
+						hex_dump data if data
+						sleep 0.01
+					end
+				end
+			end
+		end
+
+
+		def hex_dump(byte_string)
+			bytes_per_line = 32
+			offset = 0
+
+			byte_string.unpack('C*').each_slice(bytes_per_line) do |bytes|
+				hex_groups = []
+				bytes.each_slice(8) do |group|
+					hex_groups.push format('%0x ' * group.length, *group).strip
+				end
+				display = bytes.map { |b| b >= 32 && b <= 126 ? b.chr : '.' }.join
+
+				line = format '%08d | %s | %s', offset, hex_groups.join(' '), display
+				puts line
+
+				offset += bytes.length
+			end
+		end
+	end
+end

data/lib/binterm/version.rb

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

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: binterm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaron Ten Clay
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: optimist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rubyserial
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A simple binary terminal interface for development/troubleshooting. Proof
+  of concept.
+email:
+- binterm-gem@aarontc.com
+executables:
+- binterm
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- binterm.gemspec
+- exe/binterm
+- lib/binterm/bin_term.rb
+- lib/binterm/version.rb
+homepage: https://aarontc.com/projects/binterm
+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 simple binary terminal interface for development/troubleshooting.
+test_files: []