ConfiguredConsumer.hxx File Reference

#include "openlcb/EventHandlerTemplates.hxx"
#include "openlcb/ConfigRepresentation.hxx"
#include "utils/ConfigUpdateListener.hxx"
#include "utils/ConfigUpdateService.hxx"
#include "openlcb/RefreshLoop.hxx"

Go to the source code of this file.

Classes
class	openlcb::ConfiguredConsumer
	OpenLCB Consumer class integrating a simple CDI-based configuration for two event IDs, and an output GPIO object that will be turned on or off depending on the incoming event notifications. More...
class	openlcb::ConfiguredPulseConsumer
	OpenLCB Consumer class integrating a simple CDI-based configuration for a single event IDs, and an output GPIO object that will be turned on for a short period of time when the incoming event notifications arrives. More...

Namespaces
namespace	openlcb

Functions
	openlcb::CDI_GROUP (ConsumerConfig)
	CDI Configuration for a ConfiguredConsumer.
	openlcb::CDI_GROUP_ENTRY (description, StringConfigEntry< 8 >, Name("Description"), Description("User name of this output."))
	Allows the user to assign a name for this output.
	openlcb::CDI_GROUP_ENTRY (event_on, EventConfigEntry, Name("Event On"), Description("Receiving this event ID will turn the output on."))
	Specifies the event ID to set the output to ON.
	openlcb::CDI_GROUP_ENTRY (event_off, EventConfigEntry, Name("Event Off"), Description("Receiving this event ID will turn the output off."))
	Specifies the event ID to set the output to OFF.
	openlcb::CDI_GROUP_END ()
	Signals termination of the group.
	openlcb::CDI_GROUP (PulseConsumerConfig)
	CDI Configuration for a ConfiguredPulseConsumer.
	openlcb::CDI_GROUP_ENTRY (description, StringConfigEntry< 16 >, Name("Description"), Description("User name of this output."))
	Allows the user to assign a name for this output.
	openlcb::CDI_GROUP_ENTRY (event, EventConfigEntry, Name("Event"), Description("Receiving this event ID will generate a pulse on the output."))
	Specifies the event ID to trigger the output pulse.
	openlcb::CDI_GROUP_ENTRY (duration, Uint8ConfigEntry, Default(3), Name("Pulse duration"), Description("Length of the pulse to output (unit of 30 msec)."))
	Allows the user to configure the output pulse length.

Detailed Description

Copyright

Copyright (c) 2015, Balazs Racz All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Consumer class that uses CDI configuration and a GPIO template structure to export a single bit as two event consumers to OpenLCB.

Author

Balazs Racz

Date

13 June 2015

Definition in file ConfiguredConsumer.hxx.