ltrx_cpm_role Struct Reference

Represents a Configurable Pin role for registration. More...

Data Fields
const char *	helpHtml
const char *	name
uint8_t	optOneBasedCp
enum ltrx_cpm_required_assert	optRequiredAssert
enum ltrx_cpm_required_mode	optRequiredMode
void(*	optToggleCall )(const char *roleName)
enum ltrx_cpm_role_usage	usage

Detailed Description

Represents a Configurable Pin role for registration.

This struct designates the procedure and options to define a role. It it used with ltrx_cp_register_role().

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

Field Documentation

const char* ltrx_cpm_role::helpHtml

HTML help for this role.

const char* ltrx_cpm_role::name

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

uint8_t ltrx_cpm_role::optOneBasedCp

If zero, it means that the user may select any Configurable Pin for this role. Otherwise it represents a Configurable Pin number that is a required assignment for this role.

enum ltrx_cpm_required_assert ltrx_cpm_role::optRequiredAssert

If present, can constrain assert setting High or Low.

enum ltrx_cpm_required_mode ltrx_cpm_role::optRequiredMode

If present, can constrain mode setting Push-Pull or Weak Pullup.

void(* ltrx_cpm_role::optToggleCall)(const char *roleName)

If present, this function will be called when an input is toggled. Otherwise, set to NULL.

enum ltrx_cpm_role_usage ltrx_cpm_role::usage

Usage of the Configurable Pin in this role.

---

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

• ltrx_cpm.h