Initial commit - very WIP

Author: PaulZC

.gitignore

@@ -0,0 +1,220 @@
+#################
+## SparkFun Useful stuff
+#################
+
+## AVR Development
+*.eep
+*.elf
+*.lst
+*.lss
+*.sym
+*.d
+*.o
+*.srec
+*.map
+
+## Notepad++ backup files
+*.bak
+
+## BOM files
+*bom*
+
+## VSCode directories
+.vscode
+
+#################
+## Eclipse
+#################
+
+*.pydevproject
+.project
+.metadata
+bin/
+tmp/
+*.tmp
+*.bak
+*.swp
+*~.nib
+local.properties
+.classpath
+.settings/
+.loadpath
+
+# External tool builders
+.externalToolBuilders/
+
+# Locally stored "Eclipse launch configurations"
+*.launch
+
+# CDT-specific
+.cproject
+
+# PDT-specific
+.buildpath
+
+
+#############
+## Eagle
+#############
+
+# Ignore the board and schematic backup files and lock files
+*.b#?
+*.s#?
+*.l#?
+*.lck
+
+
+#############
+## KiCad
+#############
+
+*cache.lib
+*.kicad_pcb-bak
+*.net
+*.gbr
+*.drl
+
+
+#################
+## Visual Studio
+#################
+
+## Ignore Visual Studio temporary files, build results, and
+## files generated by popular Visual Studio add-ons.
+
+# User-specific files
+*.suo
+*.user
+*.sln.docstates
+
+# Build results
+[Dd]ebug/
+[Rr]elease/
+*_i.c
+*_p.c
+*.ilk
+*.meta
+*.obj
+*.pch
+*.pdb
+*.pgc
+*.pgd
+*.rsp
+*.sbr
+*.tlb
+*.tli
+*.tlh
+*.tmp
+*.vspscc
+.builds
+*.dotCover
+
+## TODO: If you have NuGet Package Restore enabled, uncomment this
+#packages/
+
+# Visual C++ cache files
+ipch/
+*.aps
+*.ncb
+*.opensdf
+*.sdf
+
+# Visual Studio profiler
+*.psess
+*.vsp
+
+# ReSharper is a .NET coding add-in
+_ReSharper*
+
+# Installshield output folder
+[Ee]xpress
+
+# DocProject is a documentation generator add-in
+DocProject/buildhelp/
+DocProject/Help/*.HxT
+DocProject/Help/*.HxC
+DocProject/Help/*.hhc
+DocProject/Help/*.hhk
+DocProject/Help/*.hhp
+DocProject/Help/Html2
+DocProject/Help/html
+
+# Click-Once directory
+publish
+
+# Others
+[Bb]in
+[Oo]bj
+sql
+TestResults
+*.Cache
+ClientBin
+stylecop.*
+~$*
+*.dbmdl
+Generated_Code #added for RIA/Silverlight projects
+
+# Backup & report files from converting an old project file to a newer
+# Visual Studio version. Backup files are not needed, because we have git ;-)
+_UpgradeReport_Files/
+Backup*/
+UpgradeLog*.XML
+
+
+############
+## Windows
+############
+
+# Windows image file caches
+Thumbs.db
+
+# Folder config file
+Desktop.ini
+
+
+#############
+## Mac OS
+#############
+
+.DS_Store
+
+
+#############
+## Linux
+#############
+
+# backup files (*.bak on Win)
+*~
+
+
+#############
+## Python
+#############
+
+*.py[co]
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+
+#Translations
+*.mo
+
+#Mr Developer
+.mr.developer.cfg

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 SparkFun Electronics
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,37 @@
+SparkFun STP3593LF OCXO Arduino Library 
+========================================
+
+<table class="table table-hover table-striped table-bordered">
+    <tr align="center">
+        <td><a href="https://www.sparkfun.com/products/26289"><img src="" alt="Standard"></a></td>
+    </tr>
+    <tr align="center">
+        <td><a href="https://www.sparkfun.com/products/26289">SparkFun GNSSDO</a></td>
+    </tr>
+</table>
+
+This is an Arduino Library for the STP3593LF (ROX5242T1N) Digitally-Controlled Double-Oven Crystal Oscillator from rakon.
+It allows you to fully configure the oscillator over I<sup>2</sup>C.
+Examples are provided which show how to control the frequency.
+
+Note: this library needs the [SparkFun Toolkit](https://github.com/sparkfun/SparkFun_Toolkit).
+
+Repository Contents
+-------------------
+
+* **/.github/workflows** - GitHub workflow actions files
+* **/examples** - Arduino examples for the STP3593LF
+* **/src** - Library source files (.cpp & .h)
+
+License Information
+-------------------
+
+This product is _**open source**_! 
+
+Please review the LICENSE.md file for license information. 
+
+If you have any questions or concerns on licensing, please contact technical support on our [SparkFun forums](https://community.sparkfun.com/).
+
+Distributed as-is; no warranty is given.
+
+- Your friends at SparkFun.

examples/Example01_AlternateAddress/Example01_AlternateAddress.ino

@@ -0,0 +1,57 @@
+/*
+  Using alternate I2C addresses for the STP3593LF OCXO.
+
+  This example shows how to use an alternate address and TwoWire port for the OCXO.
+
+  By: Paul Clark
+  SparkFun Electronics
+  Date: 2024/11/21
+  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_STP3593LF.h> // Click here to get the library: http://librarymanager/All#SparkFun_STP3593LF
+
+SfeSTP3593LFArdI2C myOCXO;
+
+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 STP3593LF Example");
+
+  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
+
+  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
+  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()
+{
+  // Nothing to do here
+}

examples/Example02_setFrequencyHz/Example02_setFrequencyHz.ino

@@ -0,0 +1,57 @@
+/*
+  Set the frequency of the STP3593LF OCXO.
+
+  By: Paul Clark
+  SparkFun Electronics
+  Date: 2024/11/21
+  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_STP3593LF.h> // Click here to get the library: http://librarymanager/All#SparkFun_STP3593LF
+
+SfeSTP3593LFArdI2C myOCXO;
+
+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 STP3593LF Example");
+
+  Wire.begin(); // Begin the I2C bus
+
+  if (!myOCXO.begin())
+  {
+    Serial.println("STP3593LF not detected! Please check the address and try again...");
+    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.setFrequencyHz(10000010.0); // Set the frequency to 10.000010MHz (+1ppm)
+
+  Serial.print("Frequency set to ");
+  Serial.print(myOCXO.getFrequencyHz());
+  Serial.println(" Hz");
+
+  // Frequency control word should be 1ppm / 800ppm * (2^38 - 1) , rounded down
+  Serial.print("Frequency control word should be 343597383. It is ");
+  Serial.println(myOCXO.getFrequencyControlWord());
+}
+
+void loop()
+{
+  // Nothing to do here
+}