PrincessPi/Precision-Timekeeping-Fuckery
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

migration

Browse Source
This commit is contained in:
Princess Pi
2026-05-26 20:41:02 -06:00
parent 51d096f856
commit 24387ef1e0
18 changed files with 380 additions and 380 deletions
Download Patch File Download Diff File Expand all files Collapse all files
old/DOCS.md
+105 -105
View File
@@ -1,106 +1,106 @@
## Install
### Hardware Needed
1. Raspberry Pi of any type
2. Timing Specific GPS Module [U-BLOX ublox LEA-M8T-0-10 HUAWEI GPS Module](https://www.ebay.com/itm/134243322249)
3. High Precision RTC Module like [Adafruit DS3231 Precision RTC Breakout](https://www.adafruit.com/product/3013)
4. CR1220 Battery for RTC
5. Female to Female jumper/dupont wires
6. Raspberry Pi Case that Exposes GPIO
7. (GPS Antenna)[https://www.aliexpress.us/item/3256808971033962.html]
8. (Cable for GPS Antenna)[https://www.amazon.com/Superbat-coaxial-Bulkhead-Adapter-Equipment/dp/B07FC8PVZS?th=1]
9. (GPS Antenna Adaptor)[https://www.amazon.com/dp/B00CVR4NN0]
10. UART
11. Solder Supplies (maybe)
### Configuring Hardware
1. Install (u-center)[https://www.u-blox.com/en/product/u-center] NOT u-center 2
2. Wire UART of GPS Module to your UART
1. Change baudrate to 115200
2. enable timing mode?
3. change cable delay to calculated value
### Wiring Everything Up
#### GPS Module
1. GPS GND to RPi Physical Pin 6 (GND)
2. GPS RX to RPi Physical Pin 8 (GPIO 14 / TX (UART))
3. GPS TX to RPi Physical Pin 10 (GPIO 15 / RX (UART))
4. GPS PPS to RPi Physical Pin 12 (GPIO 18)
5. GPS VIN to RPi Physical Pin 27 (3.3 volts)
#### RTC Module
1. RTC GND to Rpi Physical Pin 9 (GND)
3. RTC SDA to RPi Physical Pin 3 (GPIO 2 / SDA1 (I2C))
4. RTC SCL to RPi Physical Pin 5 (GPIO 4 / SCL1 (I2C))
5. RTC VCC to RPi Physical Pin 1 (3.3 volts)
### Setup Pi
#### Microsd Card
1. Install [Raspberry Pi Imager](https://www.raspberrypi.com/software/) on your PC
2. Insert Microsd card to your PC
3. Run Raspberry Pi Imager
1. Choose Device (your Raspberry Pi Type)
2. Choose OS->Raspberry Pi OS (other)->Raspberry Pi OS Lite (64-bit)
3. Choose Storage (your Microsd card)
4. Configure settings as you like them
5. Burn
#### Login to Raspberry Pi
1. `curl -s https://raw.githubusercontent.com/PrincessPi3/Precision-Timekeeping-Fuckery/refs/heads/main/installer_auto.sh?nocache=$RANDOM | $SHELL`
2. `cd ~/Precision-Timekeeping-Fuckery && git pull; bash installer1.sh` (will reboot)
3. `cd ~/Precision-Timekeeping-Fuckery && git pull; bash installer2.sh` (will reboot)
4. `cd ~/Precision-Timekeeping-Fuckery && git pull; bash installer3.sh` (will reboot)
5. `cd ~/Precision-Timekeeping-Fuckery && git pull; bash installer4.sh` (will reboot)
6. `curl -s https://gitlab.com/princesspi/general-scripts-and-system-ssssssetup/-/raw/master/customscripts/install_script.sh?nocache=$RANDOM | sudo $SHELL`
7. `exec $SHELL`
8. `configure_webhook.sh`
9. `sudo reboot`
10. Grafana
1. open grafana web interface in a browser: `http://<ip>:3000`
2. username `admin` password `admin`
3. set new password
4. Dashboards->Import
1. Upload Garfana-Visualization.json
5. edit each graph and just save
11. After 24 Hours
1. `cd ~/Precision-Timekeeping-Fuckery`
2. `bash services.sh stop`
3. `bash nuke_logs.sh`
4. `bash reconfig_full.sh ./running-warn-level-conf`
5. `sudo reboot`
## Scripts
* `uninstall.sh` uninstalls everything
* `chrony_statistics.sh` uses the python script chrony_statistics.py and feeds it copies of tracking statistics to calculate offset
*`cleanup.sh` remove old files
* `dump_configs.sh` make a backup of all configs
* `full_status.sh` show status of all of the componants of Precision-Timekeeping-Fuckery one by one
* `installer_auto.sh` script to initialize the install, it is run first
* usage: `curl -s https://raw.githubusercontent.com/PrincessPi3/Precision-Timekeeping-Fuckery/refs/heads/main/installer_auto.sh?nocache=$RANDOM | $SHELL`
* `installer1.sh` first manual installer script. runs rpi-config and optionall rpi-update
* `installer2.sh` second manual installer script. performs a dist-upgrade and an autoremove
* `installer3.sh` third manual installer script. adds grafana and telegram repos, uninstalls and disables unneeded junk, installs packages, adds pps-gpio to /etc/modules if not there, autoremove, gives users the right groups
* `installer4.sh` final manual installer script. runs `reconfig_full.sh` and enables the services on boot
* `nuke_logs.sh` does just what it says on the tin
* `reconfig_full.sh` reconfigures services in one of the directories
* usage: `bash reconfig_full.sh <config_directory>`
* `services.sh` runs an operation on all of the relevant services
* usage: `bash services.sh [start|status|stop|restart|reload|enable|disable]`
* `show_running_configs.sh` shows the current config files, one by one
* `cable-delay-calc.xlsx` spreadsheet to estimate cable delay in ns
## Files
* `status.txt` this shows the progress of an ongoing install, it is automatically created at the start and deleted at the end
* `CHANGEOG.txt` this is all the latest changes
* `version.txt` version of Precision-Timekeeping-Fuckery
## Logs
### Chrony Logs
* `sudo tail -f /var/log/chrony/tracking.log`
* `sudo tail -f /var/log/chrony/statistics.log`
* `sudo tail -f /var/log/chrony/measurements.log`
### Telegraf Logs
* `sudo tail -f /var/log/telegraf/telegraf.log`
### Grafana Logs
* `sudo tail -f /var/log/grafana/grafana.log`
### Influxdb Logs
* `sudo tail -f /var/log/syslog`
### Root Crontab Logs
## Install
### Hardware Needed
1. Raspberry Pi of any type
2. Timing Specific GPS Module [U-BLOX ublox LEA-M8T-0-10 HUAWEI GPS Module](https://www.ebay.com/itm/134243322249)
3. High Precision RTC Module like [Adafruit DS3231 Precision RTC Breakout](https://www.adafruit.com/product/3013)
4. CR1220 Battery for RTC
5. Female to Female jumper/dupont wires
6. Raspberry Pi Case that Exposes GPIO
7. (GPS Antenna)[https://www.aliexpress.us/item/3256808971033962.html]
8. (Cable for GPS Antenna)[https://www.amazon.com/Superbat-coaxial-Bulkhead-Adapter-Equipment/dp/B07FC8PVZS?th=1]
9. (GPS Antenna Adaptor)[https://www.amazon.com/dp/B00CVR4NN0]
10. UART
11. Solder Supplies (maybe)
### Configuring Hardware
1. Install (u-center)[https://www.u-blox.com/en/product/u-center] NOT u-center 2
2. Wire UART of GPS Module to your UART
1. Change baudrate to 115200
2. enable timing mode?
3. change cable delay to calculated value
### Wiring Everything Up
#### GPS Module
1. GPS GND to RPi Physical Pin 6 (GND)
2. GPS RX to RPi Physical Pin 8 (GPIO 14 / TX (UART))
3. GPS TX to RPi Physical Pin 10 (GPIO 15 / RX (UART))
4. GPS PPS to RPi Physical Pin 12 (GPIO 18)
5. GPS VIN to RPi Physical Pin 27 (3.3 volts)
#### RTC Module
1. RTC GND to Rpi Physical Pin 9 (GND)
3. RTC SDA to RPi Physical Pin 3 (GPIO 2 / SDA1 (I2C))
4. RTC SCL to RPi Physical Pin 5 (GPIO 4 / SCL1 (I2C))
5. RTC VCC to RPi Physical Pin 1 (3.3 volts)
### Setup Pi
#### Microsd Card
1. Install [Raspberry Pi Imager](https://www.raspberrypi.com/software/) on your PC
2. Insert Microsd card to your PC
3. Run Raspberry Pi Imager
1. Choose Device (your Raspberry Pi Type)
2. Choose OS->Raspberry Pi OS (other)->Raspberry Pi OS Lite (64-bit)
3. Choose Storage (your Microsd card)
4. Configure settings as you like them
5. Burn
#### Login to Raspberry Pi
1. `curl -s https://raw.githubusercontent.com/PrincessPi3/Precision-Timekeeping-Fuckery/refs/heads/main/installer_auto.sh?nocache=$RANDOM | $SHELL`
2. `cd ~/Precision-Timekeeping-Fuckery && git pull; bash installer1.sh` (will reboot)
3. `cd ~/Precision-Timekeeping-Fuckery && git pull; bash installer2.sh` (will reboot)
4. `cd ~/Precision-Timekeeping-Fuckery && git pull; bash installer3.sh` (will reboot)
5. `cd ~/Precision-Timekeeping-Fuckery && git pull; bash installer4.sh` (will reboot)
6. `curl -s https://gitlab.com/princesspi/general-scripts-and-system-ssssssetup/-/raw/master/customscripts/install_script.sh?nocache=$RANDOM | sudo $SHELL`
7. `exec $SHELL`
8. `configure_webhook.sh`
9. `sudo reboot`
10. Grafana
1. open grafana web interface in a browser: `http://<ip>:3000`
2. username `admin` password `admin`
3. set new password
4. Dashboards->Import
1. Upload Garfana-Visualization.json
5. edit each graph and just save
11. After 24 Hours
1. `cd ~/Precision-Timekeeping-Fuckery`
2. `bash services.sh stop`
3. `bash nuke_logs.sh`
4. `bash reconfig_full.sh ./running-warn-level-conf`
5. `sudo reboot`
## Scripts
* `uninstall.sh` uninstalls everything
* `chrony_statistics.sh` uses the python script chrony_statistics.py and feeds it copies of tracking statistics to calculate offset
*`cleanup.sh` remove old files
* `dump_configs.sh` make a backup of all configs
* `full_status.sh` show status of all of the componants of Precision-Timekeeping-Fuckery one by one
* `installer_auto.sh` script to initialize the install, it is run first
* usage: `curl -s https://raw.githubusercontent.com/PrincessPi3/Precision-Timekeeping-Fuckery/refs/heads/main/installer_auto.sh?nocache=$RANDOM | $SHELL`
* `installer1.sh` first manual installer script. runs rpi-config and optionall rpi-update
* `installer2.sh` second manual installer script. performs a dist-upgrade and an autoremove
* `installer3.sh` third manual installer script. adds grafana and telegram repos, uninstalls and disables unneeded junk, installs packages, adds pps-gpio to /etc/modules if not there, autoremove, gives users the right groups
* `installer4.sh` final manual installer script. runs `reconfig_full.sh` and enables the services on boot
* `nuke_logs.sh` does just what it says on the tin
* `reconfig_full.sh` reconfigures services in one of the directories
* usage: `bash reconfig_full.sh <config_directory>`
* `services.sh` runs an operation on all of the relevant services
* usage: `bash services.sh [start|status|stop|restart|reload|enable|disable]`
* `show_running_configs.sh` shows the current config files, one by one
* `cable-delay-calc.xlsx` spreadsheet to estimate cable delay in ns
## Files
* `status.txt` this shows the progress of an ongoing install, it is automatically created at the start and deleted at the end
* `CHANGEOG.txt` this is all the latest changes
* `version.txt` version of Precision-Timekeeping-Fuckery
## Logs
### Chrony Logs
* `sudo tail -f /var/log/chrony/tracking.log`
* `sudo tail -f /var/log/chrony/statistics.log`
* `sudo tail -f /var/log/chrony/measurements.log`
### Telegraf Logs
* `sudo tail -f /var/log/telegraf/telegraf.log`
### Grafana Logs
* `sudo tail -f /var/log/grafana/grafana.log`
### Influxdb Logs
* `sudo tail -f /var/log/syslog`
### Root Crontab Logs
* `sudo tail -f /var/log/root-crontab.log`
old/conf-level-warn/boot-firmware-config.txt
+9 -9
View File
@@ -1,10 +1,10 @@
# Precision Timekeeping Fuckery Additions
## GPS PPS GPIO Signal
dtoverlay=pps-gpio,gpiopin=18
## GPS GPIO UART
enable_uart=1
init_uart_baud=9600
## I2C Hardware RTC Overlay
dtoverlay=i2c-rtc,ds3231
# Precision Timekeeping Fuckery Additions
## GPS PPS GPIO Signal
dtoverlay=pps-gpio,gpiopin=18
## GPS GPIO UART
enable_uart=1
init_uart_baud=9600
## I2C Hardware RTC Overlay
dtoverlay=i2c-rtc,ds3231
# End Precision Timekeeping Fuckery Additions
old/conf-level-warn/hwclock-set
+1 -1
View File
@@ -1,2 +1,2 @@
#!/bin/sh
#!/bin/sh
# dev=$1
old/debug-level-conf/boot-firmware-config.txt
+11 -11
View File
@@ -1,12 +1,12 @@
# Precision Timekeeping Fuckery Additions
## GPS PPS GPIO Signal
dtoverlay=pps-gpio,gpiopin=18
## GPS GPIO UART
enable_uart=1
init_uart_baud=115200
## I2C Hardware RTC Overlay
dtoverlay=i2c-rtc,ds3231
# Precision Timekeeping Fuckery Additions
## GPS PPS GPIO Signal
dtoverlay=pps-gpio,gpiopin=18
## GPS GPIO UART
enable_uart=1
init_uart_baud=115200
## I2C Hardware RTC Overlay
dtoverlay=i2c-rtc,ds3231
# End Precision Timekeeping Fuckery Additions
old/debug-level-conf/hwclock-set
+1 -1
View File
@@ -1,2 +1,2 @@
#!/bin/sh
#!/bin/sh
dev=$1
old/info-level-conf/boot-firmware-config.txt
+11 -11
View File
@@ -1,12 +1,12 @@
# Precision Timekeeping Fuckery Additions
## GPS PPS GPIO Signal
dtoverlay=pps-gpio,gpiopin=18
## GPS GPIO UART
enable_uart=1
init_uart_baud=115200
## I2C Hardware RTC Overlay
dtoverlay=i2c-rtc,ds3231
# Precision Timekeeping Fuckery Additions
## GPS PPS GPIO Signal
dtoverlay=pps-gpio,gpiopin=18
## GPS GPIO UART
enable_uart=1
init_uart_baud=115200
## I2C Hardware RTC Overlay
dtoverlay=i2c-rtc,ds3231
# End Precision Timekeeping Fuckery Additions
old/info-level-conf/hwclock-set
+1 -1
View File
@@ -1,2 +1,2 @@
#!/bin/sh
#!/bin/sh
dev=$1
old/notes-scratch-old.txt
+60 -60
View File
@@ -1,61 +1,61 @@
rtc module
ds3231
product page: https://www.adafruit.com/product/3013
product tutorial: https://learn.adafruit.com/adafruit-ds3231-precision-rtc-breakout/overview
install packages python3-smbus i2c-tools
enable i2c support in raspi-config
interfacing options->i2c->
enable <Yes>
kernel module loaded by default <Yes>
check that i2c-dev is in /etc/modules
add `dtoverlay=i2c-rtc,ds3231` to /boot/firmware/config.txt
reboot
detect/test module `sudo i2cdetect -y 1`
looking for address UU AFTER configure Overlay
looking for address 68 BEFORE configure overlay
remove package fake-hwclock
remove from rc
read rtc `sudo hwclock -r`
set rtc `sudo hwclock -w`
raspberry pi RTC tutorial: https://learn.adafruit.com/adding-a-real-time-clock-to-raspberry-pi/set-rtc-time
pinout: https://learn.adafruit.com/adafruit-ds3231-precision-rtc-breakout/pinouts
battery: CR1220
chipset product page: https://www.analog.com/en/products/ds3231.html
chipset datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/DS3231.pdf
chipset reliability report: https://www.analog.com/media/en/technical-documentation/reliability-data/ds3231.pdf
notes:
https://serverfault.com/questions/1093101/chrony-hosting-time-with-rtc-as-authoritative-clock-on-an-air-gapped-isolated?__cf_chl_tk=G_sZX4ClltOv3fQJpH1q2a65tx4O2s_H_FObeBQ2UyU-1749831141-1.0.1.1-W0v5fl8cCrf0tIpB0pAqIb93L5MuoWeebiHm7iLGAlo
https://stackoverflow.com/questions/49730407/how-to-do-one-shot-time-sync-using-chrony
do oneshot sync?
script set every x seconds
`sudo hwclock -r`
GPS module
baudrates
1. 115200 // working
2. 230400
3. 460800
cable delay
cable is 10ft? RG-174?
14.3
velocity factors of cable forms
RG-58: VF ≈ 0.66 (66% of the speed of light)
RG-174: VF ≈ 0.70
LMR-200: VF ≈ 0.83
LMR-400: VF ≈ 0.85
formula
CD = time in nanoseconds of cable delay
L = Length of cable in UNIT
DF = delay factor in UNIT )speed of light in a vaccum used in nanoseconds per UNIT)
3.33 = ns (nanoseconds per meter)
1.016 = feet (feet per meter)
VF = velocity factor of cable (above)
CD ≈ (L*DF)/VF
CD ≈ (Length (meters) * 3.33 (baseline light speed in a vaccum ns/m)) / Velocity Factor of cable (VF)
derriving the speed of light offset
t(ns) = time in nanoseconds
c = speed of light in a vaccum in meters per second (3*(10^8) m/s)
d(m) = distance to travel in meters
rtc module
ds3231
product page: https://www.adafruit.com/product/3013
product tutorial: https://learn.adafruit.com/adafruit-ds3231-precision-rtc-breakout/overview
install packages python3-smbus i2c-tools
enable i2c support in raspi-config
interfacing options->i2c->
enable <Yes>
kernel module loaded by default <Yes>
check that i2c-dev is in /etc/modules
add `dtoverlay=i2c-rtc,ds3231` to /boot/firmware/config.txt
reboot
detect/test module `sudo i2cdetect -y 1`
looking for address UU AFTER configure Overlay
looking for address 68 BEFORE configure overlay
remove package fake-hwclock
remove from rc
read rtc `sudo hwclock -r`
set rtc `sudo hwclock -w`
raspberry pi RTC tutorial: https://learn.adafruit.com/adding-a-real-time-clock-to-raspberry-pi/set-rtc-time
pinout: https://learn.adafruit.com/adafruit-ds3231-precision-rtc-breakout/pinouts
battery: CR1220
chipset product page: https://www.analog.com/en/products/ds3231.html
chipset datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/DS3231.pdf
chipset reliability report: https://www.analog.com/media/en/technical-documentation/reliability-data/ds3231.pdf
notes:
https://serverfault.com/questions/1093101/chrony-hosting-time-with-rtc-as-authoritative-clock-on-an-air-gapped-isolated?__cf_chl_tk=G_sZX4ClltOv3fQJpH1q2a65tx4O2s_H_FObeBQ2UyU-1749831141-1.0.1.1-W0v5fl8cCrf0tIpB0pAqIb93L5MuoWeebiHm7iLGAlo
https://stackoverflow.com/questions/49730407/how-to-do-one-shot-time-sync-using-chrony
do oneshot sync?
script set every x seconds
`sudo hwclock -r`
GPS module
baudrates
1. 115200 // working
2. 230400
3. 460800
cable delay
cable is 10ft? RG-174?
14.3
velocity factors of cable forms
RG-58: VF ≈ 0.66 (66% of the speed of light)
RG-174: VF ≈ 0.70
LMR-200: VF ≈ 0.83
LMR-400: VF ≈ 0.85
formula
CD = time in nanoseconds of cable delay
L = Length of cable in UNIT
DF = delay factor in UNIT )speed of light in a vaccum used in nanoseconds per UNIT)
3.33 = ns (nanoseconds per meter)
1.016 = feet (feet per meter)
VF = velocity factor of cable (above)
CD ≈ (L*DF)/VF
CD ≈ (Length (meters) * 3.33 (baseline light speed in a vaccum ns/m)) / Velocity Factor of cable (VF)
derriving the speed of light offset
t(ns) = time in nanoseconds
c = speed of light in a vaccum in meters per second (3*(10^8) m/s)
d(m) = distance to travel in meters
t(ns) = d(m)/c
old/running-warn-level-conf/boot-firmware-config.txt
+11 -11
View File
@@ -1,12 +1,12 @@
# Precision Timekeeping Fuckery Additions
## GPS PPS GPIO Signal
dtoverlay=pps-gpio,gpiopin=18
## GPS GPIO UART
enable_uart=1
init_uart_baud=115200
## I2C Hardware RTC Overlay
dtoverlay=i2c-rtc,ds3231
# Precision Timekeeping Fuckery Additions
## GPS PPS GPIO Signal
dtoverlay=pps-gpio,gpiopin=18
## GPS GPIO UART
enable_uart=1
init_uart_baud=115200
## I2C Hardware RTC Overlay
dtoverlay=i2c-rtc,ds3231
# End Precision Timekeeping Fuckery Additions
old/running-warn-level-conf/hwclock-set
+1 -1
View File
@@ -1,2 +1,2 @@
#!/bin/sh
#!/bin/sh
dev=$1
old/warn-level-conf/boot-firmware-config.txt
+11 -11
View File
@@ -1,12 +1,12 @@
# Precision Timekeeping Fuckery Additions
## GPS PPS GPIO Signal
dtoverlay=pps-gpio,gpiopin=18
## GPS GPIO UART
enable_uart=1
init_uart_baud=115200
## I2C Hardware RTC Overlay
dtoverlay=i2c-rtc,ds3231
# Precision Timekeeping Fuckery Additions
## GPS PPS GPIO Signal
dtoverlay=pps-gpio,gpiopin=18
## GPS GPIO UART
enable_uart=1
init_uart_baud=115200
## I2C Hardware RTC Overlay
dtoverlay=i2c-rtc,ds3231
# End Precision Timekeeping Fuckery Additions
old/warn-level-conf/hwclock-set
+11 -11
View File
@@ -1,12 +1,12 @@
#!/bin/sh
# Reset the System Clock to UTC if the hardware clock from which it
# was copied by the kernel was in localtime.
dev=$1
# if [ -e /run/systemd/system ] ; then
# exit 0
# fi
# /sbin/hwclock --rtc=$dev --systz
#!/bin/sh
# Reset the System Clock to UTC if the hardware clock from which it
# was copied by the kernel was in localtime.
dev=$1
# if [ -e /run/systemd/system ] ; then
# exit 0
# fi
# /sbin/hwclock --rtc=$dev --systz
# /sbin/hwclock --rtc=$dev --hctosys