Skip to content

Commit 220be8a

Browse files
K4zukiK4zuki
committed
update RaspberryScpiPico.py - docstrings
1 parent 5cb2fec commit 220be8a

File tree

1 file changed

+54
-86
lines changed

1 file changed

+54
-86
lines changed

‎micropython/RaspberryScpiPico.py‎

Lines changed: 54 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -537,7 +537,6 @@ def cb_machine_freq(self, param="", opt=None):
537537
"""
538538
- MACHINE:FREQuency[?] num
539539
540-
:return:
541540
"""
542541

543542
machine_freq = param
@@ -565,9 +564,8 @@ def cb_system_error(self, param="", opt=None):
565564
"""
566565
- ``SYSTem:ERRor?``
567566
568-
:param param:
569-
:param opt:
570-
:return:
567+
:param str param: parameter string
568+
:param list(str) | none opt: list of option strings
571569
"""
572570

573571
query = (opt[-1] == "?")
@@ -591,9 +589,8 @@ def cb_pin_status(self, param="", opt=None):
591589
"""
592590
- ``PIN?``
593591
594-
:param param:
595-
:param opt:
596-
:return:
592+
:param str param: parameter string
593+
:param list(str) | none opt: list of option strings
597594
"""
598595

599596
query = (opt[-1] == "?")
@@ -620,9 +617,8 @@ def cb_pin_val(self, param="", opt=None):
620617
"""
621618
- PIN[14|15|16|17|18|19|20|21|22|25]:VALue[?] 0|1|OFF|ON
622619
623-
:param param:
624-
:param opt:
625-
:return:
620+
:param str param: parameter string
621+
:param list(str) | none opt: list of option strings
626622
"""
627623

628624
pin_number = int(opt[0])
@@ -651,9 +647,8 @@ def cb_pin_mode(self, param="", opt=None):
651647
"""
652648
- PIN[14|15|16|17|18|19|20|21|22|25]:MODE INput|OUTput|ODrain|PWM
653649
654-
:param param:
655-
:param opt:
656-
:return:
650+
:param str param: parameter string
651+
:param list(str) | none opt: list of option strings
657652
"""
658653

659654
pin_number = int(opt[0])
@@ -694,9 +689,8 @@ def cb_pin_on(self, param="", opt=None):
694689
- PIN[14|15|16|17|18|19|20|21|22|25]:ON
695690
- PIN[14|15|16|17|18|19|20|21|22|25]:OFF
696691
697-
:param param:
698-
:param opt:
699-
:return:
692+
:param str param: parameter string
693+
:param list(str) | none opt: list of option strings
700694
"""
701695

702696
pin_number = int(opt[0])
@@ -714,9 +708,8 @@ def cb_pin_off(self, param="", opt=None):
714708
- PIN[14|15|16|17|18|19|20|21|22|25]:ON
715709
- PIN[14|15|16|17|18|19|20|21|22|25]:OFF
716710
717-
:param param:
718-
:param opt:
719-
:return:
711+
:param str param: parameter string
712+
:param list(str) | none opt: list of option strings
720713
"""
721714

722715
pin_number = int(opt[0])
@@ -733,9 +726,8 @@ def cb_pin_pwm_freq(self, param="", opt=None):
733726
"""
734727
- PIN[14|15|16|17|18|19|20|21|22|25]:PWM:FREQuency[?] num
735728
736-
:param param:
737-
:param opt:
738-
:return:
729+
:param str param: parameter string
730+
:param list(str) | none opt: list of option strings
739731
"""
740732

741733
pin_number = int(opt[0])
@@ -770,9 +762,8 @@ def cb_pin_pwm_duty(self, param="", opt=None):
770762
"""
771763
- PIN[14|15|16|17|18|19|20|21|22|25]:PWM:DUTY[?] num
772764
773-
:param param:
774-
:param opt:
775-
:return:
765+
:param str param: parameter string
766+
:param list(str) | none opt: list of option strings
776767
"""
777768

778769
pin_number = int(opt[0])
@@ -807,9 +798,8 @@ def cb_led_status(self, param="", opt=None):
807798
"""
808799
- ``LED?``
809800
810-
:param param:
811-
:param opt:
812-
:return:
801+
:param str param: parameter string
802+
:param list(str) | none opt: list of option strings
813803
"""
814804

815805
pin_number = 25
@@ -829,9 +819,8 @@ def cb_led_on(self, param="", opt=None):
829819
"""
830820
- LED:ON
831821
832-
:param param:
833-
:param opt:
834-
:return:
822+
:param str param: parameter string
823+
:param list(str) | none opt: list of option strings
835824
"""
836825

837826
opt[0] = "25"
@@ -848,9 +837,8 @@ def cb_led_off(self, param="", opt=None):
848837
"""
849838
- LED:OFF
850839
851-
:param param:
852-
:param opt:
853-
:return:
840+
:param str param: parameter string
841+
:param list(str) | none opt: list of option strings
854842
"""
855843

856844
opt[0] = "25"
@@ -867,9 +855,8 @@ def cb_led_val(self, param, opt):
867855
"""
868856
- LED:VALue[?] 0|1|OFF|ON
869857
870-
:param param:
871-
:param opt:
872-
:return:
858+
:param str param: parameter string
859+
:param list(str) | none opt: list of option strings
873860
"""
874861

875862
opt[0] = "25"
@@ -881,9 +868,8 @@ def cb_led_pwm_freq(self, param="", opt=None):
881868
"""
882869
- LED:PWM:FREQuency[?] num
883870
884-
:param param:
885-
:param opt:
886-
:return:
871+
:param str param: parameter string
872+
:param list(str) | none opt: list of option strings
887873
"""
888874

889875
opt[0] = "25"
@@ -896,9 +882,8 @@ def cb_led_pwm_duty(self, param, opt):
896882
"""
897883
- LED:PWM:DUTY[?] num
898884
899-
:param param:
900-
:param List[str] opt:
901-
:return:
885+
:param str param: parameter string
886+
:param list(str) | none opt: list of option strings
902887
"""
903888

904889
opt[0] = "25"
@@ -911,9 +896,8 @@ def cb_i2c_status(self, param="", opt=None):
911896
"""
912897
- ``I2C?``
913898
914-
:param param:
915-
:param opt:
916-
:return:
899+
:param str param: parameter string
900+
:param list(str) | none opt: list of option strings
917901
"""
918902

919903
query = (opt[-1] == "?")
@@ -933,9 +917,8 @@ def cb_i2c_scan(self, param, opt):
933917
"""
934918
- I2C[01]:SCAN?
935919
936-
:param param:
937-
:param opt:
938-
:return:
920+
:param str param: parameter string
921+
:param list(str) | none opt: list of option strings
939922
"""
940923

941924
query = (opt[-1] == "?")
@@ -960,9 +943,8 @@ def cb_i2c_freq(self, param, opt):
960943
"""
961944
- I2C[01]:FREQuency[?] num
962945
963-
:param param:
964-
:param opt:
965-
:return:
946+
:param str param: parameter string
947+
:param list(str) | none opt: list of option strings
966948
"""
967949

968950
query = (opt[-1] == "?")
@@ -995,9 +977,8 @@ def cb_i2c_address_bit(self, param, opt):
995977
"""
996978
- I2C[01]:ADDRess:BIT[?] 0|1|DEFault
997979
998-
:param param:
999-
:param opt:
1000-
:return:
980+
:param str param: parameter string
981+
:param list(str) | none opt: list of option strings
1001982
"""
1002983

1003984
query = (opt[-1] == "?")
@@ -1033,9 +1014,8 @@ def cb_i2c_write(self, param, opt):
10331014
buffer: data
10341015
stop: 0|1
10351016
1036-
:param param:
1037-
:param opt:
1038-
:return:
1017+
:param str param: parameter string
1018+
:param list(str) | none opt: list of option strings
10391019
"""
10401020

10411021
query = (opt[-1] == "?")
@@ -1074,9 +1054,8 @@ def cb_i2c_read(self, param, opt):
10741054
length: 1-99
10751055
stop: 0|1
10761056
1077-
:param param:
1078-
:param opt:
1079-
:return:
1057+
:param str param: parameter string
1058+
:param list(str) | none opt: list of option strings
10801059
"""
10811060

10821061
query = (opt[-1] == "?")
@@ -1122,9 +1101,8 @@ def cb_i2c_write_memory(self, param, opt):
11221101
buf: data
11231102
addrsize: 1|2
11241103
1125-
:param param:
1126-
:param opt:
1127-
:return:
1104+
:param str param: parameter string
1105+
:param list(str) | none opt: list of option strings
11281106
"""
11291107

11301108
query = (opt[-1] == "?")
@@ -1170,9 +1148,8 @@ def cb_i2c_read_memory(self, param, opt):
11701148
nbytes: 1-99
11711149
addrsize: 1|2
11721150
1173-
:param param:
1174-
:param opt:
1175-
:return:
1151+
:param str param: parameter string
1152+
:param list(str) | none opt: list of option strings
11761153
"""
11771154

11781155
query = (opt[-1] == "?")
@@ -1215,9 +1192,8 @@ def cb_adc_read(self, param, opt):
12151192
"""
12161193
- ADC[01234]:READ?
12171194
1218-
:param param:
1219-
:param opt:
1220-
:return:
1195+
:param str param: parameter string
1196+
:param list(str) | none opt: list of option strings
12211197
"""
12221198

12231199
query = (opt[-1] == "?")
@@ -1235,9 +1211,8 @@ def cb_spi_status(self, param="", opt=None):
12351211
"""
12361212
- ``SPI?``
12371213
1238-
:param param:
1239-
:param opt:
1240-
:return:
1214+
:param str param: parameter string
1215+
:param list(str) | none opt: list of option strings
12411216
"""
12421217

12431218
query = (opt[-1] == "?")
@@ -1257,9 +1232,8 @@ def cb_spi_cs_pol(self, param, opt):
12571232
"""
12581233
- SPI[01]:CSEL:POLarity[?] 0|1|DEFault
12591234
1260-
:param param:
1261-
:param opt:
1262-
:return:
1235+
:param str param: parameter string
1236+
:param list(str) | none opt: list of option strings
12631237
"""
12641238

12651239
query = (opt[-1] == "?")
@@ -1292,9 +1266,8 @@ def cb_spi_cs_val(self, param, opt):
12921266
"""
12931267
- SPI[01]:CSEL:VALue[?] 0|1|OFF|ON
12941268
1295-
:param param:
1296-
:param opt:
1297-
:return:
1269+
:param str param: parameter string
1270+
:param list(str) | none opt: list of option strings
12981271
"""
12991272

13001273
query = (opt[-1] == "?")
@@ -1323,7 +1296,6 @@ def cb_spi_clock_phase(self, param, opt):
13231296
13241297
:param param:
13251298
:param opt:
1326-
:return:
13271299
"""
13281300

13291301
query = (opt[-1] == "?")
@@ -1368,7 +1340,6 @@ def cb_spi_freq(self, param, opt):
13681340
13691341
:param param:
13701342
:param opt:
1371-
:return:
13721343
"""
13731344

13741345
query = (opt[-1] == "?")
@@ -1410,7 +1381,6 @@ def cb_spi_tx(self, param, opt):
14101381
14111382
:param param:
14121383
:param opt:
1413-
:return:
14141384
"""
14151385

14161386
query = (opt[-1] == "?")
@@ -1454,7 +1424,6 @@ def cb_spi_write(self, param, opt):
14541424
14551425
:param param:
14561426
:param opt:
1457-
:return:
14581427
"""
14591428
query = (opt[-1] == "?")
14601429
bus_number = int(opt[0])
@@ -1489,9 +1458,8 @@ def cb_spi_read(self, param, opt):
14891458
"""
14901459
- ``SPI[01]:READ? length,mask,pre_cs,post_cs``
14911460
1492-
:param param:
1493-
:param opt:
1494-
:return:
1461+
:param str param: parameter string
1462+
:param list(str) | none opt: list of option strings
14951463
"""
14961464

14971465
query = (opt[-1] == "?")

0 commit comments

Comments
 (0)