Merge remote-tracking branch 'origin/feat/agentic-architecture' into feat/cb2ui-robot-connections

.githooks/commit-msg

@@ -0,0 +1,17 @@
+#!/bin/sh
+
+commit_msg_file=$1
+commit_msg=$(cat "$commit_msg_file")
+
+if echo "$commit_msg" | grep -Eq "^(feat|fix|refactor|perf|style|test|docs|build|chore|revert): .+"; then
+  if echo "$commit_msg" | grep -Eq "^(ref|close):\sN25B-.+"; then
+    echo "🎉 commit message is Valid"
+    exit 0
+  else
+    echo "❌ Commit message invalid! Must end with [ref/close]: N25B-000"
+    exit 1
+  fi
+else
+  echo "❌ Commit message invalid! Must start with <type>: <description>"
+  exit 1
+fi

.githooks/pre-commit

@@ -0,0 +1,18 @@
+#!/bin/sh
+
+# Get current branch
+branch=$(git rev-parse --abbrev-ref HEAD)
+
+if echo "$branch" | grep -Eq "(dev|main)"; then
+  echo 0
+fi
+
+# allowed pattern <type/>
+if echo "$branch" | grep -Eq "^(feat|fix|refactor|perf|style|test|docs|build|chore|revert)\/\w+(-\w+){0,5}$"; then
+  echo "✅ Branch name valid: $branch"
+  exit 0
+else
+  echo "❌ Invalid branch name: $branch"
+  echo "Branch must be named <type>/<description-of-branch> (must have one to six words separated by a dash)"
+  exit 1
+fi

.githooks/prepare-commit-msg

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+echo "#<type>: <description>
+
+#[optional body]
+
+#[optional footer(s)]
+
+#[ref/close]: <issue identifier>" > $1

README.md

@@ -1,93 +1,24 @@
-# PepperPlus-CB
-
-
-
-## Getting started
-
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
-
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
-
-## Add your files
-
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
+## Development environment
+We begin by installing UV (very nice utility for managing packages and Python version):
 
+```bash
+# On macOS and Linux.
+curl -LsSf https://astral.sh/uv/install.sh | sh
 ```
-cd existing_repo
-git remote add origin https://git.science.uu.nl/ics/sp/2025/n25b/pepperplus-cb.git
-git branch -M main
-git push -uf origin main
+```bash
+# On Windows.
+powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
 ```
 
-## Integrate with your tools
+Using UV, installing the packages and virtual environment is as simple as typing the following (inside the root directory of this repository):
 
-- [ ] [Set up project integrations](https://git.science.uu.nl/ics/sp/2025/n25b/pepperplus-cb/-/settings/integrations)
+```bash
+uv sync
+```
 
-## Collaborate with your team
+## Running
+To run the project (development server), execute the following command (while inside the root repository):
 
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)
-
-## Test and Deploy
-
-Use the built-in continuous integration in GitLab.
-
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
-
-***
-
-# Editing this README
-
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
-
-## Suggestions for a good README
-
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
-
-## Name
-Choose a self-explaining name for your project.
-
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
-
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
-
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
-
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
-
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
-
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
-
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
-
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
-
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
-
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
-
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
-
-## License
-For open source projects, say how it is licensed.
-
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+```bash
+uv run fastapi dev src/control_backend/main.py
+```

pyproject.toml

@@ -5,5 +5,15 @@ description = "Add your description here"
 readme = "README.md"
 requires-python = ">=3.13"
 dependencies = [
-    "fastapi[all]>=0.117.1",
+    "fastapi[all]>=0.115.6",
+    "mlx-whisper>=0.4.3 ; sys_platform == 'darwin'",
+    "openai-whisper>=20250625",
+    "pyaudio>=0.2.14",
+    "pydantic>=2.12.0",
+    "pydantic-settings>=2.11.0",
+    "pyzmq>=27.1.0",
+    "silero-vad>=6.0.0",
+    "spade>=4.1.0",
+    "torch>=2.8.0",
+    "uvicorn>=0.37.0",
 ]

src/control_backend/agents/test_agent.py

