lxp-packet 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a06975e75dcaa0908d9f1e795d6a9106cf4cabe951b5907ce9b73802d1322999
-  data.tar.gz: 32919a40bd5f34819be74a7b5eeb51d5c6cdd322882d75b2f533f2cbc73c68a6
+  metadata.gz: b7aaa9f0df8afa2c5c3c3c5652f8dc437c86fd400b499b400b61220c60795c88
+  data.tar.gz: 73ec58f5d96b333555e6d6fd3e45c56c50e389bab58ab6e25b992276e9c6a4d3
 SHA512:
-  metadata.gz: 52d0753334fb109f1caddbf00ced45d9e2d372b8de76cc8358154d95a79931357d71cfad525a0f8ee578e89f15a95648d599948501f17f8ca3a7c137bca926b0
-  data.tar.gz: 75e3b687650069eb24fd0d875b27a0a831ef20157d885b5c12450cee60e7c6e1f038606109e2dd0338f9cd9d710ce1a6a6dd240a228364c0fee65dd81975d7e4
+  metadata.gz: 1874992682079715b761e8a68c8abc4c643c39b9398541934360e982eb91fb25e5f8e4cffbe504711edc38bd9b29cb42b89037ac7b5ea5c05dd792d790e235b0
+  data.tar.gz: ae61d070c93e133eac2a3240c649c13184b1da69fe5f0faaa45fa15d7180d4022d690c8e72587f496aa692983f726524e60b1601db0fc10a6bfafbd7167da7ad

data/CHANGELOG.md

@@ -1,12 +1,23 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [0.1.2] - 2020-01-15
+
+### Fixed
+
+- broken require 'utils' in 0.1.1
+
+## [0.1.1] - 2020-01-15
+
+### Changed
 
-- Nothing yet
+- move Utils module into LXP namespace
+- add Packet#tcp_function
+- add Heartbeat packet support
 
 ## [0.1.0] - 2020-01-05
 

data/lib/lxp/packet/base.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'tcp_functions'
 require_relative 'device_functions'
 
 class LXP
@@ -28,9 +29,7 @@ class LXP
         # length after first 6 bytes maybe?
         self.packet_length = 32
 
-        @header[6] = 1 # unsure
-
-        @header[7] = 194 # translated data, TBD
+        @header[6] = 1 # unsure, always seems to be 1
       end
 
       def bytes
@@ -82,6 +81,14 @@ class LXP
         @header[5] = (packet_length >> 8) & 0xff
       end
 
+      def tcp_function
+        @header[7]
+      end
+
+      def tcp_function=(tcp_function)
+        @header[7] = tcp_function & 0xff
+      end
+
       # Passed as a string
       def datalog_serial=(datalog_serial)
         @header[8, 10] = datalog_serial.bytes

data/lib/lxp/packet/heartbeat.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'device_functions'
+
+class LXP
+  class Packet
+    # This isn't really used for anything; we don't send heartbeats to
+    # the inverter, but we do receive them. So this is just instantiated
+    # if we receive one, so that Parser.parse has something to return.
+    #
+    # They are a very minimal packet of 19 bytes total:
+    #   6 of which is frame (161, 26, p1, p2, l1, l2)
+    #   13 bytes of header (1, 193, serial * 10, 0)
+    #
+    # They have no data and no checksum, so there's really not a lot here.
+    #
+    # Ideally these could be instantiated via .parse, but they only seem to
+    # have one byte for the length, and .parse expects two. There's nothing
+    # to parse anyway so never mind.
+    #
+    class Heartbeat < Base
+      def initialize
+        super
+
+        self.tcp_function = TcpFunctions::HEARTBEAT
+      end
+    end
+  end
+end

data/lib/lxp/packet/parser.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'utils'
-
 require_relative 'device_functions'
 require_relative 'tcp_functions'
 
@@ -23,7 +21,7 @@ class LXP
 
       def parse
         case bdata[7] # tcp_function
