From f81bde7bb84e6d81c33f4a94db2cf8ac6fde3356 Mon Sep 17 00:00:00 2001 From: Stephen Merrony Date: Fri, 15 Jun 2018 11:17:48 +0100 Subject: [PATCH] Add proper README --- README.md | 45 ++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 44 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 72251c2..b0dc6f9 100644 --- a/README.md +++ b/README.md @@ -1 +1,44 @@ -# telloterm \ No newline at end of file +# telloterm +A functioning desktop testbed for flying the Ryze Tello drone via my tello API. + +_Play with this entirely at your own risk - it's not the author's fault if you lose your drone +or damage it, or anything else, when using this software._ + +Telloterm currently provides +* detailed Tello status display +* control from the keyboard +* picture taking +* optional live video feed via mplayer (must be installed separately) +* optional control via a Dualshock 4 game controller or Thrustmaster HotasX flight controller + +Only tested on GNU/Linux - it almost certainly won't work as-is on other platforms. + + +## Install + +``go get github.com/SMerrony/telloterm`` + +If you wish to use the video window you must have mplayer installed and on your PATH. + +## Usage +* Centre the throttle control at the mid-position if using a flight controller +* Turn on the Tello +* Wait for it to initialise (flashing orange LED) +* Connect your computer to the Tello WiFi +* Run telloterm from a terminal window + +Hit 'v' to start a video feed, an mplayer window should appear. + +To get help type `telloterm -h` + +Use the `-joyhelp` option to see the joystick control mappings. You will need to specify an ID and type to use a joystick. + +Use the `-keyhelp` option to see the keyboard control mappings. Be aware that in keyboard mode Tello motion continues until you +counteract it, or stop the Tello with the space bar. + +If you find that mplayer takes over the whole screen (rather than being in its own window), then try the -x11 option which may help. + +N.B. To control the Tello the telloterm window must have focus. + +Once you have landed the drone, stop the program with the Q key, and photos that have been successfully taken will then be saved +in the current directory. \ No newline at end of file