sterm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e4bdd6323c4be6d5c976f1f17ec44245affa7b08d96e70174825f39cba1744cc
+  data.tar.gz: 7a451ed0c582e8b8ea4f5af4928a5802efc0119446df18d7d6daa068e7682083
+SHA512:
+  metadata.gz: 872aabae485fb9f03794c476bfddd2485f19bcdf7656cb728817fa75a4a9c6496122a93898bafa515e346ae4a690763885cefa1dc06e3e6698a589147df96acf
+  data.tar.gz: db5115d727cf911d9d77b2d536fbb6e3013d176d4dd40e301868aa874761038d885da86e9974bcf949c9abcafd84f92327e3a6a27ba593675ffd3be8a1b9a4b7

data/.gitignore

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

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 sterm.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    sterm (0.1.0)
+      rainbow
+      serialport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rainbow (3.0.0)
+    rake (10.5.0)
+    serialport (1.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  sterm!
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -0,0 +1,24 @@
+# SerialTerm
+SerialTerm is a very simple command line tool to output data received from a serial device using the <a href="https://rubygems.org/gems/serialport/versions/1.3.1" target="_blank">serialport</a> gem.  
+
+## Installation  
+To install, just run:  
+    $ gem install sterm
+
+## Usage
+
+$ sterm DEVICE_PATH [-b BAUD_RATE -d DATA_BITS -s STOP_BITS -e LINE_ENDING]  
+  
+Default baud rate is 115200  
+Default data bits is 8  
+Default stop bits is 1  
+  
+LINE_ENDING is the **hex** value of the desired terminating string.  
+Default line ending is 0d0a (which is "\r\n" in hex).  
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/guineec/sterm.  
+  
+## License  
+This program is licensed under the <a href="https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt">GNU GPLv2.0</a> as required by the use of <a href="https://rubygems.org/gems/serialport/versions/1.3.1" target="_blank">serialport</a>.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+# SerialTerm is a very simple command line tool that outputs data received from a serial device.
+# Copyright (C) 2019 Cian Guinee
+
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+require "sterm"
+
+include Sterm
+
+trap "SIGINT" do
+  puts "\nBye!"
+  exit(0)
+end
+
+Sterm.sterm(ARGV)

data/lib/sterm.rb

@@ -0,0 +1,104 @@
+# SerialTerm is a very simple command line tool that outputs data received from a serial device.
+# Copyright (C) 2019 Cian Guinee
+
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+require "sterm/version"
+require "optparse"
+require "rainbow"
+require "serialport"
+
+module Sterm
+  class Error < StandardError; end
+
+  def sterm(arguments)
+    # Parse the arguments provided by the user
+    opts = {}
+    op = OptionParser.new do |options|
+      options.banner = %Q{SerialTerm is a very simple command line tool to output data received from a serial device.
+Usage: sterm DEVICE_PATH [options]\nTry starting with `sterm -h` for help\n\n}
+
+      options.on("-b BAUD_RATE", "--baud-rate", "Baud rate at which the serial device is transmitting (Default: 115200)") do |baud_rate|
+        opts[:baud_rate] = baud_rate
+      end
+
+      options.on("-d DATA_BITS", "--data-bits", "Data bits by device (Default: 8") do |data_bits|
+        opts[:data_bits] = data_bits
+      end
+
+      options.on("-s STOP_BITS", "--stop-bits", "Stop bits for device (Default: 1)") do |stop_bits|
+        opts[:stop_bits] = stop_bits
+      end
+
+      options.on("-e STRING", "--ends-with", "The string (in hex) that terminates each line sent by the device (Default: \"0D0A\" (\\r\\n)") do |ending|
+        opts[:ending] = ending
+      end
+    end
+    op.parse!(arguments)
+
+    # Ensure the device path is given
+    device_path = ""
+    if ARGV.length < 1 
+      STDERR.puts Rainbow("ERROR:").red + " No device path specified. Exiting."
+      exit(11)
+    else
+      device_path = ARGV[0]
+    end
+
+    # Set the options 
+    baud_rate = opts[:baud_rate]
+    if baud_rate.nil? || baud_rate.empty?
+      baud_rate = 115200
+      puts Rainbow("INFO:").aqua + " Using default baud rate of 115200."
+    else
+      baud_rate = baud_rate.to_i
+    end
+
+    data_bits = opts[:data_bits]
+    if data_bits.nil? || data_bits.empty?
+      data_bits = 8
+      puts Rainbow("INFO:").aqua + " Using default of 8 data bits."
+    else
+      data_bits = data_bits.to_i
+    end
+
+    stop_bits = opts[:stop_bits]
+    if stop_bits.nil? || stop_bits.empty?
+      stop_bits = 1
+      puts Rainbow("INFO:").aqua + " Using default of 1 stop bit."
+    else
+      stop_bits = stop_bits.to_i
+    end
+
+    line_end = [opts[:ending]].pack('H*')
+    if line_end.nil? || line_end.empty?
+      line_end = "\r\n"
+      puts Rainbow("INFO:").aqua + " Using default line ending of \"ODOA\" (\\r\\n)."
+    end
+
+    sp = SerialPort.new(device_path, baud_rate, data_bits, stop_bits, SerialPort::NONE)
+
+    if sp.nil?
+      puts Rainbow("ERROR:").red + " Couldn't initialize device at path " + device_path
+      exit(12)
+    end
+
+    puts Rainbow("CONNECT: ").green + " Connected to device at " + device_path
+  
+    while (line = sp.readline(line_end))
+      puts Rainbow(device_path + ": ").yellow + line.chomp!
+    end
+  end
+end

data/lib/sterm/version.rb

@@ -0,0 +1,20 @@
+# SerialTerm is a very simple command line tool that outputs data received from a serial device.
+# Copyright (C) 2019 Cian Guinee
+
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+module Sterm
+  VERSION = "0.1.0"
+end

data/sterm.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sterm/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sterm"
+  spec.version       = Sterm::VERSION
+  spec.authors       = ["Cian Guinee"]
+  spec.email         = ["cian.guinee@gmail.com"]
+  spec.licenses      = ["GPL-2.0"] # As required by the serialport dependency
+  spec.summary       = %q{Shows data transmitted from a UART device}
+  spec.homepage      = "https://github.com/guineec/serial-term"
+
+  # 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_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "serialport", "~> 1.3.1"
+  spec.add_dependency "rainbow", "~> 3.0.0"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: sterm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cian Guinee
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: serialport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: 
+email:
+- cian.guinee@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/sterm
+- lib/sterm.rb
+- lib/sterm/version.rb
+- sterm.gemspec
+homepage: https://github.com/guineec/serial-term
+licenses:
+- GPL-2.0
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Shows data transmitted from a UART device
+test_files: []