-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathgetting-started.html
922 lines (654 loc) · 31.6 KB
/
getting-started.html
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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="A low-cost, high-reliable Open Source WiFi Tally Light">
<link rel="canonical" href="https://wifi-tally.github.io/getting-started.html">
<link rel="shortcut icon" href="assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.1.2, mkdocs-material-6.2.3">
<title>Getting started - WiFi Tally Light</title>
<link rel="stylesheet" href="assets/stylesheets/main.3b61ea93.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.39b8e14a.min.css">
</head>
<body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#getting-started" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header-nav md-grid" aria-label="Header">
<a href="https://wifi-tally.github.io/" title="WiFi Tally Light" class="md-header-nav__button md-logo" aria-label="WiFi Tally Light">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 003-3 3 3 0 00-3-3 3 3 0 00-3 3 3 3 0 003 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
</a>
<label class="md-header-nav__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
</label>
<div class="md-header-nav__title" data-md-component="header-title">
<div class="md-header-nav__ellipsis">
<div class="md-header-nav__topic">
<span class="md-ellipsis">
WiFi Tally Light
</span>
</div>
<div class="md-header-nav__topic">
<span class="md-ellipsis">
Getting started
</span>
</div>
</div>
</div>
<label class="md-header-nav__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</label>
<button type="reset" class="md-search__icon md-icon" aria-label="Clear" data-md-component="search-reset" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
</button>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header-nav__source">
<a href="https://github.com/wifi-tally/wifi-tally/" title="Go to repository" class="md-source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 00-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 01-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 000 40.81l195.61 195.6a28.86 28.86 0 0040.8 0l194.69-194.69a28.86 28.86 0 000-40.81z"/></svg>
</div>
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="https://wifi-tally.github.io/" title="WiFi Tally Light" class="md-nav__button md-logo" aria-label="WiFi Tally Light">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 003-3 3 3 0 00-3-3 3 3 0 00-3 3 3 3 0 003 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
</a>
WiFi Tally Light
</label>
<div class="md-nav__source">
<a href="https://github.com/wifi-tally/wifi-tally/" title="Go to repository" class="md-source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 00-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 01-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 000 40.81l195.61 195.6a28.86 28.86 0 0040.8 0l194.69-194.69a28.86 28.86 0 000-40.81z"/></svg>
</div>
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="index.html" class="md-nav__link">
Open Source Tally Light
</a>
</li>
<li class="md-nav__item">
<a href="download.html" class="md-nav__link">
Download
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
Getting started
<span class="md-nav__icon md-icon"></span>
</label>
<a href="getting-started.html" class="md-nav__link md-nav__link--active">
Getting started
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#things-you-need" class="md-nav__link">
Things you need
</a>
<nav class="md-nav" aria-label="Things you need">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#a-trusted-network-that-allows-access-via-wifi" class="md-nav__link">
a trusted network that allows access via WiFi
</a>
</li>
<li class="md-nav__item">
<a href="#a-computer-to-run-the-hub-on" class="md-nav__link">
a computer to run the Hub on
</a>
</li>
<li class="md-nav__item">
<a href="#a-nodemcu-esp8266" class="md-nav__link">
a NodeMcu ESP8266
</a>
</li>
<li class="md-nav__item">
<a href="#a-piece-of-rgb-led-strip" class="md-nav__link">
a piece of RGB LED strip
</a>
</li>
<li class="md-nav__item">
<a href="#an-usb-power-source" class="md-nav__link">
an USB power source
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#setup" class="md-nav__link">
Setup
</a>
<nav class="md-nav" aria-label="Setup">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#download-sources" class="md-nav__link">
Download sources
</a>
</li>
<li class="md-nav__item">
<a href="#setting-up-the-tally" class="md-nav__link">
Setting up the Tally
</a>
<nav class="md-nav" aria-label="Setting up the Tally">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#connect-the-hardware" class="md-nav__link">
Connect the hardware
</a>
<nav class="md-nav" aria-label="Connect the hardware">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#separate-operator-and-stage-light" class="md-nav__link">
Separate Operator and Stage Light
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#prepare-the-nodemcu-toolchain" class="md-nav__link">
Prepare the NodeMCU Toolchain
</a>
</li>
<li class="md-nav__item">
<a href="#flash-the-firmware" class="md-nav__link">
Flash the firmware
</a>
</li>
<li class="md-nav__item">
<a href="#upload-code" class="md-nav__link">
Upload Code
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#setting-up-the-hub" class="md-nav__link">
Setting up the hub
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="protocol.html" class="md-nav__link">
Protocol
</a>
</li>
<li class="md-nav__item">
<a href="tally.html" class="md-nav__link">
Tally
</a>
</li>
<li class="md-nav__item">
<a href="troubleshooting.html" class="md-nav__link">
Troubleshooting
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#things-you-need" class="md-nav__link">
Things you need
</a>
<nav class="md-nav" aria-label="Things you need">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#a-trusted-network-that-allows-access-via-wifi" class="md-nav__link">
a trusted network that allows access via WiFi
</a>
</li>
<li class="md-nav__item">
<a href="#a-computer-to-run-the-hub-on" class="md-nav__link">
a computer to run the Hub on
</a>
</li>
<li class="md-nav__item">
<a href="#a-nodemcu-esp8266" class="md-nav__link">
a NodeMcu ESP8266
</a>
</li>
<li class="md-nav__item">
<a href="#a-piece-of-rgb-led-strip" class="md-nav__link">
a piece of RGB LED strip
</a>
</li>
<li class="md-nav__item">
<a href="#an-usb-power-source" class="md-nav__link">
an USB power source
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#setup" class="md-nav__link">
Setup
</a>
<nav class="md-nav" aria-label="Setup">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#download-sources" class="md-nav__link">
Download sources
</a>
</li>
<li class="md-nav__item">
<a href="#setting-up-the-tally" class="md-nav__link">
Setting up the Tally
</a>
<nav class="md-nav" aria-label="Setting up the Tally">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#connect-the-hardware" class="md-nav__link">
Connect the hardware
</a>
<nav class="md-nav" aria-label="Connect the hardware">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#separate-operator-and-stage-light" class="md-nav__link">
Separate Operator and Stage Light
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#prepare-the-nodemcu-toolchain" class="md-nav__link">
Prepare the NodeMCU Toolchain
</a>
</li>
<li class="md-nav__item">
<a href="#flash-the-firmware" class="md-nav__link">
Flash the firmware
</a>
</li>
<li class="md-nav__item">
<a href="#upload-code" class="md-nav__link">
Upload Code
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#setting-up-the-hub" class="md-nav__link">
Setting up the hub
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content">
<article class="md-content__inner md-typeset">
<a href="https://github.com/wifi-tally/wifi-tally/edit/master/documentation/docs/getting-started.md" title="Edit this page" class="md-content__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
</a>
<h1 id="getting-started">Getting started<a class="headerlink" href="#getting-started" title="Permanent link">¶</a></h1>
<p>You need two parts to get the Tally Light operational: The Tally Lights themselves
and the Hub that connects your video mixer and the Tallies.</p>
<p><img alt="Architecture Setup" src="images/architecture.png" />
<span style="font-size:smaller;opacity:0.8">uses icons from the Noun Project by
<a href="https://thenounproject.com/browse/?i=3151803">Eucalyp</a>,
<a href="https://thenounproject.com/browse/?i=1294543">Atif Arshad</a>,
<a href="https://thenounproject.com/browse?i=3014911">Hrbon</a> and
<a href="https://thenounproject.com/browse/?i=1086042">ProSymbols</a>, all licensed <a href="https://creativecommons.org/licenses/by/3.0/us/legalcode">CC-BY-3.0</a></span></p>
<h2 id="things-you-need">Things you need<a class="headerlink" href="#things-you-need" title="Permanent link">¶</a></h2>
<h3 id="a-trusted-network-that-allows-access-via-wifi">a trusted network that allows access via WiFi<a class="headerlink" href="#a-trusted-network-that-allows-access-via-wifi" title="Permanent link">¶</a></h3>
<p>Your video mixer, the Hub and the Tallies need to be able to connect to each other.
You should take care that there is a close and stable WiFi hotspot near your Tallies
for obvious reasons. The network you are using should be trusted as all communication
is unencrypted.</p>
<p>The WiFi Chip supports <code>IEEE 802.11 b/g/n</code> and operates in the <code>2.4GHz</code> frequency band.
The Wifi network should support that as well.</p>
<h3 id="a-computer-to-run-the-hub-on">a computer to run the Hub on<a class="headerlink" href="#a-computer-to-run-the-hub-on" title="Permanent link">¶</a></h3>
<p>The application is rather light weight, so there are no special requirements here
and it could run other applications in parallel. The Hub has a web interface for
monitoring and configuration that can be shown on any browser that can connect to
the computer.</p>
<p>To keep latency to a minimum it would be perfect if this computer uses a wired
connection.</p>
<h3 id="a-nodemcu-esp8266">a NodeMcu ESP8266<a class="headerlink" href="#a-nodemcu-esp8266" title="Permanent link">¶</a></h3>
<p>This is an ESP8266 wifi chip on a development board that is typically used for IoT
applications. As it is an Open Hardware project there are lots of different boards
available. They mostly differ in price and form factor and are all fit for the project.
But they all look similar to this:</p>
<p><img alt="Photography of a NodeMCU" src="images/Nodemcu_amica_bot_02.jpg" /></p>
<p><a href="https://commons.wikimedia.org/wiki/File:Nodemcu_amica_bot_02.png">"NodeMCU Amica"</a>
by "Make Magazin DE", <a href="https://creativecommons.org/licenses/by-sa/4.0/deed.en">CC-BY-SA-4.0</a></p>
<p>!TODO: elaborate on different NodeMCUs!</p>
<h3 id="a-piece-of-rgb-led-strip">a piece of RGB LED strip<a class="headerlink" href="#a-piece-of-rgb-led-strip" title="Permanent link">¶</a></h3>
<p>It needs to be specified for 5V and have a common anode.
Most LED strips that can be separated after <em>every</em> LED and have 4 pins should fulfill that requirement. </p>
<p>I recommend taking one with 120LEDs per meter to not have the LEDS be spaced too much.</p>
<h3 id="an-usb-power-source">an USB power source<a class="headerlink" href="#an-usb-power-source" title="Permanent link">¶</a></h3>
<p>The whole setup draws far less than <code>200mA</code> and can be powered via USB.</p>
<ul>
<li>Some cameras have USB outlets that you can use</li>
<li><code>200mA</code> is little enough that even the smallest power bank can supply the Tally for hours</li>
<li>use any old USB charger</li>
</ul>
<h2 id="setup">Setup<a class="headerlink" href="#setup" title="Permanent link">¶</a></h2>
<p>Running the tally lights consists of two steps:</p>
<ul>
<li>
<p><strong>Setup the Tally Light</strong> This means connecting the hardware and flashing the software onto it.</p>
</li>
<li>
<p><strong>Setup the Hub</strong> This is the piece of software that communicates with your video mixer and all
connected Tallies and runs on any computer you provide.</p>
</li>
</ul>
<h3 id="download-sources">Download sources<a class="headerlink" href="#download-sources" title="Permanent link">¶</a></h3>
<p>The latest releases can be found on <a href="https://github.com/wifi-tally/wifi-tally/releases">github.com/wifi-tally</a>.</p>
<h3 id="setting-up-the-tally">Setting up the Tally<a class="headerlink" href="#setting-up-the-tally" title="Permanent link">¶</a></h3>
<h4 id="connect-the-hardware">Connect the hardware<a class="headerlink" href="#connect-the-hardware" title="Permanent link">¶</a></h4>
<p>All you need to do is connecting the LED strip to the NodeMCU board.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Do not connect more than 5 LEDs to the board!</p>
<p>This will drain too much current through the board and potentially damaging it.</p>
</div>
<p><img alt="connection of the parts" src="images/tally-schematics-simple.png" /></p>
<table>
<thead>
<tr>
<th>board PIN</th>
<th>strip PIN</th>
</tr>
</thead>
<tbody>
<tr>
<td>D3</td>
<td>B</td>
</tr>
<tr>
<td>D2</td>
<td>R</td>
</tr>
<tr>
<td>D1</td>
<td>G</td>
</tr>
<tr>
<td>3V3</td>
<td>+ or +5V</td>
</tr>
</tbody>
</table>
<div class="admonition info">
<p class="admonition-title">Info</p>
<p>It is possible to connect the <code>+5V</code> pin of the LED strip to <code>Vin</code> on the board. But not all NodeMCU boards connect
the PIN to the USB power supply and your LEDs would stay dark.</p>
<p>It might also happen that you LED Strip does not work with a lower voltage of the 3.3V output. Typically this does
not happen, but it could if you have an older strips.</p>
</div>
<p>This is how the setup could look like on a breadboard.</p>
<p><img alt="WiFi Tally on a breaboard" src="images/on-breadboard.jpg" /></p>
<h5 id="separate-operator-and-stage-light">Separate Operator and Stage Light<a class="headerlink" href="#separate-operator-and-stage-light" title="Permanent link">¶</a></h5>
<p>You can connect a second strip to use as an indicator for the speaker on stage.
Connect the first LED as above and direct it in the direction of the camera operator.
Then connect a second strip and let it face to the front of the camera. </p>
<p><img alt="connection of the parts" src="images/tally-schematics-operator.png" /></p>
<table>
<thead>
<tr>
<th>board PIN</th>
<th>strip PIN</th>
</tr>
</thead>
<tbody>
<tr>
<td>D7</td>
<td>B</td>
</tr>
<tr>
<td>D6</td>
<td>R</td>
</tr>
<tr>
<td>D5</td>
<td>G</td>
</tr>
<tr>
<td>3V3</td>
<td>+ or +5V</td>
</tr>
</tbody>
</table>
<p>This light will only show preview and live states, but not any error states.</p>
<h4 id="prepare-the-nodemcu-toolchain">Prepare the NodeMCU Toolchain<a class="headerlink" href="#prepare-the-nodemcu-toolchain" title="Permanent link">¶</a></h4>
<p>The NodeMCU documentation very nicely explains all the steps necessary to <a href="https://nodemcu.readthedocs.io/en/master/getting-started/#getting-started-aka-nodemcu-quick-start">start a NodeMCU project</a>.
The documentation might seem overwhelming at first, but you only need to care of the two steps</p>
<ul>
<li>Flash Firmware, and</li>
<li>Upload code</li>
</ul>
<p>Depending on your Operating System, you should select one – and only one – <a href="https://nodemcu.readthedocs.io/en/master/getting-started/#task-os-selector">tool for each of these steps from
the table</a>.</p>
<p>So either select <a href="https://nodemcu.readthedocs.io/en/master/getting-started/#nodemcu-pyflasher">NodeMCU PyFlasher</a>
or <a href="https://nodemcu.readthedocs.io/en/master/getting-started/#esptoolpy">esptool.py</a> to flash the firmware
and follow their installation instruction. Similarly select <a href="https://nodemcu.readthedocs.io/en/master/getting-started/#esplorer">ESPlorer</a>
or <a href="https://nodemcu.readthedocs.io/en/master/getting-started/#nodemcu-tool">NodeMCU Tool</a> to upload code and follow
their installation instruction.</p>
<h4 id="flash-the-firmware">Flash the firmware<a class="headerlink" href="#flash-the-firmware" title="Permanent link">¶</a></h4>
<p>When everything is set up flash the firmware with the tool selected in the previous step.</p>
<p>The firmware is the <code>.bin</code> file in the <code>firmware</code> folder.</p>
<h4 id="upload-code">Upload Code<a class="headerlink" href="#upload-code" title="Permanent link">¶</a></h4>
<p>Use the tool you have selected to upload the following files from the <code>tally</code> folder to the NodeMCU board:</p>
<ul>
<li>every file ending in <code>.lc</code></li>
<li><code>init.lua</code></li>
<li>the <code>tally-settings.ini</code> described below</li>
</ul>
<div class="admonition info">
<p class="admonition-title">tally-settings.ini</p>
<p>This file configures your Tally. You can copy <code>tally-settings.ini.example</code> over and edit it as needed.</p>
<table>
<thead>
<tr>
<th>setting name</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>station.ssid</code></td>
<td>The name of the WiFi that the Tally should connect to</td>
</tr>
<tr>
<td><code>station.password</code></td>
<td>The password to connect to the WiFi. If the WiFi has no password, leave it empty.</td>
</tr>
<tr>
<td><code>hub.ip</code></td>
<td>The IP address the hub is running on</td>
</tr>
<tr>
<td><code>tally.name</code></td>
<td>How you want <em>this</em> tally to be labeled in the hub. This name needs to be unique amongst all tallies in your network. It must not be longer than <code>26</code> characters. Use of ASCII characters is recommended.</td>
</tr>
</tbody>
</table>
<p>For a list for all configuration values see <a href="tally.html">tally-settings.ini Reference</a>.</p>
</div>
<p>Reboot the NodeMCU board by pressing the <code>RST</code> button on the board or disconnecting it from power briefly.</p>
<div class="admonition success">
<p class="admonition-title">Success</p>
<p>If the LED strip starts blinking blue, this means you have correctly connected the hardware, flashed the firmware
and uploaded the code.</p>
<p><strong>Well done!</strong> </p>
</div>
<h3 id="setting-up-the-hub">Setting up the hub<a class="headerlink" href="#setting-up-the-hub" title="Permanent link">¶</a></h3>
<p>The hub requires <a href="https://nodejs.org/en/">node.js</a> to run. Packages for Linux, MacOS and even Windows
are offered on the <a href="https://nodejs.org/en/download/">Download page</a>. Get version <code>12</code>.</p>
<p>Open the terminal of your operating system, enter the <code>hub</code> directory and run</p>
<pre><code class="language-bash">npm run start
</code></pre>
<p>!TODO: explain environment variables!</p>
<p>Point your browser to the IP of your computer on port 3000, for instance http://127.0.0.1:3000 if
you are on the same machine. You should see a screen similar to this</p>
<p><img alt="alt text" src="images/tally-hub.png" title="Tally Hub" /></p>
<p>Your Tallies should also start popping up there. If not see the <a href="troubleshooting.html">Troubleshooting Guide</a>. </p>
<p>Select <code>Configuration</code> in the navigation and configure the settings for your Video Mixer.</p>
<div class="admonition info">
<p class="admonition-title">Info</p>
<p>Currently only ATEM video mixers are supported, but please <a href="https://github.com/wifi-tally/wifi-tally/issues">open an issue</a>
if you want others to be supported too. It is really simple to integrate them
and the only reason they have not been integrated yet, is that nobody has needed it already. :D</p>
</div>
<div class="admonition info">
<p class="admonition-title">Info</p>
<p>If you want to try this at home and don't have a Video Mixer at hand you can run
<code>npm run dev</code> instead. It features a <code>Mock</code> Video Mixer that randomly switches channels.</p>
</div>
<p>Switch back to <code>Tallies</code> in the navigation and assign the video channels of the Video Mixer to the according
tallies.</p>
<div class="admonition info">
<p class="admonition-title">Info</p>
<p>The Tallies and their assigned channels are automatically saved in <code>.wifi-tally.json</code> in your home directory.
So the configuration is restored when the Hub is restarted. </p>
</div>
<div class="admonition success">
<p class="admonition-title">Success</p>
<p>Your Tallies should start showing green, when they are in Preview and red when they are in Program.</p>
<p>Congratulations, you made it.</p>
</div>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-nav">
<nav class="md-footer-nav__inner md-grid" aria-label="Footer">
<a href="download.html" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
<div class="md-footer-nav__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</div>
<div class="md-footer-nav__title">
<div class="md-ellipsis">
<span class="md-footer-nav__direction">
Previous
</span>
Download
</div>
</div>
</a>
<a href="protocol.html" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
<div class="md-footer-nav__title">
<div class="md-ellipsis">
<span class="md-footer-nav__direction">
Next
</span>
Protocol
</div>
</div>
<div class="md-footer-nav__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
</div>
</a>
</nav>
</div>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-footer-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
<div class="md-footer-social">
<a href="https://github.com/wifi-tally" target="_blank" rel="noopener" title="github.com" class="md-footer-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 480 512"><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1zM480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2zm-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.4 101.3h48.2c70.3 0 150.6-13.4 150.6-101.3zm-82.6-55.1c-25.8 0-36.7 34.2-36.7 55.1s10.9 55.1 36.7 55.1 36.7-34.2 36.7-55.1-10.9-55.1-36.7-55.1z"/></svg>
</a>
</div>
</div>
</div>
</footer>
</div>
<script src="assets/javascripts/vendor.08c56446.min.js"></script>
<script src="assets/javascripts/bundle.6ced434e.min.js"></script><script id="__lang" type="application/json">{"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}</script>
<script>
app = initialize({
base: ".",
features: [],
search: Object.assign({
worker: "assets/javascripts/worker/search.8c7e0a7e.min.js"
}, typeof search !== "undefined" && search)
})
</script>
</body>
</html>