#include <DCCpp.hpp>

Collaboration diagram for DCCpp:

Static Public Member Functions
static void	begin ()

static void	beginMain (uint8_t inOptionalDirectionMotor, uint8_t inSignalPin, uint8_t inSignalEnablePin, uint8_t inCurrentMonitor)

static void	beginProg (uint8_t inOptionalDirectionMotor, uint8_t inSignalPin, uint8_t inSignalEnablePin, uint8_t inCurrentMonitor)

static void	beginMainDccSignal (uint8_t inSignalPin)

static void	beginProgDccSignal (uint8_t inSignalPin)

static void	setDebugDccMode ()

static bool	IsMainTrack (volatile RegisterList *apRegs)

static bool	IsMainTrackDeclared ()

static bool	IsProgTrackDeclared ()

static void	loop ()

static void	panicStop (bool inStop)

static void	powerOn (bool inMain=true, bool inProg=true)

static void	powerOff (bool inMain=true, bool inProg=true)

static byte	setAckThreshold (byte inNewValue)

static void	setCurrentSampleMaxMain (float inMax)

static void	setCurrentSampleMaxProg (float inMax)

static float	getCurrentMain ()

static float	getCurrentProg ()

static bool	setSpeedMain (int nReg, int inLocoId, int inStepsNumber, int inNewSpeed, bool inForward)

static int	identifyLocoIdMain ()

static int	readCvMain (int inCvId, int callBack=100, int callBackSub=200)

static void	writeCvMain (int inCvId, byte inValue, int callBack=100, int callBackSub=200)

static void	setFunctionsMain (int nReg, int inLocoId, FunctionsState &inStates)

static bool	setSpeedProg (int nReg, int inLocoId, int inStepsNumber, int inNewSpeed, bool inForward)

static int	identifyLocoIdProg ()

static int	readCvProg (int inCvId, int callBack=100, int callBackSub=200)

static bool	writeCvProg (int inCvId, byte inValue, int callBack=100, int callBackSub=200)

static void	setFunctionsProg (int nReg, int inLocoId, FunctionsState &inStates)

static void	setAccessory (int inAddress, byte inSubAddress, byte inActivate)

static void	showConfiguration ()

Detailed Description

This is the main class of the library. All data and functions are static. There is no need to instantiate this class.

Definition at line 73 of file DCCpp.hpp.

Member Function Documentation

◆ begin()

void DCCpp::begin ( )

static

Begins the DCCpp library.

Definition at line 208 of file DCCpp.cpp.

Here is the call graph for this function:

◆ beginMain()

void DCCpp::beginMain	(	uint8_t	inOptionalDirectionMotor,
		uint8_t	inSignalPin,
		uint8_t	inSignalEnablePin,
		uint8_t	inCurrentMonitor
	)

static

Initializes the main track.

Parameters

inOptionalDirectionMotor	Pin for the rerouting of shields direction pin, set it to UNDEFINED_PIN if not used.
inSignalPin	Pin for the signal pin, the one driven by an interruption, set it to UNDEFINED_PIN if not used (but the line will be always down...).
inSignalEnablePin	Pin for the enable/PWM pin, set it to UNDEFINED_PIN if not used.
inCurrentMonitor	Pin for the current monitor analog pin, set it to UNDEFINED_PIN if not used.

Definition at line 147 of file DCCpp.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ beginMainDccSignal()

void DCCpp::beginMainDccSignal ( uint8_t inSignalPin )

static

Initializes the main track.

Parameters

inSignalPin Pin for the signal pin, the one driven by an interruption, set it to UNDEFINED_PIN if not used (but the line will be always down...).

Definition at line 228 of file DccSignalESP32.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ beginProg()

void DCCpp::beginProg	(	uint8_t	inOptionalDirectionMotor,
		uint8_t	inSignalPin,
		uint8_t	inSignalEnablePin,
		uint8_t	inCurrentMonitor
	)

static

Initializes the programming track.

Parameters

inOptionalDirectionMotor	Pin for the rerouting of shields direction pin, set it to UNDEFINED_PIN if not used.
inSignalPin	Pin for the signal pin, the one driven by an interruption, set it to UNDEFINED_PIN if not used (but the line will be always down...).
inSignalEnablePin	Pin for the enable/PWM pin, set it to UNDEFINED_PIN if not used.
inCurrentMonitor	Pin for the current monitor analog pin, set it to UNDEFINED_PIN if not used.

