You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/api/encoder.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ Linear encoders are attached to joints that move in a straight line (i.e. raisin
11
11
12
12
Linear encoders measure the distance the joint has moved from its start position, in *metres*.
13
13
14
-
All encoders are stored in a list called `encoders`, you can access the encoder with `encoders[i]`, where `i` is the slot the encoder is plugged into. You can find this number in the [documentation for the robot](../robots/).
14
+
All encoders are stored in a list called `encoders`, you can access the encoder with `encoders[i]`, where `i` is the slot the encoder is plugged into. You can find this number in the [documentation for the robot](/robots/).
15
15
16
16
```python
17
17
# Get the distance from the start position
@@ -24,7 +24,7 @@ Rotary encoders are attached to joints that rotate (i.e. wheel rotations).
24
24
25
25
Rotary encoders measure the total rotation the joint has moved from its start position, in *radians*.
26
26
27
-
All encoders are stored in a list called `encoders`, you can access the encoder with `encoders[i]`, where `i` is the slot the encoder is plugged into. You can find this number in the [documentation for the robot](../robots/).
27
+
All encoders are stored in a list called `encoders`, you can access the encoder with `encoders[i]`, where `i` is the slot the encoder is plugged into. You can find this number in the [documentation for the robot](/robots/).
Copy file name to clipboardExpand all lines: content/api/radio.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,11 +17,11 @@ which has a `sweep` function that detects transmitters that are in range:
17
17
transmitters = r.radio.sweep()
18
18
```
19
19
20
-
When called, the `sweep()` function uses the radio reciever to scan for all transmitters in range.
20
+
When called, the `sweep()` function uses the radio receiver to scan for all transmitters in range.
21
21
It returns a list of `Target` objects, each of which describes one of the transmitters that were found within range.
22
22
A detailed description of the attributes of `Target` objects is provided at the bottom of this page.
23
23
24
-
Here's an example that will repeatedly print out the information, bearing, and signal stength of each transmitter in range:
24
+
Here's an example that will repeatedly print out the information, bearing, and signal strength of each transmitter in range:
25
25
26
26
```python
27
27
# Continuously prints details of nearby transmitters.
@@ -39,7 +39,7 @@ while True:
39
39
40
40
## Detecting beacons
41
41
42
-
There are 4 beacons in the arena, see [the rules](../../rules/) for their locations. These beacons continually transmit their identity. Beacons can be detected up to 2.5m away.
42
+
There are 4 beacons in the arena, see [the rules](/rules/) for their locations. These beacons continually transmit their identity. Beacons can be detected up to 2.5m away.
43
43
44
44
The beacons have the `target_info.type` value of `0` (`TargetType.BEACON`), which can be used to detect if it is a beacon. See '[Objects of the Radio System](#objects-of-the-radio-system)' below for all available information.
45
45
@@ -73,10 +73,10 @@ The `TargetInfo` object contains information about a transmitter.
73
73
It has the following attributes:
74
74
75
75
`id`
76
-
: The ID of the transmitter, either 1-16 for containers, or 100-103 for beacons. See [the rules](../rules/) for the arena layout.
76
+
: The ID of the transmitter, either 1-16 for containers, or 100-103 for beacons. See [the rules](/rules/) for the arena layout.
77
77
78
78
`type`
79
79
: The type of the transmitter, either `0` (`TargetType.BEACON`) for a beacon, or `1` (`TargetType.CONTAINER`) for a container.
80
80
81
81
`owner`
82
-
: The zone id of the robot that currently owns the stations territory. This can be `0` (`Owner.ZONE_0`), `1` (`Owner.ZONE_1`), or `-1` (`Owner.NULL`). which indicates it does not have an owner (i.e. it's a beacon). Remember, you can find out which zone your robot is in using [r.zone](game-state)
82
+
: The zone id of the robot that currently owns the stations territory. This can be `0` (`Owner.ZONE_0`), `1` (`Owner.ZONE_1`), or `-1` (`Owner.NULL`). which indicates it does not have an owner (i.e. it's a beacon). Remember, you can find out which zone your robot is in using [r.zone](/api/game-state)
Copy file name to clipboardExpand all lines: content/api/touch.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,9 +7,9 @@ Microswitches, or touch sensors, are used to measure when something is touching
7
7
8
8
## Reading the touch sensor
9
9
10
-
The touch sensors will be connected to a specific pin in the arduino, typically wired in such a way that the pin's voltage is changed when the switch is pressed by an object.
10
+
The touch sensors will be connected to a specific pin in the Arduino, typically wired in such a way that the pin's voltage is changed when the switch is pressed by an object.
11
11
12
-
To read this, you need to read the digital value of the correct pin. You can get the correct pin number by looking at [the documentation for the robot](../robots/), then writing the code like so:
12
+
To read this, you need to read the digital value of the correct pin. You can get the correct pin number by looking at [the documentation for the robot](/robots/), then writing the code like so:
Copy file name to clipboardExpand all lines: content/api/ultrasound.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,11 +7,11 @@ Ultrasound sensors can measure distance of objects from the sensor. Ultrasound s
7
7
8
8
Ultrasound sensors measure distance in a 18 degree diameter cone in front of the sensor, and report the closest measured distance in that cone. Ultrasound sensors also have a maximum distance. (Ultrasound sensors typically also have a minimum distance too, but we do not simulate that in our simulator).
9
9
10
-
In our robots, ultrasound sensors are connected to the 'arduino' board, which is used to read sensors for many different purposes. Keep reading to learn how to take measurements.
10
+
In our robots, ultrasound sensors are connected to the 'Arduino' board, which is used to read sensors for many different purposes. Keep reading to learn how to take measurements.
11
11
12
12
## Reading the ultrasound sensor
13
13
14
-
The ultrasounds sensors will be connected to a specific pin in the arduino, and will constantly measure distances. Consult the description of the [robot](../../robots/) to see which pin you should use. The analogue value of the pin will be the measured distance, in metres.
14
+
The ultrasounds sensors will be connected to a specific pin in the Arduino, and will constantly measure distances. Consult the description of the [robot](../../robots/) to see which pin you should use. The analogue value of the pin will be the measured distance, in metres.
15
15
16
16
Ultrasound sensors have a maximum range of 2 metres, if objects are further than 2m away from the robot, it will report a distance of 2m.
Copy file name to clipboardExpand all lines: content/robots/crane.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,13 +3,13 @@ title: Crane Robot
3
3
weight: 2
4
4
---
5
5
6
-
The crane has three [linear motor](../../api/motor-board), allowing it to move its [electromagnet](../../api/magnet-board) in 3 dimensions. Each motor has an [encoder (position sensor)](../../api/encoder) that can tell you the position of the motor along its track.
6
+
The crane has three [linear motor](/api/motor-board), allowing it to move its [electromagnet](/api/magnet) in 3 dimensions. Each motor has an [encoder (position sensor)](/api/encoder) that can tell you the position of the motor along its track.
7
7
8
8
Additionally, the crane has one ultrasound distance sensor and a radio, both attached to the hook (see below).
9
9
10
10
## Motor layout
11
11
12
-
The layout of the [motors](../../api/motor-board) attached to the motor boards are as follows:
12
+
The layout of the [motors](/api/motor-board) attached to the motor boards are as follows:
13
13
14
14
- Motor Board 0:
15
15
- Motor 0 - Bridge motor
@@ -19,16 +19,16 @@ The layout of the [motors](../../api/motor-board) attached to the motor boards a
19
19
20
20
## Encoder layout
21
21
22
-
The layout of the [encoders](../../api/encoder) are as follows:
22
+
The layout of the [encoders](/api/encoder) are as follows:
23
23
24
24
- Slot 0: Bridge linear encoder
25
25
- Slot 1: Trolley linear encoder
26
26
- Slot 2: Hoist linear encoder
27
27
28
28
## Ultrasound sensor
29
29
30
-
The crane has one [ultrasound sensor](../../api/ultrasound) pointing downwards from the magnet. The ultrasound sensor is attached to Arduino pin 0.
30
+
The crane has one [ultrasound sensor](/api/ultrasound) pointing downwards from the magnet. The ultrasound sensor is attached to Arduino pin 0.
31
31
32
32
## Radio
33
33
34
-
The crane robot has a [radio](../../api/radio) receiver attached to the hook, which can be used to detect which container is below it.
34
+
The crane robot has a [radio](/api/radio) receiver attached to the hook, which can be used to detect which container is below it.
Copy file name to clipboardExpand all lines: content/robots/forklift.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,9 +3,9 @@ title: Forklift Robot
3
3
weight: 1
4
4
---
5
5
6
-
The forklift has two [radial motors](../../api/motor-board), allowing it to move itself around the arena. It also has 2 grabber motors, wired so they move together. Each motor has an [encoder (position sensor)](../../api/encoder) that can tell you either the position of the motor along its track, or its angle relative to the start.
6
+
The forklift has two [radial motors](/api/motor-board), allowing it to move itself around the arena. It also has 2 grabber motors, wired so they move together. Each motor has an [encoder (position sensor)](/api/encoder) that can tell you either the position of the motor along its track, or its angle relative to the start.
7
7
8
-
The Forklift robot also has multiple Ultrasound sensors, a touch sensor, and a radio, see below for details.
8
+
The forklift robot also has multiple Ultrasound sensors, a touch sensor, and a radio, see below for details.
9
9
10
10
## Motor layout
11
11
@@ -32,11 +32,11 @@ Hint: the radius of a forklift wheel is 15cm.
32
32
33
33
## Touch sensor
34
34
35
-
In addition to other sensors, the Forklift also has a [microswitch touch sensor](../../api/touch) at the rear. This is used to detect if the forklift's rear is touching another object (a container, another robot, or a wall). The touch sensor is connected to pin `2` of the arduino.
35
+
In addition to other sensors, the forklift also has a [microswitch touch sensor](/api/touch) at the rear. This is used to detect if the forklift's rear is touching another object (a container, another robot, or a wall). The touch sensor is connected to pin `2` of the Arduino.
36
36
37
37
## Ultrasound (Distance) Sensor
38
38
39
-
The Forklift has many [ultrasound sensors](../../api/ultrasound) attached to various points in the robot, here is the layout of the ultrasound sensors:
39
+
The forklift has many [ultrasound sensors](/api/ultrasound) attached to various points in the robot, here is the layout of the ultrasound sensors:
40
40
41
41
- Sensor 0: Front Left
42
42
- Sensor 1: Front Right
@@ -47,4 +47,4 @@ The Forklift has many [ultrasound sensors](../../api/ultrasound) attached to var
47
47
48
48
## Radio
49
49
50
-
The Forklift robot has a [radio](../../api/radio) receiver attached to its center.
50
+
The forklift robot has a [radio](/api/radio) receiver attached to its centre.
0 commit comments