Johnny Fernandes
7ab69ab0f3
Naming pass: rename functions whose third+ segment is redundant or implementation-detail, sticking to the codebase's preferred ``noun_verb`` / ``verb_noun`` two-concept idiom. Renames are atomic across definitions, callers, and tests. is_penned_position → is_penned modulate_speed_near_sheep → modulate_speed mecanum_kinematics_step → mecanum_step policy_forward_mean → forward_mean Two-concept patterns like ``velocity_to_wheels`` / ``detections_from_scan`` / ``make_strombom_predictor`` are left alone — they're idiomatic converters / factories that read as a single concept, and the longer form aids grep-ability. Docstring polish: * ``herding/config.py`` header drops the "previously lived as a module-level literal" historical framing — we ship as a single thing, so the refactor anecdote no longer earns its keep. The usage examples now mention both ``HERDING_WEBOTS`` and ``HERDING_MEC_WEBOTS`` presets. 126 pytest cases still pass. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
132 lines
4.0 KiB
Python
132 lines
4.0 KiB
Python
"""Sheep flocking controller (Webots).
|
|
|
|
Each sheep emits its GPS position every 3 steps and listens for the
|
|
dog's position and peer-sheep positions. The behavioural step is
|
|
delegated to :func:`herding.world.flocking_sim.compute_heading_speed`
|
|
so the env and Webots use identical sheep dynamics.
|
|
|
|
A sheep latches penned the first time it crosses the gate plane south;
|
|
the wool turns pink (via the exposed ``woolColor`` PROTO field) and
|
|
the dynamics switch to in-pen containment.
|
|
"""
|
|
|
|
import math
|
|
import os
|
|
import random
|
|
import sys
|
|
|
|
# --- Make the shared herding/ package importable from this controller dir ---
|
|
_HERE = os.path.dirname(os.path.abspath(__file__))
|
|
_PROJECT_ROOT = os.path.normpath(os.path.join(_HERE, "..", ".."))
|
|
if _PROJECT_ROOT not in sys.path:
|
|
sys.path.insert(0, _PROJECT_ROOT)
|
|
|
|
from controller import Supervisor
|
|
|
|
from herding.world.diffdrive import heading_speed_to_wheels
|
|
from herding.world.flocking_sim import MAX_SPEED, compute_heading_speed
|
|
from herding.world.geometry import (
|
|
SHEEP_MAX_WHEEL_OMEGA,
|
|
is_penned,
|
|
)
|
|
|
|
|
|
# --- Devices ---
|
|
robot = Supervisor()
|
|
timestep = int(robot.getBasicTimeStep())
|
|
name = robot.getName()
|
|
self_node = robot.getSelf()
|
|
|
|
left_motor = robot.getDevice("left wheel motor")
|
|
right_motor = robot.getDevice("right wheel motor")
|
|
left_motor.setPosition(float("inf"))
|
|
right_motor.setPosition(float("inf"))
|
|
left_motor.setVelocity(0.0)
|
|
right_motor.setVelocity(0.0)
|
|
MOTOR_MAX = min(left_motor.getMaxVelocity(), SHEEP_MAX_WHEEL_OMEGA)
|
|
|
|
gps = robot.getDevice("gps"); gps.enable(timestep)
|
|
compass = robot.getDevice("compass"); compass.enable(timestep)
|
|
receiver = robot.getDevice("receiver"); receiver.enable(timestep)
|
|
emitter = robot.getDevice("emitter")
|
|
|
|
|
|
# --- Helpers ---
|
|
|
|
def bearing():
|
|
"""World-frame heading (0 = east, π/2 = north)."""
|
|
n = compass.getValues()
|
|
return math.atan2(n[0], n[1])
|
|
|
|
|
|
def drive(heading, speed_motor):
|
|
left_w, right_w = heading_speed_to_wheels(
|
|
heading, min(speed_motor, MAX_SPEED), bearing(), MOTOR_MAX, k_turn=4.0
|
|
)
|
|
left_motor.setVelocity(left_w)
|
|
right_motor.setVelocity(right_w)
|
|
|
|
|
|
def paint_pink():
|
|
"""Switch the sheep's wool to pink via the exposed PROTO field."""
|
|
self_node.getField("woolColor").setSFColor([1.0, 0.55, 0.72])
|
|
|
|
|
|
# --- State ---
|
|
wander_angle = random.uniform(-math.pi, math.pi)
|
|
step_count = 0
|
|
dog_x, dog_y = None, None
|
|
peers = {} # name → (x, y); periodically pruned
|
|
penned = False
|
|
|
|
# Safety net for differential-drive sheep pinned against a wall.
|
|
_prev_x, _prev_y = None, None
|
|
_stuck_count = 0
|
|
STUCK_STEPS = 20
|
|
STUCK_DIST = 0.05
|
|
|
|
|
|
# --- Main loop ---
|
|
while robot.step(timestep) != -1:
|
|
step_count += 1
|
|
pos = gps.getValues()
|
|
x, y = pos[0], pos[1]
|
|
|
|
if not penned and is_penned(x, y):
|
|
penned = True
|
|
paint_pink()
|
|
|
|
# Stale peers get dropped periodically so a peer that's gone silent
|
|
# doesn't permanently distort the local CoM.
|
|
if step_count % 30 == 0:
|
|
peers.clear()
|
|
while receiver.getQueueLength() > 0:
|
|
msg = receiver.getString()
|
|
receiver.nextPacket()
|
|
parts = msg.split(":")
|
|
if parts[0] == "dog" and len(parts) >= 3:
|
|
dog_x, dog_y = float(parts[1]), float(parts[2])
|
|
elif parts[0] == "sheep" and len(parts) >= 4 and parts[1] != name:
|
|
peers[parts[1]] = (float(parts[2]), float(parts[3]))
|
|
|
|
dog_xy = (dog_x, dog_y) if dog_x is not None and dog_y is not None else None
|
|
heading, speed, wander_angle = compute_heading_speed(
|
|
x=x, y=y, penned=penned, dog_xy=dog_xy, peers=peers,
|
|
wander_angle=wander_angle,
|
|
)
|
|
|
|
# Stuck-against-wall recovery: drive toward the field centre.
|
|
if _prev_x is not None:
|
|
moved = math.hypot(x - _prev_x, y - _prev_y)
|
|
_stuck_count = _stuck_count + 1 if moved < STUCK_DIST else 0
|
|
if _stuck_count >= STUCK_STEPS:
|
|
heading = math.atan2(-y, -x)
|
|
speed = MAX_SPEED
|
|
_stuck_count = 0
|
|
_prev_x, _prev_y = x, y
|
|
|
|
drive(heading, speed)
|
|
|
|
if step_count % 3 == 0:
|
|
emitter.send(f"sheep:{name}:{x:.4f}:{y:.4f}")
|