LIN slave node class via ESP8266 HardwareSerial. More...

#include <LIN_slave_HardwareSerial_ESP8266.h>

Inheritance diagram for LIN_Slave_HardwareSerial_ESP8266:

[legend]

Public Member Functions
	LIN_Slave_HardwareSerial_ESP8266 (bool SwapPins=false, uint16_t MinFramePause=1000L, LIN_Slave_Base::version_t Version=LIN_Slave_Base::LIN_V2, const char NameLIN[]="Slave", uint32_t TimeoutRx=1500L, const int8_t PinTxEN=INT8_MIN)
	Class constructor.

void	begin (uint16_t Baudrate=19200)
	Open serial interface.

void	end (void)
	Close serial interface.

Public Member Functions inherited from LIN_Slave_HardwareSerial
	LIN_Slave_HardwareSerial (HardwareSerial &Interface, uint16_t MinFramePause=1000L, LIN_Slave_Base::version_t Version=LIN_Slave_Base::LIN_V2, const char NameLIN[]="Slave", uint32_t TimeoutRx=1500L, const int8_t PinTxEN=INT8_MIN)
	Class constructor.

bool	available (void)
	check if a byte is available in Rx buffer

virtual void	handler (void)
	Handle LIN protocol and call user-defined frame handlers.

Public Member Functions inherited from LIN_Slave_Base
	LIN_Slave_Base (LIN_Slave_Base::version_t Version=LIN_Slave_Base::LIN_V2, const char NameLIN[]="Slave", uint32_t TimeoutRx=1500L, const int8_t PinTxEN=INT8_MIN)
	LIN slave node constructor.

virtual	~LIN_Slave_Base (void)
	LIN slave node destructor, here dummy. Any class with virtual functions should have virtual destructor.

void	resetStateMachine (void)
	Reset LIN state machine.

LIN_Slave_Base::state_t	getState (void)
	Getter for LIN state machine state.

void	resetError (void)
	Clear error of LIN state machine.

LIN_Slave_Base::error_t	getError (void)
	Getter for LIN state machine error.

void	getFrame (LIN_Slave_Base::frame_t &Type, uint8_t &Id, uint8_t &NumData, uint8_t Data[])
	Getter for LIN frame.

void	registerMasterRequestHandler (uint8_t ID, LIN_Slave_Base::LinMessageCallback Fct, uint8_t NumData)
	Attach user callback function for master request frame.

void	registerSlaveResponseHandler (uint8_t ID, LIN_Slave_Base::LinMessageCallback Fct, uint8_t NumData)
	Attach user callback function for slave response frame.

Additional Inherited Members
Public Types inherited from LIN_Slave_Base
enum	version_t : uint8_t { LIN_V1 = 1 , LIN_V2 = 2 }
	LIN protocol version. More...

enum	frame_t : uint8_t { MASTER_REQUEST = 0x10 , SLAVE_RESPONSE = 0x20 }
	LIN frame type. Use high nibble for type, low nibble for number of data bytes -> minimize callback[] size. More...

enum	state_t : uint8_t { STATE_OFF = 0x01 , STATE_WAIT_FOR_BREAK = 0x02 , STATE_WAIT_FOR_SYNC = 0x04 , STATE_WAIT_FOR_PID = 0x08 , STATE_RECEIVING_DATA = 0x10 , STATE_RECEIVING_ECHO = 0x20 , STATE_WAIT_FOR_CHK = 0x40 , STATE_DONE = 0x80 }
	LIN state machine states. Use bitmasks for fast checking multiple states. More...

enum	error_t : uint8_t { NO_ERROR = 0x00 , ERROR_STATE = 0x01 , ERROR_ECHO = 0x02 , ERROR_TIMEOUT = 0x04 , ERROR_CHK = 0x08 , ERROR_SYNC = 0x10 , ERROR_PID = 0x20 , ERROR_MISC = 0x80 }
	LIN error codes. Use bitmasks, as error is latched. Use same as LIN_master_portable. More...

Public Attributes inherited from LIN_Slave_Base
char	nameLIN [LIN_SLAVE_BUFLEN_NAME]
	LIN node name, e.g. for debug.

