-
Notifications
You must be signed in to change notification settings - Fork 0
/
driver.go
659 lines (576 loc) · 16.5 KB
/
driver.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
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
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
131
132
133
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
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
353
354
355
356
357
358
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
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
package wbgo
import (
"fmt"
"strconv"
"strings"
"time"
)
type Writability int
const (
EVENT_QUEUE_LEN = 100
DEFAULT_POLL_INTERVAL = 5 * time.Second
CONTROL_LIST_CAPACITY = 32
pushButtonType = "pushbutton"
DefaultWritability Writability = iota
ForceReadOnly
ForceWritable
)
type MQTTMessage struct {
Topic string
Payload string
QoS byte
Retained bool
}
type MQTTMessageHandler func(message MQTTMessage)
type MQTTClient interface {
WaitForReady() <-chan struct{}
Start()
Stop()
Publish(message MQTTMessage)
PublishSync(message MQTTMessage)
Subscribe(callback MQTTMessageHandler, topics ...string)
Unsubscribe(topics ...string)
}
type Model interface {
Start() error
Stop()
Observe(observer ModelObserver)
Poll()
}
// ExtendedModel is a Model that supports external devices
type ExtendedModel interface {
Model
AddExternalDevice(name string) (ExternalDeviceModel, error)
}
type DeviceModel interface {
Name() string
Title() string
Observe(observer DeviceObserver)
// AcceptValue accepts the specified control value sent via an MQTT value topic
// (not .../on). For local devices, that can be a retained value, for external
// devices, the current control value
AcceptValue(name, value string)
}
type LocalDeviceModel interface {
DeviceModel
// AcceptOnValue accepts the specified control value sent via an MQTT .../on topic
// for the target device and returns true if the value should be automatically
// echoed back
AcceptOnValue(name, value string) bool
IsVirtual() bool
}
type ExternalDeviceModel interface {
DeviceModel
SetTitle(title string)
AcceptControlType(name, controlType string)
AcceptControlRange(name string, max float64)
}
// TBD: rename ModelObserver(?) (it's not just an observer)
type ModelObserver interface {
CallSync(thunk func())
WhenReady(thunk func())
RemoveDevice(dev DeviceModel)
OnNewDevice(dev DeviceModel)
}
type Control struct {
Name string
Title string
Type string
Value string
Units string
Writability Writability
HasMax bool
Max float64
Forget bool
Order int
}
// FIXME: don't use 'type:units' notation for Type
func (c Control) GetType() string {
if idx := strings.Index(c.Type, ":"); idx >= 0 {
return c.Type[:idx]
}
return c.Type
}
func (c Control) GetUnits() string {
if c.Units != "" {
return c.Units
}
if idx := strings.Index(c.Type, ":"); idx >= 0 {
return c.Type[idx+1:]
}
return ""
}
func (c Control) Retain() bool {
return !c.Forget && c.Type != pushButtonType
}
type DeviceObserver interface {
OnNewControl(dev LocalDeviceModel, control Control) string
OnValue(dev DeviceModel, name, value string)
OnError(dev DeviceModel, name, value string)
}
type ModelBase struct {
Observer ModelObserver
}
func (model *ModelBase) Observe(observer ModelObserver) {
model.Observer = observer
}
func (model *ModelBase) Poll() {}
func (model *ModelBase) Stop() {}
type DeviceBase struct {
DevName string
DevTitle string
Observer DeviceObserver
}
func (dev *DeviceBase) Name() string {
return dev.DevName
}
func (dev *DeviceBase) Title() string {
return dev.DevTitle
}
func (dev *DeviceBase) SetTitle(title string) {
dev.DevTitle = title
}
func (dev *DeviceBase) Observe(observer DeviceObserver) {
dev.Observer = observer
}
type controlKey struct {
devName string
controlName string
}
type driverTopic struct {
ReceivedValue string
DeviceName string
ControlName string
Dev DeviceModel
Ready bool
Skip bool
}
func (drvTopic *driverTopic) resetDevice() {
drvTopic.Dev = nil
drvTopic.Ready = false
drvTopic.Skip = false
}
// Driver transfers data between Model with MQTTClient
type Driver struct {
model Model
client MQTTClient
eventCh chan func()
handleMessageCh chan func()
quit chan chan struct{}
poll chan time.Time
deviceMap map[string]DeviceModel // TBD: wrap DeviceModel instead of using parallel structures
nextOrder map[string]int
controlList map[string][]string
retainMap map[string]bool
topics map[string]*driverTopic
autoPoll bool
pollInterval time.Duration
acceptsExternalDevices bool
active bool
ready bool
whenReady *DeferredList
cleanupTopics []string
}
func NewDriver(model Model, client MQTTClient) (drv *Driver) {
drv = &Driver{
model: model,
client: client,
// Actually EVENT_QUEUE_LEN > 0 is only needed
// to avoid deadlocks in tests in a case when
// model change causes MQTT message to be generated
// that is passed back to the model
eventCh: make(chan func(), EVENT_QUEUE_LEN),
handleMessageCh: make(chan func(), EVENT_QUEUE_LEN),
quit: make(chan chan struct{}),
poll: make(chan time.Time),
deviceMap: make(map[string]DeviceModel),
nextOrder: make(map[string]int),
retainMap: make(map[string]bool),
controlList: make(map[string][]string),
topics: make(map[string]*driverTopic),
autoPoll: true,
pollInterval: DEFAULT_POLL_INTERVAL,
}
drv.whenReady = NewDeferredList(drv.CallSync)
drv.model.Observe(drv)
return
}
func (drv *Driver) SetAutoPoll(autoPoll bool) {
drv.autoPoll = autoPoll
}
func (drv *Driver) AutoPoll() bool {
return drv.autoPoll
}
func (drv *Driver) SetPollInterval(pollInterval time.Duration) {
drv.pollInterval = pollInterval
}
func (drv *Driver) PollInterval() time.Duration {
return drv.pollInterval
}
func (drv *Driver) Poll() {
drv.poll <- time.Now()
}
func (drv *Driver) addCleanupTopic(topic string) {
for _, v := range drv.cleanupTopics {
if v == topic {
return
}
}
drv.cleanupTopics = append(drv.cleanupTopics, topic)
}
func (drv *Driver) performCleanup() {
for _, topic := range drv.cleanupTopics {
drv.client.PublishSync(MQTTMessage{topic, "", 1, true})
}
}
func (drv *Driver) topic(dev DeviceModel, sub ...string) string {
parts := append(append([]string(nil), "/devices", dev.Name()), sub...)
return strings.Join(parts, "/")
}
func (drv *Driver) controlTopic(dev DeviceModel, controlName string, sub ...string) string {
parts := append(append([]string(nil), "controls", controlName), sub...)
return drv.topic(dev, parts...)
}
func (drv *Driver) publish(topic, payload string, qos byte, retain bool) {
drv.client.Publish(MQTTMessage{topic, payload, qos, retain})
}
func (drv *Driver) publishMeta(topic string, payload string) {
drv.publish(topic, payload, 1, true)
drv.addCleanupTopic(topic)
}
func (drv *Driver) publishValue(dev DeviceModel, controlName, value string) {
topic := drv.controlTopic(dev, controlName)
retain := drv.retainMap[topic]
drv.publish(topic, value, 1, retain)
}
func (drv *Driver) publishOnValue(dev DeviceModel, controlName, value string) {
drv.client.Publish(MQTTMessage{
drv.controlTopic(dev, controlName) + "/on",
value,
1,
false,
})
}
func (drv *Driver) clearTopicDevCache() {
for _, drvTopic := range drv.topics {
drvTopic.resetDevice()
}
}
func (drv *Driver) RemoveDevice(dev DeviceModel) {
drv.clearTopicDevCache()
name := dev.Name()
dev, found := drv.deviceMap[name]
if !found {
return
}
_, ok := dev.(LocalDeviceModel)
if ok {
for _, controlName := range drv.controlList[name] {
drv.client.Unsubscribe(drv.controlTopic(dev, controlName, "on"))
}
}
delete(drv.deviceMap, name)
delete(drv.nextOrder, name)
delete(drv.controlList, name)
}
func (drv *Driver) OnNewDevice(dev DeviceModel) {
drv.clearTopicDevCache()
drv.RemoveDevice(dev)
drv.deviceMap[dev.Name()] = dev
if _, ext := dev.(ExternalDeviceModel); !ext {
Debug.Printf("driver: new local device: %s", dev.Name())
// this overrides a possibly created external device with same name
drv.nextOrder[dev.Name()] = 1
drv.controlList[dev.Name()] = make([]string, 0, CONTROL_LIST_CAPACITY)
drv.publishMeta(drv.topic(dev, "meta", "name"), dev.Title())
} else {
Debug.Printf("driver: new remote device: %s", dev.Name())
}
dev.Observe(drv)
}
// var XXXStopIt = false
// wrapMessageHandler wraps the message function so that it's run in
// the driver's primary goroutine
func (drv *Driver) wrapMessageHandler(handler MQTTMessageHandler) MQTTMessageHandler {
return func(msg MQTTMessage) {
// if XXXStopIt {
// return //////
// }
drv.HandleMessageSync(func() {
handler(msg)
})
}
}
func (drv *Driver) subscribe(handler MQTTMessageHandler, topics ...string) {
drv.client.Subscribe(drv.wrapMessageHandler(handler), topics...)
}
func (drv *Driver) OnNewControl(dev LocalDeviceModel, control Control) string {
Debug.Printf("new control for %s: %#v", dev.Name(), control)
controlTopic := drv.controlTopic(dev, control.Name)
value := control.Value
if drv.active && dev.IsVirtual() && control.Retain() {
// keep value in the case of new virtual device definition in the running driver
drvTopic, found := drv.topics[controlTopic]
if found {
value = drvTopic.ReceivedValue
}
}
devName := dev.Name()
nextOrder := 0
if control.Order > 0 {
nextOrder = control.Order
} else {
nextOrder = drv.nextOrder[devName]
}
drv.publishMeta(drv.controlTopic(dev, control.Name, "meta", "type"), control.GetType())
// FIXME: tests
if control.Title != "" {
drv.publishMeta(drv.controlTopic(dev, control.Name, "meta", "name"), control.Title)
}
if control.GetUnits() != "" {
// FIXME: tests
drv.publishMeta(drv.controlTopic(dev, control.Name, "meta", "units"), control.GetUnits())
}
// FIXME: tests
switch control.Writability {
case ForceReadOnly:
drv.publishMeta(drv.controlTopic(dev, control.Name, "meta", "readonly"), "1")
case ForceWritable:
drv.publishMeta(drv.controlTopic(dev, control.Name, "meta", "writable"), "1")
}
drv.publishMeta(drv.controlTopic(dev, control.Name, "meta", "order"), strconv.Itoa(nextOrder))
if control.HasMax {
drv.publishMeta(drv.controlTopic(dev, control.Name, "meta", "max"), fmt.Sprintf("%v", control.Max))
}
if nextOrder >= drv.nextOrder[devName] {
drv.nextOrder[devName] = nextOrder + 1
}
drv.retainMap[controlTopic] = control.Retain()
if control.Retain() {
// non-retained controls are used for buttons
drv.publishValue(dev, control.Name, value)
}
// XXX: look at the control type
if control.Writability != ForceReadOnly {
Debug.Printf("subscribe to: %s", drv.controlTopic(dev, control.Name, "on"))
drv.subscribe(
drv.handleIncomingControlOnValue,
drv.controlTopic(dev, control.Name, "on"))
}
drv.controlList[devName] = append(drv.controlList[devName], control.Name)
drv.addCleanupTopic(drv.controlTopic(dev, control.Name))
return value
}
func (drv *Driver) OnValue(dev DeviceModel, controlName, value string) {
if _, ext := dev.(ExternalDeviceModel); ext {
drv.publishOnValue(dev, controlName, value)
} else {
drv.publishValue(dev, controlName, value)
}
}
func (drv *Driver) OnError(dev DeviceModel, controlName, value string) {
drv.publishMeta(drv.controlTopic(dev, controlName, "meta", "error"), value)
}
func (drv *Driver) ensureDevice(deviceName string) (DeviceModel, error) {
dev, found := drv.deviceMap[deviceName]
if found {
return dev, nil
}
if !drv.acceptsExternalDevices {
return nil, fmt.Errorf("unknown device: %s", deviceName)
}
extModel := drv.model.(ExtendedModel)
if dev, err := extModel.AddExternalDevice(deviceName); err != nil {
return nil, err
} else {
drv.deviceMap[deviceName] = dev
return dev, nil
}
}
func (drv *Driver) ensureExtDevice(deviceName string) (ExternalDeviceModel, error) {
dev, err := drv.ensureDevice(deviceName)
if err != nil {
return nil, err
}
if extDev, ok := dev.(ExternalDeviceModel); ok {
return extDev, nil
}
return nil, nil
}
func (drv *Driver) handleIncomingControlOnValue(msg MQTTMessage) {
// /devices/<name>/controls/<control>/on
if DebuggingEnabled() {
Debug.Printf("handleIncomingMQTTValue() topic: %s", msg.Topic)
Debug.Printf("MSG: %s\n", msg.Payload)
}
parts := strings.Split(msg.Topic, "/")
deviceName := parts[2]
controlName := parts[4]
dev, found := drv.deviceMap[deviceName]
if !found {
Error.Printf("UNKNOWN DEVICE: %s", deviceName)
return
}
if dev.(LocalDeviceModel).AcceptOnValue(controlName, msg.Payload) {
drv.publishValue(dev, controlName, msg.Payload)
}
}
func (drv *Driver) handleDeviceTitle(msg MQTTMessage) {
deviceName := strings.Split(msg.Topic, "/")[2]
dev, err := drv.ensureExtDevice(deviceName)
if err != nil {
Warn.Printf("Not registering external device %s: %s", deviceName, err)
}
if dev != nil { // nil would mean a local device
dev.SetTitle(msg.Payload)
}
}
func (drv *Driver) handleIncomingControlValue(msg MQTTMessage) {
// /devices/<name>/controls/<control>
drvTopic := drv.topics[msg.Topic]
if drvTopic == nil {
parts := strings.Split(msg.Topic, "/")
drvTopic = &driverTopic{
ReceivedValue: msg.Payload,
DeviceName: parts[2],
ControlName: parts[4],
Ready: drv.ready,
Skip: false,
}
drv.topics[msg.Topic] = drvTopic
} else {
drvTopic.ReceivedValue = msg.Payload
}
if drvTopic.Dev == nil || drvTopic.Ready != drv.ready {
drvTopic.Ready = drv.ready
var err error
if drv.ready {
drvTopic.Dev, err = drv.ensureExtDevice(drvTopic.DeviceName)
} else {
// not ready yet - may accept retained values for local devices
drvTopic.Dev, err = drv.ensureDevice(drvTopic.DeviceName)
}
if err != nil {
Error.Printf("Cannot register external device %s: %s", drvTopic.DeviceName, err)
}
if drvTopic.Dev == nil { // nil means no devices are currently ready to accept the value
return
}
localDev, ok := drvTopic.Dev.(LocalDeviceModel)
// devices that are connected to hardware must not pick up retained values
drvTopic.Skip = ok && !localDev.IsVirtual()
}
if !drvTopic.Skip {
drvTopic.Dev.AcceptValue(drvTopic.ControlName, msg.Payload)
}
}
func (drv *Driver) handleExternalControlType(msg MQTTMessage) {
// /devices/<name>/controls/<control>
parts := strings.Split(msg.Topic, "/")
deviceName := parts[2]
controlName := parts[4]
dev, err := drv.ensureExtDevice(deviceName)
if err != nil {
Error.Printf("Cannot register external device %s: %s", deviceName, err)
}
if dev != nil { // nil would mean a local device
dev.AcceptControlType(controlName, msg.Payload)
}
}
func (drv *Driver) handleExternalControlMax(msg MQTTMessage) {
// /devices/<name>/controls/<control>/meta/max
parts := strings.Split(msg.Topic, "/")
deviceName := parts[2]
controlName := parts[4]
dev, err := drv.ensureExtDevice(deviceName)
if err != nil {
Error.Printf("Cannot register external device %s: %s", deviceName, err)
return
}
if dev == nil { // nil would mean a local device
return
}
max, err := strconv.ParseFloat(msg.Payload, 64)
if err != nil {
Error.Printf("Cannot parse max value for device %s control %s", deviceName, controlName)
return
}
dev.AcceptControlRange(controlName, max)
}
func (drv *Driver) AcceptsExternalDevices() bool {
return drv.acceptsExternalDevices
}
func (drv *Driver) SetAcceptsExternalDevices(accepts bool) {
if drv.active {
panic("trying to do SetAcceptsExternalDevices() on an active driver")
}
drv.acceptsExternalDevices = accepts
}
func (drv *Driver) CallSync(thunk func()) {
drv.eventCh <- thunk
}
func (drv *Driver) HandleMessageSync(thunk func()) {
drv.handleMessageCh <- thunk
}
func (drv *Driver) WhenReady(thunk func()) {
drv.whenReady.MaybeDefer(thunk)
}
func (drv *Driver) Start() error {
if drv.active {
return nil
}
drv.active = true
drv.client.Start()
if err := drv.model.Start(); err != nil {
return err
}
var ticker *time.Ticker
var pollChannel <-chan time.Time = drv.poll
if drv.autoPoll {
ticker = time.NewTicker(drv.pollInterval)
pollChannel = ticker.C
}
if drv.acceptsExternalDevices {
drv.subscribe(drv.handleDeviceTitle, "/devices/+/meta/name")
drv.subscribe(drv.handleIncomingControlValue, "/devices/+/controls/+")
drv.subscribe(drv.handleExternalControlType, "/devices/+/controls/+/meta/type")
drv.subscribe(drv.handleExternalControlMax, "/devices/+/controls/+/meta/max")
}
go func() {
readyCh := drv.client.WaitForReady()
for {
select {
case <-readyCh:
drv.whenReady.Ready()
readyCh = nil
drv.ready = true
case quitCh := <-drv.quit:
if ticker != nil {
ticker.Stop()
}
drv.model.Stop()
drv.client.Stop()
close(quitCh)
return
case <-pollChannel:
drv.model.Poll()
case f := <-drv.handleMessageCh:
f()
case f := <-drv.eventCh:
f()
}
}
}()
return nil
}
func (drv *Driver) Stop() {
if !drv.active {
return
}
drv.active = false
Debug.Printf("Driver.Stop()")
drv.performCleanup()
ch := make(chan struct{})
drv.quit <- ch
<-ch
}