Skip to content

Commit 158c4bf

Browse files
IgorWilbertCloudyPadmal
authored andcommitted
Create README.md (fossasia#81)
1 parent 854a8a3 commit 158c4bf

File tree

1 file changed

+393
-0
lines changed

1 file changed

+393
-0
lines changed

PSL/README.md

Lines changed: 393 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,393 @@
1+
/* Documentation of back-end functions used in PSLab, taken from sciencelab.py */
2+
3+
<details>
4+
<summary><code>get_resistance(self)</code></summary><br />
5+
</details>
6+
7+
<details>
8+
<summary><code>get__version(self)</code></summary><br />
9+
</details>
10+
11+
<details>
12+
<summary><code>getRadioLinks(self)</code></summary><br />
13+
</details>
14+
15+
<details>
16+
<summary><code>newRadioLink(self, **args)</code></summary><br />
17+
</details>
18+
19+
<details>
20+
<summary><code>reconnect(self, **kwargs)</code></summary><br />
21+
</details>
22+
23+
<details>
24+
<summary><code>capture1(self, ch, ns, tg, *args, **kwargs)</code></summary><br />
25+
</details>
26+
27+
<details>
28+
<summary><code>capture2(self, ns, tg, TraceOneRemap='CH1')</code></summary><br />
29+
</details>
30+
31+
<details>
32+
<summary><code>capture4(self, ns, tg, TraceOneRemap='CH1')</code></summary><br />
33+
</details>
34+
35+
<details>
36+
<summary><code>capture_multiple(self, samples, tg, *args)</code></summary><br />
37+
</details>
38+
39+
<details>
40+
<summary><code>capture_fullspeed(self, chan, samples, tg, *args, **kwargs)</code></summary><br />
41+
</details>
42+
43+
<details>
44+
<summary><code>capture_fullspeed_hr(self, chan, samples, tg, *args)</code></summary><br />
45+
</details>
46+
47+
<details>
48+
<summary><code>capture_traces(self, num, samples, tg, channel_one_input='CH1', CH123SA=0, *kwargs)</code></summary><br />
49+
</details>
50+
51+
<details>
52+
<summary><code>capture_highres_traces(self, channel, samples, tg, **kwargs)</code></summary><br />
53+
</details>
54+
55+
<details>
56+
<summary><code>fetch_trace(self, channel_number)</code></summary><br />
57+
</details>
58+
59+
<details>
60+
<summary><code>oscilloscope_progress(self)</code></summary><br />
61+
</details>
62+
63+
<details>
64+
<summary><code>configure_trigger(self, chan, name, voltage, resolution=10, **kwargs)</code></summary><br />
65+
</details>
66+
67+
<details>
68+
<summary><code>set_gain(self, channel, gain, Force=False)</code></summary><br />
69+
</details>
70+
71+
<details>
72+
<summary><code>select_range(self, channel, voltage_range)</code></summary><br />
73+
</details>
74+
75+
<details>
76+
<summary><code>get_voltage(self, channel_name, **kwargs)</code></summary><br />
77+
</details>
78+
79+
<details>
80+
<summary><code>voltmeter_autorange(self, channel_name)</code></summary><br />
81+
</details>
82+
83+
<details>
84+
<summary><code>get_average_voltage(self, channel_name, **kwargs)</code></summary><br />
85+
</details>
86+
87+
<details>
88+
<summary><code>fetch_buffer(self, starting_position=0, total_points=100)</code></summary><br />
89+
</details>
90+
91+
<details>
92+
<summary><code>clear_buffer(self, starting_position, total_points)</code></summary><br />
93+
</details>
94+
95+
<details>
96+
<summary><code>fill(slef, starting_position, poin_array)</code></summary><br />
97+
</details>
98+
99+
<details>
100+
<summary><code>start_streaming(self, tg, channel='CH1')</code></summary><br />
101+
</details>
102+
103+
<details>
104+
<summary><code>stop_streaming(self)</code></summary><br />
105+
</details>
106+
107+
<details>
108+
<summary><code>get_high_freq(self, pin)</code></summary><br />
109+
</details>
110+
111+
<details>
112+
<summary><code>get_freq(self, channel='CNTR', timeout=2)</code></summary><br />
113+
</details>
114+
115+
<details>
116+
<summary><code>r2r_time(self, channel, skip_cycle=0, timeout=5)</code></summary><br />
117+
</details>
118+
119+
<details>
120+
<summary><code>f2f_time(self,channel, skip_cycle=0, timeout=5)</code></summary><br />
121+
</details>
122+
123+
<details>
124+
<summary><code>MeasureInterval(self, channel1, channel2, edge1, edge2, timeout=0.1)</code></summary><br />
125+
</details>
126+
127+
<details>
128+
<summary><code>DutyCycle(self, channel='ID1', timeout=1.)</code></summary><br />
129+
</details>
130+
131+
<details>
132+
<summary><code>PulseTime(self, channel='ID1', PulseType='LOW', timeout=0.1)</code></summary><br />
133+
</details>
134+
135+
<details>
136+
<summary><code>MeasureMultipleDigitalEdges(self, channel1, channel2, edgeType1, edgeType2, points1, points2, timeout=0.1, **kwargs)</code></summary><br />
137+
</details>
138+
139+
<details>
140+
<summary><code>capture_edges1(self, waiting_time=1., **args)</code></summary><br />
141+
</details>
142+
143+
<details>
144+
<summary><code>start_one_channel_LA_backup__(self, trigger=1, channel='ID1', maximum_time=67, **args)</code></summary><br />
145+
</details>
146+
147+
<details>
148+
<summary><code>start_one_channel_LA(self, **args)</code></summary><br />
149+
</details>
150+
151+
<details>
152+
<summary><code>start_two_channel_LA(self, **args)</code></summary><br />
153+
</details>
154+
155+
<details>
156+
<summary><code>start_three_channel_LA(self, **args)</code></summary><br />
157+
</details>
158+
159+
<details>
160+
<summary><code>start_four_channel_LA(self, trigger=1, maximum_time=0.001, mode=[1, 1, 1, 1], **args)</code></summary><br />
161+
</details>
162+
163+
<details>
164+
<summary><code>get_LA_initial_states(self)</code></summary><br />
165+
</details>
166+
167+
<details>
168+
<summary><code>stop_LA(self)</code></summary><br />
169+
</details>
170+
171+
<details>
172+
<summary><code>fetch_int_data_from_LA(self, bytes, chan=1)</code></summary><br />
173+
</details>
174+
175+
<details>
176+
<summary><code>fetch_LA_channels(self)</code></summary><br />
177+
</details>
178+
179+
<details>
180+
<summary><code>get_states(self)</code></summary><br />
181+
</details>
182+
183+
<details>
184+
<summary><code>get_state(self, input_id)</code></summary><br />
185+
</details>
186+
187+
<details>
188+
<summary><code>set_state(self, **kwargs)</code></summary><br />
189+
</details>
190+
191+
<details>
192+
<summary><code>countPulses(self, channel='SEN')</code></summary><br />
193+
</details>
194+
195+
<details>
196+
<summary><code>readPulseCount(self)</code></summary><br />
197+
</details>
198+
199+
<details>
200+
<summary><code>capacitance_via_RC_discharge(self)</code></summary><br />
201+
</details>
202+
203+
<details>
204+
<summary><code>get_capacitor_range(self)</code></summary><br />
205+
</details>
206+
207+
<details>
208+
<summary><code>get_capacitance(self)</code></summary><br />
209+
</details>
210+
211+
<details>
212+
<summary><code>get_temperature(self)</code></summary><br />
213+
</details>
214+
215+
<details>
216+
<summary><code>resetHardware(self)</code></summary><br />
217+
</details>
218+
219+
<details>
220+
<summary><code>read_flash(self, page, location)</code></summary><br />
221+
</details>
222+
223+
<details>
224+
<summary><code>read_bulk_flash(self, page, numbytes)</code></summary><br />
225+
</details>
226+
227+
<details>
228+
<summary><code>write_flash(self, page, location, string_to_write)</code></summary><br />
229+
</details>
230+
231+
<details>
232+
<summary><code>write_bulk_flash(self, location, data)</code></summary><br />
233+
</details>
234+
235+
<details>
236+
<summary><code>set_wave(self, chan, freq)</code></summary><br />
237+
</details>
238+
239+
<details>
240+
<summary><code>set_sine1(self, freq)</code></summary><br />
241+
</details>
242+
243+
<details>
244+
<summary><code>set_sine2(self, freq)</code></summary><br />
245+
</details>
246+
247+
<details>
248+
<summary><code>set_w1(self, freq, waveType=None)</code></summary><br />
249+
</details>
250+
251+
<details>
252+
<summary><code>set_w2(self, freq, waveType=None)</code></summary><br />
253+
</details>
254+
255+
<details>
256+
<summary><code>readbackWavefrom(self, chan)</code></summary><br />
257+
</details>
258+
259+
<details>
260+
<summary><code>set_waves(self, freq, phase, f2=None)</code></summary><br />
261+
</details>
262+
263+
<details>
264+
<summary><code>load_equation(self, chan, function, span=None, **kwargs)</code></summary><br />
265+
</details>
266+
267+
<details>
268+
<summary><code>load_table(self, chan, points, mode='arbit', **kwargs)</code></summary><br />
269+
</details>
270+
271+
<details>
272+
<summary><code>sqr1(self, freq, duty_cycle=50, onlyPrepare=False)</code></summary><br />
273+
</details>
274+
275+
<details>
276+
<summary><code>sqr1_pattern(self, timing_array)</code></summary><br />
277+
</details>
278+
279+
<details>
280+
<summary><code>sqr2(self, freq, duty_cycle)</code></summary><br />
281+
</details>
282+
283+
<details>
284+
<summary><code>set_sqrs(self, wavelength, phase, high_time1, high_time2, prescaler=1)</code></summary><br />
285+
</details>
286+
287+
<details>
288+
<summary><code>sqrPWM(self, freq, h0, p1, h1, p2, h2, p3, h3, **kwargs)</code></summary><br />
289+
</details>
290+
291+
<details>
292+
<summary><code>map_reference_clock(self, scaler, *args)</code></summary><br />
293+
</details>
294+
295+
<details>
296+
<summary><code>set_pv1(self, val)</code></summary><br />
297+
</details>
298+
299+
<details>
300+
<summary><code>set_pv2(self, val)</code></summary><br />
301+
</details>
302+
303+
<details>
304+
<summary><code>set_pv3(self, val)</code></summary><br />
305+
</details>
306+
307+
<details>
308+
<summary><code>set_pcs(self, val)</code></summary><br />
309+
</details>
310+
311+
<details>
312+
<summary><code>get_pv1(self)</code></summary><br />
313+
</details>
314+
315+
<details>
316+
<summary><code>get_pv2(self)</code></summary><br />
317+
</details>
318+
319+
<details>
320+
<summary><code>get_pv3(self)</code></summary><br />
321+
</details>
322+
323+
<details>
324+
<summary><code>get_pcs(self)</code></summary><br />
325+
</details>
326+
327+
<details>
328+
<summary><code>WS2812B(self, cols, output='CS1')</code></summary><br />
329+
</details>
330+
331+
<details>
332+
<summary><code>read_program_address(self, address)</code></summary><br />
333+
</details>
334+
335+
<details>
336+
<summary><code>device_id(self)</code></summary><br />
337+
</details>
338+
339+
<details>
340+
<summary><code>read_data_address(self, address)</code></summary><br />
341+
</details>
342+
343+
<details>
344+
<summary><code>stepForward(self, steps, delay)</code></summary><br />
345+
</details>
346+
347+
<details>
348+
<summary><code>stepBackward(self, steps, delay)</code></summary><br />
349+
</details>
350+
351+
<details>
352+
<summary><code>servo(self, angle, chan='SQR1')</code></summary><br />
353+
</details>
354+
355+
<details>
356+
<summary><code>servo4(self, a1, a2, a3, a4)</code></summary><br />
357+
</details>
358+
359+
<details>
360+
<summary><code>enableUartPassthrough(self, baudrate, persist=False)</code></summary><br />
361+
</details>
362+
363+
<details>
364+
<summary><code>estimateDistance(self)</code></summary><br />
365+
</details>
366+
367+
<details>
368+
<summary><code>opticalArray(self, SS, delay, channel='CH3', **kwargs)</code></summary><br />
369+
</details>
370+
371+
<details>
372+
<summary><code>setUARTBAUD(self, BAUD)</code></summary><br />
373+
</details>
374+
375+
<details>
376+
<summary><code>writeUART(self, character)</code></summary><br />
377+
</details>
378+
379+
<details>
380+
<summary><code>readUART(self)</code></summary><br />
381+
</details>
382+
383+
<details>
384+
<summary><code>readUARTStatus(self)</code></summary><br />
385+
</details>
386+
387+
<details>
388+
<summary><code>readLog(self)</code></summary><br />
389+
</details>
390+
391+
<details>
392+
<summary><code>raiseException(self, ex, msg)</code></summary><br />
393+
</details>

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy