-
Notifications
You must be signed in to change notification settings - Fork 21
/
sfuncman_2.6.0-0.json
1548 lines (1548 loc) · 86.6 KB
/
sfuncman_2.6.0-0.json
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
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"L298N_DCmotor": {
"help": {
"doc": "\n [i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/L298N_DCmotor.png?raw=true",
"m1_control": {
"doc": null,
"param(s)": "direc=None speed=None"
},
"pinmap": {
"doc": "\n [i] micrOS LM naming convention\n Shows logical pins - pin number(s) used by this Load module\n - info which pins to use for this application\n :return dict: pin name (str) - pin value (int) pairs\n \npin map: l298speed, l298dir_1, l298dir_2",
"param(s)": ""
},
"set_direction": {
"doc": "\n direc (direction) values:\n 0: forward\n 1: backward\n ",
"param(s)": "direc=0"
},
"set_speed": {
"doc": null,
"param(s)": "speed=100"
},
"stop": {
"doc": null,
"param(s)": ""
}
},
"L9110_DCmotor": {
"help": {
"doc": "\n [i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/L9110_DCmotor.png?raw=true",
"motor_control": {
"doc": null,
"param(s)": "direc=None speed=None"
},
"pinmap": {
"doc": "\n [i] micrOS LM naming convention\n Shows logical pins - pin number(s) used by this Load module\n - info which pins to use for this application\n :return dict: pin name (str) - pin value (int) pairs\n \npin map: l9110dir_1, l9110dir_2",
"param(s)": ""
}
},
"OV2640": {
"capture": {
"doc": null,
"param(s)": ""
},
"flashlight": {
"doc": "\n Camera flashlight\n :param state: True/False/None(automatic)\n ",
"param(s)": "state=None"
},
"help": {
"doc": "\n [i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/OV2640.png?raw=true",
"lmdep": {
"doc": "\n Show Load Module dependency\n - List of load modules used by this application\n :return: tuple\n ",
"param(s)": ""
},
"load": {
"doc": "\n Load Camera module OV2640\n :param quality: high (HD), medium (SVGA), low (240x240)\n :param freq: default (not set: 10kHz) or high: 20kHz\n :param effect: NONE (default), OR: NEG, BW, RED, GREEN, BLUE, RETRO\n ",
"param(s)": "quality='medium' freq='ault' effect=\"NONE\""
},
"photo": {
"doc": null,
"param(s)": "name='photo.jpg'"
},
"set_photo_endpoint": {
"doc": "\n Set photo endpoint (rest endpoint)\n ",
"param(s)": ""
},
"settings": {
"doc": "\n Camera settings\n :param flip: flip image True/False\n :param mirror: mirror image True/False\n :param effect: None (default), OR: NEG, BW, RED, GREEN, BLUE, RETRO\n :param saturation: 0-100 %\n :param brightness: 0-100 %\n :param contrast: 0-100 %\n :param whitebalace: NONE (default) SUNNY, CLOUDY, OFFICE, HOME\n :param q: 10-63 lower number means higher quality\n ",
"param(s)": "quality=None flip=None mirror=None effect=None saturation=None brightness=None contrast=None whitebalace=None q=None"
}
},
"VL53L0X": {
"help": {
"doc": "\n [BETA][i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/VL53L0X.png?raw=true",
"measure": {
"doc": "\n Experimental\n ",
"param(s)": ""
},
"pinmap": {
"doc": "\n [i] micrOS LM naming convention\n Shows logical pins - pin number(s) used by this Load module\n - info which pins to use for this application\n :return dict: pin name (str) - pin value (int) pairs\n \npin map: i2c_scl, i2c_sda",
"param(s)": ""
}
},
"aht10": {
"help": {
"doc": "\n [i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/aht10.png?raw=true",
"load": {
"doc": "\n Initialize AHT10 module\n ",
"param(s)": ""
},
"measure": {
"doc": "\n Measure with aht10\n :return dict: temp, hum\n ",
"param(s)": ""
},
"pinmap": {
"doc": "\n [i] micrOS LM naming convention\n Shows logical pins - pin number(s) used by this Load module\n - info which pins to use for this application\n :return dict: pin name (str) - pin value (int) pairs\n \npin map: i2c_scl, i2c_sda",
"param(s)": ""
},
"reset": {
"doc": "\n Reset the sensor\n ",
"param(s)": ""
}
},
"bme280": {
"help": {
"doc": "\n [i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/bme280.png?raw=true",
"lmdep": {
"doc": "\n Show Load Module dependency\n - List of load modules used by this application\n :return: tuple\n ",
"param(s)": ""
},
"load": {
"doc": "\n Initialize BME280 module\n ",
"param(s)": ""
},
"measure": {
"doc": "\n Measure with bme280\n :return dict: temp, hum, pressure\n ",
"param(s)": "ntfy=False"
},
"measure_w_co2": {
"doc": "\n Measure with bme280 and mq135 (CO2)\n :return dict: temp, hum, pressure, co2\n ",
"param(s)": ""
},
"pinmap": {
"doc": "\n [i] micrOS LM naming convention\n Shows logical pins - pin number(s) used by this Load module\n - info which pins to use for this application\n :return dict: pin name (str) - pin value (int) pairs\n \npin map: i2c_scl, i2c_sda",
"param(s)": ""
}
},
"buzzer": {
"bipp": {
"doc": "\n Buzzer bipp sound generator\n :param repeat int: bipp count\n :param freq int: 0-1000 default: 600\n :return str: Verdict string\n ",
"param(s)": "repeat=1 freq=None"
},
"help": {
"doc": "\n [i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/buzzer.png?raw=true",
"list_tones": {
"doc": "\n List built-in tones\n ",
"param(s)": ""
},
"load": {
"doc": "\n Initialize buzzer module\n :param cache bool: file state machine cache: True/False/None(default: automatic True)\n - Load .pds (state machine cache) for this load module\n - Apply loaded states to gpio pins (boot function)\n :return str: Cache state\n ",
"param(s)": "cache=None"
},
"pinmap": {
"doc": "\n [i] micrOS LM naming convention\n Shows logical pins - pin number(s) used by this Load module\n - info which pins to use for this application\n :return dict: pin name (str) - pin value (int) pairs\n \npin map: buzzer",
"param(s)": ""
},
"play": {
"doc": "\n RTTTL Piezzo Player\n :param rtttlstr str: rttl string, default: 'd=4,o=5,b=250:e,8p,8f,8g,8p,1c6,8p.,d,8p,8e,1f,p.'\n :return str: verdict\n ",
"param(s)": "rtttlstr='Indiana'"
}
},
"catgame": {
"game": {
"doc": "\n Servo cat toy \"mover\" - left-right\n :param repeat int: repeat servo pos change\n :param delta int: center(75) +/-delta(35)\n :return str: verdict\n ",
"param(s)": "repeat=10 delta=20"
},
"help": {
"doc": "\n [i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/catgame.png?raw=true",
"live_game": {
"doc": "\n Generate game\n :param chance int: percent value 0-100\n :return str: verdict (action / no action)\n ",
"param(s)": "chance=10"
},
"lmdep": {
"doc": "\n Show Load Module dependency\n - List of load modules used by this application\n :return: tuple\n ",
"param(s)": ""
},
"load": {
"doc": "\n Initialize catgame-servo module\n ",
"param(s)": ""
},
"pinmap": {
"doc": "\n [i] micrOS LM naming convention\n Shows logical pins - pin number(s) used by this Load module\n - info which pins to use for this application\n :return dict: pin name (str) - pin value (int) pairs\n \npin map: servo_1, servo_2",
"param(s)": ""
},
"stop": {
"doc": "\n Stop game - home position (75) + deinit\n :return str: servo verdict\n ",
"param(s)": ""
}
},
"cct": {
"brightness": {
"doc": "\n Set CCT brightness\n :param percent: int - brightness percentage: 0-100\n :param smooth: bool - enable smooth color transition: True(default)/False\n :param wake: bool - wake up output / if off turn on with new brightness\n :return dict: cct status - states: CW, WW, S\n ",
"param(s)": "percent=None smooth=True wake=True"
},
"help": {
"doc": "\n [i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"hue_transition": {
"doc": "\n [TASK] Set HUE transition independently from brightness\n - Running warm and cold white ratio change\n - USE cct brightness function to set brightness besides this transition (running)\n :param percent: warm channel ratio in percent 0-100\n :param sec: transition length\n :param wake: bool, wake on setup (auto run on periphery)\n :return: info msg string\n ",
"param(s)": "percent sec=1.0 wake=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/cct.png?raw=true",
"load": {
"doc": "\n Initialize Cold white / Warm white LED module\n :param cache bool: file state machine cache: True/False/None(default: automatic True)\n - Load .pds (state machine cache) for this load module\n - Apply loaded states to gpio pins (boot function)\n :return str: Cache state\n ",
"param(s)": "cache=None"
},
"pinmap": {
"doc": "\n [i] micrOS LM naming convention\n Shows logical pins - pin number(s) used by this Load module\n - info which pins to use for this application\n :return dict: pin name (str) - pin value (int) pairs\n \npin map: cwhite, wwhite",
"param(s)": ""
},
"random": {
"doc": "\n Demo function: implements random hue change\n :param smooth bool: enable smooth color transition: True(default)/False\n :param max_val: set channel maximum generated value: 0-1000\n :return dict: cct status - states: CW, WW, S\n ",
"param(s)": "smooth=True max_val=1000"
},
"status": {
"doc": "\n [i] micrOS LM naming convention\n Show Load Module state machine\n :param lmf str: selected load module function aka (function to show state of): None (show all states)\n - micrOS client state synchronization\n :return dict: CW, WW, S\n ",
"param(s)": "lmf=None"
},
"subscribe_presence": {
"doc": "\n Initialize LM presence module with ON/OFF callback functions\n :return: None\n ",
"param(s)": ""
},
"toggle": {
"doc": "\n Toggle led state based on the stored state\n :param state bool: True(1)/False(0)/None(default - automatic toggle)\n :param smooth bool: enable smooth color transition: True(default)/False\n :return dict: cct status - states: CW, WW, S\n ",
"param(s)": "state=None smooth=True"
},
"transition": {
"doc": "\n [TASK] Set transition color change for long dimming periods < 30sec\n - creates the dimming generators\n :param cw: cold white 0-1000\n :param ww: warm white 0-1000\n :param sec: transition length in sec\n :param wake: bool, wake on setup (auto run on periphery)\n :return: info msg string\n ",
"param(s)": "cw=None ww=None sec=1.0 wake=False"
},
"white": {
"doc": "\n Set CCT values with PWM signal\n :param cw: cold white value 0-1000\n :param ww: warm white value 0-1000\n :param smooth: (bool) runs white channels change with smooth effect\n :param force: (bool) clean fade generators and set color\n :return dict: cct status - states: CW, WW, S\n ",
"param(s)": "cw=None ww=None smooth=True"
}
},
"co2": {
"help": {
"doc": "\n [i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/co2.png?raw=true",
"load": {
"doc": "\n Initialize mq135 CO2 (ppm) sensor module\n ",
"param(s)": ""
},
"measure_mq135": {
"doc": "\n CO2 Gas Concentration - Parts-per-million - PPM\n -> 1ppm = 0.0001% gas.\n Concentration evaluation:\n 250-400ppm Normal background concentration in outdoor ambient air\n 400-1,000ppm Concentrations typical of occupied indoor spaces with good air exchange\n 1,000-2,000ppm Complaints of drowsiness and poor air.\n 2,000-5,000 ppm Headaches, sleepiness and stagnant, stale, stuffy air. Poor concentration, loss of attention, increased heart rate and slight nausea may also be present.\n 5,000ppm Workplace exposure limit (as 8-hour TWA) in most jurisdictions.\n >40,000 ppm Exposure may lead to serious oxygen deprivation resulting in permanent brain damage, coma, even death.\n :param temperature int: temp compensation - celsius\n :param humidity int: hum compensation\n :return str: verdict\n ",
"param(s)": "temperature=None humidity=None"
},
"pinmap": {
"doc": "\n [i] micrOS LM naming convention\n Shows logical pins - pin number(s) used by this Load module\n - info which pins to use for this application\n :return dict: pin name (str) - pin value (int) pairs\n \npin map: co2",
"param(s)": ""
},
"raw_measure_mq135": {
"doc": "\n Measure raw mq135 CO2 value\n :return str: raw value / adc_property\n ",
"param(s)": ""
}
},
"dashboard_be": {
"create_dashboard": {
"doc": "\n Create dashboard endpoint\n ",
"param(s)": ""
},
"help": {
"doc": "\n [i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/dashboard_be.png?raw=true",
"load": {
"doc": null,
"param(s)": ""
}
},
"demo": {
"calculator": {
"doc": null,
"param(s)": "a b op=\"+\""
},
"dice_cube": {
"doc": null,
"param(s)": ""
},
"exec_info": {
"doc": null,
"param(s)": ""
},
"hello": {
"doc": null,
"param(s)": "name=\"MrNobody\""
},
"help": {
"doc": null,
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/demo.png?raw=true",
"links": {
"doc": null,
"param(s)": ""
},
"load": {
"doc": "\n Initialize demo module\n ",
"param(s)": ""
},
"source": {
"doc": null,
"param(s)": ""
},
"yes_no": {
"doc": null,
"param(s)": ""
}
},
"dht11": {
"help": {
"doc": "\n [i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/dht11.png?raw=true",
"lmdep": {
"doc": "\n Show Load Module dependency\n - List of load modules used by this application\n :return: tuple\n ",
"param(s)": ""
},
"load": {
"doc": "\n Initialize DHT11 hum/temp sensor module\n ",
"param(s)": ""
},
"logger": {
"doc": "\n Return temp, hum, (co2) logged data\n ",
"param(s)": ""
},
"measure": {
"doc": "\n Measure with dht11\n :return dict: temp, hum\n ",
"param(s)": "log=False"
},
"measure_w_co2": {
"doc": "\n Measure with dht11 and mq135 (CO2)\n :return dict: temp, hum, co2\n ",
"param(s)": "log=False"
},
"pinmap": {
"doc": "\n [i] micrOS LM naming convention\n Shows logical pins - pin number(s) used by this Load module\n - info which pins to use for this application\n :return dict: pin name (str) - pin value (int) pairs\n \npin map: dhtpin",
"param(s)": ""
}
},
"dht22": {
"help": {
"doc": "\n [i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/dht22.png?raw=true",
"lmdep": {
"doc": "\n Show Load Module dependency\n - List of load modules used by this application\n :return: tuple\n ",
"param(s)": ""
},
"load": {
"doc": "\n Initialize DHT22 hum/temp sensor module\n ",
"param(s)": ""
},
"logger": {
"doc": "\n Return temp, hum, (co2) logged data\n ",
"param(s)": ""
},
"measure": {
"doc": "\n Measure with dht22\n :return dict: temp, hum\n ",
"param(s)": "log=False"
},
"measure_w_co2": {
"doc": "\n Measure with dht22 and mq135 (CO2)\n :return dict: temp, hum, co2\n ",
"param(s)": "log=False"
},
"pinmap": {
"doc": "\n [i] micrOS LM naming convention\n Shows logical pins - pin number(s) used by this Load module\n - info which pins to use for this application\n :return dict: pin name (str) - pin value (int) pairs\n \npin map: dhtpin",
"param(s)": ""
}
},
"dimmer": {
"help": {
"doc": "\n [i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/dimmer.png?raw=true",
"load": {
"doc": "\n Initialize dimmer module\n :param cache bool: file state machine cache: True/False/None(default: automatic True)\n - Load .pds (state machine cache) for this load module\n - Apply loaded states to gpio pins (boot function)\n :return str: Cache state\n ",
"param(s)": "cache=None"
},
"pinmap": {
"doc": "\n [i] micrOS LM naming convention\n Shows logical pins - pin number(s) used by this Load module\n - info which pins to use for this application\n :return dict: pin name (str) - pin value (int) pairs\n \npin map: dim_1",
"param(s)": ""
},
"set_value": {
"doc": "\n Set dimmer values with PWM signal\n :param value: (int) value 0-1000 default: None (set cached value)\n :param smooth: (bool) run channel change with smooth effect\n :param force: (bool) clean fade generators and set value\n :return dict: X, S\n ",
"param(s)": "value=None smooth=True"
},
"status": {
"doc": "\n [i] micrOS LM naming convention\n Show Load Module state machine\n :param lmf str: selected load module function aka (function to show state of): None (show all states)\n - micrOS client state synchronization\n :return dict: X, S\n ",
"param(s)": "lmf=None"
},
"subscribe_presence": {
"doc": "\n Initialize LM presence module with ON/OFF callback functions\n :return: None\n ",
"param(s)": ""
},
"toggle": {
"doc": "\n Toggle dimmer state based on the stored state\n :param state bool: True(1)/False(0)/None(default - automatic toggle)\n :param smooth bool: run channel change with smooth effect\n :return dict: X, S\n ",
"param(s)": "state=None smooth=True"
},
"transition": {
"doc": "\n [TASK] Set transition color change for long dimming periods < 30sec\n - creates the dimming generators\n :param value: value 0-1000\n :param sec: transition length in sec\n :param wake: bool, wake on setup (auto run on periphery)\n :return: info msg string\n ",
"param(s)": "value sec=1.0 wake=False"
}
},
"distance": {
"deinit": {
"doc": null,
"param(s)": ""
},
"distance_cm": {
"doc": null,
"param(s)": ""
},
"distance_mm": {
"doc": "\n To calculate the distance we get the pulse_time and divide it by 2\n (the pulse walk the distance twice) and by 29.1 becasue\n the sound speed on air (343.2 m/s), that It's equivalent to\n 0.34320 mm/us that is 1mm each 2.91us\n pulse_time // 2 // 2.91 -> pulse_time // 5.82 -> pulse_time * 100 // 582\n ",
"param(s)": ""
},
"help": {
"doc": "\n [i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/distance.png?raw=true",
"load": {
"doc": "\n Initialize HCSR04 ultrasonic distance sensor module\n ",
"param(s)": ""
},
"pinmap": {
"doc": "\n [i] micrOS LM naming convention\n Shows logical pins - pin number(s) used by this Load module\n - info which pins to use for this application\n :return dict: pin name (str) - pin value (int) pairs\n \npin map: hcsrtrig, hcsrecho",
"param(s)": ""
}
},
"ds18": {
"help": {
"doc": "\n [i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/ds18.png?raw=true",
"load": {
"doc": "\n Initialize DS18 temp sensor module\n ",
"param(s)": ""
},
"measure": {
"doc": "\n Measure with digital onewire temperature sensor\n - ds18\n :return str: temp string\n ",
"param(s)": ""
},
"pinmap": {
"doc": "\n [i] micrOS LM naming convention\n Shows logical pins - pin number(s) used by this Load module\n - info which pins to use for this application\n :return dict: pin name (str) - pin value (int) pairs\n \npin map: ds18",
"param(s)": ""
}
},
"esp32": {
"battery": {
"doc": "\n TinyPico battery manager interface\n :return dict: volt, state (is charging)\n ",
"param(s)": ""
},
"hall": {
"doc": "\n Measure with esp32 built-in hall sensor\n ",
"param(s)": ""
},
"help": {
"doc": "\n [BETA][i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/esp32.png?raw=true",
"temp": {
"doc": "\n Measure CPU temperature\n ",
"param(s)": ""
},
"touch": {
"doc": "\n Test function:\n :param triglvl: trigger level, value < triglvl decide touched\n :return dict: verdict isTouched and value\n ",
"param(s)": "triglvl=300"
}
},
"gameOfLife": {
"help": {
"doc": "\n [i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/gameOfLife.png?raw=true",
"load": {
"doc": "\n Init Conway's Game of Life\n :param w: width of display (pixel)\n :param h: height of display (pixel)\n :param custom: custom initial set, example: ((10,10),(1,0,0),(0,1,1),(0,0,1))\n Init and store GoL instance, inject default cells\n ",
"param(s)": "w=32 h=16 custom=None"
},
"my_config": {
"doc": "module 'LM_gameOfLife' has no attribute 'my_config'",
"param(s)": "add_cells"
},
"next_gen": {
"doc": "\n Main Game of Life function\n Get Next Generation of cells (with auto load and GoL reinit)\n :param raw: Output type (raw:True -> matrix), (raw:False formatted output)\n :param w: width of display (pixel) - auto init\n :param h: height of display (pixel) - auto init\n return change of life matrix or None if there is no change (on None, restart feature: call reset())\n ",
"param(s)": "raw=False w=32 h=16"
},
"reset": {
"doc": "\n Reset life table - set default\n ",
"param(s)": ""
}
},
"genIO": {
"genio_pins": {
"doc": "\n Get used pins in genIO module\n ",
"param(s)": ""
},
"get_adc": {
"doc": "\n Get Analog Digital conersion input\n :param pin: pin number or logical pin name\n :param key: select adc parameter by key\n :return dict: adc volt, percent, raw\n ",
"param(s)": "pin key=None"
},
"get_in": {
"doc": "\n Get digital input (high(1)/ low (0))\n :param pin: pin number or logical pin\n :return dict: pin, state\n ",
"param(s)": "pin"
},
"help": {
"doc": "\n [i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/genIO.png?raw=true",
"set_out": {
"doc": "\n Set simple digital (high/low) output\n :param pin: pun number or logical name\n :param state: state: 1/0 = True/False\n :return dict: pin, state\n ",
"param(s)": "pin state=None"
},
"set_pwm": {
"doc": "\n Set PWM signal output\n :param pin: pin number or logical name\n :param duty: pwm duty\n :param freq: pwm frequency (board dependent)\n :return dict: pin, freq, duty\n ",
"param(s)": "pin duty=500 freq=20480"
},
"set_random_pwm": {
"doc": "\n Set random PWM duty in min-max range\n :param pin: pin number or logical name\n :param min_duty: set min duty value (0-1000)\n :param max_duty: set max duty value (0-1000)\n :param freq: pwm frequency (board dependent)\n ",
"param(s)": "pin min_duty max_duty freq=20480"
}
},
"i2c": {
"help": {
"doc": "\n [BETA][i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/i2c.png?raw=true",
"pinmap": {
"doc": "\n [i] micrOS LM naming convention\n Shows logical pins - pin number(s) used by this Load module\n - info which pins to use for this application\n :return dict: pin name (str) - pin value (int) pairs\n \npin map: i2c_scl, i2c_sda",
"param(s)": ""
},
"scan": {
"doc": "\n I2C scan function - experimental\n :return list: list of devices\n ",
"param(s)": ""
}
},
"i2s_mic": {
"background_capture": {
"doc": "\n Start recording samples into a buffer by micro task\n ",
"param(s)": ""
},
"bytes_per_second": {
"doc": "\n Get configured number of bytes per second\n :t: seconds (number)\n ",
"param(s)": "t=1"
},
"decode": {
"doc": "\n Decode raw bytes to floats between -1 and 1\n :samples: samples to select channels from (bytes, bytearray)\n ",
"param(s)": "samples=b''"
},
"get_from_buffer": {
"doc": "\n Return samples stored in the buffer, captured by micro task\n :capture_duration: maximum duration (seconds) of samples to retrieve (number)\n :channel: which channel to get samples from ('left', 'right' or 'all')\n :downsampling: return every nth sample (int)\n ",
"param(s)": "capture_duration=Data.CAPTURE_DURATION"
},
"help": {
"doc": "\n [i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/i2s_mic.png?raw=true",
"load": {
"doc": "\n Initialize I2S microphone module\n :buf_length: I2S internal buffer length (int)\n :sampling_rate: I2S sampling rate (int)\n :capture_duration: override default duration of samples to retrieve\n :shift_size: override default shift size\n :sample_size: override default sample size (16 or 32)\n :i2s_channel: override default I2S channel\n :default_channel: override default channel ('left', 'right' or 'all')\n :sound_format: override default format (I2S.MONO, I2S.STEREO)\n :downsampling: override default downsampling\n :control_button: name of button pin, control task is enbaled when provided\n :enable_endpoint: enable/disable endpoint creation at /mic/stream (True/False)\n ",
"param(s)": "buf_length=Data.BUF_LENGTH sampling_rate=Data.SAMPLING_RATE"
},
"pinmap": {
"doc": "\n [i] micrOS LM naming convention\n Shows logical pins - pin number(s) used by this Load module\n - info which pins to use for this application\n :return dict: pin name (str) - pin value (int) pairs\n \npin map: sck, ws, sd",
"param(s)": ""
},
"select_channel": {
"doc": "\n Separate channels from stereo data and/or apply downsampling\n Can be used as a workaround for https://github.com/espressif/esp-idf/issues/6625\n :samples: samples to select channels from (bytes, bytearray)\n :channel: which channel to get samples from ('left', 'right' or 'all')\n :downsampling: return every nth sample (int)\n ",
"param(s)": "samples=b'' channel = Data.DEFAULT_CHANNEL downsampling = 1"
},
"set_volume": {
"doc": "\n Change default volume by positive/negative bitwise shift\n :param mic: shift_size, positive shift increases volume (int)\n ",
"param(s)": "shift_size=0"
}
},
"intercon": {
"addr_cache": {
"doc": "\n Dump intercon connection cache\n :return dict: device-ip pairs\n ",
"param(s)": ""
},
"help": {
"doc": "\n [i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/intercon.png?raw=true",
"sendcmd": {
"doc": "\n Implements send command function towards micrOS devices\n example: sendcmd \"hello\" host=\"IP/hostname.local\") OR sendcmd host=\"IP/hostname.local\" cmd=\"system rssi\")\n :param host[0]: host IP or Hostname\n :param cmd[1]: command - module func arg(s)\n :return str: reply\n ",
"param(s)": "*args **kwargs"
}
},
"keychain": {
"button": {
"doc": "\n IRQ1 keychain module control function\n - neopixel ON/OFF\n - display wake-up (ON)\n ",
"param(s)": ""
},
"color_wheel": {
"doc": "\n Neopixel color wheel\n :param br: brightness value 0-100 percent\n :param run: run led update / disable\n ",
"param(s)": "br=None"
},
"display": {
"doc": "\n Create kc._display task - refresh loop\n :param period: display refresh period in ms (min. 500ms)\n :param tts: time to sleep (in seconds)\n ",
"param(s)": "period=1000 tts=30"
},
"display_toggle": {
"doc": "\n Display mode toggle (main/screensaver)\n ",
"param(s)": ""
},
"help": {
"doc": "\n [i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/keychain.png?raw=true",
"lmdep": {
"doc": "\n Load Module dependencies\n ",
"param(s)": ""
},
"load": {
"doc": "\n Init OLED display 64x32 (default)\n Init Neopixel LED (1 segment)\n :param width: screen width (pixel)\n :param height: screen height (pixel)\n :param bootmsg: First text on page at bootup, default: \"micrOS\"\n ",
"param(s)": "width=64 height=32 bootmsg=\"micrOS\""
},
"neopixel_toggle": {
"doc": "\n Disable/Enable neopixel LED (brightness 0/default)\n ",
"param(s)": ""
},
"pinmap": {
"doc": "\n PIN MAP dump\n \npin map: i2c_scl, i2c_sda, ds18, neop",
"param(s)": ""
},
"temperature": {
"doc": "\n Measure ds18B20 temperature sensor\n ",
"param(s)": ""
}
},
"ld2410": {
"bytes_to_str": {
"doc": null,
"param(s)": "data"
},
"enable_config": {
"doc": null,
"param(s)": ""
},
"enable_engineering": {
"doc": null,
"param(s)": ""
},
"end_config": {
"doc": null,
"param(s)": ""
},
"end_engineering": {
"doc": null,
"param(s)": ""
},
"firmware_version": {
"doc": null,
"param(s)": ""
},
"help": {
"doc": "\n [i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/ld2410.png?raw=true",
"pinmap": {
"doc": "\n [i] micrOS LM naming convention\n Shows logical pins - pin number(s) used by this Load module\n - info which pins to use for this application\n :return dict: pin name (str) - pin value (int) pairs\n \npin map: tx, rx",
"param(s)": ""
},
"print_bytes": {
"doc": null,
"param(s)": "data"
},
"read": {
"doc": null,
"param(s)": ""
},
"read_serial_buffer": {
"doc": null,
"param(s)": ""
},
"send_command": {
"doc": null,
"param(s)": "cmd data=NULLDATA response_expected=True"
},
"serial_flush": {
"doc": null,
"param(s)": ""
}
},
"light_sensor": {
"help": {
"doc": "\n [i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"illuminance": {
"doc": "\n Measure light illuminance in flux\n - result is 20 result average (noise reduction)\n ",
"param(s)": ""
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/light_sensor.png?raw=true",
"intensity": {
"doc": "\n Measure light intensity in %\n - result is 20 result average (noise reduction)\n ",
"param(s)": ""
},
"load": {
"doc": "\n Initialize TEMPT6000 light sensor module\n ",
"param(s)": ""
},
"pinmap": {
"doc": "\n [i] micrOS LM naming convention\n Shows logical pins - pin number(s) used by this Load module\n - info which pins to use for this application\n :return dict: pin name (str) - pin value (int) pairs\n \npin map: temp6000",
"param(s)": ""
},
"subscribe_intercon": {
"doc": "\n [TASK] ON/OFF command sender over intercon on given threshold\n :param on: on callback to send: \"host cmd\"\n :param off: off callback to send: \"host cmd\"\n :param threshold: percentage value for on(under) /off(above)\n :param tolerance: off tolerance value -> off event: threshold+tolerance\n :param sample_sec: light measure task period in sec (also means event frequency)\n ",
"param(s)": "on off threshold=4 tolerance=2 sample_sec=60"
}
},
"lmpacman": {
"cachedump": {
"doc": null,
"param(s)": "cdel=None"
},
"del_duplicates": {
"doc": "\n Load module package manager (Not just load modules)\n - delete duplicated .mpy and .py resources, keep .mpy resource!\n ",
"param(s)": ""
},
"delmod": {
"doc": "\n Module package manager\n :param mod:\n Delete Load Module with full name: module.py or module.mpy\n OR delete any web resource: *.js, *.css, *.html\n ",
"param(s)": "mod=None"
},
"help": {
"doc": "\n [i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/lmpacman.png?raw=true",
"listmods": {
"doc": null,
"param(s)": ""
},
"micros_checksum": {
"doc": null,
"param(s)": ""
},
"module": {
"doc": "\n List / unload loaded upython Load Modules\n :param unload: module name to unload\n :param unload: None - list active modules\n :return str: verdict\n ",
"param(s)": "unload=None"
}
},
"neoeffects": {
"color": {
"doc": "\n Set color buffer - for runtime effect color change\n :param r int: red channel 0-255 (default: None - cached value)\n :param g int: green channel 0-255 (default: None - cached value)\n :param b int: blue channel 0-255 (default: None - cached value)\n :return dict: rgb status - states: R, G, B, S\n ",
"param(s)": "r=None g=None b=None"
},
"cycle": {
"doc": "\n Cycle effect\n :param r int: red value 0-1000\n :param g int: green value 0-1000\n :param b int: blue value 0-1000\n :param shift bool: automatic effect shifting\n :param ledcnt int: number of neopixel elements in chain (default: 24)\n :return str: verdict\n ",
"param(s)": "r=None g=None b=None shift=True ledcnt=24"
},
"fire": {
"doc": null,
"param(s)": "r=None g=None b=None ledcnt=24"
},
"help": {
"doc": "\n [i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/neoeffects.png?raw=true",
"lmdep": {
"doc": "\n Show Load Module dependency\n - List of load modules used by this application\n :return: tuple\n ",
"param(s)": ""
},
"meteor": {
"doc": "\n Meteor effect\n :param r int: red value 0-1000\n :param g int: green value 0-1000\n :param b int: blue value 0-1000\n :param shift bool: automatic effect shifting\n :param ledcnt int: number of neopixel elements in chain (default: 24)\n :return str: verdict\n ",
"param(s)": "r=None g=None b=None shift=True ledcnt=24"
},
"pinmap": {
"doc": "\n [i] micrOS LM naming convention\n Shows logical pins - pin number(s) used by this Load module\n - info which pins to use for this application\n :return dict: pin name (str) - pin value (int) pairs\n \npin map: neop",
"param(s)": ""
},
"rainbow": {
"doc": "\n Rainbow effect\n :param step int: color weel resolution in step (default: 1)\n :param br int: brightness in percentage\n :param ledcnt int: number of neopixel elements in chain (default: 24)\n :return str: verdict\n ",
"param(s)": "step=1 br=50 ledcnt=24"
},
"random": {
"doc": "\n Demo function: implements random color change\n :param max_val: set channel maximum generated value: 0-255\n :return str: rgb status - states: R, G, B\n ",
"param(s)": "max_val=255"
},
"shader": {
"doc": "\n Shader for ring lamp\n :param size int: shader size (disabled LEDs)\n :param offset int: rotate shader 0-(ledcnt-1)\n :param shift bool: auto shift shader effect (False)\n :param ledcnt int: number of neopixel elements in chain (default: 24)\n :return str: verdict\n ",
"param(s)": "size=6 offset=0 shift=False ledcnt=24"
}
},
"neopixel": {
"brightness": {
"doc": "\n Set neopixel brightness\n :param percent: (int) brightness percentage: 0-100\n :param smooth: (bool) enable smooth color transition: True(default)/False\n :param wake: bool - wake up output / if off turn on with new brightness\n :return dict: rgb status - states: R, G, B, S\n ",
"param(s)": "percent=None smooth=True wake=True"
},
"color": {
"doc": "\n Set NEOPIXEL RGB values\n :param r: red value 0-255\n :param g: green value 0-255\n :param b: blue value 0-255\n :param smooth: runs colors change with smooth effect\n :param force: clean fade generators and set color\n :return dict: rgb status - states: R, G, B, S\n ",
"param(s)": "r=None g=None b=None smooth=True"
},
"help": {
"doc": "\n [i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/neopixel.png?raw=true",
"load": {
"doc": "\n Initiate NeoPixel RGB module\n :param cache bool: file state machine cache: True/False/None(default: automatic True)\n - Load .pds (state machine cache) for this load module\n - Apply loaded states to gpio pins (boot function)\n :return str: Cache state\n ",
"param(s)": "cache=None ledcnt=24"
},
"pinmap": {
"doc": "\n [i] micrOS LM naming convention\n Shows logical pins - pin number(s) used by this Load module\n - info which pins to use for this application\n :return dict: pin name (str) - pin value (int) pairs\n \npin map: neop",
"param(s)": ""
},
"random": {
"doc": "\n Demo function: implements random color change\n :param smooth: (bool) enable smooth color transition: True(default)/False\n :param max_val: set channel maximum generated value: 0-1000\n :return dict: rgb status - states: R, G, B, S\n ",
"param(s)": "smooth=True max_val=255"
},
"segment": {
"doc": "\n Set single segment by index on neopixel\n :param r: red value 0-255\n :param g: green value 0-255\n :param b: blue value 0-255\n :param s: segment - index 0-ledcnt\n :param cache: cache color (update .pds file)\n :param write: send color buffer to neopixel (update LEDs)\n :return dict: rgb status - states: R, G, B, S\n ",
"param(s)": "r=None g=None b=None s=0 cache=False write=True"
},
"status": {
"doc": "\n [i] micrOS LM naming convention\n Show Load Module state machine\n :param lmf str: selected load module function aka (function to show state of): None (show all states)\n - micrOS client state synchronization\n :return dict: R, G, B, S\n ",
"param(s)": "lmf=None"
},
"subscribe_presence": {
"doc": "\n Initialize LM presence module with ON/OFF callback functions\n :return: None\n ",
"param(s)": ""
},
"toggle": {
"doc": "\n Toggle led state based on the stored state\n :param state: True(1)/False(0)\n :param smooth: runs colors change with smooth effect\n :return dict: rgb status - states: R, G, B, S\n ",
"param(s)": "state=None smooth=True"
},
"transition": {
"doc": "\n [TASK] Set transition color change for long dimming periods < 30sec\n - creates the dimming generators\n :param r: red channel 0-255\n :param g: green channel 0-255\n :param b: blue channel 0-255\n :param sec: transition length in sec\n :param wake: bool, wake on setup (auto run on periphery)\n :return: info msg string\n ",
"param(s)": "r=None g=None b=None sec=1.0 wake=False"
}
},
"oled": {
"bitmap": {
"doc": "\n Draw simple bitmap\n :param bmp: lines of image string ('001','011','111')\n :param x: x offset\n :param y: y offset\n ",
"param(s)": "bmp=None x=0 y=0"
},
"clean": {
"doc": "\n Clean display\n :param state: 0/1\n ",
"param(s)": "state=0"
},
"help": {
"doc": "\n [i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"image": {
"doc": "\n [BETA]\n https://blog.martinfitzpatrick.com/displaying-images-oled-displays/\n Load Portable Bitmap Format (PBM) image\n :param pbm_img: .pbm image path\n :param x: x offset\n :param y: y offset\n ",
"param(s)": "pbm_img x=0 y=0"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/oled.png?raw=true",
"invert": {
"doc": "\n Invert OLED display\n ",
"param(s)": ""
},
"line": {
"doc": "\n Draw line on OLED\n :param sx: start x\n :param sy: start y\n :param ex: end x\n :param ey: end y\n :param state: state 0/1\n ",
"param(s)": "sx sy ex ey state=1"
},
"load": {
"doc": "\n :param width: pixel\n :param height: pixel\n :param brightness: percentage\n ",
"param(s)": "width=128 height=64 brightness=50"
},
"pinmap": {
"doc": "\n [i] micrOS LM naming convention\n Shows logical pins - pin number(s) used by this Load module\n - info which pins to use for this application\n :return dict: pin name (str) - pin value (int) pairs\n \npin map: i2c_scl, i2c_sda",
"param(s)": ""
},
"pixel": {
"doc": "\n https://blog.martinfitzpatrick.com/oled-displays-i2c-micropython/\n Set pixel\n .pixel(x, y, c)\n ",
"param(s)": "x y color=1"
},
"poweroff": {
"doc": "\n Power OFF OLED\n ",
"param(s)": ""
},
"poweron": {
"doc": "\n Power ON OLED\n ",
"param(s)": ""
},
"rect": {
"doc": "\n Draw rectangle on OLED\n :param x: start x\n :param y: start y\n :param w: width\n :param h: height\n :param state: state\n :param fill: fill rectangle (True/False)\n ",
"param(s)": "x y w h state=1 fill=False"
},
"show": {
"doc": "\n Show OLED buffer data\n - update display\n ",
"param(s)": ""
},
"text": {
"doc": "\n Create text on OLED\n :param string: text to draw\n :param x: 0-127\n :param y: 0-63\n ",
"param(s)": "string=\"text\" x=0 y=0"
}
},
"oled_sh1106": {
"bitmap": {
"doc": "\n Draw simple bitmap\n :param bmp: lines of image string ('001','011','111')\n :param x: x offset\n :param y: y offset\n ",
"param(s)": "bmp=None x=0 y=0"
},
"clean": {
"doc": "\n Clean display\n :param state: 0/1\n ",
"param(s)": "state=0"
},
"flip": {
"doc": null,
"param(s)": ""
},
"help": {
"doc": "\n [i] micrOS LM naming convention - built-in help message\n :return tuple:\n (widgets=False) list of functions implemented by this application\n (widgets=True) list of widget json for UI generation\n ",
"param(s)": "widgets=False"
},
"img": "https://github.com/BxNxM/micrOS/blob/master/media/lms/oled_sh1106.png?raw=true",
"invert": {
"doc": "\n Invert OLED display\n ",
"param(s)": ""
},
"line": {
"doc": "\n Draw line on OLED\n :param sx: start x\n :param sy: start y\n :param ex: end x\n :param ey: end y\n :param state: state 0/1\n ",
"param(s)": "sx sy ex ey state=1"
},
"load": {
"doc": null,
"param(s)": "width=128 height=64 brightness=50 rotate=180"
},
"pinmap": {
"doc": "\n [i] micrOS LM naming convention\n Shows logical pins - pin number(s) used by this Load module\n - info which pins to use for this application\n :return dict: pin name (str) - pin value (int) pairs\n \npin map: i2c_scl, i2c_sda",
"param(s)": ""
},
"pixel": {
"doc": null,
"param(s)": "x y state=1"
},
"poweroff": {
"doc": "\n Power OFF OLED\n ",
"param(s)": ""
},
"poweron": {
"doc": "\n Power ON OLED\n ",
"param(s)": ""
},
"rect": {
"doc": "\n Draw rectangle on OLED\n :param x: start x\n :param y: start y\n :param w: width\n :param h: height\n :param state: state\n :param fill: fill rectangle (True/False)\n ",
"param(s)": "x y w h state=1 fill=False"
},
"show": {
"doc": "\n Show OLED buffer data\n - update display\n ",
"param(s)": ""
},
"text": {
"doc": "\n Create text on OLED\n :param string: text to draw\n :param x: 0-127\n :param y: 0-63\n ",
"param(s)": "string=\"text\" x=0 y=0"
}
},
"oled_ui": {
"[1]": {
"doc": "invalid syntax (<string>, line 1)",
"param(s)": "ine function like: mypage display"
},
"adc_genpage": {
"doc": "\n Create ADC visualization pages dynamically :)\n :param pin: pin number for ADC read, default: 33\n :return: page creation verdict\n ",
"param(s)": "pin=33"
},
"cmd_genpage": {
"doc": "\n Create load module execution pages dynamically :)\n - based on cmd value: load_module function (args)\n :param cmd: 'load_module function (args)' string\n :param run: run button event at page init: True/False\n :return: page creation verdict\n ",
"param(s)": "cmd=None run=False"
},
"control": {
"doc": "\n OLED UI control\n :param cmd str: next, prev, press, on, off\n :return str: verdict\n ",
"param(s)": "cmd='next'"
},
"function_genpage": {
"doc": "\n Coding interface to register custom pages in oled_ui (ui application manager)\n [1] define function like: def mypage(display):\n [2] use display.text, display.pixel, etc. display function in mypage\n [3] oled_ui.function_genpage(mypage)\n :param func: python function reference with display parameter\n ",
"param(s)": "func"
},
"help": {