lxp-packet 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64f2d92693be97e362ae4d3485fa4772bc813a9271d0fd6aa90d60dad103fe31
-  data.tar.gz: c55207ae772cbe564f7891d634547209d8e022e545711dbe5813138cd53de722
+  metadata.gz: f690a3ff0e519ed9f0c68152117bfcd4ece48d2ffd67c32b83cd1b2bafc356b5
+  data.tar.gz: 4f35b9e46c92659e7bd5c366e3cc6bcbe9c4646e17278b6a8df3f7c3edb220a5
 SHA512:
-  metadata.gz: 9ae5ae4c8df6d890bf75ec7280c598d2fb29c48977b7ffb256163b105566f73796b915c631388dea19c7b59aad2305720f7e0db7173bf0373d9bef0299d1b92f
-  data.tar.gz: d9290a541c2489825f76a259b467779dfc5b20f44b156a1f645d98b3515e3ab6ff1764ba99e3aa8733af07db0cae3f68f4d31b7f56da48cc32cfabee349a5c89
+  metadata.gz: d19df5ab0f0cbe0568c4f7277a1ea84c071f30a3c882cabc16464b0a6a1b2850d27deeb191e74920d5f6da7fb052fde8b89768a535117a369c1724b75cfc4ef4
+  data.tar.gz: 418b00400f1c147d45dccb5f0d74660baccd9a5a5d88fb81cd0e25c86115550f1609f1482d9ea8fca9f4f9ec56d86b6bd5654138d7d2561d8a9595dc0fb4f466

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Metrics/LineLength:
+  Enabled: no

data/CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.4.0] - 2020-04-07
+
+### Added
+
+- parsing of ReadHold packets with multiple registers/values
+- beginnings of a test suite!
+
+
 ## [0.3.0] - 2020-04-02
 
 ### Fixed

data/README.md

@@ -96,6 +96,22 @@ r = read_reply(sock, pkt)
 puts "Received: #{r.value}" # should be discharge cut-off value
 ```
 
+Usually, `ReadHold` instances contain the details of just one register. However, it is possible they can contain multiple. Pressing "Read" on the LuxPower Web Portal provokes the inverter into sending out 5 packets that each contain multiple registers, for example. [TODO: work out how to request these packets ourselves]
+
+To access these, you can use subscript notation to get a register directly, or call `#to_h` to get a hash of registers/values. For convenience this also works with single register packets, though obviously only one subscript will ever return data, and `to_h` will only have one key.
+
+```ruby
+# assuming pkt is a parsed packet with multiple registers/values:
+pkt[0] # => 35462 # value of register 0
+pkt.to_h # { 0 => 35462, 1 => 1, ... }
+
+# assuming pkt is a parsed packet with only register 21:
+pkt[21] # => value of register 21
+pkt[22] # => nil
+pkt.to_h # { 21 => 62292 }
+```
+
+
 ### Writing
 
 Updating a value on the inverter.
@@ -119,7 +135,7 @@ r = read_reply(sock, pkt)
 puts "Received: #{r.value}" # should be new discharge cut-off value, 20
 ```
 
-### Updating a multi-byte register
+### Updating a bitwise register
 
 The Lux has two registers that contain multiple settings. In `doc/LXP_REGISTERS.txt` you can see them at 21 and 110. They have two bytes.
 
@@ -127,7 +143,7 @@ This library combines them into a 16bit word, so that the constants in `LXP::Pac
 
 First you need to read the previous value, update it with a new bit, then write it back. This is really just a combination of the two above examples.
 
-This enables AC charge. You need to OR the bit with the previous value so as not to change other settings tored in register 21.
+This example enables AC charge. You need to OR the bit with the previous value so as not to change other settings stored in register 21.
 
 It could be improved not to bother doing the write if it was already enabled.
 

data/doc/LXP_REGISTERS.txt

@@ -9,9 +9,10 @@ Registers 21 and 110 are bitmasks; normally you fetch the previous
 settings, apply your changes, and set the new value back.
 
 0 MODEL
-2 SERIAL_NUM
-7 FW_CODE
-12 TIME
+2-8 SERIAL_NUM
+7 FW_CODE ?
+9-10 ?
+12-14 TIME
 15 COM_ADDR
 16 LANGUAGE
 20 PV_INPUT_MODE

