Open Ephys GUI
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | Protected Attributes
ofArduino Class Reference

This class extend ofStandardFirmata and provides additional functionality like servo support through SysEx messages. More...

#include <ofArduino.h>

List of all members.

Public Member Functions

 ofArduino ()
virtual ~ofArduino ()
bool connect (string device, int baud=57600)
void disconnect ()
bool isArduinoReady ()
void setUseDelay (bool bDelay)
void update ()
bool isInitialized ()
void setDigitalHistoryLength (int length)
void setAnalogHistoryLength (int length)
void setStringHistoryLength (int length)
void setSysExHistoryLength (int nSysEx)
void sendDigitalPinMode (int pin, int mode)
void sendAnalogPinReporting (int pin, int mode)
void sendDigital (int pin, int value, bool force=false)
void sendPwm (int pin, int value, bool force=false)
void sendSysEx (int command, vector< unsigned char > data)
void sendString (string str)
void sendProtocolVersionRequest ()
void sendFirmwareVersionRequest ()
void sendReset ()
void sendSysExBegin ()
void sendSysExEnd ()
void sendByte (unsigned char byte)
void sendValueAsTwo7bitBytes (int value)
int getPwm (int pin)
int getDigital (int pin)
int getAnalog (int pin)
vector< unsigned char > getSysEx ()
string getString ()
int getMajorProtocolVersion ()
int getMinorProtocolVersion ()
int getMajorFirmwareVersion ()
int getMinorFirmwareVersion ()
string getFirmwareName ()
list< int > * getDigitalHistory (int pin)
list< int > * getAnalogHistory (int pin)
list< vector< unsigned char > > * getSysExHistory ()
list< string > * getStringHistory ()
int getDigitalPinMode (int pin)
int getAnalogPinReporting (int pin)
int getValueFromTwo7bitBytes (unsigned char lsb, unsigned char msb)
void sendServo (int pin, int value, bool force=false)
void sendServoAttach (int pin, int minPulse=544, int maxPulse=2400, int angle=180)
void sendServoDetach (int pin)
int getServo (int pin)

Protected Member Functions

void initPins ()
void sendDigitalPinReporting (int pin, int mode)
void sendDigitalPortReporting (int port, int mode)
void processData (unsigned char inputData)
void processDigitalPort (int port, unsigned char value)
virtual void processSysExData (vector< unsigned char > data)
unsigned long ofGetSystemTimeMicros ()
float ofGetElapsedTimef ()
unsigned long ofGetElapsedTimeMicros ()

Protected Attributes

bool _initialized
int _totalDigitalPins
ofSerial _port
int _portStatus
int _analogHistoryLength
int _digitalHistoryLength
int _stringHistoryLength
int _sysExHistoryLength
int _waitForData
int _executeMultiByteCommand
int _multiByteChannel
unsigned char _storedInputData [FIRMATA_MAX_DATA_BYTES]
vector< unsigned char > _sysExData
int _majorProtocolVersion
int _minorProtocolVersion
int _majorFirmwareVersion
int _minorFirmwareVersion
string _firmwareName
int _firmwareVersionSum
list< vector< unsigned char > > _sysExHistory
list< string > _stringHistory
list< int > _analogHistory [ARD_TOTAL_ANALOG_PINS]
list< int > _digitalHistory [ARD_TOTAL_DIGITAL_PINS]
int _digitalPinMode [ARD_TOTAL_DIGITAL_PINS]
int _digitalPinValue [ARD_TOTAL_DIGITAL_PINS]
int _digitalPortValue [ARD_TOTAL_PORTS]
int _digitalPortReporting [ARD_TOTAL_PORTS]
int _digitalPinReporting [ARD_TOTAL_DIGITAL_PINS]
int _analogPinReporting [ARD_TOTAL_ANALOG_PINS]
bool bUseDelay
bool connected
float connectTime
int _servoValue [ARD_TOTAL_DIGITAL_PINS]
unsigned long startTimeMicros

Detailed Description

This class extend ofStandardFirmata and provides additional functionality like servo support through SysEx messages.

use the OFstdFirmata for servo support...


Constructor & Destructor Documentation

ofArduino::ofArduino ( )
virtual ofArduino::~ofArduino ( )
virtual

Member Function Documentation

bool ofArduino::connect ( string  device,
int  baud = 57600 
)
void ofArduino::disconnect ( )
bool ofArduino::isArduinoReady ( )
void ofArduino::setUseDelay ( bool  bDelay)
void ofArduino::update ( )
bool ofArduino::isInitialized ( )
void ofArduino::setDigitalHistoryLength ( int  length)
void ofArduino::setAnalogHistoryLength ( int  length)
void ofArduino::setStringHistoryLength ( int  length)
void ofArduino::setSysExHistoryLength ( int  nSysEx)
void ofArduino::sendDigitalPinMode ( int  pin,
int  mode 
)
void ofArduino::sendAnalogPinReporting ( int  pin,
int  mode 
)
void ofArduino::sendDigital ( int  pin,
int  value,
bool  force = false 
)
void ofArduino::sendPwm ( int  pin,
int  value,
bool  force = false 
)
void ofArduino::sendSysEx ( int  command,
vector< unsigned char >  data 
)
void ofArduino::sendString ( string  str)
void ofArduino::sendProtocolVersionRequest ( )
void ofArduino::sendFirmwareVersionRequest ( )
void ofArduino::sendReset ( )
void ofArduino::sendSysExBegin ( )
void ofArduino::sendSysExEnd ( )
void ofArduino::sendByte ( unsigned char  byte)
void ofArduino::sendValueAsTwo7bitBytes ( int  value)
int ofArduino::getPwm ( int  pin)
int ofArduino::getDigital ( int  pin)
int ofArduino::getAnalog ( int  pin)
vector<unsigned char> ofArduino::getSysEx ( )
string ofArduino::getString ( )
int ofArduino::getMajorProtocolVersion ( )
int ofArduino::getMinorProtocolVersion ( )
int ofArduino::getMajorFirmwareVersion ( )
int ofArduino::getMinorFirmwareVersion ( )
string ofArduino::getFirmwareName ( )
list<int>* ofArduino::getDigitalHistory ( int  pin)
list<int>* ofArduino::getAnalogHistory ( int  pin)
list<vector<unsigned char> >* ofArduino::getSysExHistory ( )
list<string>* ofArduino::getStringHistory ( )
int ofArduino::getDigitalPinMode ( int  pin)
int ofArduino::getAnalogPinReporting ( int  pin)
int ofArduino::getValueFromTwo7bitBytes ( unsigned char  lsb,
unsigned char  msb 
)
void ofArduino::sendServo ( int  pin,
int  value,
bool  force = false 
)
void ofArduino::sendServoAttach ( int  pin,
int  minPulse = 544,
int  maxPulse = 2400,
int  angle = 180 
)
void ofArduino::sendServoDetach ( int  pin)
int ofArduino::getServo ( int  pin)
void ofArduino::initPins ( )
protected
void ofArduino::sendDigitalPinReporting ( int  pin,
int  mode 
)
protected
void ofArduino::sendDigitalPortReporting ( int  port,
int  mode 
)
protected
void ofArduino::processData ( unsigned char  inputData)
protected
void ofArduino::processDigitalPort ( int  port,
unsigned char  value 
)
protected
virtual void ofArduino::processSysExData ( vector< unsigned char >  data)
protectedvirtual
unsigned long ofArduino::ofGetSystemTimeMicros ( )
protected
float ofArduino::ofGetElapsedTimef ( )
protected
unsigned long ofArduino::ofGetElapsedTimeMicros ( )
protected

Member Data Documentation

bool ofArduino::_initialized
protected
int ofArduino::_totalDigitalPins
protected
ofSerial ofArduino::_port
protected
int ofArduino::_portStatus
protected
int ofArduino::_analogHistoryLength
protected
int ofArduino::_digitalHistoryLength
protected
int ofArduino::_stringHistoryLength
protected
int ofArduino::_sysExHistoryLength
protected
int ofArduino::_waitForData
protected
int ofArduino::_executeMultiByteCommand
protected
int ofArduino::_multiByteChannel
protected
unsigned char ofArduino::_storedInputData[FIRMATA_MAX_DATA_BYTES]
protected
vector<unsigned char> ofArduino::_sysExData
protected
int ofArduino::_majorProtocolVersion
protected
int ofArduino::_minorProtocolVersion
protected
int ofArduino::_majorFirmwareVersion
protected
int ofArduino::_minorFirmwareVersion
protected
string ofArduino::_firmwareName
protected
int ofArduino::_firmwareVersionSum
protected
list<vector<unsigned char> > ofArduino::_sysExHistory
protected
list<string> ofArduino::_stringHistory
protected
list<int> ofArduino::_analogHistory[ARD_TOTAL_ANALOG_PINS]
protected
list<int> ofArduino::_digitalHistory[ARD_TOTAL_DIGITAL_PINS]
protected
int ofArduino::_digitalPinMode[ARD_TOTAL_DIGITAL_PINS]
protected
int ofArduino::_digitalPinValue[ARD_TOTAL_DIGITAL_PINS]
protected
int ofArduino::_digitalPortValue[ARD_TOTAL_PORTS]
protected
int ofArduino::_digitalPortReporting[ARD_TOTAL_PORTS]
protected
int ofArduino::_digitalPinReporting[ARD_TOTAL_DIGITAL_PINS]
protected
int ofArduino::_analogPinReporting[ARD_TOTAL_ANALOG_PINS]
protected
bool ofArduino::bUseDelay
protected
bool ofArduino::connected
protected
float ofArduino::connectTime
protected
int ofArduino::_servoValue[ARD_TOTAL_DIGITAL_PINS]
protected
unsigned long ofArduino::startTimeMicros
protected

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