Protected Types inherited from LIN_Slave_Base
typedef void(*	LinMessageCallback) (uint8_t numData, uint8_t *data)
	Type for frame callback function.

Protected Member Functions inherited from LIN_Slave_HardwareSerial
virtual bool	_getBreakFlag (void)
	Get break detection flag.

void	_resetBreakFlag (void)
	Clear break detection flag.

uint8_t	_serialPeek (void)
	peek next byte from Rx buffer

uint8_t	_serialRead (void)
	read next byte from Rx buffer

void	_serialWrite (uint8_t buf[], uint8_t num)
	write bytes to Tx buffer

Protected Member Functions inherited from LIN_Slave_Base
uint8_t	_calculatePID (uint8_t ID)
	Calculate protected frame ID.

uint8_t	_calculateChecksum (uint8_t NumData, uint8_t Data[])
	Calculate LIN frame checksum.

void	_enableTransmitter (void)
	Enable RS485 transmitter (DE=high)

void	_disableTransmitter (void)
	Disable RS485 transmitter (DE=low)

Protected Attributes inherited from LIN_Slave_HardwareSerial
HardwareSerial *	pSerial
	pointer to serial interface used for LIN

bool	flagBreak
	a break was detected, is set in handle

uint16_t	minFramePause
	min. inter-frame pause [us] to start new frame (not standard compliant!)

Protected Attributes inherited from LIN_Slave_Base
int8_t	pinTxEN
	optional Tx direction pin, e.g. for LIN via RS485

uint16_t	baudrate
	communication baudrate [Baud]

LIN_Slave_Base::version_t	version
	LIN protocol version.

LIN_Slave_Base::state_t	state
	status of LIN state machine

LIN_Slave_Base::error_t	error
	error state. Is latched until cleared

bool	flagBreak
	flag for BREAK detected. Needs to be set in Rx-ISR

LIN_Slave_Base::callback_t	callback [64]
	array of user callback functions for IDs 0x00..0x3F

uint8_t	pid
	protected frame identifier

uint8_t	id
	unprotected frame identifier

LIN_Slave_Base::frame_t	type
	frame type (master request or slave response)

uint8_t	numData
	number of data bytes in frame

uint8_t	bufData [9]
	buffer for data bytes (max. 8B) + checksum

uint8_t	idxData
	current index in bufData

uint32_t	timeoutRx
	timeout [us] for bytes in frame

uint32_t	timeLastRx
	time [us] of last received byte in frame

Detailed Description

LIN slave node class via ESP8266 HardwareSerial.

LIN slave node class via ESP8266 HardwareSerial. Is derived from generic HW-Serial class (only different constructor)

Definition at line 37 of file LIN_slave_HardwareSerial_ESP8266.h.

Constructor & Destructor Documentation

◆ LIN_Slave_HardwareSerial_ESP8266()

LIN_Slave_HardwareSerial_ESP8266::LIN_Slave_HardwareSerial_ESP8266	(	bool	SwapPins = `false`,
		uint16_t	MinFramePause = `1000L`,
		LIN_Slave_Base::version_t	Version = `LIN_Slave_Base::LIN_V2`,
		const char	NameLIN[] = `"Slave"`,
		uint32_t	TimeoutRx = `1500L`,
		const int8_t	PinTxEN = `INT8_MIN`
	)

Class constructor.

Constructor for LIN node class using ESP8266 HardwareSerial 0.

Constructor for LIN node class for using ESP8266 HardwareSerial 0. Inherit all methods from LIN_Slave_HardwareSerial, only different constructor

Parameters

[in]	SwapPins	use alternate Serial2 Rx/Tx pins (default = false)
[in]	MinFramePause	min. inter-frame pause [us] to detect new frame (default = 1000)
[in]	Version	LIN protocol version (default = v2)
[in]	NameLIN	LIN node name (default = "Slave")
[in]	TimeoutRx	timeout [us] for bytes in frame (default = 1500)
[in]	PinTxEN	optional Tx enable pin (high active) e.g. for LIN via RS485 (default = -127/none)