Update to v1.1

Author: Kruemelbahn

LocoNetKS.cpp

@@ -1,7 +1,7 @@
 /*
 ||
 || @file LocoNetKS.cpp
-|| @version 1.0
+|| @version 1.1
 || @author Michael Zimmermann
 || @contact michael.zimmermann.sg@t-online.de
 ||
@@ -92,151 +92,3 @@ LN_STATUS LocoNetClassKS::sendReportSensor(uint16_t Address, uint8_t State)
   return LocoNet.send(OPC_INPUT_REP, AddrL, AddrH);
 }
 //=== end LocoNetClassKS ===
-
-//=== LocoNetFastClockClassKS ===
-/* this class is copied from original LocoNetFastClockClass in file loconet.cpp (Version 1.1.13) 
-*  modification is made for new flag "FC_FLAG_NOTIFY_JMRI" (see also commenst "added")
-*/
-#define FC_FLAG_DCS100_COMPATIBLE_SPEED	0x01
-#define FC_FLAG_MINUTE_ROLLOVER_SYNC		0x02
-#define FC_FLAG_NOTIFY_FRAC_MINS_TICK		0x04
-#define FC_FLAG_NOTIFY_JMRI							0x08			// new for JMRI
-#define FC_FRAC_MIN_BASE   							0x3FFF
-#define FC_FRAC_RESET_HIGH	 						0x78
-#define FC_FRAC_RESET_LOW 	 						0x6D
-#define FC_TIMER_TICKS         					65        // 65ms ticks
-#define FC_TIMER_TICKS_REQ	  					250       // 250ms waiting for Response to FC Req
-
-void LocoNetFastClockClassKS::init(uint8_t DCS100CompatibleSpeed, uint8_t CorrectDCS100Clock, uint8_t NotifyFracMin)
-{
-	fcState = FC_ST_IDLE;
-
-	fcFlags = 0;
-	if (DCS100CompatibleSpeed)
-		fcFlags |= FC_FLAG_DCS100_COMPATIBLE_SPEED;
-
-	if (CorrectDCS100Clock)
-		fcFlags |= FC_FLAG_MINUTE_ROLLOVER_SYNC;
-
-	if (NotifyFracMin)
-		fcFlags |= FC_FLAG_NOTIFY_FRAC_MINS_TICK;
-}
-
-// new method
-void LocoNetFastClockClassKS::initJMRI(uint8_t IsJMRI)
-{
-	fcLastfrac_minsh = 0;
-	if (IsJMRI)
-		fcFlags |= FC_FLAG_NOTIFY_JMRI;
-}
-
-void LocoNetFastClockClassKS::poll(void)
-{
-	LocoNet.send(OPC_RQ_SL_DATA, FC_SLOT, 0);
-}
-
-void LocoNetFastClockClassKS::doNotify(uint8_t Sync)
-{
-	if (notifyFastClock)
-		notifyFastClock(fcSlotData.clk_rate, fcSlotData.days,
-			(fcSlotData.hours_24 >= (128 - 24)) ? fcSlotData.hours_24 - (128 - 24) : fcSlotData.hours_24 % 24,
-			fcSlotData.mins_60 - (127 - 60), Sync);
-}
-
-// changed method
-void LocoNetFastClockClassKS::processMessage(lnMsg* LnPacket)
-{
-	if ((LnPacket->fc.slot == FC_SLOT) && ((LnPacket->fc.command == OPC_WR_SL_DATA) || (LnPacket->fc.command == OPC_SL_RD_DATA)))
-	{
-		if ((LnPacket->fc.clk_cntrl & 0x40)
-// +++ added because JMRI is sending 'fc.clk_cntrl = 0x00' (Bit 6 not set)
-			|| (fcFlags & FC_FLAG_NOTIFY_JMRI))
-// added end
-		{
-			if (fcState >= FC_ST_REQ_TIME)
-			{
-				memcpy(&fcSlotData, &LnPacket->fc, sizeof(fastClockMsg));
-// ++ added for JMRI and use in "process66msActions"
-				fcLastfrac_minsh = fcSlotData.frac_minsh;
-// added end
-				doNotify(1);
-
-				if (notifyFastClockFracMins && fcFlags & FC_FLAG_NOTIFY_FRAC_MINS_TICK)
-					notifyFastClockFracMins(FC_FRAC_MIN_BASE - ((fcSlotData.frac_minsh << 7) + fcSlotData.frac_minsl));
-
-				fcState = FC_ST_READY;
-			}
-		}
-		else
-			fcState = FC_ST_DISABLED;
-	}
-}
-
-// changed method
-void LocoNetFastClockClassKS::process66msActions(void)
-{
-	// If we are all initialised and ready then increment accumulators
-	if (fcState == FC_ST_READY)
-	{
-		fcSlotData.frac_minsl += fcSlotData.clk_rate;
-		if (fcSlotData.frac_minsl & 0x80)
-		{
-			fcSlotData.frac_minsl &= ~0x80;
-
-			fcSlotData.frac_minsh++;
-			if ((fcSlotData.frac_minsh & 0x80)
-// +++ added because JMRI starts with 'fcSlotData.frac_minsh = 3' instead of FC_FRAC_RESET_HIGH (0x78)
-//                                 therefore fcSlotData.frac_minsh is always less than 0x80
-//															   and fcSlotData.frac_minsh comes in maximum up to 10, independant from fcSlotdata.clk_rate
-				|| ((fcFlags & FC_FLAG_NOTIFY_JMRI) &&
-					  (fcSlotData.frac_minsh > (fcLastfrac_minsh + 6)) &&
-						(fcSlotData.frac_minsh < (FC_FRAC_RESET_HIGH + (fcFlags & FC_FLAG_DCS100_COMPATIBLE_SPEED)))
-					 ) 
-				 )
-// added end
-			{
-				// For the next cycle prime the fraction of a minute accumulators
-				fcSlotData.frac_minsl = FC_FRAC_RESET_LOW;
-
-				// If we are in FC_FLAG_DCS100_COMPATIBLE_SPEED mode we need to run faster
-				// by reducong the FRAC_MINS duration count by 128
-				fcSlotData.frac_minsh = FC_FRAC_RESET_HIGH + (fcFlags & FC_FLAG_DCS100_COMPATIBLE_SPEED);
-
-				fcSlotData.mins_60++;
-				if (fcSlotData.mins_60 >= 0x7F)
-				{
-					fcSlotData.mins_60 = 127 - 60;
-
-					fcSlotData.hours_24++;
-					if (fcSlotData.hours_24 & 0x80)
-					{
-						fcSlotData.hours_24 = 128 - 24;
-
-						fcSlotData.days++;
-					}
-				}
-
-				// We either send a message out onto the LocoNet to change the time,
-				// which we will also see and act on or just notify our user
-				// function that our internal time has changed.
-				if (fcFlags & FC_FLAG_MINUTE_ROLLOVER_SYNC)
-				{
-					fcSlotData.command = OPC_WR_SL_DATA;
-					LocoNet.send((lnMsg*)&fcSlotData);
-				}
-				else
-					doNotify(0);
-			}
-		}
-
-		if (notifyFastClockFracMins && (fcFlags & FC_FLAG_NOTIFY_FRAC_MINS_TICK))
-			notifyFastClockFracMins(FC_FRAC_MIN_BASE - ((fcSlotData.frac_minsh << 7) + fcSlotData.frac_minsl));
-	}
-
-	if (fcState == FC_ST_IDLE)
-	{
-		LocoNet.send(OPC_RQ_SL_DATA, FC_SLOT, 0);
-		fcState = FC_ST_REQ_TIME;
-	}
-}
-//=== end LocoNetFastClockClassKS ===

