Repository navigation
Expand file tree
/
Copy pathindex.html
More file actions
213 lines (200 loc) · 12.6 KB
/
Copy pathindex.html
File metadata and controls
213 lines (200 loc) · 12.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>NINA — Network Inspector & Notification Assistant</title>
<meta name="description" content="NINA is the DREAM Robotics fleet's caretaker: she watches every robot, says what's wrong and why, and writes it to RIFT's mission log.">
<meta name="color-scheme" content="dark">
<meta property="og:title" content="NINA — Network Inspector & Notification Assistant">
<meta property="og:description" content="The fleet's caretaker: health checks, reboot and mode-change detection, spoken alerts.">
<meta property="og:type" content="website">
<meta property="og:image" content="images/nina_avatar.jpg">
<link rel="icon" href="site/favicon.ico" sizes="any">
<link rel="apple-touch-icon" href="site/apple-touch-icon.png">
<link rel="stylesheet" href="site/style.css">
<script src="site/site.js" defer></script>
</head>
<body>
<nav aria-label="Primary">
<div class="wrap">
<a class="brand" href="#top">NINA</a>
<ul>
<li><a href="#overview">Overview</a></li>
<li><a href="#checks">Checks</a></li>
<li><a href="#settings">Settings</a></li>
<li><a href="#api">API</a></li>
<li><a href="#quickstart">Quick start</a></li>
<li><a href="https://github.com/CursedPrograms/NINA">GitHub</a></li>
</ul>
</div>
</nav>
<header class="hero" id="top">
<div class="wrap">
<div class="eyebrow">Cursed Entertainment</div>
<h1>NINA</h1>
<p class="tagline">Network Inspector & Notification Assistant</p>
<p class="lede">The fleet's caretaker. NINA watches every robot and tells you what's wrong, and why, before you have to go looking: who went offline, who rebooted, whose web page is so slow it froze her, and which mode change nobody made.</p>
<div class="cta">
<a class="btn primary" href="https://github.com/CursedPrograms/NINA">View on GitHub</a>
<a class="btn" href="#quickstart">Quick start</a>
<a class="btn" href="https://ko-fi.com/cursedentertainment">Support on Ko-fi</a>
</div>
<div class="tags" aria-label="Technologies">
<span class="tag">Python</span>
<span class="tag">Flask</span>
<span class="tag">pygame</span>
<span class="tag">Windows TTS</span>
<span class="tag">MIT License</span>
</div>
<figure class="avatar">
<img src="images/nina_avatar.jpg" alt="NINA's avatar: a retro nurse in a crimson dress with headphones and a red-cross cap" width="768" height="768">
<figcaption>NINA · avatar</figcaption>
</figure>
</div>
</header>
<main>
<section id="overview">
<div class="wrap">
<h2>Overview</h2>
<h3 class="title">Every robot, looked after</h3>
<div class="grid cols-3">
<div class="card">
<span class="k">Watch</span>
<h4>The whole fleet</h4>
<p>Every robot RIFT knows, checked every few seconds: answering or not, and how fast. Two misses in a row and she says it's offline; she says when it's back, too.</p>
</div>
<div class="card">
<span class="k">Diagnose</span>
<h4>Causes, not just symptoms</h4>
<p>Each problem comes with a likely reason: “NORA isn't answering — this PC is on another network”, or “NORA rebooted — check what was just switched on”.</p>
</div>
<div class="card">
<span class="k">Speak</span>
<h4>Out loud</h4>
<p>The important things are spoken with Windows text-to-speech and written to RIFT's mission log, so nothing slips by while you're working on a robot.</p>
</div>
<div class="card">
<span class="k">NORA</span>
<h4>A closer look at the hub</h4>
<p>NORA runs the network, so NINA watches her uptime for reboots, her drive mode and who changed it, and how long her web page takes to send.</p>
</div>
<div class="card">
<span class="k">Ports</span>
<h4>Hands off the boards</h4>
<p>Serial ports are listed, never opened: opening a port resets an Arduino and fights the program that owns it. She guesses which board each one is.</p>
</div>
<div class="card">
<span class="k">Fleet</span>
<h4>One of the robots</h4>
<p>She registers with RIFT like everyone else, so she's on the dashboard and in MILA's list, and she joins the Brainfuck conversations in her own pitch.</p>
</div>
<div class="card">
<span class="k">Checkups</span>
<h4>How are you?</h4>
<p>She asks every robot how it is — moving or still, turning, wheels locked, music, mode — and watches its distance sensors. One stuck on a value gets a checkup: <em>are you standing still?</em> Moving: she tells you. Still: she moves it a little and measures, like a doctor.</p>
</div>
<div class="card">
<span class="k">TINA</span>
<h4>Keeps TINA posted</h4>
<p>Everything she notices goes to TINA as it happens, with a snapshot of the fleet every 30 s, so TINA starts every job knowing who’s up and how they are.</p>
</div>
<div class="card">
<span class="k">RIFT</span>
<h4>Says when she's lost</h4>
<p>If registering with RIFT stops working she says so — a 404 means something else is on RIFT’s port.</p>
</div>
</div>
</div>
</section>
<section id="checks">
<div class="wrap">
<h2>Checks</h2>
<h3 class="title">What she looks at, and why</h3>
<div class="table-wrap">
<table>
<thead><tr><th>What</th><th>How</th><th>What it catches</th></tr></thead>
<tbody>
<tr><td>Fleet</td><td class="mono">RIFT /fleet, then each robot's /ping</td><td>Offline, back online, slow to answer (over 2 s)</td></tr>
<tr><td>NORA uptime</td><td class="mono">:5002/talk → now</td><td>Reboots: uptime falling back to zero, e.g. a power dip from the UV light or motors</td></tr>
<tr><td>NORA mode</td><td class="mono">:5002/sensors → mode, msrc</td><td>Mode changes, and ones no web page, Bluetooth app or remote made</td></tr>
<tr><td>NORA's page</td><td class="mono">:5002/ once a minute</td><td>A page so slow her loop freezes while it sends, so RIFT thinks she's offline</td></tr>
<tr><td>This PC's WiFi</td><td class="mono">netsh wlan show interfaces</td><td>Windows hopping off NORA's network to one with internet</td></tr>
<tr><td>Serial ports</td><td class="mono">pyserial list_ports (never opened)</td><td>Boards plugged in and unplugged, with a guess at which robot</td></tr>
</tbody>
</table>
</div>
</div>
</section>
<section id="settings">
<div class="wrap">
<h2>Settings</h2>
<h3 class="title">config.json, or the options menu</h3>
<div class="table-wrap">
<table>
<thead><tr><th>Setting</th><th>Default</th><th>What it does</th></tr></thead>
<tbody>
<tr><td class="mono">Port</td><td class="mono">5012</td><td>Her page and API</td></tr>
<tr><td class="mono">RiftHost / RiftPort</td><td class="mono">127.0.0.1 / 5000</td><td>Where RIFT runs</td></tr>
<tr><td class="mono">NoraHost / NoraSsid</td><td class="mono">192.168.4.1 / NORA</td><td>NORA's address and WiFi name</td></tr>
<tr><td class="mono">CheckSeconds</td><td class="mono">5</td><td>How often she looks</td></tr>
<tr><td class="mono">SlowMs</td><td class="mono">2000</td><td>Slower than this is worth a warning</td></tr>
<tr><td class="mono">Speak / Voice / VoicePitch</td><td class="mono">on / Zira / 0.85</td><td>Her voice, and her chirp pitch</td></tr>
<tr><td class="mono">MissionLog</td><td class="mono">on</td><td>Write problems to RIFT's mission log</td></tr>
<tr><td class="mono">TinaUrl</td><td class="mono">http://127.0.0.1:5013</td><td>Where TINA is, for her fleet news</td></tr>
<tr><td class="mono">StuckMinutes</td><td class="mono">10</td><td>A sensor on one value this long gets a checkup</td></tr>
<tr><td class="mono">DistressMinutes</td><td class="mono">15</td><td>A robot moving nonstop this long: she warns you (0 = off)</td></tr>
<tr><td class="mono">PanicMinutes</td><td class="mono">3</td><td>Turning in nearly every reading this long, like bouncing off walls: she warns you</td></tr>
<tr><td class="mono">GluedMinutes</td><td class="mono">5</td><td>Another robot's radio right on top of a moving one this long: she warns you</td></tr>
<tr><td class="mono">Passwords</td><td class="mono">empty</td><td>NORA's wheel-lock password and MILA's PIN, so she may move them a little to test a sensor</td></tr>
</tbody>
</table>
</div>
</div>
</section>
<section id="api">
<div class="wrap">
<h2>API</h2>
<h3 class="title">For RIFT and anything else</h3>
<div class="grid cols-2">
<div class="card"><h4><code>GET /status</code></h4><p>Everything she knows: robots, NORA, this PC's WiFi, serial ports and recent events, as JSON.</p></div>
<div class="card"><h4><code>GET /events</code></h4><p>Her log, newest first: time, level (info / warn / problem), what happened and why.</p></div>
<div class="card"><h4><code>GET /chirp?u=0-13</code></h4><p>Says a Brainfuck phrase on the PC speaker, like the robots' buzzers. RIFT's conversations use it.</p></div>
<div class="card"><h4><code>GET /checkups</code></h4><p>How each robot says it is (moving, turning, wheels locked, music, mode) and its distance readings.</p></div>
<div class="card"><h4><code>POST /report</code></h4><p>A robot sends its own readings: <code>{"name", "state": {...}, "sensors": {"front": 23.5}}</code>.</p></div>
<div class="card"><h4><code>GET /ping</code></h4><p><code>NINA alive</code>, for anyone checking on the caretaker.</p></div>
</div>
</div>
</section>
<section id="quickstart">
<div class="wrap">
<h2>Quick start</h2>
<h3 class="title">Running in a minute</h3>
<p class="muted">NINA runs on the PC next to <a href="https://github.com/CursedPrograms/RIFT">RIFT</a>. <code>run.bat</code> creates her venv the first time and starts her; <code>run_all.bat</code> in the GitHub folder starts her with the rest of the fleet.</p>
<pre><span class="p">></span> run.bat <span class="c"># sets up venv, then starts NINA</span>
<span class="p">></span> options.bat <span class="c"># her settings, as an options menu</span>
<span class="c"># Her page: the fleet, and everything she's noticed</span>
http://127.0.0.1:5012/</pre>
</div>
</section>
<section id="windows">
<div class="wrap">
<h2>Windows app</h2>
<h3 class="title">A native window on NINA's page</h3>
<p>It opens NINA's own page in a window, so it always looks the same as the page. Keep it in NINA's <code>builds</code> folder: if NINA isn't running, it starts <code>run.bat</code> beside it.</p>
<p><a class="btn primary" href="https://github.com/CursedPrograms/NINA/raw/main/builds/NINA-Controller.exe">Download NINA-Controller.exe</a></p>
</div>
</section>
</main>
<footer id="site-footer">© Cursed Entertainment 2026</footer>
<script src="https://cursedprograms.github.io/RIFT/site/footer.js"></script>
<!-- DREAM-ECOSYSTEM:START -->
<section class="eco">
<div class="eco-title">The DREAM Robotics ecosystem</div>
<div><strong>Minds</strong> — <a href="https://cursedprograms.github.io/DREAM/">DREAM</a> companion · <a href="https://cursedprograms.github.io/TINA/">TINA</a> engineer · <a href="https://cursedprograms.github.io/NINA/">NINA</a> caretaker · <a href="https://cursedprograms.github.io/RIFT/">RIFT</a> fleet hub · <a href="https://github.com/CursedPrograms/LYCEA">LYCEA</a> training school</div>
<div><strong>Robots</strong> — <a href="https://cursedprograms.github.io/NORA-Robot-v00/">NORA</a> · <a href="https://cursedprograms.github.io/MILA-Robot-v00/">MILA</a> · <a href="https://cursedprograms.github.io/WHIP-Robot-v00/">WHIP</a> · <a href="https://cursedprograms.github.io/KIDA-Robot-v00/">KIDA-00</a> · <a href="https://cursedprograms.github.io/KIDA-Robot-v01/">KIDA-01</a> · <a href="https://cursedprograms.github.io/IDA-Robot-v00/">IDA</a> · <a href="https://cursedprograms.github.io/ARM-Robot-v01/">ARM</a> · <a href="https://cursedprograms.github.io/NIKA-Robot-v00/">NIKA</a> · <a href="https://cursedprograms.github.io/ARIA-Robot-v00/">ARIA</a> · <a href="https://cursedprograms.github.io/AURA/">AURA</a> weather · <a href="https://cursedprograms.github.io/FLORA-Robot-v00/">FLORA</a> gardener</div>
<div><strong>Remotes</strong> — <a href="https://cursedprograms.github.io/RITA/">RITA</a> handheld remote</div>
</section>
<!-- DREAM-ECOSYSTEM:END -->
</body>
</html>