MsDevices.SumoEyes Class Reference

SumoEyes: this class provides PiStorms specific interface for the SumoEyes obstacle detection sensor from mindsensors.com. More...

Inheritance diagram for MsDevices.SumoEyes:

Public Member Functions
def	__init__
	Initialize the class with the PiStorms bank. More...
def	detectObstactleZone
	Check the zones for an obstacle. More...
def	readSensorValue
	Reads the value from the SumoEyes sensor. More...
def	setRange
	Sets the sensor range to LONG_RANGE or SHORT_RANGE setting. More...
def	isNear
	Checks if the sensor reading is within a tolerance to find the zone. More...

Public Attributes
	sensor

Static Public Attributes
list	SE_None = [0, "None"]
dictionary	SE_Values
int	PS_S1EV_Ready = 0x70
int	PS_S2EV_Ready = 0xA4
	LONG_RANGE = True
	SHORT_RANGE = False

Detailed Description

SumoEyes: this class provides PiStorms specific interface for the SumoEyes obstacle detection sensor from mindsensors.com.

Constructor & Destructor Documentation

def MsDevices.SumoEyes.__init__	(		self,
			port
	)

Initialize the class with the PiStorms bank.

Parameters

self	The object pointer.
port	The PiStorms bank.

Remarks

Example implementation in your program:

...
psm = PiStorms() 
se_sensor = MsDevices.SumoEyes(psm.BAS1)
...

Member Function Documentation

def MsDevices.SumoEyes.detectObstactleZone	(		self,
			verbose = False
	)

Check the zones for an obstacle.

Parameters

self	The object pointer.
verbose	Outputs the string value of the direction if set to True

Remarks

Example implementation in your program:

...
psm = PiStorms() 
se_sensor = MsDevices.SumoEyes(psm.BAS1)
print se_sensor.detectObstactleZone()
...

def MsDevices.SumoEyes.isNear	(		self,
			reference,
			value,
			tolerance = 40
	)

Checks if the sensor reading is within a tolerance to find the zone.

Parameters

self	The object pointer.
reference	The reference value.
value	The sensor measurement.
tolerance	The tolerance.

Remarks

Should not be used in other programs

def MsDevices.SumoEyes.readSensorValue

(

self

)

Reads the value from the SumoEyes sensor.

Parameters

self	The object pointer.

Remarks

Should not be used in other programs

def MsDevices.SumoEyes.setRange	(		self,
			range = LONG_RANGE
	)

Sets the sensor range to LONG_RANGE or SHORT_RANGE setting.

Parameters

self	The object LONG_RANGE.
range	The range (long is default)

Remarks

Example implementation in your program:

...
psm = PiStorms() 
se_sensor = MsDevices.SumoEyes(psm.BAS1)
se_sensor.setRange(se_sensor.SHORT_RANGE)
...

Member Data Documentation

dictionary MsDevices.SumoEyes.SE_Values

static

Initial value:

= {
        465: [1, "Front"],
        555: [3, "Right"],
        800: [2, "Left"]
    }

---

The documentation for this class was generated from the following file:

• PiStorms/sys/MsDevices.py