DCC time broadcast and DS1307 clock chip

CommandDistributor.cpp

@@ -185,6 +185,9 @@ void CommandDistributor::setClockTime(int16_t clocktime, int8_t clockrate, byte
   {
     case 1:
       if (clocktime != lastclocktime){
+        auto difference = clocktime - lastclocktime;
+        if (difference<0) difference+=1440;
+        DCC::setTime(clocktime,clockrate,difference>2);
         // CAH. DIAG removed because LCD does it anyway. 
         LCD(6,F("Clk Time:%d Sp %d"), clocktime, clockrate);
         // look for an event for this time

DCC.cpp

@@ -445,6 +445,44 @@ void DCC::writeCVBitMain(int cab, int cv, byte bNum, bool bValue)  {
   DCCWaveform::mainTrack.schedulePacket(b, nB, 4);
 }
 
+bool DCC::setTime(uint16_t minutes,uint8_t speed, bool suddenChange) {
+  /* see rcn-122
+  5 Global commands 
+These commands are sent and begin exclusively with a broadcast address 0 
+always with {synchronous bits} 0 0000-0000 … and end with the checksum 
+... PPPPPPPP 1. Therefore, only the bytes of the commands and not that of 
+shown below whole package shown. The commands can be used by vehicle and 
+accessory decoders alike. 
+
+  5.1 Time command 
+This command is four bytes long and has the format: 
+1100-0001 CCxx-xxxx xxxx-xxxxx xxxx-xxxx 
+CC indicates what data is transmitted in the packet: 
+CC = 00 Model Time 
+1100-0001 00MM-MMMM WWWH-HHHH U0BB-BBBB with: 
+MMMMMM = Minutes, Value range: 0..59 
+WWW =     Day of the Week, Value range: 0 = Monday, 1 = Tuesday, 2 = Wednesday, 
+3 = Thursday, 4 = Friday, 5 = Saturday, 6 = Sunday, 7 = Weekday 
+is not supported. 
+HHHHH =   Hours, value range: 0..23 
+U =         
+Update, i.e. the time has changed suddenly, e.g. by a new one timetable to start.        
+Up to 4 can occur per sudden change commands can be marked like this. 
+BBBBBB =    Acceleration factor, value range 0..63. An acceleration factor of 0 means the  
+model clock has been stopped, a factor of 1 corresponds to real time, at 2 the 
+clock runs twice as fast, at three times as fast as real time, etc. 
+*/
+if (minutes>=1440 || speed>63 ) return false; 
+byte b[5];
+b[0]=0; // broadcast address
+b[1]=0b11000001; // 1100-0001 (model time)
+b[2]=minutes % 60 ;  // MM
+b[3]= 0b11100000 | (minutes/60); // 111H-HHHH weekday not supported
+b[4]= (suddenChange ? 0b10000000 : 0) | speed;
+DCCWaveform::mainTrack.schedulePacket(b, sizeof(b), 2);
+return true; 
+}
+
 FSH* DCC::getMotorShieldName() {
   return shieldName;
 }

DCC.h

@@ -85,6 +85,7 @@ public:
   static void writeCVBit(int16_t cv, byte bitNum, bool bitValue, ACK_CALLBACK callback);
   static void verifyCVByte(int16_t cv, byte byteValue, ACK_CALLBACK callback);
   static void verifyCVBit(int16_t cv, byte bitNum, bool bitValue, ACK_CALLBACK callback);
+  static bool setTime(uint16_t minutes,uint8_t speed, bool suddenChange);
 
   static void getLocoId(ACK_CALLBACK callback);
   static void setLocoId(int id,ACK_CALLBACK callback);

IODeviceList.h

@@ -0,0 +1,36 @@
+/*
+ *  © 2024, Chris Harlow. All rights reserved.
+ *
+ *  This file is part of CommandStation-EX
+ *
+ *  This is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  It is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with CommandStation.  If not, see <https://www.gnu.org/licenses/>.
+*/
+/* 
+This is the list of HAL drivers automatically included by IODevice.h
+It has been moved here to be easier to maintain than editing IODevice.h
+*/
+#include "IO_MCP23008.h"
+#include "IO_MCP23017.h"
+#include "IO_PCF8574.h"
+#include "IO_PCF8575.h"
+#include "IO_PCA9555.h"
+#include "IO_duinoNodes.h"
+#include "IO_EXIOExpander.h"
+#include "IO_trainbrains.h"
+#include "IO_EncoderThrottle.h"
+#include "IO_TCA8418.h"
+#include "IO_NeoPixel.h"
+#include "IO_TM1638.h"
+#include "IO_EXSensorCAM.h"
+#include "IO_DS1307.h"

IO_DS1307.cpp

@@ -0,0 +1,143 @@
+/*
+ *  © 2024, Chris Harlow. All rights reserved.
+ *
+ *  This file is part of CommandStation-EX
+ *
+ *  This is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  It is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with CommandStation.  If not, see <https://www.gnu.org/licenses/>.
+*/
+
+/*
+* The IO_DS1307 device driver is used to interface a standalone realtime clock. 
+* The clock will announce every minute (which will trigger EXRAIL ONTIME events).
+* Seconds, and Day/date info is ignored, except that the announced hhmm time
+* will attempt to synchronize with the 0 seconds of the clock. 
+* An analog read in EXRAIL (IFGTE(vpin, value) etc will check against the hh*60+mm time.
+* The clock can be easily set by an analog write to the vpin using 24 hr clock time
+* with the command <z vpin hh mm ss> 
+*/
+
+#include "IO_DS1307.h"
+#include "I2CManager.h"
+#include "DIAG.h"
+#include "CommandDistributor.h"
+
+uint8_t d2b(uint8_t d) {
+     return (d >> 4)*10 + (d & 0x0F);  
+}
+
+void DS1307::create(VPIN vpin, I2CAddress i2cAddress) {
+    if (checkNoOverlap(vpin, 1, i2cAddress)) new DS1307(vpin, i2cAddress);
+  }
+ 
+    
+  // Constructor
+    DS1307::DS1307(VPIN vpin,I2CAddress i2cAddress){
+      _firstVpin = vpin;
+      _nPins = 1;
+     _I2CAddress = i2cAddress;
+     addDevice(this);
+    }
+
+uint32_t DS1307::getTime() {
+    // Obtain ss,mm,hh buffers from device
+    uint8_t readBuffer[3];
+    const uint8_t writeBuffer[1]={0};
+
+    // address register 0 for read. 
+    I2CManager.write(_I2CAddress, writeBuffer, 1);
+    if (I2CManager.read(_I2CAddress, readBuffer, 3) != I2C_STATUS_OK) {
+       _deviceState=DEVSTATE_FAILED;
+       return 0;
+    } 
+    _deviceState=DEVSTATE_NORMAL;
+
+    if (debug) {
+      static const char hexchars[]="0123456789ABCDEF";
+      USB_SERIAL.print(F("<*RTC"));
+        for (int i=2;i>=0;i--) {
+          USB_SERIAL.write(' ');  
+          USB_SERIAL.write(hexchars[readBuffer[i]>>4]);
+          USB_SERIAL.write(hexchars[readBuffer[i]& 0x0F ]);
+        }
+        StringFormatter::send(&USB_SERIAL,F(" %d *>\n"),_deviceState);
+      }
+    
+    if (readBuffer[0] & 0x80) {
+        _deviceState=DEVSTATE_INITIALISING;
+        DIAG(F("DS1307 clock in standby"));
+        return 0; // clock is not running
+    }
+    // convert device format to seconds since midnight
+    uint8_t ss=d2b(readBuffer[0]  & 0x7F);
+    uint8_t mm=d2b(readBuffer[1]);
+    uint8_t hh=d2b(readBuffer[2] & 0x3F);
+    return (hh*60ul +mm)*60ul +ss;     
+}
+
+void DS1307::_begin()  {
+  // Initialise  device and sync loop() to zero seconds
+    I2CManager.begin(); 
+    auto tstamp=getTime();
+    if (_deviceState==DEVSTATE_NORMAL) {
+        byte seconds=tstamp%60;
+        delayUntil(micros() + ((60-seconds) * 1000000));
+    }
+    _display(); 
+}
+
+// Processing loop to obtain clock time.
+// This self-synchronizes to the next minute tickover
+void DS1307::_loop(unsigned long currentMicros) { 
+    auto time=getTime();
+    if (_deviceState==DEVSTATE_NORMAL) {
+       byte ss=time%60;
+       CommandDistributor::setClockTime(time/60, 1, 1);      
+       delayUntil(currentMicros + ((60-ss) * 1000000));  
+    }
+}
+
+
+  // Display device driver info.
+  void DS1307::_display()  {
+    auto tstamp=getTime();
+    byte ss=tstamp%60;
+    tstamp/=60;
+    byte mm=tstamp%60;
+    byte hh=tstamp/60;
+    DIAG(F("DS1307 on I2C:%s vpin %d %d:%d:%d %S"), 
+      _I2CAddress.toString(), _firstVpin,
+      hh,mm,ss,
+     (_deviceState==DEVSTATE_FAILED) ? F("OFFLINE") : F(""));
+  }
+
+  // allow user to set the clock 
+  void DS1307::_writeAnalogue(VPIN vpin, int hh, uint8_t mm, uint16_t ss)  {  
+    (void) vpin;
+    uint8_t writeBuffer[3];
+    writeBuffer[0]=1; // write mm,hh first 
+    writeBuffer[1]=((mm/10)<<4) + (mm % 10);  
+    writeBuffer[2]=((hh/10)<<4) + (hh % 10);  
+    I2CManager.write(_I2CAddress, writeBuffer, 3);
+    writeBuffer[0]=0; // write ss  
+    writeBuffer[1]=((ss/10)<<4) + (ss % 10);  
+    I2CManager.write(_I2CAddress, writeBuffer, 2);
+    _loop(micros()); // resync with seconds rollover
+  }
+   
+  // Method to read analogue hh*60+mm time 
+   int DS1307::_readAnalogue(VPIN vpin) { 
+    (void)vpin; 
+    return getTime()/60;
+  };
+

IO_DS1307.h

@@ -0,0 +1,54 @@
+/*
+ *  © 2024, Chris Harlow. All rights reserved.
+ *
+ *  This file is part of CommandStation-EX
+ *
+ *  This is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  It is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with CommandStation.  If not, see <https://www.gnu.org/licenses/>.
+*/
+
+/*
+* The IO_DS1307 device driver is used to interface a standalone realtime clock. 
+* The clock will announce every minute (which will trigger EXRAIL ONTIME events).
+* Seconds, and Day/date info is ignored, except that the announced hhmm time
+* will attempt to synchronize with the 0 seconds of the clock. 
+* An analog read in EXRAIL (IFGTE(vpin, value) etc will check against the hh*60+mm time.
+* The clock can be easily set by an analog write to the vpin using 24 hr clock time
+* with the command <z vpin hh mm ss> 
+*/
+
+#ifndef IO_DS1307_h
+#define IO_DS1307_h
+
+
+#include "IODevice.h"
+
+class DS1307 : public IODevice {
+public: 
+  static const bool debug=false; 
+  static void create(VPIN vpin, I2CAddress i2cAddress);
+ 
+    
+private:
+  
+  // Constructor
+    DS1307(VPIN vpin,I2CAddress i2cAddress);
+    uint32_t getTime();
+    void _begin() override;
+    void _display() override;
+    void _loop(unsigned long currentMicros) override;
+    int _readAnalogue(VPIN vpin) override;
+    void _writeAnalogue(VPIN vpin, int hh, uint8_t mm, uint16_t ss)  override;
+};
+ 
+#endif

version.h

@@ -3,7 +3,8 @@
 
 #include "StringFormatter.h"
 
-#define VERSION "5.5.1"
+#define VERSION "5.5.2"
+// 5.5.2  - DS1307 Real Time clock 
 // 5.5.1  - Momentum 
 // 5.5.0  - New version on devel
 // 5.4.0  - New version on master