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 | ###############################################################################
# Copyright (c) 2020-2024 by Altair Engineering, Inc.
# All rights reserved.
#
# Altair Engineering, Inc. makes this software available as part of the Vision
# tool platform. As long as you are a licensee of the Vision tool platform
# you may make copies of the software and modify it to be used within the
# Vision tool platform, but you must include all of this notice on any copy.
# Redistribution without written permission to any third party, with or
# without modification, is not permitted.
# Altair Engineering, Inc. does not warrant that this software is error free
# or fit for any purpose. Altair Engineering, Inc. disclaims any liability for
# all claims, expenses, losses, damages and costs any user may incur as a
# result of using, copying or modifying the software.
# =============================================================================
# @plugin
# Send Skill Commands To Skill Server
# @namespace
# SkillClient
# @section
# Miscellaneous Userware Examples
# @description
# Send skill commands to skill server.
# Configure host name and port number to match the skill server.
# The Skill server script needs to be loaded into the Cadence Virtuoso
# environment.
# @configuration
# @files
# skill/skillClient.tcl
# @cmdline
# -userware @files[0]
# @tag
# gui skill
###############################################################################
# -----------------------------------------------------------------------------
# socket
# -----------------------------------------------------------------------------
#
set SkillClient(socket) ""
# =============================================================================
# Init - Initialize the plugin
# =============================================================================
#
proc SkillClient:Init {} {
global env
##
# The port number must match with skillServer.tcl
#
if {[info exists env(SKILLSERVPORT)]} {
set port $env(SKILLSERVPORT)
} else {
set port 8123
}
##
# Set config options
#
gui plugin addConfig SkillClient host "localhost" text \
"Hostname of skill server."
gui plugin addConfig SkillClient port $port number \
"Port number of skill server."
zmessage print DBG "SkillClient:Init"
}
# =============================================================================
# Finit - Finalize the plugin
# =============================================================================
#
proc SkillClient:Finit {} {
global SkillClient
SkillClient:_closeSocket
array unset SkillClient
}
# -----------------------------------------------------------------------------
# _collectResult - Get result from skill server
# -----------------------------------------------------------------------------
#
proc SkillClient:_collectResult {} {
global SkillClient
zmessage print DBG "_collectResult"
if {$SkillClient(socket) ne ""} {
if {[eof $SkillClient(socket)]} {
SkillClient:_closeSocket
zmessage print DBG "->closed"
set SkillClient(result) ""
set SkillClient(end) closed
} else {
set SkillClient(result) [gets $SkillClient(socket)]
zmessage print DBG "->$SkillClient(result)"
if {$SkillClient(result) != {}} {
set SkillClient(end) ok
}
}
}
}
# =============================================================================
# SendCommand - Send command to skill server
# =============================================================================
#
proc SkillClient:SendCommand {command {timeoutMsec 5000}} {
global SkillClient
set result {}
##
# Connect to server.
#
if {$SkillClient(socket) eq ""} {
SkillClient:_openSocket
}
if {$SkillClient(socket) ne ""} {
if {[catch {
zmessage print DBG \
"SkillClient:SendCommand $SkillClient(socket) '$command'"
set SkillClient(end) {}
set SkillClient(result) ""
set id [after $timeoutMsec {set SkillClient(end) timeout}]
puts $SkillClient(socket) $command
flush $SkillClient(socket)
vwait SkillClient(end)
zmessage print DBG \
"SkillClient:SendCommand vwait ended $SkillClient(end)"
after cancel $id
if {$SkillClient(end) != "ok"} {
zmessage print ERR\
"Problem sending '$command' ($SkillClient(end))"
} elseif {[string match {ERROR *} $SkillClient(result)]} {
zmessage print ERR "Skill $SkillClient(result)"
} else {
zmessage print DBG "Got result=$SkillClient(result)"
if {([string index $SkillClient(result) 0] == {"}) &&
([string index $SkillClient(result) end] == {"})} {
set SkillClient(result) \
[string range $SkillClient(result) 1 end-1]
}
set result $SkillClient(result)
}
} err]} {
zmessage print ERR "Problem sending '$command' ($err)"
}
}
return $result
}
# -----------------------------------------------------------------------------
# _openSocket - connect to server
# -----------------------------------------------------------------------------
#
proc SkillClient:_openSocket {} {
global SkillClient
set host [gui plugin getConfigValue SkillClient host]
set port [gui plugin getConfigValue SkillClient port]
if {[catch {
zmessage print DBG "SkillClient:_openSocket $host $port"
set SkillClient(socket) [socket $host $port]
chan configure $SkillClient(socket) -blocking 0 -translation crlf \
-buffering line
chan event $SkillClient(socket) readable {
SkillClient:_collectResult
}
zmessage print DBG "--> $SkillClient(socket)"
} err]} {
zmessage print ERR "Cannot connect to '$host' port $port ($err)"
}
}
# -----------------------------------------------------------------------------
# _closeSocket - close disconnect from server
# -----------------------------------------------------------------------------
#
proc SkillClient:_closeSocket {} {
global SkillClient
if {$SkillClient(socket) ne ""} {
zmessage print DBG "SkillClient:_closeSocket $SkillClient(socket)"
chan event $SkillClient(socket) readable {
}
close $SkillClient(socket)
set SkillClient(socket) ""
}
}
# =============================================================================
# Call the initialization procedure
# =============================================================================
#
SkillClient:Init
|