hamnet 0.0.1 → 0.0.3

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODNkZjQzN2NhODYyZWM2NWVhNzlmMmIwZDE5MjIxMDg5YWE0Mzk0Ng==
+  data.tar.gz: !binary |-
+    NWMyODJmMDFlOTc0Njk0YTQ5MGNjMzA4OWMyYzUzODE1YWY5ZWIzMQ==
+SHA512:
+  metadata.gz: !binary |-
+    YThmNDRiMzM2ZDk4ZmExODVmODA1MDA1OGE4NWQzZjg0NmVmOTk0OTNhOWY2
+    YzA2ZTA4N2UzNDlhNjY4NTZmMDllZGEyNzE0NzFkYzQ0MDBhMWQxOTA3Yzg3
+    NmE3Y2E0ODFmYmE2NzNlNjYwZGVhZWUzZmJlYWNkYjkwYTkzNzc=
+  data.tar.gz: !binary |-
+    ZTg0OTAxNjgwNjcxODYwZjhkNjRmNjJjNGI5MTNiZTgzYWM0YzhiYWFmMGYw
+    Nzg5ODExZDJhMzkxMDNmNDAyMGQ5YWViMjYwZmNkYjhjOGFhNzI2NzBkOGU5
+    YjZkNWJiYmU0NmJmMzJlZTc5NjY4MWU2ODcxNTAyZTNmYTc5M2Q=

data/lib/hamnet.rb

@@ -4,19 +4,24 @@
 # Jeff Francis, N0GQ, jeff@gritch.org
 # http://fldigi.gritch.org
 
+# ToDo:
+#
+# Escape <<< >>> from data field.
+
 require 'zlib'
 require 'base64'
 require 'time'
 require 'thread'
 
-FRAME_SIMPLE=0
-FRAME_BASE64=1
-FRAME_COMPRESSED_BASE64=2
+HAMNET_FRAME_ACK=0
+HAMNET_FRAME_SIMPLE=1
+HAMNET_FRAME_BASE64=2
+HAMNET_FRAME_COMPRESSED_BASE64=3
 # To do.
-FRAME_PING=3
-FRAME_PING_REPLY=4
-FRAME_TELEMETRY=5
-FRAME_POSITION=6
+HAMNET_FRAME_PING=4
+HAMNET_FRAME_PING_REPLY=5
+HAMNET_FRAME_TELEMETRY=6
+HAMNET_FRAME_POSITION=7
 
 # This defines a basic frame of data for use with fldigi.  The frame
 # consists of:
@@ -24,27 +29,32 @@ FRAME_POSITION=6
 # Header field.  Three bytes, consisting of "<<<"
 # From field.  Eight bytes (allowing for "WA0AAA-0")
 # To field.  Eight bytes (allowing for "WB0BBB-0")
-# Type field.  One byte (numeric) specifying encoding, compression.
+# Sequence field. Two bytes (two hex digits) specifying sequence number.
+# Type field.  Two bytes (two hex digits) specifying encoding, compression.
 # Data field.  Arbitrary number of bytes of payload.
 # CRC field.  Last eight bytes, CRC32 checksum of From, To, Type, Data fields.
 # Trailer field.  Three bytes, consisting of ">>>"
 class Frame
-  attr_accessor :from, :to, :type, :valid
+  attr_accessor :from, :to, :type, :sequence, :valid, :frompad, :topad
 
-  def initialize(from, to, type)
+  def initialize(from, to, type, sequence)
     @from=from.downcase
     @to=to.downcase
     @type=type
+    @sequence=sequence
     @wiredata=nil
     @userdata=nil
     @crc=nil
     @valid=nil
 
-    while @from.length<8
-      @from=@from+":"
+    @frompad=@from
+    while @frompad.length<8
+      @frompad=@frompad+":"
     end
-    while @to.length<8
-      @to=@to+":"
+
+    @topad=@to
+    while @topad.length<8
+      @topad=@topad+":"
     end
   end
 
@@ -58,24 +68,33 @@ end
 # (to), the type of frame (see constants above), and the actual data
 # to be transmitted.
 class TxFrame < Frame
