PiStorms.PiStorms Class Reference

PiStorms: This class provides functions for PiStorms. More...

Inheritance diagram for PiStorms.PiStorms:

Public Member Functions
def	__init__
	Initialize the PiStorms motor and sensor ports. More...
def	command
def	Shutdown
	Shutdown the Raspberry Pi. More...
def	battVoltage
	Returns the input battery voltage. More...
def	GetFirmwareVersion
	Returns the PiStorms firmware version. More...
def	GetVendorName
	Returns the PiStorms vendor name. More...
def	GetDeviceId
	Returns the PiStorms device ID. More...
def	led
	Writes to the specified RGB LED. More...
def	isKeyPressed
	Check if the GO button is pressed. More...
def	getKeyPressValue
	Check if any Function button is pressed. More...
def	isF1Pressed
	Check if F1 Function button is pressed. More...
def	isF2Pressed
	Check if F2 Function button is pressed. More...
def	isF3Pressed
	Check if F3 Function button is pressed. More...
def	isF4Pressed
	Check if F4 Function button is pressed. More...
def	getKeyPressCount
	Returns the GO button press count. More...
def	resetKeyPressCount
	Resets the GO button press count. More...

Public Attributes
	screen
	An instance of mindsensorsUI.mindsensorsUI representing the PiStorms's touchscreen. More...
	psc
	An instance of PiStormsCom.PiStormsCom. More...
	BAS1
	An instance of PiStormsSensor representing Bank A sensor 1. More...
	BAS2
	An instance of PiStormsSensor representing Bank A sensor 2. More...
	BBS1
	An instance of PiStormsSensor representing Bank B sensor 1. More...
	BBS2
	An instance of PiStormsSensor representing Bank B sensor 2. More...
	BAM1
	An instance of PiStormsMotor representing Bank A motor 1. More...
	BAM2
	An instance of PiStormsMotor representing Bank A motor 2. More...
	BBM1
	An instance of PiStormsMotor representing Bank B motor 1. More...
	BBM2
	An instance of PiStormsMotor representing Bank B motor 2. More...

Detailed Description

PiStorms: This class provides functions for PiStorms.

PiStormsSensor, PiStormsMotor, and mindsensorsUI are subclasses of PiStorms and are automatically initialized with initialization of PiStorms class.

Constructor & Destructor Documentation

def PiStorms.PiStorms.__init__	(		self,
			name = "PiStorms",
			rotation = 3
	)

Initialize the PiStorms motor and sensor ports.

Parameters

self	The object pointer.
name	The display title that will appear at the top of the LCD touchscreen.
rotation	The rotation of the LCD touchscreen.

Remarks

There is no need to use this function directly. To initialize the PiStorms class in your program:

from PiStorms import PiStorms 
...
psm = PiStorms()

Member Function Documentation

def PiStorms.PiStorms.battVoltage

(

self

)

Returns the input battery voltage.

Parameters

self	The object pointer.

Remarks

To use this function in your program:

from PiStorms import PiStorms 
...
psm = PiStorms()
volts = psm.battVoltage()
if(volts > 6):
    # do some task

def PiStorms.PiStorms.GetDeviceId

(

self

)

Returns the PiStorms device ID.

Parameters

self	The object pointer.

Remarks

To use this function in your program:

from PiStorms import PiStorms 
...
psm = PiStorms()
devID = psm.GetDeviceId()
print str(devID)

def PiStorms.PiStorms.GetFirmwareVersion

(

self

)

Returns the PiStorms firmware version.

Parameters

self	The object pointer.

Remarks

To use this function in your program:

from PiStorms import PiStorms 
...
psm = PiStorms()
fwVersion = psm.GetFirmwareVersion()
print str(devID)

def PiStorms.PiStorms.getKeyPressCount

(

self

)

Returns the GO button press count.

Parameters

self	The object pointer.

Remarks

To use this function in your program:

from PiStorms import PiStorms 
...
psm = PiStorms()
keyCount = psm.getKeyPressCount()
if(keyCount == 5):
    # do some task

def PiStorms.PiStorms.getKeyPressValue

(

self

)

Check if any Function button is pressed.

Parameters

self	The object pointer.

Remarks

To use this function in your program:

