doc(various):Move common setup instructions to dedicatd README
[EVA-2020-02.git] / README.org
1 * Environment Sensor ninfacyzga-01
2 ** Introduction
3 This document created by Steven Baltakatei Sandoval on
4 2020-06-07T21:56Z under a [[http://creativecommons.org/licenses/by-sa/4.0/][CC BY-SA 4.0]] license and last updated on
5 2020-07-23T22:26Z.
6 ** Abstract
7 This git repository contains software and documentation necessary to
8 set up a sensor package for logging observables in the local
9 environment.
10
11 Collected sensor data include:
12
13 - Location (GPS WGS84)
14 - Time (via ~gpsd~)
15 - Air Pressure (pascals)
16 - Alignment (degrees X, degrees Y, degrees from magnetic north)
17
18 ** Setup
19
20 See the following documents for instructions on setting up hardware
21 for each type of data collected.
22
23 *** Location
24
25 See the location [[file:doc/location/README.org][readme]].
26
27 *** Pressure
28
29 See the pressure [[file:doc/pressure/README.org][readme]].
30
31 *** Alignment
32
33 See the alignment [[file:doc/alignment/README.org][readme]].
34
35 ** Name Etymology
36
37 *** Origin
38
39 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
40 fatci zgana". The three gismu in the tanru contain the following
41 meanings:
42
43 **** ~cnino~: new
44 **** ~fatci~: fact
45 **** ~zgana~: observe
46
47 *** Meaning
48
49 Hence, the primary mission of a ~ninfacyzga~ device is to observe facts
50 of the new. The primary mission is NOT to process facts into
51 stories. Neither is the primary mission to network with other devices
52 for the purpose of sharing information. This means a ~ninfacyzga~
53 device records data about the environment but does not attempt to
54 generate summaries or reports of archived data as a historian
55 would. Instead, the device simply transmits what it sees (ex: camera),
56 hears (ex: microphone), feels (ex: accelerometer, gyroscope, or
57 magnetometer), smells (ex: gas detector), etc.
58
59 The observations of a ~nincafyzga~ device are the input of another
60 class of devices called ~temlisru'e~ whose primary mission is to
61 process observations into stories over time.
62
63 The transmission and verification of observations and analyses
64 produced by ~ninfacyzga~ or ~temlisru'e~ devices is managed by another
65 class of devices called ~calkuptcana~.
66
67 *** Pronunciation
68
69 ~ninfacyzga~ is pronounced ~/ninfaʃəzga/~.
70
71 ~temlisru'e~ is pronounced ~/tɛmlisruhe/~.
72
73 ~calkuptcana~ is pronounced ~/ʃalkuptʃana/~.
74
75 ** Directory structure
76
77 Directories in this repository are structured as follows:
78
79 - ~doc~: Contains documentation explaining in human-readable format
80 what each file does.
81
82 - ~archive~: Contains legacy files from previous iterations of the
83 project.
84
85 - ~exec~: Contains executable components of the project.
86
87 ** References
88
89 1. "Lojban". 2020-02-12. [[https://mw.lojban.org/papri/Logical_Language_Group]["Logical Language Group"]]. Date Accessed:
90 2020-06-07. [[https://web.archive.org/web/20200304102316/https://mw.lojban.org/papri/Logical_Language_Group][Archive link]]. Archive date: 2020-03-04.
91
92 2. "lujvo". 2014-09-30. [[https://mw.lojban.org/papri/Logical_Language_Group]["Logical Language Group"]]. Date Accessed:
93 2020-06-07. [[https://web.archive.org/web/20160401100124/https://mw.lojban.org/papri/lujvo][Archive link]]. Archive date: 2016-04-01.