Definition at line 182 of file DCCpp.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ beginProgDccSignal()

void DCCpp::beginProgDccSignal ( uint8_t inSignalPin )

static

Initializes the programming track.

Parameters

inSignalPin Pin for the signal pin, the one driven by an interruption, set it to UNDEFINED_PIN if not used (but the line will be always down...).

Definition at line 252 of file DccSignalESP32.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCurrentMain()

static float DCCpp::getCurrentMain ( )

inlinestatic

Get the actual analog level for the current detection pin for the main track.

Returns: Current value between 0 and 1023 using an exponential smoother...

Definition at line 243 of file DCCpp.hpp.

◆ getCurrentProg()

static float DCCpp::getCurrentProg ( )

inlinestatic

Get the actual analog level for the current detection pin for the programming track.

Returns: Current value between 0 and 1023.

Definition at line 248 of file DCCpp.hpp.

◆ identifyLocoIdMain()

static int DCCpp::identifyLocoIdMain ( )

inlinestatic

Try to identify the address of a decoder on the main track. Be sure there is only one loco on the track to call this function !

Returns: CV 1 value: the loco decoder Id or -1 if no decoder identified.

Definition at line 265 of file DCCpp.hpp.

◆ identifyLocoIdProg()

static int DCCpp::identifyLocoIdProg ( )

inlinestatic

Try to identify the address of a decoder on the programming track. Be sure there is only one loco on the track to call this function !

Returns: CV 1 value: the loco decoder Id or -1 if no decoder identified.

Definition at line 307 of file DCCpp.hpp.

◆ IsMainTrack()

static bool DCCpp::IsMainTrack ( volatile RegisterList * apRegs )

inlinestatic

Checks if the given RegisterList is for the main track or not.

Parameters

apRegs RegisterList to check.

Returns: true if the RegisterList is mainRegs, the one from the main track.

Definition at line 191 of file DCCpp.hpp.

◆ IsMainTrackDeclared()

static bool DCCpp::IsMainTrackDeclared ( )

inlinestatic

Checks if beginMain() has been called with the right arguments !

Returns: true if the main track is defined.

Definition at line 196 of file DCCpp.hpp.

◆ IsProgTrackDeclared()

static bool DCCpp::IsProgTrackDeclared ( )

inlinestatic

Checks if beginProg() has been called with the right arguments !

Returns: true if the prog track is defined.

Definition at line 201 of file DCCpp.hpp.

◆ loop()

void DCCpp::loop ( )

static

Main loop function of the library.

Definition at line 104 of file DCCpp.cpp.

Here is the call graph for this function:

◆ panicStop()

void DCCpp::panicStop ( bool inStop )

static

Stop/restore the power on all the tracks.

Parameters

inStop If true, stop the power, otherwise restore the power.

Definition at line 393 of file DCCpp.cpp.

Here is the call graph for this function:

◆ powerOff()

void DCCpp::powerOff	(	bool	inMain = `true`,
		bool	inProg = `true`
	)

static

Stop the power on all the tracks by default, or on the chosen track according .

Parameters

inMain	If true, power off the main track.
inProg	If true, power off the programmation track.

Definition at line 431 of file DCCpp.cpp.

Here is the caller graph for this function:

◆ powerOn()

void DCCpp::powerOn	(	bool	inMain = `true`,
		bool	inProg = `true`
	)

static

Set the power on all the tracks by default, or on the chosen track according .

Parameters

inMain	If true, power on the main track.
inProg	If true, power on the programmation track.

Definition at line 409 of file DCCpp.cpp.

Here is the caller graph for this function:

◆ readCvMain()

static int DCCpp::readCvMain	(	int	inCvId,
		int	callBack = `100`,
		int	callBackSub = `200`
	)

inlinestatic

Try to read a CV from a decoder on the main track. Be sure there is only one loco on the track before calling this function !

Parameters

