Compiling. TODO: setFrequencyByBiasMillis

Author: PaulZC

.github/workflows/compile-sketch.yml

@@ -103,7 +103,7 @@ jobs:
             - source-url: https://github.com/sparkfun/SparkFun_Toolkit.git
             # - name: name-of-library-registered-with-arduino-library-manager
           sketch-paths: |
-            - examples/Example05_AlternateAddress
+            - examples/Example01_AlternateAddress
           enable-warnings-report: true
           enable-deltas-report: true
           verbose: true

examples/Example01_AlternateAddress/Example01_AlternateAddress.ino

@@ -13,9 +13,9 @@
 
 // You will need the SparkFun Toolkit. Click here to get it: http://librarymanager/All#SparkFun_Toolkit
 
-#include <SparkFun_ADS1219.h> // Click here to get the library: http://librarymanager/All#SparkFun_ADS1219
+#include <SparkFun_SiT5358.h> // Click here to get the library: http://librarymanager/All#SparkFun_SiT5358
 
-SfeADS1219ArdI2C myADC;
+SfeSiT5358ArdI2C myTCXO;
 
 void setup()
 {
@@ -26,34 +26,33 @@ void setup()
   {
     delay(100); // Wait for the user to open the Serial Monitor
   }
-  Serial.println("SparkFun ADS1219 Example");
+  Serial.println("SparkFun SiT5358 Example");
 
   Wire.begin(); // Begin the I2C bus
 
   bool begun;
-  begun = myADC.begin(Wire, 0x4F); // Initialize the ADC - using a custom bus and address - see notes above
-  begun = myADC.begin(0x4F); // This is also possible. It defaults to Wire
+  begun = myTCXO.begin(Wire, 0x60); // Initialize the SiT5358 - using a custom bus and address
+  begun = myTCXO.begin(0x60); // This is also possible. It defaults to Wire
+  begun = myTCXO.begin(); // This is also possible. It defaults to Wire and address 0x60
 
   if (!begun)
   {
-    Serial.println("ADC not detected! Please check the address and try again...");
+    Serial.println("SiT5358 not detected! Please check the address and try again...");
     while (1); // Do nothing more
   }
 
-  Serial.println("Reading the differential voltage between AIN0 (+) and AIN1 (-)");
+  // Read the frequency control word - should be zero initially
+  int32_t fcw = myTCXO.getFrequencyControlWord();
+  Serial.print("The frequency control word is: ");
+  Serial.println(fcw);
+
+  // Read the pull range control
+  uint8_t prc = myTCXO.getPullRangeControl();
+  Serial.print("Pull range control is: ");
+  Serial.println(myTCXO.getPullRangeControlText(prc));
 }
 
 void loop()
 {
-  myADC.startSync(); // Start a single-shot conversion.
-
-  while (myADC.dataReady() == false) // Check if the conversion is complete. This will return true if data is ready.
-  {
-    delay(10); // The conversion is not complete. Wait a little to avoid pounding the I2C bus.
-  }
-
-  myADC.readConversion(); // Read the conversion result from the ADC. Store it internally.
-  int32_t sample = myADC.getConversionRaw(); // Get the raw ADC value. Note: this is NOT adjusted for gain.
-  Serial.print("Raw ADC value: ");
-  Serial.println(sample); // Print the raw ADC value
+  // Nothing to do here
 }

examples/Example02_setFrequencyHz/Example02_setFrequencyHz.ino

@@ -0,0 +1,61 @@
+/*
+  Set the frequency of the SiT5358 DCTCXO.
+
+  By: Paul Clark
+  SparkFun Electronics
+  Date: 2024/8/1
+  SparkFun code, firmware, and software is released under the MIT License.
+  Please see LICENSE.md for further details.
+
+*/
+
+// You will need the SparkFun Toolkit. Click here to get it: http://librarymanager/All#SparkFun_Toolkit
+
+#include <SparkFun_SiT5358.h> // Click here to get the library: http://librarymanager/All#SparkFun_SiT5358
+
+SfeSiT5358ArdI2C myTCXO;
+
+void setup()
+{
+  delay(1000); // Allow time for the microcontroller to start up
+
+  Serial.begin(115200); // Begin the Serial console
+  while (!Serial)
+  {
+    delay(100); // Wait for the user to open the Serial Monitor
+  }
+  Serial.println("SparkFun SiT5358 Example");
+
+  Wire.begin(); // Begin the I2C bus
+
+  if (!myTCXO.begin())
+  {
+    Serial.println("SiT5358 not detected! Please check the address and try again...");
+    while (1); // Do nothing more
+  }
+
+  myTCXO.setBaseFrequencyHz(10000000.0); // Pass the oscillator base frequency into the driver
+
+  Serial.print("Base frequency set to ");
+  Serial.println(myTCXO.getBaseFrequencyHz());
+  Serial.println(" Hz");
+
+  myTCXO.setPullRangeControl(SiT5358_PULL_RANGE_200ppm); // Set the pull range control to 200ppm
+
+  Serial.print("Pull range control set to ");
+  Serial.println(myTCXO.getPullRangeControlText(myTCXO.getPullRangeControl()));
+
+  myTCXO.setFrequencyHz(10001000.0); // Set the frequency to 10.001MHz (+100ppm)
+
+  Serial.print("Frequency set to ");
+  Serial.print(myTCXO.getFrequencyHz());
+  Serial.println(" Hz");
+
+  Serial.print("Frequency control word should be 16777216. It is ");
+  Serial.println(myTCXO.getFrequencyControlWord());
+}
+
+void loop()
+{
+  // Nothing to do here
+}