@synefex/node-red-sila2 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +36 -0
- package/LICENSE +201 -0
- package/NOTICE +24 -0
- package/README.md +119 -0
- package/package.json +56 -0
- package/protos/SiLAFramework.proto +132 -0
- package/protos/SiLAService.proto +81 -0
- package/src/call-command/sila-call-command.html +137 -0
- package/src/call-command/sila-call-command.js +110 -0
- package/src/connection/sila-connection.html +101 -0
- package/src/connection/sila-connection.js +148 -0
- package/src/get-property/sila-get-property.html +125 -0
- package/src/get-property/sila-get-property.js +114 -0
- package/src/lib/client.js +216 -0
- package/src/lib/picker/picker.js +174 -0
- package/src/lib/unwrap.js +35 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Changelog -- @synefex/node-red-sila2
|
|
2
|
+
|
|
3
|
+
Format: [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
|
|
4
|
+
Versioning: [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
5
|
+
|
|
6
|
+
## [0.1.0] - 2026-05-11 (preparing)
|
|
7
|
+
|
|
8
|
+
First public release.
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
- `sila-connection` config node: long-lived gRPC channel + bundled proto
|
|
12
|
+
registry, with optional extra proto dirs/files for additional features.
|
|
13
|
+
- `sila-call-command` action node: invoke an unobservable SiLA 2 command
|
|
14
|
+
on any loaded feature; auto-unwraps the SiLA 2 basic-type response
|
|
15
|
+
wrappers.
|
|
16
|
+
- `sila-get-property` action node: read an unobservable SiLA 2 property
|
|
17
|
+
(`Get_<Name>`) with optional single-field unwrap.
|
|
18
|
+
- Bundled protos: `SiLAFramework.proto` (canonical) and `SiLAService.proto`
|
|
19
|
+
(hand-derived from the FDL) so the mandatory core feature works
|
|
20
|
+
zero-config.
|
|
21
|
+
- Editor picker: cascading Feature -> Command/Property dropdowns backed
|
|
22
|
+
by `GET /sila/conn/:id/features`, classifying methods by SiLA 2 naming
|
|
23
|
+
convention (`Get_*` -> property, otherwise command).
|
|
24
|
+
- Apache-2.0 licensing.
|
|
25
|
+
- Unit tests for the SiLA 2 basic-type unwrap helper and per-node load
|
|
26
|
+
tests via `node-red-node-test-helper`.
|
|
27
|
+
|
|
28
|
+
### Notes
|
|
29
|
+
- This release uses static proto loading via `@grpc/proto-loader`, not
|
|
30
|
+
gRPC reflection. SiLA 2 servers vary in reflection support; static
|
|
31
|
+
loading works against all of them.
|
|
32
|
+
- Observable commands and observable property subscriptions are not yet
|
|
33
|
+
supported. Roadmap items.
|
|
34
|
+
- Pinned-cert TLS is not yet supported. Insecure (no TLS) and default-
|
|
35
|
+
trust TLS are available; production users should provide explicit
|
|
36
|
+
root certs.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for describing the origin of the Work and
|
|
141
|
+
reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may accept and charge a
|
|
167
|
+
fee for, acceptance of support, warranty, indemnity, or other
|
|
168
|
+
liability obligations and/or rights consistent with this License.
|
|
169
|
+
However, in accepting such obligations, You may act only on Your
|
|
170
|
+
own behalf and on Your sole responsibility, not on behalf of any
|
|
171
|
+
other Contributor, and only if You agree to indemnify, defend, and
|
|
172
|
+
hold each Contributor harmless for any liability incurred by, or
|
|
173
|
+
claims asserted against, such Contributor by reason of your accepting
|
|
174
|
+
any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 Wiens Synefex GmbH
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
200
|
+
implied. See the License for the specific language governing permissions
|
|
201
|
+
and limitations under the License.
|
package/NOTICE
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
@synefex/node-red-sila
|
|
2
|
+
Copyright 2026 Wiens Synefex GmbH
|
|
3
|
+
|
|
4
|
+
This product is licensed under the Apache License, Version 2.0.
|
|
5
|
+
You may obtain a copy of the License in the accompanying LICENSE file
|
|
6
|
+
or at http://www.apache.org/licenses/LICENSE-2.0.
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
This package bundles the canonical SiLA 2 framework protobuf definition
|
|
11
|
+
in `protos/SiLAFramework.proto`, copied from sila_base:
|
|
12
|
+
|
|
13
|
+
sila_base
|
|
14
|
+
https://gitlab.com/SiLA2/sila_base
|
|
15
|
+
Copyright the SiLA Consortium contributors
|
|
16
|
+
Licensed under the Apache License, Version 2.0
|
|
17
|
+
|
|
18
|
+
The bundled `protos/SiLAService.proto` is a hand-derived translation of
|
|
19
|
+
the SiLAService Feature Definition (SiLAService.sila.xml) from sila_base
|
|
20
|
+
into gRPC proto3 form. It carries the same Apache License, Version 2.0.
|
|
21
|
+
|
|
22
|
+
Runtime dependencies (`@grpc/grpc-js`, `@grpc/proto-loader`, transitive
|
|
23
|
+
`protobufjs`, etc.) are pulled in by `npm install` and carry their own
|
|
24
|
+
licenses; see the LICENSE files distributed under `node_modules/`.
|
package/README.md
ADDED
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
# @synefex/node-red-sila2
|
|
2
|
+
|
|
3
|
+
Node-RED nodes for talking to **SiLA 2** lab-device servers from
|
|
4
|
+
Node-RED. SiLA 2 is the open standard for lab automation, layering a
|
|
5
|
+
Feature / Command / Property contract on top of gRPC over HTTP/2.
|
|
6
|
+
|
|
7
|
+
This package gives you a connection node and two action nodes built on
|
|
8
|
+
`@grpc/grpc-js` and `@grpc/proto-loader`. Static proto loading (not
|
|
9
|
+
reflection) so it works against every SiLA 2 server, regardless of
|
|
10
|
+
implementation language.
|
|
11
|
+
|
|
12
|
+
[](https://www.npmjs.com/package/@synefex/node-red-sila2)
|
|
13
|
+
[](LICENSE)
|
|
14
|
+
|
|
15
|
+
## Install
|
|
16
|
+
|
|
17
|
+
In your Node-RED userDir (typically `~/.node-red/`):
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npm install @synefex/node-red-sila2
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Restart Node-RED. Three new nodes appear in the palette under the
|
|
24
|
+
`Synefex SiLA 2` section.
|
|
25
|
+
|
|
26
|
+
## Nodes
|
|
27
|
+
|
|
28
|
+
| Node | Purpose |
|
|
29
|
+
|---|---|
|
|
30
|
+
| `sila-connection` | gRPC channel + bundled proto registry. Config node. |
|
|
31
|
+
| `sila-call-command` | Invoke an unobservable SiLA 2 command on a feature. |
|
|
32
|
+
| `sila-get-property` | Read an unobservable SiLA 2 property (`Get_<Name>`). |
|
|
33
|
+
|
|
34
|
+
## Quick start
|
|
35
|
+
|
|
36
|
+
1. Drop a **SiLA 2 connection** config node and point it at your SiLA 2
|
|
37
|
+
server (host + port). Leave **Insecure** ticked for a dev server
|
|
38
|
+
without TLS.
|
|
39
|
+
2. Wire an **inject -> SiLA 2 get -> debug** flow.
|
|
40
|
+
3. In the SiLA 2 get node:
|
|
41
|
+
- Connection: the one you just made
|
|
42
|
+
- Feature: `SiLAService`
|
|
43
|
+
- Property: `ServerName`
|
|
44
|
+
4. Deploy and click inject. `payload` becomes the server's name string,
|
|
45
|
+
e.g. `"MettlerToledoAX205SiLAServer"`.
|
|
46
|
+
|
|
47
|
+
For commands, use **SiLA 2 call** instead. The bundled SiLAService feature
|
|
48
|
+
exposes `GetFeatureDefinition` and `SetServerName`; for domain features
|
|
49
|
+
(balances, liquid handlers, etc.) you bring your own `.proto` files (see
|
|
50
|
+
"Adding more features" below).
|
|
51
|
+
|
|
52
|
+
## Bundled features
|
|
53
|
+
|
|
54
|
+
The package always loads two `.proto` files from `protos/`:
|
|
55
|
+
|
|
56
|
+
- `SiLAFramework.proto` -- canonical wrapper types (`String`, `Real`,
|
|
57
|
+
`Boolean`, ...) used by every SiLA 2 feature.
|
|
58
|
+
- `SiLAService.proto` -- the mandatory core feature every SiLA 2 server
|
|
59
|
+
implements (`ServerName`, `ServerType`, `ServerUUID`,
|
|
60
|
+
`ServerDescription`, `ServerVersion`, `ServerVendorURL`,
|
|
61
|
+
`ImplementedFeatures`, plus `GetFeatureDefinition` and
|
|
62
|
+
`SetServerName`). Hand-derived from the FDL in
|
|
63
|
+
[sila_base](https://gitlab.com/SiLA2/sila_base).
|
|
64
|
+
|
|
65
|
+
That's enough to talk to any SiLA 2 server's identity surface out of the
|
|
66
|
+
box. For domain features (your actual lab devices) you provide their
|
|
67
|
+
`.proto` files via the connection's **Extra proto dirs** /
|
|
68
|
+
**Extra proto files** config.
|
|
69
|
+
|
|
70
|
+
## Adding more features
|
|
71
|
+
|
|
72
|
+
SiLA 2 features are defined in FDL XML; the `.proto` is generated from
|
|
73
|
+
the FDL by the SiLA 2 codegen. If your server is the `sila2` Python
|
|
74
|
+
reference implementation, the generated `.proto` files live inside the
|
|
75
|
+
running container and can be copied out with one shell command (see
|
|
76
|
+
the `extract_protos.sh` helper in this repo's `sila-handoff/` notes).
|
|
77
|
+
|
|
78
|
+
Once you have the `.proto` files, drop them in a directory and point
|
|
79
|
+
the connection node's **Extra proto dirs** at it (comma-separated list
|
|
80
|
+
of dirs and/or individual files). The picker dropdowns automatically
|
|
81
|
+
include any feature that's loaded.
|
|
82
|
+
|
|
83
|
+
## Picker
|
|
84
|
+
|
|
85
|
+
Open a SiLA 2 call or SiLA 2 get node in the editor and you'll see two
|
|
86
|
+
dropdowns above the manual fields:
|
|
87
|
+
|
|
88
|
+
- **Feature**: lists every loaded feature.
|
|
89
|
+
- **Command** / **Property**: lists the methods on the selected feature,
|
|
90
|
+
classified by SiLA 2 naming convention (`Get_<X>` -> property `<X>`,
|
|
91
|
+
everything else -> command).
|
|
92
|
+
|
|
93
|
+
The picker writes the chosen values into the manual text fields below;
|
|
94
|
+
you can also type by hand.
|
|
95
|
+
|
|
96
|
+
## Why static protos and not reflection
|
|
97
|
+
|
|
98
|
+
An earlier draft used gRPC reflection. The Python `sila2` reference
|
|
99
|
+
server enables reflection by default, but other SiLA 2 implementations
|
|
100
|
+
(Java, C#) often do not, and even some `sila2` deployments turn it off.
|
|
101
|
+
Static proto loading is universal -- the package works against every
|
|
102
|
+
SiLA 2 server we've tested.
|
|
103
|
+
|
|
104
|
+
## Limitations / roadmap
|
|
105
|
+
|
|
106
|
+
This is the v0.1.0 release. Out of scope for now:
|
|
107
|
+
|
|
108
|
+
- Observable commands (the `CommandExecutionUUID` flow with progress).
|
|
109
|
+
- Observable properties (server-streaming subscriptions).
|
|
110
|
+
- Pinned-cert TLS (insecure and default-trust TLS are available).
|
|
111
|
+
- Decoded `sila-error-bin` trailer (SiLA 2 framework errors currently
|
|
112
|
+
surface as generic gRPC errors).
|
|
113
|
+
|
|
114
|
+
If any of these is blocking for you, open an issue.
|
|
115
|
+
|
|
116
|
+
## License
|
|
117
|
+
|
|
118
|
+
Apache License, Version 2.0. See [`LICENSE`](LICENSE) and
|
|
119
|
+
[`NOTICE`](NOTICE).
|
package/package.json
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@synefex/node-red-sila2",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Node-RED nodes for SiLA 2 lab-device servers (gRPC over HTTP/2). Bundled SiLAFramework + SiLAService protos; static proto loading with optional extras.",
|
|
5
|
+
"license": "Apache-2.0",
|
|
6
|
+
"author": "Maximilian Wiens <maximilian.wiens@synefex.de> (Wiens Synefex GmbH)",
|
|
7
|
+
"repository": {
|
|
8
|
+
"type": "git",
|
|
9
|
+
"url": "git+https://github.com/synefex/node-red-sila2.git"
|
|
10
|
+
},
|
|
11
|
+
"homepage": "https://github.com/synefex/node-red-sila2#readme",
|
|
12
|
+
"bugs": {
|
|
13
|
+
"url": "https://github.com/synefex/node-red-sila2/issues"
|
|
14
|
+
},
|
|
15
|
+
"node-red": {
|
|
16
|
+
"version": ">=3.1.0",
|
|
17
|
+
"nodes": {
|
|
18
|
+
"sila-connection": "src/connection/sila-connection.js",
|
|
19
|
+
"sila-call-command": "src/call-command/sila-call-command.js",
|
|
20
|
+
"sila-get-property": "src/get-property/sila-get-property.js"
|
|
21
|
+
}
|
|
22
|
+
},
|
|
23
|
+
"dependencies": {
|
|
24
|
+
"@grpc/grpc-js": "^1.10.0",
|
|
25
|
+
"@grpc/proto-loader": "^0.7.10"
|
|
26
|
+
},
|
|
27
|
+
"devDependencies": {
|
|
28
|
+
"node-red": "^4.0.0",
|
|
29
|
+
"node-red-node-test-helper": "^0.3.4",
|
|
30
|
+
"mocha": "^10.7.0"
|
|
31
|
+
},
|
|
32
|
+
"scripts": {
|
|
33
|
+
"test": "mocha \"test/**/*.test.js\" --timeout 5000"
|
|
34
|
+
},
|
|
35
|
+
"files": [
|
|
36
|
+
"src/",
|
|
37
|
+
"protos/",
|
|
38
|
+
"README.md",
|
|
39
|
+
"LICENSE",
|
|
40
|
+
"NOTICE",
|
|
41
|
+
"CHANGELOG.md"
|
|
42
|
+
],
|
|
43
|
+
"engines": {
|
|
44
|
+
"node": ">=18"
|
|
45
|
+
},
|
|
46
|
+
"keywords": [
|
|
47
|
+
"node-red",
|
|
48
|
+
"node-red-contrib",
|
|
49
|
+
"sila",
|
|
50
|
+
"sila2",
|
|
51
|
+
"grpc",
|
|
52
|
+
"lab-automation",
|
|
53
|
+
"laboratory",
|
|
54
|
+
"synefex"
|
|
55
|
+
]
|
|
56
|
+
}
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
syntax = "proto3";
|
|
2
|
+
|
|
3
|
+
package sila2.org.silastandard;
|
|
4
|
+
|
|
5
|
+
option java_outer_classname = "SiLAFramework";
|
|
6
|
+
|
|
7
|
+
// -------- SiLA Basic Types --------
|
|
8
|
+
message String {
|
|
9
|
+
string value = 1;
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
message Integer {
|
|
13
|
+
int64 value = 1;
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
message Real {
|
|
17
|
+
double value = 1;
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
message Boolean {
|
|
21
|
+
bool value = 1;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
message Binary {
|
|
25
|
+
oneof union {
|
|
26
|
+
bytes value = 1;
|
|
27
|
+
string binaryTransferUUID = 2;
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
message Date {
|
|
32
|
+
uint32 day = 1;
|
|
33
|
+
uint32 month = 2;
|
|
34
|
+
uint32 year = 3;
|
|
35
|
+
Timezone timezone = 4;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
message Time {
|
|
39
|
+
uint32 second = 1;
|
|
40
|
+
uint32 minute = 2;
|
|
41
|
+
uint32 hour = 3;
|
|
42
|
+
Timezone timezone = 4;
|
|
43
|
+
uint32 millisecond = 5;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
message Timestamp {
|
|
47
|
+
uint32 second = 1;
|
|
48
|
+
uint32 minute = 2;
|
|
49
|
+
uint32 hour = 3;
|
|
50
|
+
uint32 day = 4;
|
|
51
|
+
uint32 month = 5;
|
|
52
|
+
uint32 year = 6;
|
|
53
|
+
Timezone timezone = 7;
|
|
54
|
+
uint32 millisecond = 8;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
message Any {
|
|
58
|
+
string type = 1;
|
|
59
|
+
bytes payload = 2;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
// -------- Framework Types --------
|
|
63
|
+
message CommandExecutionUUID {
|
|
64
|
+
string value = 1;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
message CommandConfirmation {
|
|
68
|
+
CommandExecutionUUID commandExecutionUUID = 1;
|
|
69
|
+
Duration lifetimeOfExecution = 2;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
message ExecutionInfo {
|
|
73
|
+
enum CommandStatus {
|
|
74
|
+
waiting = 0 ;
|
|
75
|
+
running = 1;
|
|
76
|
+
finishedSuccessfully = 2;
|
|
77
|
+
finishedWithError = 3;
|
|
78
|
+
}
|
|
79
|
+
CommandStatus commandStatus = 1;
|
|
80
|
+
Real progressInfo = 2;
|
|
81
|
+
Duration estimatedRemainingTime = 3;
|
|
82
|
+
Duration updatedLifetimeOfExecution = 4;
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
// -------- Error Handling --------
|
|
86
|
+
message SiLAError {
|
|
87
|
+
oneof error {
|
|
88
|
+
ValidationError validationError = 1;
|
|
89
|
+
DefinedExecutionError definedExecutionError = 2;
|
|
90
|
+
UndefinedExecutionError undefinedExecutionError = 3;
|
|
91
|
+
FrameworkError frameworkError = 4;
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
message ValidationError {
|
|
96
|
+
string parameter = 1; /* fully qualified parameter identifier */
|
|
97
|
+
string message = 2;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
message DefinedExecutionError {
|
|
101
|
+
string errorIdentifier = 1; /* fully qualified defined execution error identifier */
|
|
102
|
+
string message = 2;
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
message UndefinedExecutionError {
|
|
106
|
+
string message = 1;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
message FrameworkError {
|
|
110
|
+
enum ErrorType {
|
|
111
|
+
COMMAND_EXECUTION_NOT_ACCEPTED = 0;
|
|
112
|
+
INVALID_COMMAND_EXECUTION_UUID = 1;
|
|
113
|
+
COMMAND_EXECUTION_NOT_FINISHED = 2;
|
|
114
|
+
INVALID_METADATA = 3;
|
|
115
|
+
NO_METADATA_ALLOWED = 4;
|
|
116
|
+
}
|
|
117
|
+
ErrorType errorType = 1;
|
|
118
|
+
string message = 2;
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
// -------- Internal types --------
|
|
122
|
+
// Timezone: used in Date, Time, Timestamp
|
|
123
|
+
message Timezone {
|
|
124
|
+
int32 hours = 1;
|
|
125
|
+
uint32 minutes = 2;
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
// Duration: used in CommandConfirmation, ExecutionInfo
|
|
129
|
+
message Duration {
|
|
130
|
+
int64 seconds = 1;
|
|
131
|
+
int32 nanos = 2;
|
|
132
|
+
}
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
syntax = "proto3";
|
|
2
|
+
|
|
3
|
+
// SiLAService is the mandatory core feature every SiLA 2 server implements.
|
|
4
|
+
// Hand-derived from the canonical FDL at:
|
|
5
|
+
// https://gitlab.com/SiLA2/sila_base/raw/master/feature_definitions/org/silastandard/core/SiLAService/v1/SiLAService.sila.xml
|
|
6
|
+
//
|
|
7
|
+
// Property getter naming convention (per SiLA spec): each Property <Name>
|
|
8
|
+
// is exposed as a unary rpc Get_<Name> with empty parameters, returning a
|
|
9
|
+
// Get_<Name>_Responses message that has a single field <Name> of the
|
|
10
|
+
// property's wrapped basic type.
|
|
11
|
+
|
|
12
|
+
import "SiLAFramework.proto";
|
|
13
|
+
|
|
14
|
+
package sila2.org.silastandard.core.silaservice.v1;
|
|
15
|
+
|
|
16
|
+
service SiLAService {
|
|
17
|
+
// ---- Commands ----
|
|
18
|
+
rpc GetFeatureDefinition (GetFeatureDefinition_Parameters) returns (GetFeatureDefinition_Responses) {}
|
|
19
|
+
rpc SetServerName (SetServerName_Parameters) returns (SetServerName_Responses) {}
|
|
20
|
+
|
|
21
|
+
// ---- Property getters ----
|
|
22
|
+
rpc Get_ServerName (Get_ServerName_Parameters) returns (Get_ServerName_Responses) {}
|
|
23
|
+
rpc Get_ServerType (Get_ServerType_Parameters) returns (Get_ServerType_Responses) {}
|
|
24
|
+
rpc Get_ServerUUID (Get_ServerUUID_Parameters) returns (Get_ServerUUID_Responses) {}
|
|
25
|
+
rpc Get_ServerDescription (Get_ServerDescription_Parameters) returns (Get_ServerDescription_Responses) {}
|
|
26
|
+
rpc Get_ServerVersion (Get_ServerVersion_Parameters) returns (Get_ServerVersion_Responses) {}
|
|
27
|
+
rpc Get_ServerVendorURL (Get_ServerVendorURL_Parameters) returns (Get_ServerVendorURL_Responses) {}
|
|
28
|
+
rpc Get_ImplementedFeatures (Get_ImplementedFeatures_Parameters) returns (Get_ImplementedFeatures_Responses) {}
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
// ---- Command messages ----
|
|
32
|
+
|
|
33
|
+
message GetFeatureDefinition_Parameters {
|
|
34
|
+
sila2.org.silastandard.String FeatureIdentifier = 1;
|
|
35
|
+
}
|
|
36
|
+
message GetFeatureDefinition_Responses {
|
|
37
|
+
sila2.org.silastandard.String FeatureDefinition = 1;
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
message SetServerName_Parameters {
|
|
41
|
+
sila2.org.silastandard.String ServerName = 1;
|
|
42
|
+
}
|
|
43
|
+
message SetServerName_Responses {
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
// ---- Property messages ----
|
|
47
|
+
|
|
48
|
+
message Get_ServerName_Parameters {}
|
|
49
|
+
message Get_ServerName_Responses {
|
|
50
|
+
sila2.org.silastandard.String ServerName = 1;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
message Get_ServerType_Parameters {}
|
|
54
|
+
message Get_ServerType_Responses {
|
|
55
|
+
sila2.org.silastandard.String ServerType = 1;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
message Get_ServerUUID_Parameters {}
|
|
59
|
+
message Get_ServerUUID_Responses {
|
|
60
|
+
sila2.org.silastandard.String ServerUUID = 1;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
message Get_ServerDescription_Parameters {}
|
|
64
|
+
message Get_ServerDescription_Responses {
|
|
65
|
+
sila2.org.silastandard.String ServerDescription = 1;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
message Get_ServerVersion_Parameters {}
|
|
69
|
+
message Get_ServerVersion_Responses {
|
|
70
|
+
sila2.org.silastandard.String ServerVersion = 1;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
message Get_ServerVendorURL_Parameters {}
|
|
74
|
+
message Get_ServerVendorURL_Responses {
|
|
75
|
+
sila2.org.silastandard.String ServerVendorURL = 1;
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
message Get_ImplementedFeatures_Parameters {}
|
|
79
|
+
message Get_ImplementedFeatures_Responses {
|
|
80
|
+
repeated sila2.org.silastandard.String ImplementedFeatures = 1;
|
|
81
|
+
}
|