inCvId	CV id from 0 to 255.
callBack	an arbitrary integer (0-32767) that is ignored by the Base Station and is simply echoed back in the output - useful for external programs that call this function. Default 100.
callBackSub	a second arbitrary integer (0-32767) that is ignored by the Base Station and is simply echoed back in the output - useful for external programs (e.g. DCC++ Interface) that call this function. Default 200

Returns: CV value: the CV value or -1 if the value cannot be read.

Definition at line 274 of file DCCpp.hpp.

◆ readCvProg()

static int DCCpp::readCvProg	(	int	inCvId,
		int	callBack = `100`,
		int	callBackSub = `200`
	)

inlinestatic

Try to read a CV from a decoder on the programming track. Be sure there is only one loco on the track before calling this function !

Parameters

inCvId	CV id from 0 to 255.
callBack	an arbitrary integer (0-32767) that is ignored by the Base Station and is simply echoed back in the output - useful for external programs that call this function. Default 100.
callBackSub	a second arbitrary integer (0-32767) that is ignored by the Base Station and is simply echoed back in the output - useful for external programs (e.g. DCC++ Interface) that call this function. Default 200

Returns: CV value: the CV value or -1 if the value cannot be read.

Definition at line 316 of file DCCpp.hpp.

◆ setAccessory()

void DCCpp::setAccessory	(	int	inAddress,
		byte	inSubAddress,
		byte	inActivate
	)

static

Activates or not the given accessory

Parameters

inAddress	main address of the accessory decoder, from 0 to 511.
inSubAddress	accessory number inside the decoder, from 0 to 3.
inActivate	True to activate the accessory, false to deactivate.

Definition at line 622 of file DCCpp.cpp.

◆ setAckThreshold()

byte DCCpp::setAckThreshold ( byte inNewValue )

static

Set the minimum threshold value to validate a CV reading or writing..

Parameters

inNewValue Maximum value between 0 and 1023. Default is 30. The threshold that the exponentially-smoothed analogRead samples (after subtracting the baseline current) must cross to establish ACKNOWLEDGEMENT.

Returns: Previous value.

Definition at line 452 of file DCCpp.cpp.

◆ setCurrentSampleMaxMain()

static void DCCpp::setCurrentSampleMaxMain ( float inMax )

inlinestatic

Set the maximum current value before an event 'too much current consumption detected !' for main track.

Parameters

inMax Maximum value between 0 and 1023. Default is 300.

Definition at line 233 of file DCCpp.hpp.

◆ setCurrentSampleMaxProg()

static void DCCpp::setCurrentSampleMaxProg ( float inMax )

inlinestatic

Set the maximum current value before an event 'too much current consumption detected !' for programming track.

Parameters

inMax Maximum value between 0 and 1023. Default is 300.

Definition at line 238 of file DCCpp.hpp.

◆ setDebugDccMode()

void DCCpp::setDebugDccMode ( )

static

Set the tracks in slow 'debug' mode only for tests.

Definition at line 275 of file DccSignalESP32.cpp.

◆ setFunctionsMain()

static void DCCpp::setFunctionsMain	(	int	nReg,
		int	inLocoId,
		FunctionsState &	inStates
	)

inlinestatic

Set the functions states of the given decoder on the main track.

Parameters

nReg	Register number. Original DCC++ use register 0 to send function states only a few times. DCCpp Can use any register to be able to send function packets repeatedly like the speed packets,
inLocoId	Decoder address in short or long format.
inStates	FunctionsState class with the wanted new status.

Definition at line 290 of file DCCpp.hpp.

◆ setFunctionsProg()

static void DCCpp::setFunctionsProg	(	int	nReg,
		int	inLocoId,
		FunctionsState &	inStates
	)

inlinestatic

Set the functions states of the given decoder on the programming track.

Parameters

nReg	Register number. Original DCC++ use register 0 to send function states only a few times. DCCpp Can use any register to be able to send function packets repeatedly like the speed packets,
inLocoId	Decoder address in short or long format.
inStates	FunctionsState class with the wanted new status.

Definition at line 332 of file DCCpp.hpp.

◆ setSpeedMain()

static bool DCCpp::setSpeedMain	(	int	nReg,
		int	inLocoId,
		int	inStepsNumber,
		int	inNewSpeed,
		bool	inForward
	)

inlinestatic

