Skip to content

umigv/embedded_hardware

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

97 Commits
 
 
 
 
 
 
 
 

Repository files navigation

UMARV Hardware

PCB designs and hardware files for the University of Michigan Autonomous Robotic Vehicle (UMARV) project.

For CS/software folks: You probably just need to browse a schematic or check a pinout. Jump to the folder for your board below and open the README.md inside it — no Git setup needed, GitHub renders schematics and PDFs in the browser.


Repo Structure

embedded_hardware/
├── estop-lora-esp32/        # Remote E-stop board (LoRa + ESP32)
│   ├── schematic.SchDoc
│   ├── board.PcbDoc
│   ├── Project Outputs/     #includes Gerber(.GM, .GBL, etc), DRC, Pick and Place files
│   └── README.md            # Pinout, ROS2 topic links, revision history
├── power-distribution/
├── motor-driver/
├── coming-soon/
├── .gitignore
└── README.md                # (this file)

Each board folder should have its own README.md explaining or linking to:

  • What the board does
  • Which ROS2 topics / signals it connects to
  • Connector pinout

First-Time Setup (Hardware Contributors)

You need to be a member of the umigv GitHub org first.

Clone only your board (recommended — avoids downloading large files from other boards)

git clone --no-checkout https://github.com/umigv/embedded_hardware
cd hardware
git sparse-checkout init --cone
git sparse-checkout set your-board-folder-name
git checkout main

Replace your-board-folder-name with the actual folder, e.g. estop-lora-esp32.

  • Naming convention: function-component

Clone everything

git clone https://github.com/umigv/hardware
cd hardware

Pushing a New Board

1. If you cloned with sparse checkout, add your folder to the sparse list first

git sparse-checkout add your-new-board-name

2. Create your folder and add files

mkdir your-new-board-name
cd your-new-board-name
# Copy your Altium files in here

3. Commit and push

git add your-new-board-name/
git commit -m "your-new-board-name: initial upload rev1"
git push

Adding a New Board from an Existing Repo

If your board was previously its own git repository, delete the nested .git folder before adding it here — otherwise git will treat it as a submodule instead of tracking your files.

Windows:

Remove-Item -Recurse -Force your-board-folder/.git

Mac/Linux:

rm -rf your-board-folder/.git

Your Altium files are unaffected — only the old repo history is removed, which lives on your personal GitHub anyway.


Altium-Specific Notes

  • check root .gitignore file for what it ignores

  • individual folder .gitignores can be set to more specific, but cannot include what the root ignores

  • Include: .SchDoc, .PcbDoc, .PrjPcb, gerbers/, BOM export, project-specific libraries

  • Do not include: History/, __Previews/, ProjectLogs/ — these are auto-generated and handled by .gitignore

  • If you use a shared library, document the library name and version in your board's README.md so others can open it cleanly

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages