Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit e2ecba9

Browse files
Updated Readme
Fixed some naming and old TODO
1 parent 0237938 commit e2ecba9

File tree

4 files changed

+30
-8
lines changed

4 files changed

+30
-8
lines changed

‎README.md‎

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
This package includes modules and tools to simulate an aerial vehicle similar to a quadcopter, and
44
makes it easy to use it for various A.I. applications such as path following, obstacle avoidance, etc.
55

6+
It comes with a bunch of sensors that can be attached to the UAV, such as a Camera (RGB and Depth), IMU (motion), and more to come.
7+
The simulator can have an "objective" set to generate observations for machine learning applications.
8+
69
## Installation
710

811
Install the package using pip from :
@@ -13,7 +16,7 @@ pip install git+https://github.com/nb-programmer/dronesim.git
1316

1417
## Usage
1518

16-
Run the default simulator which launches a window with keyboard controls, Video stream though UDP and a scene with an elliptical path to traverse.
19+
Run the default simulator which launches a window with keyboard controls and a scene with an elliptical path to traverse.
1720

1821
To run the simulator, call the package name in the terminal:
1922

@@ -27,11 +30,30 @@ Or alternatively, execute the package using the Python interpreter:
2730
$ python -m dronesim
2831
```
2932

30-
Use the keyboard to control the drone, with the following binds:
33+
Refer to the `examples/` folder for running the simulator with custom controllers
34+
35+
## Controls
36+
37+
### Simulator controls
38+
39+
Use the keyboard and mouse to interact with the simulator app.
40+
41+
The default mouse control is set to `Free mode` with mouse for looking.
42+
43+
Key|Action
44+
---|---
45+
Esc|Unlock/Lock and Show/Hide mouse
46+
F3|Show debug data
47+
F5|Change camera mode from one of three [Free, First Person and Third Person]
48+
F6|Toggle control between camera and UAV
49+
F11|Toggle fullscreen
50+
51+
### Default drone controls
52+
53+
Use the keyboard to control the drone or camera, with the following binds:
3154

3255
Key|Action
3356
---|---
34-
R|Reset simulator state
3557
I|Take off
3658
K|Land
3759
W|Move forwards

‎dronesim/sensor/motion.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
from .sensor import SensorBase
22

3-
class EKFSensor(SensorBase):
3+
class IMUSensor(SensorBase):
44
def update(self):
55
pass
66

‎dronesim/simapp.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -310,8 +310,7 @@ def update(self, state : dict = None):
310310
bone['bone'].setH(bone['bone'].getH() + prop_vel*bone['spinDir'])
311311

312312
super().update()
313-
314-
#TODO: Support multiple drone actors using tuple of (IDroneControllable, Actor) pairs
313+
315314
class SimulatorApplication(ShowBase):
316315
'''
317316
'''

‎dronesim/simulator.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
from .objective import ObjectiveBase
55
from .types import StateType, StepActionType
66

7-
from .sensor.motion import EKFSensor
7+
#Default sensors to attach
8+
from .sensor.motion import IMUSensor
89

910
import typing
1011

@@ -29,7 +30,7 @@ def __init__(self,
2930

3031
#Sensor attachment
3132
if default_sensors:
32-
self.addSensor(ekf0 = EKFSensor())
33+
self.addSensor(ekf0 = IMUSensor())
3334

3435
self.addSensor(**additional_sensors)
3536

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /