yrcom 0.2.0__py3-none-any.whl

yrcom-0.2.0.dist-info/METADATA

@@ -0,0 +1,112 @@
+Metadata-Version: 2.4
+Name: yrcom
+Version: 0.2.0
+Summary: Yaskawa robot communication — Ethernet Server, HSES and HSES File Control (pure stdlib)
+Author: cmosbk
+License: MIT
+Project-URL: Homepage, https://github.com/CMOSBK/yrcom
+Project-URL: Issues, https://github.com/CMOSBK/yrcom/issues
+Keywords: yaskawa,robot,hses,ethernet-server,motoman,yrc1000
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Dynamic: license-file
+
+# yrcom
+
+[![CI](https://github.com/CMOSBK/yrcom/actions/workflows/ci.yml/badge.svg)](https://github.com/CMOSBK/yrcom/actions/workflows/ci.yml)
+
+Yaskawa robot communication as a standalone Python library — a single,
+hardware-verified communication core meant to be shared across projects
+instead of being duplicated.
+
+The name: **YRC** (Yaskawa Robot Controller, e.g. YRC1000) + **COM**munication.
+
+**Pure stdlib** — no runtime dependencies. Import name: `yrcom`.
+
+## Transports
+
+| Class | Transport | Purpose |
+|---|---|---|
+| `YaskawaClient` | Ethernet Server, TCP 80 | classic host-control commands |
+| `HsesClient` | HSES, UDP 10040 | high speed: 45 commands (status, alarms, variables, IO, telemetry, motion) |
+| `HsesFileClient` | HSES File Control, UDP 10041 | read/write job files, file list, CMOS backup |
+| `RobotConnection` | ES + HSES behind one IP | pick the transport via `transport="hses"\|"ethernet"` |
+| `HsesReplayServer` | — (testing) | replays a recorded robot session as a UDP server → offline development/testing |
+
+Command coverage: HSES Robot Control **45/45**, File Control **5/5**
+(verified against real hardware: YRC1000, SW YAS5.40).
+
+## Installation
+
+```bash
+pip install yrcom           # from PyPI
+```
+
+For development:
+
+```bash
+pip install -e ".[dev]"     # editable install incl. pytest
+```
+
+## Quick start
+
+```python
+from yrcom import HsesClient
+
+c = HsesClient("192.0.2.10")    # UDP 10040
+c.open()
+print(c.read_status())          # {'servo_on': False, 'teach': True, ...}
+print(c.read_d_var(0))          # D[0]
+c.close()
+```
+
+Transport-agnostic via `RobotConnection`:
+
+```python
+from yrcom import RobotConnection
+
+rc = RobotConnection("192.0.2.10", transport="hses")
+rc.connect()
+print(rc.status())              # same keys, whether HSES or ES
+```
+
+## Offline: the replay simulator
+
+Record a controller's real responses as JSON (tx/rx pairs per command, see
+`tests/fixtures/sample_capture.json` for the format) and replay them — the
+real `HsesClient` talks to the simulator:
+
+```python
+from yrcom import HsesReplayServer, HsesClient
+
+with HsesReplayServer.from_capture("capture.json") as srv:
+    c = HsesClient("127.0.0.1", srv.port); c.open()
+    print(c.read_status())      # recorded response, no robot needed
+```
+
+Or as a standalone server: `python -m yrcom.hses_sim capture.json --port 10040`.
+
+## Legal
+
+Independent community project, not affiliated with or endorsed by Yaskawa.
+*Yaskawa*, *Motoman* and *YRC1000* are trademarks of Yaskawa Electric
+Corporation and are used here descriptively (compatibility) only. The
+implementation is based on the publicly available protocol manuals
+(HW0483202, HW1483358).
+
+## Tests
+
+```bash
+pip install -e ".[dev]"
+pytest
+```
+
+The tests run **without a robot**: a stateful ES mock (`tests/mock_robot.py`)
+and a small HSES capture fixture (`tests/fixtures/`).
+
+## License
+
+MIT — see [LICENSE](LICENSE).

yrcom-0.2.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+yrcom/__init__.py,sha256=7UyqyMY7-M7zwMVNpx9ptK2DscZ_THFpJ1HTmYG7K-U,1622
+yrcom/hses_client.py,sha256=56EFOwPQ-tpY-VmnPcLkAndtAH_61sKnWXhlMAClm60,74320
+yrcom/hses_errors.py,sha256=c6nhqNGpyATrJdppndAlmoMRw-Icd5y_UJhQ2TYFdTY,8199
+yrcom/hses_file.py,sha256=OHQKSNiAwwHRw3z7B_h6OjS4HuwiQkszsFdRhG44pok,11124
+yrcom/hses_sim.py,sha256=xQxFeRNRhgWCej5xHL42b_gwuym2dJS4uRiDzX_oiz8,6276
+yrcom/robot_connection.py,sha256=ASN1YcmMir1HJMXfOEmusoeZnpX0_BkvNYI1vArZPPQ,18309
+yrcom/yaskawa_client.py,sha256=nlWpiFADc1trpLfKzcbqNbipBCXPLMVHrAWJc3CkTIk,27014
+yrcom-0.2.0.dist-info/licenses/LICENSE,sha256=XVWHFASfdf1BpVm21aFktjxmg-qTFWVHG8PGGx4hsrU,1063
+yrcom-0.2.0.dist-info/METADATA,sha256=tEK-ypx4L7LM7_FoF3FqyCX1ATbY2yIjjErmUOoRxKg,3415
+yrcom-0.2.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+yrcom-0.2.0.dist-info/entry_points.txt,sha256=vpDNDtqn2pgTTxgn-nJq6de4skJEdxYXOz1XoFuFqu0,51
+yrcom-0.2.0.dist-info/top_level.txt,sha256=YF9HbmaX5IOpXTkwPopCLk7gAp9rKbee3_4WB3hPP_M,6
+yrcom-0.2.0.dist-info/RECORD,,

yrcom-0.2.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

yrcom-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+yrcom-sim = yrcom.hses_sim:_main

yrcom-0.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 cmosbk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

yrcom-0.2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+yrcom