@rainbow-robotics/muscat-plugin-kit 1.10.1-dev.1 → 1.10.1

package/cli/templates/common/assets/icon.svg

@@ -1,45 +1,45 @@
-<svg width="256" height="256" viewBox="0 0 256 256" fill="none" xmlns="http://www.w3.org/2000/svg">
-  <defs>
-    <linearGradient id="bg" x1="36" y1="28" x2="220" y2="228" gradientUnits="userSpaceOnUse">
-      <stop stop-color="#8B5CF6"/>
-      <stop offset="1" stop-color="#5B21B6"/>
-    </linearGradient>
-    <linearGradient id="grape" x1="92" y1="74" x2="168" y2="178" gradientUnits="userSpaceOnUse">
-      <stop stop-color="#D8B4FE"/>
-      <stop offset="1" stop-color="#A855F7"/>
-    </linearGradient>
-  </defs>
-
-  <rect x="16" y="16" width="224" height="224" rx="52" fill="url(#bg)"/>
-
-  <!-- plugin brackets -->
-  <path d="M72 84H56C47.1634 84 40 91.1634 40 100V116" stroke="white" stroke-width="12" stroke-linecap="round"/>
-  <path d="M184 84H200C208.837 84 216 91.1634 216 100V116" stroke="white" stroke-width="12" stroke-linecap="round"/>
-  <path d="M72 172H56C47.1634 172 40 164.837 40 156V140" stroke="white" stroke-width="12" stroke-linecap="round"/>
-  <path d="M184 172H200C208.837 172 216 164.837 216 156V140" stroke="white" stroke-width="12" stroke-linecap="round"/>
-
-  <!-- grape stem + leaf -->
-  <path d="M128 73C128 59 137 48 151 44" stroke="#F3E8FF" stroke-width="10" stroke-linecap="round"/>
-  <path d="M142 51C151 39 169 39 179 50C165 60 151 62 142 51Z" fill="#C4B5FD"/>
-
-  <!-- muscat grape cluster -->
-  <circle cx="106" cy="91" r="18" fill="url(#grape)"/>
-  <circle cx="132" cy="88" r="18" fill="url(#grape)"/>
-  <circle cx="158" cy="91" r="18" fill="url(#grape)"/>
-  <circle cx="94" cy="119" r="18" fill="url(#grape)"/>
-  <circle cx="120" cy="116" r="18" fill="url(#grape)"/>
-  <circle cx="146" cy="116" r="18" fill="url(#grape)"/>
-  <circle cx="172" cy="119" r="18" fill="url(#grape)"/>
-  <circle cx="107" cy="145" r="18" fill="url(#grape)"/>
-  <circle cx="133" cy="144" r="18" fill="url(#grape)"/>
-  <circle cx="159" cy="145" r="18" fill="url(#grape)"/>
-  <circle cx="120" cy="170" r="18" fill="url(#grape)"/>
-  <circle cx="146" cy="170" r="18" fill="url(#grape)"/>
-  <circle cx="133" cy="193" r="18" fill="url(#grape)"/>
-
-  <!-- center plugin glyph -->
-  <path d="M122 119V109C122 103.477 126.477 99 132 99H136C141.523 99 146 103.477 146 109V119" stroke="white" stroke-width="8" stroke-linecap="round"/>
-  <rect x="116" y="118" width="36" height="34" rx="10" fill="white"/>
-  <path d="M127 152V163" stroke="white" stroke-width="8" stroke-linecap="round"/>
-  <path d="M141 152V163" stroke="white" stroke-width="8" stroke-linecap="round"/>
-</svg>
+<svg width="256" height="256" viewBox="0 0 256 256" fill="none" xmlns="http://www.w3.org/2000/svg">
+  <defs>
+    <linearGradient id="bg" x1="36" y1="28" x2="220" y2="228" gradientUnits="userSpaceOnUse">
+      <stop stop-color="#8B5CF6"/>
+      <stop offset="1" stop-color="#5B21B6"/>
+    </linearGradient>
+    <linearGradient id="grape" x1="92" y1="74" x2="168" y2="178" gradientUnits="userSpaceOnUse">
+      <stop stop-color="#D8B4FE"/>
+      <stop offset="1" stop-color="#A855F7"/>
+    </linearGradient>
+  </defs>
+
+  <rect x="16" y="16" width="224" height="224" rx="52" fill="url(#bg)"/>
+
+  <!-- plugin brackets -->
+  <path d="M72 84H56C47.1634 84 40 91.1634 40 100V116" stroke="white" stroke-width="12" stroke-linecap="round"/>
+  <path d="M184 84H200C208.837 84 216 91.1634 216 100V116" stroke="white" stroke-width="12" stroke-linecap="round"/>
+  <path d="M72 172H56C47.1634 172 40 164.837 40 156V140" stroke="white" stroke-width="12" stroke-linecap="round"/>
+  <path d="M184 172H200C208.837 172 216 164.837 216 156V140" stroke="white" stroke-width="12" stroke-linecap="round"/>
+
+  <!-- grape stem + leaf -->
+  <path d="M128 73C128 59 137 48 151 44" stroke="#F3E8FF" stroke-width="10" stroke-linecap="round"/>
+  <path d="M142 51C151 39 169 39 179 50C165 60 151 62 142 51Z" fill="#C4B5FD"/>
+
+  <!-- muscat grape cluster -->
+  <circle cx="106" cy="91" r="18" fill="url(#grape)"/>
+  <circle cx="132" cy="88" r="18" fill="url(#grape)"/>
+  <circle cx="158" cy="91" r="18" fill="url(#grape)"/>
+  <circle cx="94" cy="119" r="18" fill="url(#grape)"/>
+  <circle cx="120" cy="116" r="18" fill="url(#grape)"/>
+  <circle cx="146" cy="116" r="18" fill="url(#grape)"/>
+  <circle cx="172" cy="119" r="18" fill="url(#grape)"/>
+  <circle cx="107" cy="145" r="18" fill="url(#grape)"/>
+  <circle cx="133" cy="144" r="18" fill="url(#grape)"/>
+  <circle cx="159" cy="145" r="18" fill="url(#grape)"/>
+  <circle cx="120" cy="170" r="18" fill="url(#grape)"/>
+  <circle cx="146" cy="170" r="18" fill="url(#grape)"/>
+  <circle cx="133" cy="193" r="18" fill="url(#grape)"/>
+
+  <!-- center plugin glyph -->
+  <path d="M122 119V109C122 103.477 126.477 99 132 99H136C141.523 99 146 103.477 146 109V119" stroke="white" stroke-width="8" stroke-linecap="round"/>
+  <rect x="116" y="118" width="36" height="34" rx="10" fill="white"/>
+  <path d="M127 152V163" stroke="white" stroke-width="8" stroke-linecap="round"/>
+  <path d="M141 152V163" stroke="white" stroke-width="8" stroke-linecap="round"/>
+</svg>

