https://github.com/brianlesko/my-template-repo

I intend to use this template repo for my robotics and engineering projects to better keep my projects well documented and clean
https://github.com/brianlesko/my-template-repo

Last synced: about 20 hours ago
JSON representation

I intend to use this template repo for my robotics and engineering projects to better keep my projects well documented and clean

• Host: GitHub
• URL: https://github.com/brianlesko/my-template-repo
• Owner: BrianLesko
• Created: 2024-08-23T01:52:49.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-10-20T23:57:51.000Z (18 days ago)
• Last Synced: 2024-10-21T03:35:01.312Z (18 days ago)
• Language: Shell
• Size: 25.6 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        

# Template Repository

Set up a great looking readme.md quickly using [this repository].

 



 

## Software Dependencies

This code uses the following libraries:

- `streamlit`: for building the user interface.

- `numpy`: for creating arrays.

- `matplotlib`: for plotting the stepper motor visualization

- `hidapi`: for accessing usb connections on the host device

 

## Hardware Dependencies

1. A base station computer

2. A second computer for the robot

3. A PWM capable arduino + cable + servo motors and BLDC Motor controller

4. A PS5 remote + cable

## Usage

1. clone this repository

```

git clone ...

```

2. The base station and robot computers must be on the same network. Set up each device with a static IP

2. Change the robot IP in 'app.py' and 'car.py' you can also change the port which is '12345'

3. Change the PS5 remote vendorID and productID in 'app.py'

4. Plug the arduino into the robot

5. Run the arduino sketch.ino file on your arduino

6. Run the car.py file on your robot 

```

python car.py

```

7. plug the PS5 remote into the base station

8. run the streamlit app with the following command in your base station terminal

```

streamlit run app.py

```

This will start the local Streamlit server, and you can access the interface by opening a web browser and navigating to `http://localhost:8501`.

 

## Repository Structure

```

repository/

├── app.py # The base station UI to send the Internet commands to the robot

├── customize_gui # class for adding gui elements

├── dualsense.py # The class used to decode received bytes from the wired controller

├── ethernet.py # a helper class for sending Internet IP communciation

├── car.py # Recieves the internet commands and relays them to the arduino

├── sketch.ino # the arduino code to control the motors

├── requirements.txt # the python packages needed to run locally

├── .gitignore # includes the local virtual environment named my_env

└── docs/

    └── preview.png # preview photo for Github

```

 

## Topics 

```

Python | Low Code UI | Mobile robot | Internet IP 

HIDapi | decode bytes | PS5 | Sony | Dualsense | external device | communication 

Mechanical and Robotics engineer

```

 



 



╭━━╮╭━━━┳━━┳━━━┳━╮╱╭╮        ╭╮╱╱╭━━━┳━━━┳╮╭━┳━━━╮

┃╭╮┃┃╭━╮┣┫┣┫╭━╮┃┃╰╮┃┃        ┃┃╱╱┃╭━━┫╭━╮┃┃┃╭┫╭━╮┃

┃╰╯╰┫╰━╯┃┃┃┃┃╱┃┃╭╮╰╯┃        ┃┃╱╱┃╰━━┫╰━━┫╰╯╯┃┃╱┃┃

┃╭━╮┃╭╮╭╯┃┃┃╰━╯┃┃╰╮┃┃        ┃┃╱╭┫╭━━┻━━╮┃╭╮┃┃┃╱┃┃

┃╰━╯┃┃┃╰┳┫┣┫╭━╮┃┃╱┃┃┃        ┃╰━╯┃╰━━┫╰━╯┃┃┃╰┫╰━╯┃

╰━━━┻╯╰━┻━━┻╯╱╰┻╯╱╰━╯        ╰━━━┻━━━┻━━━┻╯╰━┻━━━╯

  

 

                          

follow all of these for pizza :)