Merge pull request #16 from ErnGusMik/experimental

v2.4.1 Stable

.deepsource.toml

@@ -5,4 +5,5 @@ name = "python"
 enabled = true
 
   [analyzers.meta]
-  runtime_version = "3.x.x"
+  runtime_version = "3.x.x"
+  max_line_length = 100

LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 ErnGusMik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

MANIFEST.in

@@ -0,0 +1 @@
+include README.md

README.md

@@ -1,230 +1,43 @@
 # Python Tello
-This is a library for easy usage of the Ryze Tello drone education edition. <br />
-**Current Version:**
-*1.1 Beta* <br />
-SDK 3.0 Implementation under development!
-## Requirements:
-* Python installed on your system or as a VS Code extension
-* Ryze Tello EDU Edition (get one [here](https://www.ryzerobotics.com/tello-edu))
-* This package
-
-## Quickstart
-This quickstart focuses on the file edition.
-To get instructions for the live edition, go to [Tello Live Edition Guide]()
-```python
-import telloFile # Imports library
-tello = telloFile.Tello() # Sets var tello as the class
-tello.connect() # Initializes SDK mode (more below)
-```
-*(WRITEHERE.py)*
-
-## Usage
-The library consists of callable functions.
-To see `set` functions, please go [here](SET%26READ_GUIDE.md)
-To see `complex` functions, please go [here](COMPLEX_GUIDE.md)
-To see examples, please go [here]()
-
-### tello.connect()
-Initializes SDK mode.
-Must be run as the first function every time the script runs. <br />
-Possible responses: `ok` / `error` <br />
-Example:
-```python
-tello.connect()
-```
-### tello.takeoff()
-Automatic takeoff. <br />
-Possible responses: `ok` / `error` <br />
-Example:
-```python
-tello.takeoff()
-```
-
-### tello.land()
-Automatic landing. <br />
-Possible responses: `ok` / `error` <br />
-Example:
-```python
-tello.land()
-```
-
-### tello.video_stream_on()
-Enable video stream. <br />
-**Camera functionality under development** <br />
-Possible responses: `ok` / `error` <br />
-Example:
-```python
-tello.streamon()
-```
-
-### tello.video_stream_off()
-Disable video stream. <br />
-**Camera functionality under development** <br />
-Possible responses: `ok` / `error` <br />
-Example:
-```python
-tello.streamoff()
-```
-
-### tello.emergency()
-Stops all motors immediately. <br />
-**Danger of drone falling!** <br />
-Possible responses: `ok` / `error` <br />
-Parameters:
-* reason: String, *optional*. Reason for stopping motors.<br />
-Example:
-```python
-tello.emergency('The drone has hit a wall')
-```
-
-### tello.stop()
-Stops all movement and hovers in the air. <br />
-Possible responses: `ok` / `error` <br />
-Example:
-```python
-tello.stop()
-```
 
-### tello.up(x)
-Ascends to *x* cm off the ground. <br />
-Possible responses: `ok` / `error` <br />
-Parameters:
-* x: Integer. Height in cm. Allowed values: 20-500<br />
-Example:
-```python
-tello.up(30)
-```
+This is a library for easy usage of the Ryze Tello drone education edition and RoboMaster Tello Talent. Beginner Friendly! <br />
+**Current Version:**
+_2.4.1_ <br />
+SDK 3.0 is **here** and **tested**!
 
-### tello.down(x)
-Descends to *x* cm off the ground. <br />
-Possible responses: `ok` / `error` <br />
-Parameters:
-* x: Integer. Height in cm. Allowed values: 20-500<br />
-Example:
-```python
-tello.down(100)
-```
+## Requirements:
 
-### tello.left(x)
-Goes left for *x* cm. <br />
-Possible responses: `ok` / `error` <br />
-Parameters:
-* x: Integer. Distance in cm. Allowed values: 20-500<br />
-Example:
-```python
-tello.left(249)
-```
+- Python 3.6 or higher installed on your system (get it on [python.org](https://www.python.org/))
+- Ryze Tello EDU Edition (get one [here](https://www.ryzerobotics.com/tello-edu)) OR RoboMaster Tello Talent (get one [here](https://store.dji.com/product/robomaster-tt))
+- This package
 
-### tello.right(x)
-Goes right for *x* cm. <br />
-Possible responses: `ok` / `error` <br />
-Parameters:
-* x: Integer. Distance in cm. Allowed values: 20-500<br />
-Example:
-```python
-tello.right(23)
-```
+## Documentation
 
-### tello.forward(x)
-Goes forwards for *x* cm. <br />
-Possible responses: `ok` / `error` <br />
-Parameters:
-* x: Integer. Distance in cm. Allowed values: 20-500<br />
-Example:
-```python
-tello.forward(500)
-```
+To see the documentation, please go to the GitHub Wiki of this project, available [here](https://github.com/ErnGusMik/python-tello/wiki)
 
-### tello.back(x)
-Goes backwards for *x* cm. <br />
-Possible responses: `ok` / `error` <br />
-Parameters:
-* x: Integer. Distance in cm. Allowed values: 20-500<br />
-Example:
-```python
-tello.back(65)
-```
+## Getting Started
 
-### tello.cw(x)
-Rotates clockwise for *x* degrees. <br />
-Possible responses: `ok` / `error` <br />
-Parameters:
-* x: Integer. Degrees to turn.  Allowed values: 1-360<br />
-Example:
-```python
-tello.cw(100)
-```
+You can get this package on PyPi (pip) and GitHub.
+To donwload using GitHub, please click [this link](https://github.com/ErnGusMik/python-tello/archive/refs/heads/main.zip). The package will start downloading.
+To download using pip, enter the following in your terminal interface (Command Prompt on Windows):
 
-### tello.ccw(x)
-Rotates counter-clockwise for *x* degrees. <br />
-Possible responses: `ok` / `error` <br />
-Parameters:
-* x: Integer. Degrees to turn.  Allowed values: 1-360<br />
-Example:
-```python
-tello.ccw(359)
+```bash
+user@os$ pip install tello-sdk
 ```
 
-### tello.flip(x)
-Flips drone in *x* direction. <br />
-Possible responses: `ok` / `error` <br />
-Parameters:
-* x: String. Direction to flip.  Allowed values: `'f'` (forwards), `'b'` (backwards), `'l'` (left), `'r'` (right)<br />
-Example:
-```python
-tello.flip('l')
-```
-
-### tello.throw_fly()
-Toss the drone in the air within 5 seconds of receiving response to takeoff <br />
-Possible responses: `ok` / `error` <br />
-Example:
-```python
-tello.throw_fly()
-```
+[More info in the Docs](https://github.com/ErnGusMik/python-tello/wiki)
 
-### tello.motor_on()
-Turns on motors (at a slow RPM)<br />
-Possible responses: `ok` / `error` <br />
-Example:
-```python
-tello.motor_on()
-```
+## Usage
 
-### tello.motor_off()
-Turns off motors (use motor_on() first)<br />
-Possible responses: `ok` / `error` <br />
-Example:
-```python
-tello.motor_off()
-```
+The library is beginner friendly. Even if you are new to programming, usage should be easy.
+The Tello SDK library is made of callable functions that make the drone do something.
 
-### tello.throw_fly()
-Turns off motors (use tello.motoron() first)<br />
-Possible responses: `ok` / `error` <br />
-Example:
-```python
-tello.motoroff()
-```
+[For function names, refer to the Docs](https://github.com/ErnGusMik/python-tello/wiki)
 
-### tello.end()
-Ends the program. <br />
-Possible responses: `ok` / Thrown `error` <br />
-Example:
-```python
-tello.end()
-```
+## Contributors
 
-## Version history:
-**1.1 Beta:**
-* Implementation of some Tello SDK 3.0 commands
-* Naming changes
-* Functions now return the response
-* In development: camera functions, customization, SDK 3.0 full implementation
-* V1.1.1: spelling fix
+This library was created entirely by ErnGusMik
 
+## Licence
 
-**1.0 Beta:**
-* Implement most of Tello SDK 2.0 commands
-* Documentation started
-* `tello.run()` command for executing any command straight to the drone.
+This library is licenced under the MIT licence.

VERSIONS.md

@@ -0,0 +1,80 @@
+# Tello & RMTT SDK
+
+## Version history:
+
+**2.4.1**
+
+- Documentation finished
+- Redone README.md
+- Added VERSIONS.md
+
+**2.3.0-alpha**
+
+- Naming changes
+- Added tello_version()
+- Did research.
+
+**2.1.0-alpha**
+
+- Tested all new EXT commands
+- Tested most other new commands
+- setup.py changes (long-description)
+- deepsource.toml changes (max-line-limt: 100)
+- tello.set_display_ascii_character() is still being tested.
+
+**2.0.5-alpha**
+
+- setup.py changes
+- Re-releasing on pip
+
+**2.0.4-alpha**
+
+- Readded .deepsource.toml
+- Hopefully fixed pip 'No Description provided' issue
+
+**2.0.3-alpha**
+
+- Reorganized structure for PyPi
+- Added LICENSE.txt (MIT License)
+- Added setup.cfg
+- Added setup.py and configured for PyPi
+- Added tello-sdk/**init**.py
+- We're pip installable now!
+
+**2.0.2-alpha**
+
+- Style fixes
+- Started work on going pip-ready :)
+- Changed all print to logging (for easier debugging)
+- Added debugging and tips options to Tello class
+
+**2.0.1-alpha**
+
+- Small fixes
+
+**2.0-alpha**
+
+- All new Tello SDK 3.0 commands implemented!
+- Small potential bug/style fixes
+- This is an Alpha version, so it is **not** stable, by any means!
+
+**1.1.2-alpha**
+
+- Potential bug fixes
+- Security issue fix
+- Performance optimizations
+- Remodel of **init** function
+
+**1.1-beta:**
+
+- Implementation of some Tello SDK 3.0 commands
+- Naming changes
+- Functions now return the response
+- In development: camera functions, customization, SDK 3.0 full implementation
+- V1.1.1: spelling fix
+
+**1.0-beta:**
+
+- Implement most of Tello SDK 2.0 commands
+- Documentation started
+- `tello.run()` command for executing any command straight to the drone.