@@ -0,0 +1,37 @@
+import json
+import logging
+from spade.agent import Agent
+from spade.behaviour import CyclicBehaviour
+import zmq
+
+from control_backend.core.config import settings
+from control_backend.core.zmq_context import context
+from control_backend.schemas.message import Message
+
+logger = logging.getLogger(__name__)
+
+class TestAgent(Agent):
+    socket: zmq.Socket
+
+    class ListenBehaviour(CyclicBehaviour):
+        async def run(self):
+            assert self.agent is not None
+            topic, body = await self.agent.socket.recv_multipart()
+            
+            try:
+                message_json = json.loads(body.decode("utf-8"))
+                message = Message.model_validate(message_json)
+                logger.info("Received message \"%s\"", message.message)
+            except Exception as e:
+                logger.error("Error processing message: %s", e)
+
+    async def setup(self):
+        logger.info("Setting up %s", self.jid)
+        self.socket = context.socket(zmq.SUB)
+        self.socket.connect(settings.zmq_settings.internal_comm_address)
+        self.socket.setsockopt(zmq.SUBSCRIBE, b"message")
+
+        b = self.ListenBehaviour()
+        self.add_behaviour(b)
+
+        logger.info("Finished setting up %s", self.jid)

src/control_backend/api/v1/endpoints/message.py

@@ -0,0 +1,23 @@
+from fastapi import APIRouter, Request
+import logging
+
+from zmq import Socket
+
+from control_backend.schemas.message import Message
+
+logger = logging.getLogger(__name__)
+
+router = APIRouter()
+
+@router.post("/message", status_code=202)
+async def receive_message(message: Message, request: Request):
+    logger.info("Received message: %s", message.message)
+
+    topic = b"message"
+    body = message.model_dump_json().encode("utf-8")
+
+    pub_socket: Socket = request.app.state.internal_comm_socket
+
+    pub_socket.send_multipart([topic, body])
+
+    return {"status": "Message received"}

src/control_backend/api/v1/endpoints/sse.py

@@ -0,0 +1,8 @@
+from fastapi import APIRouter, Request
+
+router = APIRouter()
+
+# TODO: implement
+@router.get("/sse")
+async def sse(request: Request):
+    pass

src/control_backend/api/v1/router.py

@@ -0,0 +1,15 @@
+from fastapi.routing import APIRouter
+
+from control_backend.api.v1.endpoints import message, sse
+
+api_router = APIRouter()
+
+api_router.include_router(
+    message.router,
+    tags=["Messages"]
+)
+
+api_router.include_router(
+    sse.router,
+    tags=["SSE"]
+)

src/control_backend/core/config.py

@@ -0,0 +1,16 @@
+from pydantic import BaseModel
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+class ZMQSettings(BaseModel):
+    internal_comm_address: str = "tcp://localhost:5560"
+
+class Settings(BaseSettings):
+    app_title: str = "PepperPlus"
+    
+    ui_url: str = "http://localhost:5173"
+
+    zmq_settings: ZMQSettings = ZMQSettings()
+    
+    model_config = SettingsConfigDict(env_file=".env")
+    
+settings = Settings()

src/control_backend/core/zmq_context.py

@@ -0,0 +1,3 @@
+from zmq.asyncio import Context
+
+context = Context()

src/control_backend/main.py

@@ -0,0 +1,51 @@
+# External imports
+import contextlib
+from fastapi import FastAPI
+from fastapi.middleware.cors import CORSMiddleware
+import logging
+import zmq
+
+# Internal imports
+from control_backend.agents.test_agent import TestAgent
+from control_backend.api.v1.router import api_router
+from control_backend.core.config import settings
+from control_backend.core.zmq_context import context
+
+logger = logging.getLogger(__name__)
+logging.basicConfig(level=logging.INFO)
+
+@contextlib.asynccontextmanager
+async def lifespan(app: FastAPI):
+    logger.info("%s starting up.", app.title)
+
+    # Initiate sockets
+    internal_comm_socket = context.socket(zmq.PUB)
+    internal_comm_address = settings.zmq_settings.internal_comm_address
+    internal_comm_socket.bind(internal_comm_address)
+    app.state.internal_comm_socket = internal_comm_socket
+    logger.info("Internal publishing socket bound to %s", internal_comm_socket)
+
+    # Initiate agents
+    test_agent = TestAgent("test_agent@localhost", "test_agent")
+    await test_agent.start()
+    
+    yield
+    
+    logger.info("%s shutting down.", app.title)
+    
+
+# if __name__ == "__main__":
+app = FastAPI(title=settings.app_title, lifespan=lifespan)
+
+# This middleware allows other origins to communicate with us
+app.add_middleware(
+    CORSMiddleware, # https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/CORS
+    allow_origins=[settings.ui_url], # address of our UI application
+    allow_methods=["*"], # GET, POST, etc.
+)
+
+app.include_router(api_router, prefix="") # TODO: make prefix /api/v1
+
+@app.get("/")
+async def root():
+    return {"status": "ok"}

src/control_backend/schemas/message.py

@@ -0,0 +1,4 @@
+from pydantic import BaseModel
+
+class Message(BaseModel):
+    message: str