package/cli/templates/common/manifest.json

@@ -1,26 +1,26 @@
-{
-  "id": "__PLUGIN_ID__",
-  "name": "__PLUGIN_NAME__",
-  "version": "1.0.0",
-  "minMuscatVersion": "1.0.0",
-  "author": "__PLUGIN_AUTHOR__",
-  "email": "__PLUGIN_EMAIL__",
-  "description": {
-    "ko": "",
-    "en": ""
-  },
-  "icons": "assets/icon.svg",
-  "targetModels": "all",
-  "targetCategorys": "all",
-  "contributes": [
-    {
-      "point": "toolbar",
-      "icon": "assets/icon.svg",
-      "label": { "ko": "__PLUGIN_NAME__", "en": "__PLUGIN_NAME__" },
-      "ui": "content",
-      "opens": "popover"
-    }
-  ],
-  "variables": [],
-  "runtime": { "type": "__RUNTIME_TYPE__", "entry": "main.py" }
-}
+{
+  "id": "__PLUGIN_ID__",
+  "name": "__PLUGIN_NAME__",
+  "version": "1.0.0",
+  "minMuscatVersion": "1.0.0",
+  "author": "__PLUGIN_AUTHOR__",
+  "email": "__PLUGIN_EMAIL__",
+  "description": {
+    "ko": "",
+    "en": ""
+  },
+  "icons": "assets/icon.svg",
+  "targetModels": "all",
+  "targetCategorys": "all",
+  "contributes": [
+    {
+      "point": "toolbar",
+      "icon": "assets/icon.svg",
+      "label": { "ko": "__PLUGIN_NAME__", "en": "__PLUGIN_NAME__" },
+      "ui": "content",
+      "opens": "popover"
+    }
+  ],
+  "variables": [],
+  "runtime": { "type": "__RUNTIME_TYPE__", "entry": "main.py" }
+}

