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