mruby-serialport-uart 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8acf7450ce5e36ab1afd64bd9a7a56e62666bdd5737cb70bca5125ef4ea13439
+  data.tar.gz: b2fc87101262329fa83b8df0791a9e2ec119b3a4e3339352232b9dd47c317647
+SHA512:
+  metadata.gz: a851cbbb52bace4822139aa72af3f0dfc3bc26548daf4fa9a2afee1ce51a684b959605d2eec5b76d32860c0ad1300d2d43cd402553807fd638464c4082df75c1
+  data.tar.gz: 25f1955388f8915b6bc0b800a55fba116cc8b7ff498c9d6b8da7fbb84ad1a7b1a15181e9d71d8c984a8b83953f50d403fd0c387ccb6ec3429ad38c76dc27b9fa

data/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, Shimane IT Open-Innovation Center.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,45 @@
+# UART class using serialport gem.
+
+## Overview
+
+This is an implementation of the UART class library.  
+Follows [mruby, mruby/c common I/O API guidelines.](https://github.com/mruby/microcontroller-peripheral-interface-guide)
+
+This is a wrapper for the [serialport gem](https://rubygems.org/gems/serialport).
+
+## Installation
+
+    $ gem install mruby-serialport-uart
+
+
+## Features
+
+  * Read and write by serialport.
+  * Communication parameters can be changed at any time.
+  * It has linewise methods and binary methods.
+
+
+## Usage
+
+about RaspberryPi...
+
+```
+# echo server
+require "mruby/uart"   # or "mruby/uart/serialport"
+
+uart = UART.new("/dev/serial0")
+while true
+  s = uart.read(1)
+  uart.write s
+  print s
+end
+```
+
+Other case, see original guidelines.
+
+https://github.com/mruby/microcontroller-peripheral-interface-guide/blob/main/mruby_io_UART_en.md
+
+
+## Licence
+
+BSD 3-Clause License. see LICENSE file.

data/lib/mruby/uart/serialport/uart_serialport.rb

@@ -0,0 +1,264 @@
+#
+# UART class using serialport gem.
+#
+# Copyright (c) 2023 Shimane IT Open-Innovation Center.
+#
+# see: LICENSE file.
+# see: https://github.com/mruby/microcontroller-peripheral-interface-guide/blob/main/mruby_io_UART_en.md
+#
+# frozen_string_literal: true
+#
+
+require "serialport"
+
+
+##
+# UART namespace
+#
+module UART
+  # Constants
+  NONE = 0
+  ODD = 1
+  EVEN = 2
+  RTSCTS = 4
+
+  ##
+  # constructor
+  #
+  #@see UART::GemSerialport.initialize
+  #
+  def self.new( node=nil, baudrate:9600, baud:nil, data_bits:8, stop_bits:1,
+                parity:NONE, flow_control:NONE, unit:nil )
+    UART::GemSerialport.new( node, baudrate, baud, data_bits, stop_bits,
+                             parity, flow_control, unit )
+  end
+end
+
+
+##
+# gem serialport wrapper class
+# https://rubygems.org/gems/serialport
+#
+class UART::GemSerialport
+
+  ##
+  # constructor
+  #
+  #@param [String] node         device node.
+  #@param [Integer] baudrate    baudrate
+  #@param [Integer] baud        baudrate
+  #@param [Integer] data_bits   data bits
+  #@param [Integer] stop_bits   stop bits
+  #@param [Constant] parity      parity bit (UART::NONE, ODD, EVEN)
+  #@param [Constant] flow_control flow control (UART::NONE, RTSCTS)
+  #@param [String] unit         device node.
+  #@see UART.new
+  #
+  def initialize( node, baudrate, baud, data_bits,
+                  stop_bits, parity, flow_control, unit )
+    @device = SerialPort.new(node||unit)
+    @readbuf = "".b
+
+    setmode( baudrate:baudrate, baud:baud, data_bits:data_bits,
+             stop_bits:stop_bits, parity:parity, flow_control:flow_control )
+  end
+
+
+  ##
+  # Changes the mode (parameters) of UART.
+  #
+  #@param [Integer] baudrate    baudrate
+  #@param [Integer] baud        baudrate
+  #@param [Integer] data_bits   data bits
+  #@param [Integer] stop_bits   stop bits
+  #@param [Constant] parity      parity bit (UART::NONE, ODD, EVEN)
+  #@param [Constant] flow_control flow control (UART::NONE, RTSCTS)
+  #@return [void]
+  #
+  def setmode( baudrate:nil, baud:nil, data_bits:nil, stop_bits:nil,
+               parity:nil, flow_control:nil )
+    if baud || baudrate
+      @device.baud = baud || baudrate
+    end
+
+    if data_bits
+      @device.data_bits = data_bits
+    end
+
+    if stop_bits
+      @device.stop_bits = stop_bits
+    end
+
+    case parity
+    when UART::NONE
+      @device.parity = SerialPort::NONE
+    when UART::ODD
+      @device.parity = SerialPort::ODD
+    when UART::EVEN
+      @device.parity = SerialPort::EVEN
+    when nil
+      # nothing to do
+    else
+      raise ArgumentError
+    end
+
+    case flow_control
+    when UART::NONE
+      @device.flow_control = SerialPort::NONE
+    when UART::RTSCTS
+      @device.flow_control = SerialPort::HARD
+    when nil
+      # nothing to do
+    else
+      raise ArgumentError
+    end
+  end
+
+
+  ##
+  # Reads data of the specified number of bytes, read_bytes.
+  #
+  #@param [Integer] read_bytes  read bytes.
+  #@return [String]     reading datas.
+  #
+  def read( read_bytes )
+    while bytes_available() < read_bytes
+      sleep 0.1
+    end
+
+    return @readbuf.slice!(0, read_bytes)
+  end
+
+
+  ##
+  # Sends data.
+  #
+  #@param [String]  string      data to send.
+  #@return [Integer]  the number of bytes sent.
+  #
+  def write( string )
+    @device.write( string )
+  end
+
+
+  ##
+  # Reads a line of string.
+  #
+  #@return [String]  reading data.
+  #
+  def gets()
+    while true
+      _fill_readbuf()
+      pos = @readbuf.index("\n")
+      break if pos
+      sleep 0.1
+    end
+
+    return @readbuf.slice!(0, pos+1)
+  end
+
+
+  ##
+  # Sends one line and sends a newline code at the end of the argument string.
+  # The newline code is LF only by this version.
+  #
+  #@param [String] string       string to send.
+  #
+  def puts( string )
+    @device.write( string )
+    if string[-1] != "\n"
+      @device.write( "\n" )
+    end
+
+    return nil
+  end
+
+
+  ##
+  # Returns the number of readable bytes in the read buffer.
+  #
+  #@return [Integer]  num of readable bytes.
+  #
+  def bytes_available()
+    _fill_readbuf()
+
+    return @readbuf.size
+  end
+
+
+  ##
+  # Returns the number of bytes of data in the transmission buffer that have not been actually sent.
+  #
+  #@return [Integer]   num of bytes.
+  #
+  def bytes_to_write()
+    return 0
+  end
+
+
+  ##
+  # Returns true if reading a line of data is possible.
+  #
+  #@return [Bool]  true if a line of data can be read
+  #
+  def can_read_line()
+    _fill_readbuf()
+
+    return @readbuf.include?("\n")
+  end
+
+
+  ##
+  # Block until transmission of data accumulated in the transmission buffer is completed.
+  #
+  #@return [void]
+  #
+  def flush()
+    @device.flush()
+  end
+
+
+  ##
+  # Clears the receive buffer.
+  #
+  #@return [void]
+  #
+  def clear_rx_buffer()
+    @readbuf.clear
+  end
+
+  ##
+  # Clears the transmission buffer.
+  #
+  #@return [void]
+  #
+  def clear_tx_buffer()
+    # nothing to do.
+  end
+
+
+  ##
+  # Sends a break signal.
+  # The time is optional and specified in seconds.
+  #
+  #@param [Integer,Float] time
+  #@return [void]
+  #
+  def send_break( time = 0 )
+    t = (time * 10).to_i
+    t = [t, 1].max
+
+    @device.break( t )
+  end
+
+
+  private
+  def _fill_readbuf()
+    while true
+      s = @device.read_nonblock( 1024 ) rescue nil
+      break if !s
+      @readbuf << s
+    end
+  end
+
+end

data/lib/mruby/uart/serialport/version.rb

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

data/lib/mruby/uart/serialport.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "serialport/version"
+require_relative "serialport/uart_serialport"

data/lib/mruby/uart.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "uart/serialport"

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: mruby-serialport-uart
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- HirohitoHigashi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: serialport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- higashi@s-itoc.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/mruby/uart.rb
+- lib/mruby/uart/serialport.rb
+- lib/mruby/uart/serialport/uart_serialport.rb
+- lib/mruby/uart/serialport/version.rb
+homepage: https://github.com/HirohitoHigashi/mruby-mio/tree/main/mruby-serialport-uart
+licenses:
+- BSD 3-CLAUSE
+metadata:
+  homepage_uri: https://github.com/HirohitoHigashi/mruby-mio/tree/main/mruby-serialport-uart
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.13
+signing_key:
+specification_version: 4
+summary: UART class library using serialport gem. compliant with mruby, mruby/c common
+  I/O API guidelines.
+test_files: []