Skip to content

Commit e0f6032

Browse files
committed
[DOCS] changes to device descriptions
1 parent 98b5942 commit e0f6032

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

docs/docs/device.md

+20-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,24 @@
1-
# Lowcar Device refrence
1+
# Lowcar Device reference
22

3-
Lowcar devices are the physical devices students use to interact with the game field. Each device uses the Student API to interface with them. Here you will find in deph explanations of each device and how to control them.
3+
Lowcar is the name given to all of the code in the repo that runs on an Arduino microcontroller, which controls the various devices. Most of your teleoperated code will designed to interface with these lowcar devices. These devices include BatteryBuzzer, KoalaBear (motor controller), LimitSwitch, LineFollower, and ServoControl. In this tutorial, you will find in-depth explanations of each device and how to control them.
44

5-
[//]: <> (link to the student api later)
5+
For more detailed information and descriptions on the Lowcar devices please refer to the [runtime wiki](https://github.com/pioneers/runtime/wiki/Lowcar)
66

7-
#
7+
# More Background on the infomration
8+
9+
in each device page, the device information will be separated into three parts, a photo of the device, the device's parameters, a general description of it's intended usage and other possible applications.
10+
11+
## Limit Switch
12+
![Limit Switch](https://raw.githubusercontent.com/pioneers/runtime-docs/master/device-pics/LimitSwitch.JPG)
13+
14+
### Parameters
15+
| Name | Data type | Readable| Writeable |
16+
|---------|-----------|---------|-----------|
17+
| switch0 | BOOL | TRUE | FALSE |
18+
| switch1 | BOOL | TRUE | FALSE |
19+
| switch2 | BOOL | True | FALSE |
20+
21+
22+
23+
A limit switch is a device wired with three switches. These switches, `switch0`, `switch1`, AND `switch2` each have a metal actuator attached to them. The original purpose of a limit switch is to limit an object from going past a certain endpoint. However, it's use isn't limited to limiting the range of an object, for example using it to detect the presence of an object in a certain place or not.
824

9-
insert glossary stuff later

0 commit comments

Comments
 (0)