Class: SDN::CLI::MQTT

Inherits:
Object
  • Object
show all
Includes:
Read, Subscriptions, Write
Defined in:
lib/sdn/cli/mqtt.rb,
lib/sdn/cli/mqtt/read.rb,
lib/sdn/cli/mqtt/group.rb,
lib/sdn/cli/mqtt/motor.rb,
lib/sdn/cli/mqtt/write.rb,
lib/sdn/cli/mqtt/p_queue.rb,
lib/sdn/cli/mqtt/subscriptions.rb

Defined Under Namespace

Modules: Read, Subscriptions, Write Classes: Group, MessageAndRetries, Motor, PQueue

Constant Summary collapse

WAIT_TIME = 
0.25
BROADCAST_WAIT = 
5.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Subscriptions

#handle_message

Methods included from Write

#write

Methods included from Read

#read

Constructor Details

#initialize(sdn, mqtt_uri, device_id: "somfy", base_topic: "homie", auto_discover: true, known_motors: []) ⇒ MQTT

Returns a new instance of MQTT.



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/sdn/cli/mqtt.rb', line 28

def initialize(sdn,
               mqtt_uri,
               device_id: "somfy",
               base_topic: "homie",
               auto_discover: true,
               known_motors: [])
  @base_topic = "#{base_topic}/#{device_id}"
  @mqtt = ::MQTT::Client.new(mqtt_uri)
  @mqtt.set_will("#{@base_topic}/$state", "lost", retain: true)
  @mqtt.connect

  @motors = {}
  @groups = {}

  @mutex = Mutex.new
  @cond = ConditionVariable.new
  @queue = PQueue.new
  @response_pending = false
  @broadcast_pending = false

  @auto_discover = auto_discover
  @motors_found = true

  clear_tree(@base_topic)
  publish_basic_attributes

  @sdn = sdn

  known_motors&.each do |addr|
    addr = Message.parse_address(addr)
    @queue.push(MessageAndRetries.new(Message::GetMotorPosition.new(addr), 5, 0))
  end

  Thread.abort_on_exception = true
  Thread.new { read }
  Thread.new { write }
  @mqtt.get { |packet| handle_message(packet.topic, packet.payload) }
end

Instance Attribute Details

#groups ⇒ Object (readonly)

Returns the value of attribute groups.



26
27
28
 
# File 'lib/sdn/cli/mqtt.rb', line 26

def groups
  @groups
end

#motors ⇒ Object (readonly)

Returns the value of attribute motors.



26
27
28
 
# File 'lib/sdn/cli/mqtt.rb', line 26

def motors
  @motors
end

Instance Method Details

#add_group(addr) ⇒ Object 



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/sdn/cli/mqtt.rb', line 359