from PiStorms import PiStorms 
...
psm = PiStorms()
key = psm.getKeyValue()
if(key == 40):
    # (40 is F4), do some task

def PiStorms.PiStorms.GetVendorName

(

self

)

Returns the PiStorms vendor name.

Parameters

self	The object pointer.

Remarks

To use this function in your program:

from PiStorms import PiStorms 
...
psm = PiStorms()
venName = psm.GetVendorName()
print str(devID)

def PiStorms.PiStorms.isF1Pressed

(

self

)

Check if F1 Function button is pressed.

Parameters

self	The object pointer.

Remarks

To use this function in your program:

from PiStorms import PiStorms 
...
psm = PiStorms()
key = psm.isF1Pressed()
if(key == True):
    # F1 is pressed, do some task

def PiStorms.PiStorms.isF2Pressed

(

self

)

Check if F2 Function button is pressed.

Parameters

self	The object pointer.

Remarks

To use this function in your program:

from PiStorms import PiStorms 
...
psm = PiStorms()
key = psm.isF2Pressed()
if(key == True):
    # F2 is pressed, do some task

def PiStorms.PiStorms.isF3Pressed

(

self

)

Check if F3 Function button is pressed.

Parameters

self	The object pointer.

Remarks

To use this function in your program:

from PiStorms import PiStorms 
...
psm = PiStorms()
key = psm.isF3Pressed()
if(key == True):
    # F3 is pressed, do some task

def PiStorms.PiStorms.isF4Pressed

(

self

)

Check if F4 Function button is pressed.

Parameters

self	The object pointer.

Remarks

To use this function in your program:

from PiStorms import PiStorms 
...
psm = PiStorms()
key = psm.isF4Pressed()
if(key == True):
    # F4 is pressed, do some task

def PiStorms.PiStorms.isKeyPressed

(

self

)

Check if the GO button is pressed.

Parameters

self	The object pointer.

Remarks

To use this function in your program:

from PiStorms import PiStorms 
...
psm = PiStorms()
key = psm.isKeyPressed()
if(key == True):
    # do some task

def PiStorms.PiStorms.led	(		self,
			lednum,
			red,
			green,
			blue
	)

Writes to the specified RGB LED.

Parameters

self	The object pointer.
lednum	The number to specify the LED (1 for BankA, 2 for BankB).
red	The red value to write to the specified LED (0-255).
green	The green value to write to the specified LED (0-255).
blue	The blue value to write to the specified LED (0-255).

Remarks

To use this function in your program:

from PiStorms import PiStorms 
...
psm = PiStorms()
psm.led(1,255,0,0)

def PiStorms.PiStorms.resetKeyPressCount

(

self

)

Resets the GO button press count.

Parameters

self	The object pointer.

Remarks

To use this function in your program:

from PiStorms import PiStorms 
...
psm = PiStorms()
resetKeyPressCount()

def PiStorms.PiStorms.Shutdown

(

self

)

Shutdown the Raspberry Pi.

Parameters

self	The object pointer.

Remarks

To use this function in your program:

from PiStorms import PiStorms 
...
psm = PiStorms()
psm.Shutdown()

Member Data Documentation

PiStorms.PiStorms.BAM1

An instance of PiStormsMotor representing Bank A motor 1.

PiStorms.PiStorms.BAM2

An instance of PiStormsMotor representing Bank A motor 2.

PiStorms.PiStorms.BAS1

An instance of PiStormsSensor representing Bank A sensor 1.

PiStorms.PiStorms.BAS2

An instance of PiStormsSensor representing Bank A sensor 2.

PiStorms.PiStorms.BBM1

An instance of PiStormsMotor representing Bank B motor 1.

PiStorms.PiStorms.BBM2

An instance of PiStormsMotor representing Bank B motor 2.

PiStorms.PiStorms.BBS1

An instance of PiStormsSensor representing Bank B sensor 1.

PiStorms.PiStorms.BBS2

An instance of PiStormsSensor representing Bank B sensor 2.

PiStorms.PiStorms.psc

An instance of PiStormsCom.PiStormsCom.

PiStorms.PiStorms.screen

An instance of mindsensorsUI.mindsensorsUI representing the PiStorms's touchscreen.

---

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

• PiStorms/sys/PiStorms.py