Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos #376

Merged
merged 7 commits into from
Feb 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/functional-areas/crazyradio_lib.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ None
| -------------| --------------------------------------------------------|
| Parameters | (bool) active|
| Returns | None|
| Description | Enable or disable the continious carrier mode. In continious carrier the Crazyradio transmit a constant sinus at the currently set frequency (channel) and power. This is a test mode that can affect other 2.4GHz devices (ex. wifi) it should only be used in a lab for test purposes.|
| Description | Enable or disable the continuous carrier mode. In continuous carrier the Crazyradio transmit a constant sinus at the currently set frequency (channel) and power. This is a test mode that can affect other 2.4GHz devices (ex. wifi) it should only be used in a lab for test purposes.|

##### scan\_channels(self, start, stop, packet)

Expand Down
22 changes: 11 additions & 11 deletions docs/user-guides/python_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ following way:

There\'s a few limitations that needs to be taken into account:

- The maximum byte lenght for a log packet is of 26 bytes. This for
- The maximum byte length for a log packet is of 26 bytes. This for
for example allows to log 6 floats and one uint16_t (6*4 + 2 bytes)
in a single packet.
- The minimum period of a for a log configuration is multiples of 10ms
Expand Down Expand Up @@ -237,14 +237,14 @@ To send a new control set-point use the following:

Thrust is an integer value ranging from 10001 (next to no power) to
60000 (full power). It corresponds to the mean thrust that will be
appied to the motors. There is a battery compensation algorythm
applied to the motors. There is a battery compensation algorithm
applied to make the thrust mostly independent of battery voltage.
Roll/pitch are in degree and yarate in degree/seconds.
Roll/pitch are in degree and yawrate in degree/seconds.

This command will set the attitude controller setpoint for the next
500ms. After 500ms without net setpoint, the Crazyflie will apply a
setpoint with the same thrust but with roll/pitch/yawrate = 0, this
will make the Crazyflie stop accelerate. After 2secons without new
will make the Crazyflie stop accelerate. After 2 seconds without new
setpoint the Crazyflie will cut power to the motors.

Note that this command implements a motor lock mechanism that is
Expand Down Expand Up @@ -428,12 +428,12 @@ The logging cannot be started until your are connected to a Crazyflie:
print "Error when logging %s" % logconf.name
```

The values of log varibles are transferred from the Crazyflie using CRTP
packets, where all varibles belonging to one logging configuration are
transfered in the same packet. A CRTP packet has a maximum data size of
The values of log variables are transferred from the Crazyflie using CRTP
packets, where all variables belonging to one logging configuration are
transferred in the same packet. A CRTP packet has a maximum data size of
30 bytes, which sets an upper limit to the number of variables that
can be used in one logging configuration. If the desired log variables
do not fit in one logging configuration, a second cofiguration may
do not fit in one logging configuration, a second configuration may
be added.

``` python
Expand All @@ -442,7 +442,7 @@ be added.

## Synchronous API

The synchronous classes are wrappers around the asynchronouse API, where the asynchronous
The synchronous classes are wrappers around the asynchronous API, where the asynchronous
calls/callbacks are replaced with blocking calls. The synchronous API does not
provide the full flexibility of the asynchronous API, but is useful when writing
small scripts for logging for instance.
Expand All @@ -453,12 +453,12 @@ exiting it, for instance a connection or take off/landing of a Crazyflie.

### SyncCrazyflie

The SyncCrazyflie class wrapps a Crazyflie instance and mainly simplifies connect/disconnect.
The SyncCrazyflie class wraps a Crazyflie instance and mainly simplifies connect/disconnect.

Basic usage
``` python
with SyncCrazyflie(uri) as scf:
# A Crazyflie instance is created and is now connected. If the connection failes,
# A Crazyflie instance is created and is now connected. If the connection fails,
# an exception is raised.

# The underlying crazyflie object can be accessed through the cf member
Expand Down
4 changes: 2 additions & 2 deletions docs/user-guides/sbs_connect_log_param.md
Original file line number Diff line number Diff line change
Expand Up @@ -411,7 +411,7 @@ Then add the following to the `def simple_param_async(...)` function:
time.sleep(1)

```
The sleep function is to give the script a bit more time to wait for the Crazyflies response and not lose the connection immediatly.
The sleep function is to give the script a bit more time to wait for the Crazyflies response and not lose the connection immediately.