package/cli/templates/common/package.json

@@ -1,22 +1,22 @@
-{
-  "name": "__PLUGIN_ID__",
-  "version": "1.0.0",
-  "private": true,
-  "type": "module",
-  "dependencies": {
-    "@rainbow-robotics/plugin-ui": "__RB_VERSION__"
-  },
-  "devDependencies": {
-    "@tailwindcss/vite": "^4.1.0",
-    "@rainbow-robotics/muscat-plugin-kit": "__RB_VERSION__",
-    "@rainbow-robotics/preview-host": "__RB_VERSION__",
-    "@types/react": "^19.0.10",
-    "@types/react-dom": "^19.0.4",
-    "@vitejs/plugin-react": "^4.0.0",
-    "react": "^19.0.0",
-    "react-dom": "^19.0.0",
-    "tailwindcss": "^4.1.0",
-    "typescript": "^5.8.0",
-    "vite": "^6.0.0"
-  }
-}
+{
+  "name": "__PLUGIN_ID__",
+  "version": "1.0.0",
+  "private": true,
+  "type": "module",
+  "dependencies": {
+    "@rainbow-robotics/plugin-ui": "__RB_VERSION__"
+  },
+  "devDependencies": {
+    "@tailwindcss/vite": "^4.1.0",
+    "@rainbow-robotics/muscat-plugin-kit": "__RB_VERSION__",
+    "@rainbow-robotics/preview-host": "__RB_VERSION__",
+    "@types/react": "^19.0.10",
+    "@types/react-dom": "^19.0.4",
+    "@vitejs/plugin-react": "^4.0.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "tailwindcss": "^4.1.0",
+    "typescript": "^5.8.0",
+    "vite": "^6.0.0"
+  }
+}

package/cli/templates/common/py/main.py

