Skip to content

Commit

Permalink
Made Welcome page show by default upon opening the website. Added con…
Browse files Browse the repository at this point in the history
…tent for Getting Started section
  • Loading branch information
tguyenn committed Jul 14, 2024
1 parent 9e09fc6 commit 96d2876
Show file tree
Hide file tree
Showing 19 changed files with 127 additions and 34 deletions.
Binary file added docs/_assets/images/LED-pinout.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/images/button-diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/images/continuity-test.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/images/datasheet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/images/outdated-circuit-diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ url: "https://ut.ieee.ras.github.io" # the base hostname & protocol for your sit
# Build settings
theme: just-the-docs

livereload: true
search_enabled: true

# Exclude from processing.
Expand Down
16 changes: 0 additions & 16 deletions docs/_includes/head_custom.html

This file was deleted.

6 changes: 0 additions & 6 deletions docs/_layouts/home.html

This file was deleted.

4 changes: 3 additions & 1 deletion docs/_sections/_guide-general/schedule.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,6 @@ nav_include: true
nav_order: 2
---

TBD
TODO: put real calendar here

<iframe src="https://calendar.google.com/calendar/embed?src=1e8b00794a07180514fdc54c5b78dca70637bc1a8a72076e64dc787ebe2a71cb%40group.calendar.google.com&ctz=America%2FChicago" style="border: 0" width="800" height="600" frameborder="0" scrolling="no"></iframe>
1 change: 1 addition & 0 deletions docs/_sections/_guide-general/welcome.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Welcome
permalink: /
nav_include: true
nav_order: 1
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,12 @@ You will need to carefully plan your sensor and actuator placement as it will dr
The distance sensor will be used during the wall following portion of the competition. The location of the distance sensors *will* affect your chassis design and code, so it is important to decide on a good location! Also remember that you will have multiple IR sensors in your design.