LocoNetKS.h

@@ -1,12 +1,12 @@
 /*
 ||
 || @file LocoNetKS.h
-|| @version 1.0
+|| @version 1.1
 || @author Michael Zimmermann
 || @contact michael.zimmermann.sg@t-online.de
 ||
 || @description
-|| | additional functions for 'LocoNetClass' and 'LocoNetFastClockClass' from Loconet-Library, published by MRRwA (previously EmbeddedLocoNet)
+|| | additional functions for 'LocoNetClass' from Loconet-Library, published by MRRwA (previously EmbeddedLocoNet)
 || #
 ||
 || @license
@@ -53,26 +53,4 @@ class LocoNetClassKS {
 
 extern LocoNetClassKS LocoNetKS;
 
-class LocoNetFastClockClassKS
-{
-private:
-	FC_STATE			fcState;			// State of the Fast Clock Slave 
-	uint8_t				fcFlags;			// Storage of the option flags passed into initFastClock()
-	fastClockMsg 	fcSlotData;		// Primary storage for the Fast Clock slot data 
-	uint8_t 			fcLastPeriod;	// Period of last tick so we can alternate between
-	uint8_t       fcLastfrac_minsh; // new
-
-	void doNotify(uint8_t Sync);
-
-public:
-	void init(uint8_t DCS100CompatibleSpeed, uint8_t CorrectDCS100Clock, uint8_t NotifyFracMin);
-	void initJMRI(uint8_t IsJMRI);															// new
-	void poll(void);
-	void processMessage(lnMsg* LnPacket);												// modified
-	void process66msActions(void);															// modified
-
-	FC_STATE getFastClockState() { return fcState; }						// new, used in debug-cases
-	fastClockMsg getFastClockSlotData() { return fcSlotData; }	// new, used in debug-cases
-};
-
 #endif

README.md

@@ -2,9 +2,6 @@
 
 This is a simple library with additional functions I missed in the original LocoNET-library for usage with Arduino-platform.<br>
 
-In addition, I copied the original LocoNetFastClockClass and modified it.<br>
-This was necessary because the original class doesnot work for me during the development of the [Nebenuhr](http://www.github.com/Kruemelbahn/Nebenuhr), a FastClock-Slave which should work with [JMRI](https://www.jmri.org/)<br>
-
 Necessary base-library can be found on https://github.com/mrrwa/LocoNet
 
 Tested on ATmega328.

library.properties

@@ -1,10 +1,10 @@
 name=LocoNetKS
-version=1.0
+version=1.1
 author=michael <Kruemelbahn2000@hotmail.de>
 maintainer=michael <Kruemelbahn2000@hotmail.de>
 sentence=additional functions for class LocoNet (see http://mrrwa.org/loconet-interface/)
 paragraph=This library allows extends the interface to the LocoNet-Library
 category=Communication
-url=https://github.com/Kruemelbahn/LocoNetKS
+url=http://www.kruemelsoft.privat.t-online.de
 architectures=avr
 depends=LocoNet