def add_group(addr)
  addr = addr.delete(".")
  group = @groups[addr]
  return group if group

  @mqtt.batch_publish do
    publish("#{addr}/$name", addr)
    publish("#{addr}/$type", "Shade Group")
    publish("#{addr}/$properties",
            "discover,control,jog-ms,jog-pulses,position-pulses,position-percent," \
            "ip,reset,state,last-direction,motors")

    publish("#{addr}/discover/$name", "Trigger Motor Discovery")
    publish("#{addr}/discover/$datatype", "enum")
    publish("#{addr}/discover/$format", "discover")
    publish("#{addr}/discover/$settable", "true")
    publish("#{addr}/discover/$retained", "false")

    publish("#{addr}/control/$name", "Control motors")
    publish("#{addr}/control/$datatype", "enum")
    publish("#{addr}/control/$format", "up,down,stop,wink,next_ip,previous_ip,refresh")
    publish("#{addr}/control/$settable", "true")
    publish("#{addr}/control/$retained", "false")

    publish("#{addr}/jog-ms/$name", "Jog motors by ms")
    publish("#{addr}/jog-ms/$datatype", "integer")
    publish("#{addr}/jog-ms/$format", "-65535:65535")
    publish("#{addr}/jog-ms/$unit", "ms")
    publish("#{addr}/jog-ms/$settable", "true")
    publish("#{addr}/jog-ms/$retained", "false")

    publish("#{addr}/jog-pulses/$name", "Jog motors by pulses")
    publish("#{addr}/jog-pulses/$datatype", "integer")
    publish("#{addr}/jog-pulses/$format", "-65535:65535")
    publish("#{addr}/jog-pulses/$unit", "pulses")
    publish("#{addr}/jog-pulses/$settable", "true")
    publish("#{addr}/jog-pulses/$retained", "false")

    publish("#{addr}/position-pulses/$name", "Position from up limit (in pulses)")
    publish("#{addr}/position-pulses/$datatype", "integer")
    publish("#{addr}/position-pulses/$format", "0:65535")
    publish("#{addr}/position-pulses/$unit", "pulses")
    publish("#{addr}/position-pulses/$settable", "true")

    publish("#{addr}/position-percent/$name", "Position (in %)")
    publish("#{addr}/position-percent/$datatype", "integer")
    publish("#{addr}/position-percent/$format", "0:100")
    publish("#{addr}/position-percent/$unit", "%")
    publish("#{addr}/position-percent/$settable", "true")

    publish("#{addr}/ip/$name", "Intermediate Position")
    publish("#{addr}/ip/$datatype", "integer")
    publish("#{addr}/ip/$format", "1:16")
    publish("#{addr}/ip/$settable", "true")

    publish("#{addr}/state/$name", "State of the motors")
    publish("#{addr}/state/$datatype", "enum")
    publish("#{addr}/state/$format", "#{Message::PostMotorStatus::STATE.keys.join(",")},mixed")

    publish("#{addr}/last-direction/$name", "Direction of last motion")
    publish("#{addr}/last-direction/$datatype", "enum")
    publish("#{addr}/last-direction/$format", "#{Message::PostMotorStatus::DIRECTION.keys.join(",")},mixed")

    publish("#{addr}/motors/$name", "Comma separated motor addresses that are members of this group")
    publish("#{addr}/motors/$datatype", "string")

    group = @groups[addr] = Group.new(self, addr)
    publish("$nodes", (["FFFFFF"] + @motors.keys.sort + @groups.keys.sort).join(","))
  end
  group
end

#clear_tree(topic) ⇒ Object 



84
85
86
87
88
89
90
91
 
# File 'lib/sdn/cli/mqtt.rb', line 84

def clear_tree(topic)
  @mqtt.subscribe("#{topic}/#")
  @mqtt.unsubscribe("#{topic}/#", wait_for_ack: true)
  until @mqtt.queue_empty?
    packet = @mqtt.get
    @mqtt.publish(packet.topic, nil, retain: true)
  end
end

#enqueue(message) ⇒ Object 



75
76
77
78
79
80
81
82
 
# File 'lib/sdn/cli/mqtt.rb', line 75

def enqueue(message)
  @mutex.synchronize do
    break if @queue.include?(message)

    @queue.push(message)
    @cond.signal
  end
end

#publish(topic, value) ⇒ Object 



67
68
69
 
# File 'lib/sdn/cli/mqtt.rb', line 67

def publish(topic, value)
  @mqtt.publish("#{@base_topic}/#{topic}", value, retain: true, qos: 1)
end

#publish_basic_attributes ⇒ Object 



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
 
# File 'lib/sdn/cli/mqtt.rb', line 93

def publish_basic_attributes
  @mqtt.batch_publish do
    publish("$homie", "4.0.0")
    publish("$name", "Somfy SDN Network")
    publish("$state", "init")
    publish("$nodes", "FFFFFF")

    publish("FFFFFF/$name", "Broadcast")
    publish("FFFFFF/$type", "sdn")
    publish("FFFFFF/$properties", "discover")

    publish("FFFFFF/discover/$name", "Trigger Motor Discovery")
    publish("FFFFFF/discover/$datatype", "enum")
    publish("FFFFFF/discover/$format", "discover")
    publish("FFFFFF/discover/$settable", "true")
    publish("FFFFFF/discover/$retained", "false")

    subscribe_all

    publish("$state", "ready")
  end

  @mqtt.on_reconnect do
    subscribe_all
    publish("$state", :init)
    publish("$state", :ready)
  end
