PAL

Collaboration diagram for PAL:

Data Structures
class	GPIOIno
	Arduino GPIO class. More...
class	SPICIno
	Arduino SPIC class. More...
class	TimerIno

Detailed Description

---

Data Structure Documentation

GPIOIno

class GPIOIno

Arduino GPIO class.

Inheritance diagram for GPIOIno:

Collaboration diagram for GPIOIno:

Public Types
Interrupt event
enum	IntEvent_t { INT_FALLING_EDGE = 0 , INT_RISING_EDGE = 1 }
Voltage level
enum	VLevel_t { GPIO_LOW = 0 , GPIO_HIGH = 1 }
Voltage logic
enum	VLogic_t { NEGATIVE = 1 , POSITIVE = 2 }
Public Member Functions
	GPIOIno ()
	Constructor of the Arduino GPIO class. More...
	GPIOIno (uint8_t pin, uint8_t mode, VLogic_t logic)
	Constructor of the Arduino GPIO class. More...
	~GPIOIno ()
Error_t	init ()
	Initialize the GPIO. More...
Error_t	deinit ()
	Deinitialize the GPIO. More...
VLevel_t	read ()
	Read GPIO logic level. More...
Error_t	write (VLevel_t level)
	Set GPIO logic level. More...
Error_t	enable ()
	Enable the GPIO. More...
Error_t	disable ()
	Disable the GPIO. More...
Error_t	checkErrorStatus ()

Member Enumeration Documentation

IntEvent_t

enum tle94112::GPIOC::IntEvent_t

inherited

Enumerator
INT_FALLING_EDGE	Interrupt on falling edge
INT_RISING_EDGE	Interrupt on rising edge

VLevel_t

enum tle94112::GPIOC::VLevel_t

inherited

Enumerator
GPIO_LOW	Level low
GPIO_HIGH	Level high

VLogic_t

enum tle94112::GPIOC::VLogic_t

inherited

Enumerator
NEGATIVE	Negative logic. 0 on voltage level high, 1 on voltage low
POSITIVE	Positive logic. 1 on voltage level high, 0 on voltage low

Constructor & Destructor Documentation

GPIOIno() [1/2]

GPIOIno::GPIOIno

(

)

Constructor of the Arduino GPIO class.

This function is setting the basics for a GPIO.

GPIOIno() [2/2]

GPIOIno::GPIOIno	(	uint8_t	pin,
		uint8_t	mode,
		VLogic_t	logic
	)

Constructor of the Arduino GPIO class.

This function is setting the basics for a GPIO. It allows to set the pin number, mode of the pin and the logic level.

Parameters

[in]	pin	Number of the desired pin
[in]	mode	Defines the mode of the pin (INPUT, OUTPUT, etc.)
[in]	logic	Defines the logic level of the pin

~GPIOIno()

GPIOIno::~GPIOIno

(

)

Member Function Documentation

init()

Error_t GPIOIno::init ( void  )

virtual

Initialize the GPIO.

This function is initializing the chosen pin.

Returns

Error_t

Implements tle94112::GPIOC.

deinit()

Error_t GPIOIno::deinit ( )

virtual

Deinitialize the GPIO.

This function is deinitializing the chosen pin.

Returns

Error_t

Implements tle94112::GPIOC.

read()

GPIOIno::VLevel_t GPIOIno::read ( )

virtual

Read GPIO logic level.

This function reads the logic level of the chosen pin and returns the logic level value.

Returns

GPIOIno::VLevel_t

Return values

0	= GPIO_LOW
1	= GPIO_HIGH

Implements tle94112::GPIOC.

write()

Error_t GPIOIno::write ( VLevel_t  level )

virtual

Set GPIO logic level.

This functions sets the logic level of the chosen pin.

Parameters

[in]

level

Desired logic level of the pin

Returns

Error_t

Implements tle94112::GPIOC.

enable()

Error_t GPIOIno::enable ( )

virtual

Enable the GPIO.

This functions enable the chosen pin. Depending on the chosen logic of the pin it sets the right logic level of the pin.

Returns

Error_t

Implements tle94112::GPIOC.

disable()

Error_t GPIOIno::disable ( )

virtual

Disable the GPIO.

This functions disables the chosen pin. Depending on the chosen logic of the pin it sets the right logic level of the pin.

Returns

Error_t

Implements tle94112::GPIOC.

checkErrorStatus()

Error_t GPIOC::checkErrorStatus ( )

inherited

SPICIno

class SPICIno

Arduino SPIC class.

Inheritance diagram for SPICIno:

Collaboration diagram for SPICIno:

Public Member Functions
	SPICIno ()
	Constructor of the Arduino SPIC class. More...
	SPICIno (uint8_t lsb, uint8_t mode, uint8_t clock)
	Construct a new SPICIno::SPICIno object of the Arduino SPIC class. More...
	SPICIno (SPIClass &port, uint8_t csPin, uint8_t misoPin=MISO, uint8_t mosiPin=MOSI, uint8_t sckPin=SCK)
	Construct a new SPICIno::SPICIno object of the Arduino SPIC class. More...
	~SPICIno ()
Error_t	init ()
	Initialize the SPIC. More...
Error_t	deinit ()
	Deinitialize the SPIC. More...