{: .highlight}
Remember that the GP2Y0A21YK0F IR sensors have a specific range [(link to datasheet)](https://www.pololu.com/file/0J85/gp2y0a21yk0f.pdf) that produces good output, so make sure your placement does not break your wall following!
Remember that the GP2Y0A21YK0F IR sensors have a specific range [(link to datasheet)](https://www.pololu.com/file/0J85/gp2y0a21yk0f.pdf) that produces good output, so make sure your placement does not break your wall following! One way to avoid the sensor getting too close to the wall could be to move them closer to the middle of the chassis.
{: .callout-toby}

Below are some different ideas of placement:
<img src="{{ '/_assets/images/IR_sensors.png' | prepend: site.baseurl }}" alt="IR_sensors.png :(">


## Line Sensor and Color Sensor
These two sensors will have similar placement! The line sensor and color sensor will be used to to detect what is right underneath the robot so these two will be placed on the bottom of your robot. Make sure your sensors are very close to the ground in order for them to function properly!

Expand All @@ -33,5 +32,5 @@ Illustrated below is a sample configuration:
<img src="{{ '/_assets/images/line_and_color.png' | prepend: site.baseurl }}" alt="line_and_color.png :(" >

## Actuators
"Actuators" is just a fancy name for motors or anything that enables movement for your robot. You will need at least two of these with a castor ball to have a moving base. While you have full creative reign on where to put your actuators to achieve motion and solve the mechanical challenge, it will be important to consider where to place your wheel actuators since they will affect how your robot drives and, (arguably) most importantly, turns.
"Actuators" is just a fancy name for motors or anything that enables some kind of movement for your robot. You will need at least two of these with a castor ball to have a moving base. While you have full creative reign on where to put your actuators to achieve motion and solve the mechanical challenge, it will be important to consider where to place your wheel actuators since they will affect how your robot drives and, (arguably) most importantly, turns.

Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,9 @@ layout: default
title: Environment Setup
nav_include: true
parent: Getting Started
nav_order: 1
nav_order: 5
---



ermm uhh ummm
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ layout: default
title: Getting Started
nav_include: true
has_children: true
nav_order: 1
nav_order: 2
---
Original file line number Diff line number Diff line change
@@ -1,7 +1,32 @@
---
layout: default
title: Microcontroller Interface
title: Microcontroller Interfacing
nav_include: true
parent: Getting Started
nav_order: 1
nav_order: 4
---

# Microcontroller Interfacing KINDA OUTDATED, images need formatting
Microcontrollers are cool and all, but they’re a lot more interesting when you can do stuff in the real world!

## Programming goal
For this tutorial, we want to turn on the LED if: PA2 is turned high (to power the LED) and the switch is closed. The example code can be found in our github.

## Interfacing example
For this example, we’ll use an LED and a switch. You will need six components - a red LED, switch, 470 ohm resistor, TM4C, breadboard, and some wires.

{: .highlight}
Our microcontroller pin outputs way too much current for our LED to handle, so we need to put a resistor in series with the microcontroller output pin and LED.
{: .callout-toby}

1. Connect a wire to a GPIO pin (let’s choose PA2 for this example). The other end goes to one of the switch legs.
1. Stick the long side of the LED on another switch leg. Use the continuity mode on the multimeter to make sure the leg is disconnected by putting each of the probes at each end of the switch (see below). Pressing the switch should short the legs.
1. Put the resistor in series with the short end of the LED (-), and connect the GND pin to the other end of the resistor.

<img src="{{ '/_assets/images/led-pinout.png' | prepend: site.baseurl }}" alt="led interface :()" width=550 height=235>

<img src="{{ '/_assets/images/outdated-circuit-diagram.png' | prepend: site.baseurl }}" alt="outdated-circuit-diagram :()">

<img src="{{ '/_assets/images/button-diagram.png' | prepend: site.baseurl }}" alt="led interface">

<img src="{{ '/_assets/images/continuity-test.png' | prepend: site.baseurl }}" alt="led interface">
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,50 @@ layout: default
title: Reading Datasheets
nav_include: true
parent: Getting Started
nav_order: 1
nav_order: 3
---

# Reading Datasheets
The internet! Textbooks! How-to guides! Datasheets are yet another form of references that come in handy when learning more about your team’s electronic parts. Search for a datasheet of a part online- most manufacturers post pdfs that you can easily pull up.

Datasheets help you understand the component better- whether it’s increasing accuracy or troubleshooting mistakes. For now, don’t worry if you can’t understand everything written in those pages. The topics addressed on this page are the most relevant for Robotathon.

[Here is a link](https://www.infineon.com/dgdl/Infineon-IPP055N03L-DS-v01_03-en.pdf?fileId=db3a30431441fb5d01148d01ee1c0e91) to the datasheet this page references below. This component is **not** used in Robotathon, but it makes a good dissection example.

<div style="text-align: center;">
<img src="{{ '/_assets/images/datasheet.png' | prepend: site.baseurl }}" alt="datasheet">
</div>

## First Page
Typically, the first page is pretty meta. Areas of interest include:

## <span style="background-color: #DD7E6B;">General Description</span>
* An overview of the features and applications of the part

## <span style="background-color: #f9cb9c;">Specifications</span>
* Numbers that describe what a part needs and can do

**Check the Table of Contents (TOC) for or skim the pages for the following topics!**
## <span style="background-color: #ffe599;">Connection Diagrams</span>
* A pinout lists the part’s pins, where they’re physically located, and their functions.

## <span style="background-color: #b6d7a8;">Absolute Minimum/Maximum Ratings</span>
* These are the threshold specs that the part can handle before being permanently damaged! Be careful!

## <span style="background-color: #a4c2f4;"> Recommended Operating Conditions</span>
* Performance specs like voltage, ranges, timing info, temperature, etc.
* Electrical Characteristics: specify particular test conditions which guarantee specific performance limits
* Timing Diagrams: show how data should be sent to and received from the part, and what speed it should be sent / received

## Application Information
* More specifics on pin functions, how to communicate with the part, commands, memory tables, and more.

{: .highlight}
Note: manufacturers might use different wording to describe what was mentioned above (i.e. pinout = connection diagram).
{: .callout-toby}


Just like a Wikipedia page, datasheets tell you a lot of information that may or may not pertain to what you’re looking for. By knowing generally where to look and what you’re interested in, it’s faster for you to find the details you need!



18 changes: 16 additions & 2 deletions docs/_sections/_guide-primaries/guide-manual.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
---
layout: default
title: How to read :D (idk what to name this)
title: Preface
nav_order: 0
---
# Preface OUTDATED
This guide is separated into multiple sections each with graphics, tips, and sample code or examples.

We suggest that you read the pages as you progress with your robot - please reference back to this guide when you need direction. Also understand that this guide, while broad, is not comprehensive. We want you to discover solutions by yourselves, so we will only provide the bare minimum to create a working robot.

can we kill this file/merge it to Getting Started
Finally, if you have any technical questions or don’t understand a topic, ask the mentors or during office hours! We can help to resolve your problems, or point you to the right person who can. The mentors, office hours, tech talks, our youtube video series, and other teammates are valuable resources you can exploit.
Section Overview

The first section, Getting Started, sets you up for success in regards to getting familiar with the TM4C microcontroller, the software build process, and embedded systems development in general. We highly recommend that you at least take a look at Environment Setup, as this page will streamline your development process and prevent a lot of environment errors you may get in the future.

The second section, Designing a Robot, is pretty self explanatory. We’ll cover the computer aided design (CAD) software - SOLIDWORKS - that Mechanical Engineers will use in their courses here. We’ll also discuss the physical construction of a robot, as well as the resources the engineering Makerspace provides to students.

The third section, Sensors and Actuators, involves building the circuits and programming the software that controls your robot. To soften the learning curve, we abstract a lot of logic needed to program the TM4C, and provide high level interfaces for you to use described in our [wiki](https://github.com/ut-ras/Rasware/wiki). We encourage you to utilize our APIs beyond what is used in each instructional page.

The fourth section, Debugging, provides optional, but highly recommended guides to problem solving. Trust us, >95% of your code problems can be solved with the right Google search, saving you time and stress.

Finally, the Robotathon steering committee appreciates your feedback! If you have questions that you think should be clarified here, or topics that you think should be covered in the next revision of this guide, please fill out our [google form!](https://forms.gle/6UpwaETAtQpkvoMa8)
24 changes: 24 additions & 0 deletions docs/_sections/_guide-supplementals/breadboard-bugs.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,27 @@ nav_include: true
# parent: Resources
nav_order: 1
---

# How to (not) Explode Your Microcontroller like the Rest of Us (copy pasted minimal content editing)

## What is a short circuit?

A short circuit is the connection between two different nodes that are at different voltages via a path of very low resistance.

## Why Should You Avoid a Short Circuit?
A short circuit causes a surge of high amounts of current to flow through both nodes, which is very dangerous. This could cause potential injuries such as a shock or a burn as well as damage electronics nearby. Hence why it is preferable to avoid shorting anything.

## How to Avoid a Short Circuit:
* Disconnect power from any electronic device when interfacing with its hardware.
* Do not have microcontroller connected to power when moving around cables
* Make sure that there are no open cables near an electronic device with power.
* Make sure to not connect cables to the wrong pins.
* I.e. you should never directly connect VCC to GND with no resistance in between.
* Make sure to connect resistors of the necessary resistance to any electronic devices you will interface with.
* Not doing so will a high amount of current through the electronic device and potentially damage it (or make it burst into flames)
* Don’t touch an electronic part with a metal
* Avoid having any type of metal near electronic devices
* Make sure that all cables are safely connected and cannot disconnect when the device is in use.
* When soldering electronics, make sure that solder does not cover two pins at once, or be somewhere it’s not supposed to.
* Don’t be distracted when working with electricity.

2 changes: 1 addition & 1 deletion docs/_sections/_guide-supplementals/software.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: default
title: Software (??)
title: Software
nav_include: true
# parent: Resources
nav_order: 1
Expand Down
Binary file added docs/favicon.ico
Binary file not shown.

0 comments on commit 96d2876

Please sign in to comment.