chore(README):Update main readme.

[EVA-2020-02.git] / README.org

* Environment Sensor ninfacyzga-01
** Introduction
This document created by Steven Baltakatei Sandoval on
2020-06-07T21:56Z under a [[http://creativecommons.org/licenses/by-sa/4.0/][CC BY-SA 4.0]] license and last updated on
2020-10-16T23:10Z.

** Abstract
This git repository contains software and documentation necessary to
set up a sensor package for logging observables in the local
environment.

Collected sensor data include:

- Location (GPS WGS84)
- Time (via ~gpsd~ and ~ntpsec~)
- Air Pressure (pascals)
- Alignment (degrees X, degrees Y, degrees from magnetic north)

** Setup
See the following documents for instructions on setting up hardware
for each type of data collected.

- [[file:doc/location/README.org][Location]]
- [[file:doc/time/README.org][Time]]
- [[file:doc/pressure/README.org][Pressure]]
- [[file:doc/alignment/README.org][Alignment]]

** Name Etymology
*** Origin
The name ~ninfacyzga~ is a [[https://mw.lojban.org/papri/Logical_Language_Group][lojban]] [[https://mw.lojban.org/papri/lujvo][lujvo]] consisting of the tanru "cnino
fatci zgana". The three gismu in the tanru contain the following
meanings:

**** ~cnino~: new
**** ~fatci~: fact
**** ~zgana~: observe

*** Meaning
Hence, the primary mission of a ~ninfacyzga~ device is to observe facts
of the new. The primary mission is NOT to process facts into
stories. Neither is the primary mission to network with other devices
for the purpose of sharing information. This means a ~ninfacyzga~
device records data about the environment but does not attempt to
generate summaries or reports of archived data as a historian
would. Instead, the device simply transmits what it sees (ex: camera),
hears (ex: microphone), feels (ex: accelerometer, gyroscope, or
magnetometer), smells (ex: gas detector), etc.

The observations of a ~nincafyzga~ device are the input of another
class of devices called ~temlisru'e~ whose primary mission is to
process observations into stories over time.

The transmission and verification of observations and analyses
produced by ~ninfacyzga~ or ~temlisru'e~ devices is managed by another
class of devices called ~calkuptcana~.

*** Pronunciation
~ninfacyzga~ is pronounced ~/ninfaʃəzga/~.

~temlisru'e~ is pronounced ~/tɛmlisruhe/~.

~calkuptcana~ is pronounced ~/ʃalkuptʃana/~.

** Directory structure
Directories in this repository are structured as follows:

- ~doc~: Contains documentation explaining in human-readable format
  what each file does.

- ~archive~: Contains legacy files from previous iterations of the
  project.
  
- ~exec~: Contains executable components of the project.

** References
1. "Lojban". 2020-02-12. [[https://mw.lojban.org/papri/Logical_Language_Group]["Logical Language Group"]]. Date Accessed:
   2020-06-07. [[https://web.archive.org/web/20200304102316/https://mw.lojban.org/papri/Logical_Language_Group][Archive link]]. Archive date: 2020-03-04.

2. "lujvo". 2014-09-30. [[https://mw.lojban.org/papri/Logical_Language_Group]["Logical Language Group"]]. Date Accessed:
   2020-06-07. [[https://web.archive.org/web/20160401100124/https://mw.lojban.org/papri/lujvo][Archive link]]. Archive date: 2016-04-01.