DCCpp
This is the library version of a program for Arduino to control railroading DCC devices.
DCCpp.hpp
1 //-------------------------------------------------------------------
2 #ifndef __DCCpp_hpp__
3 #define __DCCpp_hpp__
4 //-------------------------------------------------------------------
5 
6 #include "DCCpp.h"
7 
14 {
15  private:
18  byte activeFlags[4];
19 
23  byte activeFlagsSent[4];
24 
25  inline byte byteNumber(byte inFunctionNumber) { return inFunctionNumber / 8; }
26  inline byte bitNumber(byte inFunctionNumber) { return inFunctionNumber % 8; }
27 
28  public:
32 
35  void clear();
39  void activate(byte inFunctionNumber);
43  void inactivate(byte inFunctionNumber);
48  bool isActivated(byte inFunctionNumber);
50  void statesSent();
56  bool isActivationChanged(byte inFunctionNumber);
57 
58 #ifdef DCCPP_DEBUG_MODE
59 
62  void printActivated();
63 #endif
64 };
65 
70 class DCCpp
71 {
72  private:
73  static bool programMode;
74  static bool panicStopped;
75 
76  static bool setThrottle(volatile RegisterList *inReg, int nReg, int inLocoId, int inStepsNumber, int inNewSpeed, bool inForward);
77  //static int readCv(volatile RegisterList *inReg, byte inCvId, int callBack = 100, int callBackSub = 200) { return inReg->readCV(inCvId, callBack, callBackSub); }
78  static void writeCv(volatile RegisterList *inReg, int inCvId, byte inCvValue, int callBack = 100, int callBackSub = 200);
79  static int identifyLocoId(volatile RegisterList *inReg);
80  static void setFunctions(volatile RegisterList *inReg, int nReg, int inLocoId, FunctionsState &inStates);
81 
82  public:
83  static volatile RegisterList mainRegs, progRegs;
84  static CurrentMonitor mainMonitor;
85  static CurrentMonitor progMonitor;
86 
87  public:
88  // begins
91  static void begin();
98  static void beginMain(uint8_t inOptionalDirectionMotor, uint8_t inSignalPin, uint8_t inSignalEnablePin, uint8_t inCurrentMonitor);
105  static void beginProg(uint8_t inOptionalDirectionMotor, uint8_t inSignalPin, uint8_t inSignalEnablePin, uint8_t inCurrentMonitor);
106 
109  static inline void beginMainMotorShield() { beginMain(MOTOR_SHIELD_DIRECTION_MOTOR_CHANNEL_PIN_A, DCC_SIGNAL_PIN_MAIN, MOTOR_SHIELD_SIGNAL_ENABLE_PIN_MAIN, MOTOR_SHIELD_CURRENT_MONITOR_PIN_MAIN); }
112  static inline void beginProgMotorShield() { beginProg(MOTOR_SHIELD_DIRECTION_MOTOR_CHANNEL_PIN_B, DCC_SIGNAL_PIN_PROG, MOTOR_SHIELD_SIGNAL_ENABLE_PIN_PROG, MOTOR_SHIELD_CURRENT_MONITOR_PIN_PROG); }
113 
116  static inline void beginMainPololu() { beginMain(POLOLU_DIRECTION_MOTOR_CHANNEL_PIN_A, DCC_SIGNAL_PIN_MAIN, POLOLU_SIGNAL_ENABLE_PIN_MAIN, POLOLU_CURRENT_MONITOR_PIN_MAIN); }
119  static inline void beginProgPololu() { beginProg(POLOLU_DIRECTION_MOTOR_CHANNEL_PIN_B, DCC_SIGNAL_PIN_PROG, POLOLU_SIGNAL_ENABLE_PIN_PROG, POLOLU_CURRENT_MONITOR_PIN_PROG); }
120 #ifdef USE_ETHERNET
121 
126  static void beginEthernet(uint8_t *inMac, uint8_t *inIp, EthernetProtocol inProtocol = EthernetProtocol::TCP);
127 #endif
128 
129  // DCCpp global functions
130 
135  static bool IsMainTrack(volatile RegisterList *apRegs) { return apRegs == &mainRegs; }
136 
139  static void loop();
140 
144  static void panicStop(bool inStop);
145 
150  static void powerOn(bool inMain = true, bool inProg = true);
151 
156  static void powerOff(bool inMain = true, bool inProg = true);
157 
161  static inline void setCurrentSampleMaxMain(float inMax) { mainMonitor.currentSampleMax = inMax; }
162 
166  static inline void setCurrentSampleMaxProg(float inMax) { progMonitor.currentSampleMax = inMax; }
167 
171  static inline float getCurrentMain() { return mainMonitor.pin == UNDEFINED_PIN ? 0 : mainMonitor.current; }
172 
176  static inline float getCurrentProg() { return progMonitor.pin == UNDEFINED_PIN ? 0 : progMonitor.current; }
177 
178  // Main track functions
179 
187  static inline bool setSpeedMain(int nReg, int inLocoId, int inStepsNumber, int inNewSpeed, bool inForward) { return setThrottle(&(mainRegs), nReg, inLocoId, inStepsNumber, inNewSpeed, inForward); }
188 
192  static inline int identifyLocoIdMain() { return identifyLocoId(&(mainRegs)); }
193 
201  static inline int readCvMain(int inCvId, int callBack = 100, int callBackSub = 200) { return mainRegs.readCVmain(inCvId, callBack, callBackSub); }
202 
210  static inline void writeCvMain(int inCvId, byte inValue, int callBack = 100, int callBackSub = 200) { writeCv(&(mainRegs), inCvId, inValue, callBack, callBackSub); }
211 
217  static inline void setFunctionsMain(int nReg, int inLocoId, FunctionsState &inStates) { setFunctions(&(mainRegs), nReg, inLocoId, inStates); }
218 
219  // Programming track functions
220 
228  static inline bool setSpeedProg(int nReg, int inLocoId, int inStepsNumber, int inNewSpeed, bool inForward) { return setThrottle(&(progRegs), nReg, inLocoId, inStepsNumber, inNewSpeed, inForward); }
229 
233  static inline int identifyLocoIdProg() { return identifyLocoId(&(progRegs)); }
234 
242  static inline int readCvProg(int inCvId, int callBack = 100, int callBackSub = 200) { return progRegs.readCV(inCvId, callBack, callBackSub); }
243 
250  static inline void writeCvProg(int inCvId, byte inValue, int callBack = 100, int callBackSub = 200) { writeCv(&(progRegs), inCvId, inValue, callBack, callBackSub); }
251 
257  static inline void setFunctionsProg(int nReg, int inLocoId, FunctionsState &inStates) { setFunctions(&(progRegs), nReg, inLocoId, inStates); }
258 
259  // Accessories
260 
266  static void setAccessory(int inAddress, byte inSubAddress, byte inActivate);
267 
268 public:
269 #ifdef DCCPP_PRINT_DCCPP
270 
271  #define PRINT_DCCPP DCCpp::showConfiguration();
272 
275  static void showConfiguration();
276 #else
277  #define PRINT_DCCPP
278 #endif
279 };
280 
281 //-------------------------------------------------------------------
282 #endif
283 //-------------------------------------------------------------------
static void setFunctionsProg(int nReg, int inLocoId, FunctionsState &inStates)
Definition: DCCpp.hpp:257
static void writeCvProg(int inCvId, byte inValue, int callBack = 100, int callBackSub = 200)
Definition: DCCpp.hpp:250
static bool setSpeedProg(int nReg, int inLocoId, int inStepsNumber, int inNewSpeed, bool inForward)
Definition: DCCpp.hpp:228
static void setFunctionsMain(int nReg, int inLocoId, FunctionsState &inStates)
Definition: DCCpp.hpp:217
static void writeCvMain(int inCvId, byte inValue, int callBack = 100, int callBackSub = 200)
Definition: DCCpp.hpp:210
static int readCvMain(int inCvId, int callBack = 100, int callBackSub = 200)
Definition: DCCpp.hpp:201
static int identifyLocoIdMain()
Definition: DCCpp.hpp:192
static float getCurrentProg()
Definition: DCCpp.hpp:176
static int identifyLocoIdProg()
Definition: DCCpp.hpp:233
static void setCurrentSampleMaxProg(float inMax)
Definition: DCCpp.hpp:166
static void setCurrentSampleMaxMain(float inMax)
Definition: DCCpp.hpp:161
void inactivate(byte inFunctionNumber)
Definition: DCCpp.cpp:45
static int readCvProg(int inCvId, int callBack = 100, int callBackSub = 200)
Definition: DCCpp.hpp:242
FunctionsState()
Definition: DCCpp.cpp:24
static float getCurrentMain()
Definition: DCCpp.hpp:171
void clear()
Definition: DCCpp.cpp:29
static void powerOn(bool inMain = true, bool inProg = true)
Definition: DCCpp.cpp:548
void statesSent()
Definition: DCCpp.cpp:60
static void begin()
Definition: DCCpp.cpp:293
static void setAccessory(int inAddress, byte inSubAddress, byte inActivate)
Definition: DCCpp.cpp:756
Definition: DCCpp.hpp:70
static void beginMain(uint8_t inOptionalDirectionMotor, uint8_t inSignalPin, uint8_t inSignalEnablePin, uint8_t inCurrentMonitor)
Definition: DCCpp.cpp:117
bool isActivationChanged(byte inFunctionNumber)
Definition: DCCpp.cpp:55
static void beginMainMotorShield()
Definition: DCCpp.hpp:109
static bool setSpeedMain(int nReg, int inLocoId, int inStepsNumber, int inNewSpeed, bool inForward)
Definition: DCCpp.hpp:187
static void beginProgMotorShield()
Definition: DCCpp.hpp:112
bool isActivated(byte inFunctionNumber)
Definition: DCCpp.cpp:50
void activate(byte inFunctionNumber)
Definition: DCCpp.cpp:40
static void beginMainPololu()
Definition: DCCpp.hpp:116
static void beginProg(uint8_t inOptionalDirectionMotor, uint8_t inSignalPin, uint8_t inSignalEnablePin, uint8_t inCurrentMonitor)
Definition: DCCpp.cpp:182
static void beginProgPololu()
Definition: DCCpp.hpp:119
static bool IsMainTrack(volatile RegisterList *apRegs)
Definition: DCCpp.hpp:135
static void loop()
Definition: DCCpp.cpp:92
static void panicStop(bool inStop)
Definition: DCCpp.cpp:531
static void powerOff(bool inMain = true, bool inProg = true)
Definition: DCCpp.cpp:561