end

#publish_motor(addr, node_type) ⇒ Object 



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/sdn/cli/mqtt.rb', line 145

def publish_motor(addr, node_type)
  motor = nil

  @mqtt.batch_publish do
    publish("#{addr}/$name", addr)
    publish("#{addr}/$type", node_type.to_s)
    properties = %w[
      discover
      label
      state
      control
      jog-ms
      jog-pulses
      position-pulses
      position-percent
      ip
      down-limit
      groups
      last-direction
    ] + (1..16).map { |ip| ["ip#{ip}-pulses", "ip#{ip}-percent"] }.flatten

    unless node_type == :st50ilt2
      properties.push("reset",
                      "last-action-source",
                      "last-action-cause",
                      "up-limit",
                      "direction",
                      "up-speed",
                      "down-speed",
                      "slow-speed")
    end

    publish("#{addr}/$properties", properties.join(","))

    publish("#{addr}/discover/$name", "Trigger Motor Discovery")
    publish("#{addr}/discover/$datatype", "enum")
    publish("#{addr}/discover/$format", "discover")
    publish("#{addr}/discover/$settable", "true")
    publish("#{addr}/discover/$retained", "false")

    publish("#{addr}/label/$name", "Node label")
    publish("#{addr}/label/$datatype", "string")
    publish("#{addr}/label/$settable", "true")

    publish("#{addr}/state/$name", "Current state of the motor")
    publish("#{addr}/state/$datatype", "enum")
    publish("#{addr}/state/$format", Message::PostMotorStatus::STATE.keys.join(","))

    publish("#{addr}/control/$name", "Control motor")
    publish("#{addr}/control/$datatype", "enum")
    publish("#{addr}/control/$format", "up,down,stop,wink,next_ip,previous_ip,refresh")
    publish("#{addr}/control/$settable", "true")
    publish("#{addr}/control/$retained", "false")

    publish("#{addr}/jog-ms/$name", "Jog motor by ms")
    publish("#{addr}/jog-ms/$datatype", "integer")
    publish("#{addr}/jog-ms/$format", "-65535:65535")
    publish("#{addr}/jog-ms/$unit", "ms")
    publish("#{addr}/jog-ms/$settable", "true")
    publish("#{addr}/jog-ms/$retained", "false")

    publish("#{addr}/jog-pulses/$name", "Jog motor by pulses")
    publish("#{addr}/jog-pulses/$datatype", "integer")
    publish("#{addr}/jog-pulses/$format", "-65535:65535")
    publish("#{addr}/jog-pulses/$unit", "pulses")
    publish("#{addr}/jog-pulses/$settable", "true")
    publish("#{addr}/jog-pulses/$retained", "false")

    publish("#{addr}/position-percent/$name", "Position (in %)")
    publish("#{addr}/position-percent/$datatype", "integer")
    publish("#{addr}/position-percent/$format", "0:100")
    publish("#{addr}/position-percent/$unit", "%")
    publish("#{addr}/position-percent/$settable", "true")

    publish("#{addr}/position-pulses/$name", "Position from up limit (in pulses)")
    publish("#{addr}/position-pulses/$datatype", "integer")
    publish("#{addr}/position-pulses/$format", "0:65535")
    publish("#{addr}/position-pulses/$unit", "pulses")
    publish("#{addr}/position-pulses/$settable", "true")

    publish("#{addr}/ip/$name", "Intermediate Position")
    publish("#{addr}/ip/$datatype", "integer")
    publish("#{addr}/ip/$format", "1:16")
    publish("#{addr}/ip/$settable", "true")
    publish("#{addr}/ip/$retained", "false") if node_type == :st50ilt2

    publish("#{addr}/down-limit/$name", "Down limit")
    publish("#{addr}/down-limit/$datatype", "integer")
    publish("#{addr}/down-limit/$format", "0:65535")
    publish("#{addr}/down-limit/$unit", "pulses")
    publish("#{addr}/down-limit/$settable", "true")

    publish("#{addr}/last-direction/$name", "Direction of last motion")
    publish("#{addr}/last-direction/$datatype", "enum")
    publish("#{addr}/last-direction/$format", Message::PostMotorStatus::DIRECTION.keys.join(","))

    unless node_type == :st50ilt2
      publish("#{addr}/reset/$name", "Recall factory settings")
      publish("#{addr}/reset/$datatype", "enum")
      publish("#{addr}/reset/$format", Message::SetFactoryDefault::RESET.keys.join(","))
      publish("#{addr}/reset/$settable", "true")
      publish("#{addr}/reset/$retained", "false")

      publish("#{addr}/last-action-source/$name", "Source of last action")
      publish("#{addr}/last-action-source/$datatype", "enum")
      publish("#{addr}/last-action-source/$format", Message::PostMotorStatus::SOURCE.keys.join(","))

      publish("#{addr}/last-action-cause/$name", "Cause of last action")
      publish("#{addr}/last-action-cause/$datatype", "enum")
      publish("#{addr}/last-action-cause/$format", Message::PostMotorStatus::CAUSE.keys.join(","))

      publish("#{addr}/up-limit/$name", "Up limit (always = 0)")
      publish("#{addr}/up-limit/$datatype", "integer")
      publish("#{addr}/up-limit/$format", "0:65535")
      publish("#{addr}/up-limit/$unit", "pulses")
      publish("#{addr}/up-limit/$settable", "true")

      publish("#{addr}/direction/$name", "Motor rotation direction")
      publish("#{addr}/direction/$datatype", "enum")
      publish("#{addr}/direction/$format", "standard,reversed")
      publish("#{addr}/direction/$settable", "true")

      publish("#{addr}/up-speed/$name", "Up speed")
      publish("#{addr}/up-speed/$datatype", "integer")
      publish("#{addr}/up-speed/$format", "6:28")
      publish("#{addr}/up-speed/$unit", "RPM")
      publish("#{addr}/up-speed/$settable", "true")

      publish("#{addr}/down-speed/$name", "Down speed, always = Up speed")
      publish("#{addr}/down-speed/$datatype", "integer")
      publish("#{addr}/down-speed/$format", "6:28")
      publish("#{addr}/down-speed/$unit", "RPM")
      publish("#{addr}/down-speed/$settable", "true")

      publish("#{addr}/slow-speed/$name", "Slow speed")
      publish("#{addr}/slow-speed/$datatype", "integer")
      publish("#{addr}/slow-speed/$format", "6:28")
      publish("#{addr}/slow-speed/$unit", "RPM")
      publish("#{addr}/slow-speed/$settable", "true")
    end

    publish("#{addr}/groups/$name", "Group Memberships (comma separated, address must start 0101xx)")
    publish("#{addr}/groups/$datatype", "string")
    publish("#{addr}/groups/$settable", "true")

    (1..16).each do |ip|
      publish("#{addr}/ip#{ip}-pulses/$name", "Intermediate Position #{ip}")
      publish("#{addr}/ip#{ip}-pulses/$datatype", "integer")
      publish("#{addr}/ip#{ip}-pulses/$format", "0:65535")
      publish("#{addr}/ip#{ip}-pulses/$unit", "pulses")
      publish("#{addr}/ip#{ip}-pulses/$settable", "true")

      publish("#{addr}/ip#{ip}-percent/$name", "Intermediate Position #{ip}")
      publish("#{addr}/ip#{ip}-percent/$datatype", "integer")
      publish("#{addr}/ip#{ip}-percent/$format", "0:100")
      publish("#{addr}/ip#{ip}-percent/$unit", "%")
      publish("#{addr}/ip#{ip}-percent/$settable", "true")
    end

    motor = Motor.new(self, addr, node_type)
    @motors[addr] = motor
    publish("$nodes", (["FFFFFF"] + @motors.keys.sort + @groups.keys.sort).join(","))
  end

  sdn_addr = Message.parse_address(addr)
  @mutex.synchronize do
    # message priorities are:
    # 0 - control
    # 1 - follow-up (i.e. get position after control)
    # 2 - get motor limits
    # 3 - get motor info
    # 4 - get group 1
    # 5 - get ip 1
    # 6 - get group 2
    # 7 - get ip 2
    # ...
    # 50 - discover

    # The Group and IP sorting makes it so you quickly get the most commonly used group
    # and IP addresses, while the almost-never-used ones are pushed to the bottom of the list

    @queue.push(MessageAndRetries.new(Message::GetNodeLabel.new(sdn_addr), 5, 3))

    case node_type
    when :st30, 0x20 # no idea why 0x20, but that's what I get
      @queue.push(MessageAndRetries.new(Message::GetMotorLimits.new(sdn_addr), 5, 2))
      @queue.push(MessageAndRetries.new(Message::GetMotorStatus.new(sdn_addr), 5, 3))
      @queue.push(MessageAndRetries.new(Message::GetMotorDirection.new(sdn_addr), 5, 3))
      @queue.push(MessageAndRetries.new(Message::GetMotorRollingSpeed.new(sdn_addr), 5, 3))
      (1..16).each do |ip|
        @queue.push(MessageAndRetries.new(Message::GetMotorIP.new(sdn_addr, ip), 5, (2 * ip) + 3))
      end
    when :st50ilt2
      @queue.push(MessageAndRetries.new(Message::ILT2::GetMotorPosition.new(sdn_addr), 5, 2))
      @queue.push(MessageAndRetries.new(Message::ILT2::GetMotorSettings.new(sdn_addr), 5, 3))
      (1..16).each do |ip|
        @queue.push(MessageAndRetries.new(Message::ILT2::GetMotorIP.new(sdn_addr, ip), 5, (2 * ip) + 3))
      end
    end
    (1..16).each do |g|
      @queue.push(MessageAndRetries.new(Message::GetGroupAddr.new(sdn_addr, g), 5, (2 * g) + 2))
    end

    @cond.signal
  end

  motor