@@ -1,125 +1,125 @@
-"""
-Muscat plugin backend — __PLUGIN_NAME__
-
-On-robot (default):
-  muscat-pk dev:back
-  python main.py
-
-Remote dev (from your laptop):
-  Set env vars before running:
-    MUSCAT_ROBOT_HOST=192.168.1.100
-    MUSCAT_ROBOT_TOKEN=<service token>
-  Then: muscat-pk dev:back
-
-Handlers:
-  plugin.serve / plugin.subscribe / plugin.publish  -> plugin UI <-> backend only
-  plugin.router.on / subscribe / emit               -> external endpoints
-    (REST / Socket.IO / TCP / MQTT / WebRTC at common/plugin/<plugin_id>/<path>).
-    Needs a robot running rainbow-rb-sdk >= 0.0.9.dev5; older robots have no
-    `plugin.router` (AttributeError). See README "External endpoints".
-"""
-
-import asyncio
-import os
-from typing import Any
-
-from rainbow.rb_sdk import RBManipulateSDK, RBPluginCall
-from rainbow.rb_sdk.rb_sdk_cpp import ConnectOptions
-
-
-PLUGIN_NAME = "__PLUGIN_NAME__"
-
-plugin = RBPluginCall()
-manipulate = RBManipulateSDK()
-
-
-def register_handlers():
-    # Register handlers here — called after connect() so subscriptions survive
-    # session reconnection in remote-dev mode.
-
-    # --- Plugin UI <-> backend (not reachable from outside Muscat) ---
-
-    @plugin.subscribe("event")
-    def on_ui_event(payload: dict[str, Any] | None = None):
-        """Handle messages published from the plugin UI with rb.pub("event", ...)."""
-        print(f"[{PLUGIN_NAME}] event:", payload)
-
-    @plugin.serve("grip")
-    def grip(payload: dict[str, Any] | None = None):
-        """Handle the default UI button: rb.action("grip", { width })."""
-        width = (payload or {}).get("width", 20)
-        print(f"[{PLUGIN_NAME}] grip requested: width={width}")
-        plugin.publish("state", {"ready": True, "last_grip_width": width})
-        return {"ok": True, "width": width}
-
-    @plugin.serve("tool/echo")
-    def echo(payload: dict[str, Any] | None = None):
-        """Small query example callable from the UI with rb.action("tool/echo", ...)."""
-        return {"echo": payload, "plugin": PLUGIN_NAME}
-
-    # --- External endpoints (REST / Socket.IO / TCP / MQTT / WebRTC) ---
-    # Exposed as common/plugin/<plugin_id>/hello, e.g.
-    #   curl -X POST http://<robot>/common/plugin/<plugin_id>/hello \
-    #        -H 'Content-Type: application/json' -d '{"name": "kim"}'
-    # Restrict transports with explicit_routes=["api"] (REST only), etc.
-    # Raise PluginRouteError(403, "msg") to set the response status.
-
-    @plugin.router.on("/hello")
-    def hello(payload: dict[str, Any] | None = None, meta: dict[str, Any] | None = None):
-        """meta = {"transport": "api"|"socket"|"tcp"|"mqtt"|"webrtc", "principal": dict | None}."""
-        name = (payload or {}).get("name", "there")
-        return {"msg": f"hi {name}", "via": (meta or {}).get("transport")}
-
-
-def move_j_example():
-    """
-    Example: use other robot SDKs from the same backend.
-
-    This function is not called automatically. Add safety checks and call it
-    from your own handler when the robot is ready.
-    """
-    return manipulate.move.call_move_j(
-        robot_model="C500920",
-        target={
-            "tar_values": [0, 0, 0, 0, 0, 0],
-            "tar_frame": 0,
-            "tar_unit": 0,
-        },
-    )
-
-
-async def main():
-    robot_host = os.getenv("MUSCAT_ROBOT_HOST")
-    robot_token = os.getenv("MUSCAT_ROBOT_TOKEN")
-
-    if robot_host and robot_token:
-        # Remote dev: connect to the robot before registering any handlers.
-        # connect() closes and reopens the Zenoh session, so handlers registered
-        # before this call would be lost.
-        opts = ConnectOptions()
-        opts.token = robot_token
-        opts.host = robot_host
-        manipulate.connect(opts)
-
-    register_handlers()
-
-    plugin.publish("state", {"ready": True, "plugin": PLUGIN_NAME})       # -> plugin UI
-    plugin.router.emit("/state", {"ready": True, "plugin": PLUGIN_NAME})  # -> external subscribers of common/plugin/<plugin_id>/state
-    print(f"[{PLUGIN_NAME}] backend ready")
-
-    try:
-        while True:
-            await asyncio.sleep(1)
-    except (KeyboardInterrupt, asyncio.CancelledError):
-        pass
-    finally:
-        if robot_host and robot_token:
-            await manipulate.disconnect()
-        print(f"[{PLUGIN_NAME}] stopped")
-
-
-if __name__ == "__main__":
-    try:
-        asyncio.run(main())
-    except KeyboardInterrupt:
-        pass
+"""
+Muscat plugin backend — __PLUGIN_NAME__
+
+On-robot (default):
+  muscat-pk dev:back
+  python main.py
+
+Remote dev (from your laptop):
+  Set env vars before running:
+    MUSCAT_ROBOT_HOST=192.168.1.100
+    MUSCAT_ROBOT_TOKEN=<service token>
+  Then: muscat-pk dev:back
+
+Handlers:
+  plugin.serve / plugin.subscribe / plugin.publish  -> plugin UI <-> backend only
+  plugin.router.on / subscribe / emit               -> external endpoints
+    (REST / Socket.IO / TCP / MQTT / WebRTC at common/plugin/<plugin_id>/<path>).
+    Needs a robot running rainbow-rb-sdk >= 0.0.9.dev5; older robots have no
+    `plugin.router` (AttributeError). See README "External endpoints".
+"""
+
+import asyncio
+import os
+from typing import Any
+
+from rainbow.rb_sdk import RBManipulateSDK, RBPluginCall
+from rainbow.rb_sdk.rb_sdk_cpp import ConnectOptions
+
+
+PLUGIN_NAME = "__PLUGIN_NAME__"
+
+plugin = RBPluginCall()
+manipulate = RBManipulateSDK()
+
+
+def register_handlers():
+    # Register handlers here — called after connect() so subscriptions survive
+    # session reconnection in remote-dev mode.
+
+    # --- Plugin UI <-> backend (not reachable from outside Muscat) ---
+
+    @plugin.subscribe("event")
+    def on_ui_event(payload: dict[str, Any] | None = None):
+        """Handle messages published from the plugin UI with rb.pub("event", ...)."""
+        print(f"[{PLUGIN_NAME}] event:", payload)
+
+    @plugin.serve("grip")
+    def grip(payload: dict[str, Any] | None = None):
+        """Handle the default UI button: rb.action("grip", { width })."""
+        width = (payload or {}).get("width", 20)
+        print(f"[{PLUGIN_NAME}] grip requested: width={width}")
+        plugin.publish("state", {"ready": True, "last_grip_width": width})
+        return {"ok": True, "width": width}
+
+    @plugin.serve("tool/echo")
+    def echo(payload: dict[str, Any] | None = None):
+        """Small query example callable from the UI with rb.action("tool/echo", ...)."""
+        return {"echo": payload, "plugin": PLUGIN_NAME}
+
+    # --- External endpoints (REST / Socket.IO / TCP / MQTT / WebRTC) ---
+    # Exposed as common/plugin/<plugin_id>/hello, e.g.
+    #   curl -X POST http://<robot>/common/plugin/<plugin_id>/hello \
+    #        -H 'Content-Type: application/json' -d '{"name": "kim"}'
+    # Restrict transports with explicit_routes=["api"] (REST only), etc.
+    # Raise PluginRouteError(403, "msg") to set the response status.
+
+    @plugin.router.on("/hello")
+    def hello(payload: dict[str, Any] | None = None, meta: dict[str, Any] | None = None):
+        """meta = {"transport": "api"|"socket"|"tcp"|"mqtt"|"webrtc", "principal": dict | None}."""
+        name = (payload or {}).get("name", "there")
+        return {"msg": f"hi {name}", "via": (meta or {}).get("transport")}
+
+
+def move_j_example():
+    """
+    Example: use other robot SDKs from the same backend.
+
+    This function is not called automatically. Add safety checks and call it
+    from your own handler when the robot is ready.
+    """
+    return manipulate.move.call_move_j(
+        robot_model="C500920",
+        target={
+            "tar_values": [0, 0, 0, 0, 0, 0],
+            "tar_frame": 0,
+            "tar_unit": 0,
+        },
+    )
+
+
+async def main():
+    robot_host = os.getenv("MUSCAT_ROBOT_HOST")
+    robot_token = os.getenv("MUSCAT_ROBOT_TOKEN")
+
+    if robot_host and robot_token:
+        # Remote dev: connect to the robot before registering any handlers.
+        # connect() closes and reopens the Zenoh session, so handlers registered
+        # before this call would be lost.
+        opts = ConnectOptions()
+        opts.token = robot_token
+        opts.host = robot_host
+        manipulate.connect(opts)
+
+    register_handlers()
+
+    plugin.publish("state", {"ready": True, "plugin": PLUGIN_NAME})       # -> plugin UI
+    plugin.router.emit("/state", {"ready": True, "plugin": PLUGIN_NAME})  # -> external subscribers of common/plugin/<plugin_id>/state
+    print(f"[{PLUGIN_NAME}] backend ready")
+
+    try:
+        while True:
+            await asyncio.sleep(1)
+    except (KeyboardInterrupt, asyncio.CancelledError):
+        pass
+    finally:
+        if robot_host and robot_token:
+            await manipulate.disconnect()
+        print(f"[{PLUGIN_NAME}] stopped")
+
+
+if __name__ == "__main__":
+    try:
+        asyncio.run(main())
+    except KeyboardInterrupt:
+        pass

package/cli/templates/common/tsconfig.json

@@ -1,13 +1,13 @@
-{
-  "compilerOptions": {
-    "target": "ESNext",
-    "module": "ESNext",
-    "moduleResolution": "bundler",
-    "jsx": "react-jsx",
-    "strict": true,
-    "skipLibCheck": true,
-    "noEmit": true,
-    "lib": ["DOM", "DOM.Iterable", "ESNext"]
-  },
-  "include": ["ui"]
-}
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "jsx": "react-jsx",
+    "strict": true,
+    "skipLibCheck": true,
+    "noEmit": true,
+    "lib": ["DOM", "DOM.Iterable", "ESNext"]
+  },
+  "include": ["ui"]
+}