Index of all elements
[ a ]
[ c ]
[ d ]
[ e ]
[ f ]
[ g ]
[ h ]
[ i ]
[ k ]
[ l ]
[ m ]
[ n ]
[ o ]
[ r ]
[ s ]
[ t ]
[ u ]
[ w ]
[ _ ]
a
- addError
- in file kit108.php, method Kit108::addError()
Public. Add an error message to this object's queue.
top
c
- $canonicalOutput
- in file kit108.php, variable Kit108::$canonicalOutput
Public. Whether to drop the first zero from hex output.
- closeDev
- in file kit108.php, method Kit108::closeDev()
Public. Close the serial port.
top
d
- $decimalOutput
- in file kit108.php, variable Kit108::$decimalOutput
Public. Whether to return output as decimal or hexadecimal.
- $dev
- in file kit108.php, variable Kit108::$dev
Private. The current serial device (e.g. "/dev/ttyS0").
top
e
- $errors
- in file kit108.php, variable Kit108::$errors
Private. An array storing this object's error messages.
top
f
- $forceOutEOL
- in file kit108.php, variable Kit108::$forceOutEOL
Public. Force the End Of Line character(s) used by the class.
top
g
- getDev
- in file kit108.php, method Kit108::getDev()
Public. Returns the current serial port.
- getErrors
- in file kit108.php, method Kit108::getErrors()
Public. Retrieve the current errors.
- getInput
- in file kit108.php, method Kit108::getInput()
Public. Get the status of the specified input.
- getInputs
- in file kit108.php, method Kit108::getInputs()
Public. Get the status of all inputs at once.
- getKitPrompt
- in file kit108.php, method Kit108::getKitPrompt()
Private. The prompt used by the device.
- getRelay
- in file kit108.php, method Kit108::getRelay()
Public. Returns the current state of the specified relay.
- getRelays
- in file kit108.php, method Kit108::getRelays()
Public. Get the status for all relays at once.
- getSoftwareVersion
- in file kit108.php, method Kit108::getSoftwareVersion()
Public. Returns the Kit108 device's firmware version.
top
h
- $healthy
- in file kit108.php, variable Kit108::$healthy
Private. This object's health status.
top
i
- initDev
- in file kit108.php, method Kit108::initDev()
Private. Initializes the current serial port for use with a Kit108 device.
- initSerial
- in file kit108.php, method Kit108::initSerial()
Private. Initialises the serial port.
- isHealthy
- in file kit108.php, method Kit108::isHealthy()
Public. Checks whether this object is healthy.
top
top
l
- $lastOrder
- in file kit108.php, variable Kit108::$lastOrder
Private. The previous known order.
- $lastOrderType
- in file kit108.php, variable Kit108::$lastOrderType
Private. The previous known order's type.
- loadDependencies
- in file kit108.php, method Kit108::loadDependencies()
Private. Loads dependencies required for this class to operate.
top
top
n
- $neverWork
- in file kit108.php, variable Kit108::$neverWork
Private. Whether this class can possibly work in this system's context.
top
o
- $outEOL
- in file kit108.php, variable Kit108::$outEOL
Private. The End Of Line character(s) used by the class.
top
r
- rawRead
- in file kit108.php, method Kit108::rawRead()
Public. This is the lowest-level method for reading from the device within the context of this class.
- rawWrite
- in file kit108.php, method Kit108::rawWrite()
Public. This is the lowest-level method for writing to the device within the context of this class.
- read
- in file kit108.php, method Kit108::read()
Public. Read data from the device.
- relayOff
- in file kit108.php, method Kit108::relayOff()
Public. Deactivate the specified relay.
- relayOn
- in file kit108.php, method Kit108::relayOn()
Public. Activate the specified relay.
top
s
- $serial
- in file kit108.php, variable Kit108::$serial
Private. The actual serial object.
- $serialClassName
- in file kit108.php, variable Kit108::$serialClassName
Public. The name of the serial class.
- $serialIncludeFull
- in file kit108.php, variable Kit108::$serialIncludeFull
Public. The file which contains the serial class.
- $serialIncludePath
- in file kit108.php, variable Kit108::$serialIncludePath
Public. The path to the serial class file.
- sendOrder
- in file kit108.php, method Kit108::sendOrder()
Public. Send an order to the device and retrieve the output.
- setAllRelays
- in file kit108.php, method Kit108::setAllRelays()
Public. Activate all relays.
- setDev
- in file kit108.php, method Kit108::setDev()
Public. Sets the current object's serial device and initializes it.
- setHexRelays
- in file kit108.php, method Kit108::setHexRelays()
Public. Sets all relays to the hexadecimal value passed in $relays.
- setRelay
- in file kit108.php, method Kit108::setRelay()
Public. Alias for relayOn().
- setRelays
- in file kit108.php, method Kit108::setRelays()
Public. Sets all relays to the values passed in $relays.
top
t
- testDev
- in file kit108.php, method Kit108::testDev()
Public. Test the current device.
- toggleRelay
- in file kit108.php, method Kit108::toggleRelay()
Public. Toggle the status of the specified relay.
top
top
w
- write
- in file kit108.php, method Kit108::write()
Public. Write data to the device.
top
_
- $_virgin
- in file kit108.php, variable Kit108::$_virgin
Private. Whether this object has ever been initialised.
- _everWork
- in file kit108.php, method Kit108::_everWork()
Private. Decides whether this class will ever work on this system.
- _setOutEOL
- in file kit108.php, method Kit108::_setOutEOL()
Private. Decides a default EOL for output depending on the context.
top
|
|
