Class: Jfy::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/jfy/client.rb

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Client

Returns a new instance of Client.



9
10
11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/jfy/client.rb', line 9

def initialize(options = {})
  serial_port = options[:serial_port] || '/dev/ttyUSB0'
  baud = options[:baud] || 9600
  @debug = options[:debug] || false

  @serial = SerialPort.new(serial_port, :baud => baud)

  @serial.flush_output
  @serial.flush_input
  @serial.read_timeout = 1_000

  @last_write = Time.now
end

Instance Method Details

#description(serial_num) ⇒ Object 



46
47
48
49
50
51
52
53
 
# File 'lib/jfy/client.rb', line 46

def description(serial_num)
  packet = Jfy::Packet.new(Jfy::Codes::READ_DESCRIPTION, [], :dst => serial_num)
  packet = write(packet)

  fail(BadPacket, 'invalid description response') unless packet.command == Jfy::Codes::READ_DESCRIPTION_RESP

  packet.decode
end

#offline_query ⇒ Object 



28
29
30
31
32
33
34
35
 
# File 'lib/jfy/client.rb', line 28

def offline_query
  packet = Packet.new(Jfy::Codes::OFFLINE_QUERY, [], :dst => 0x0)
  packet = write(packet)

  fail(BadPacket, 'invalid offline response') unless packet.command == Jfy::Codes::REGISTER_REQUEST

  packet.decode
end

#query_inverter_info(serial_num) ⇒ Object

rubocop:disable Metrics/AbcSize, Metrics/MethodLength



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/jfy/client.rb', line 134

def query_inverter_info(serial_num)
  packet = Jfy::Packet.new(Jfy::Codes::QUERY_INVERTER_INFO, [], :dst => serial_num)
  packet = write(packet)

  fail(BadPacket, 'invalid inverter info response') unless packet.command == Jfy::Codes::QUERY_INVERTER_INFO_RESP

  data = packet.data

  phase_types = {
    0x31 => 1,
    0x33 => 3,
  }
  phases = phase_types[data[0]] || fail("Unknown phase mode #{data[0]}")

  rating          = data[1, 6].pack('c*').to_i
  version         = data[7, 5].pack('c*')
  model           = data[12, 16].pack('c*').strip
  manufacturer    = data[28, 16].pack('c*').strip
  serial          = data[44, 16].pack('c*').strip
  nominal_voltage = data[60, 4].pack('c*').to_i / 10.0

  metrics = {
    :phases          => phases,
    :rating          => rating,
    :version         => version,
    :model           => model,
    :manufacturer    => manufacturer,
    :serial          => serial,
    :nominal_voltage => nominal_voltage,
  }

  metrics
end

#query_normal_info(serial_num) ⇒ Object

rubocop:disable Metrics/AbcSize, Metrics/MethodLength



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/jfy/client.rb', line 65

def query_normal_info(serial_num)
  packet = Jfy::Packet.new(Jfy::Codes::QUERY_NORMAL_INFO, [], :dst => serial_num)
  packet = write(packet)

  fail(BadPacket, 'invalid query normal info response') unless packet.command == Jfy::Codes::QUERY_NORMAL_INFO_RESP

  data = packet.data

  modes = {
    [0x0, 0x0] => :wait,
    [0x0, 0x1] => :normal,
    [0x0, 0x2] => :warning,
    [0x0, 0x3] => :error,
  }
  mode = modes[data[24, 2]] || fail("Unkown mode #{data[24]} #{data[25]}")

  metrics = {
    :temperature => short(data, 0) / 10.0,
    :mode        => mode,
    :voltage     => [
      short(data, 2) / 10.0,
      short(data, 4) / 10.0,
      short(data, 6) / 10.0,
      # FIXME: Need to test on larger inverter
      # short(data, 28) / 10.0,
      # short(data, 30) / 10.0,
      # short(data, 32) / 10.0,
      # short(data, 40) / 10.0,
      # short(data, 42) / 10.0,
      # short(data, 44) / 10.0,
    ],
    :current     => [
      short(data, 8) / 10.0,
      short(data, 10) / 10.0,
      short(data, 12) / 10.0,
      # FIXME: Need to test on larger inverter
      # short(data, 34) / 10.0,
      # short(data, 36) / 10.0,
      # short(data, 38) / 10.0,
      # short(data, 46) / 10.0,
      # short(data, 48) / 10.0,
      # short(data, 50) / 10.0,
    ],
    :hours       => long(data, 18),
    :power       => {
      :total => long(data, 14) / 10.0 * 1_000,
      :today => short(data, 26) / 100.0 * 1_000,
      :now   => short(data, 22),
    },
  }

  if data.size > 68
    metrics.merge!(
      :fault => {
        :temperature => short(data, 114) / 10.0,
        :voltage     => [
          short(data, 116) / 10.0,
          short(data, 118) / 10.0,
          short(data, 120) / 10.0,
        ],
      },
    )
  end

  metrics
end

#query_set_info(serial_num) ⇒ Object

rubocop:disable Metrics/AbcSize, Metrics/MethodLength



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/jfy/client.rb', line 170

def query_set_info(serial_num)
  packet = Jfy::Packet.new(Jfy::Codes::QUERY_SET_INFO, [], :dst => serial_num)
  packet = write(packet)

  fail(BadPacket, 'invalid set info response') unless packet.command == Jfy::Codes::QUERY_SET_INFO_RESP

  data = packet.data

  metrics = {
    :pv_voltage   => {
      :startup   => short(data, 0) / 10.0,
      :high_stop => short(data, 4) / 10.0,
      :low_stop  => short(data, 6) / 10.0,
    },
    :grid         => {
      :voltage   => {
        :min => short(data, 8) / 10.0,
        :max => short(data, 10) / 10.0,
      },
      :frequency => {
        :min => short(data, 12) / 100.0,
        :max => short(data, 14) / 100.0,
      },
      :impedance => {
        :max   => short(data, 16) / 1_000.0,
        :delta => short(data, 18),
      },
    },
    :power_max    => short(data, 20),
    :power_factor => short(data, 22) / 100.0,
    :connect_time => short(data, 2),
  }

  metrics
end

#re_register ⇒ Object 



23
24
25
26
 
# File 'lib/jfy/client.rb', line 23

def re_register
  packet = Packet.new(Jfy::Codes::RE_REGISTER, [], :dst => 0x0)
  write(packet, :read => false)
end

#register(serial_num, address) ⇒ Object 



37
38
39
40
41
42
43
44
 
# File 'lib/jfy/client.rb', line 37

def register(serial_num, address)
  data = serial_num.unpack('c*') << address
  packet = Jfy::Packet.new(Jfy::Codes::SEND_ADDRESS, data, :dst => 0x0)
  packet = write(packet)

  fail(BadPacket, 'invalid send address response') unless packet.command == Jfy::Codes::ADDRESS_CONFIRM
  fail(BadPacket, 'No Ack') unless packet.ack?
end

#rw_description(serial_num) ⇒ Object 



55
56
57
58
59
60
61
62
 
# File 'lib/jfy/client.rb', line 55

def rw_description(serial_num)
  packet = Jfy::Packet.new(Jfy::Codes::READ_RW_DESCRIPTION, [], :dst => serial_num)
  packet = write(packet)

  fail(BadPacket, 'invalid rw description response') unless packet.command == Jfy::Codes::READ_RW_DESCRIPTION_RESP

  packet.decode
end