data/lib/lxp/packet/base.rb

@@ -26,7 +26,6 @@ class LXP
 
         self.protocol = 1
 
-        # length after first 6 bytes maybe?
         self.packet_length = 32
 
         @header[6] = 1 # unsure, always seems to be 1
@@ -89,6 +88,10 @@ class LXP
         @header[7] = tcp_function & 0xff
       end
 
+      def datalog_serial
+        @header[8, 10].pack('C*')
+      end
+
       # Passed as a string
       def datalog_serial=(datalog_serial)
         @header[8, 10] = datalog_serial.bytes
@@ -111,6 +114,10 @@ class LXP
         @data[1] = device_function
       end
 
+      def inverter_serial
+        @data[2, 10].pack('C*')
+      end
+
       # Passed as a string
       def inverter_serial=(inverter_serial)
         @data[2, 10] = inverter_serial.bytes
@@ -125,12 +132,6 @@ class LXP
         @data[13] = (register >> 8) & 0xff
       end
 
-      def value_length_byte?
-        @value_length_byte ||=
-          protocol == 2 &&
-          device_function != DeviceFunctions::WRITE_SINGLE
-      end
-
       def value_length
         if value_length_byte?
           @data[14]
@@ -142,13 +143,11 @@ class LXP
       # protocol 1 has value at 14 and 15
       # protocol 2 has length at 14, then that many bytes of values
       #
-      # So this can return an int or an array.
-      #
-      def value
+      def values
         if value_length_byte?
           @data[15, value_length]
         else
-          @data[14] | @data[15] << 8
+          @data[14, 2] # | @data[15] << 8
         end
       end
 
@@ -171,6 +170,12 @@ class LXP
 
       private
 
+      def value_length_byte?
+        @value_length_byte ||=
+          protocol == 2 &&
+          device_function != DeviceFunctions::WRITE_SINGLE
+      end
+
       def crc16_modbus(arr)
         arr.length.times.inject(0xffff) do |r, n|
           r ^= arr[n]

data/lib/lxp/packet/heartbeat.rb

@@ -15,10 +15,6 @@ class LXP
     #
     # 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

data/lib/lxp/packet/read_hold.rb

@@ -18,18 +18,36 @@ class LXP
         self.value = 1
       end
 
-      # ReadHold packets should always (I think) have two byte values.
+      # Return the first value in a ReadHold packet. This is normally used
+      # when the packet only has one value.
       #
-      # Raise if not, as that is not expected?
+      # #values returns an Array. This converts it to an int.
       #
-      # Base#value will return an int for protocol 1, or an Array
-      # for protocol 2. If we can, convert that Array to an int.
+      def value(offset = 0)
+        Utils.int(values[offset, 2])
+      end
+
+      # Subscript notation is used when the ReadHold packet has multiple
+      # registers in it. This is indicated by value_length > 2.
       #
-      def value
-        raise 'value_length not 2?' unless value_length == 2
+      # In this case, #register tells us the first register in the values, then
+      # each 2 bytes are subsequent registers.
+      #
+      def [](reg_num)
+        offset = (reg_num - register) * 2
+
+        return if offset.negative? || offset > data_length
+
+        value(offset)
+      end
+
+      # Return a Hash of all register->values in the ReadHold packet.
+      def to_h
+        r = register
 
-        r = super
-        r.is_a?(Array) ? Utils.int(r, 2) : r
+        values.each_slice(2).each_with_index.map do |v, idx|
+          [r + idx, Utils.int(v)]
+        end.to_h
       end
     end
   end

data/lib/lxp/packet/write_single.rb

@@ -27,14 +27,10 @@ class LXP
       #
       # Raise if not, as that is not expected?
       #
-      # Base#value will return an int for protocol 1, or an Array
-      # for protocol 2. If we can, convert that Array to an int.
-      #
       def value
         raise 'value_length not 2?' unless value_length == 2
 
-        r = super
-        r.is_a?(Array) ? Utils.int(r, 2) : r
+        Utils.int(values[0, 2])
       end
     end
   end

data/lib/lxp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class LXP
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lxp-packet.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_development_dependency 'bundler', '~> 2.0'
+  s.add_development_dependency 'rspec'
 end

