Home       Trees       Index       Help   

Pyro - Python Robotics

Package pyrobot :: Package robot :: Module device :: Class Device
[frames | no frames]

Class Device

Known Subclasses:
AiboHeadDevice, Camera, Gripper, IRSensor, PlayerDevice, RobocupLaserDevice, RobocupSimulationDevice, SimDevice, SimplePlot, SimulationDevice, TestDevice
A basic device class. All device derive from this.
Method Summary
  __init__(self, deviceType, visible)
Constructor for the device class.
  __getitem__(self, item)
Get a SensorValue, a range, or a set.
  __iter__(self)
Used to iterate through SensorValues of device.
  addWidgets(self, window)
Method to addWidgets to the device window.
  angle(self, *args, **kwargs)
Device-level method to get all of the angles.
  destroy(self)
Hides the window.
  distance(self, *args, **kwargs)
Device-level method to get all of the distances.
  getActive(self)
Returns the value of .active.
  getDeviceData(self)
Returns the device data, whatever it might be.
  getDeviceState(self)
Returns the .state.
  getGroupNames(self, pos)
Return all of the groups a pos is in.
  getMaxvalue(self)
Get the maxvalue of the sensor.
  getSensorValue(self, pos)
Returns a specific SensorValue from the range device.
  getVisible(self)
Returns the .visible of the sensor.
  makeWindow(self)
Method to make and show the device window.
  rawToUnits(self, raw, noise, units)
Convert the sensor units into default units.
  setActive(self, value)
Sets the .active property.
  setMaxvalue(self, value)
Set the maxvalue of the sensor.
  setTitle(self, title)
Sets the title of the device.
  setup(self)
Use this to put setup code in (instead of in __init__).
  setVisible(self, value)
Sets the .visible attribute, and hides/shows window.
  startDevice(self)
Starts the device (sets the .state).
  stopDevice(self)
Stops the device (sets the .state).
  updateDevice(self)
Method called to update the device properties.
  updateWindow(self)
Method to update the device window.

Property Summary
  geometry
  noise
  pos
  rawValue
  value

Method Details

__init__(self, deviceType='unspecified', visible=0)
(Constructor) 

Constructor for the device class.

__getitem__(self, item)
(Indexing operator) 

Get a SensorValue, a range, or a set.

__iter__(self) 

Used to iterate through SensorValues of device.

addWidgets(self, window) 

Method to addWidgets to the device window.

angle(self, *args, **kwargs) 

Device-level method to get all of the angles. Can translate units.

>>> robot.sonar[0][3].angle(unit="radians")
>>> [s.angle(units="degrees") for s in robot.sonar[0]["left"]]

destroy(self) 

Hides the window.

distance(self, *args, **kwargs) 

Device-level method to get all of the distances.

>>> robot.sonar[0].angle(unit="radians")
[2.34, 1.34, .545]
>>> robot.sonar[0]["left"].angle(unit="degrees")
[90, 45, 180]

getActive(self) 

Returns the value of .active.

getDeviceData(self) 

Returns the device data, whatever it might be.

getDeviceState(self) 

Returns the .state.

getGroupNames(self, pos) 

Return all of the groups a pos is in.

getMaxvalue(self) 

Get the maxvalue of the sensor.

getSensorValue(self, pos) 

Returns a specific SensorValue from the range device.

getVisible(self) 

Returns the .visible of the sensor.

makeWindow(self) 

Method to make and show the device window.

rawToUnits(self, raw, noise=0.0, units=None) 

Convert the sensor units into default units.

setActive(self, value) 

Sets the .active property.

setMaxvalue(self, value) 

Set the maxvalue of the sensor.

setTitle(self, title) 

Sets the title of the device.

setup(self) 

Use this to put setup code in (instead of in __init__).

setVisible(self, value) 

Sets the .visible attribute, and hides/shows window.

startDevice(self) 

Starts the device (sets the .state).

stopDevice(self) 

Stops the device (sets the .state).

updateDevice(self) 

Method called to update the device properties.

updateWindow(self) 

Method to update the device window.

   Home       Trees       Index       Help   

Pyro - Python Robotics

Generated by Epydoc 2.1 on Mon Jul 25 01:39:27 2005 http://epydoc.sf.net