fix(doc):Enforce relative paths in org files, misc fixes
authorSteven Baltakatei Sandoval <baltakatei@gmail.com>
Mon, 19 Oct 2020 03:46:53 +0000 (03:46 +0000)
committerSteven Baltakatei Sandoval <baltakatei@gmail.com>
Mon, 19 Oct 2020 03:46:53 +0000 (03:46 +0000)
doc/location/README.org
doc/time/README.org

index 07163d4ba3c1fa9d742443fc932fbdbef75f5879..d45fdae7d9182d0daa482720bb5d9f1f676f6923 100644 (file)
@@ -4,8 +4,8 @@
 #+EMAIL: baltakatei@gmail.com
 ** About
 This document was created by Steven Baltakatei Sandoval on
-~2020-06-29T12:14Z~ under a [[https://creativecommons.org/licenses/by-sa/4.0/][Creative Commons BY-SA 4.0 license]]. It
-was updated by Steven Baltakatei Sandoval on ~2020-10-16T23:32Z~
+~2020-06-29T12:14Z~ under a [[https://creativecommons.org/licenses/by-sa/4.0/][Creative Commons BY-SA 4.0 license]]. It was
+updated by Steven Baltakatei Sandoval on ~2020-10-18T00:13Z~
 
 ** Narrative
 Ninfacyzga-01 records (logs) its position in time and space using a
@@ -135,15 +135,19 @@ GPSD_OPTIONS="-n"
 #+END_EXAMPLE
 
 NOTE: The ~DEVICES=~ line must be adjusted if the the ~ninfacyzga~
-device is configured to also track time.
+device is configured to also track time. (See [[file:../time/README.org::*Setup%20~gpsd~][ref]]).
 
 NOTE: The ~-n~ option causes ~gpsd~ to begin polling GPS devices
 without waiting for a client to connect. This is important if ~gpsd~
 provides data to other applications (ex: ~gpspipe~, ~chrony~).
 
+Enable ~gpsd~ to run automatically via:
+
+: $ sudo systemctl enable gpsd
+
 Restart ~gpsd~ via:
 
-: $ sudo systemctl restart gpsd.service
+: $ sudo systemctl restart gpsd
 
 Run ~gpsmon~ to verify that location data is being recorded.
 
index ffb2210def1aa3dd6c3e1cf07bdbc5b385e93cb7..5351973dd06e28f25bd5a5cc8d724cbab4d313ec 100644 (file)
@@ -4,8 +4,8 @@
 * Time Tracking
 ** About
 This document was created by Steven Baltakatei Sandoval on
-~2020-07-23T22:27Z~ under a [[https://creativecommons.org/licenses/by-sa/4.0/][Creative Commons BY-SA 4.0 license]]. It
-was updated by Steven Baltakatei Sandoval on ~2020-10-17T23:31Z~
+~2020-07-23T22:27Z~ under a [[https://creativecommons.org/licenses/by-sa/4.0/][Creative Commons BY-SA 4.0 license]]. It was
+updated by Steven Baltakatei Sandoval on ~2020-10-18T00:11Z~
 
 ** Narrative
 The ~ninfacyzga-01~ device is equipped with an Ozzmaker BerryGPS-IMU
@@ -89,6 +89,7 @@ to expect PPS data on ~BCM 18~ (pin number 12; see [[https://pinout.xyz/][link]]
 by adding the following line to ~/boot/config.txt~ as described on
 [[https://ozzmaker.com/forums/topic/problems-with-pps-on-a-pi0w-running-raspian-and-attached-to-a-berrygps-imuv3/][this Ozzmaker page]]:
 
+: # Enable PPS on GPIO 18
 : dtoverlay=pps-gpio,gpiopin=18
 
 The ~/boot/config.txt~ file can be modified via:
@@ -116,13 +117,13 @@ Note: For older Raspberry Pi models, it may be necessary to enable
 The Ozzmaker BerryGPS-IMU makes NMEA sentences available via the
 serial "UART" device ~/dev/ttyAMA0~. If bluetooth has not been
 disabled, the Raspberry Pi OS automatically creates a software "UART"
-device at ~/dev/serial0~. See the "[[file:~/git-OC/ninfacyzga-01/doc/setup/README.org::*Disable%20Bluetooth][Disable Bluetooth]]" section in the
+device at ~/dev/serial0~. See the "[[file:../setup/README.org::*Disable%20Bluetooth][Disable Bluetooth]]" section in the
 [[file:../setup/README.org][Main Setup]] Initial Startup procedure for instructions on how to
 disable bluetooth to free up ~/dev/ttyAMA0~ for use by ~gpsd~.
 
 ***** Setup ~gpsd~
-See the "[[file:~/git-OC/ninfacyzga-01/doc/location/README.org::*Setup%20~gpsd~][Setup ~gpsd~]]" subsection within the "Initial Startup" section
-of the Location Logging [[file:~/git-OC/ninfacyzga-01/doc/location/README.org][~README.org~]] file. There is one additional
+See the "[[file:../location/README.org::*Setup%20~gpsd~][Setup ~gpsd~]]" subsection within the "Initial Startup" section
+of the Location Logging [[file:../location/README.org][~README.org~]] file. There is one additional
 change that must be made which is to add a ~/dev/pps0~ item to the
 ~DEVICES=~ line in ~/etc/default/gpsd~ like so:
 
@@ -175,10 +176,10 @@ incorrectly maps the GPS and PPS data.
 
 The following commands may be useful for testing ~gpsd~ and ~chrony~
 configurations.
-- ~sudo chronyc sources -v~ : Shows time sources and associated accuracy
+- ~chronyc sources -v~ : Shows time sources and associated accuracy
   information.
 
-- ~sudo chronyc tracking~ : Shows the current time difference between
+- ~chronyc tracking~ : Shows the current time difference between
   the reference clock and the system clock. Note: ~chrony~ gradually
   attempts to reduce the difference by changing the system clock.
 
@@ -194,7 +195,7 @@ configurations.
 
 - ~sudo systemctl restart chrony~ : Restart ~chrony~.
 
-- ~sudo systemctl status chrony~ : Check status of ~chrony~ service.
+- ~systemctl status chrony~ : Check status of ~chrony~ service.
 
 - ~sudo ntpshmmon~ : Shows live output of data using the shared memory
   driver filled by ~gpsd~. ([[https://gpsd.gitlab.io/gpsd/gpsd-time-service-howto.html][ref]])
@@ -327,3 +328,4 @@ makestep 1 3
 refclock SHM 0 refid GPS precision 1e-1 offset 0.0000 delay 0.2 stratum 1
 refclock SHM 1 refid PPS precision 1e-7 stratum 1
 #+END_EXAMPLE
+