For the given decoder id, set the speed and the direction on the main track.

Parameters

nReg	Register number. Avoid register 0, used for one shot commands like accessories or CV programming.
inLocoId	Decoder address in short or long format.
inStepsNumber	According to the decoder configuration, set it to 14, 28 or 128 .
inNewSpeed	Speed of the loco, between 2 and the steps number - 1 (13, 27 or 127). 0 means normal complete stop. 1 means emergency stop.
inForward	True means forward move, false means backward.

Returns: True if the value has been changed. At the moment, always return true...

Definition at line 260 of file DCCpp.hpp.

◆ setSpeedProg()

static bool DCCpp::setSpeedProg	(	int	nReg,
		int	inLocoId,
		int	inStepsNumber,
		int	inNewSpeed,
		bool	inForward
	)

inlinestatic

For the given decoder id, set the speed and the direction on the programming track.

Parameters

nReg	Register number. Avoid register 0, used for one shot commands like accessories or CV programming.
inLocoId	Decoder address in short or long format.
inStepsNumber	According to the decoder configuration, set it to 14, 28 or 128 .
inNewSpeed	Speed of the loco, between 2 and the steps number - 1 (13, 27 or 127). 0 means normal complete stop. 1 means emergency stop.
inForward	True means forward move, false means backward.

Returns: True if the value has been changed. At the moment, always return true...

Definition at line 302 of file DCCpp.hpp.

◆ showConfiguration()

void DCCpp::showConfiguration ( )

static

Print the list of activated functions.

Remarks: Only available if DCCPP_PRINT_DCCPP is defined.

Definition at line 286 of file DCCpp.cpp.

Here is the caller graph for this function:

◆ writeCvMain()

static void DCCpp::writeCvMain	(	int	inCvId,
		byte	inValue,
		int	callBack = `100`,
		int	callBackSub = `200`
	)

inlinestatic

Write the given CV on the main track. Be sure there is only one loco on the track before calling this function !

Parameters

inCvId	CV id from 0 to 255.
inValue	CV new value from 0 to 255.
callBack	an arbitrary integer (0-32767) that is ignored by the Base Station and is simply echoed back in the output - useful for external programs that call this function. Default 100.
callBackSub	a second arbitrary integer (0-32767) that is ignored by the Base Station and is simply echoed back in the output - useful for external programs (e.g. DCC++ Interface) that call this function. Default 200

Definition at line 283 of file DCCpp.hpp.

◆ writeCvProg()

static bool DCCpp::writeCvProg	(	int	inCvId,
		byte	inValue,
		int	callBack = `100`,
		int	callBackSub = `200`
	)

inlinestatic

Write the given CV on the programming track.

Parameters

inCvId	CV id from 0 to 255.
inValue	CV new value from 0 to 255.
callBack	an arbitrary integer (0-32767) that is ignored by the Base Station and is simply echoed back in the output - useful for external programs that call this function. Default 100.
callBackSub	a second arbitrary integer (0-32767) that is ignored by the Base Station and is simply echoed back in the output - useful for external programs (e.g. DCC++ Interface) that call this function. Default 200

Returns: False if the writing have failed.

Definition at line 325 of file DCCpp.hpp.

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

DCC_Card/DCCpp.hpp
DCC_Card/DCCpp.cpp
DCC_Card/DccSignalESP32.cpp

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ begin()

◆ beginMain()

◆ beginMainDccSignal()

◆ beginProg()

◆ beginProgDccSignal()

◆ getCurrentMain()

◆ getCurrentProg()

◆ identifyLocoIdMain()

◆ identifyLocoIdProg()

◆ IsMainTrack()

◆ IsMainTrackDeclared()

◆ IsProgTrackDeclared()

◆ loop()

◆ panicStop()

◆ powerOff()

◆ powerOn()

◆ readCvMain()

◆ readCvProg()

◆ setAccessory()

◆ setAckThreshold()

◆ setCurrentSampleMaxMain()

◆ setCurrentSampleMaxProg()

◆ setDebugDccMode()

◆ setFunctionsMain()

◆ setFunctionsProg()

◆ setSpeedMain()

◆ setSpeedProg()

◆ showConfiguration()

◆ writeCvMain()

◆ writeCvProg()