end

#subscribe(topic) ⇒ Object 



71
72
73
 
# File 'lib/sdn/cli/mqtt.rb', line 71

def subscribe(topic)
  @mqtt.subscribe("#{@base_topic}/#{topic}")
end

#subscribe_all ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/sdn/cli/mqtt.rb', line 122

def subscribe_all
  subscribe("+/discover/set")
  subscribe("+/label/set")
  subscribe("+/control/set")
  subscribe("+/jog-ms/set")
  subscribe("+/jog-pulses/set")
  subscribe("+/position-pulses/set")
  subscribe("+/position-percent/set")
  subscribe("+/ip/set")
  subscribe("+/reset/set")
  subscribe("+/direction/set")
  subscribe("+/up-speed/set")
  subscribe("+/down-speed/set")
  subscribe("+/slow-speed/set")
  subscribe("+/up-limit/set")
  subscribe("+/down-limit/set")
  subscribe("+/groups/set")
  (1..16).each do |ip|
    subscribe("+/ip#{ip}-pulses/set")
    subscribe("+/ip#{ip}-percent/set")
  end
end

#touch_group(group_addr) ⇒ Object 



354
355
356
357
 
# File 'lib/sdn/cli/mqtt.rb', line 354

def touch_group(group_addr)
  group = @groups[Message.print_address(group_addr).delete(".")]
  group&.publish(:motors, group.motors_string)
end