Tested with the emulator

Author: PaulZC

examples/Example01_AlternateAddress/Example01_AlternateAddress.ino

@@ -31,24 +31,20 @@ void setup()
   Wire.begin(); // Begin the I2C bus
 
   bool begun;
-  begun = myOCXO.begin(Wire, 0x50); // Initialize the STP3593LF - using a custom bus and address
-  begun = myOCXO.begin(0x50); // This is also possible. It defaults to Wire
-  begun = myOCXO.begin(); // This is also possible. It defaults to Wire and address 0x50
+  begun = myOCXO.begin(Wire, 0x70); // Initialize the STP3593LF - using a custom bus and address
+  begun = myOCXO.begin(0x70); // This is also possible. It defaults to Wire
+  begun = myOCXO.begin(); // This is also possible. It defaults to Wire and address 0x70
 
   if (!begun)
   {
     Serial.println("STP3593LF not detected! Please check the address and try again...");
     while (1); // Do nothing more
   }
 
-  // Read the frequency control word - should be zero initially
+  // Read the frequency control word - should be ~500000 initially?
   int64_t fcw = myOCXO.getFrequencyControlWord();
   Serial.print("The frequency control word is: ");
   Serial.println(fcw);
-
-  // Read the available (clipped) pull range
-  double pullAvailable = myOCXO.getMaxPullAvailable();
-  Serial.printf("Maximum frequency pull is: %e\r\n", pullAvailable);
 }
 
 void loop()

examples/Example04_setFrequencyByBiasMillis/Example04_setFrequencyByBiasMillis.ino renamed to examples/Example02_setFrequencyByBiasMillis/Example02_setFrequencyByBiasMillis.ino

@@ -10,32 +10,17 @@
   SparkFun code, firmware, and software is released under the MIT License.
   Please see LICENSE.md for further details.
 
-  Consider the STP3593LFAI-KYG33IV-10.000000:
-  The operating temperature range is Industrial, -40 to 85°C (option "I").
-  LVCMOS output (option "-").
-  Frequency stability +/-1ppb (option "Y").
-  It is DCOCXO with a configurable I2C address (option "G").
-  Supply voltage 3.3V (option "33").
-  Pin 1 is Output Enable (option "I"). (No software OE control).
-  The pull range limit is 3.125ppm (option "V").
-  Base frequency is 10.000000MHz.
-
   Consider this example:
-  * The OCXO frequency has not yet been changed. It is running at the default 10.000000 MHz.
-  * 10.000000 MHZ is the library default base frequency. But we could set it with setBaseFrequencyHz(10000000.0)
-  * The available pull range is read during begin.
   * The mosaic-T manual states that the oscillator frequency should be changed by no more than 3ppb per second.
   * We tell the library this using setMaxFrequencyChangePPB(3.0)
   * The GNSS RxClkBias reports that receiver time is ahead of system time by 200 nanoseconds (+200ns).
   * We instruct the library to change the frequency using setFrequencyByBiasMillis(200.0e-6)
-  * The OCXO clock period is 100ns.
+  * The OCXO clock period is ~100ns.
   * The 200ns bias corresponds to 2 clock cycles.
-  * To remove that bias in one second, the oscillator frequency would need to be reduced to 9.999998 MHz.
+  * To remove that bias in one second, the oscillator frequency would need to be reduced to 9999998 Hz.
   * That is a change of 2 parts in 10000000, or 0.2ppm, or 200ppb.
   * The frequency change will be limited to 3ppb.
-  * Since the STP3593LF maximum Pull Range is 800ppm, and the Pull Register is 39-bit signed, 3ppb corresponds to 1030792 LSB.
-  * The firmware writes the value -1030792 to the Frequency Control Register, reducing the frequency to 9.99999997 MHz.
-  * getFrequencyHz will return 9999999.97
+  * Since the resolution of the frequency control word is 8E-13, the frequency control word should decrease by 3750
 
 */
 
@@ -64,31 +49,24 @@ void setup()
     while (1); // Do nothing more
   }
 
-  myOCXO.setBaseFrequencyHz(10000000.0); // Pass the oscillator base frequency into the driver
-
-  Serial.print("Base frequency set to ");
-  Serial.print(myOCXO.getBaseFrequencyHz());
-  Serial.println(" Hz");
-
   myOCXO.setMaxFrequencyChangePPB(3.0); // Set the maximum frequency change in PPB
 
   Serial.print("Maximum frequency change set to ");
   Serial.print(myOCXO.getMaxFrequencyChangePPB());
   Serial.println(" PPB");
 
-  Serial.print("Frequency control word should be 0. It is ");
-  Serial.println(myOCXO.getFrequencyControlWord());
+  uint32_t controlWord = myOCXO.getFrequencyControlWord();
+  Serial.print("Frequency control word is currently ");
+  Serial.println(controlWord);
 
   Serial.println("Applying a clock bias of +200ns");
   // Set the frequency by clock bias (+200ns, +200e-6ms)
   // For this test, set the P term to 1.0 and the I term to 0.0
   myOCXO.setFrequencyByBiasMillis(200.0e-6, 1.0, 0.0);
 
-  Serial.print("Frequency should be 9999999.97 Hz. It is ");
-  Serial.print(myOCXO.getFrequencyHz());
-  Serial.println(" Hz");
-
-  Serial.print("Frequency control word should be -1030792. It is ");
+  Serial.print("Frequency control word should be ");
+  Serial.print(controlWord - 3750); // See notes above
+  Serial.print(". It is ");
   Serial.println(myOCXO.getFrequencyControlWord());
 }
 

