_ICustom< N > Class Template Reference

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

#include <custom_interface.h>

Public Member Functions
	_ICustom (int8_t dc=-1)
	Creates instance of custom basic interface.
virtual	~_ICustom ()
	Destroys instance of custom basic interface.
virtual void	begin ()
	Initializes basic class for custom interface.
virtual void	end ()
	Deinitializes basic class for custom interface.
virtual void	start ()
	Starts communication with the display over custom interface.
virtual void	stop ()
	Ends communication with the display over custom interface. More...
void	send (uint8_t data)
	Sends byte to custom interface. More...
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
	This function must implement actual sending of data to hardware interface.
void	forceTransfer ()
	Call this method to transfer data to hardware. More...
int8_t	getDc ()
	Returns number of D/C pin if used, or -1.

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.

Member Function Documentation

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.

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.

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.

---

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

• src/lcd_hal/custom_interface.h