const classafParrotSdk2::DroneUserConfig
sys::Obj afParrotSdk2::DroneUserConfig
Drone config in the User category. This config contains preferences for individual human users, so is largely based on controller sensitivity profiles.
Create a new user by means of:
drone.config.session.user("My User Name")
Future code may then access the same user by not passing a user name:
prof := drone.config.session.user.currentProfile
- currentProfile
Str:Int currentProfile { private set }
Returns the current sensitivity profile. These are the absolute values allowed by the drone. All drone move commands pertain to a percentage of the max values detailed here.
drone.config.session.user.currentProfile()
// --> [maxEulerAngle:20, maxVerticalSpeed:1000, maxYawSpeed:200]This method will return either the indoor or outdoor profile dependent on the
drone.config.useOutdoorProfile
setting.maxEulerAngle
is the maximum bending angle for the drone in degrees, for both pitch and roll angles. Recommended values are 0 - 30 degrees.maxVerticalSpeed
is the maximum vertical speed of the drone in milimeters per second. Recommended values are 200 - 2000.maxYawSpeed
is the maximum yaw (spin) speed of the drone in degrees per second. Recommanded values are 40 - 350.
Corresponds to the configuration keys:
CONTROL:euler_angle_max
CONTROL:control_vz_max
CONTROL:control_yaw
- deleteAll
Void deleteAll()
Deletes ALL user data from the drone. Use with caution.
- deleteMe
Void deleteMe()
Deletes this user profile from the drone.
- dump
Str dump(Bool dumpToStdOut := true)
Dumps all fields to debug string.
- id
Int id { private set }
The current user ID.
Corresponds to the
CUSTOM:user_id
configuration key.- indoorProfile
Sensitivity profile for indoor use. To use this profile, set the following:
drone.config.useOutdoorProfile = false
See currentProfile for value details.
drone.config.session.user.indoorProfile()
// --> [maxEulerAngle:12, maxVerticalSpeed:700, maxYawSpeed:100]When setting values, all unknown values are ignored. To change, pass in a map with just the values you wish to update.
Corresponds to the configuration keys:
CONTROL:indoor_euler_angle_max
CONTROL:indoor_control_vz_max
CONTROL:indoor_control_yaw
- make
new make(Drone drone)
Creates a new
DroneUserConfig
instance for the given Drone. Note this class holds no state.- name
Str name { private set }
The current user name.
Corresponds to the
CUSTOM:user_desc
configuration key.- outdoorProfile
Sensitivity profile for outdoor use. To use this profile, set the following:
drone.config.useOutdoorProfile = true
See currentProfile for value details.
drone.config.session.user.outdoorProfile()
// --> [maxEulerAngle:20, maxVerticalSpeed:1000, maxYawSpeed:200]When setting values, all unknown values are ignored. To change, pass in a map with just the values you wish to update.
Corresponds to the configuration keys:
CONTROL:outdoor_euler_angle_max
CONTROL:outdoor_control_vz_max
CONTROL:outdoor_control_yaw