Skip to content

Commit 47a2a29

Browse files
author
Adimote
committed
fix spelling and links
1 parent 518b3e4 commit 47a2a29

File tree

8 files changed

+43
-27
lines changed

8 files changed

+43
-27
lines changed

.spelling

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,23 @@
1+
×
12
100x100mm
23
11.1V
4+
15cm
5+
2.2A.
6+
2.5m
37
20000Hz
48
20Hz
59
2200mAh
6-
2.2A.
710
250x250mm
11+
2m
812
2mm
913
3.3V
1014
3.81mm
1115
3m
1216
4mm
1317
5mm
14-
70x84x20mm
15-
7.5mm
1618
7-zip
19+
7.5mm
20+
70x84x20mm
1721
83x99x24mm
1822
Adafruit
1923
AprilTag
@@ -25,7 +29,9 @@ Codecademy
2529
Datacamp
2630
dropdown
2731
elif
32+
energised
2833
enum
34+
forklift
2935
FreeCodeCamp
3036
H0-1
3137
iMAX
@@ -38,6 +44,7 @@ LiPo
3844
macOS
3945
Math
4046
matplotlib
47+
microswitch
4148
microswitches
4249
numpy
4350
piezo
@@ -46,19 +53,20 @@ Programiz
4653
PyCharm
4754
pyplot
4855
python3
56+
r.zone
4957
R2021b
5058
scikit-learn
5159
scipy
52-
SourceBots
5360
Smallpeice
61+
SourceBots
5462
square-ish
5563
StackOverflow
5664
submodule
65+
TargetInfo
5766
TeckNet
5867
Tutorialspoint
5968
Uno
6069
vcc
6170
VSCode
6271
W3Schools
6372
Webots
64-
×

content/api/encoder.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Linear encoders are attached to joints that move in a straight line (i.e. raisin
1111

1212
Linear encoders measure the distance the joint has moved from its start position, in *metres*.
1313

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/).
1515

1616
```python
1717
# Get the distance from the start position
@@ -24,7 +24,7 @@ Rotary encoders are attached to joints that rotate (i.e. wheel rotations).
2424

2525
Rotary encoders measure the total rotation the joint has moved from its start position, in *radians*.
2626

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/).
2828

2929
```python
3030
# Get the total rotation from the start position

content/api/magnet.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,19 @@ r.magnet.energised = False
1818
```
1919

2020
{{% notice warning %}}
21-
Check the spelling of `energised`, it's in british english, `energized` will not work!
21+
Check the spelling of `energised`, it's in British English, `energized` will not work!
2222
{{% /notice %}}
2323

2424
You can get the current state of the magnet by getting the value of `energized` like so:
2525

2626
```python
2727
magnet_on = r.magnet.energised
2828
```
29+
30+
## Checking if a container is nearby
31+
32+
The magnet can tell you if there is an object in range to be picked up. You can check if any object is in range by accessing the `nearby` property.
33+
```python
34+
# Get if a container is nearby
35+
is_nearby = r.magnet.nearby # True or False
36+
```

content/api/radio.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ which has a `sweep` function that detects transmitters that are in range:
1717
transmitters = r.radio.sweep()
1818
```
1919

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.
2121
It returns a list of `Target` objects, each of which describes one of the transmitters that were found within range.
2222
A detailed description of the attributes of `Target` objects is provided at the bottom of this page.
2323

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:
2525

2626
``` python
2727
# Continuously prints details of nearby transmitters.
@@ -39,7 +39,7 @@ while True:
3939

4040
## Detecting beacons
4141

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.
4343

4444
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.
4545

@@ -73,10 +73,10 @@ The `TargetInfo` object contains information about a transmitter.
7373
It has the following attributes:
7474

7575
`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.
7777

7878
`type`
7979
: The type of the transmitter, either `0` (`TargetType.BEACON`) for a beacon, or `1` (`TargetType.CONTAINER`) for a container.
8080

8181
`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)

content/api/touch.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ Microswitches, or touch sensors, are used to measure when something is touching
77

88
## Reading the touch sensor
99

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.
1111

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:
1313

1414
``` python
1515
# Get if something is touching the touch sensor.

content/api/ultrasound.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ Ultrasound sensors can measure distance of objects from the sensor. Ultrasound s
77

88
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).
99

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.
1111

1212
## Reading the ultrasound sensor
1313

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.
1515

1616
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.
1717

content/robots/crane.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ title: Crane Robot
33
weight: 2
44
---
55

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.
77

88
Additionally, the crane has one ultrasound distance sensor and a radio, both attached to the hook (see below).
99

1010
## Motor layout
1111

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:
1313

1414
- Motor Board 0:
1515
- Motor 0 - Bridge motor
@@ -19,16 +19,16 @@ The layout of the [motors](../../api/motor-board) attached to the motor boards a
1919

2020
## Encoder layout
2121

22-
The layout of the [encoders](../../api/encoder) are as follows:
22+
The layout of the [encoders](/api/encoder) are as follows:
2323

2424
- Slot 0: Bridge linear encoder
2525
- Slot 1: Trolley linear encoder
2626
- Slot 2: Hoist linear encoder
2727

2828
## Ultrasound sensor
2929

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.
3131

3232
## Radio
3333

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.

content/robots/forklift.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ title: Forklift Robot
33
weight: 1
44
---
55

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.
77

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.
99

1010
## Motor layout
1111

@@ -32,11 +32,11 @@ Hint: the radius of a forklift wheel is 15cm.
3232

3333
## Touch sensor
3434

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.
3636

3737
## Ultrasound (Distance) Sensor
3838

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:
4040

4141
- Sensor 0: Front Left
4242
- Sensor 1: Front Right
@@ -47,4 +47,4 @@ The Forklift has many [ultrasound sensors](../../api/ultrasound) attached to var
4747

4848
## Radio
4949

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

Comments
 (0)