Skip to content

Commit 9179345

Browse files
committed
Merge branch 'main' into jptesting
2 parents 69b31e3 + c83706b commit 9179345

File tree

3,106 files changed

+352509
-19607
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

3,106 files changed

+352509
-19607
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @JPGC04 @andrew-kan @majdkhalife @Rain1618 @Coldstuff1 @farahmehzabeen @thirteenlizards @YHLiu2001 @celineshao
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: PlatformIO CI
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
branches:
9+
- main
10+
11+
jobs:
12+
build:
13+
runs-on: ubuntu-latest
14+
15+
steps:
16+
- uses: actions/checkout@v4
17+
18+
- uses: actions/cache@v4
19+
with:
20+
path: |
21+
~/.cache/pip
22+
~/.platformio/.cache
23+
key: ${{ runner.os }}-pio
24+
25+
- uses: actions/setup-python@v5
26+
with:
27+
python-version: '3.11'
28+
29+
- name: Install PlatformIO Core
30+
run: pip install --upgrade platformio
31+
32+
- name: Build PlatformIO Project
33+
run: |
34+
cd pio_workspace
35+
pio run

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
stm_workspace/.metadata/
2+
**.vscode

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# McGill Robotics AUV Embedded 2025
2+
3+
Welcome to the AUV Embedded 2025 repository! This repository is created and maintained by the 2025 McGill Robotics AUV Electrical team. It serves as a platform for sharing, calibrating, and version-controlling the embedded software we develop for our Autonomous Underwater Vehicle (AUV).
4+
5+
## About Us
6+
7+
We are a dedicated team of students from McGill Robotics, focused on designing and implementing the PCBs and embedded systems that power our underwater robot. Our mission is to enable autonomous navigation and task performance through advanced electrical engineering and software development.
8+
9+
## What You'll Find Here
10+
11+
- **Embedded Software**: Source code and libraries for our AUV's embedded systems.
12+
- **Team Structure**: Information about our team members and roles.
13+
- **Tutorials**: Guides and tutorials on using ROS (Robot Operating System) and Arduino for our projects.
14+
15+
For more detail please visit our [Wiki](https://github.com/mcgill-robotics/auv-embedded-2025/wiki).

pio_workspace/.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.pio
2+
.vscode/.browse.c_cpp.db*
3+
.vscode/c_cpp_properties.json
4+
.vscode/launch.json
5+
.vscode/ipch
6+
.DS_Store
7+
lib/.DS_Store

pio_workspace/include/README

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
2+
This directory is intended for project header files.
3+
4+
A header file is a file containing C declarations and macro definitions
5+
to be shared between several project source files. You request the use of a
6+
header file in your project source file (C, C++, etc) located in `src` folder
7+
by including it, with the C preprocessing directive `#include'.
8+
9+
```src/main.c
10+
11+
#include "header.h"
12+
13+
int main (void)
14+
{
15+
...
16+
}
17+
```
18+
19+
Including a header file produces the same results as copying the header file
20+
into each source file that needs it. Such copying would be time-consuming
21+
and error-prone. With a header file, the related declarations appear
22+
in only one place. If they need to be changed, they can be changed in one
23+
place, and programs that include the header file will automatically use the
24+
new version when next recompiled. The header file eliminates the labor of
25+
finding and changing all the copies as well as the risk that a failure to
26+
find one copy will result in inconsistencies within a program.
27+
28+
In C, the usual convention is to give header files names that end with `.h'.
29+
It is most portable to use only letters, digits, dashes, and underscores in
30+
header file names, and at most one dot.
31+
32+
Read more about using header files in official GCC documentation:
33+
34+
* Include Syntax
35+
* Include Operation
36+
* Once-Only Headers
37+
* Computed Includes
38+
39+
https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
#ifdef ACTUATOR_H
2+
3+
#include <Arduino.h>
4+
5+
void actuator_setup();
6+
void actuator_loop();
7+
8+
#endif
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
#ifdef DISPLAY_H
2+
3+
#include <Arduino.h>
4+
5+
void display_setup();
6+
void display_loop();
7+
8+
#endif

pio_workspace/include/power_main.h

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
#ifdef POWER_H
2+
3+
#include <Arduino.h>
4+
5+
void power_setup();
6+
void power_loop();
7+
8+
#endif
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
#ifdef POWER_ROS1_H
2+
3+
#include <Arduino.h>
4+
5+
void power_ros1_setup();
6+
void power_ros1_loop();
7+
8+
#endif

0 commit comments

Comments
 (0)