data/spec/parser_spec.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+RSpec.describe LXP::Packet::Parser do
+  let(:parser) { LXP::Packet::Parser.new(input.pack('C*')) }
+  let(:packet) { parser.parse }
+
+  subject { packet }
+
+  context 'ReadHold multi data (registers 0-22)' do
+    let(:input) { [161, 26, 2, 0, 77, 0, 1, 194, 99, 99, 99, 99, 99, 99, 99, 99, 99, 99, 63, 0, 1, 3, 88, 88, 88, 88, 88, 88, 88, 88, 88, 88, 0, 0, 46, 134, 138, 1, 0, 88, 88, 88, 88, 88, 88, 88, 88, 88, 88, 66, 65, 65, 65, 1, 10, 10, 1, 0, 0, 20, 4, 7, 16, 14, 49, 1, 0, 1, 0, 0, 0, 0, 0, 4, 0, 0, 0, 84, 243, 176, 4, 40, 224] }
+
+    it { is_expected.to be_a LXP::Packet::ReadHold }
+
+    it 'has the correct attributes' do
+      expect(packet).to have_attributes register: 0,
+                                        values: [134, 138, 1, 0, 88, 88, 88, 88, 88, 88, 88, 88, 88, 88, 66, 65, 65, 65, 1, 10, 10, 1, 0, 0, 20, 4, 7, 16, 14, 49, 1, 0, 1, 0, 0, 0, 0, 0, 4, 0, 0, 0, 84, 243, 176, 4],
+                                        to_h: { 0 => 35_462, 1 => 1, 2 => 22_616, 3 => 22_616, 4 => 22_616, 5 => 22_616, 6 => 22_616, 7 => 16_706, 8 => 16_705, 9 => 2561, 10 => 266, 11 => 0, 12 => 1044, 13 => 4103, 14 => 12_558, 15 => 1, 16 => 1, 17 => 0, 18 => 0, 19 => 4, 20 => 0, 21 => 62_292, 22 => 1200 },
+                                        protocol: 2,
+                                        packet_length: 77, data_length: 63,
+                                        tcp_function: LXP::Packet::TcpFunctions::TRANSLATED_DATA,
+                                        device_function: LXP::Packet::DeviceFunctions::READ_HOLD,
+                                        inverter_serial: 'XXXXXXXXXX',
+                                        datalog_serial: 'cccccccccc',
+                                        bytes: input
+      expect(packet[22]).to eq 1200
+
+      # test out of bounds subscripts return nil
+      expect(packet[23]).to be_nil
+    end
+  end
+
+  context 'ReadHold multi data (registers 80-113)' do
+    let(:input) { [161, 26, 2, 0, 99, 0, 1, 194, 99, 99, 99, 99, 99, 99, 99, 99, 99, 99, 85, 0, 1, 3, 88, 88, 88, 88, 88, 88, 88, 88, 88, 88, 80, 0, 68, 0, 0, 0, 0, 100, 0, 20, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 230, 0, 50, 0, 111, 9, 252, 8, 20, 0, 5, 0, 0, 0, 0, 0, 0, 0, 48, 2, 144, 1, 66, 0, 66, 0, 0, 0, 0, 0, 10, 0, 56, 255, 38, 2, 0, 0, 144, 1, 2, 0, 0, 0, 0, 0, 0, 0, 193, 242] }
+
+    it { is_expected.to be_a LXP::Packet::ReadHold }
+
+    it 'has the correct attributes' do
+      expect(packet).to have_attributes register: 80,
+                                        values: [0, 0, 0, 0, 100, 0, 20, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 230, 0, 50, 0, 111, 9, 252, 8, 20, 0, 5, 0, 0, 0, 0, 0, 0, 0, 48, 2, 144, 1, 66, 0, 66, 0, 0, 0, 0, 0, 10, 0, 56, 255, 38, 2, 0, 0, 144, 1, 2, 0, 0, 0, 0, 0, 0, 0],
+                                        to_h: { 80 => 0, 81 => 0, 82 => 100, 83 => 20, 84 => 0, 85 => 0, 86 => 0, 87 => 0, 88 => 0, 89 => 0, 90 => 230, 91 => 50, 92 => 2415, 93 => 2300, 94 => 20, 95 => 5, 96 => 0, 97 => 0, 98 => 0, 99 => 560, 100 => 400, 101 => 66, 102 => 66, 103 => 0, 104 => 0, 105 => 10, 106 => 65_336, 107 => 550, 108 => 0, 109 => 400, 110 => 2, 111 => 0, 112 => 0, 113 => 0 },
+                                        protocol: 2,
+                                        packet_length: 99, data_length: 85,
+                                        tcp_function: LXP::Packet::TcpFunctions::TRANSLATED_DATA,
+                                        device_function: LXP::Packet::DeviceFunctions::READ_HOLD,
+                                        inverter_serial: 'XXXXXXXXXX',
+                                        datalog_serial: 'cccccccccc',
+                                        bytes: input
+      expect(packet[80]).to eq 0
+      expect(packet[94]).to eq 20
+      expect(packet[113]).to eq 0
+
+      # test out of bounds subscripts return nil
+      expect(packet[114]).to be_nil
+      expect(packet[79]).to be_nil
+    end
+  end
+
+  context 'ReadInput1 data' do
+    let(:input) { [161, 26, 2, 0, 111, 0, 1, 194, 99, 99, 99, 99, 99, 99, 99, 99, 99, 99, 97, 0, 1, 4, 88, 88, 88, 88, 88, 88, 88, 88, 88, 88, 0, 0, 80, 16, 0, 0, 0, 0, 0, 0, 0, 241, 1, 95, 0, 0, 47, 0, 0, 0, 0, 0, 0, 0, 0, 121, 2, 172, 9, 1, 0, 0, 0, 146, 19, 57, 2, 0, 0, 227, 0, 232, 3, 172, 9, 0, 11, 80, 112, 146, 19, 0, 0, 0, 0, 0, 0, 0, 0, 221, 0, 0, 0, 0, 0, 42, 0, 73, 0, 86, 0, 52, 0, 0, 0, 36, 0, 2, 0, 172, 14, 181, 11, 127, 131] }
+
+    it { is_expected.to be_a LXP::Packet::ReadInput1 }
+
+    it 'has the correct attributes' do
+      expect(packet).to have_attributes register: 0,
+                                        values: [16, 0, 0, 0, 0, 0, 0, 0, 241, 1, 95, 0, 0, 47, 0, 0, 0, 0, 0, 0, 0, 0, 121, 2, 172, 9, 1, 0, 0, 0, 146, 19, 57, 2, 0, 0, 227, 0, 232, 3, 172, 9, 0, 11, 80, 112, 146, 19, 0, 0, 0, 0, 0, 0, 0, 0, 221, 0, 0, 0, 0, 0, 42, 0, 73, 0, 86, 0, 52, 0, 0, 0, 36, 0, 2, 0, 172, 14, 181, 11],
+                                        protocol: 2,
+                                        packet_length: 111, data_length: 97,
+                                        tcp_function: LXP::Packet::TcpFunctions::TRANSLATED_DATA,
+                                        device_function: LXP::Packet::DeviceFunctions::READ_INPUT,
+                                        inverter_serial: 'XXXXXXXXXX',
+                                        datalog_serial: 'cccccccccc',
+                                        bytes: input
+    end
+
+    describe '#to_h' do
+      subject { packet.to_h }
+      it { is_expected.to eq status: 16, v_bat: 49.7, soc: 95, p_pv: 0, p_charge: 0, p_discharge: 633, v_acr: 247.6, f_ac: 50.1, p_inv: 569, p_rec: 0, v_eps: 247.6, f_eps: 50.1, p_to_grid: 0, p_to_user: 0, e_pv_day: 22.1, e_inv_day: 4.2, e_rec_day: 7.3, e_chg_day: 8.6, e_dischg_day: 5.2, e_eps_day: 0.0, e_to_grid_day: 3.6, e_to_user_day: 0.2, v_bus_1: 375.6, v_bus_2: 299.7 }
+    end
+  end
+end

data/spec/read_hold_spec.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+RSpec.describe LXP::Packet::ReadHold do
+  let(:packet) { LXP::Packet::ReadHold.new }
+
+  before do
+    packet.inverter_serial = '1234567890'
+    packet.datalog_serial = '0987654321'
+    packet.register = 21
+  end
+
+  it 'has the correct attributes' do
+    expect(packet).to have_attributes register: 21, values: [1, 0], value: 1,
+                                      to_h: { 21 => 1 },
+                                      protocol: 1,
+                                      packet_length: 32, data_length: 18,
+                                      tcp_function: LXP::Packet::TcpFunctions::TRANSLATED_DATA,
+                                      device_function: LXP::Packet::DeviceFunctions::READ_HOLD,
+                                      inverter_serial: '1234567890',
+                                      datalog_serial: '0987654321',
+                                      bytes: [161, 26, 1, 0, 32, 0, 1, 194, 48, 57, 56, 55, 54, 53, 52, 51, 50, 49, 18, 0, 0, 3, 49, 50, 51, 52, 53, 54, 55, 56, 57, 48, 21, 0, 1, 0, 241, 72]
+    expect(packet[21]).to eq 1
+  end
+
+  it 'creates the correct binary' do
+    expect(packet.to_bin).to eq [161, 26, 1, 0, 32, 0, 1, 194, 48, 57, 56, 55, 54, 53, 52, 51, 50, 49, 18, 0, 0, 3, 49, 50, 51, 52, 53, 54, 55, 56, 57, 48, 21, 0, 1, 0, 241, 72].pack('C*')
+  end
+
+  it 'works with protocol 2' do
+    packet.protocol = 2
+    expect(packet).to have_attributes protocol: 2,
+                                      bytes: [161, 26, 2, 0, 32, 0, 1, 194, 48, 57, 56, 55, 54, 53, 52, 51, 50, 49, 18, 0, 0, 3, 49, 50, 51, 52, 53, 54, 55, 56, 57, 48, 21, 0, 1, 0, 241, 72]
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'lxp/packet'

