openrois-gateway 0.1.0a1__tar.gz
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.
- openrois_gateway-0.1.0a1/.gitignore +220 -0
- openrois_gateway-0.1.0a1/CHANGELOG.md +23 -0
- openrois_gateway-0.1.0a1/Dockerfile +43 -0
- openrois_gateway-0.1.0a1/LICENSE +202 -0
- openrois_gateway-0.1.0a1/NOTICE +7 -0
- openrois_gateway-0.1.0a1/PKG-INFO +160 -0
- openrois_gateway-0.1.0a1/README.md +134 -0
- openrois_gateway-0.1.0a1/pyproject.toml +69 -0
- openrois_gateway-0.1.0a1/src/openrois/gateway/__init__.py +28 -0
- openrois_gateway-0.1.0a1/src/openrois/gateway/__main__.py +9 -0
- openrois_gateway-0.1.0a1/src/openrois/gateway/app.py +93 -0
- openrois_gateway-0.1.0a1/src/openrois/gateway/cli.py +69 -0
- openrois_gateway-0.1.0a1/src/openrois/gateway/config.py +144 -0
- openrois_gateway-0.1.0a1/src/openrois/gateway/py.typed +0 -0
- openrois_gateway-0.1.0a1/tests/__init__.py +0 -0
- openrois_gateway-0.1.0a1/tests/test_app.py +102 -0
- openrois_gateway-0.1.0a1/tests/test_cli.py +69 -0
- openrois_gateway-0.1.0a1/tests/test_config.py +95 -0
|
@@ -0,0 +1,220 @@
|
|
|
1
|
+
# Byte-compiled / optimized / DLL files
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[codz]
|
|
4
|
+
*$py.class
|
|
5
|
+
|
|
6
|
+
# C extensions
|
|
7
|
+
*.so
|
|
8
|
+
|
|
9
|
+
# Distribution / packaging
|
|
10
|
+
.Python
|
|
11
|
+
build/
|
|
12
|
+
develop-eggs/
|
|
13
|
+
dist/
|
|
14
|
+
downloads/
|
|
15
|
+
eggs/
|
|
16
|
+
.eggs/
|
|
17
|
+
lib/
|
|
18
|
+
lib64/
|
|
19
|
+
parts/
|
|
20
|
+
sdist/
|
|
21
|
+
var/
|
|
22
|
+
wheels/
|
|
23
|
+
share/python-wheels/
|
|
24
|
+
*.egg-info/
|
|
25
|
+
.installed.cfg
|
|
26
|
+
*.egg
|
|
27
|
+
MANIFEST
|
|
28
|
+
|
|
29
|
+
# PyInstaller
|
|
30
|
+
# Usually these files are written by a python script from a template
|
|
31
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
32
|
+
*.manifest
|
|
33
|
+
*.spec
|
|
34
|
+
|
|
35
|
+
# Installer logs
|
|
36
|
+
pip-log.txt
|
|
37
|
+
pip-delete-this-directory.txt
|
|
38
|
+
|
|
39
|
+
# Unit test / coverage reports
|
|
40
|
+
htmlcov/
|
|
41
|
+
.tox/
|
|
42
|
+
.nox/
|
|
43
|
+
.coverage
|
|
44
|
+
.coverage.*
|
|
45
|
+
.cache
|
|
46
|
+
nosetests.xml
|
|
47
|
+
coverage.xml
|
|
48
|
+
*.cover
|
|
49
|
+
*.py.cover
|
|
50
|
+
*.lcov
|
|
51
|
+
.hypothesis/
|
|
52
|
+
.pytest_cache/
|
|
53
|
+
cover/
|
|
54
|
+
|
|
55
|
+
# Translations
|
|
56
|
+
*.mo
|
|
57
|
+
*.pot
|
|
58
|
+
|
|
59
|
+
# Django stuff:
|
|
60
|
+
*.log
|
|
61
|
+
local_settings.py
|
|
62
|
+
db.sqlite3
|
|
63
|
+
db.sqlite3-journal
|
|
64
|
+
|
|
65
|
+
# Flask stuff:
|
|
66
|
+
instance/
|
|
67
|
+
.webassets-cache
|
|
68
|
+
|
|
69
|
+
# Scrapy stuff:
|
|
70
|
+
.scrapy
|
|
71
|
+
|
|
72
|
+
# Sphinx documentation
|
|
73
|
+
docs/_build/
|
|
74
|
+
|
|
75
|
+
# PyBuilder
|
|
76
|
+
.pybuilder/
|
|
77
|
+
target/
|
|
78
|
+
|
|
79
|
+
# Jupyter Notebook
|
|
80
|
+
.ipynb_checkpoints
|
|
81
|
+
|
|
82
|
+
# IPython
|
|
83
|
+
profile_default/
|
|
84
|
+
ipython_config.py
|
|
85
|
+
|
|
86
|
+
# pyenv
|
|
87
|
+
# For a library or package, you might want to ignore these files since the code is
|
|
88
|
+
# intended to run in multiple environments; otherwise, check them in:
|
|
89
|
+
# .python-version
|
|
90
|
+
|
|
91
|
+
# pipenv
|
|
92
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
93
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
94
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
95
|
+
# install all needed dependencies.
|
|
96
|
+
# Pipfile.lock
|
|
97
|
+
|
|
98
|
+
# UV
|
|
99
|
+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
|
|
100
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
101
|
+
# commonly ignored for libraries.
|
|
102
|
+
# uv.lock
|
|
103
|
+
|
|
104
|
+
# poetry
|
|
105
|
+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
|
106
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
107
|
+
# commonly ignored for libraries.
|
|
108
|
+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
|
109
|
+
# poetry.lock
|
|
110
|
+
# poetry.toml
|
|
111
|
+
|
|
112
|
+
# pdm
|
|
113
|
+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
|
114
|
+
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
|
|
115
|
+
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
|
|
116
|
+
# pdm.lock
|
|
117
|
+
# pdm.toml
|
|
118
|
+
.pdm-python
|
|
119
|
+
.pdm-build/
|
|
120
|
+
|
|
121
|
+
# pixi
|
|
122
|
+
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
|
|
123
|
+
# pixi.lock
|
|
124
|
+
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
|
|
125
|
+
# in the .venv directory. It is recommended not to include this directory in version control.
|
|
126
|
+
.pixi/*
|
|
127
|
+
!.pixi/config.toml
|
|
128
|
+
|
|
129
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
|
130
|
+
__pypackages__/
|
|
131
|
+
|
|
132
|
+
# Celery stuff
|
|
133
|
+
celerybeat-schedule*
|
|
134
|
+
celerybeat.pid
|
|
135
|
+
|
|
136
|
+
# Redis
|
|
137
|
+
*.rdb
|
|
138
|
+
*.aof
|
|
139
|
+
*.pid
|
|
140
|
+
|
|
141
|
+
# RabbitMQ
|
|
142
|
+
mnesia/
|
|
143
|
+
rabbitmq/
|
|
144
|
+
rabbitmq-data/
|
|
145
|
+
|
|
146
|
+
# ActiveMQ
|
|
147
|
+
activemq-data/
|
|
148
|
+
|
|
149
|
+
# SageMath parsed files
|
|
150
|
+
*.sage.py
|
|
151
|
+
|
|
152
|
+
# Environments
|
|
153
|
+
.env
|
|
154
|
+
.envrc
|
|
155
|
+
.venv
|
|
156
|
+
env/
|
|
157
|
+
venv/
|
|
158
|
+
ENV/
|
|
159
|
+
env.bak/
|
|
160
|
+
venv.bak/
|
|
161
|
+
|
|
162
|
+
# Spyder project settings
|
|
163
|
+
.spyderproject
|
|
164
|
+
.spyproject
|
|
165
|
+
|
|
166
|
+
# Rope project settings
|
|
167
|
+
.ropeproject
|
|
168
|
+
|
|
169
|
+
# mkdocs documentation
|
|
170
|
+
/site
|
|
171
|
+
|
|
172
|
+
# mypy
|
|
173
|
+
.mypy_cache/
|
|
174
|
+
.dmypy.json
|
|
175
|
+
dmypy.json
|
|
176
|
+
|
|
177
|
+
# Pyre type checker
|
|
178
|
+
.pyre/
|
|
179
|
+
|
|
180
|
+
# pytype static type analyzer
|
|
181
|
+
.pytype/
|
|
182
|
+
|
|
183
|
+
# Cython debug symbols
|
|
184
|
+
cython_debug/
|
|
185
|
+
|
|
186
|
+
# PyCharm
|
|
187
|
+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
|
188
|
+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
|
189
|
+
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
|
190
|
+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
|
191
|
+
# .idea/
|
|
192
|
+
|
|
193
|
+
# Abstra
|
|
194
|
+
# Abstra is an AI-powered process automation framework.
|
|
195
|
+
# Ignore directories containing user credentials, local state, and settings.
|
|
196
|
+
# Learn more at https://abstra.io/docs
|
|
197
|
+
.abstra/
|
|
198
|
+
|
|
199
|
+
# Visual Studio Code
|
|
200
|
+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
|
|
201
|
+
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
|
|
202
|
+
# and can be added to the global gitignore or merged into this file. However, if you prefer,
|
|
203
|
+
# you could uncomment the following to ignore the entire vscode folder
|
|
204
|
+
# .vscode/
|
|
205
|
+
# Temporary file for partial code execution
|
|
206
|
+
tempCodeRunnerFile.py
|
|
207
|
+
|
|
208
|
+
# Ruff stuff:
|
|
209
|
+
.ruff_cache/
|
|
210
|
+
|
|
211
|
+
# PyPI configuration file
|
|
212
|
+
.pypirc
|
|
213
|
+
|
|
214
|
+
# Marimo
|
|
215
|
+
marimo/_static/
|
|
216
|
+
marimo/_lsp/
|
|
217
|
+
__marimo__/
|
|
218
|
+
|
|
219
|
+
# Streamlit
|
|
220
|
+
.streamlit/secrets.toml
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/2.0.0/),
|
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## [Unreleased]
|
|
9
|
+
|
|
10
|
+
## [0.1.0a1] - 2026-11-06
|
|
11
|
+
|
|
12
|
+
### Added
|
|
13
|
+
|
|
14
|
+
- The `openrois-gateway` command and `python -m openrois.gateway`: the main RoIS HRI Engine on a WebSocket port, with child engines on `/adapter` and clients on any other path.
|
|
15
|
+
- Every method of the RoIS method catalog, served to clients for the components of every child engine, with the RoIS behavior of `openrois-engine`. Binds, command ids and the abort of a client's commands when it releases a component or goes away are held at the gateway, and errors from the adapters reach the clients concerned.
|
|
16
|
+
- `openrois-engine` 0.1.0a2 or later is required, because a second client could not subscribe to an event before it.
|
|
17
|
+
- Configuration from a YAML file, `OPENROIS_GATEWAY_*` environment variables and command-line flags, each overriding the one before: the host (loopback by default), the port, the engine id, the log level and the child request timeout.
|
|
18
|
+
- A warning in the log when the gateway binds an address beyond loopback, since it has no TLS and no authentication.
|
|
19
|
+
- A graceful stop on SIGTERM and SIGINT that closes every connection with code 1001 and exits with code 0. Exit code 1 reports a gateway that cannot start, and exit code 2 an invalid configuration.
|
|
20
|
+
- `Gateway` and `GatewayConfig`, to run the gateway inside another program.
|
|
21
|
+
|
|
22
|
+
[unreleased]: https://github.com/openrois/openrois/compare/gateway-v0.1.0-alpha.1...HEAD
|
|
23
|
+
[0.1.0a1]: https://github.com/openrois/openrois/releases/tag/gateway-v0.1.0-alpha.1
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# syntax=docker/dockerfile:1
|
|
2
|
+
#
|
|
3
|
+
# The OpenRoIS gateway. Build from the repository root:
|
|
4
|
+
#
|
|
5
|
+
# docker build -f services/gateway/Dockerfile -t openrois-gateway .
|
|
6
|
+
# docker run --rm -p 127.0.0.1:8765:8765 openrois-gateway
|
|
7
|
+
#
|
|
8
|
+
# Settings come from OPENROIS_GATEWAY_* environment variables or flags after the image
|
|
9
|
+
# name. See services/gateway/README.md.
|
|
10
|
+
|
|
11
|
+
FROM python:3.12-slim AS build
|
|
12
|
+
|
|
13
|
+
WORKDIR /src
|
|
14
|
+
COPY interfaces/python interfaces/python
|
|
15
|
+
COPY engine engine
|
|
16
|
+
COPY services/gateway services/gateway
|
|
17
|
+
# Build wheels for the three packages and every dependency, so the runtime stage
|
|
18
|
+
# installs offline and carries no source tree or build tools.
|
|
19
|
+
RUN pip wheel --no-cache-dir --wheel-dir /wheels ./interfaces/python ./engine \
|
|
20
|
+
./services/gateway
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
FROM python:3.12-slim
|
|
24
|
+
|
|
25
|
+
ENV PYTHONDONTWRITEBYTECODE=1 \
|
|
26
|
+
PYTHONUNBUFFERED=1 \
|
|
27
|
+
PIP_DISABLE_PIP_VERSION_CHECK=1
|
|
28
|
+
|
|
29
|
+
# --pre: the OpenRoIS packages are alpha releases, the only versions in /wheels.
|
|
30
|
+
RUN --mount=type=bind,from=build,source=/wheels,target=/wheels \
|
|
31
|
+
pip install --no-cache-dir --no-index --find-links /wheels --pre openrois-gateway
|
|
32
|
+
|
|
33
|
+
RUN useradd --system --uid 10001 --no-create-home openrois
|
|
34
|
+
USER openrois
|
|
35
|
+
|
|
36
|
+
# Inside the container the gateway listens on every interface, so Docker can publish
|
|
37
|
+
# the port. Publish it on 127.0.0.1 unless the network is trusted: the gateway does not
|
|
38
|
+
# authenticate its peers.
|
|
39
|
+
ENV OPENROIS_GATEWAY_HOST=0.0.0.0
|
|
40
|
+
EXPOSE 8765
|
|
41
|
+
|
|
42
|
+
# The gateway handles SIGTERM itself and exits with code 0 after closing connections.
|
|
43
|
+
ENTRYPOINT ["openrois-gateway"]
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright 2026 Coarobo GK
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,160 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: openrois-gateway
|
|
3
|
+
Version: 0.1.0a1
|
|
4
|
+
Summary: OpenRoIS gateway: the process that hosts the main RoIS HRI Engine and faces the network
|
|
5
|
+
Project-URL: Homepage, https://openrois.org/
|
|
6
|
+
Project-URL: Repository, https://github.com/openrois/openrois
|
|
7
|
+
Project-URL: Bug-Tracker, https://github.com/openrois/openrois/issues
|
|
8
|
+
Author: OpenRoIS Community
|
|
9
|
+
License-Expression: Apache-2.0
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
License-File: NOTICE
|
|
12
|
+
Keywords: hri,middleware,omg,robotics,rois
|
|
13
|
+
Classifier: Development Status :: 3 - Alpha
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
17
|
+
Requires-Python: >=3.12
|
|
18
|
+
Requires-Dist: openrois-engine>=0.1.0a2
|
|
19
|
+
Requires-Dist: pydantic>=2.0
|
|
20
|
+
Provides-Extra: dev
|
|
21
|
+
Requires-Dist: mypy>=1.8; extra == 'dev'
|
|
22
|
+
Requires-Dist: pytest-asyncio>=1.0; extra == 'dev'
|
|
23
|
+
Requires-Dist: pytest>=8.4; extra == 'dev'
|
|
24
|
+
Requires-Dist: ruff>=0.4; extra == 'dev'
|
|
25
|
+
Description-Content-Type: text/markdown
|
|
26
|
+
|
|
27
|
+
# openrois-gateway
|
|
28
|
+
|
|
29
|
+

|
|
30
|
+
|
|
31
|
+
The OpenRoIS gateway: the process that hosts the main RoIS HRI Engine and faces the network.
|
|
32
|
+
|
|
33
|
+
Adapters and lower gateways connect to it as child engines on the path `/adapter`. Service
|
|
34
|
+
applications connect as clients on any other path. The gateway discovers each child engine's
|
|
35
|
+
components, aggregates their profiles, holds the bindings, runs command sequences across
|
|
36
|
+
the child engines, and routes every RoIS call and every event to where it belongs. It composes
|
|
37
|
+
`Engine` and `WsServer` from [`openrois-engine`](https://github.com/openrois/openrois/blob/dev/engine/README.md) into a process with
|
|
38
|
+
configuration, logging and a graceful stop.
|
|
39
|
+
|
|
40
|
+
## Install
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
pip install openrois-gateway
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
The gateway needs Python 3.12 or later. With [uv](https://docs.astral.sh/uv/), which fetches
|
|
47
|
+
Python itself, it runs with no install:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
uvx --python 3.12 --from openrois-gateway openrois-gateway
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## Run
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
openrois-gateway # listens on ws://127.0.0.1:8765
|
|
57
|
+
openrois-gateway --host 0.0.0.0 --port 9000
|
|
58
|
+
python -m openrois.gateway --config gateway.yaml
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Ctrl+C or SIGTERM stops the gateway: it closes every connection with code 1001 and exits
|
|
62
|
+
with code 0.
|
|
63
|
+
|
|
64
|
+
The gateway does not authenticate its peers, so it binds loopback by default. Bind another
|
|
65
|
+
interface only on a network you trust, and the gateway logs a warning when you do. Phones
|
|
66
|
+
and headsets need this, since they cannot reach a gateway on loopback.
|
|
67
|
+
|
|
68
|
+
## Docker
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
# From the repository root.
|
|
72
|
+
docker build -f services/gateway/Dockerfile -t openrois-gateway .
|
|
73
|
+
docker run --rm -p 127.0.0.1:8765:8765 openrois-gateway --log-level debug
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
Inside the container the gateway listens on every interface, so Docker can publish the port.
|
|
77
|
+
Publish it on `127.0.0.1` unless the network is trusted. Settings come from
|
|
78
|
+
`OPENROIS_GATEWAY_*` variables (`-e`) or flags after the image name.
|
|
79
|
+
|
|
80
|
+
[`compose.yaml`](https://github.com/openrois/openrois/blob/dev/compose.yaml) at the repository root runs the gateway with the
|
|
81
|
+
[mock adapter](https://github.com/openrois/openrois/blob/dev/testing/mock-adapter/README.md) behind it:
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
docker compose up --build
|
|
85
|
+
python testing/conformance/wire_check.py
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
The check connects as a client, waits until the adapter's components appear, and runs the
|
|
89
|
+
[conformance list](https://github.com/openrois/openrois/blob/dev/testing/conformance/README.md). It needs only the `websockets`
|
|
90
|
+
package and exits with 0 when every scenario passes.
|
|
91
|
+
|
|
92
|
+
## Configuration
|
|
93
|
+
|
|
94
|
+
Each source overrides the one before it: the defaults, a YAML file, the environment, and the
|
|
95
|
+
command-line flags.
|
|
96
|
+
|
|
97
|
+
| Setting | Flag | Environment | Default |
|
|
98
|
+
|---------|------|-------------|---------|
|
|
99
|
+
| Interface to bind | `--host` | `OPENROIS_GATEWAY_HOST` | `127.0.0.1` |
|
|
100
|
+
| TCP port, `0` for a free one | `--port` | `OPENROIS_GATEWAY_PORT` | `8765` |
|
|
101
|
+
| Engine id in the profile | `--engine-id` | `OPENROIS_GATEWAY_ENGINE_ID` | `gateway` |
|
|
102
|
+
| Log level: `debug`, `info`, `warning`, `error` | `--log-level` | `OPENROIS_GATEWAY_LOG_LEVEL` | `info` |
|
|
103
|
+
| Seconds to wait for a child engine's reply | `--child-timeout` | `OPENROIS_GATEWAY_CHILD_TIMEOUT` | `10` |
|
|
104
|
+
| YAML file with settings | `--config` | `OPENROIS_GATEWAY_CONFIG` | None |
|
|
105
|
+
|
|
106
|
+
The YAML file is a flat mapping with the setting names below. A key it does not know is an
|
|
107
|
+
error.
|
|
108
|
+
|
|
109
|
+
```yaml
|
|
110
|
+
host: 127.0.0.1
|
|
111
|
+
port: 8765
|
|
112
|
+
engine_id: gateway
|
|
113
|
+
log_level: info
|
|
114
|
+
child_timeout: 10
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
| Exit code | Meaning |
|
|
118
|
+
|-----------|---------|
|
|
119
|
+
| `0` | Stopped by a signal |
|
|
120
|
+
| `1` | The gateway could not start, for example because the port is taken |
|
|
121
|
+
| `2` | The configuration is invalid |
|
|
122
|
+
|
|
123
|
+
## Embed
|
|
124
|
+
|
|
125
|
+
```python
|
|
126
|
+
import asyncio
|
|
127
|
+
|
|
128
|
+
from openrois.gateway import Gateway, GatewayConfig
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
async def main() -> None:
|
|
132
|
+
gateway = Gateway(GatewayConfig(port=0))
|
|
133
|
+
stop = asyncio.Event()
|
|
134
|
+
# run() serves until SIGTERM, SIGINT, or until the event is set.
|
|
135
|
+
await gateway.run(stop)
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
asyncio.run(main())
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
`start()` and `stop()` are available on their own, and `port` reports the bound port.
|
|
142
|
+
|
|
143
|
+
## Test
|
|
144
|
+
|
|
145
|
+
```bash
|
|
146
|
+
pip install -e "./services/gateway[dev]"
|
|
147
|
+
cd services/gateway && pytest && mypy && ruff check src/ tests/
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
## Status
|
|
151
|
+
|
|
152
|
+
Alpha, pre-1.0, unstable API. The gateway answers the RoIS method catalog that the
|
|
153
|
+
TypeScript SDK and the HRI client speak, with the RoIS behavior of CP1 to CP3 that
|
|
154
|
+
[`openrois-engine`](https://github.com/openrois/openrois/blob/dev/engine/README.md) implements, and makes no conformance claim.
|
|
155
|
+
Authentication is planned for Phase 9, so the gateway binds to loopback by default. Health endpoints and a compose healthcheck are
|
|
156
|
+
planned for [Phase 5](https://openrois.org/docs/project/roadmap).
|
|
157
|
+
|
|
158
|
+
## License
|
|
159
|
+
|
|
160
|
+
Apache-2.0.
|