-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy patheebus.puml
395 lines (326 loc) · 26.1 KB
/
eebus.puml
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
@startuml
namespace go_eebus {
class EebusNode << (S,Aquamarine) >> {
- isGateway bool
+ SpineNode *spine.SpineNode
+ DeviceStructure *resources.DeviceModel
+ Update Updater
+ SubscriptionNofity(datagram resources.DatagramType, conn spine.SpineConnection)
+ Start()
}
class go_eebus.Updater << (T, #FF7700) >> {
}
class "<font color=blue>func</font>(resources.DatagramType, spine.SpineConnection) " as fontcolorbluefuncfontresourcesDatagramTypespineSpineConnection {
'This class was created so that we can correctly have an alias pointing to this name. Since it contains dots that can break namespaces
}
}
namespace resources {
class BindSubscribeEntry << (S,Aquamarine) >> {
+ ClientAddress FeatureAddressType
+ ServerAddress FeatureAddressType
}
class BindingManagementRequestCallType << (S,Aquamarine) >> {
+ ClientAddress *FeatureAddressType
+ ServerAddress *FeatureAddressType
+ ServerFeatureType string
}
class CmdType << (S,Aquamarine) >> {
+ FunctionName string
+ Function string
}
class ComissioningNewSkis << (S,Aquamarine) >> {
+ Skis string
+ Devices string
}
class DatagramType << (S,Aquamarine) >> {
+ Header *HeaderType
+ Payload *PayloadType
}
class DescriptionElement << (S,Aquamarine) >> {
+ Label string
+ Description string
}
class DeviceAddressType << (S,Aquamarine) >> {
+ Device string
}
class DeviceModel << (S,Aquamarine) >> {
+ DeviceType string
+ DeviceAddress string
+ Description string
+ Entities []*EntityModel
+ CreateNodeManagement(isGateway bool) *FeatureModel
+ MakeHeader(entity int, feature int, addressDestination *FeatureAddressType, cmdClassifier string, msgCounter int, ackRequest bool) *HeaderType
}
class EntityAddressType << (S,Aquamarine) >> {
+ Device string
+ Entity int
}
class EntityModel << (S,Aquamarine) >> {
+ EntityType string
+ EntityAddress int
+ Description string
+ Features []*FeatureModel
}
class FeatureAddressType << (S,Aquamarine) >> {
+ Device string
+ Entity int
+ Feature int
}
class FeatureModel << (S,Aquamarine) >> {
+ FeatureType string
+ FeatureAddress int
+ Role string
+ Description string
+ Functions []*FunctionModel
+ BindingTo []string
+ SubscriptionTo []string
+ MaxBindings int
+ MaxSubscriptions int
}
class FunctionElement << (S,Aquamarine) >> {
+ Function string
}
class FunctionModel << (S,Aquamarine) >> {
+ FunctionName string
+ ChangeNotify Notifier
+ Function <font color=blue>interface</font>{}
}
class FunctionPropertyType << (S,Aquamarine) >> {
+ Function string
+ PossibleOperations string
}
class HeaderType << (S,Aquamarine) >> {
+ SpecificationVersion string
+ AddressSource *FeatureAddressType
+ AddressDestination *FeatureAddressType
+ MsgCounter int
+ CmdClassifier string
+ Timestamp string
+ AckRequest bool
}
class MeasurementDataType << (S,Aquamarine) >> {
+ ValueType string
+ Timestamp string
+ Value float64
+ EvaluationPeriod TimePeriodType
+ ValueSource string
+ ValueTendency string
+ ValueState string
}
class MeasurementDescriptionDataType << (S,Aquamarine) >> {
+ MeasurementType string
+ Unit string
+ ScopeType string
+ Label string
+ Description string
}
class NetworkManagementDeviceDescriptionDataType << (S,Aquamarine) >> {
+ DeviceAddress *DeviceAddressType
+ DeviceType string
+ Description string
}
class NetworkManagementEntityDescritpionDataType << (S,Aquamarine) >> {
+ EntityAddress *EntityAddressType
+ EntityType string
+ Description string
}
class NetworkManagementFeatureInformationType << (S,Aquamarine) >> {
+ FeatureAddress *FeatureAddressType
+ FeatureType string
+ Role string
+ SupportedFunction *FunctionPropertyType
+ Description string
}
class NodeManagementBindingData << (S,Aquamarine) >> {
+ BindingEntries []*BindSubscribeEntry
}
class NodeManagementBindingRequestCall << (S,Aquamarine) >> {
+ BindingRequest *BindingManagementRequestCallType
}
class NodeManagementDetailedDiscovery << (S,Aquamarine) >> {
+ SpecificationVersionList []*NodeManagementSpecificationVersionListType
+ DeviceInformation *NodeManagementDetailedDiscoveryDeviceInformationType
+ EntityInformation []*NodeManagementDetailedDiscoveryEntityInformationType
+ FeatureInformation []*NodeManagementDetailedDiscoveryFeatureInformationType
}
class NodeManagementDetailedDiscoveryDeviceInformationType << (S,Aquamarine) >> {
+ Description *NetworkManagementDeviceDescriptionDataType
}
class NodeManagementDetailedDiscoveryEntityInformationType << (S,Aquamarine) >> {
+ Description *NetworkManagementEntityDescritpionDataType
}
class NodeManagementDetailedDiscoveryFeatureInformationType << (S,Aquamarine) >> {
+ Description *NetworkManagementFeatureInformationType
}
class NodeManagementSpecificationVersionListType << (S,Aquamarine) >> {
+ SpecificationVersion string
}
class NodeManagementSubscriptionData << (S,Aquamarine) >> {
+ SubscriptionEntries []*BindSubscribeEntry
}
class NodeManagementSubscriptionRequestCall << (S,Aquamarine) >> {
+ SubscriptionRequest *SubscriptionManagementRequestCallType
}
class PayloadType << (S,Aquamarine) >> {
+ Cmd *CmdType
}
class ResultElement << (S,Aquamarine) >> {
+ ErrorNumber int
+ Description string
}
class SubscriptionManagementRequestCallType << (S,Aquamarine) >> {
+ ClientAddress *FeatureAddressType
+ ServerAddress *FeatureAddressType
+ ServerFeatureType string
}
class TimePeriodType << (S,Aquamarine) >> {
+ StartTime string
+ EndTime string
}
class resources.Notifier << (T, #FF7700) >> {
}
}
namespace ship {
class CmiMessage << (S,Aquamarine) >> {
+ MessageType int
+ MessageValue int
}
class DataValue << (S,Aquamarine) >> {
+ Header HeaderType
+ Payload resources.DatagramType
}
class HeaderType << (S,Aquamarine) >> {
+ ProtocollId string
}
class Message << (S,Aquamarine) >> {
+ MessageType int
+ MessageValue DataValue
}
class Request << (S,Aquamarine) >> {
+ Path string
+ Id string
+ Ski string
}
class SMEInstance << (S,Aquamarine) >> {
- role string
- connectionState string
- closeHandler CloseHandler
+ Connection *websocket.Conn
+ Ski string
+ RecieveTimeout(seconds int) []byte
+ StartCMI()
+ RecieveOnce(handleFunc handler)
+ Recieve(handleFunc dataHandler)
+ Send(payload resources.DatagramType)
}
class ShipNode << (S,Aquamarine) >> {
- serverPort int
- hostname string
- devId string
- brand string
- devType string
+ IsGateway bool
+ SME []*SMEInstance
+ Requests []*Request
+ SpineConnectionNotify ConnectionManagerSpine
+ SpineCloseHandler CloseHandler
+ CertName string
- getSki() string
- handleFoundService(entry *zeroconf.ServiceEntry)
- newConnection(role string, conn *websocket.Conn, ski string)
+ BrowseDns()
+ RegisterDns()
+ Start()
+ Connect(service string, ski string)
+ StartServer()
}
class ship.CloseHandler << (T, #FF7700) >> {
}
class ship.ConnectionManager << (T, #FF7700) >> {
}
class ship.ConnectionManagerSpine << (T, #FF7700) >> {
}
class ship.dataHandler << (T, #FF7700) >> {
}
class ship.handler << (T, #FF7700) >> {
}
class "<font color=blue>func</font>(resources.DatagramType) " as fontcolorbluefuncfontresourcesDatagramType {
'This class was created so that we can correctly have an alias pointing to this name. Since it contains dots that can break namespaces
}
class "<font color=blue>func</font>(string, *websocket.Conn) " as fontcolorbluefuncfontstringwebsocketConn {
'This class was created so that we can correctly have an alias pointing to this name. Since it contains dots that can break namespaces
}
}
namespace spine {
class BindSubscribe << (S,Aquamarine) >> {
+ Conn *SpineConnection
+ BindSubscribeEntry *resources.BindSubscribeEntry
+ Send(payload *resources.PayloadType)
}
class BindSubscribeInfo << (S,Aquamarine) >> {
+ BindSubscribe string
+ BindSubscribeEntry *resources.BindSubscribeEntry
}
class Feature << (S,Aquamarine) >> {
+ EntityType string
+ FeatureType string
+ FeatureAddress resources.FeatureAddressType
+ FunctionName string
+ CurrentState string
}
class SpineConnection << (S,Aquamarine) >> {
- recieveChan <font color=blue>chan</font> resources.DatagramType
- bindSubscribeNotify BindSubscribeNotify
- bindSubscribeInfo []*BindSubscribeInfo
+ SME *ship.SMEInstance
+ Address string
+ MsgCounter int
+ OwnDevice *resources.DeviceModel
+ DiscoveryInformation *resources.NodeManagementDetailedDiscovery
+ SubscriptionNofity Notifier
+ Features []*Feature
- sendBindingRequest(EntityAddress int, FeatureAddress int, DestinationAddr *resources.FeatureAddressType, FeatureType string)
- processBindingRequest(datagram *resources.DatagramType)
- requestAllowed(bindSubscribe string, header *resources.HeaderType) bool
- sendSubscriptionRequest(EntityAddress int, FeatureAddress int, DestinationAddr *resources.FeatureAddressType, FeatureType string)
- processSubscriptionRequest(datagram *resources.DatagramType)
+ SendXML(header *resources.HeaderType, payload *resources.PayloadType)
+ StartRecieveHandler()
+ RecieveTimeout(seconds int) (resources.DatagramType, bool)
+ CountBindings(serverAddr resources.FeatureAddressType) int
+ CountSubscriptions(serverAddr resources.FeatureAddressType) int
+ StartDetailedDiscovery()
}
class SpineNode << (S,Aquamarine) >> {
+ ShipNode *ship.ShipNode
+ Connections []*SpineConnection
+ DeviceStructure *resources.DeviceModel
+ Bindings []*BindSubscribe
+ Subscriptions []*BindSubscribe
+ SubscriptionNofity Notifier
- newConnection(SME *ship.SMEInstance, newSki string)
- newBindSubscribe(bindSubscribe string, conn *SpineConnection, entry *resources.BindSubscribeEntry)
- closeHandler(SME *ship.SMEInstance)
+ Start()
}
class spine.BindSubscribeNotify << (T, #FF7700) >> {
}
class spine.Notifier << (T, #FF7700) >> {
}
class "<font color=blue>func</font>(resources.DatagramType, SpineConnection) " as fontcolorbluefuncfontresourcesDatagramTypeSpineConnection {
'This class was created so that we can correctly have an alias pointing to this name. Since it contains dots that can break namespaces
}
class "<font color=blue>func</font>(string, *SpineConnection, *resources.BindSubscribeEntry) " as fontcolorbluefuncfontstringSpineConnectionresourcesBindSubscribeEntry {
'This class was created so that we can correctly have an alias pointing to this name. Since it contains dots that can break namespaces
}
}
"go_eebus.fontcolorbluefuncfontresourcesDatagramTypespineSpineConnection" #.. "go_eebus.Updater"
"resources.<font color=blue>func</font>(string, string, FeatureAddressType) " #.. "resources.Notifier"
"ship.<font color=blue>func</font>(*SMEInstance) " #.. "ship.CloseHandler"
"ship.<font color=blue>func</font>(*SMEInstance, string) " #.. "ship.ConnectionManagerSpine"
"ship.<font color=blue>func</font>([]byte) " #.. "ship.handler"
"ship.fontcolorbluefuncfontresourcesDatagramType" #.. "ship.dataHandler"
"ship.fontcolorbluefuncfontstringwebsocketConn" #.. "ship.ConnectionManager"
"spine.fontcolorbluefuncfontresourcesDatagramTypeSpineConnection" #.. "spine.Notifier"
"spine.fontcolorbluefuncfontstringSpineConnectionresourcesBindSubscribeEntry" #.. "spine.BindSubscribeNotify"
@enduml