Skip to content

Document robot controls and add regression tests - #70

Merged
Kamilr616 merged 1 commit into
mainfrom
agent/document-robot-controls
Jul 14, 2026
Merged

Document robot controls and add regression tests#70
Kamilr616 merged 1 commit into
mainfrom
agent/document-robot-controls

Conversation

@Kamilr616

Copy link
Copy Markdown
Owner

Summary

  • document the proportional one-joystick differential-drive algorithm in both READMEs
  • add the exact joystick equations, dead zones, keyboard mapping, command timing, and safety behavior to the technical documentation
  • add regression coverage for straight motion, proportional arcs, rotation in place, stop behavior, and arrow-key control
  • add CLAUDE.md forwarding agent guidance to AGENTS.md

Impact

The repository now explains how a single joystick combines throttle and steering for smooth differential-drive movement, including rotation around the robot's own axis, while also documenting keyboard control as an alternative. Tests protect the documented PWM mappings from regressions.

Validation

  • dotnet test src/server/SmartBotBlazorApp.Tests/SmartBotBlazorApp.Tests.csproj --no-restore --nologo — 28 passed
  • git diff --check — passed

@Kamilr616
Kamilr616 marked this pull request as ready for review July 14, 2026 16:51
Copilot AI review requested due to automatic review settings July 14, 2026 16:51

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR documents how the dashboard converts joystick/keyboard input into differential-drive motor commands, and adds regression tests to keep the documented PWM mappings stable.

Changes:

  • Added regression tests for joystick dead zones, proportional mixing, rotation-in-place, and arrow-key mappings.
  • Documented the control algorithm and safety/throttling behavior across README(s) and technical docs.
  • Added CLAUDE.md to forward agent guidance to AGENTS.md.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
src/server/SmartBotBlazorApp.Tests/RobotMovementInputTests.cs Adds regression tests for joystick mixing/dead zones and arrow-key motor mappings.
README.md Documents one-joystick differential-drive behavior and keyboard alternative.
README.pl.md Polish version of the new one-joystick differential-drive documentation.
docs/server.md Adds a server-side control-input overview pointing to the relevant handlers/pages.
docs/getting-started.md Adds a quick “control reference” section for joystick + arrow keys.
docs/architecture.md Adds detailed motion-control equations, dead zones, and timing/safety behavior.
CLAUDE.md Forwards agent instructions to AGENTS.md.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Comment thread README.pl.md Outdated
@Kamilr616 Kamilr616 closed this Jul 14, 2026
@Kamilr616 Kamilr616 reopened this Jul 14, 2026
@Kamilr616
Kamilr616 force-pushed the agent/document-robot-controls branch from 6ee01a5 to 856c402 Compare July 14, 2026 17:09
@Kamilr616
Kamilr616 force-pushed the agent/document-robot-controls branch from 856c402 to b38c16c Compare July 14, 2026 17:20
@Kamilr616
Kamilr616 merged commit 43518f8 into main Jul 14, 2026
1 check passed
@Kamilr616
Kamilr616 deleted the agent/document-robot-controls branch July 14, 2026 17:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants