Firmata Class Reference

#include <firmata.h>

Collaboration diagram for Firmata:

Public Member Functions
	Firmata ()
	Firmata (const char *_serialPort)
	Firmata (const char *_serialPort, uint32_t baud)
	~Firmata ()
int	writeDigitalPin (unsigned char pin, unsigned char mode)
int	setPinMode (unsigned char pin, unsigned char mode)
int	setPwmPin (unsigned char pin, int16_t value)
int	mapAnalogChannels ()
int	askFirmwareVersion ()
int	askCapabilities ()
int	askPinState (int pin)
int	reportDigitalPorts (int enable)
int	reportAnalogPorts (int enable)
int	setSamplingInterval (int16_t value)
int	systemReset ()
int	closePort ()
int	flushPort ()
int	sendStringData (char *data)
void	print_state ()
int	OnIdle ()

Public Attributes
pin_t	pin_info [128]
char	firmata_name [140]
char	string_buffer [MAX_STRING_DATA_LEN]
bool	portOpen

Protected Member Functions
int	init (const char *_serialPort, uint32_t baud)
	bitpacked digital pin state More...
int	sendValueAsTwo7bitBytes (int value)

Protected Attributes
Arduino *	arduino
int	waitForData
int	executeMultiByteCommand
int	multiByteChannel
unsigned char	serialInBuf [FIRMATA_MAX_DATA_BYTES]
unsigned char	serialOutBuf [FIRMATA_MAX_DATA_BYTES]
vector< unsigned char >	sysExBuf
char	firmwareVersion [FIRMATA_FIRMWARE_VERSION_SIZE]
int	digitalPortValue [ARDUINO_DIG_PORTS]

Private Member Functions
void	Parse (const uint8_t *buf, int len)
void	DoMessage (void)

Private Attributes
int	parse_count
int	parse_command_len
uint8_t	parse_buf [4096]

Constructor & Destructor Documentation

Firmata() [1/3]

Firmata::Firmata

(

)

Firmata() [2/3]

Firmata::Firmata

(

const char *

_serialPort

)

Firmata() [3/3]

Firmata::Firmata	(	const char *	_serialPort,
		uint32_t	baud
	)

~Firmata()

Firmata::~Firmata

(

)

Member Function Documentation

askCapabilities()

int Firmata::askCapabilities

(

)

askFirmwareVersion()

int Firmata::askFirmwareVersion

(

)

askPinState()

int Firmata::askPinState

(

int

pin

)

closePort()

int Firmata::closePort

(

)

DoMessage()

void Firmata::DoMessage ( void  )

private

flushPort()

int Firmata::flushPort

(

)

init()

int Firmata::init ( const char *  _serialPort, uint32_t  baud  )

protected

bitpacked digital pin state

mapAnalogChannels()

int Firmata::mapAnalogChannels

(

)

OnIdle()

int Firmata::OnIdle

(

)

Parse()

void Firmata::Parse ( const uint8_t *  buf, int  len  )

private

print_state()

void Firmata::print_state

(

)

reportAnalogPorts()

int Firmata::reportAnalogPorts

(

int

enable

)

reportDigitalPorts()

int Firmata::reportDigitalPorts

(

int

enable

)

sendStringData()

int Firmata::sendStringData

(

char *

data

)

sendValueAsTwo7bitBytes()

int Firmata::sendValueAsTwo7bitBytes ( int  value )

protected

setPinMode()

int Firmata::setPinMode	(	unsigned char	pin,
		unsigned char	mode
	)

setPwmPin()

int Firmata::setPwmPin	(	unsigned char	pin,
		int16_t	value
	)

setSamplingInterval()

int Firmata::setSamplingInterval

(

int16_t

value

)

systemReset()

int Firmata::systemReset

(

)

writeDigitalPin()

int Firmata::writeDigitalPin	(	unsigned char	pin,
		unsigned char	mode
	)

Member Data Documentation

arduino

Arduino* Firmata::arduino

protected

digitalPortValue

int Firmata::digitalPortValue[ARDUINO_DIG_PORTS]

protected

executeMultiByteCommand

int Firmata::executeMultiByteCommand

protected

firmata_name

char Firmata::firmata_name[140]

firmwareVersion

char Firmata::firmwareVersion[FIRMATA_FIRMWARE_VERSION_SIZE]

protected

multiByteChannel

int Firmata::multiByteChannel

protected

parse_buf

uint8_t Firmata::parse_buf[4096]

private

parse_command_len

int Firmata::parse_command_len

private

parse_count

int Firmata::parse_count

private

pin_info

pin_t Firmata::pin_info[128]

portOpen

bool Firmata::portOpen

serialInBuf

unsigned char Firmata::serialInBuf[FIRMATA_MAX_DATA_BYTES]

protected

serialOutBuf

unsigned char Firmata::serialOutBuf[FIRMATA_MAX_DATA_BYTES]

protected

string_buffer

char Firmata::string_buffer[MAX_STRING_DATA_LEN]

sysExBuf

vector<unsigned char> Firmata::sysExBuf

protected

waitForData

int Firmata::waitForData

protected

---

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

• ln/3rdparty/src/indilib/indi-1.7.4/3rdparty/indi-duino/libfirmata/src/firmata.h
• ln/3rdparty/src/indilib/indi-1.7.4/3rdparty/indi-duino/libfirmata/src/firmata.cpp