_ICustom< N > Class Template Reference

#include <custom_interface.h>

Public Member Functions
	_ICustom (int8_t dc=-1)
virtual	~_ICustom ()
virtual void	begin ()
virtual void	end ()
virtual void	start ()
virtual void	stop ()
void	send (uint8_t data)
void	sendBuffer (const uint8_t *buffer, uint16_t size)
	Sends bytes to custom interface. More...

Protected Member Functions
virtual void	transferToHw (const uint8_t *buffer, uint16_t size)=0
void	forceTransfer ()
int8_t	getDc ()

Detailed Description

template<int N>
class _ICustom< N >

This is basic class for custom user-defined interfaces This is template, which accepts maximum number of bytes in interface buffer as template argument

Definition at line 38 of file custom_interface.h.

Constructor & Destructor Documentation

_ICustom()

template<int N>

_ICustom< N >::_ICustom ( int8_t  dc = -1 )

inlineexplicit

Creates instance of custom basic interface

Definition at line 44 of file custom_interface.h.

~_ICustom()

template<int N>

virtual _ICustom< N >::~_ICustom ( )

inlinevirtual

Destroys instance of custom basic interface

Definition at line 56 of file custom_interface.h.

Member Function Documentation

begin()

template<int N>

virtual void _ICustom< N >::begin ( )

inlinevirtual

Initializes basic class for custom interface

Definition at line 67 of file custom_interface.h.

end()

template<int N>

virtual void _ICustom< N >::end ( )

inlinevirtual

Deinitializes basic class for custom interface

Definition at line 74 of file custom_interface.h.

forceTransfer()

template<int N>

void _ICustom< N >::forceTransfer ( )

inlineprotected

Call this method to transfer data to hardware. This method is called automatically, when internal interface buffer is overflown.

Definition at line 134 of file custom_interface.h.

getDc()

template<int N>

int8_t _ICustom< N >::getDc ( )

inlineprotected

Returns number of D/C pin if used, or -1

Definition at line 143 of file custom_interface.h.

send()

template<int N>

void _ICustom< N >::send ( uint8_t  data )

inline

Sends byte to custom interface

Parameters

data	- byte to send

Definition at line 96 of file custom_interface.h.

sendBuffer()

template<int N>

void _ICustom< N >::sendBuffer ( const uint8_t *  buffer, uint16_t  size  )

inline

Sends bytes to custom interface.

Sends bytes to custom interface.

Parameters

buffer	- bytes to send
size	- number of bytes to send

Definition at line 114 of file custom_interface.h.

start()

template<int N>

virtual void _ICustom< N >::start ( )

inlinevirtual

Starts communication with the display over custom interface.

Definition at line 81 of file custom_interface.h.

stop()

template<int N>

virtual void _ICustom< N >::stop ( )

inlinevirtual

Ends communication with the display over custom interface..

Definition at line 88 of file custom_interface.h.

transferToHw()

template<int N>

virtual void _ICustom< N >::transferToHw ( const uint8_t *  buffer, uint16_t  size  )

protectedpure virtual

This function must implement actual sending of data to hardware interface

---

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

• src/lcd_hal/custom_interface.h