Skip to content

Commit fae5f42

Browse files
PaulZCPaulZC
committed
Initial commit - very WIP
0 parents  commit fae5f42

File tree

10 files changed

+993
-0
lines changed

10 files changed

+993
-0
lines changed

‎.gitattributes

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Auto detect text files and perform LF normalization
2+
* text=auto

‎.github/workflows/compile-sketch.yml

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
name: Cross-compilation
2+
3+
on:
4+
# - push
5+
- pull_request
6+
- workflow_dispatch
7+
8+
jobs:
9+
compile-sketch:
10+
runs-on: ubuntu-latest
11+
12+
strategy:
13+
fail-fast: false
14+
15+
matrix:
16+
board:
17+
# Uno
18+
# https://github.com/arduino/ArduinoCore-avr/blob/master/boards.txt
19+
- fqbn: arduino:avr:mega
20+
platforms: |
21+
- name: arduino:avr
22+
source-url: https://downloads.arduino.cc/packages/package_index.json
23+
24+
# ESP32
25+
# https://github.com/espressif/arduino-esp32/blob/master/boards.txt
26+
- fqbn: esp32:esp32:esp32
27+
platforms: |
28+
- name: esp32:esp32
29+
source-url: https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
30+
31+
# ESP32-S2
32+
# https://github.com/espressif/arduino-esp32/blob/master/boards.txt
33+
- fqbn: esp32:esp32:esp32s2
34+
platforms: |
35+
- name: esp32:esp32
36+
source-url: https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
37+
38+
# ESP32-C3
39+
# https://github.com/espressif/arduino-esp32/blob/master/boards.txt
40+
- fqbn: esp32:esp32:esp32c3
41+
platforms: |
42+
- name: esp32:esp32
43+
source-url: https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
44+
45+
# Artemis / Apollo3
46+
# https://github.com/sparkfun/Arduino_Apollo3/blob/main/boards.txt
47+
- fqbn: SparkFun:apollo3:sfe_artemis_atp
48+
platforms: |
49+
- name: SparkFun:apollo3
50+
source-url: https://raw.githubusercontent.com/sparkfun/Arduino_Apollo3/master/package_sparkfun_apollo3_index.json
51+
52+
# ESP8266
53+
# https://github.com/esp8266/Arduino/blob/master/boards.txt
54+
- fqbn: esp8266:esp8266:thingdev
55+
platforms: |
56+
- name: esp8266:esp8266
57+
source-url: https://arduino.esp8266.com/stable/package_esp8266com_index.json
58+
59+
# SAMD21
60+
# https://github.com/arduino/ArduinoCore-samd/blob/master/boards.txt
61+
- fqbn: arduino:samd:mkr1000
62+
platforms: |
63+
- name: arduino:samd
64+
# source-url: https://downloads.arduino.cc/packages/package_index.json
65+
66+
# Nano BLE 33 / nRF52840
67+
# https://github.com/arduino/ArduinoCore-mbed/blob/master/boards.txt
68+
- fqbn: arduino:mbed:nano33ble
69+
platforms: |
70+
- name: arduino:mbed
71+
# source-url: https://downloads.arduino.cc/packages/package_index.json
72+
73+
# RP2040
74+
# https://github.com/arduino/ArduinoCore-mbed/blob/master/boards.txt
75+
- fqbn: rp2040:rp2040:sparkfun_promicrorp2040
76+
platforms: |
77+
- name: rp2040:rp2040
78+
source-url: https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json
79+
80+
# STM32
81+
# https://github.com/arduino/ArduinoCore-mbed/blob/master/boards.txt
82+
- fqbn: STMicroelectronics:stm32:GenF4
83+
platforms: |
84+
- name: STMicroelectronics:stm32
85+
source-url: https://github.com/stm32duino/BoardManagerFiles/raw/main/package_stmicroelectronics_index.json
86+
87+
steps:
88+
- name: Checkout
89+
uses: actions/checkout@v3
90+
91+
- name: Branch name
92+
run: echo running on branch ${GITHUB_REF##*/}
93+
94+
- name: Compile Sketch
95+
uses: arduino/[email protected]
96+
with:
97+
github-token: ${{ secrets.GITHUB_TOKEN }}
98+
platforms: ${{ matrix.board.platforms }}
99+
fqbn: ${{ matrix.board.fqbn }}
100+
libraries: |
101+
- source-path: ./
102+
# Add library dependencies here:
103+
- source-url: https://github.com/sparkfun/SparkFun_Toolkit.git
104+
# - name: name-of-library-registered-with-arduino-library-manager
105+
sketch-paths: |
106+
- examples/Example05_AlternateAddress
107+
enable-warnings-report: true
108+
enable-deltas-report: true
109+
verbose: true
110+
111+
# outputs:
112+
# report-artifact-name: ${{ steps.report-artifact-name.outputs.report-artifact-name }}
113+

‎.gitignore

Lines changed: 220 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,220 @@
1+
#################
2+
## SparkFun Useful stuff
3+
#################
4+
5+
## AVR Development
6+
*.eep
7+
*.elf
8+
*.lst
9+
*.lss
10+
*.sym
11+
*.d
12+
*.o
13+
*.srec
14+
*.map
15+
16+
## Notepad++ backup files
17+
*.bak
18+
19+
## BOM files
20+
*bom*
21+
22+
## VSCode directories
23+
.vscode
24+
25+
#################
26+
## Eclipse
27+
#################
28+
29+
*.pydevproject
30+
.project
31+
.metadata
32+
bin/
33+
tmp/
34+
*.tmp
35+
*.bak
36+
*.swp
37+
*~.nib
38+
local.properties
39+
.classpath
40+
.settings/
41+
.loadpath
42+
43+
# External tool builders
44+
.externalToolBuilders/
45+
46+
# Locally stored "Eclipse launch configurations"
47+
*.launch
48+
49+
# CDT-specific
50+
.cproject
51+
52+
# PDT-specific
53+
.buildpath
54+
55+
56+
#############
57+
## Eagle
58+
#############
59+
60+
# Ignore the board and schematic backup files and lock files
61+
*.b#?
62+
*.s#?
63+
*.l#?
64+
*.lck
65+
66+
67+
#############
68+
## KiCad
69+
#############
70+
71+
*cache.lib
72+
*.kicad_pcb-bak
73+
*.net
74+
*.gbr
75+
*.drl
76+
77+
78+
#################
79+
## Visual Studio
80+
#################
81+
82+
## Ignore Visual Studio temporary files, build results, and
83+
## files generated by popular Visual Studio add-ons.
84+
85+
# User-specific files
86+
*.suo
87+
*.user
88+
*.sln.docstates
89+
90+
# Build results
91+
[Dd]ebug/
92+
[Rr]elease/
93+
*_i.c
94+
*_p.c
95+
*.ilk
96+
*.meta
97+
*.obj
98+
*.pch
99+
*.pdb
100+
*.pgc
101+
*.pgd
102+
*.rsp
103+
*.sbr
104+
*.tlb
105+
*.tli
106+
*.tlh
107+
*.tmp
108+
*.vspscc
109+
.builds
110+
*.dotCover
111+
112+
## TODO: If you have NuGet Package Restore enabled, uncomment this
113+
#packages/
114+
115+
# Visual C++ cache files
116+
ipch/
117+
*.aps
118+
*.ncb
119+
*.opensdf
120+
*.sdf
121+
122+
# Visual Studio profiler
123+
*.psess
124+
*.vsp
125+
126+
# ReSharper is a .NET coding add-in
127+
_ReSharper*
128+
129+
# Installshield output folder
130+
[Ee]xpress
131+
132+
# DocProject is a documentation generator add-in
133+
DocProject/buildhelp/
134+
DocProject/Help/*.HxT
135+
DocProject/Help/*.HxC
136+
DocProject/Help/*.hhc
137+
DocProject/Help/*.hhk
138+
DocProject/Help/*.hhp
139+
DocProject/Help/Html2
140+
DocProject/Help/html
141+
142+
# Click-Once directory
143+
publish
144+
145+
# Others
146+
[Bb]in
147+
[Oo]bj
148+
sql
149+
TestResults
150+
*.Cache
151+
ClientBin
152+
stylecop.*
153+
~$*
154+
*.dbmdl
155+
Generated_Code #added for RIA/Silverlight projects
156+
157+
# Backup & report files from converting an old project file to a newer
158+
# Visual Studio version. Backup files are not needed, because we have git ;-)
159+
_UpgradeReport_Files/
160+
Backup*/
161+
UpgradeLog*.XML
162+
163+
164+
############
165+
## Windows
166+
############
167+
168+
# Windows image file caches
169+
Thumbs.db
170+
171+
# Folder config file
172+
Desktop.ini
173+
174+
175+
#############
176+
## Mac OS
177+
#############
178+
179+
.DS_Store
180+
181+
182+
#############
183+
## Linux
184+
#############
185+
186+
# backup files (*.bak on Win)
187+
*~
188+
189+
190+
#############
191+
## Python
192+
#############
193+
194+
*.py[co]
195+
196+
# Packages
197+
*.egg
198+
*.egg-info
199+
dist
200+
build
201+
eggs
202+
parts
203+
bin
204+
var
205+
sdist
206+
develop-eggs
207+
.installed.cfg
208+
209+
# Installer logs
210+
pip-log.txt
211+
212+
# Unit test / coverage reports
213+
.coverage
214+
.tox
215+
216+
#Translations
217+
*.mo
218+
219+
#Mr Developer
220+
.mr.developer.cfg

‎LICENSE

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

‎README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
SparkFun SiT5358 DCTCXO Arduino Library
2+
========================================
3+
4+
<table class="table table-hover table-striped table-bordered">
5+
<tr align="center">
6+
<td><a href="https://www.sparkfun.com/products/26289"><img src="" alt="Standard"></a></td>
7+
</tr>
8+
<tr align="center">
9+
<td><a href="https://www.sparkfun.com/products/26289">SparkFun RTK mosaic-T</a></td>
10+
</tr>
11+
</table>
12+
13+
This is an Arduino Library for the SiT5358 Digitally-Controlled Temperature-Compensated Crystal Oscillator from SiTime.
14+
It allows you to fully configure the oscillator over I<sup>2</sup>C.
15+
Examples are provided which show how to control the frequency and pull range.
16+
17+
Note: this library needs the [SparkFun Toolkit](https://github.com/sparkfun/SparkFun_Toolkit).
18+
19+
Repository Contents
20+
-------------------
21+
22+
* **/.github/workflows** - GitHub workflow actions files
23+
* **/examples** - Arduino examples for the ADS1219
24+
* **/src** - Library source files (.cpp & .h)
25+
26+
License Information
27+
-------------------
28+
29+
This product is _**open source**_!
30+
31+
Please review the LICENSE.md file for license information.
32+
33+
If you have any questions or concerns on licensing, please contact technical support on our [SparkFun forums](https://community.sparkfun.com/).
34+
35+
Distributed as-is; no warranty is given.
36+
37+
- Your friends at SparkFun.

0 commit comments

Comments
 (0)