If you would like to test out the script now already, replace `simple_log_async(...)` with `simple_param_async(scf, group, name)` and run the script. You can see that it will print out the variable name and value:
`The crazyflie has parameter stabilizer.estimator set at number: 1`
Expand All @@ -436,7 +436,7 @@ What it can't do is to set a Read Only (RO) parameter, only Read Write (RW) para

## Finishing and running the script

It is usually good practice to put the parameter setting back to where it came from, since after disconnecting the Crazyflie, the parameter will still be set. Only after physcially restarting the Crazyflie the parameter will reset to its default setting as defined in the firmware.
It is usually good practice to put the parameter setting back to where it came from, since after disconnecting the Crazyflie, the parameter will still be set. Only after physically restarting the Crazyflie the parameter will reset to its default setting as defined in the firmware.

So finish the `simple_param_async(...)` function by adding the next few lines:
```python
Expand Down
4 changes: 2 additions & 2 deletions docs/user-guides/sbs_motion_commander.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ The reason for the crazyflie to immediately take off, is that the motion command

## Changing the height

Currently the motion commander had 0.3 meters height as default but this can ofcourse be changed.
Currently the motion commander had 0.3 meters height as default but this can of course be changed.

Change the following line in `take_off_simple(...)`:
```python
Expand Down Expand Up @@ -257,7 +257,7 @@ Now we are going to add a turn into it. Replace the content under motion command
time.sleep(1)
```

Try to run the script again. Now you can see the crazyflie take off, go forward, turn 180 degrees and go forward again to its initial position. The `mc.back()` needed to be replaced with the forward since the motion commander sends the velocity setpoints in the __body fixed coordinated__ system. This means that the commands forward will go forward to whereever the current heading (the front) of the crazyflie points to.
Try to run the script again. Now you can see the crazyflie take off, go forward, turn 180 degrees and go forward again to its initial position. The `mc.back()` needed to be replaced with the forward since the motion commander sends the velocity setpoints in the __body fixed coordinated__ system. This means that the commands forward will go forward to wherever the current heading (the front) of the crazyflie points to.

Double check if your code code is still correct:

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guides/sbs_swarm_interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ if __name__ == '__main__':
If everything is working properly, you can move to the next step .

# Step 2: Security Before Flying
Before executing any take off and flight maneuvers, the copters need to make sure that they have a precise enough position estimation. Otherwise it will take off anyway and it is very likely to crash. This is done through `reset_estimators()` by resetting the internal position estimator of each copter and waiting until the variance of the position estimation drops below a certain threshold.
Before executing any take off and flight manoeuvres, the copters need to make sure that they have a precise enough position estimation. Otherwise it will take off anyway and it is very likely to crash. This is done through `reset_estimators()` by resetting the internal position estimator of each copter and waiting until the variance of the position estimation drops below a certain threshold.
```python
with Swarm(uris, factory=factory) as swarm:
swarm.parallel_safe(lightCheck)
Expand Down
2 changes: 1 addition & 1 deletion examples/autonomy/position_commander_demo.py
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ def land_on_elevated_surface():
# fly onto a landing platform at non-zero height (ex: from floor to desk, etc)
pc.forward(1.0)
pc.left(1.0)
# land() will be called on context exit, gradually lowering to default_lanidng_height, then stoppig motors
# land() will be called on context exit, gradually lowering to default_landing_height, then stopping motors


def simple_sequence():
Expand Down
2 changes: 1 addition & 1 deletion examples/positioning/bezier_trajectory.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
autonomous_sequence_high_level.py example.

This code uses Bezier curves of degree 7, that is with 8 control points.
See https://en.wikipedia.org/wiki/B%C3%A9zier_curve
See https://en.wikipedia.org/wiki/Bézier_curve

All coordinates are (x, y, z, yaw)
"""
Expand Down