data/spec/write_single_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+RSpec.describe LXP::Packet::WriteSingle do
+  let(:packet) { LXP::Packet::WriteSingle.new }
+
+  before do
+    packet.inverter_serial = '1234567890'
+    packet.datalog_serial = '0987654321'
+    packet.register = 21
+    packet.value = 8000
+  end
+
+  it 'has the correct attributes' do
+    expect(packet).to have_attributes register: 21, values: [64, 31], value: 8000,
+                                      protocol: 1,
+                                      packet_length: 32, data_length: 18,
+                                      tcp_function: LXP::Packet::TcpFunctions::TRANSLATED_DATA,
+                                      device_function: LXP::Packet::DeviceFunctions::WRITE_SINGLE,
+                                      inverter_serial: '1234567890',
+                                      datalog_serial: '0987654321',
+                                      bytes: [161, 26, 1, 0, 32, 0, 1, 194, 48, 57, 56, 55, 54, 53, 52, 51, 50, 49, 18, 0, 0, 6, 49, 50, 51, 52, 53, 54, 55, 56, 57, 48, 21, 0, 64, 31, 69, 211]
+  end
+
+  it 'creates the correct binary' do
+    expect(packet.to_bin).to eq [161, 26, 1, 0, 32, 0, 1, 194, 48, 57, 56, 55, 54, 53, 52, 51, 50, 49, 18, 0, 0, 6, 49, 50, 51, 52, 53, 54, 55, 56, 57, 48, 21, 0, 64, 31, 69, 211].pack('C*')
+  end
+
+  it 'works with protocol 2' do
+    packet.protocol = 2
+    expect(packet).to have_attributes protocol: 2,
+                                      bytes: [161, 26, 2, 0, 32, 0, 1, 194, 48, 57, 56, 55, 54, 53, 52, 51, 50, 49, 18, 0, 0, 6, 49, 50, 51, 52, 53, 54, 55, 56, 57, 48, 21, 0, 64, 31, 69, 211]
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lxp-packet
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Chris Elsworth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-02 00:00:00.000000000 Z
+date: 2020-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - chris@cae.me.uk
@@ -32,6 +46,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -55,6 +71,10 @@ files:
 - lib/lxp/utils.rb
 - lib/lxp/version.rb
 - lxp-packet.gemspec
+- spec/parser_spec.rb
+- spec/read_hold_spec.rb
+- spec/spec_helper.rb
+- spec/write_single_spec.rb
 homepage: https://github.com/celsworth/lxp-packet
 licenses:
 - MIT