-        when TcpFunctions::HEARTBEAT then nil # ignored
+        when TcpFunctions::HEARTBEAT then Heartbeat.new
         when TcpFunctions::TRANSLATED_DATA then parse_translated_data
         else
           raise "unhandled tcp_function #{bdata[7]}"

data/lib/lxp/packet/read_hold.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative 'base'
-require_relative 'device_functions'
 
 class LXP
   class Packet
@@ -9,6 +8,7 @@ class LXP
       def initialize
         super
 
+        self.tcp_function = TcpFunctions::TRANSLATED_DATA
         self.device_function = DeviceFunctions::READ_HOLD
 
         self.data_length = 18

data/lib/lxp/packet/read_input1.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'utils'
 require_relative 'read_input'
 
 class LXP

data/lib/lxp/packet/read_input2.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'utils'
 require_relative 'read_input'
 
 class LXP

data/lib/lxp/packet/read_input3.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'utils'
 require_relative 'read_input'
 
 class LXP

data/lib/lxp/packet/write_single.rb

@@ -8,6 +8,7 @@ class LXP
       def initialize
         super
 
+        self.tcp_function = TcpFunctions::TRANSLATED_DATA
         self.device_function = DeviceFunctions::WRITE_SINGLE
         self.data_length = 18
       end

data/lib/lxp/packet.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
+require_relative 'utils'
+
 require_relative 'packet/registers'
 require_relative 'packet/register_bits'
 
 require_relative 'packet/parser'
 
+require_relative 'packet/heartbeat'
 require_relative 'packet/read_input1'
 require_relative 'packet/read_input2'
 require_relative 'packet/read_input3'

data/lib/lxp/utils.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class LXP
+  module Utils
+    module_function
+
+    def int(bytes, order = :lsb)
+      bytes = bytes.reverse if order == :msb
+
+      bytes.each_with_index.map do |b, idx|
+        b << (idx * 8)
+      end.inject(:|)
+    end
+
+    def int_complement(bytes, order = :lsb)
+      r = int(bytes, order)
+      r -= 0x10000 if r & 0x8000 == 0x8000
+      r
+    end
+  end
+end

data/lib/lxp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module LXP
-  VERSION = '0.1.0'
+class LXP
+  VERSION = '0.1.2'
 end

data/lxp-packet.gemspec

@@ -17,11 +17,7 @@ Gem::Specification.new do |s|
   s.metadata['homepage_uri'] = s.homepage
   s.metadata['source_code_uri'] = 'https://github.com/celsworth/lxp-packet'
 
-  s.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|s|features)/}) }
-  end
-  s.bindir        = 'exe'
-  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.files         = `git ls-files -z`.split("\x0")
   s.require_paths = ['lib']
 
   s.add_development_dependency 'bundler', '~> 2.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lxp-packet
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Chris Elsworth
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2020-01-05 00:00:00.000000000 Z
+date: 2020-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -41,6 +41,7 @@ files:
 - lib/lxp/packet.rb
 - lib/lxp/packet/base.rb
 - lib/lxp/packet/device_functions.rb
+- lib/lxp/packet/heartbeat.rb
 - lib/lxp/packet/parser.rb
 - lib/lxp/packet/read_hold.rb
 - lib/lxp/packet/read_input.rb
@@ -51,8 +52,8 @@ files:
 - lib/lxp/packet/registers.rb
 - lib/lxp/packet/tcp_functions.rb
 - lib/lxp/packet/write_single.rb
+- lib/lxp/utils.rb
 - lib/lxp/version.rb
-- lib/utils.rb
 - lxp-packet.gemspec
 homepage: https://github.com/celsworth/lxp-packet
 licenses:

data/lib/utils.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Utils
-  module_function
-
-  def int(bytes, order = :lsb)
-    bytes = bytes.reverse if order == :msb
-
-    bytes.each_with_index.map do |b, idx|
-      b << (idx * 8)
-    end.inject(:|)
-  end
-
-  def int_complement(bytes, order = :lsb)
-    r = int(bytes, order)
-    r -= 0x10000 if r & 0x8000 == 0x8000
-    r
-  end
-end