Home
Trees
Indices
Help
libprs500
[
hide private
]
[
frames
] |
no frames
]
[
Module Hierarchy
|
Class Hierarchy
]
Class Hierarchy
libprs500.communicate.DeviceDescriptor
:
Describes a USB device.
libprs500.terminfo.ProgressBar
:
A 3-line progress bar, which looks like:
libprs500.terminfo.TerminalController
:
A class that can be used to portably generate formatted output to a terminal.
object
:
The most base type
usb.Bus
:
Bus object
usb.Device
:
Device descriptor object
libprs500.communicate.PRS500Device
:
Contains the logic for performing various tasks on the reader.
libprs500.prstypes.field
:
A
Descriptor
, that implements access to protocol packets in a human readable way.
usb.DeviceHandle
:
DeviceHandle object
usb.Endpoint
:
Endpoint descriptor object
libprs500.communicate.File
:
Wrapper that allows easy access to all information about files/directories
libprs500.prstypes.stringfield
:
A field storing a variable length string.
libprs500.prstypes.PathResponseCodes
:
Known response commands to path related commands
exceptions.BaseException
:
Common base class for all exceptions
exceptions.Exception
:
Common base class for all non-exit exceptions.
libprs500.errors.ProtocolError
:
The base class for all exceptions in this package
libprs500.errors.ControlError
:
Errors in Command/Response pairs while communicating with the device
libprs500.errors.ArgumentError
:
Errors caused by invalid arguments to a public interface function
libprs500.errors.PathError
:
When a user supplies an incorrect/invalid path
libprs500.errors.PacketError
:
Errors with creating/interpreting packets
exceptions.StandardError
:
Base class for all standard Python exceptions that do not represent interpreter exiting.
exceptions.EnvironmentError
:
Base class for I/O related errors.
exceptions.IOError
:
I/O operation failed.
usb.USBError
list
:
list() -> new list list(sequence) -> new list initialized from sequence's items
libprs500.prstypes.TransferBuffer
:
Represents raw (unstructured) data packets sent over the usb bus.
libprs500.prstypes.Answer
:
Defines the structure of packets sent to host via a bulk transfer (i.e., bulk reads)
libprs500.prstypes.FileProperties
:
Defines the structure of packets that contain size, date and permissions information about files/directories.
libprs500.prstypes.DeviceInfo
:
Defines the structure of the packet containing information about the device
libprs500.prstypes.ListAnswer
:
Defines the structure of packets that contain items in a list.
libprs500.prstypes.USBProtocolVersion
libprs500.prstypes.IdAnswer
:
Defines the structure of packets that contain identifiers for queries.
libprs500.prstypes.FreeSpaceAnswer
libprs500.prstypes.Command
:
Defines the structure of command packets sent to the device.
libprs500.prstypes.Response
:
Defines the structure of response packets received from the device.
libprs500.prstypes.ListResponse
:
Defines the structure of response packets received during list (ll) queries.
libprs500.prstypes.DeviceInfoQuery
:
The command used to ask for device information
libprs500.prstypes.LongCommand
:
A
Command
whoose data section is 16 bytes long
libprs500.prstypes.AcknowledgeBulkRead
:
Must be sent to device after a bulk read
libprs500.prstypes.PathCommand
:
Abstract class that defines structure common to all path related commands.
libprs500.prstypes.FileOpen
:
File open command
libprs500.prstypes.SetFileInfo
:
Set File information
libprs500.prstypes.FileCreate
:
Create a file
libprs500.prstypes.FileDelete
:
Delete a file
libprs500.prstypes.DirOpen
:
Open a directory for reading its contents
libprs500.prstypes.PathQuery
:
Defines structure of command that requests information about a path
libprs500.prstypes.DirDelete
:
Delete a directory
libprs500.prstypes.FreeSpaceQuery
:
Query the free space available
libprs500.prstypes.DirCreate
:
Create a directory
libprs500.prstypes.FileIO
:
Command to read/write from an open file
libprs500.prstypes.ShortCommand
:
A
Command
whoose data section is 4 bytes long
libprs500.prstypes.DirRead
:
The command that asks the device to send the next item in the list
libprs500.prstypes.GetUSBProtocolVersion
:
Get USB Protocol version used by device
libprs500.prstypes.SetBulkSize
libprs500.prstypes.FileClose
:
File close command
libprs500.prstypes.UnlockDevice
libprs500.prstypes.DirClose
:
Close a previously opened directory
libprs500.prstypes.USBConnect
:
Ask device to change status to 'USB connected' i.e., tell the device that the present sequence of commands is complete
usb.Configuration
:
Configuration descriptor object
usb.Interface
:
Interface descriptor object
prs500.FileFormatter
Home
Trees
Indices
Help
libprs500
Generated by Epydoc 3.0alpha3 on Wed Nov 8 17:34:08 2006
http://epydoc.sourceforge.net