waterfurnace_aurora 1.3.1 → 1.4.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/exe/aurora_mqtt_bridge +24 -9
- data/exe/web_aid_tool +7 -91
- data/lib/aurora/mqtt_modbus.rb +1 -1
- data/lib/aurora/registers.rb +8 -2
- data/lib/aurora/version.rb +1 -1
- data/lib/aurora/web_aid_tool.rb +103 -0
- metadata +17 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 2d5bee0f2cffba19731706869b56caf63404b81a1b570de2371123edcc4ca086
|
4
|
+
data.tar.gz: fdfaa768ff29702215564e8fca08b9c709a8e513ca05fbc10af149e80100497d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 13486b5db0bb4bae2c6370a50b41d165b396d7b15b146ed2c97ab340003f2ef661a707508a3846017943e5a86627da7a3843a696f4811a231e3a342105ef94df
|
7
|
+
data.tar.gz: 85f1d9697f5b787226181348aea84bb2735c6e3568e69374ad3768c0c246386ac4229c6f8cdb7a14685808e4dffe07932dfd24d5664be4e8b4885f1f5a016aaa
|
data/exe/aurora_mqtt_bridge
CHANGED
@@ -11,11 +11,15 @@ require "yaml"
|
|
11
11
|
require "aurora/core_ext/string"
|
12
12
|
|
13
13
|
debug_modbus = false
|
14
|
+
web_aid_tool = nil
|
15
|
+
device_name = "WaterFurnace"
|
14
16
|
|
15
17
|
options = OptionParser.new do |opts|
|
16
18
|
opts.banner = "Usage: aurora_mqtt_bridge /path/to/serial/port [options]"
|
17
19
|
|
20
|
+
opts.on("--device-name DEVIECENAME", "Give a descriptive name to your device") { |v| device_name = v }
|
18
21
|
opts.on("--debug-modbus", "Print actual protocol bytes") { debug_modbus = true }
|
22
|
+
opts.on("--web-aid-tool PORT", "Run web aid tool on given port", :integer) { |v| web_aid_tool = v }
|
19
23
|
opts.on("-v", "--version", "Print version") do
|
20
24
|
puts Aurora::VERSION
|
21
25
|
exit
|
@@ -36,10 +40,12 @@ end
|
|
36
40
|
mqtt_uri = ARGV[1]
|
37
41
|
|
38
42
|
abc = Aurora::ABCClient.new(ARGV[0])
|
39
|
-
abc.modbus_slave.logger = Logger.new($stdout)
|
40
|
-
|
43
|
+
Aurora.logger = abc.modbus_slave.logger = Logger.new($stdout)
|
44
|
+
Aurora.logger.level = debug_modbus ? :debug : :info
|
41
45
|
|
42
46
|
class MQTTBridge
|
47
|
+
attr_reader :mutex
|
48
|
+
|
43
49
|
def initialize(abc, homie)
|
44
50
|
@abc = abc
|
45
51
|
@homie = homie
|
@@ -86,7 +92,9 @@ class MQTTBridge
|
|
86
92
|
|
87
93
|
@abc.refresh
|
88
94
|
publish_basic_attributes
|
95
|
+
end
|
89
96
|
|
97
|
+
def join
|
90
98
|
loop do
|
91
99
|
begin
|
92
100
|
@mutex.synchronize do
|
@@ -803,13 +811,20 @@ class MQTTBridge
|
|
803
811
|
end
|
804
812
|
end
|
805
813
|
|
806
|
-
log_level = ARGV.include?("--debug") ? :debug : :warn
|
807
|
-
Aurora.logger = Logger.new($stdout)
|
808
|
-
Aurora.logger.level = log_level
|
809
|
-
abc.modbus_slave.logger = Aurora.logger
|
810
|
-
|
811
814
|
device = "aurora-#{abc.serial_number}"
|
812
|
-
homie = MQTT::Homie::Device.new(device,
|
815
|
+
homie = MQTT::Homie::Device.new(device, device_name, mqtt: mqtt_uri)
|
813
816
|
homie.logger = Aurora.logger
|
814
817
|
|
815
|
-
MQTTBridge.new(abc, homie)
|
818
|
+
mqtt_bridge = MQTTBridge.new(abc, homie)
|
819
|
+
|
820
|
+
if web_aid_tool
|
821
|
+
Thread.new { mqtt_bridge.join }
|
822
|
+
|
823
|
+
require "aurora/web_aid_tool"
|
824
|
+
Aurora::WebAIDTool.modbus_slave = abc.modbus_slave
|
825
|
+
Aurora::WebAIDTool.port = web_aid_tool
|
826
|
+
Aurora::WebAIDTool.mutex = mqtt_bridge.mutex
|
827
|
+
Aurora::WebAIDTool.run!
|
828
|
+
else
|
829
|
+
mqtt_bridge.join
|
830
|
+
end
|
data/exe/web_aid_tool
CHANGED
@@ -2,16 +2,17 @@
|
|
2
2
|
# frozen_string_literal: true
|
3
3
|
|
4
4
|
require "aurora"
|
5
|
-
require "
|
5
|
+
require "aurora/web_aid_tool"
|
6
6
|
require "logger"
|
7
7
|
require "optparse"
|
8
|
-
require "yaml"
|
9
8
|
|
10
9
|
debug_modbus = monitor = ignore_missing_registers = false
|
10
|
+
port = 4567
|
11
11
|
|
12
12
|
options = OptionParser.new do |opts|
|
13
13
|
opts.banner = "Usage: web_aid_tool /path/to/serial/port [options]"
|
14
14
|
|
15
|
+
opts.on("--port PORT", "Which port to listen on (default 4567)", :integer) { |v| port = v }
|
15
16
|
opts.on("--debug-modbus", "Print actual protocol bytes") { debug_modbus = true }
|
16
17
|
opts.on("--monitor", "Print interpreted registers as they are requested, like aurora_monitor") { monitor = true }
|
17
18
|
opts.on("--ignore-missing-registers",
|
@@ -39,92 +40,7 @@ slave = Aurora::ABCClient.open_modbus_slave(ARGV[0], ignore_missing_registers: i
|
|
39
40
|
slave.logger = Logger.new($stdout)
|
40
41
|
slave.logger.level = debug_modbus ? :debug : :warn
|
41
42
|
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
# _don't_ do URI escaping
|
47
|
-
def encode_result(params)
|
48
|
-
params.map { |p| p.join("=") }.join("&")
|
49
|
-
end
|
50
|
-
|
51
|
-
require "sinatra"
|
52
|
-
|
53
|
-
set :public_folder, "html"
|
54
|
-
set :logging, false
|
55
|
-
|
56
|
-
get "/" do
|
57
|
-
send_file "html/index.htm"
|
58
|
-
end
|
59
|
-
|
60
|
-
units = 0
|
61
|
-
|
62
|
-
get "/getunits.cgi" do
|
63
|
-
encode_result(units: units)
|
64
|
-
end
|
65
|
-
|
66
|
-
get "/setunits.cgi" do
|
67
|
-
units = params["units"].to_i
|
68
|
-
encode_result(error: 0)
|
69
|
-
end
|
70
|
-
|
71
|
-
get "/config.cgi" do
|
72
|
-
encode_result(
|
73
|
-
"AWL Version" => Aurora::VERSION,
|
74
|
-
"Local Web Version" => 1.08,
|
75
|
-
"SSID" => nil,
|
76
|
-
"Units" => units,
|
77
|
-
"AWL ID" => ARGV[0],
|
78
|
-
"AWL ID CRC" => nil
|
79
|
-
)
|
80
|
-
end
|
81
|
-
|
82
|
-
get "/request.cgi" do
|
83
|
-
params = parse_query_string(request.query_string)
|
84
|
-
result = params.slice("cmd", "id", "set", "addr")
|
85
|
-
result["err"] = nil
|
86
|
-
|
87
|
-
# these are just aliases to get a certain set of registers
|
88
|
-
case params["cmd"]
|
89
|
-
when "abcinfo"
|
90
|
-
params["regs"] = "2;8;88,4"
|
91
|
-
when "devices"
|
92
|
-
params["regs"] = "800;803;806,3;812;815;818;824"
|
93
|
-
end
|
94
|
-
|
95
|
-
case params["cmd"]
|
96
|
-
when "getregs", "abcinfo", "devices"
|
97
|
-
queries = params["regs"].split(";").map do |range|
|
98
|
-
start, length = range.split(",").map(&:to_i)
|
99
|
-
next start if length.nil?
|
100
|
-
|
101
|
-
start...(start + length)
|
102
|
-
end
|
103
|
-
registers = slave.read_multiple_holding_registers(*queries)
|
104
|
-
if monitor
|
105
|
-
puts "READING"
|
106
|
-
puts Aurora.print_registers(registers)
|
107
|
-
end
|
108
|
-
result["values"] = registers.values.join(",")
|
109
|
-
when "putregs"
|
110
|
-
writes = params["regs"].split(";").map do |write|
|
111
|
-
write.split(",").map(&:to_i)
|
112
|
-
end.compact.to_h
|
113
|
-
if monitor
|
114
|
-
puts "WRITING"
|
115
|
-
puts Aurora.print_registers(writes)
|
116
|
-
end
|
117
|
-
|
118
|
-
writes.each do |(addr, value)|
|
119
|
-
slave.write_holding_register(addr, value)
|
120
|
-
end
|
121
|
-
else
|
122
|
-
return ""
|
123
|
-
end
|
124
|
-
|
125
|
-
encode_result(result)
|
126
|
-
end
|
127
|
-
|
128
|
-
# can't rely on this running automatically when we're installed as a gem,
|
129
|
-
# because the wrapper script will confuse it
|
130
|
-
Sinatra::Application.run!
|
43
|
+
Aurora::WebAIDTool.modbus_slave = slave
|
44
|
+
Aurora::WebAIDTool.monitor = monitor
|
45
|
+
Aurora::WebAIDTool.port = port
|
46
|
+
Aurora::WebAIDTool.run!
|
data/lib/aurora/mqtt_modbus.rb
CHANGED
@@ -19,7 +19,7 @@ module Aurora
|
|
19
19
|
query_id = SecureRandom.uuid
|
20
20
|
mqtt_query = queries.map { |m| m.is_a?(Range) ? "#{m.begin},#{m.count}" : m }.join(";")
|
21
21
|
@mqtt.publish("#{@base_topic}/getregs", "#{query_id}:#{mqtt_query}", qos: 1)
|
22
|
-
Timeout.timeout(
|
22
|
+
Timeout.timeout(5) do
|
23
23
|
result = {}
|
24
24
|
loop do
|
25
25
|
packet = @mqtt.get
|
data/lib/aurora/registers.rb
CHANGED
@@ -60,11 +60,16 @@ module Aurora
|
|
60
60
|
result
|
61
61
|
end
|
62
62
|
|
63
|
-
def
|
63
|
+
def to_uint32(registers, idx)
|
64
64
|
Aurora&.logger&.warn("Missing register #{idx + 1}") unless registers[idx + 1]
|
65
65
|
(registers[idx] << 16) + registers[idx + 1]
|
66
66
|
end
|
67
67
|
|
68
|
+
def to_int32(registers, idx)
|
69
|
+
v = to_uint32(registers, idx)
|
70
|
+
v & 0x80000000 == 0x80000000 ? v - 0x100000000 : v
|
71
|
+
end
|
72
|
+
|
68
73
|
def to_string(registers, idx, length)
|
69
74
|
(idx...(idx + length)).map do |i|
|
70
75
|
next "\ufffd" unless registers[i] # missing data? add unicode invalid character
|
@@ -533,7 +538,8 @@ module Aurora
|
|
533
538
|
->(v) { COMPONENT_STATUS[v] } => [800, 803, 806, 812, 815, 818, 824, 827],
|
534
539
|
method(:axb_inputs) => [1103],
|
535
540
|
->(v) { from_bitmask(v, AXB_OUTPUTS) } => [1104],
|
536
|
-
method(:
|
541
|
+
method(:to_uint32) => [1146, 1148, 1150, 1152, 1164, 3422, 3424],
|
542
|
+
method(:to_int32) => [1154, 1156],
|
537
543
|
method(:manual_operation) => [3002],
|
538
544
|
method(:thermostat_configuration2) => [12_006],
|
539
545
|
->(v) { HEATING_MODE[v] } => [12_606, 21_202, 21_211, 21_220, 21_229, 21_238, 21_247],
|
data/lib/aurora/version.rb
CHANGED
@@ -0,0 +1,103 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "sinatra/base"
|
4
|
+
|
5
|
+
module Aurora
|
6
|
+
class WebAIDTool < Sinatra::Base
|
7
|
+
class << self
|
8
|
+
attr_accessor :modbus_slave, :monitor, :units, :mutex
|
9
|
+
end
|
10
|
+
|
11
|
+
extend Forwardable
|
12
|
+
delegate %i[modbus_slave monitor units units= mutex] => "self.class"
|
13
|
+
|
14
|
+
self.mutex = Mutex.new
|
15
|
+
self.units = 0
|
16
|
+
|
17
|
+
set :public_folder, "html"
|
18
|
+
set :logging, false
|
19
|
+
|
20
|
+
get "/" do
|
21
|
+
send_file "html/index.htm"
|
22
|
+
end
|
23
|
+
|
24
|
+
get "/getunits.cgi" do
|
25
|
+
encode_result(units: units)
|
26
|
+
end
|
27
|
+
|
28
|
+
get "/setunits.cgi" do
|
29
|
+
self.units = params["units"].to_i
|
30
|
+
encode_result(error: 0)
|
31
|
+
end
|
32
|
+
|
33
|
+
get "/config.cgi" do
|
34
|
+
encode_result(
|
35
|
+
"AWL Version" => Aurora::VERSION,
|
36
|
+
"Local Web Version" => 1.08,
|
37
|
+
"SSID" => nil,
|
38
|
+
"Units" => units,
|
39
|
+
"AWL ID" => ARGV[0],
|
40
|
+
"AWL ID CRC" => nil
|
41
|
+
)
|
42
|
+
end
|
43
|
+
|
44
|
+
get "/request.cgi" do
|
45
|
+
params = parse_query_string(request.query_string)
|
46
|
+
result = params.slice("cmd", "id", "set", "addr")
|
47
|
+
result["err"] = nil
|
48
|
+
|
49
|
+
# these are just aliases to get a certain set of registers
|
50
|
+
case params["cmd"]
|
51
|
+
when "abcinfo"
|
52
|
+
params["regs"] = "2;8;88,4"
|
53
|
+
when "devices"
|
54
|
+
params["regs"] = "800;803;806,3;812;815;818;824"
|
55
|
+
end
|
56
|
+
|
57
|
+
case params["cmd"]
|
58
|
+
when "getregs", "abcinfo", "devices"
|
59
|
+
queries = params["regs"].split(";").map do |range|
|
60
|
+
start, length = range.split(",").map(&:to_i)
|
61
|
+
next start if length.nil?
|
62
|
+
|
63
|
+
start...(start + length)
|
64
|
+
end
|
65
|
+
registers = mutex.synchronize { modbus_slave.read_multiple_holding_registers(*queries) }
|
66
|
+
if monitor
|
67
|
+
puts "READING"
|
68
|
+
puts Aurora.print_registers(registers)
|
69
|
+
end
|
70
|
+
result["values"] = registers.values.join(",")
|
71
|
+
when "putregs"
|
72
|
+
writes = params["regs"].split(";").map do |write|
|
73
|
+
write.split(",").map(&:to_i)
|
74
|
+
end.compact.to_h
|
75
|
+
if monitor
|
76
|
+
puts "WRITING"
|
77
|
+
puts Aurora.print_registers(writes)
|
78
|
+
end
|
79
|
+
|
80
|
+
mutex.synchronize do
|
81
|
+
writes.each do |(addr, value)|
|
82
|
+
modbus_slave.write_holding_register(addr, value)
|
83
|
+
end
|
84
|
+
end
|
85
|
+
else
|
86
|
+
return ""
|
87
|
+
end
|
88
|
+
|
89
|
+
encode_result(result)
|
90
|
+
end
|
91
|
+
|
92
|
+
private
|
93
|
+
|
94
|
+
def parse_query_string(query_string)
|
95
|
+
query_string.split("&").map { |p| p.split("=") }.to_h
|
96
|
+
end
|
97
|
+
|
98
|
+
# _don't_ do URI escaping
|
99
|
+
def encode_result(params)
|
100
|
+
params.map { |p| p.join("=") }.join("&")
|
101
|
+
end
|
102
|
+
end
|
103
|
+
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: waterfurnace_aurora
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.4.2
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Cody Cutrer
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-02-
|
11
|
+
date: 2022-02-19 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: ccutrer-serialport
|
@@ -92,6 +92,20 @@ dependencies:
|
|
92
92
|
- - "~>"
|
93
93
|
- !ruby/object:Gem::Version
|
94
94
|
version: '2.1'
|
95
|
+
- !ruby/object:Gem::Dependency
|
96
|
+
name: thin
|
97
|
+
requirement: !ruby/object:Gem::Requirement
|
98
|
+
requirements:
|
99
|
+
- - "~>"
|
100
|
+
- !ruby/object:Gem::Version
|
101
|
+
version: '1.8'
|
102
|
+
type: :runtime
|
103
|
+
prerelease: false
|
104
|
+
version_requirements: !ruby/object:Gem::Requirement
|
105
|
+
requirements:
|
106
|
+
- - "~>"
|
107
|
+
- !ruby/object:Gem::Version
|
108
|
+
version: '1.8'
|
95
109
|
- !ruby/object:Gem::Dependency
|
96
110
|
name: byebug
|
97
111
|
requirement: !ruby/object:Gem::Requirement
|
@@ -182,6 +196,7 @@ files:
|
|
182
196
|
- lib/aurora/registers.rb
|
183
197
|
- lib/aurora/thermostat.rb
|
184
198
|
- lib/aurora/version.rb
|
199
|
+
- lib/aurora/web_aid_tool.rb
|
185
200
|
- lib/waterfurnace_aurora.rb
|
186
201
|
homepage: https://github.com/ccutrer/waterfurnace_aurora
|
187
202
|
licenses:
|