* Location Logging
-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-07-23T21:49Z~
#+TITLE: Ninfacyzga-01 Manual
#+AUTHOR: Steven Baltakatei Sandoval
#+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~
+
** Narrative
Ninfacyzga-01 records (logs) its position in time and space using a
[[https://en.wikipedia.org/wiki/Satellite_navigation_device][GPS receiver]]. The NMEA location data produced by the receiver is
executable file contained within this repository at ~exec/bklog~. It
should be copied to ~$HOME/.local/bin~.
-~bkgpslog~ : A legacy bash script similar to ~bklog~ but narrower in
-scope in that it only records output from ~gpspipe~.
-
-~gpsd~ : A background daemon app capable of interfacing with the
-Ozzmaker BerryGPS-IMU's GPS submodule. Installed and initialized by
-~apt~.
+[[https://tracker.debian.org/pkg/gpsd][~gpsd~]] : A background daemon app capable of interfacing with the
+[[https://ozzmaker.com/berrygps-berrygps-imu-quick-start-guide/][Ozzmaker BerryGPS-IMU]]'s GPS submodule. Installed and initialized by
+~apt~. Should be installed along with the ~gpsd-clients~ package.
~gpspipe~ : A command line app that polls ~gpsd~ and produces a stream
stdout consisting of GPS data lines in NMEA format. Installed via
may be converted to this format using ~gpsbabel~.
**** Encryption Method
-Files produced by the bkgpslog script are encrypted against a set of
-public keys using [[https://github.com/FiloSottile/age][~age~]], a simple command line encryption tool
-selected over ~gpg~ because of ~age~'s deliberate lack of
-configurability.
-
-The public keys are bech32 strings supplied as options to bkgpslog
-when called. The secret key should *NOT* be stored in Ninfacyzga-01.
-
-If a key pair was generated using ~age-keygen~, then it is an [[https://en.wikipedia.org/wiki/Curve25519][~X25519~]]
-key pair. See the [[https://age-encryption.org/v1][~age~ Version 1 specification]].
-
-An ~ssh-rsa~ or ~ssh-ed25519~ SSH public key string may be used instead of
-the bech32 public key string produced by ~age-keygen~ for convenience.
-
-Help information for ~age~ is available by running ~$ age --help~.
-***** Encryption Commands
-****** Encryption through ~age~
-In order to illustrate how ~bklog~ encrypts files, below is an example
-command illustrating how ~age~ may be used to encrypt a file.
-
-#+BEGIN_EXAMPLE
-$ echo "asdf" | age -r \
-age1kza7pfshy7xwygf9349zgmk7x53mquvedgw9r98qwyyqhssh830qqjzlsw \
-> "$HOME/secret_file"
-#+END_EXAMPLE
-
-The resulting ~secret-file~ is a binary blob with a plaintext header
-indicating how the blob was encrypted (which version of age was used,
-which public key was used).
-
-****** Encryption through ~bklog~
-~bklog~ may instructed to encrypt files via the ~-e~ and ~-r [pubkey
-string]~ options. An example is shown below:
-
-#+BEGIN_EXAMPLE
-$ gpspipe -r | bklog -e \
--r age1kza7pfshy7xwygf9349zgmk7x53mquvedgw9r98qwyyqhssh830qqjzlsw \
--r age1ce3pvzrqfcn2pc6zqzglc8ac8yjk3fzukpy08cesqjjwns53xywqmaq7xw \
--r age1pu5usxm743sx7rf22985xv2f4s0luzv6r6yx4fa7p8c2zyvp9fvqus2xr5 \
--o "$HOME/Location"
-#+END_EXAMPLE
-
-~bklog~ may be instructed via the ~-e~ and ~-R~ options to watch a
-directory in order to locate public key strings in its files. ~bklog~
-reads the first line of each file and interprets it as a public key
-string.
-
-In this example, the strings beginning with ~age1...~ are
-bech32-formatted public key strings. Please see the [[*Key Generation][Key Generation]]
-section for an explanation.
-
-Since ~age~ also accepts ~ssh~ public key strings, these may also be
-used if they are of the following form (no comment).
-
-: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABA…AACAQDLnJbPs7CjwPT+OxXd
-
-***** Decryption Commands
-Files may be decrypted using a command similar to:
-
-#+BEGIN_EXAMPLE
-cat location.gpx.age | age -d -i key.txt > location.gpx
-#+END_EXAMPLE
-
-The version of ~age~ used to perform the encryption
+See [[file:../setup/README.org][Main Setup]] procedures.
** Operating Procedures
*** Initial Startup
See OEM (Ozzmaker) [[https://ozzmaker.com/berrygps-berrygps-imu-quick-start-guide/][quickstart guide for the BerryGPS-IMU]].
-
**** Physical Setup
BerryGPS-IMU must be electrically connected to the correct pins on the
**** Software Setup
***** Install Executables
+Follow the [[file:../setup/README.org][Main Setup]] procedures to obtain required files from this
+repository.
+
+Install ~gpsd~, ~gpsd-clients~, and ~gpsbabel~.
-Install Raspbian 10 Buster onto an SD card image. See the Raspberry Pi
-Foundation [[https://www.raspberrypi.org/documentation/installation/installing-images/README.md][installation instructions]]. Configure WiFi to permit log
-file transfer. Configure SSH to permit remote administration via the
-command line interface.
+: $ sudo apt install gpsd gpsd-clients gpsbabel
-Make sure to install the ~unattended-upgrades~ package to make sure
-the latest security patches for packages are installed. See [[https://linux-audit.com/using-unattended-upgrades-on-debian-and-ubuntu/][this page]]
-for a description of how ~unattended-upgrades~ works.
+***** Setup Serial for BerryGPS
+The Ozzmaker BerryGPS-IMU unit requires that the serial console be
+disabled and the serial port enabled. (see [[https://ozzmaker.com/berrygps-setup-guide-raspberry-pi/][ref]]).
-Install ~gpsd~, ~gpspipe~, ~git~, and this repository for location
-logging capability.
+: $ sudo raspi-config
-Install ~syncthing~ for log file transfer capability.
+Navigate to ~5 Interfacing Options~, then ~P6 Serial~.
-Place ~age~ binary (the one compiled for ARM CPU architecture for
-Linux) in ~$HOME/.local/bin~.
+When prompted "Would you like a login shell to be accessible over
+serial?", answer ~No~.
-***** Disable Swap File
-Since standard Raspbian 10 (Buster) install involves copying
-unencrypted file system image to SD card which is mounted by the
-Raspberry Pi, system memory may be written to disk in the form of a
-Swap file as described [[https://ideaheap.com/2013/07/stopping-sd-card-corruption-on-a-raspberry-pi/][here]]. In order to reduce the chance that
-location log data is ever written to disk, swap file functionality
-must be disabled[fn:ideaheap_20130731_disableswap].
+When prompted "Would you like the serial port hardware to be
+enabled?", answer ~Yes~.
-Raspbian 10 uses dphys-swapfile to manage a swap file. It may be
-disabled persistently[fn:rpf_20190702_disableswappersist] by running
-the following command:
+***** Setup ~gpsd~
+~gpsd~ needs to know which serial port to look at for NMEA location
+data generated by the GPS unit. This can be done by modifying the
+~gpsd~ configuration file at ~/etc/default/gpsd~.
-: sudo systemctl disable dphys-swapfile.service
+: sudo nano /etc/default/gpsd
-To view the status of the swap file in Raspbian 10, run ~free -m~:
+Make sure the following lines are present:
#+BEGIN_EXAMPLE
-pi@ninfacyzga-01:~$ free -m
- total used free shared buff/cache available
-Mem: 432 86 36 21 309 268
-Swap: 99 0 99
+START_DAEMON="true"
+USBAUTO="false"
+DEVICES="/dev/ttyAMA0"
+GPSD_OPTIONS="-n"
#+END_EXAMPLE
-After disabling the swap file and rebooting:
+NOTE: The ~DEVICES=~ line must be adjusted if the the ~ninfacyzga~
+device is configured to also track time.
-#+BEGIN_EXAMPLE
-pi@ninfacyzga-01:~$ free -m
- total used free shared buff/cache available
-Mem: 432 89 214 3 128 289
-Swap: 0 0 0
-#+END_EXAMPLE
+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~).
-[fn:ideaheap_20130731_disableswap] Explanation:
-https://ideaheap.com/2013/07/stopping-sd-card-corruption-on-a-raspberry-pi/
+Restart ~gpsd~ via:
-[fn:rpf_20190702_disableswappersist] Persistant disabling of swap in
-Raspbian 10 Buster:
-https://www.raspberrypi.org/forums/viewtopic.php?p=1490692&sid=5c596a124b7805d6b10dab8d3d7caf16#p1490692
+: $ sudo systemctl restart gpsd.service
-***** Automatic Start Configuration
+Run ~gpsmon~ to verify that location data is being recorded.
+: $ gpsmon
+
+***** Automatic Start Configuration
It is recommended to create a daily ~cron~ job that executes a bash
script that starts ~bklog~ jobs to record location along with other
types of data recording. An example of such a script is below:
: environment variable.
***** Log Transfer Configuration
+See [[file:../setup/README.org][Main Setup]] procedures.
+
Log files may be shared to other machines via ~syncthing~. See [[https://docs.syncthing.net/][this]]
manual for how to set up a shared folder and add Ninfacyzga-01 as a
device. Syncthing's directory synchronization capability allows a
of this document.
***** Key Generation
-An ~age~ encryption key may be generated like so:
-#+BEGIN_EXAMPLE
-$ umask # Gets current umask
-0022 # Note: This is the default umask for Raspbian 10
-$ umask 066 # So key.txt will have no perms except for owner (you)
-$ umask # Confirm umask set to 066
-0066
-$ age-keygen > key.txt
-Public key: age1pu5usxm743sx7rf22985xv2f4s0luzv6r6yx4fa7p8c2zyvp9fvqus2xr5
-$ ls -al key.txt
--rw------- 1 baltakatei baltakatei 184 Jun 29 18:28 key.txt
-$ umask 0022 # Return umask to default value
-$ umask
-0022
-#+END_EXAMPLE
-
-The resulting public/private keypair data looks like:
-#+BEGIN_EXAMPLE
-$ cat key.txt
-# created: 2020-06-29T18:01:56Z
-# public key: age1pu5usxm743sx7rf22985xv2f4s0luzv6r6yx4fa7p8c2zyvp9fvqus2xr5
-AGE-SECRET-KEY-1NEUU5U2XGZGL9UYWNPU5DL99TGJJHFSN4F2E2WCCSDJJ6L5ZMLESNTVTU0
-#+END_EXAMPLE
-
-The file ~key.txt~ is not password-protected by default and should be
-secured like an SSH public key should. The ~$ umask 066~ command run
-before the ~$ age-keygen > key.txt~ command ensures ~key.txt~ will not
-be readable, writeable, or executable to anyone except the owner
-(you).
+See [[file:../setup/README.org][Main Setup]] procedures.
*** Normal Startup
Turn on Ninfacyzga-01 by supplying 5VDC power to the Raspberry Pi. No
loss. Log files being written every 60 seconds means, at most, 60
seconds worth of location data may be lost.
*** End of Life Disposal
-LiPo batteries used by the PiZ Uptime 2.0 module should be disposed of
-properly with their potential ignitability in mind, especially if they
-are not fully discharged.
-
-Consult your local municipality for its "E-Waste Disposal" (or
-equivalent) policy. Metals used in the Raspberry Pi and related
-components may be recycled.
-
-Take extra precuation if lead solder was used in assembling the
-electronics. Consumer electronics in early 21st century should use
-lead-free solder.
+See [[file:../setup/README.org][Main Setup]] procedures.
projects / EVA-2020-02.git / blobdiff