examples/Example02_setFrequencyHz/Example02_setFrequencyHz.ino

@@ -9,33 +9,31 @@
 
   Note: This code doesn't update the registerAddress correctly - on ESP32 (3.0.1).
         registerAddress is only updated _after_ the registers have been read...
-        SfeSTP3593LFDriver::begin() calls readClipRegister() and readRegisters()
-        twice, to ensure registerAddress points at 0x00 and 0x0C correctly.
 
 */
 
 #include <Wire.h>
 
-#define I2C_DEV_ADDR 0x50
+#define I2C_DEV_ADDR 0x70
 
-// Emulate registers 0x00 (DCXO Clip) to 0x0E (DCXO LSW) (16-bit, MSB first)
-#define CLIP 0x00 // Change to (e.g.) 0x08 to emulate 200ppm clip range. 
-#define NUM_REG_BYTES (15*2)
-volatile uint8_t registerBytes[NUM_REG_BYTES];
+// Emulate a single 32-bit register for reading and writing
+// Although, in reality, data is read from 0x41 and written to 0xA0
+#define NUM_REG_BYTES (4)
+volatile uint8_t registerBytes[NUM_REG_BYTES] = { 0x00, 0x07, 0xA1, 0x20 }; // Default to 500000 (MSB first)
 volatile uint8_t registerAddress = 0;
 
 // On Request:
-// Write bytes from registerBytes, starting at registerAddress * 2
+// Write bytes from registerBytes
 void requestHandler()
 {
-  int i = registerAddress * 2;
-  for (; i < NUM_REG_BYTES; i++)
+  // Ignore registerAddress
+  for (int i = 0; i < NUM_REG_BYTES; i++)
     Wire.write(registerBytes[i]);
 }
 
 // On Receive:
 // Copy the first incoming byte into registerAddress (see notes above)
-// Copy the remaining bytes into registerBytes, starting at registerAddress * 2
+// Copy the remaining bytes into registerBytes
 void receiveHandler(int len)
 {
   int count = -1;
@@ -48,8 +46,9 @@ void receiveHandler(int len)
         registerAddress = b;
         break;
       default:
-        if (((registerAddress * 2) + count) < NUM_REG_BYTES)
-          registerBytes[((registerAddress * 2) + count)] = b;
+        // Ignore registerAddress
+        if (count < NUM_REG_BYTES)
+          registerBytes[count] = b;
         break;
     }
     count++;
@@ -58,11 +57,6 @@ void receiveHandler(int len)
 
 void setup()
 {
-  // Initialize the register bytes
-  for (int i = 0; i < NUM_REG_BYTES; i++)
-    registerBytes[i] = 0;
-  registerBytes[0] = CLIP; // Store in OCXO Clip MSB
-
   delay(1000); // Allow time for the microcontroller to start up
 
   Serial.begin(115200); // Begin the Serial console
@@ -85,23 +79,13 @@ void loop()
   {
     lastPrint = millis();
 
-    // Extract the 39-bit Frequency Control Word
-    uint64_t freqControl = ((uint64_t)registerBytes[28]) >> 1;
-    freqControl |= ((uint64_t)registerBytes[27]) << 7;
-    freqControl |= ((uint64_t)registerBytes[26]) << 15;
-    freqControl |= ((uint64_t)registerBytes[25]) << 23;
-    freqControl |= ((uint64_t)registerBytes[24]) << 31;
-    if (freqControl & 0x0000004000000000) // Correct two's complement
-      freqControl |= 0xFFFFFFC000000000;
+    // Extract the Frequency Control Word
+    uint32_t freqControl = ((uint32_t)registerBytes[0]) << 24;
+    freqControl |= ((uint32_t)registerBytes[1]) << 16;
+    freqControl |= ((uint32_t)registerBytes[2]) <<  8;
+    freqControl |= ((uint32_t)registerBytes[3]) <<  0;
 
-    union // Avoid any ambiguity when converting uint64_t to int64_t
-    {
-        uint64_t unsigned64;
-        int64_t signed64;
-    } unsignedSigned64;
-    unsignedSigned64.unsigned64 = freqControl;
-
     Serial.print("Frequency control is ");
-    Serial.println(unsignedSigned64.signed64);
+    Serial.println(freqControl);
   }
 }

examples/Example03_IllegalFrequency/Example03_IllegalFrequency.ino

@@ -13,19 +13,15 @@ SfeSTP3593LFArdI2C	KEYWORD1
 #######################################
 
 begin	KEYWORD2
-readClipRegister	KEYWORD2
-readRegisters	KEYWORD2
+readFrequencyControlWord	KEYWORD2
 getFrequencyControlWord	KEYWORD2
 setFrequencyControlWord	KEYWORD2
-getPullRangeClip	KEYWORD2
-getMaxPullRange	KEYWORD2
 getBaseFrequencyHz	KEYWORD2
 setBaseFrequencyHz	KEYWORD2
-getFrequencyHz	KEYWORD2
-setFrequencyHz	KEYWORD2
 getMaxFrequencyChangePPB	KEYWORD2
 setMaxFrequencyChangePPB	KEYWORD2
 setFrequencyByBiasMillis	KEYWORD2
+saveFrequencyControlValue	KEYWORD2
 
 #######################################
 # Constants (LITERAL1)