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