-  attr_accessor :from, :to, :type, :userdata, :wiredata
+  attr_accessor :from, :to, :type, :sequence, :userdata, :wiredata
 
-  def initialize(from, to, type, userdata)
+  def initialize(from, to, type, sequence, userdata)
     # Create the object.
-    super(from, to, type)
+    super(from, to, type, sequence)
     @userdata=userdata
 
     # Do the needful with the payload.
     case @type
-    when FRAME_SIMPLE
-      message=@from+@to+@type.to_s+@userdata
+    when HAMNET_FRAME_SIMPLE
+      message=@frompad+@topad+sprintf("%02x",@type).upcase+sprintf("%02x",@sequence).upcase+@userdata
       @crc=Zlib::crc32(message).to_s(16).downcase
-    when FRAME_BASE64
-      message=@from+@to+@type.to_s+Base64::strict_encode64(@userdata)
+      while @crc.length<8
+        @crc="0"+@crc
+      end
+    when HAMNET_FRAME_BASE64
+      message=@frompad+@topad+sprintf("%02x",@type).upcase+sprintf("%02x",@sequence).upcase+Base64::strict_encode64(@userdata)
       @crc=Zlib::crc32(message).to_s(16).downcase
-    when FRAME_COMPRESSED_BASE64
-      message=@from+@to+@type.to_s+Base64::strict_encode64(Zlib::Deflate.deflate(@userdata,Zlib::BEST_COMPRESSION))
+      while @crc.length<8
+        @crc="0"+@crc
+      end
+    when HAMNET_FRAME_COMPRESSED_BASE64
+      message=@frompad+@topad+sprintf("%02x",@type).upcase+sprintf("%02x",@sequence).upcase+Base64::strict_encode64(Zlib::Deflate.deflate(@userdata,Zlib::BEST_COMPRESSION))
       @crc=Zlib::crc32(message).to_s(16).downcase
+      while @crc.length<8
+        @crc="0"+@crc
+      end
     else
       return false
     end
@@ -90,7 +109,7 @@ end
 # frame (delimited with "<<<" and ">>>", and it validates the frame,
 # then creates and populates an object with the fields of that frame.
 class RxFrame < Frame
-  attr_accessor :from, :to, :type, :userdata, :wiredata
+  attr_accessor :from, :to, :type, :sequence, :userdata, :wiredata
 
   def initialize(wiredata)
     # First, make sure it's properly delimited.
@@ -109,21 +128,24 @@ class RxFrame < Frame
       to=tmp[0,8].gsub(":","")
       tmp=tmp[8,tmp.length-8]
       # Extract the frame type.
-      type=tmp[0,1].to_i
-      tmp=tmp[1,tmp.length-1]
+      type=tmp[0,2].to_i(16)
+      tmp=tmp[2,tmp.length-2]
+      # Extract the sequence number.
+      sequence=tmp[0,2].to_i(16)
+      tmp=tmp[2,tmp.length-2]
       # Create and populate the object.
-      super(from, to, type)
+      super(from, to, type, sequence)
       @wiredata=wiredata
       # Decode the payload.
       case @type
-      when FRAME_SIMPLE
+      when HAMNET_FRAME_SIMPLE
         @userdata=tmp
-      when FRAME_BASE64
+      when HAMNET_FRAME_BASE64
         @userdata=Base64::strict_decode64(tmp)
-      when FRAME_COMPRESSED_BASE64
+      when HAMNET_FRAME_COMPRESSED_BASE64
         @userdata=Zlib::Inflate.inflate(Base64::strict_decode64(tmp))
       end
-      # Calculate the check the CRC.
+      # Calculate and check the CRC.
       @crc=Zlib::crc32(crcstring).to_s(16).downcase
       if crc==@crc
         @valid=true

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hamnet
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - Jeff Francis, N0GQ
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-15 00:00:00.000000000 Z
+date: 2015-01-05 00:00:00.000000000 Z
 dependencies: []
 description: A library for constructing fldigi network packets.
 email: jeff@gritch.org
@@ -21,26 +20,25 @@ files:
 homepage: http://fldigi.gritch.org/
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.4.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A library for constructing fldigi network packets.
 test_files: []