Base helper for I²C card producers and consumers. More...

#include <I2cCardHelper.h>

Inheritance diagram for I2cCardHelper:

[legend]

Collaboration diagram for I2cCardHelper:

[legend]

Classes
union	EventUserArgsUnion
	Packed 4-byte metadata carried in EventRegistryEntry::user_arg. More...

Public Member Functions
	I2cCardHelper (openlcb::Node pNode, uint8_t numCards, I2cCardType cardType=I2cCardType::MCP23017, bool isProducer=false, const char cardDescription="I2C Card")
	Constructor for I2cCardHelper. More...

	~I2cCardHelper ()
	Destructor: releases I²C card array, unregisters event handlers, and detaches from ConfigUpdateService. More...

bool	ensureUniqueI2cOffset (uint8_t cardIndex, uint8_t bus, uint8_t offset)

Public Attributes
union I2cCardHelper::EventUserArgsUnion	userArgs

Protected Member Functions
void	_do_unregister ()
	Unregisters this event handler from the global registry.

void	handle_identify_consumer (const openlcb::EventRegistryEntry &registry_entry, openlcb::EventReport event, BarrierNotifiable done) OVERRIDE
	Process request to identify produced events.

void	handle_identify_producer (const openlcb::EventRegistryEntry &registry_entry, openlcb::EventReport event, BarrierNotifiable done) OVERRIDE
	Process request to identify produced events.

virtual void	SendEventIdentified (const openlcb::EventRegistryEntry &registry_entry, openlcb::EventReport event, BarrierNotifiable done)
	Sends Producer- or Consumer-Identified for `registry_entry`. More...

void	applyI2cInfo (int fd, uint8_t cardIndex, i2cInfoConfig_type cfgI2cInfoRef)
	sets up the MCP card's I2C connection using the user provided (CDI) configuration information (bus and address offset) More...

void	resetCardInfo (int fd, cardInfoConfig_type cfgI2cInfoRef)
	resets the card configuration information (description field). More...

void	resetI2cInfo (int fd, i2cInfoConfig_type cfgI2cInfoRef)
	resets the card's I2C configuration information (bus and address fields). More...

virtual void	drive_pin (uint8_t card, uint8_t pin, bool set)

virtual void	drive_pin_ext (uint8_t card, uint8_t pin, bool set, uint8_t intArg)

EventUserArgsUnion	unpack_user_args (const openlcb::EventRegistryEntry &re) const
	Small helper to unpack our 4-byte user_arg payload from the registry entry.

void	handle_event_report (const openlcb::EventRegistryEntry &registry_entry, openlcb::EventReport event, BarrierNotifiable done) OVERRIDE

Private Member Functions
void	_initI2cCards (bool isProducer)
	Initializes the array of I2C card objects using the configured card type. More...

Detailed Description

Base helper for I²C card producers and consumers.

Provides:

event registration and Identify handlers,
CDI helpers for I²C bus/address and card info,
a default consumer handler that decodes user_arg and calls drive_pin_ext().

Does not provide polling; producers that need polling should also derive from I2cPollingHelper.

Definition at line 115 of file I2cCardHelper.h.

Constructor & Destructor Documentation

◆ I2cCardHelper()

I2cCardHelper::I2cCardHelper	(	openlcb::Node *	pNode,
		uint8_t	numCards,
		I2cCardType	cardType = `I2cCardType::MCP23017`,
		bool	isProducer = `false`,
		const char *	cardDescription = `"I2C Card"`
	)

inline

Constructor for I2cCardHelper.

Initializes an I2C card helper for a given OpenLCB node, specifying the number of I2C cards and the card type (default is MCP23017). Registers this object as a configuration update listener.

Parameters

pNode	Pointer to the OpenLCB node object associated with this helper.
numCards	Number of I2C card instances to manage.
isProducer	(Optional) True if the cards are used as producers (default: false).
cardDescription	(Optional) Friendly name for logging (default: "I2C Card").
cardType	(Optional) Type of I2C card (e.g., MCP23017, PCA9685, ESP32). Defaults to I2cCardType::MCP23017.

Note: If cardType is not specified, MCP23017 is used by default.

Definition at line 156 of file I2cCardHelper.h.

Here is the call graph for this function:

◆ ~I2cCardHelper()

I2cCardHelper::~I2cCardHelper ( )

inline

Destructor: releases I²C card array, unregisters event handlers, and detaches from ConfigUpdateService.

Note: If your derived class caches additional handlers, unregister them prior to base dtor.

Definition at line 168 of file I2cCardHelper.h.

Here is the call graph for this function:

Member Function Documentation

◆ _initI2cCards()

void I2cCardHelper::_initI2cCards ( bool isProducer )

inlineprivate

Initializes the array of I2C card objects using the configured card type.

Allocates and initializes each I2C card in the array to the type specified by the cardType_ member. If isProducer is true, registers each card's polling callback.

Parameters

isProducer True if the card is used as a producer and requires polling.

Definition at line 460 of file I2cCardHelper.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ applyI2cInfo()

void I2cCardHelper::applyI2cInfo	(	int	fd,
		uint8_t	cardIndex,
		i2cInfoConfig_type	cfgI2cInfoRef
	)

inlineprotected

sets up the MCP card's I2C connection using the user provided (CDI) configuration information (bus and address offset)

Note

producer/consumers apply_configuration() callback invoke this method to initialize the I2C / MCP connection information for the card

all I2C connected cards have CDI section for user provided bus and address information (which must match the settings of the I2C enabeled card)

HOOK: Typical call site is within your apply_configuration() loop:

read bus & offset from CDI
initialize the corresponding i2cCards[cardIndex]

Parameters

fd	file handle to access the CDI configuration information (provided by openmrn)
cardIndex	specifies which card the configuration is for. Used to update the i2cCards[] array and initialize the connection
cfgI2cInfoRef	offset into the intenal configuration space for the CDI configuration for the MCP card

Definition at line 295 of file I2cCardHelper.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ drive_pin()

virtual void I2cCardHelper::drive_pin	(	uint8_t	card,
		uint8_t	pin,
		bool	set
	)

inlineprotectedvirtual

Hook for consumers: drive one output pin (simple case). Default does nothing; simple consumers override this.

Parameters

card	card index (as stored in user_arg)
pin	pin index (as stored in user_arg)
set	desired logical state from the event semantics (SET/ON = true, CLR/OFF = false)

Reimplemented in IoConfiguredPC, OutputConfiguredConsumer, ServoConfiguredConsumer, TurnoutConfiguredPC, and NeoPixelConfiguredConsumer.

Definition at line 392 of file I2cCardHelper.h.

Here is the caller graph for this function:

◆ drive_pin_ext()

virtual void I2cCardHelper::drive_pin_ext	(	uint8_t	card,
		uint8_t	pin,
		bool	set,
		uint8_t	intArg
	)

inlineprotectedvirtual

Extended hook for consumers that also need the CDI intArg (e.g., audio message index). Default forwards to drive_pin(...) so existing consumers remain unchanged.

Reimplemented in AudioConfiguredConsumer.

Definition at line 402 of file I2cCardHelper.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ensureUniqueI2cOffset()

bool I2cCardHelper::ensureUniqueI2cOffset	(	uint8_t	cardIndex,
		uint8_t	bus,
		uint8_t	offset
	)

inline

Check for duplicate offsets on the same I2C bus. Automatically resets the tracker on the first call per config pass.

Remarks: Call this once per card during your apply_configuration loop, with the CDI values.

Parameters

cardIndex	Index of the card in the config loop.
bus	I2C bus number (0 or 1).
offset	I2C offset (0–7).

Returns: true if this (bus, offset) was already claimed.

Definition at line 183 of file I2cCardHelper.h.

Here is the caller graph for this function:

◆ handle_event_report()

void I2cCardHelper::handle_event_report	(	const openlcb::EventRegistryEntry &	registry_entry,
		openlcb::EventReport *	event,
		BarrierNotifiable *	done
	)

inlineprotected

Default consumer handler: maps an incoming Event Report to (card,pin,set,intArg) and calls drive_pin_ext(...). Producers are ignored.

Definition at line 418 of file I2cCardHelper.h.

Here is the call graph for this function:

◆ resetCardInfo()

void I2cCardHelper::resetCardInfo	(	int	fd,
		cardInfoConfig_type	cfgI2cInfoRef
	)

inlineprotected

resets the card configuration information (description field).

Note: invoke from the consumer/producer factory_reset() to reset the card configuration

Parameters

fd	file handle to access the CDI configuration information (provided by openmrn)
cfgI2cInfoRef	offset into the intenal configuration space for the CDI configuration block for the card's info (description, etc)

Definition at line 309 of file I2cCardHelper.h.

Here is the caller graph for this function:

◆ resetI2cInfo()

void I2cCardHelper::resetI2cInfo	(	int	fd,
		i2cInfoConfig_type	cfgI2cInfoRef
	)

inlineprotected

resets the card's I2C configuration information (bus and address fields).

Note: invoke from the consumer/producer factory_reset() to reset the card configuration

Parameters

fd	file handle to access the CDI configuration information (provided by openmrn)
cfgI2cInfoRef	offset into the intenal configuration space for the CDI configuration for card's I2C info (bus/offset)

Definition at line 321 of file I2cCardHelper.h.

Here is the caller graph for this function:

◆ SendEventIdentified()

virtual void I2cCardHelper::SendEventIdentified	(	const openlcb::EventRegistryEntry &	registry_entry,
		openlcb::EventReport *	event,
		BarrierNotifiable *	done
	)

inlineprotectedvirtual

Sends Producer- or Consumer-Identified for registry_entry.

Identification type is inferred from the registry entry’s packed user args (see

See also: isProducer). Override to customize the MTI or payload.

Reimplemented in TurnoutConfiguredPC.

Definition at line 273 of file I2cCardHelper.h.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ userArgs

union I2cCardHelper::EventUserArgsUnion I2cCardHelper::userArgs

event arguments

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

Node_Card/I2cCardHelper.h

Classes

Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ I2cCardHelper()

◆ ~I2cCardHelper()

Member Function Documentation

◆ _initI2cCards()

◆ applyI2cInfo()

◆ drive_pin()

◆ drive_pin_ext()

◆ ensureUniqueI2cOffset()

◆ handle_event_report()

◆ resetCardInfo()

◆ resetI2cInfo()

◆ SendEventIdentified()

Member Data Documentation

◆ userArgs