embodied-ops 0.2.0__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.
- embodied_ops-0.2.0/LICENSE +176 -0
- embodied_ops-0.2.0/PKG-INFO +135 -0
- embodied_ops-0.2.0/README.md +108 -0
- embodied_ops-0.2.0/pyproject.toml +61 -0
- embodied_ops-0.2.0/setup.cfg +4 -0
- embodied_ops-0.2.0/src/embodied_ops/__init__.py +66 -0
- embodied_ops-0.2.0/src/embodied_ops/_version.py +1 -0
- embodied_ops-0.2.0/src/embodied_ops/device.py +134 -0
- embodied_ops-0.2.0/src/embodied_ops/endpoints.py +22 -0
- embodied_ops-0.2.0/src/embodied_ops/errors.py +25 -0
- embodied_ops-0.2.0/src/embodied_ops/features.py +115 -0
- embodied_ops-0.2.0/src/embodied_ops/py.typed +0 -0
- embodied_ops-0.2.0/src/embodied_ops/registry.py +91 -0
- embodied_ops-0.2.0/src/embodied_ops/rpc/__init__.py +13 -0
- embodied_ops-0.2.0/src/embodied_ops/rpc/_codec.py +158 -0
- embodied_ops-0.2.0/src/embodied_ops/rpc/client.py +320 -0
- embodied_ops-0.2.0/src/embodied_ops/rpc/server.py +503 -0
- embodied_ops-0.2.0/src/embodied_ops/rpc/types.py +36 -0
- embodied_ops-0.2.0/src/embodied_ops/rpc/v1/__init__.py +1 -0
- embodied_ops-0.2.0/src/embodied_ops/rpc/v1/device.proto +111 -0
- embodied_ops-0.2.0/src/embodied_ops/rpc/v1/device_pb2.py +72 -0
- embodied_ops-0.2.0/src/embodied_ops/rpc/v1/device_pb2_grpc.py +485 -0
- embodied_ops-0.2.0/src/embodied_ops.egg-info/PKG-INFO +135 -0
- embodied_ops-0.2.0/src/embodied_ops.egg-info/SOURCES.txt +27 -0
- embodied_ops-0.2.0/src/embodied_ops.egg-info/dependency_links.txt +1 -0
- embodied_ops-0.2.0/src/embodied_ops.egg-info/requires.txt +4 -0
- embodied_ops-0.2.0/src/embodied_ops.egg-info/top_level.txt +1 -0
- embodied_ops-0.2.0/tests/test_contracts.py +113 -0
- embodied_ops-0.2.0/tests/test_rpc.py +207 -0
|
@@ -0,0 +1,176 @@
|
|
|
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 reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and 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 choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: embodied-ops
|
|
3
|
+
Version: 0.2.0
|
|
4
|
+
Summary: Capability-oriented protocols for embodied systems
|
|
5
|
+
Author: PengYue
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/pengyue-polaron/embodied-ops
|
|
8
|
+
Project-URL: Repository, https://github.com/pengyue-polaron/embodied-ops
|
|
9
|
+
Project-URL: Issues, https://github.com/pengyue-polaron/embodied-ops/issues
|
|
10
|
+
Keywords: robotics,embodied-ai,sdk,protocol
|
|
11
|
+
Classifier: Development Status :: 3 - Alpha
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Programming Language :: Python :: 3
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
18
|
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
|
19
|
+
Classifier: Typing :: Typed
|
|
20
|
+
Requires-Python: >=3.10
|
|
21
|
+
Description-Content-Type: text/markdown
|
|
22
|
+
License-File: LICENSE
|
|
23
|
+
Provides-Extra: grpc
|
|
24
|
+
Requires-Dist: grpcio<2.0.0,>=1.82.0; extra == "grpc"
|
|
25
|
+
Requires-Dist: protobuf<8.0.0,>=7.35.0; extra == "grpc"
|
|
26
|
+
Dynamic: license-file
|
|
27
|
+
|
|
28
|
+
# embodied-ops
|
|
29
|
+
|
|
30
|
+
`embodied-ops` is a small Python contract for composing embodied systems without
|
|
31
|
+
coupling applications to a particular robot framework or middleware. Its core remains
|
|
32
|
+
dependency-free; the `grpc` extra adds a versioned local service boundary.
|
|
33
|
+
|
|
34
|
+
It standardizes:
|
|
35
|
+
|
|
36
|
+
- capability-oriented device manifests;
|
|
37
|
+
- typed observation and action feature descriptions;
|
|
38
|
+
- strict, non-clamping scalar validation;
|
|
39
|
+
- lifecycle and health protocols;
|
|
40
|
+
- backend discovery through the standard `embodied_ops.backends` entry-point group;
|
|
41
|
+
- an optional Protobuf/gRPC transport over Unix-domain sockets.
|
|
42
|
+
|
|
43
|
+
It intentionally does **not** own ROS nodes, robot drivers, teleoperation mappings,
|
|
44
|
+
datasets, policy runtimes, process supervision, or safety limits. Those belong to
|
|
45
|
+
installed backends and application runtimes.
|
|
46
|
+
|
|
47
|
+
## Backend contract
|
|
48
|
+
|
|
49
|
+
An integration publishes a factory in `pyproject.toml`:
|
|
50
|
+
|
|
51
|
+
```toml
|
|
52
|
+
[project.entry-points."embodied_ops.backends"]
|
|
53
|
+
my_robot = "my_robot_runtime.backend:create_backend"
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
The factory accepts a plain mapping and returns an `OperationalDevice`. Constructing
|
|
57
|
+
the device must not open hardware; callers explicitly invoke `connect()` or use
|
|
58
|
+
`device_session()`.
|
|
59
|
+
|
|
60
|
+
```python
|
|
61
|
+
from embodied_ops import create_device
|
|
62
|
+
|
|
63
|
+
robot = create_device("my_robot", {"config": "robot.toml"})
|
|
64
|
+
robot.connect()
|
|
65
|
+
try:
|
|
66
|
+
print(robot.manifest.to_dict())
|
|
67
|
+
print(robot.health())
|
|
68
|
+
finally:
|
|
69
|
+
robot.disconnect()
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
Additional capabilities are expressed structurally through `ObservableDevice`,
|
|
73
|
+
`CommandDevice`, `CalibratableDevice`, and `ResettableDevice`. Adapters such as
|
|
74
|
+
LeRobot plugins translate these contracts into their framework-native interfaces.
|
|
75
|
+
|
|
76
|
+
## RPC boundary
|
|
77
|
+
|
|
78
|
+
Install the optional transport when an adapter and its hardware runtime must live in
|
|
79
|
+
separate processes:
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
python -m pip install "embodied-ops[grpc]"
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
The runtime owns the real device and serves it; clients receive only the manifest and
|
|
86
|
+
capability operations:
|
|
87
|
+
|
|
88
|
+
```python
|
|
89
|
+
from embodied_ops.rpc import DeviceRpcServer, RemoteDevice
|
|
90
|
+
|
|
91
|
+
endpoint = "unix:///run/my-robot/device.sock"
|
|
92
|
+
server = DeviceRpcServer(
|
|
93
|
+
device,
|
|
94
|
+
endpoint=endpoint,
|
|
95
|
+
lease_timeout_s=1.0,
|
|
96
|
+
command_timeout_s=0.5,
|
|
97
|
+
)
|
|
98
|
+
server.start()
|
|
99
|
+
|
|
100
|
+
robot = RemoteDevice(endpoint=endpoint, client_name="my-adapter")
|
|
101
|
+
robot.connect()
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
Protocol v1 provides describe, observe, command, health, calibration, and reset RPCs.
|
|
105
|
+
It carries scalar features and dependency-free typed tensor payloads. Command sessions
|
|
106
|
+
are exclusive and use opaque session ids, contiguous command sequence numbers,
|
|
107
|
+
monotonic timestamps, server-owned leases, and an independent command-inactivity
|
|
108
|
+
deadman. Heartbeats prove session liveness but do not keep an idle command lease alive.
|
|
109
|
+
Observe-only sessions may coexist. Devices that implement `CommandLeaseDevice` can
|
|
110
|
+
release their command resources while keeping read-only observation attached; other
|
|
111
|
+
devices retain the conservative disconnect-on-command-close behavior. The hardware
|
|
112
|
+
runtime remains responsible for its final fail-closed behavior.
|
|
113
|
+
|
|
114
|
+
Only absolute `unix:///` endpoints are accepted in v1. TCP/TLS policy is intentionally
|
|
115
|
+
not implied by the local protocol.
|
|
116
|
+
|
|
117
|
+
## Versioning
|
|
118
|
+
|
|
119
|
+
The Python package follows semantic versioning. `DeviceManifest.api_version` versions
|
|
120
|
+
the capability contract independently. The wire handshake has its own
|
|
121
|
+
`protocol_version`; both are currently version 1.
|
|
122
|
+
|
|
123
|
+
## Development
|
|
124
|
+
|
|
125
|
+
```bash
|
|
126
|
+
uv sync --extra grpc --dev
|
|
127
|
+
uv run pytest
|
|
128
|
+
uv run ruff check .
|
|
129
|
+
uv run ruff format --check .
|
|
130
|
+
uv build
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
## License
|
|
134
|
+
|
|
135
|
+
Apache-2.0
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
# embodied-ops
|
|
2
|
+
|
|
3
|
+
`embodied-ops` is a small Python contract for composing embodied systems without
|
|
4
|
+
coupling applications to a particular robot framework or middleware. Its core remains
|
|
5
|
+
dependency-free; the `grpc` extra adds a versioned local service boundary.
|
|
6
|
+
|
|
7
|
+
It standardizes:
|
|
8
|
+
|
|
9
|
+
- capability-oriented device manifests;
|
|
10
|
+
- typed observation and action feature descriptions;
|
|
11
|
+
- strict, non-clamping scalar validation;
|
|
12
|
+
- lifecycle and health protocols;
|
|
13
|
+
- backend discovery through the standard `embodied_ops.backends` entry-point group;
|
|
14
|
+
- an optional Protobuf/gRPC transport over Unix-domain sockets.
|
|
15
|
+
|
|
16
|
+
It intentionally does **not** own ROS nodes, robot drivers, teleoperation mappings,
|
|
17
|
+
datasets, policy runtimes, process supervision, or safety limits. Those belong to
|
|
18
|
+
installed backends and application runtimes.
|
|
19
|
+
|
|
20
|
+
## Backend contract
|
|
21
|
+
|
|
22
|
+
An integration publishes a factory in `pyproject.toml`:
|
|
23
|
+
|
|
24
|
+
```toml
|
|
25
|
+
[project.entry-points."embodied_ops.backends"]
|
|
26
|
+
my_robot = "my_robot_runtime.backend:create_backend"
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
The factory accepts a plain mapping and returns an `OperationalDevice`. Constructing
|
|
30
|
+
the device must not open hardware; callers explicitly invoke `connect()` or use
|
|
31
|
+
`device_session()`.
|
|
32
|
+
|
|
33
|
+
```python
|
|
34
|
+
from embodied_ops import create_device
|
|
35
|
+
|
|
36
|
+
robot = create_device("my_robot", {"config": "robot.toml"})
|
|
37
|
+
robot.connect()
|
|
38
|
+
try:
|
|
39
|
+
print(robot.manifest.to_dict())
|
|
40
|
+
print(robot.health())
|
|
41
|
+
finally:
|
|
42
|
+
robot.disconnect()
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Additional capabilities are expressed structurally through `ObservableDevice`,
|
|
46
|
+
`CommandDevice`, `CalibratableDevice`, and `ResettableDevice`. Adapters such as
|
|
47
|
+
LeRobot plugins translate these contracts into their framework-native interfaces.
|
|
48
|
+
|
|
49
|
+
## RPC boundary
|
|
50
|
+
|
|
51
|
+
Install the optional transport when an adapter and its hardware runtime must live in
|
|
52
|
+
separate processes:
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
python -m pip install "embodied-ops[grpc]"
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
The runtime owns the real device and serves it; clients receive only the manifest and
|
|
59
|
+
capability operations:
|
|
60
|
+
|
|
61
|
+
```python
|
|
62
|
+
from embodied_ops.rpc import DeviceRpcServer, RemoteDevice
|
|
63
|
+
|
|
64
|
+
endpoint = "unix:///run/my-robot/device.sock"
|
|
65
|
+
server = DeviceRpcServer(
|
|
66
|
+
device,
|
|
67
|
+
endpoint=endpoint,
|
|
68
|
+
lease_timeout_s=1.0,
|
|
69
|
+
command_timeout_s=0.5,
|
|
70
|
+
)
|
|
71
|
+
server.start()
|
|
72
|
+
|
|
73
|
+
robot = RemoteDevice(endpoint=endpoint, client_name="my-adapter")
|
|
74
|
+
robot.connect()
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
Protocol v1 provides describe, observe, command, health, calibration, and reset RPCs.
|
|
78
|
+
It carries scalar features and dependency-free typed tensor payloads. Command sessions
|
|
79
|
+
are exclusive and use opaque session ids, contiguous command sequence numbers,
|
|
80
|
+
monotonic timestamps, server-owned leases, and an independent command-inactivity
|
|
81
|
+
deadman. Heartbeats prove session liveness but do not keep an idle command lease alive.
|
|
82
|
+
Observe-only sessions may coexist. Devices that implement `CommandLeaseDevice` can
|
|
83
|
+
release their command resources while keeping read-only observation attached; other
|
|
84
|
+
devices retain the conservative disconnect-on-command-close behavior. The hardware
|
|
85
|
+
runtime remains responsible for its final fail-closed behavior.
|
|
86
|
+
|
|
87
|
+
Only absolute `unix:///` endpoints are accepted in v1. TCP/TLS policy is intentionally
|
|
88
|
+
not implied by the local protocol.
|
|
89
|
+
|
|
90
|
+
## Versioning
|
|
91
|
+
|
|
92
|
+
The Python package follows semantic versioning. `DeviceManifest.api_version` versions
|
|
93
|
+
the capability contract independently. The wire handshake has its own
|
|
94
|
+
`protocol_version`; both are currently version 1.
|
|
95
|
+
|
|
96
|
+
## Development
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
uv sync --extra grpc --dev
|
|
100
|
+
uv run pytest
|
|
101
|
+
uv run ruff check .
|
|
102
|
+
uv run ruff format --check .
|
|
103
|
+
uv build
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
## License
|
|
107
|
+
|
|
108
|
+
Apache-2.0
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "embodied-ops"
|
|
3
|
+
version = "0.2.0"
|
|
4
|
+
description = "Capability-oriented protocols for embodied systems"
|
|
5
|
+
readme = "README.md"
|
|
6
|
+
requires-python = ">=3.10"
|
|
7
|
+
license = "Apache-2.0"
|
|
8
|
+
authors = [{ name = "PengYue" }]
|
|
9
|
+
keywords = ["robotics", "embodied-ai", "sdk", "protocol"]
|
|
10
|
+
classifiers = [
|
|
11
|
+
"Development Status :: 3 - Alpha",
|
|
12
|
+
"Intended Audience :: Developers",
|
|
13
|
+
"Programming Language :: Python :: 3",
|
|
14
|
+
"Programming Language :: Python :: 3.10",
|
|
15
|
+
"Programming Language :: Python :: 3.11",
|
|
16
|
+
"Programming Language :: Python :: 3.12",
|
|
17
|
+
"Programming Language :: Python :: 3.13",
|
|
18
|
+
"Topic :: Scientific/Engineering :: Artificial Intelligence",
|
|
19
|
+
"Typing :: Typed",
|
|
20
|
+
]
|
|
21
|
+
dependencies = []
|
|
22
|
+
|
|
23
|
+
[project.optional-dependencies]
|
|
24
|
+
grpc = [
|
|
25
|
+
"grpcio>=1.82.0,<2.0.0",
|
|
26
|
+
"protobuf>=7.35.0,<8.0.0",
|
|
27
|
+
]
|
|
28
|
+
|
|
29
|
+
[project.urls]
|
|
30
|
+
Homepage = "https://github.com/pengyue-polaron/embodied-ops"
|
|
31
|
+
Repository = "https://github.com/pengyue-polaron/embodied-ops"
|
|
32
|
+
Issues = "https://github.com/pengyue-polaron/embodied-ops/issues"
|
|
33
|
+
|
|
34
|
+
[build-system]
|
|
35
|
+
requires = ["setuptools>=77"]
|
|
36
|
+
build-backend = "setuptools.build_meta"
|
|
37
|
+
|
|
38
|
+
[tool.setuptools.packages.find]
|
|
39
|
+
where = ["src"]
|
|
40
|
+
|
|
41
|
+
[tool.setuptools.package-data]
|
|
42
|
+
embodied_ops = ["py.typed"]
|
|
43
|
+
"embodied_ops.rpc.v1" = ["*.proto"]
|
|
44
|
+
|
|
45
|
+
[dependency-groups]
|
|
46
|
+
dev = [
|
|
47
|
+
"build>=1.2",
|
|
48
|
+
"grpcio>=1.82.0,<2.0.0",
|
|
49
|
+
"grpcio-tools>=1.82.0,<2.0.0",
|
|
50
|
+
"protobuf>=7.35.0,<8.0.0",
|
|
51
|
+
"pytest>=8.3",
|
|
52
|
+
"ruff>=0.11",
|
|
53
|
+
]
|
|
54
|
+
|
|
55
|
+
[tool.pytest.ini_options]
|
|
56
|
+
testpaths = ["tests"]
|
|
57
|
+
|
|
58
|
+
[tool.ruff]
|
|
59
|
+
line-length = 100
|
|
60
|
+
target-version = "py310"
|
|
61
|
+
extend-exclude = ["src/embodied_ops/rpc/v1/*_pb2*.py"]
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
"""Public capability protocols for embodied systems."""
|
|
2
|
+
|
|
3
|
+
from ._version import __version__
|
|
4
|
+
from .device import (
|
|
5
|
+
API_VERSION,
|
|
6
|
+
CalibratableDevice,
|
|
7
|
+
Capability,
|
|
8
|
+
CommandDevice,
|
|
9
|
+
CommandLeaseDevice,
|
|
10
|
+
DeviceManifest,
|
|
11
|
+
HealthReport,
|
|
12
|
+
HealthStatus,
|
|
13
|
+
ObservableDevice,
|
|
14
|
+
OperationalDevice,
|
|
15
|
+
ResettableDevice,
|
|
16
|
+
)
|
|
17
|
+
from .errors import (
|
|
18
|
+
BackendConflictError,
|
|
19
|
+
BackendNotFoundError,
|
|
20
|
+
ContractError,
|
|
21
|
+
EmbodiedOpsError,
|
|
22
|
+
LifecycleError,
|
|
23
|
+
RpcError,
|
|
24
|
+
)
|
|
25
|
+
from .endpoints import unix_socket_path
|
|
26
|
+
from .features import FeatureKind, FeatureSpec, index_features, validate_feature_values
|
|
27
|
+
from .registry import (
|
|
28
|
+
BACKEND_ENTRY_POINT_GROUP,
|
|
29
|
+
BackendFactory,
|
|
30
|
+
BackendRegistry,
|
|
31
|
+
create_device,
|
|
32
|
+
default_registry,
|
|
33
|
+
device_session,
|
|
34
|
+
)
|
|
35
|
+
|
|
36
|
+
__all__ = [
|
|
37
|
+
"API_VERSION",
|
|
38
|
+
"BACKEND_ENTRY_POINT_GROUP",
|
|
39
|
+
"BackendConflictError",
|
|
40
|
+
"BackendFactory",
|
|
41
|
+
"BackendNotFoundError",
|
|
42
|
+
"BackendRegistry",
|
|
43
|
+
"CalibratableDevice",
|
|
44
|
+
"Capability",
|
|
45
|
+
"CommandDevice",
|
|
46
|
+
"CommandLeaseDevice",
|
|
47
|
+
"ContractError",
|
|
48
|
+
"DeviceManifest",
|
|
49
|
+
"EmbodiedOpsError",
|
|
50
|
+
"FeatureKind",
|
|
51
|
+
"FeatureSpec",
|
|
52
|
+
"HealthReport",
|
|
53
|
+
"HealthStatus",
|
|
54
|
+
"LifecycleError",
|
|
55
|
+
"ObservableDevice",
|
|
56
|
+
"OperationalDevice",
|
|
57
|
+
"ResettableDevice",
|
|
58
|
+
"RpcError",
|
|
59
|
+
"__version__",
|
|
60
|
+
"create_device",
|
|
61
|
+
"default_registry",
|
|
62
|
+
"device_session",
|
|
63
|
+
"index_features",
|
|
64
|
+
"unix_socket_path",
|
|
65
|
+
"validate_feature_values",
|
|
66
|
+
]
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
__version__ = "0.2.0"
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
"""Capability-oriented device contracts."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
from collections.abc import Mapping
|
|
6
|
+
from dataclasses import dataclass, field
|
|
7
|
+
from enum import Enum
|
|
8
|
+
from types import MappingProxyType
|
|
9
|
+
from typing import Protocol, runtime_checkable
|
|
10
|
+
|
|
11
|
+
from .errors import ContractError
|
|
12
|
+
from .features import FeatureSpec, index_features
|
|
13
|
+
|
|
14
|
+
API_VERSION = 1
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
class Capability(str, Enum):
|
|
18
|
+
OBSERVE = "observe"
|
|
19
|
+
COMMAND = "command"
|
|
20
|
+
HEALTH = "health"
|
|
21
|
+
CALIBRATE = "calibrate"
|
|
22
|
+
RESET = "reset"
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
class HealthStatus(str, Enum):
|
|
26
|
+
UNKNOWN = "unknown"
|
|
27
|
+
HEALTHY = "healthy"
|
|
28
|
+
DEGRADED = "degraded"
|
|
29
|
+
FAULT = "fault"
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
@dataclass(frozen=True, slots=True)
|
|
33
|
+
class HealthReport:
|
|
34
|
+
status: HealthStatus
|
|
35
|
+
summary: str
|
|
36
|
+
details: Mapping[str, object] = field(default_factory=dict)
|
|
37
|
+
|
|
38
|
+
def __post_init__(self) -> None:
|
|
39
|
+
if not self.summary:
|
|
40
|
+
raise ContractError("health summary must not be empty")
|
|
41
|
+
object.__setattr__(self, "details", MappingProxyType(dict(self.details)))
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
@dataclass(frozen=True, slots=True)
|
|
45
|
+
class DeviceManifest:
|
|
46
|
+
"""Backend-neutral description of one operational device."""
|
|
47
|
+
|
|
48
|
+
identifier: str
|
|
49
|
+
capabilities: tuple[Capability, ...]
|
|
50
|
+
observation_features: tuple[FeatureSpec, ...] = ()
|
|
51
|
+
action_features: tuple[FeatureSpec, ...] = ()
|
|
52
|
+
metadata: Mapping[str, str] = field(default_factory=dict)
|
|
53
|
+
api_version: int = API_VERSION
|
|
54
|
+
|
|
55
|
+
def __post_init__(self) -> None:
|
|
56
|
+
if not self.identifier or self.identifier.strip() != self.identifier:
|
|
57
|
+
raise ContractError(f"invalid device identifier: {self.identifier!r}")
|
|
58
|
+
if self.api_version != API_VERSION:
|
|
59
|
+
raise ContractError(
|
|
60
|
+
f"unsupported manifest API version {self.api_version}; expected {API_VERSION}"
|
|
61
|
+
)
|
|
62
|
+
if len(set(self.capabilities)) != len(self.capabilities):
|
|
63
|
+
raise ContractError("device capabilities must be unique")
|
|
64
|
+
index_features(self.observation_features)
|
|
65
|
+
index_features(self.action_features)
|
|
66
|
+
if self.observation_features and Capability.OBSERVE not in self.capabilities:
|
|
67
|
+
raise ContractError("observation features require the observe capability")
|
|
68
|
+
if self.action_features and Capability.COMMAND not in self.capabilities:
|
|
69
|
+
raise ContractError("action features require the command capability")
|
|
70
|
+
object.__setattr__(self, "metadata", MappingProxyType(dict(self.metadata)))
|
|
71
|
+
|
|
72
|
+
def to_dict(self) -> dict[str, object]:
|
|
73
|
+
return {
|
|
74
|
+
"api_version": self.api_version,
|
|
75
|
+
"identifier": self.identifier,
|
|
76
|
+
"capabilities": [capability.value for capability in self.capabilities],
|
|
77
|
+
"observation_features": [feature.to_dict() for feature in self.observation_features],
|
|
78
|
+
"action_features": [feature.to_dict() for feature in self.action_features],
|
|
79
|
+
"metadata": dict(self.metadata),
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
@runtime_checkable
|
|
84
|
+
class OperationalDevice(Protocol):
|
|
85
|
+
"""Minimum lifecycle and health surface implemented by every backend."""
|
|
86
|
+
|
|
87
|
+
@property
|
|
88
|
+
def manifest(self) -> DeviceManifest: ...
|
|
89
|
+
|
|
90
|
+
@property
|
|
91
|
+
def is_connected(self) -> bool: ...
|
|
92
|
+
|
|
93
|
+
def connect(self) -> None: ...
|
|
94
|
+
|
|
95
|
+
def health(self) -> HealthReport: ...
|
|
96
|
+
|
|
97
|
+
def disconnect(self) -> None: ...
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
@runtime_checkable
|
|
101
|
+
class ObservableDevice(OperationalDevice, Protocol):
|
|
102
|
+
def observe(self) -> Mapping[str, object]: ...
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
@runtime_checkable
|
|
106
|
+
class CommandDevice(OperationalDevice, Protocol):
|
|
107
|
+
def command(self, action: Mapping[str, object]) -> Mapping[str, object]: ...
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
@runtime_checkable
|
|
111
|
+
class CommandLeaseDevice(CommandDevice, Protocol):
|
|
112
|
+
"""Optional hooks for transports that grant exclusive command ownership.
|
|
113
|
+
|
|
114
|
+
Observation resources may remain connected while a transport acquires and
|
|
115
|
+
releases the command path independently. Implementations must make release
|
|
116
|
+
fail closed and idempotent.
|
|
117
|
+
"""
|
|
118
|
+
|
|
119
|
+
def acquire_command_lease(self) -> None: ...
|
|
120
|
+
|
|
121
|
+
def release_command_lease(self) -> None: ...
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
@runtime_checkable
|
|
125
|
+
class CalibratableDevice(OperationalDevice, Protocol):
|
|
126
|
+
@property
|
|
127
|
+
def is_calibrated(self) -> bool: ...
|
|
128
|
+
|
|
129
|
+
def calibrate(self) -> None: ...
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
@runtime_checkable
|
|
133
|
+
class ResettableDevice(OperationalDevice, Protocol):
|
|
134
|
+
def reset(self, target: str | None = None) -> None: ...
|