Error_t	transfer (uint8_t send, uint8_t &received)
	transfers a data package via the spi bus More...
Error_t	transfer16 (uint16_t send, uint16_t &received)
	transfers a data package via the spi bus with 16 bit length More...
Error_t	checkErrorStatus ()

Constructor & Destructor Documentation

SPICIno() [1/3]

SPICIno::SPICIno

(

)

Constructor of the Arduino SPIC class.

This function is setting the basics for a SPIC and the default spi.

SPICIno() [2/3]

SPICIno::SPICIno	(	uint8_t	lsb,
		uint8_t	mode,
		uint8_t	clock
	)

Construct a new SPICIno::SPICIno object of the Arduino SPIC class.

This function sets some basic SPI modes for the default SPI port.

Parameters

lsb	lowside (LSB) or highside (MSB) mode
mode	SPI mode
clock	SPI clock divider

SPICIno() [3/3]

SPICIno::SPICIno	(	SPIClass &	port,
		uint8_t	csPin,
		uint8_t	misoPin = MISO,
		uint8_t	mosiPin = MOSI,
		uint8_t	sckPin = SCK
	)

Construct a new SPICIno::SPICIno object of the Arduino SPIC class.

This function sets all pins for a given SPI port, allowing a free setting of the SPI interface

Parameters

port	SPI port if not default
csPin	chipselect pin for the SPI port
misoPin	miso pin number
mosiPin	mosi pin number
sckPin	systemclock pin number

~SPICIno()

SPICIno::~SPICIno

(

)

Member Function Documentation

init()

Error_t SPICIno::init ( void  )

virtual

Initialize the SPIC.

This function is initializing the chosen spi channel with the given values for lsb,clock and mode

Returns

Error_t

Implements tle94112::SPIC.

deinit()

Error_t SPICIno::deinit ( )

virtual

Deinitialize the SPIC.

This function is deinitializing the chosen spi channel.

Returns

Error_t

Implements tle94112::SPIC.

transfer()

Error_t SPICIno::transfer ( uint8_t  send, uint8_t &  received  )

virtual

transfers a data package via the spi bus

Parameters

send	address and/or command to send
received	received data from spi bus

Returns

Error_t

Implements tle94112::SPIC.

transfer16()

Error_t SPICIno::transfer16 ( uint16_t  send, uint16_t &  received  )

virtual

transfers a data package via the spi bus with 16 bit length

Parameters

send	address and/or command to send
received	received data from spi bus

Returns

SPICWiced::Error_t

Implements tle94112::SPIC.

checkErrorStatus()

Error_t SPIC::checkErrorStatus ( )

inherited

TimerIno

class TimerIno

Inheritance diagram for TimerIno:

Collaboration diagram for TimerIno:

Public Member Functions
	TimerIno ()
	Constructor of the Arduino Timer class. More...
	~TimerIno ()
	Destructor of the Arduino Timer class. More...
Error_t	init ()
	Initialization of the Timer. More...
Error_t	deinit ()
	Deinitialize the Timer. More...
Error_t	start ()
	Start the timer. More...
Error_t	elapsed (uint32_t &elapsed)
	Calculate the elapsed time. More...
Error_t	stop ()
	Stop the timer. More...
Error_t	delayMilli (uint32_t timeout)
	Time delay. More...
Error_t	delayMicro (uint32_t timeout)
	Time delay. More...

Constructor & Destructor Documentation

TimerIno()

TimerIno::TimerIno

(

)

Constructor of the Arduino Timer class.

~TimerIno()

TimerIno::~TimerIno

(

)

Destructor of the Arduino Timer class.

Member Function Documentation

init()

Error_t TimerIno::init ( void  )

virtual

Initialization of the Timer.

This function is initializing the Timer and sets the elapsed time to zero.

Returns

Error_t

Implements tle94112::Timer.

deinit()

Error_t TimerIno::deinit ( )

virtual

Deinitialize the Timer.

This function deinitialize the Timer and also resets the elapsed time variable.

Returns

Error_t

Implements tle94112::Timer.

start()

Error_t TimerIno::start ( )

virtual

Start the timer.

This function is starting the timer.

Returns

Error_t

Implements tle94112::Timer.

elapsed()

Error_t TimerIno::elapsed ( uint32_t &  elapsed )

virtual

Calculate the elapsed time.

This function is calculating the elapsed time since the start of the timer. The value stored in the given variable is in milliseconds.

Parameters

[in]

&elapsed

Address of a value where the elapsed time should be stored

Returns

Error_t

Implements tle94112::Timer.

stop()

Error_t TimerIno::stop ( )

virtual

Stop the timer.

This function stops the timer and resets the start time variable.

Returns

Error_t

Implements tle94112::Timer.

delayMilli()

Error_t TimerIno::delayMilli ( uint32_t  timeout )

virtual

Time delay.

This function is causing a desired delay of the application. The input value is given in milliseconds.

Parameters

[in]

timeout

Desired timeout in ms

Returns

Error_t

Implements tle94112::Timer.

delayMicro()

Error_t TimerIno::delayMicro ( uint32_t  timeout )

virtual

Time delay.

This function is causing a desired delay of the application. The input value is given in microseconds.

Parameters

[in]

timeout

Desired timeout in us

Returns

Error_t

Implements tle94112::Timer.