littleWire Class Reference

littleWire class More...

#include <littleWire.h>

List of all members.

Public Member Functions
	littleWire ()
	~littleWire ()
unsigned char	connect ()
unsigned char	readFirmwareVersion ()
void	pinMode (unsigned char pin, unsigned char mode)
void	digitalWrite (unsigned char pin, unsigned char state)
unsigned char	digitalRead (unsigned char pin)
unsigned int	analogRead (unsigned char channel)
void	pwm_init ()
void	pwm_stop ()
void	pwm_updateCompare (unsigned char channelA, unsigned char channelB)
void	pwm_updatePrescaler (unsigned int value)
void	spi_init ()
unsigned char	spi_sendMessage (unsigned char message)
void	spi_sendMessageMulti (unsigned char *sendBuffer, unsigned char *inputBuffer, unsigned char length, unsigned char mode)
void	spi_updateDelay (unsigned int duration)
void	i2c_init ()
void	i2c_beginTransmission (unsigned char address)
void	i2c_send (unsigned char message)
void	i2c_endTransmission ()
void	i2c_requestFrom (unsigned char address, unsigned char numBytes, unsigned char *responseBuffer)
void	servo_init ()
void	servo_updateLocation (unsigned char locationChannelA, unsigned char locationChannelB)

---

Detailed Description

littleWire class

littleWire Class.

---

Constructor & Destructor Documentation

littleWire::littleWire

(

)

Simple Constructor

Parameters:

(none)

Returns:

(none)

Author:

Ihsan Kehribar <ihsan@kehribar.me>

Omer Kilic <omerkilic@gmail.com>

Version:

0.9

LICENSE

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

littleWire::~littleWire

(

)

Simple Destructor

Parameters:

(none)

Returns:

(none)

---

Member Function Documentation

unsigned char littleWire::connect

(

)

Tries to connect to the device

Parameters:

(none)

Returns:

Nonzero for healty connection

unsigned char littleWire::readFirmwareVersion

(

)

Reads the firmware version of the Little Wire
Format: 0xXY => X: Primary version Y: Minor version

Parameters:

(none)

Returns:

Firmware version

---

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

• library/littleWire.h
• library/littleWire.cpp