Skip to content

Commit

Permalink
fixed inconsistent bolding
Browse files Browse the repository at this point in the history
  • Loading branch information
adamseth2 committed Nov 21, 2024
1 parent 04f5ee0 commit 8e2dd4d
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 10 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Follow the steps below based on your role and setup:

Visit [Mission Control](https://www.trickfirerobotics.org/mission-control/) and follow the **Launching on Rover** instructions below.

#### Launching on Rover
## **Launching on Rover**

Setup router and ensure connect to trickfirerouter on your computer. The router password is on the router itself Turn the rover computer on by plugging in the c port charger. You will know the computer is on if the LED lights up.
Run the commands below in Powershell or in your OS terminal. When prompted for a password, please ask a software member.
Expand Down
4 changes: 2 additions & 2 deletions docs/code_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
- **App.vue**: Pubs and Subs that are always running and not part of a component such as controller should be ran here.
- **types.ts** Put all global types here.

## Design choices
## **Design choices**

We are using Vue for its reactivity and lightweightness along side Pinia, a global state management to handle the growing amount of state shared among components. We use Typescript to make the code more readable and more maintainable. Because ROS uses the publisher and subscriber paradigm, we use Roslibjs library to easily interact with ROS in TypesScript, allowing us to use publishers, subscribers, and services, without having to manually. The websocket and the protocol is through Rosbridge Suite

## How the Rover and the Mission Control communicates under the hood
## **How the Rover and the Mission Control communicates under the hood**

The rover runs Ros server which create a websocket server that then the mission control connects to, as it is ran on the browser. The connection is TCP connection and able to send data bidirectional. Any interactions such as subscribing and publishing under the hood are just json sent back and forward. This is all done for us and we simply use the Roslibjs library. Below is an example of Chrome webdev-> network-> WS (Websocket) on what the json message being sent looks like.

Expand Down
10 changes: 4 additions & 6 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,17 @@

Welcome to the mission control subteam! We hope that you will stick around and learn quite a bit of things about frontend and networking! However, before you can do that, you should review the resources given in this document to familiarize yourself.

## Whats the mission control?
## **What's the mission control?**

The mission control is the human interface to communicate bidirectionally (Sends and receives information) with the rover. For example, sending joystick inputs to the rover or displaying the rover's camera feed in realtime.

## Difference between urc-2023 and mission-control GitHub Repository
## **Difference between urc-2023 and mission-control GitHub Repository**

The urc-2023 repo is the code that is ran on the rover itself. Due to the code being very hardware specifics, the docker container you run on your computer ensures standardization with the rover. Think of the rover as the "server"

The mission-control repo is completely separate from the urc-2023 as it is webpage-based, meaning the code is ran in the browser, and with modern browsers standardization of features, docker container is not needed. Think of the mission control as the "client"

## Locally ran

## Recommended IDE Setup
## **Recommended IDE Setup**

- [VSCode](https://code.visualstudio.com/)

Expand Down Expand Up @@ -44,7 +42,7 @@ In this particular codebase, we use the following libraries/tools/technologies.
- Node Package Manager (NPM)
- Difference between dependency and Dev-dependency and when installing packages, which one to install too.

## So... what should I do now?
## **So... what should I do now?**

Please look at the [mission-control github issues](https://github.com/TrickfireRobotics/mission-control/issues) and look for **_Good First Issue_**. Some issues might only require only a fraction of the concepts above like UI related ones.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To develop code for the mission control, please follow the setup below:
3. Run `cd mission-control` to open the repository
4. Run `npm install` to install dependencies

### Launching
### **Launching**

1. Run `npm run dev`
2. While running open another VSCode window to the URC repo in the docker environment
Expand Down

0 comments on commit 8e2dd4d

Please sign in to comment.