docs update complete

Author: sytelus

AirLib/include/common/AirSimSettings.hpp

@@ -566,6 +566,10 @@ struct AirSimSettings {
         //these settings_json are expected in same section, not in another child
         auto vehicle_setting = std::unique_ptr<PX4VehicleSetting>(new PX4VehicleSetting());
 
+        //TODO: we should be selecting remote if available else keyboard
+        //currently keyboard is not supported so use rc as default
+        vehicle_setting->rc.remote_control_id = 0;
+
         MavLinkConnectionInfo &connection_info = vehicle_setting->connection_info;
         connection_info.sim_sysid = static_cast<uint8_t>(settings_json.getInt("SimSysID", connection_info.sim_sysid));
         connection_info.sim_compid = settings_json.getInt("SimCompID", connection_info.sim_compid);
@@ -620,8 +624,15 @@ struct AirSimSettings {
         std::unique_ptr<VehicleSetting> vehicle_setting;
         if (vehicle_type == kVehicleTypePX4)
             vehicle_setting = createPX4VehicleSetting(settings_json);
-        else //for everything else we don't need derived class yet
+        //for everything else we don't need derived class yet
+        else {
             vehicle_setting = std::unique_ptr<VehicleSetting>(new VehicleSetting());
+            if (vehicle_type == kVehicleTypeSimpleFlight) {
+                //TODO: we should be selecting remote if available else keyboard
+                //currently keyboard is not supported so use rc as default
+                vehicle_setting->rc.remote_control_id = 0;
+            }
+        }
         vehicle_setting->vehicle_name = vehicle_name;
 
         //required settings_json
@@ -660,6 +671,9 @@ struct AirSimSettings {
     {
         vehicles.clear();
 
+        //NOTE: Do not set defaults for vehicle type here. If you do then make sure
+        //to sync code in createVehicleSetting() as well.
+
         //create simple flight as default multirotor
         auto simple_flight_setting = std::unique_ptr<VehicleSetting>(new VehicleSetting());
         simple_flight_setting->vehicle_name = "SimpleFlight";
@@ -692,6 +706,10 @@ struct AirSimSettings {
             std::vector<std::string> keys;
             vehicles_child.getChildNames(keys);
 
+            //remove default vehicles, if values are specified in settings
+            if (keys.size())
+                vehicles.clear();
+
             for (const auto& key : keys) {
                 msr::airlib::Settings child;
                 vehicles_child.getChild(key, child);

PythonClient/README.md

@@ -1,26 +1,17 @@
-# Python API Examples for AirSim
+# Python API for AirSim
 
-This folder contains Python package and examples for [AirSim](https://github.com/microsoft/airsim).
+This package contains Python APIs for [AirSim](https://github.com/microsoft/airsim).
 
-## Pre-requisites
-Please make sure you have installed Python package for msgpack (this needs administrator/sudo prompt):
+## How to Use
+See examples at [car/hello_car.py](https://github.com/Microsoft/AirSim/blob/master/PythonClient/car/hello_car.py) or [multirotor\hello_drone.py](https://github.com/Microsoft/AirSim/blob/master/PythonClient/hello_drone.py). 
+
+## Dependencies
+This package depends on `msgpack` and would automatically install `msgpack-rpc-python` (this may need administrator/sudo prompt):
 ```
 pip install msgpack-rpc-python
 ```
 
-Some examples requires opencv. You can install required packages by running `install_packages.bat`.
-
-Note: Do not run `setup.py`. It is meant for creating python package.
-
-## How to Run
-Try out `car/hello_car.py` or `multirotor\hello_drone.py`. 
-You can run them either from Visual Studio solution or from command line like usual Python scripts.
-Also explore other examples.
-
-## Folder Structure
-
-The `airsim` folder contains wrapper over msgpack APIs to expose AirSim APIs in friendly Pythonic way. 
-Other folders contains example code for how to use APIs.
+Some examples also requires opencv.
 
 ## More Info
 

PythonClient/airsim.egg-info/PKG-INFO

@@ -0,0 +1,43 @@
+Metadata-Version: 2.1
+Name: airsim
+Version: 1.2.0
+Summary: Open source simulator based on Unreal Engine for autonomous vehicles from Microsoft AI & Research
+Home-page: https://github.com/microsoft/airsim
+Author: Shital Shah
+Author-email: sytelus@gmail.com
+License: UNKNOWN
+Description: # Python API Examples for AirSim
+        
+        This folder contains Python package and examples for [AirSim](https://github.com/microsoft/airsim).
+        
+        ## Pre-requisites
+        Please make sure you have installed Python package for msgpack (this needs administrator/sudo prompt):
+        ```
+        pip install msgpack-rpc-python
+        ```
+        
+        Some examples requires opencv. You can install required packages by running `install_packages.bat`.
+        
+        Note: Do not run `setup.py`. It is meant for creating python package.
+        
+        ## How to Run
+        Try out `car/hello_car.py` or `multirotor\hello_drone.py`. 
+        You can run them either from Visual Studio solution or from command line like usual Python scripts.
+        Also explore other examples.
+        
+        ## Folder Structure
+        
+        The `airsim` folder contains wrapper over msgpack APIs to expose AirSim APIs in friendly Pythonic way. 
+        Other folders contains example code for how to use APIs.
+        
+        ## More Info
+        
+        More information on AirSim Python APIs can be found at:
+        https://github.com/Microsoft/AirSim/blob/master/docs/python.md
+        
+        
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown

PythonClient/airsim.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+README.md
+setup.py
+airsim/__init__.py
+airsim/client.py
+airsim/pfm.py
+airsim/types.py
+airsim/utils.py
+airsim.egg-info/PKG-INFO
+airsim.egg-info/SOURCES.txt
+airsim.egg-info/dependency_links.txt
+airsim.egg-info/top_level.txt

PythonClient/airsim.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

PythonClient/airsim.egg-info/top_level.txt

@@ -0,0 +1 @@
+airsim

PythonClient/car/setup_path.py

@@ -35,18 +35,18 @@ def getParentDir():
     @staticmethod
     def addAirSimModulePath():
         # if airsim module is installed then don't do anything else
-        import pkgutil
-        airsim_loader = pkgutil.find_loader('airsim')
-        if airsim_loader is not None:
-            return
-
-        grand_parent = SetupPath.getParentDir()
-        if grand_parent !=  '':
-            airsim_path = os.path.join(grand_parent, 'airsim')
+        #import pkgutil
+        #airsim_loader = pkgutil.find_loader('airsim')
+        #if airsim_loader is not None:
+        #    return
+
+        parent = SetupPath.getParentDir()
+        if parent !=  '':
+            airsim_path = os.path.join(parent, 'airsim')
             client_path = os.path.join(airsim_path, 'client.py')
             if os.path.exists(client_path):
-                sys.path.insert(0, grand_parent)
+                sys.path.insert(0, parent)
         else:
-            logging.warning("airsim module not found in grand parent folder. Using default installed module (if any).")
+            logging.warning("airsim module not found in parent folder. Using installed package (pip install airsim).")
 
 SetupPath.addAirSimModulePath()

PythonClient/dist/airsim-1.2.0-py3-none-any.whl

@@ -18,4 +18,7 @@
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
     ),
+    install_requires=[
+          'msgpack-rpc-python', 'numpy'
+    ]
 )