LINXx firmware
Extensions to LINX toolkit
Public Member Functions | Public Attributes | List of all members
LinxSerialListener Class Reference
Inheritance diagram for LinxSerialListener:
LinxListener

Public Member Functions

virtual int Start (LinxDevice *linxDev, unsigned char uartChan)
 
virtual int Connected ()
 
virtual int Close ()
 
virtual int Exit ()
 
virtual int CheckForCommands ()
 Runs listener state machine; to be called in sketch loop() More...
 
- Public Member Functions inherited from LinxListener
virtual int Start ()
 
virtual int Listen ()
 
virtual int Available ()
 
virtual int Accept ()
 
virtual int Connected ()
 
virtual int Close ()
 
virtual int Exit ()
 
void AttachCustomCommand (unsigned short commandNumber, int(*function)(unsigned char, unsigned char *, unsigned char *, unsigned char *))
 
void AttachPeriodicTask (int(*function)(unsigned char *, unsigned char *))
 
virtual int CheckForCommands ()
 Runs listener state machine; to be called in sketch loop() More...
 
int ProcessCommand (unsigned char *recBuffer, unsigned char *sendBuffer)
 Handles command packets. More...
 
void PacketizeAndSend (unsigned char *commandPacketBuffer, unsigned char *responsePacketBuffer, unsigned int dataSize, int status)
 Sends response packet. More...
 
void StatusResponse (unsigned char *commandPacketBuffer, unsigned char *responsePacketBuffer, int status)
 Sends status only as response (no data) More...
 
void DataBufferResponse (unsigned char *commandPacketBuffer, unsigned char *responsePacketBuffer, const unsigned char *dataBuffer, unsigned char dataSize, int status)
 Format byte array and send as LINX packet. Does not include data length byte. More...
 
unsigned char ComputeChecksum (unsigned char *packetBuffer)
 
bool ChecksumPassed (unsigned char *packetBuffer)
 

Public Attributes

LinxListenerState State
 
- Public Attributes inherited from LinxListener
LinxDeviceLinxDev
 
LinxListenerState State
 
LinxListenerInterface Interface
 
unsigned char ListenerChan
 
unsigned char * recBuffer
 
unsigned char * sendBuffer
 
unsigned int PrevPacket =0
 
int(* customCommands [16])(unsigned char, unsigned char *, unsigned char *, unsigned char *)
 
int(* periodicTasks [1])(unsigned char *, unsigned char *)
 

Member Function Documentation

◆ CheckForCommands()

int LinxSerialListener::CheckForCommands ( )
virtual

Runs listener state machine; to be called in sketch loop()

Returns
int

Reimplemented from LinxListener.

◆ Close()

int LinxSerialListener::Close ( )
virtual

Reimplemented from LinxListener.

◆ Connected()

int LinxSerialListener::Connected ( )
virtual

Reimplemented from LinxListener.

◆ Exit()

int LinxSerialListener::Exit ( )
virtual

Reimplemented from LinxListener.


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