Specification.Specification Class Reference

Robot specification. More...

Inheritance diagram for Specification.Specification:

Public Member Functions
def	__init__ (self, index=None)
def	init (self)
def	save (self)
def	delete (self)
def	change (self, newident)
def	getInstallPath (self)
def	isInstalled (self, ident=None)
def	getPackagePath (self)
def	isPackaged (self)
def	getPackageTimestamp (self)
def	refreshServos (self)
def	refreshMotors (self)
def	stopMotors (self)
def	getMotionId (self, name)
def	getActiveKeyMap (self)
def	getKeyMapping (self, hex)
def	generatePackage (self)
Public Member Functions inherited from JsonBlob.JsonBlob
def	__init__ (self, index=None, autoload=True)
def	reload (self)
def	save (self)
def	delete (self)
def	blobExists (self)
def	getModulePath (self)
def	getTypePath (self)
def	getRowPath (self)
def	getRowFileName (self)

Static Public Member Functions
def	GetInstance (index=None)
def	currentIdent (new=False)
def	newIdent ()
def	listPackages ()
def	getPackageInfo (filename)
def	clone (ident, codename=None)
def	deployPackage (tarfilename)
Static Public Member Functions inherited from JsonBlob.JsonBlob
def	reindex (force=False)
def	find (jbModule, jbType, jbIndex)
def	all (jbModule=None, jbType=None)
def	hydrate (jbModule=None, jbType=None, ids=[])

Public Attributes
	jsonData
	servos
	motions
	chains
	motors
	steppers
	keyboard
	imu
	jbIndex
	activemap
Public Attributes inherited from JsonBlob.JsonBlob
	jbModule
	jbType
	jbIndex
	jsonData

Static Public Attributes
	cwd = AmsEnvironment.AppPath()
	basepath = os.path.join(cwd, 'specifications')
	installpath = os.path.join(basepath, 'installed')
	packagepath = os.path.join(basepath, 'packages')
	filebase = AmsEnvironment.FilePath()
Static Public Attributes inherited from JsonBlob.JsonBlob
	basepath = os.path.join(AmsEnvironment.FilePath(), 'jsonblob')
	indexpath = os.path.join(basepath, 'index.json')
dictionary	constructors = {}
bool	indexexists = False
bool	indexed = False
dictionary	index = {}

Detailed Description

Robot specification.

Constructor & Destructor Documentation

__init__()

def Specification.Specification.__init__	(		self,
			index = None
	)

Initializes the Specification object

@param index

Member Function Documentation

change()

def Specification.Specification.change	(		self,
			newident
	)

activates a specification

@param newident

clone()

def Specification.Specification.clone (   ident,   codename = None  )

static

clone a specification

@param ident
@param codename

currentIdent()

def Specification.Specification.currentIdent (   new = False )

static

gets the current specification id
if a valid id is not found, a new one is created

@param new bool

delete()

def Specification.Specification.delete

(

self

)

delete specification

deployPackage()

def Specification.Specification.deployPackage (   tarfilename )

static

unpack a specification package

@param tarfilename

generatePackage()

def Specification.Specification.generatePackage

(

self

)

generate a package from a specification

getActiveKeyMap()

def Specification.Specification.getActiveKeyMap

(

self

)

gets the active keymap

getInstallPath()

def Specification.Specification.getInstallPath

(

self

)

gets the path for installed specifications

getKeyMapping()

def Specification.Specification.getKeyMapping	(		self,
			hex
	)

gets key mappings for given hex

@param hex

getMotionId()

def Specification.Specification.getMotionId	(		self,
			name
	)

gets a motion id from name

@param name

getPackageInfo()

def Specification.Specification.getPackageInfo (   filename )

static

collects the spec data inside a package

@param filename

getPackagePath()

def Specification.Specification.getPackagePath

(

self

)

gets the path for spec packages

getPackageTimestamp()

def Specification.Specification.getPackageTimestamp

(

self

)

gets the modified time for a package file

init()

def Specification.Specification.init

(

self

)

setup object attributes

isInstalled()

def Specification.Specification.isInstalled	(		self,
			ident = None
	)

determine whether a spec exists

@param ident

isPackaged()

def Specification.Specification.isPackaged

(

self

)

checks for spec package

listPackages()

def Specification.Specification.listPackages ( )

static

gets a list of specification packages

newIdent()

def Specification.Specification.newIdent ( )

static

generates a new id

refreshServos()

def Specification.Specification.refreshServos

(

self

)

refresh servos

save()

def Specification.Specification.save

(

self

)

override of JsonBlob.save
serializes servos, motions amd motors before saving

---

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

• Specification.py