ltrx_line_protocol Struct Reference

Represents a line protocol for registration. More...

#include <ltrx_line.h>

Data Fields
const char *	helpHtml
const char *	protocolName
bool(*	startProtocol )(uint16_t zeroBasedIndex)
void(*	stopProtocol )(uint16_t zeroBasedIndex)

Detailed Description

Represents a line protocol for registration.

This struct designates the procedures to start and stop a Serial Line protocol. It it used with ltrx_line_register_protocol().

Note that your struct must persist, so you will typically declare it static const.

Field Documentation

helpHtml

const char* ltrx_line_protocol::helpHtml

HTML help for Line Protocol selection.

protocolName

const char* ltrx_line_protocol::protocolName

Name of this protocol as it will appear in configuration menu choices.

startProtocol

bool(* ltrx_line_protocol::startProtocol) (uint16_t zeroBasedIndex)

Function that starts this protocol.

stopProtocol

void(* ltrx_line_protocol::stopProtocol) (uint16_t zeroBasedIndex)

Function that stops this protocol.

---

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

• ltrx_line.h