VEX IQ Python API
Public Member Functions | List of all members
vex.Sonar Class Reference
Inheritance diagram for vex.Sonar:
vex.Device

Public Member Functions

def __init__ (self, index)
 
def set_maximum (self, distance, distanceUnits=DistanceUnits.MM)
 Sets the maximum distance (default 2.5m) More...
 
def distance (self, distanceUnits=DistanceUnits.MM)
 Gets the value of the sonar sensor. More...
 

Detailed Description

 Creates a new sonar sensor object on the port specified in the parameter.
 @param index to the brain port.

Constructor & Destructor Documentation

◆ __init__()

def vex.Sonar.__init__ (   self,
  index 
)

Member Function Documentation

◆ set_maximum()

def vex.Sonar.set_maximum (   self,
  distance,
  distanceUnits = DistanceUnits.MM 
)

Sets the maximum distance (default 2.5m)

Parameters
distancemaximum distance to be measured in units
distanceUnitsa DistanceUnits enum value for the measurement unit.

◆ distance()

def vex.Sonar.distance (   self,
  distanceUnits = DistanceUnits.MM 
)

Gets the value of the sonar sensor.

Returns
an integer that represents the unit value specified by the parameter.
Parameters
distanceUnitsThe measurement unit for the sonar device, DistanceUnits enum value.