Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
mablin7 committed Nov 14, 2024
1 parent f68a3ec commit aa34c7b
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 20 deletions.
8 changes: 0 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,6 @@ You'll need the following dependencies on your system:

To run Dies locally, simply use `cargo run -- <options>`.

If you are connected to the team VPN, you can run your local copy of Dies on the server. For now, this will only work on Linux. First of all make sure you have `ssh` and `rsync` and that your public key is added to the server. Then, you can run the following command:

```sh
./run.sh <options>
```

_Note:_ If you have large files in the repository that you wouldn't like to upload to the server, add their names to `.rsyncignore`.

### Debugging hanging issues

If you are experiencing hanging issues, you can use `tokio-console` to see the state of running tasks. To do this, you need to install `tokio-console`:
Expand Down
2 changes: 1 addition & 1 deletion dies-settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@
"ball_unit_transition_var": 20.48,
"ball_measurement_var": 0.01
}
}
}
25 changes: 14 additions & 11 deletions docs/src/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,20 @@ The behavior of the players is determined by the `TeamController`. This in turn
`Role`s can in turn use _skills_ to perform common reusable and composable tasks, such as moving to a position, or kicking the ball.

```mermaid
graph TD
Executor <--> BasestationClient
Executor <--> SSLClient
World --> Executor
Executor --> TeamController
SSLClient --> World
TeamController --> PlayerController
TeamController --> Strategy
Strategy --> Role
Role --> Skill
PlayerController <--> Role
flowchart LR
SSL[SSL Client] -- Vision + Referee Data --> Executor
BS[Basestation Client] <-- Robot Commands/Feedback --> Executor
Executor -- Data from environment --> World
World -- Filtered Data --> Executor
Executor -- World Data --> Team[Team Controller]
Team -- Player Commands --> Executor
Team <-- World Data/Player Commands --> Strategy[Strategy]
Strategy --> Role1[Role]
Strategy --> Role2[Role]
Strategy --> Role3[Role]
Team <--> Player1[Player Controller]
Team <--> Player2[Player Controller]
Team <--> Player3[Player Controller]
```

## Crates
Expand Down

0 comments on commit aa34c7b

Please sign in to comment.