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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
|
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.0.3, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Octave Instrument Control Toolkit</title>
<meta name="description" content="Octave Instrument Control Toolkit">
<meta name="keywords" content="Octave Instrument Control Toolkit">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="#Top" rel="start" title="Top">
<link href="#Index" rel="index" title="Index">
<link href="#SEC_Contents" rel="contents" title="Table of Contents">
<link href="#Installing-and-loading" rel="next" title="Installing and loading">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
a.summary-letter-printindex {text-decoration: none}
div.center {text-align:center}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
pre.display-preformatted {font-family: inherit}
span:hover a.copiable-link {visibility: visible}
strong.def-name {font-family: monospace; font-weight: bold; font-size: larger}
td.printindex-index-entry {vertical-align: top}
td.printindex-index-section {vertical-align: top}
th.entries-header-printindex {text-align:left}
th.sections-header-printindex {text-align:left}
ul.mark-bullet {list-style-type: disc}
ul.toc-numbered-mark {list-style: none}
-->
</style>
<link rel="stylesheet" type="text/css" href="instrument-control.css">
</head>
<body lang="en">
<div class="top-level-extent" id="Top">
<div class="nav-panel">
<p>
Next: <a href="#Installing-and-loading" accesskey="n" rel="next">Installing and loading</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h1 class="top" id="Introduction">Introduction</h1>
<p>The Instrument Control toolkit is a set of low level I/O functions for serial, i2c, spi, modbus, parallel, tcp, gpib, vxi11, udp and usbtmc interfaces
</p>
<div class="element-contents" id="SEC_Contents">
<h2 class="contents-heading">Table of Contents</h2>
<div class="contents">
<ul class="toc-numbered-mark">
<li><a id="toc-Installing-and-loading-1" href="#Installing-and-loading">1 Installing and loading</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Requirements" href="#Requirements">1.1 Requirements</a></li>
<li><a id="toc-Windows-install" href="#Windows-install">1.2 Windows install</a></li>
<li><a id="toc-Online-Direct-install" href="#Online-Direct-install">1.3 Online Direct install</a></li>
<li><a id="toc-Off_002dline-install" href="#Off_002dline-install">1.4 Off-line install</a></li>
<li><a id="toc-Loading" href="#Loading">1.5 Loading</a></li>
</ul></li>
<li><a id="toc-Basic-Usage-Overview-1" href="#Basic-Usage-Overview">2 Basic Usage Overview</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Authors-1" href="#Authors">2.1 Authors</a></li>
<li><a id="toc-Available-Interfaces" href="#Available-Interface">2.2 Available Interfaces</a></li>
<li><a id="toc-Basic-Serial-1" href="#Basic-Serial">2.3 Basic Serial</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Serial" href="#Serial">2.3.1 Serial</a></li>
<li><a id="toc-SerialPort" href="#SerialPort">2.3.2 SerialPort</a></li>
</ul></li>
<li><a id="toc-Basic-TCP-1" href="#Basic-TCP">2.4 Basic TCP</a>
<ul class="toc-numbered-mark">
<li><a id="toc-TCP" href="#TCP">2.4.1 TCP</a></li>
<li><a id="toc-TCP-Client-1" href="#TCP-Client-1">2.4.2 TCP Client</a></li>
</ul></li>
<li><a id="toc-Basic-UDP-1" href="#Basic-UDP">2.5 Basic UDP</a>
<ul class="toc-numbered-mark">
<li><a id="toc-UDP" href="#UDP">2.5.1 UDP</a></li>
<li><a id="toc-UDP-Port-1" href="#UDP-Port-1">2.5.2 UDP Port</a></li>
</ul></li>
</ul></li>
<li><a id="toc-Function-Reference-1" href="#Function-Reference">3 Function Reference</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Common-Functions-1" href="#Common-Functions">3.1 Common Functions</a>
<ul class="toc-numbered-mark">
<li><a id="toc-flushinput" href="#flushinput">3.1.1 flushinput</a></li>
<li><a id="toc-flushoutput" href="#flushoutput">3.1.2 flushoutput</a></li>
<li><a id="toc-readbinblock" href="#readbinblock">3.1.3 readbinblock</a></li>
<li><a id="toc-readline" href="#readline">3.1.4 readline</a></li>
<li><a id="toc-writebinblock" href="#writebinblock">3.1.5 writebinblock</a></li>
<li><a id="toc-writeline" href="#writeline">3.1.6 writeline</a></li>
<li><a id="toc-writeread" href="#writeread">3.1.7 writeread</a></li>
</ul></li>
<li><a id="toc-General-1" href="#General">3.2 General</a>
<ul class="toc-numbered-mark">
<li><a id="toc-instrhelp" href="#instrhelp">3.2.1 instrhelp</a></li>
<li><a id="toc-instrhwinfo" href="#instrhwinfo">3.2.2 instrhwinfo</a></li>
<li><a id="toc-resolvehost" href="#resolvehost">3.2.3 resolvehost</a></li>
</ul></li>
<li><a id="toc-GPIB-1" href="#GPIB">3.3 GPIB</a>
<ul class="toc-numbered-mark">
<li><a id="toc-_0040octave_005fgpib_002ffclose" href="#g_t_0040octave_005fgpib_002ffclose">3.3.1 @octave_gpib/fclose</a></li>
<li><a id="toc-_0040octave_005fgpib_002ffopen" href="#g_t_0040octave_005fgpib_002ffopen">3.3.2 @octave_gpib/fopen</a></li>
<li><a id="toc-_0040octave_005fgpib_002ffprintf" href="#g_t_0040octave_005fgpib_002ffprintf">3.3.3 @octave_gpib/fprintf</a></li>
<li><a id="toc-_0040octave_005fgpib_002ffread" href="#g_t_0040octave_005fgpib_002ffread">3.3.4 @octave_gpib/fread</a></li>
<li><a id="toc-_0040octave_005fgpib_002ffscanf" href="#g_t_0040octave_005fgpib_002ffscanf">3.3.5 @octave_gpib/fscanf</a></li>
<li><a id="toc-_0040octave_005fgpib_002ffwrite" href="#g_t_0040octave_005fgpib_002ffwrite">3.3.6 @octave_gpib/fwrite</a></li>
<li><a id="toc-clrdevice" href="#clrdevice">3.3.7 clrdevice</a></li>
<li><a id="toc-gpib" href="#gpib">3.3.8 gpib</a></li>
<li><a id="toc-gpib_005fclose" href="#gpib_005fclose">3.3.9 gpib_close</a></li>
<li><a id="toc-gpib_005fread" href="#gpib_005fread">3.3.10 gpib_read</a></li>
<li><a id="toc-gpib_005ftimeout" href="#gpib_005ftimeout">3.3.11 gpib_timeout</a></li>
<li><a id="toc-gpib_005fwrite" href="#gpib_005fwrite">3.3.12 gpib_write</a></li>
<li><a id="toc-spoll" href="#spoll">3.3.13 spoll</a></li>
<li><a id="toc-trigger" href="#trigger">3.3.14 trigger</a></li>
</ul></li>
<li><a id="toc-I2C-1" href="#I2C">3.4 I2C</a>
<ul class="toc-numbered-mark">
<li><a id="toc-_0040octave_005fi2c_002ffclose" href="#g_t_0040octave_005fi2c_002ffclose">3.4.1 @octave_i2c/fclose</a></li>
<li><a id="toc-_0040octave_005fi2c_002ffopen" href="#g_t_0040octave_005fi2c_002ffopen">3.4.2 @octave_i2c/fopen</a></li>
<li><a id="toc-_0040octave_005fi2c_002ffread" href="#g_t_0040octave_005fi2c_002ffread">3.4.3 @octave_i2c/fread</a></li>
<li><a id="toc-_0040octave_005fi2c_002ffwrite" href="#g_t_0040octave_005fi2c_002ffwrite">3.4.4 @octave_i2c/fwrite</a></li>
<li><a id="toc-_0040octave_005fi2c_002fget" href="#g_t_0040octave_005fi2c_002fget">3.4.5 @octave_i2c/get</a></li>
<li><a id="toc-_0040octave_005fi2c_002fset" href="#g_t_0040octave_005fi2c_002fset">3.4.6 @octave_i2c/set</a></li>
<li><a id="toc-i2c" href="#i2c">3.4.7 i2c</a></li>
<li><a id="toc-i2c_005faddr" href="#i2c_005faddr">3.4.8 i2c_addr</a></li>
<li><a id="toc-i2c_005fclose" href="#i2c_005fclose">3.4.9 i2c_close</a></li>
<li><a id="toc-i2c_005fread" href="#i2c_005fread">3.4.10 i2c_read</a></li>
<li><a id="toc-i2c_005fwrite" href="#i2c_005fwrite">3.4.11 i2c_write</a></li>
</ul></li>
<li><a id="toc-Modbus-1" href="#Modbus">3.5 Modbus</a>
<ul class="toc-numbered-mark">
<li><a id="toc-_0040octave_005fmodbus_002fget" href="#g_t_0040octave_005fmodbus_002fget">3.5.1 @octave_modbus/get</a></li>
<li><a id="toc-_0040octave_005fmodbus_002fmaskWrite" href="#g_t_0040octave_005fmodbus_002fmaskWrite">3.5.2 @octave_modbus/maskWrite</a></li>
<li><a id="toc-_0040octave_005fmodbus_002fread" href="#g_t_0040octave_005fmodbus_002fread">3.5.3 @octave_modbus/read</a></li>
<li><a id="toc-_0040octave_005fmodbus_002fset" href="#g_t_0040octave_005fmodbus_002fset">3.5.4 @octave_modbus/set</a></li>
<li><a id="toc-_0040octave_005fmodbus_002fwrite" href="#g_t_0040octave_005fmodbus_002fwrite">3.5.5 @octave_modbus/write</a></li>
<li><a id="toc-_0040octave_005fmodbus_002fwriteRead" href="#g_t_0040octave_005fmodbus_002fwriteRead">3.5.6 @octave_modbus/writeRead</a></li>
<li><a id="toc-modbus" href="#modbus">3.5.7 modbus</a></li>
</ul></li>
<li><a id="toc-Parallel-1" href="#Parallel">3.6 Parallel</a>
<ul class="toc-numbered-mark">
<li><a id="toc-_0040octave_005fparallel_002ffclose" href="#g_t_0040octave_005fparallel_002ffclose">3.6.1 @octave_parallel/fclose</a></li>
<li><a id="toc-_0040octave_005fparallel_002ffopen" href="#g_t_0040octave_005fparallel_002ffopen">3.6.2 @octave_parallel/fopen</a></li>
<li><a id="toc-_0040octave_005fparallel_002ffread" href="#g_t_0040octave_005fparallel_002ffread">3.6.3 @octave_parallel/fread</a></li>
<li><a id="toc-_0040octave_005fparallel_002ffwrite" href="#g_t_0040octave_005fparallel_002ffwrite">3.6.4 @octave_parallel/fwrite</a></li>
<li><a id="toc-parallel" href="#parallel">3.6.5 parallel</a></li>
<li><a id="toc-pp_005fclose" href="#pp_005fclose">3.6.6 pp_close</a></li>
<li><a id="toc-pp_005fctrl" href="#pp_005fctrl">3.6.7 pp_ctrl</a></li>
<li><a id="toc-pp_005fdata" href="#pp_005fdata">3.6.8 pp_data</a></li>
<li><a id="toc-pp_005fdatadir" href="#pp_005fdatadir">3.6.9 pp_datadir</a></li>
<li><a id="toc-pp_005fstat" href="#pp_005fstat">3.6.10 pp_stat</a></li>
</ul></li>
<li><a id="toc-Serial-_0028Deprecated_0029-1" href="#Serial-_0028Deprecated_0029">3.7 Serial (Deprecated)</a>
<ul class="toc-numbered-mark">
<li><a id="toc-_0040octave_005fserial_002ffclose" href="#g_t_0040octave_005fserial_002ffclose">3.7.1 @octave_serial/fclose</a></li>
<li><a id="toc-_0040octave_005fserial_002fflushinput" href="#g_t_0040octave_005fserial_002fflushinput">3.7.2 @octave_serial/flushinput</a></li>
<li><a id="toc-_0040octave_005fserial_002fflushoutput" href="#g_t_0040octave_005fserial_002fflushoutput">3.7.3 @octave_serial/flushoutput</a></li>
<li><a id="toc-_0040octave_005fserial_002ffopen" href="#g_t_0040octave_005fserial_002ffopen">3.7.4 @octave_serial/fopen</a></li>
<li><a id="toc-_0040octave_005fserial_002ffprintf" href="#g_t_0040octave_005fserial_002ffprintf">3.7.5 @octave_serial/fprintf</a></li>
<li><a id="toc-_0040octave_005fserial_002ffread" href="#g_t_0040octave_005fserial_002ffread">3.7.6 @octave_serial/fread</a></li>
<li><a id="toc-_0040octave_005fserial_002ffwrite" href="#g_t_0040octave_005fserial_002ffwrite">3.7.7 @octave_serial/fwrite</a></li>
<li><a id="toc-_0040octave_005fserial_002fget" href="#g_t_0040octave_005fserial_002fget">3.7.8 @octave_serial/get</a></li>
<li><a id="toc-_0040octave_005fserial_002fserialbreak" href="#g_t_0040octave_005fserial_002fserialbreak">3.7.9 @octave_serial/serialbreak</a></li>
<li><a id="toc-_0040octave_005fserial_002fset" href="#g_t_0040octave_005fserial_002fset">3.7.10 @octave_serial/set</a></li>
<li><a id="toc-_0040octave_005fserial_002fsrl_005fbaudrate" href="#g_t_0040octave_005fserial_002fsrl_005fbaudrate">3.7.11 @octave_serial/srl_baudrate</a></li>
<li><a id="toc-_0040octave_005fserial_002fsrl_005fbytesize" href="#g_t_0040octave_005fserial_002fsrl_005fbytesize">3.7.12 @octave_serial/srl_bytesize</a></li>
<li><a id="toc-_0040octave_005fserial_002fsrl_005fclose" href="#g_t_0040octave_005fserial_002fsrl_005fclose">3.7.13 @octave_serial/srl_close</a></li>
<li><a id="toc-_0040octave_005fserial_002fsrl_005fflush" href="#g_t_0040octave_005fserial_002fsrl_005fflush">3.7.14 @octave_serial/srl_flush</a></li>
<li><a id="toc-_0040octave_005fserial_002fsrl_005fparity" href="#g_t_0040octave_005fserial_002fsrl_005fparity">3.7.15 @octave_serial/srl_parity</a></li>
<li><a id="toc-_0040octave_005fserial_002fsrl_005fstopbits" href="#g_t_0040octave_005fserial_002fsrl_005fstopbits">3.7.16 @octave_serial/srl_stopbits</a></li>
<li><a id="toc-_0040octave_005fserial_002fsrl_005ftimeout" href="#g_t_0040octave_005fserial_002fsrl_005ftimeout">3.7.17 @octave_serial/srl_timeout</a></li>
<li><a id="toc-serial" href="#serial">3.7.18 serial</a></li>
<li><a id="toc-seriallist" href="#seriallist">3.7.19 seriallist</a></li>
<li><a id="toc-srl_005fread" href="#srl_005fread">3.7.20 srl_read</a></li>
<li><a id="toc-srl_005fwrite" href="#srl_005fwrite">3.7.21 srl_write</a></li>
</ul></li>
<li><a id="toc-Serial-Port-1" href="#Serial-Port">3.8 Serial Port</a>
<ul class="toc-numbered-mark">
<li><a id="toc-_0040octave_005fserialport_002fconfigureTerminator" href="#g_t_0040octave_005fserialport_002fconfigureTerminator">3.8.1 @octave_serialport/configureTerminator</a></li>
<li><a id="toc-_0040octave_005fserialport_002fflush" href="#g_t_0040octave_005fserialport_002fflush">3.8.2 @octave_serialport/flush</a></li>
<li><a id="toc-_0040octave_005fserialport_002ffprintf" href="#g_t_0040octave_005fserialport_002ffprintf">3.8.3 @octave_serialport/fprintf</a></li>
<li><a id="toc-_0040octave_005fserialport_002ffread" href="#g_t_0040octave_005fserialport_002ffread">3.8.4 @octave_serialport/fread</a></li>
<li><a id="toc-_0040octave_005fserialport_002ffwrite" href="#g_t_0040octave_005fserialport_002ffwrite">3.8.5 @octave_serialport/fwrite</a></li>
<li><a id="toc-_0040octave_005fserialport_002fget" href="#g_t_0040octave_005fserialport_002fget">3.8.6 @octave_serialport/get</a></li>
<li><a id="toc-_0040octave_005fserialport_002fgetpinstatus" href="#g_t_0040octave_005fserialport_002fgetpinstatus">3.8.7 @octave_serialport/getpinstatus</a></li>
<li><a id="toc-_0040octave_005fserialport_002fread" href="#g_t_0040octave_005fserialport_002fread">3.8.8 @octave_serialport/read</a></li>
<li><a id="toc-_0040octave_005fserialport_002fserialbreak" href="#g_t_0040octave_005fserialport_002fserialbreak">3.8.9 @octave_serialport/serialbreak</a></li>
<li><a id="toc-_0040octave_005fserialport_002fset" href="#g_t_0040octave_005fserialport_002fset">3.8.10 @octave_serialport/set</a></li>
<li><a id="toc-_0040octave_005fserialport_002fsetDTR" href="#g_t_0040octave_005fserialport_002fsetDTR">3.8.11 @octave_serialport/setDTR</a></li>
<li><a id="toc-_0040octave_005fserialport_002fsetRTS" href="#g_t_0040octave_005fserialport_002fsetRTS">3.8.12 @octave_serialport/setRTS</a></li>
<li><a id="toc-_0040octave_005fserialport_002fwrite" href="#g_t_0040octave_005fserialport_002fwrite">3.8.13 @octave_serialport/write</a></li>
<li><a id="toc-serialport" href="#serialport">3.8.14 serialport</a></li>
<li><a id="toc-serialportlist" href="#serialportlist">3.8.15 serialportlist</a></li>
</ul></li>
<li><a id="toc-SPI-1" href="#SPI">3.9 SPI</a>
<ul class="toc-numbered-mark">
<li><a id="toc-_0040octave_005fspi_002ffclose" href="#g_t_0040octave_005fspi_002ffclose">3.9.1 @octave_spi/fclose</a></li>
<li><a id="toc-_0040octave_005fspi_002ffopen" href="#g_t_0040octave_005fspi_002ffopen">3.9.2 @octave_spi/fopen</a></li>
<li><a id="toc-_0040octave_005fspi_002ffread" href="#g_t_0040octave_005fspi_002ffread">3.9.3 @octave_spi/fread</a></li>
<li><a id="toc-_0040octave_005fspi_002ffwrite" href="#g_t_0040octave_005fspi_002ffwrite">3.9.4 @octave_spi/fwrite</a></li>
<li><a id="toc-_0040octave_005fspi_002fget" href="#g_t_0040octave_005fspi_002fget">3.9.5 @octave_spi/get</a></li>
<li><a id="toc-_0040octave_005fspi_002fread" href="#g_t_0040octave_005fspi_002fread">3.9.6 @octave_spi/read</a></li>
<li><a id="toc-_0040octave_005fspi_002fset" href="#g_t_0040octave_005fspi_002fset">3.9.7 @octave_spi/set</a></li>
<li><a id="toc-_0040octave_005fspi_002fwrite" href="#g_t_0040octave_005fspi_002fwrite">3.9.8 @octave_spi/write</a></li>
<li><a id="toc-_0040octave_005fspi_002fwriteAndRead" href="#g_t_0040octave_005fspi_002fwriteAndRead">3.9.9 @octave_spi/writeAndRead</a></li>
<li><a id="toc-spi" href="#spi">3.9.10 spi</a></li>
<li><a id="toc-spi_005fclose" href="#spi_005fclose">3.9.11 spi_close</a></li>
<li><a id="toc-spi_005fread" href="#spi_005fread">3.9.12 spi_read</a></li>
<li><a id="toc-spi_005fwrite" href="#spi_005fwrite">3.9.13 spi_write</a></li>
<li><a id="toc-spi_005fwriteAndRead" href="#spi_005fwriteAndRead">3.9.14 spi_writeAndRead</a></li>
</ul></li>
<li><a id="toc-TCP-_0028Deprecated_0029-1" href="#TCP-_0028Deprecated_0029">3.10 TCP (Deprecated)</a>
<ul class="toc-numbered-mark">
<li><a id="toc-_0040octave_005ftcp_002ffclose" href="#g_t_0040octave_005ftcp_002ffclose">3.10.1 @octave_tcp/fclose</a></li>
<li><a id="toc-_0040octave_005ftcp_002fflush" href="#g_t_0040octave_005ftcp_002fflush">3.10.2 @octave_tcp/flush</a></li>
<li><a id="toc-_0040octave_005ftcp_002fflushinput" href="#g_t_0040octave_005ftcp_002fflushinput">3.10.3 @octave_tcp/flushinput</a></li>
<li><a id="toc-_0040octave_005ftcp_002fflushoutput" href="#g_t_0040octave_005ftcp_002fflushoutput">3.10.4 @octave_tcp/flushoutput</a></li>
<li><a id="toc-_0040octave_005ftcp_002ffopen" href="#g_t_0040octave_005ftcp_002ffopen">3.10.5 @octave_tcp/fopen</a></li>
<li><a id="toc-_0040octave_005ftcp_002ffprintf" href="#g_t_0040octave_005ftcp_002ffprintf">3.10.6 @octave_tcp/fprintf</a></li>
<li><a id="toc-_0040octave_005ftcp_002ffread" href="#g_t_0040octave_005ftcp_002ffread">3.10.7 @octave_tcp/fread</a></li>
<li><a id="toc-_0040octave_005ftcp_002ffwrite" href="#g_t_0040octave_005ftcp_002ffwrite">3.10.8 @octave_tcp/fwrite</a></li>
<li><a id="toc-_0040octave_005ftcp_002fget" href="#g_t_0040octave_005ftcp_002fget">3.10.9 @octave_tcp/get</a></li>
<li><a id="toc-_0040octave_005ftcp_002fread" href="#g_t_0040octave_005ftcp_002fread">3.10.10 @octave_tcp/read</a></li>
<li><a id="toc-_0040octave_005ftcp_002fset" href="#g_t_0040octave_005ftcp_002fset">3.10.11 @octave_tcp/set</a></li>
<li><a id="toc-_0040octave_005ftcp_002fwrite" href="#g_t_0040octave_005ftcp_002fwrite">3.10.12 @octave_tcp/write</a></li>
<li><a id="toc-tcp" href="#tcp">3.10.13 tcp</a></li>
<li><a id="toc-tcp_005fclose" href="#tcp_005fclose">3.10.14 tcp_close</a></li>
<li><a id="toc-tcp_005fread" href="#tcp_005fread">3.10.15 tcp_read</a></li>
<li><a id="toc-tcp_005ftimeout" href="#tcp_005ftimeout">3.10.16 tcp_timeout</a></li>
<li><a id="toc-tcp_005fwrite" href="#tcp_005fwrite">3.10.17 tcp_write</a></li>
<li><a id="toc-tcpip" href="#tcpip">3.10.18 tcpip</a></li>
</ul></li>
<li><a id="toc-TCP-Client-2" href="#TCP-Client">3.11 TCP Client</a>
<ul class="toc-numbered-mark">
<li><a id="toc-_0040octave_005ftcpclient_002fconfigureTerminator" href="#g_t_0040octave_005ftcpclient_002fconfigureTerminator">3.11.1 @octave_tcpclient/configureTerminator</a></li>
<li><a id="toc-_0040octave_005ftcpclient_002fflush" href="#g_t_0040octave_005ftcpclient_002fflush">3.11.2 @octave_tcpclient/flush</a></li>
<li><a id="toc-_0040octave_005ftcpclient_002fget" href="#g_t_0040octave_005ftcpclient_002fget">3.11.3 @octave_tcpclient/get</a></li>
<li><a id="toc-_0040octave_005ftcpclient_002fread" href="#g_t_0040octave_005ftcpclient_002fread">3.11.4 @octave_tcpclient/read</a></li>
<li><a id="toc-_0040octave_005ftcpclient_002fset" href="#g_t_0040octave_005ftcpclient_002fset">3.11.5 @octave_tcpclient/set</a></li>
<li><a id="toc-_0040octave_005ftcpclient_002fwrite" href="#g_t_0040octave_005ftcpclient_002fwrite">3.11.6 @octave_tcpclient/write</a></li>
<li><a id="toc-tcpclient" href="#tcpclient">3.11.7 tcpclient</a></li>
</ul></li>
<li><a id="toc-TCP-Server-1" href="#TCP-Server">3.12 TCP Server</a>
<ul class="toc-numbered-mark">
<li><a id="toc-_0040octave_005ftcpserver_002fconfigureTerminator" href="#g_t_0040octave_005ftcpserver_002fconfigureTerminator">3.12.1 @octave_tcpserver/configureTerminator</a></li>
<li><a id="toc-_0040octave_005ftcpserver_002fflush" href="#g_t_0040octave_005ftcpserver_002fflush">3.12.2 @octave_tcpserver/flush</a></li>
<li><a id="toc-_0040octave_005ftcpserver_002fget" href="#g_t_0040octave_005ftcpserver_002fget">3.12.3 @octave_tcpserver/get</a></li>
<li><a id="toc-_0040octave_005ftcpserver_002fread" href="#g_t_0040octave_005ftcpserver_002fread">3.12.4 @octave_tcpserver/read</a></li>
<li><a id="toc-_0040octave_005ftcpserver_002fset" href="#g_t_0040octave_005ftcpserver_002fset">3.12.5 @octave_tcpserver/set</a></li>
<li><a id="toc-_0040octave_005ftcpserver_002fwrite" href="#g_t_0040octave_005ftcpserver_002fwrite">3.12.6 @octave_tcpserver/write</a></li>
<li><a id="toc-tcpserver" href="#tcpserver">3.12.7 tcpserver</a></li>
</ul></li>
<li><a id="toc-UDP-_0028Deprecated_0029-1" href="#UDP-_0028Deprecated_0029">3.13 UDP (Deprecated)</a>
<ul class="toc-numbered-mark">
<li><a id="toc-_0040octave_005fudp_002ffclose" href="#g_t_0040octave_005fudp_002ffclose">3.13.1 @octave_udp/fclose</a></li>
<li><a id="toc-_0040octave_005fudp_002fflush" href="#g_t_0040octave_005fudp_002fflush">3.13.2 @octave_udp/flush</a></li>
<li><a id="toc-_0040octave_005fudp_002fflushinput" href="#g_t_0040octave_005fudp_002fflushinput">3.13.3 @octave_udp/flushinput</a></li>
<li><a id="toc-_0040octave_005fudp_002fflushoutput" href="#g_t_0040octave_005fudp_002fflushoutput">3.13.4 @octave_udp/flushoutput</a></li>
<li><a id="toc-_0040octave_005fudp_002ffopen" href="#g_t_0040octave_005fudp_002ffopen">3.13.5 @octave_udp/fopen</a></li>
<li><a id="toc-_0040octave_005fudp_002ffprintf" href="#g_t_0040octave_005fudp_002ffprintf">3.13.6 @octave_udp/fprintf</a></li>
<li><a id="toc-_0040octave_005fudp_002ffread" href="#g_t_0040octave_005fudp_002ffread">3.13.7 @octave_udp/fread</a></li>
<li><a id="toc-_0040octave_005fudp_002ffwrite" href="#g_t_0040octave_005fudp_002ffwrite">3.13.8 @octave_udp/fwrite</a></li>
<li><a id="toc-_0040octave_005fudp_002fget" href="#g_t_0040octave_005fudp_002fget">3.13.9 @octave_udp/get</a></li>
<li><a id="toc-_0040octave_005fudp_002fread" href="#g_t_0040octave_005fudp_002fread">3.13.10 @octave_udp/read</a></li>
<li><a id="toc-_0040octave_005fudp_002fset" href="#g_t_0040octave_005fudp_002fset">3.13.11 @octave_udp/set</a></li>
<li><a id="toc-_0040octave_005fudp_002fwrite" href="#g_t_0040octave_005fudp_002fwrite">3.13.12 @octave_udp/write</a></li>
<li><a id="toc-udp" href="#udp">3.13.13 udp</a></li>
<li><a id="toc-udp_005fclose" href="#udp_005fclose">3.13.14 udp_close</a></li>
<li><a id="toc-udp_005fdemo" href="#udp_005fdemo">3.13.15 udp_demo</a></li>
<li><a id="toc-udp_005fread" href="#udp_005fread">3.13.16 udp_read</a></li>
<li><a id="toc-udp_005ftimeout" href="#udp_005ftimeout">3.13.17 udp_timeout</a></li>
<li><a id="toc-udp_005fwrite" href="#udp_005fwrite">3.13.18 udp_write</a></li>
</ul></li>
<li><a id="toc-UDP-Port-2" href="#UDP-Port">3.14 UDP Port</a>
<ul class="toc-numbered-mark">
<li><a id="toc-_0040octave_005fudpport_002fconfigureMulticast" href="#g_t_0040octave_005fudpport_002fconfigureMulticast">3.14.1 @octave_udpport/configureMulticast</a></li>
<li><a id="toc-_0040octave_005fudpport_002fconfigureTerminator" href="#g_t_0040octave_005fudpport_002fconfigureTerminator">3.14.2 @octave_udpport/configureTerminator</a></li>
<li><a id="toc-_0040octave_005fudpport_002fflush" href="#g_t_0040octave_005fudpport_002fflush">3.14.3 @octave_udpport/flush</a></li>
<li><a id="toc-_0040octave_005fudpport_002ffprintf" href="#g_t_0040octave_005fudpport_002ffprintf">3.14.4 @octave_udpport/fprintf</a></li>
<li><a id="toc-_0040octave_005fudpport_002ffread" href="#g_t_0040octave_005fudpport_002ffread">3.14.5 @octave_udpport/fread</a></li>
<li><a id="toc-_0040octave_005fudpport_002ffwrite" href="#g_t_0040octave_005fudpport_002ffwrite">3.14.6 @octave_udpport/fwrite</a></li>
<li><a id="toc-_0040octave_005fudpport_002fget" href="#g_t_0040octave_005fudpport_002fget">3.14.7 @octave_udpport/get</a></li>
<li><a id="toc-_0040octave_005fudpport_002fread" href="#g_t_0040octave_005fudpport_002fread">3.14.8 @octave_udpport/read</a></li>
<li><a id="toc-_0040octave_005fudpport_002fset" href="#g_t_0040octave_005fudpport_002fset">3.14.9 @octave_udpport/set</a></li>
<li><a id="toc-_0040octave_005fudpport_002fwrite" href="#g_t_0040octave_005fudpport_002fwrite">3.14.10 @octave_udpport/write</a></li>
<li><a id="toc-_0040octave_005fudpport_002fwriteline" href="#g_t_0040octave_005fudpport_002fwriteline">3.14.11 @octave_udpport/writeline</a></li>
<li><a id="toc-udpport" href="#udpport">3.14.12 udpport</a></li>
</ul></li>
<li><a id="toc-USBTMC-1" href="#USBTMC">3.15 USBTMC</a>
<ul class="toc-numbered-mark">
<li><a id="toc-_0040octave_005fusbtmc_002ffclose" href="#g_t_0040octave_005fusbtmc_002ffclose">3.15.1 @octave_usbtmc/fclose</a></li>
<li><a id="toc-_0040octave_005fusbtmc_002ffopen" href="#g_t_0040octave_005fusbtmc_002ffopen">3.15.2 @octave_usbtmc/fopen</a></li>
<li><a id="toc-_0040octave_005fusbtmc_002ffread" href="#g_t_0040octave_005fusbtmc_002ffread">3.15.3 @octave_usbtmc/fread</a></li>
<li><a id="toc-_0040octave_005fusbtmc_002ffwrite" href="#g_t_0040octave_005fusbtmc_002ffwrite">3.15.4 @octave_usbtmc/fwrite</a></li>
<li><a id="toc-usbtmc" href="#usbtmc">3.15.5 usbtmc</a></li>
<li><a id="toc-usbtmc_005fclose" href="#usbtmc_005fclose">3.15.6 usbtmc_close</a></li>
<li><a id="toc-usbtmc_005fread" href="#usbtmc_005fread">3.15.7 usbtmc_read</a></li>
<li><a id="toc-usbtmc_005fwrite" href="#usbtmc_005fwrite">3.15.8 usbtmc_write</a></li>
</ul></li>
<li><a id="toc-VXI11-1" href="#VXI11">3.16 VXI11</a>
<ul class="toc-numbered-mark">
<li><a id="toc-_0040octave_005fvxi11_002ffclose" href="#g_t_0040octave_005fvxi11_002ffclose">3.16.1 @octave_vxi11/fclose</a></li>
<li><a id="toc-_0040octave_005fvxi11_002ffopen" href="#g_t_0040octave_005fvxi11_002ffopen">3.16.2 @octave_vxi11/fopen</a></li>
<li><a id="toc-_0040octave_005fvxi11_002ffread" href="#g_t_0040octave_005fvxi11_002ffread">3.16.3 @octave_vxi11/fread</a></li>
<li><a id="toc-_0040octave_005fvxi11_002ffwrite" href="#g_t_0040octave_005fvxi11_002ffwrite">3.16.4 @octave_vxi11/fwrite</a></li>
<li><a id="toc-vxi11" href="#vxi11">3.16.5 vxi11</a></li>
<li><a id="toc-vxi11_005fclose" href="#vxi11_005fclose">3.16.6 vxi11_close</a></li>
<li><a id="toc-vxi11_005fread" href="#vxi11_005fread">3.16.7 vxi11_read</a></li>
<li><a id="toc-vxi11_005fwrite" href="#vxi11_005fwrite">3.16.8 vxi11_write</a></li>
</ul></li>
</ul></li>
<li><a id="toc-GNU-General-Public-License" href="#Copying">Appendix A GNU General Public License</a></li>
<li><a id="toc-Index-1" href="#Index" rel="index">Index</a></li>
</ul>
</div>
</div>
<hr>
<div class="chapter-level-extent" id="Installing-and-loading">
<div class="nav-panel">
<p>
Next: <a href="#Basic-Usage-Overview" accesskey="n" rel="next">Basic Usage Overview</a>, Previous: <a href="#Top" accesskey="p" rel="prev">Introduction</a>, Up: <a href="#Top" accesskey="u" rel="up">Introduction</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h2 class="chapter" id="Installing-and-loading-1">1 Installing and loading</h2>
<a class="index-entry-id" id="index-Installing-and-loading"></a>
<p>The Instrument Control toolkit must be installed and then loaded to be used.
</p>
<p>It can be installed in <abbr class="acronym">GNU</abbr> Octave directly from octave-forge,
or can be installed in an off-line mode via a downloaded tarball.
</p>
<p>The toolkit must be then be loaded once per each <abbr class="acronym">GNU</abbr> Octave session in order to use its functionality.
</p>
<ul class="mini-toc">
<li><a href="#Requirements" accesskey="1">Requirements</a></li>
<li><a href="#Windows-install" accesskey="2">Windows install</a></li>
<li><a href="#Online-Direct-install" accesskey="3">Online Direct install</a></li>
<li><a href="#Off_002dline-install" accesskey="4">Off-line install</a></li>
<li><a href="#Loading" accesskey="5">Loading</a></li>
</ul>
<div class="section-level-extent" id="Requirements">
<h3 class="section">1.1 Requirements</h3>
<a class="index-entry-id" id="index-Requirements"></a>
<p>For GPIB support (Linux only), linux-gpib must be installed before installing instrument-control.
GPIB support is also available for windows by following the information from the wiki:
https://wiki.octave.org/Instrument_control_package#Requirements
</p>
<p>For VXI11 support, rpcgen, and libtirpc-devel must be installed before installing instrument-control.
</p>
<p>For MODBUS support, the libmodbus-devel must be installed before installing instrument-control.
</p>
</div>
<div class="section-level-extent" id="Windows-install">
<h3 class="section">1.2 Windows install</h3>
<a class="index-entry-id" id="index-Windows-install"></a>
<p>If using the <abbr class="acronym">GNU</abbr> Octave installer in Windows, the toolkit will have already been installed, and does not need to be re-installed
unless a newer version is available.
</p>
<p>Run the following command to verify if the toolkit is available:
</p>
<div class="example">
<pre class="example-preformatted">pkg list instrument-control
</pre></div>
</div>
<div class="section-level-extent" id="Online-Direct-install">
<h3 class="section">1.3 Online Direct install</h3>
<a class="index-entry-id" id="index-Online-install"></a>
<p>With an internet connection available, toolkit can be installed from
octave-forge using the following command within <abbr class="acronym">GNU</abbr> Octave:
</p>
<div class="example">
<pre class="example-preformatted">pkg install -forge instrument-control
</pre></div>
<p>The latest released version of the toolkit will be downloaded, compiled and installed.
</p>
</div>
<div class="section-level-extent" id="Off_002dline-install">
<h3 class="section">1.4 Off-line install</h3>
<a class="index-entry-id" id="index-Off_002dline-install"></a>
<p>With the toolkit package already downloaded, and in the current directory when running
<abbr class="acronym">GNU</abbr> Octave, the package can be installed using the following command within <abbr class="acronym">GNU</abbr> Octave:
</p>
<div class="example">
<pre class="example-preformatted">pkg install instrument-control-0.9.2.tar.gz
</pre></div>
</div>
<div class="section-level-extent" id="Loading">
<h3 class="section">1.5 Loading</h3>
<a class="index-entry-id" id="index-Loading"></a>
<p>Regardless of the method of installing the toolkit, in order to use its functions,
the toolkit must be loaded using the pkg load command:
</p>
<div class="example">
<pre class="example-preformatted">pkg load instrument-control
</pre></div>
<p>The toolkit must be loaded on each <abbr class="acronym">GNU</abbr> Octave session.
</p>
<hr>
</div>
</div>
<div class="chapter-level-extent" id="Basic-Usage-Overview">
<div class="nav-panel">
<p>
Next: <a href="#Function-Reference" accesskey="n" rel="next">Function Reference</a>, Previous: <a href="#Installing-and-loading" accesskey="p" rel="prev">Installing and loading</a>, Up: <a href="#Top" accesskey="u" rel="up">Introduction</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h2 class="chapter" id="Basic-Usage-Overview-1">2 Basic Usage Overview</h2>
<a class="index-entry-id" id="index-Basic-Usage-Overview"></a>
<ul class="mini-toc">
<li><a href="#Authors" accesskey="1">Authors</a></li>
<li><a href="#Available-Interface" accesskey="2">Available Interfaces</a></li>
<li><a href="#Basic-Serial" accesskey="3">Basic Serial</a></li>
<li><a href="#Basic-TCP" accesskey="4">Basic TCP</a></li>
<li><a href="#Basic-UDP" accesskey="5">Basic UDP</a></li>
</ul>
<hr>
<div class="section-level-extent" id="Authors">
<div class="nav-panel">
<p>
Next: <a href="#Available-Interface" accesskey="n" rel="next">Available Interfaces</a>, Up: <a href="#Basic-Usage-Overview" accesskey="u" rel="up">Basic Usage Overview</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="Authors-1">2.1 Authors</h3>
<p>The Instrument control package provides low level I/O functions for serial, i2c, spi, parallel, tcp, gpib, vxi11, udp and usbtmc interfaces.
</p>
<p>It was written mainly by the following developers:
</p>
<ul class="itemize mark-bullet">
<li>Andrius Sutas <andrius.sutasg at mail.com>
</li><li>Stefan Mahr <dac922 at gmx.de>
</li><li>John Donoghue <john.donoghue at ieee.org>
</li></ul>
<hr>
</div>
<div class="section-level-extent" id="Available-Interface">
<div class="nav-panel">
<p>
Next: <a href="#Basic-Serial" accesskey="n" rel="next">Basic Serial</a>, Previous: <a href="#Authors" accesskey="p" rel="prev">Authors</a>, Up: <a href="#Basic-Usage-Overview" accesskey="u" rel="up">Basic Usage Overview</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="Available-Interfaces">2.2 Available Interfaces</h3>
<p>The ability to use each interface is dependent on OS and what libraries were available during the toolkit install.
</p>
<p>To verify the available interfaces, run the following command in octave:
</p>
<div class="example">
<pre class="example-preformatted">instrhwinfo
</pre></div>
<p>The function will return information on the supported interfaces that are available, similar to below:
</p>
<div class="example">
<pre class="example-preformatted"> ToolboxVersion = 0.7.0
ToolboxName = octave instrument control package
SupportedInterfaces =
{
[1,1] = gpib
[1,2] = i2c
[1,3] = parallel
[1,4] = serial
[1,5] = serialport
[1,6] = tcp
[1,7] = tcpclient
[1,8] = udp
[1,9] = udpport
[1,10] = usbtmc
[1,11] = vxi11
}
</pre></div>
<p>Most interfaces have two types of functions:
</p>
<ul class="itemize mark-bullet">
<li>somewhat compatible matlab functions such as fread, fwrite
</li><li>interface specific lower level functions such as udp_read, udp_write
</li></ul>
<hr>
</div>
<div class="section-level-extent" id="Basic-Serial">
<div class="nav-panel">
<p>
Next: <a href="#Basic-TCP" accesskey="n" rel="next">Basic TCP</a>, Previous: <a href="#Available-Interface" accesskey="p" rel="prev">Available Interfaces</a>, Up: <a href="#Basic-Usage-Overview" accesskey="u" rel="up">Basic Usage Overview</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="Basic-Serial-1">2.3 Basic Serial</h3>
<ul class="mini-toc">
<li><a href="#Serial" accesskey="1">Serial</a></li>
<li><a href="#SerialPort" accesskey="2">SerialPort</a></li>
</ul>
<div class="subsection-level-extent" id="Serial">
<h4 class="subsection">2.3.1 Serial</h4>
<table class="cartouche" border="1"><tr><td>
<p><strong class="strong">NOTE</strong>: The serial object has been deprecated and may not appear in newer versions of the instrument-control toolbox. Instead new code should use the serialport object.
</p></td></tr></table>
<p>The serial port can be opened using the serial function:
</p>
<div class="example">
<pre class="example-preformatted">s = serial("/dev/ttyUSB1", 115200)
</pre></div>
<p>The first parameter is the device name and is OS specific. The second parameter is the baudrate.
</p>
<p>A list of available serial ports can be retrieved using the function:
</p>
<div class="example">
<pre class="example-preformatted">seriallist
</pre></div>
<p>After creating the interface object, properties of the device can be set or retrieved using get or set functions or as property access.
</p>
<div class="example">
<pre class="example-preformatted">s = serial("/dev/ttyUSB1", 115200)
br = get(s, "baudrate") # gets the baudrate
br = s.baudrate # also gets the baudrate
set(s, "baudrate", 9600) # set the baudrate
s.baudrate = 9600 # also sets the baudrate
</pre></div>
<p>The device can be written and read from using fread, fwrite and srl_read and slr_write functions.
</p>
<div class="example">
<pre class="example-preformatted">srl_write(s, "hello world") # write hello world
fprintf(s, "hello again")
val = srl_read(s, 10) # attempt to read
val = fread(s, 10)
</pre></div>
<p>The device can be closed using fclose or srl_close.
</p>
<div class="example">
<pre class="example-preformatted">fclose(s)
</pre></div>
</div>
<div class="subsection-level-extent" id="SerialPort">
<h4 class="subsection">2.3.2 SerialPort</h4>
<p>The recommended method of accessing serial ports is through the serialport object.
</p>
<p>The serial port can be opened using the serialport function:
</p>
<div class="example">
<pre class="example-preformatted">s = serialport("/dev/ttyUSB1", 115200)
</pre></div>
<p>The first parameter is the device name and is OS specific. The second parameter is the baudrate.
</p>
<p>A list of available serial ports can be retrieved using the function:
</p>
<div class="example">
<pre class="example-preformatted">serialportlist
</pre></div>
<p>After creating the interface object, properties of the device can be set or retrieved using get or set functions or as property access.
</p>
<div class="example">
<pre class="example-preformatted">s = serialport("/dev/ttyUSB1", 115200)
br = get(s, "BaudRate") # gets the baudrate
br = s.BaudRate # also gets the baudrate
set(s, "BaudRate", 9600) # set the baudrate
s.BaudRate = 9600 # also sets the baudrate
</pre></div>
<p>The device can be written and read from using read and write functions.
</p>
<div class="example">
<pre class="example-preformatted">write(s, "hello world") # write hello world
val = read(s, 10)
</pre></div>
<p>The device can be closed by clearing the serialport object.
</p>
<div class="example">
<pre class="example-preformatted">clear s
</pre></div>
<hr>
</div>
</div>
<div class="section-level-extent" id="Basic-TCP">
<div class="nav-panel">
<p>
Next: <a href="#Basic-UDP" accesskey="n" rel="next">Basic UDP</a>, Previous: <a href="#Basic-Serial" accesskey="p" rel="prev">Basic Serial</a>, Up: <a href="#Basic-Usage-Overview" accesskey="u" rel="up">Basic Usage Overview</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="Basic-TCP-1">2.4 Basic TCP</h3>
<ul class="mini-toc">
<li><a href="#TCP" accesskey="1">TCP</a></li>
<li><a href="#TCP-Client-1" accesskey="2">TCP Client</a></li>
</ul>
<div class="subsection-level-extent" id="TCP">
<h4 class="subsection">2.4.1 TCP</h4>
<table class="cartouche" border="1"><tr><td>
<p><strong class="strong">NOTE</strong>: The TCP object has been deprecated and may not appear in newer versions of the instrument-control toolbox. Instead new code should use the tcpclient object.
</p></td></tr></table>
<p>A TCP connection can be opened using the tcp or tcpip function:
</p>
<div class="example">
<pre class="example-preformatted">s = tcp("127.0.0.1", 80)
</pre></div>
<p>The first parameter is the IP address to connect to. The second parameter is the port number. And optional timeout value can be also be provided.
</p>
<p>A more matlab compatible function is available as tcpip to also open a tcp port:
</p>
<div class="example">
<pre class="example-preformatted">s = tcpip("gnu.org", 80)
</pre></div>
<p>The first parameter is a hostname or ip address, the second the port number. Additional parameter/value pairs can be provided after the port.
</p>
<p>After creating the interface object, properties of the device can be set or retrieved using get or set functions or as property access.
</p>
<div class="example">
<pre class="example-preformatted">s = tcp("127.0.0.1", 80)
oldtimeout = get(s, "timeout") # get timeout
set(s, "timeout", 10) # set the timeout
s.timeout = oldtimeout # also sets the timeout
</pre></div>
<p>The device can be written and read from using fread, fwrite and tcp_read and tcp_write functions.
</p>
<div class="example">
<pre class="example-preformatted">tcp_write(s, "HEAD / HTTP/1.1\r\n\r\n")
val = tcp_read(s, 100, 500) # attempt to read 100 bytes
</pre></div>
<p>The device can be closed using fclose or tcp_close.
</p>
<div class="example">
<pre class="example-preformatted">fclose(s)
</pre></div>
</div>
<div class="subsection-level-extent" id="TCP-Client-1">
<h4 class="subsection">2.4.2 TCP Client</h4>
<p>The recommended method of creating a tcp connection is through the tcpclient object.
</p>
<p>A TCP connection can be opened using the tcpclient function:
</p>
<div class="example">
<pre class="example-preformatted">s = tcpclient("127.0.0.1", 80)
</pre></div>
<p>The first parameter is the IP address or hostname to connect to. The second parameter is the port number.
</p>
<p>Additional parameter/value pairs can be provided after the port.
</p>
<p>After creating the interface object, properties of the device can be set or retrieved using get or set functions or as property access.
</p>
<div class="example">
<pre class="example-preformatted">s = tcpclient("127.0.0.1", 80)
oldtimeout = get(s, "Timeout") # get timeout
set(s, "Timeout", 10) # set the timeout
s.Timeout = oldtimeout # also sets the timeout
</pre></div>
<p>The device can be written and read from using read and write functions.
</p>
<div class="example">
<pre class="example-preformatted">write(s, "HEAD / HTTP/1.1\r\n\r\n")
val = read(s, 100) # attempt to read 100 bytes
</pre></div>
<p>The device can be closed by clearing the object variable.
</p>
<div class="example">
<pre class="example-preformatted">clear s
</pre></div>
<hr>
</div>
</div>
<div class="section-level-extent" id="Basic-UDP">
<div class="nav-panel">
<p>
Previous: <a href="#Basic-TCP" accesskey="p" rel="prev">Basic TCP</a>, Up: <a href="#Basic-Usage-Overview" accesskey="u" rel="up">Basic Usage Overview</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="Basic-UDP-1">2.5 Basic UDP</h3>
<ul class="mini-toc">
<li><a href="#UDP" accesskey="1">UDP</a></li>
<li><a href="#UDP-Port-1" accesskey="2">UDP Port</a></li>
</ul>
<div class="subsection-level-extent" id="UDP">
<h4 class="subsection">2.5.1 UDP</h4>
<table class="cartouche" border="1"><tr><td>
<p><strong class="strong">NOTE</strong>: The UDP object has been deprecated and may not appear in newer versions of the instrument-control toolbox. Instead new code should use the udpport object.
</p></td></tr></table>
<p>A UDP connection can be opened using the udp function:
</p>
<div class="example">
<pre class="example-preformatted">s = udp("127.0.0.1", 80)
</pre></div>
<p>The first parameter is the IP address data will be to. The second parameter is the port number.
</p>
<p>If and ip address and port is not provides, it will default to "127.0.0.1" and 23.
</p>
<p>The address and port can be changed after creation using the remotehost and remoteport properties.
</p>
<div class="example">
<pre class="example-preformatted">s = udp()
s.remotehost = "127.0.0.1";
s.remoteport = 100;
</pre></div>
<p>After creating the interface object, other properties of the device can be set or retrieved using get or set functions or as property access.
</p>
<div class="example">
<pre class="example-preformatted">s = udp("127.0.0.1", 80)
oldtimeout = get(s, "timeout") # get timeout
set(s, "timeout", 10) # set the timeout
s.timeout = oldtimeout # also sets the timeout
</pre></div>
<p>The device can be written and read from using fread, fwrite and udp_read and udp_write functions.
</p>
<div class="example">
<pre class="example-preformatted">udp_write(s, "test")
val = udp_read(s, 5)
</pre></div>
<p>The device can be closed using fclose or udp_close.
</p>
<div class="example">
<pre class="example-preformatted">fclose(s)
</pre></div>
</div>
<div class="subsection-level-extent" id="UDP-Port-1">
<h4 class="subsection">2.5.2 UDP Port</h4>
<p>The recommended method of creating a udp socket is through the udpport object.
</p>
<p>A udpport object can be created using the udpport function:
</p>
<div class="example">
<pre class="example-preformatted">s = udpport()
</pre></div>
<p>Additional parameter/value pairs can be provided during creation of the object.
</p>
<p>After creating the interface object, properties of the device can be set or retrieved using get or set functions or as property access.
</p>
<div class="example">
<pre class="example-preformatted">s = udpport()
oldtimeout = get(s, "Timeout") # get timeout
set(s, "Timeout", 10) # set the timeout
s.Timeout = oldtimeout # also sets the timeout
</pre></div>
<p>The device can be written and read from using read and write functions.
</p>
<p>The destination address and port to send data to must be specified at least on the first time write is used.
</p>
<div class="example">
<pre class="example-preformatted">write(s, "test", "127.0.0.1", s.LocalPort)
val = read(s)
</pre></div>
<p>The device can be closed by clearing the object variable.
</p>
<div class="example">
<pre class="example-preformatted">clear s
</pre></div>
<hr>
</div>
</div>
</div>
<div class="chapter-level-extent" id="Function-Reference">
<div class="nav-panel">
<p>
Next: <a href="#Copying" accesskey="n" rel="next">GNU General Public License</a>, Previous: <a href="#Basic-Usage-Overview" accesskey="p" rel="prev">Basic Usage Overview</a>, Up: <a href="#Top" accesskey="u" rel="up">Introduction</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h2 class="chapter" id="Function-Reference-1">3 Function Reference</h2>
<a class="index-entry-id" id="index-Function-Reference"></a>
<p>The functions currently available in the toolkit are described below.
</p>
<ul class="mini-toc">
<li><a href="#Common-Functions" accesskey="1">Common Functions</a></li>
<li><a href="#General" accesskey="2">General</a></li>
<li><a href="#GPIB" accesskey="3">GPIB</a></li>
<li><a href="#I2C" accesskey="4">I2C</a></li>
<li><a href="#Modbus" accesskey="5">Modbus</a></li>
<li><a href="#Parallel" accesskey="6">Parallel</a></li>
<li><a href="#Serial-_0028Deprecated_0029" accesskey="7">Serial (Deprecated)</a></li>
<li><a href="#Serial-Port" accesskey="8">Serial Port</a></li>
<li><a href="#SPI" accesskey="9">SPI</a></li>
<li><a href="#TCP-_0028Deprecated_0029">TCP (Deprecated)</a></li>
<li><a href="#TCP-Client">TCP Client</a></li>
<li><a href="#TCP-Server">TCP Server</a></li>
<li><a href="#UDP-_0028Deprecated_0029">UDP (Deprecated)</a></li>
<li><a href="#UDP-Port">UDP Port</a></li>
<li><a href="#USBTMC">USBTMC</a></li>
<li><a href="#VXI11">VXI11</a></li>
</ul>
<hr>
<div class="section-level-extent" id="Common-Functions">
<div class="nav-panel">
<p>
Next: <a href="#General" accesskey="n" rel="next">General</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="Common-Functions-1">3.1 Common Functions</h3>
<a class="index-entry-id" id="index-Common-Functions"></a>
<ul class="mini-toc">
<li><a href="#flushinput" accesskey="1">flushinput</a></li>
<li><a href="#flushoutput" accesskey="2">flushoutput</a></li>
<li><a href="#readbinblock" accesskey="3">readbinblock</a></li>
<li><a href="#readline" accesskey="4">readline</a></li>
<li><a href="#writebinblock" accesskey="5">writebinblock</a></li>
<li><a href="#writeline" accesskey="6">writeline</a></li>
<li><a href="#writeread" accesskey="7">writeread</a></li>
</ul>
<div class="subsection-level-extent" id="flushinput">
<h4 class="subsection">3.1.1 flushinput</h4>
<a class="index-entry-id" id="index-flushinput"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-flushinput-4"><span class="category-def">: </span><span><strong class="def-name">flushinput</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-flushinput-4'> ¶</a></span></dt>
<dd><p>Flush the instruments input buffers
</p>
<h4 class="subsubheading" id="Inputs">Inputs</h4>
<p><var class="var">dev</var> - connected device or array of devices
</p>
<h4 class="subsubheading" id="Outputs">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> flushoutput.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="flushoutput">
<h4 class="subsection">3.1.2 flushoutput</h4>
<a class="index-entry-id" id="index-flushoutput"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-flushoutput-4"><span class="category-def">: </span><span><strong class="def-name">flushoutput</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-flushoutput-4'> ¶</a></span></dt>
<dd><p>Flush the instruments output buffers
</p>
<h4 class="subsubheading" id="Inputs-1">Inputs</h4>
<p><var class="var">dev</var> - connected device or array of devices
</p>
<h4 class="subsubheading" id="Outputs-1">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> flushinput.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="readbinblock">
<h4 class="subsection">3.1.3 readbinblock</h4>
<a class="index-entry-id" id="index-readbinblock"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-readbinblock-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">readbinblock</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-readbinblock-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-readbinblock-2"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">readbinblock</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">datatype</var>)</code><a class="copiable-link" href='#index-readbinblock-2'> ¶</a></span></dt>
<dd><p>read a binblock of data from a instrument device
</p>
<h4 class="subsubheading" id="Inputs-2">Inputs</h4>
<p><var class="var">dev</var> - connected device
</p>
<p><var class="var">datatype</var> - optional data type to read data as (default ’uint8’)
</p>
<h4 class="subsubheading" id="Outputs-2">Outputs</h4>
<p><var class="var">data</var> - data read
</p>
<p><strong class="strong">See also:</strong> flushoutput.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="readline">
<h4 class="subsection">3.1.4 readline</h4>
<a class="index-entry-id" id="index-readline"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-readline-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">readline</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-readline-1'> ¶</a></span></dt>
<dd><p>read data from a instrument device excluding terminator value
</p>
<h4 class="subsubheading" id="Inputs-3">Inputs</h4>
<p><var class="var">dev</var> - connected device
</p>
<h4 class="subsubheading" id="Outputs-3">Outputs</h4>
<p><var class="var">data</var> - ASCII data read
</p>
<p><strong class="strong">See also:</strong> flushoutput.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="writebinblock">
<h4 class="subsection">3.1.5 writebinblock</h4>
<a class="index-entry-id" id="index-writebinblock"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-writebinblock-1"><span class="category-def">: </span><span><strong class="def-name">writebinblock</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">data</var>, <var class="var">datatype</var>)</code><a class="copiable-link" href='#index-writebinblock-1'> ¶</a></span></dt>
<dd><p>Write a IEEE 488.2 binblock of data to a instrument device
</p>
<p>binblock formatted data is defined as:
</p>
<p>#<A><B><C>
</p>
<p>where:
<A> ASCII number containing the length of part <B>
</p>
<p><B> ASCII number containing the number of bytes of <C>
</p>
<p><C> Binary data block
</p>
<h4 class="subsubheading" id="Inputs-4">Inputs</h4>
<p><var class="var">dev</var> - connected device
</p>
<p><var class="var">data</var> - binary data to send
</p>
<p><var class="var">datatype</var> - datatype to send data as
</p>
<h4 class="subsubheading" id="Outputs-4">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> flushoutput.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="writeline">
<h4 class="subsection">3.1.6 writeline</h4>
<a class="index-entry-id" id="index-writeline"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-writeline-2"><span class="category-def">: </span><span><strong class="def-name">writeline</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-writeline-2'> ¶</a></span></dt>
<dd><p>Write data to a instrument device including terminator value
</p>
<h4 class="subsubheading" id="Inputs-5">Inputs</h4>
<p><var class="var">dev</var> - connected device
</p>
<p><var class="var">data</var> - ASCII data to write
</p>
<h4 class="subsubheading" id="Outputs-5">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> flushoutput.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="writeread">
<h4 class="subsection">3.1.7 writeread</h4>
<a class="index-entry-id" id="index-writeread"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-writeread-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">writeread</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">command</var>)</code><a class="copiable-link" href='#index-writeread-1'> ¶</a></span></dt>
<dd><p>write a ASCII command and read data from a instrument device.
</p>
<h4 class="subsubheading" id="Inputs-6">Inputs</h4>
<p><var class="var">dev</var> - connected device
</p>
<p><var class="var">command</var> - ASCII command
</p>
<h4 class="subsubheading" id="Outputs-6">Outputs</h4>
<p><var class="var">data</var> - ASCII data read
</p>
<p><strong class="strong">See also:</strong> readline, writeline.
</p></dd></dl>
<hr>
</div>
</div>
<div class="section-level-extent" id="General">
<div class="nav-panel">
<p>
Next: <a href="#GPIB" accesskey="n" rel="next">GPIB</a>, Previous: <a href="#Common-Functions" accesskey="p" rel="prev">Common Functions</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="General-1">3.2 General</h3>
<a class="index-entry-id" id="index-General"></a>
<ul class="mini-toc">
<li><a href="#instrhelp" accesskey="1">instrhelp</a></li>
<li><a href="#instrhwinfo" accesskey="2">instrhwinfo</a></li>
<li><a href="#resolvehost" accesskey="3">resolvehost</a></li>
</ul>
<div class="subsection-level-extent" id="instrhelp">
<h4 class="subsection">3.2.1 instrhelp</h4>
<a class="index-entry-id" id="index-instrhelp"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-instrhelp-1"><span class="category-def">: </span><span><strong class="def-name">instrhelp</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href='#index-instrhelp-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-instrhelp-2"><span class="category-def">: </span><span><strong class="def-name">instrhelp</strong> <code class="def-code-arguments">(<var class="var">funcname</var>)</code><a class="copiable-link" href='#index-instrhelp-2'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-instrhelp-3"><span class="category-def">: </span><span><strong class="def-name">instrhelp</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-instrhelp-3'> ¶</a></span></dt>
<dd><p>Display instrument help
</p>
<h4 class="subsubheading" id="Inputs-7">Inputs</h4>
<p><var class="var">funcname</var> - function to display help about.<br>
<var class="var">obj</var> - object to display help about.<br>
</p>
<p>If no input is provided, the function will display and overview
of the package functionality.
</p>
<h4 class="subsubheading" id="Outputs-7">Outputs</h4>
<p>None
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="instrhwinfo">
<h4 class="subsection">3.2.2 instrhwinfo</h4>
<a class="index-entry-id" id="index-instrhwinfo"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-instrhwinfo-1"><span class="category-def">Function File: </span><span><code class="def-type">[<var class="var">list</var>] =</code> <strong class="def-name">instrhwinfo</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href='#index-instrhwinfo-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-instrhwinfo-2"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">list</var> =</code> <strong class="def-name">instrhwinfo</strong> <code class="def-code-arguments">(<var class="var">interface</var>)</code><a class="copiable-link" href='#index-instrhwinfo-2'> ¶</a></span></dt>
<dd><p>Query available hardware for instrument-control
</p>
<p>When run without any input parameters, instrhwinfo will provide the toolbox
information and a list of supported interfaces.
</p>
<h4 class="subsubheading" id="Inputs-8">Inputs</h4>
<p><var class="var">interface</var> is the instrument interface to query. When provided, instrhwinfo
will provide information on the specified interface.
</p>
<p>Currently only interface "serialport","i2c" and "spi" and is supported, which will provide a list of
available serial ports or i2c ports.
</p>
<h4 class="subsubheading" id="Outputs-8">Outputs</h4>
<p>If an output variable is provided, the function will store the information
to the variable, otherwise it will be displayed to the screen.
</p>
<h4 class="subsubheading" id="Example">Example</h4>
<div class="example">
<pre class="example-preformatted"> instrhwinfo
scalar structure containing the fields:
ToolboxVersion = 0.4.0
ToolboxName = octave instrument control package
SupportedInterfaces =
{
[1,1] = i2c
[1,2] = parallel
[1,3] = serialport
[1,4] = tcp
[1,5] = udp
[1,6] = usbtmc
[1,7] = vxi11
}
</pre></div>
</dd></dl>
</div>
<div class="subsection-level-extent" id="resolvehost">
<h4 class="subsection">3.2.3 resolvehost</h4>
<a class="index-entry-id" id="index-resolvehost"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-resolvehost-1"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">name</var> =</code> <strong class="def-name">resolvehost</strong> <code class="def-code-arguments">(<var class="var">host</var>)</code><a class="copiable-link" href='#index-resolvehost-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-resolvehost-2"><span class="category-def">Loadable Function: </span><span><code class="def-type">[<var class="var">name</var>, <var class="var">address</var>] =</code> <strong class="def-name">resolvehost</strong> <code class="def-code-arguments">(<var class="var">host</var>)</code><a class="copiable-link" href='#index-resolvehost-2'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-resolvehost-3"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">out</var> =</code> <strong class="def-name">resolvehost</strong> <code class="def-code-arguments">(<var class="var">host</var>, <var class="var">returntype</var>)</code><a class="copiable-link" href='#index-resolvehost-3'> ¶</a></span></dt>
<dd>
<p>Resolve a network host name or address to network name and address
</p>
<h4 class="subsubheading" id="Inputs-9">Inputs</h4>
<p><var class="var">host</var> - Host name or IP address string to resolve.<br>
<var class="var">name</var> - Resolved IP host name.<br>
<var class="var">returntype</var> - ’name’ to get host name, ’address’ to get IP address.
</p>
<h4 class="subsubheading" id="Outputs-9">Outputs</h4>
<p><var class="var">name</var> - Resolved IP host name.<br>
<var class="var">address</var> - Resolved IP host address.<br>
<var class="var">out</var> - host name if <var class="var">returntype</var> is ’name’, ipaddress if <var class="var">returntype</var> is ’address’<br>
</p>
<h4 class="subsubheading" id="Example-1">Example</h4>
<div class="example">
<pre class="example-preformatted">%% get resolved ip name and address of www.gnu.org
[name, address] = resolvehost ('www.gnu.org');
%% get ip address of www.gnu.org
ipaddress = resolvehost ('www.gnu.org', 'address');
</pre></div>
<p><strong class="strong">See also:</strong> tcp, udp.
</p>
</dd></dl>
<hr>
</div>
</div>
<div class="section-level-extent" id="GPIB">
<div class="nav-panel">
<p>
Next: <a href="#I2C" accesskey="n" rel="next">I2C</a>, Previous: <a href="#General" accesskey="p" rel="prev">General</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="GPIB-1">3.3 GPIB</h3>
<a class="index-entry-id" id="index-GPIB"></a>
<ul class="mini-toc">
<li><a href="#g_t_0040octave_005fgpib_002ffclose" accesskey="1">@octave_gpib/fclose</a></li>
<li><a href="#g_t_0040octave_005fgpib_002ffopen" accesskey="2">@octave_gpib/fopen</a></li>
<li><a href="#g_t_0040octave_005fgpib_002ffprintf" accesskey="3">@octave_gpib/fprintf</a></li>
<li><a href="#g_t_0040octave_005fgpib_002ffread" accesskey="4">@octave_gpib/fread</a></li>
<li><a href="#g_t_0040octave_005fgpib_002ffscanf" accesskey="5">@octave_gpib/fscanf</a></li>
<li><a href="#g_t_0040octave_005fgpib_002ffwrite" accesskey="6">@octave_gpib/fwrite</a></li>
<li><a href="#clrdevice" accesskey="7">clrdevice</a></li>
<li><a href="#gpib" accesskey="8">gpib</a></li>
<li><a href="#gpib_005fclose" accesskey="9">gpib_close</a></li>
<li><a href="#gpib_005fread">gpib_read</a></li>
<li><a href="#gpib_005ftimeout">gpib_timeout</a></li>
<li><a href="#gpib_005fwrite">gpib_write</a></li>
<li><a href="#spoll">spoll</a></li>
<li><a href="#trigger">trigger</a></li>
</ul>
<div class="subsection-level-extent" id="g_t_0040octave_005fgpib_002ffclose">
<h4 class="subsection">3.3.1 @octave_gpib/fclose</h4>
<a class="index-entry-id" id="index-fclose"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fclose-9"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">res</var> =</code> <strong class="def-name">fclose</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-fclose-9'> ¶</a></span></dt>
<dd><p>Closes connection to GPIB device <var class="var">obj</var>
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fgpib_002ffopen">
<h4 class="subsection">3.3.2 @octave_gpib/fopen</h4>
<a class="index-entry-id" id="index-fopen"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fopen-9"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">res</var> =</code> <strong class="def-name">fopen</strong> <code class="def-code-arguments">(<var class="var">obj</var>) (dummy)</code><a class="copiable-link" href='#index-fopen-9'> ¶</a></span></dt>
<dd><p>Opens connection to GPIB device <var class="var">obj</var>
This currently is a dummy function to improve compatibility to MATLAB
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fgpib_002ffprintf">
<h4 class="subsection">3.3.3 @octave_gpib/fprintf</h4>
<a class="index-entry-id" id="index-fprintf"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fprintf-6"><span class="category-def">Function File: </span><span><strong class="def-name">fprintf</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">cmd</var>)</code><a class="copiable-link" href='#index-fprintf-6'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fprintf-7"><span class="category-def">Function File: </span><span><strong class="def-name">fprintf</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">format</var>, <var class="var">cmd</var>)</code><a class="copiable-link" href='#index-fprintf-7'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fprintf-8"><span class="category-def">Function File: </span><span><strong class="def-name">fprintf</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">cmd</var>, <var class="var">mode</var>)</code><a class="copiable-link" href='#index-fprintf-8'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fprintf-9"><span class="category-def">Function File: </span><span><strong class="def-name">fprintf</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">format</var>, <var class="var">cmd</var>, <var class="var">mode</var>)</code><a class="copiable-link" href='#index-fprintf-9'> ¶</a></span></dt>
<dd><p>Writes string <var class="var">cmd</var> to GPIB instrument
</p>
<p><var class="var">obj</var> is a GPIB object
</p>
<p><var class="var">cmd</var> String
<var class="var">format</var> Format specifier
<var class="var">mode</var> sync
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fgpib_002ffread">
<h4 class="subsection">3.3.4 @octave_gpib/fread</h4>
<a class="index-entry-id" id="index-fread"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fread-11"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-fread-11'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-12"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>)</code><a class="copiable-link" href='#index-fread-12'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-13"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-fread-13'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-14"><span class="category-def">Function File: </span><span><code class="def-type">[<var class="var">data</var>,<var class="var">count</var>] =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, ...)</code><a class="copiable-link" href='#index-fread-14'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-15"><span class="category-def">Function File: </span><span><code class="def-type">[<var class="var">data</var>,<var class="var">count</var>,<var class="var">errmsg</var>] =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, ...)</code><a class="copiable-link" href='#index-fread-15'> ¶</a></span></dt>
<dd><p>Reads <var class="var">data</var> from GPIB instrument
</p>
<p><var class="var">obj</var> is a GPIB object
</p>
<p><var class="var">size</var> Number of values to read. (Default: 100)
<var class="var">precision</var> precision of data
</p>
<p><var class="var">count</var> values read
<var class="var">errmsg</var> read operation error message
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fgpib_002ffscanf">
<h4 class="subsection">3.3.5 @octave_gpib/fscanf</h4>
<a class="index-entry-id" id="index-fscanf"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fscanf-1"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">res</var> =</code> <strong class="def-name">fscanf</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-fscanf-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fscanf-2"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">res</var> =</code> <strong class="def-name">fscanf</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">format</var>)</code><a class="copiable-link" href='#index-fscanf-2'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fscanf-3"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">res</var> =</code> <strong class="def-name">fscanf</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">format</var>, <var class="var">size</var>)</code><a class="copiable-link" href='#index-fscanf-3'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fscanf-4"><span class="category-def">Function File: </span><span><code class="def-type">[<var class="var">res</var>,<var class="var">count</var>] =</code> <strong class="def-name">fscanf</strong> <code class="def-code-arguments">(<var class="var">obj</var>, ...)</code><a class="copiable-link" href='#index-fscanf-4'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fscanf-5"><span class="category-def">Function File: </span><span><code class="def-type">[<var class="var">res</var>,<var class="var">count</var>,<var class="var">errmsg</var>] =</code> <strong class="def-name">fscanf</strong> <code class="def-code-arguments">(<var class="var">obj</var>, ...)</code><a class="copiable-link" href='#index-fscanf-5'> ¶</a></span></dt>
<dd><p>Reads data <var class="var">res</var> from GPIB instrument
</p>
<p><var class="var">obj</var> is a GPIB object
</p>
<p><var class="var">format</var> Format specifier
<var class="var">size</var> number of values
</p>
<p><var class="var">count</var> values read
<var class="var">errmsg</var> read operation error message
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fgpib_002ffwrite">
<h4 class="subsection">3.3.6 @octave_gpib/fwrite</h4>
<a class="index-entry-id" id="index-fwrite"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fwrite-11"><span class="category-def">Function File: </span><span><strong class="def-name">fwrite</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-fwrite-11'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fwrite-12"><span class="category-def">Function File: </span><span><strong class="def-name">fwrite</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-fwrite-12'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fwrite-13"><span class="category-def">Function File: </span><span><strong class="def-name">fwrite</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>, <var class="var">mode</var>)</code><a class="copiable-link" href='#index-fwrite-13'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fwrite-14"><span class="category-def">Function File: </span><span><strong class="def-name">fwrite</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>, <var class="var">precision</var>, <var class="var">mode</var>)</code><a class="copiable-link" href='#index-fwrite-14'> ¶</a></span></dt>
<dd><p>Writes <var class="var">data</var> to GPIB instrument
</p>
<p><var class="var">obj</var> is a GPIB object
</p>
<p><var class="var">data</var> data to write
<var class="var">precision</var> precision of data
<var class="var">mode</var> sync
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="clrdevice">
<h4 class="subsection">3.3.7 clrdevice</h4>
<a class="index-entry-id" id="index-clrdevice"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-clrdevice-1"><span class="category-def">Function File: </span><span><strong class="def-name">clrdevice</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-clrdevice-1'> ¶</a></span></dt>
<dd><p>Send clear command to Clear GPIB instrument.
</p>
<p><var class="var">obj</var> is a GPIB object
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="gpib">
<h4 class="subsection">3.3.8 gpib</h4>
<a class="index-entry-id" id="index-gpib"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-gpib-1"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">gpib</var> =</code> <strong class="def-name">gpib</strong> <code class="def-code-arguments">([<var class="var">gpibid</var>], [<var class="var">timeout</var>])</code><a class="copiable-link" href='#index-gpib-1'> ¶</a></span></dt>
<dd>
<p>Open gpib interface.
</p>
<p><var class="var">gpibid</var> - the interface number.<br>
<var class="var">timeout</var> - the interface timeout value. If omitted defaults to blocking call.
</p>
<p>The gpib() shall return instance of <var class="var">octave_gpib</var> class as the result <var class="var">gpib</var>.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="gpib_005fclose">
<h4 class="subsection">3.3.9 gpib_close</h4>
<a class="index-entry-id" id="index-gpib_005fclose"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-gpib_005fclose-1"><span class="category-def">Loadable Function: </span><span><strong class="def-name">gpib_close</strong> <code class="def-code-arguments">(<var class="var">gpib</var>)</code><a class="copiable-link" href='#index-gpib_005fclose-1'> ¶</a></span></dt>
<dd>
<p>Close the interface and release a file descriptor.
</p>
<p><var class="var">gpib</var> - instance of <var class="var">octave_gpib</var> class.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="gpib_005fread">
<h4 class="subsection">3.3.10 gpib_read</h4>
<a class="index-entry-id" id="index-gpib_005fread"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-gpib_005fread-1"><span class="category-def">Loadable Function: </span><span><code class="def-type">[<var class="var">data</var>, <var class="var">count</var>, <var class="var">eoi</var>] =</code> <strong class="def-name">gpib_read</strong> <code class="def-code-arguments">(<var class="var">gpib</var>, <var class="var">n</var>)</code><a class="copiable-link" href='#index-gpib_005fread-1'> ¶</a></span></dt>
<dd>
<p>Read from gpib interface.
</p>
<p><var class="var">gpib</var> - instance of <var class="var">octave_gpib</var> class.<br>
<var class="var">n</var> - number of bytes to attempt to read of type Integer.
</p>
<p>The gpib_read() shall return number of bytes successfully read in <var class="var">count</var> as Integer and the bytes themselves in <var class="var">data</var> as uint8 array.
<var class="var">eoi</var> indicates read operation complete
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="gpib_005ftimeout">
<h4 class="subsection">3.3.11 gpib_timeout</h4>
<a class="index-entry-id" id="index-gpib_005ftimeout"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-gpib_005ftimeout-1"><span class="category-def">Loadable Function: </span><span><strong class="def-name">gpib_timeout</strong> <code class="def-code-arguments">(<var class="var">gpib</var>, <var class="var">timeout</var>)</code><a class="copiable-link" href='#index-gpib_005ftimeout-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-gpib_005ftimeout-2"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">t</var> =</code> <strong class="def-name">gpib_timeout</strong> <code class="def-code-arguments">(<var class="var">gpib</var>)</code><a class="copiable-link" href='#index-gpib_005ftimeout-2'> ¶</a></span></dt>
<dd>
<p>Set new or get existing gpib interface timeout parameter. The timeout value is valid from 0 to 17.
</p>
<p><var class="var">gpib</var> - instance of <var class="var">octave_gpib</var> class.<br>
<var class="var">timeout</var> - Value of 0 means never timeout, 11 means one second and 17 means 1000 seconds (see GPIB documentation (ibtmo) for further details)
</p>
<p>If <var class="var">timeout</var> parameter is omitted, the gpib_timeout() shall return current timeout value as the result <var class="var">t</var>.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="gpib_005fwrite">
<h4 class="subsection">3.3.12 gpib_write</h4>
<a class="index-entry-id" id="index-gpib_005fwrite"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-gpib_005fwrite-1"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">n</var> =</code> <strong class="def-name">gpib_write</strong> <code class="def-code-arguments">(<var class="var">gpib</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-gpib_005fwrite-1'> ¶</a></span></dt>
<dd>
<p>Write data to a gpib interface.
</p>
<p><var class="var">gpib</var> - instance of <var class="var">octave_gpib</var> class.<br>
<var class="var">data</var> - data to be written to the gpib interface. Can be either of String or uint8 type.
</p>
<p>Upon successful completion, gpib_write() shall return the number of bytes written as the result <var class="var">n</var>.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="spoll">
<h4 class="subsection">3.3.13 spoll</h4>
<a class="index-entry-id" id="index-spoll"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-spoll-1"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">out</var> =</code> <strong class="def-name">spoll</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-spoll-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-spoll-2"><span class="category-def">Function File: </span><span><code class="def-type">[<var class="var">out</var>,<var class="var">statusByte</var>] =</code> <strong class="def-name">spoll</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-spoll-2'> ¶</a></span></dt>
<dd><p>Serial polls GPIB instruments.
</p>
<p><var class="var">obj</var> is a GPIB object or a cell array of GPIB objects
</p>
<p><var class="var">out</var> GPIB objects ready for service
<var class="var">statusByte</var> status Byte
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="trigger">
<h4 class="subsection">3.3.14 trigger</h4>
<a class="index-entry-id" id="index-trigger"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-trigger-1"><span class="category-def">Function File: </span><span><strong class="def-name">trigger</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-trigger-1'> ¶</a></span></dt>
<dd><p>Triggers GPIB instrument.
</p>
<p><var class="var">obj</var> is a GPIB object
</p>
</dd></dl>
<hr>
</div>
</div>
<div class="section-level-extent" id="I2C">
<div class="nav-panel">
<p>
Next: <a href="#Modbus" accesskey="n" rel="next">Modbus</a>, Previous: <a href="#GPIB" accesskey="p" rel="prev">GPIB</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="I2C-1">3.4 I2C</h3>
<a class="index-entry-id" id="index-I2C"></a>
<ul class="mini-toc">
<li><a href="#g_t_0040octave_005fi2c_002ffclose" accesskey="1">@octave_i2c/fclose</a></li>
<li><a href="#g_t_0040octave_005fi2c_002ffopen" accesskey="2">@octave_i2c/fopen</a></li>
<li><a href="#g_t_0040octave_005fi2c_002ffread" accesskey="3">@octave_i2c/fread</a></li>
<li><a href="#g_t_0040octave_005fi2c_002ffwrite" accesskey="4">@octave_i2c/fwrite</a></li>
<li><a href="#g_t_0040octave_005fi2c_002fget" accesskey="5">@octave_i2c/get</a></li>
<li><a href="#g_t_0040octave_005fi2c_002fset" accesskey="6">@octave_i2c/set</a></li>
<li><a href="#i2c" accesskey="7">i2c</a></li>
<li><a href="#i2c_005faddr" accesskey="8">i2c_addr</a></li>
<li><a href="#i2c_005fclose" accesskey="9">i2c_close</a></li>
<li><a href="#i2c_005fread">i2c_read</a></li>
<li><a href="#i2c_005fwrite">i2c_write</a></li>
</ul>
<div class="subsection-level-extent" id="g_t_0040octave_005fi2c_002ffclose">
<h4 class="subsection">3.4.1 @octave_i2c/fclose</h4>
<a class="index-entry-id" id="index-fclose-1"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fclose-10"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">res</var> =</code> <strong class="def-name">fclose</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-fclose-10'> ¶</a></span></dt>
<dd><p>Closes I2C connection <var class="var">obj</var>
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fi2c_002ffopen">
<h4 class="subsection">3.4.2 @octave_i2c/fopen</h4>
<a class="index-entry-id" id="index-fopen-1"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fopen-10"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">res</var> =</code> <strong class="def-name">fopen</strong> <code class="def-code-arguments">(<var class="var">obj</var>) (dummy)</code><a class="copiable-link" href='#index-fopen-10'> ¶</a></span></dt>
<dd><p>Opens I2C connection <var class="var">obj</var>
</p>
<p>This currently is a dummy function to improve compatibility to MATLAB
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fi2c_002ffread">
<h4 class="subsection">3.4.3 @octave_i2c/fread</h4>
<a class="index-entry-id" id="index-fread-1"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fread-16"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-fread-16'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-17"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>)</code><a class="copiable-link" href='#index-fread-17'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-18"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-fread-18'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-19"><span class="category-def">Function File: </span><span><code class="def-type">[<var class="var">data</var>,<var class="var">count</var>] =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, ...)</code><a class="copiable-link" href='#index-fread-19'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-20"><span class="category-def">Function File: </span><span><code class="def-type">[<var class="var">data</var>,<var class="var">count</var>,<var class="var">errmsg</var>] =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, ...)</code><a class="copiable-link" href='#index-fread-20'> ¶</a></span></dt>
<dd><p>Reads <var class="var">data</var> from I2C instrument
</p>
<h4 class="subsubheading" id="Inputs-10">Inputs</h4>
<p><var class="var">obj</var> is a I2C object.<br>
<var class="var">size</var> Number of values to read. (Default: 100).<br>
<var class="var">precision</var> precision of data.<br>
</p>
<h4 class="subsubheading" id="Outputs-10">Outputs</h4>
<p><var class="var">data</var> data values.<br>
<var class="var">count</var> number of values read.<br>
<var class="var">errmsg</var> read operation error message.<br>
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fi2c_002ffwrite">
<h4 class="subsection">3.4.4 @octave_i2c/fwrite</h4>
<a class="index-entry-id" id="index-fwrite-1"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fwrite-15"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">fwrite</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-fwrite-15'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fwrite-16"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">fwrite</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-fwrite-16'> ¶</a></span></dt>
<dd><p>Writes <var class="var">data</var> to I2C instrument
</p>
<h4 class="subsubheading" id="Inputs-11">Inputs</h4>
<p><var class="var">obj</var> is a I2C object.<br>
<var class="var">data</var> data to write.<br>
<var class="var">precision</var> precision of data.<br>
</p>
<h4 class="subsubheading" id="Outputs-11">Outputs</h4>
<p>returns number of bytes written.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fi2c_002fget">
<h4 class="subsection">3.4.5 @octave_i2c/get</h4>
<a class="index-entry-id" id="index-get"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-get-10"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">struct</var> =</code> <strong class="def-name">get</strong> <code class="def-code-arguments">(<var class="var">i2c</var>)</code><a class="copiable-link" href='#index-get-10'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-get-11"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">field</var> =</code> <strong class="def-name">get</strong> <code class="def-code-arguments">(<var class="var">i2c</var>, <var class="var">property</var>)</code><a class="copiable-link" href='#index-get-11'> ¶</a></span></dt>
<dd><p>Get the properties of i2c object.
</p>
<h4 class="subsubheading" id="Inputs-12">Inputs</h4>
<p><var class="var">i2c</var> - instance of <var class="var">octave_i2c</var> class.<br>
</p>
<p><var class="var">property</var> - name of property.<br>
</p>
<h4 class="subsubheading" id="Outputs-12">Outputs</h4>
<p>When <var class="var">property</var> was specified, return the value of that property.<br>
otherwise return the values of all properties as a structure.<br>
</p>
<p><strong class="strong">See also:</strong> @octave_i2c/set.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fi2c_002fset">
<h4 class="subsection">3.4.6 @octave_i2c/set</h4>
<a class="index-entry-id" id="index-set"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-_0028obj_002c"><span class="category-def">Function File: </span><span><code class="def-type">set</code> <strong class="def-name">(<var class="var">obj</var>,</strong> <code class="def-code-arguments"><var class="var">property</var>,<var class="var">value</var>)</code><a class="copiable-link" href='#index-_0028obj_002c'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-_0028obj_002c-1"><span class="category-def">Function File: </span><span><code class="def-type">set</code> <strong class="def-name">(<var class="var">obj</var>,</strong> <code class="def-code-arguments"><var class="var">property</var>,<var class="var">value</var>,…)</code><a class="copiable-link" href='#index-_0028obj_002c-1'> ¶</a></span></dt>
<dd><p>Set the properties of i2c object.
</p>
<h4 class="subsubheading" id="Inputs-13">Inputs</h4>
<p><var class="var">obj</var> - instance of <var class="var">octave_i2c</var> class.<br>
<var class="var">property</var> - name of property.<br>
</p>
<p>If <var class="var">property</var> is a cell so must be <var class="var">value</var>, it sets the values of
all matching properties.
</p>
<p>The function also accepts property-value pairs.
</p>
<h4 class="subsubheading" id="Properties">Properties</h4>
<dl class="table">
<dt><var class="var">’name’</var></dt>
<dd><p>Set the name for the i2c socket.
</p>
</dd>
<dt><var class="var">’remoteaddress’</var></dt>
<dd><p>Set the remote address for the i2c socket.
</p>
</dd>
</dl>
<h4 class="subsubheading" id="Outputs-13">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> @octave_i2c/get.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="i2c">
<h4 class="subsection">3.4.7 i2c</h4>
<a class="index-entry-id" id="index-i2c"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-i2c-1"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">i2c</var> =</code> <strong class="def-name">i2c</strong> <code class="def-code-arguments">([<var class="var">port_path</var>], [<var class="var">address</var>])</code><a class="copiable-link" href='#index-i2c-1'> ¶</a></span></dt>
<dd>
<p>Open i2c interface.
</p>
<h4 class="subsubheading" id="Inputs-14">Inputs</h4>
<p><var class="var">port_path</var> - the interface device port/path of type String. If omitted defaults to
’/dev/i2c-0’. <br>
<var class="var">address</var> - the slave device address. If omitted must be set using i2c_addr() call.
</p>
<h4 class="subsubheading" id="Outputs-14">Outputs</h4>
<p><var class="var">i2c</var> - An instance of <var class="var">octave_i2c</var> class.
</p>
<h4 class="subsubheading" id="Properties-1">Properties</h4>
<p>The i2c object has the following properties:
</p><dl class="table">
<dt>name</dt>
<dd><p>Name of the object
</p></dd>
<dt>remoteaddress</dt>
<dd><p>the slave device address
</p></dd>
<dt>port</dt>
<dd><p>The interface driver port (readonly)
</p></dd>
</dl>
</dd></dl>
</div>
<div class="subsection-level-extent" id="i2c_005faddr">
<h4 class="subsection">3.4.8 i2c_addr</h4>
<a class="index-entry-id" id="index-i2c_005faddr"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-i2c_005faddr-1"><span class="category-def">Loadable Function: </span><span><strong class="def-name">i2c_addr</strong> <code class="def-code-arguments">(<var class="var">i2c</var>, <var class="var">address</var>)</code><a class="copiable-link" href='#index-i2c_005faddr-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-i2c_005faddr-2"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">addr</var> =</code> <strong class="def-name">i2c_addr</strong> <code class="def-code-arguments">(<var class="var">i2c</var>)</code><a class="copiable-link" href='#index-i2c_005faddr-2'> ¶</a></span></dt>
<dd>
<p>Set new or get existing i2c slave device address.
</p>
<h4 class="subsubheading" id="Inputs-15">Inputs</h4>
<p><var class="var">i2c</var> - instance of <var class="var">octave_i2c</var> class.<br>
<var class="var">address</var> - i2c slave device address of type Integer.
The address is passed in the 7 or 10 lower bits of the argument.
</p>
<h4 class="subsubheading" id="Outputs-15">Outputs</h4>
<p><var class="var">addr</var> - If <var class="var">address</var> parameter is omitted, the i2c_addr() shall return
current i2c slave device address.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="i2c_005fclose">
<h4 class="subsection">3.4.9 i2c_close</h4>
<a class="index-entry-id" id="index-i2c_005fclose"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-i2c_005fclose-1"><span class="category-def">Loadable Function: </span><span><strong class="def-name">i2c_close</strong> <code class="def-code-arguments">(<var class="var">i2c</var>)</code><a class="copiable-link" href='#index-i2c_005fclose-1'> ¶</a></span></dt>
<dd>
<p>Close the interface and release a file descriptor.
</p>
<h4 class="subsubheading" id="Inputs-16">Inputs</h4>
<p><var class="var">i2c</var> - instance of <var class="var">octave_i2c</var> class.<br>
</p>
<h4 class="subsubheading" id="Outputs-16">Outputs</h4>
<p>None
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="i2c_005fread">
<h4 class="subsection">3.4.10 i2c_read</h4>
<a class="index-entry-id" id="index-i2c_005fread"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-i2c_005fread-1"><span class="category-def">Loadable Function: </span><span><code class="def-type">[<var class="var">data</var>, <var class="var">count</var>] =</code> <strong class="def-name">i2c_read</strong> <code class="def-code-arguments">(<var class="var">i2c</var>, <var class="var">n</var>)</code><a class="copiable-link" href='#index-i2c_005fread-1'> ¶</a></span></dt>
<dd>
<p>Read from i2c slave device.
</p>
<h4 class="subsubheading" id="Inputs-17">Inputs</h4>
<p><var class="var">i2c</var> - instance of <var class="var">octave_i2c</var> class.<br>
<var class="var">n</var> - number of bytes to attempt to read of type Integer.
</p>
<h4 class="subsubheading" id="Outputs-17">Outputs</h4>
<p>The i2c_read() shall return number of bytes successfully read in <var class="var">count</var> as Integer and the bytes themselves in <var class="var">data</var> as uint8 array.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="i2c_005fwrite">
<h4 class="subsection">3.4.11 i2c_write</h4>
<a class="index-entry-id" id="index-i2c_005fwrite"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-i2c_005fwrite-1"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">n</var> =</code> <strong class="def-name">i2c_write</strong> <code class="def-code-arguments">(<var class="var">i2c</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-i2c_005fwrite-1'> ¶</a></span></dt>
<dd>
<p>Write data to a i2c slave device.
</p>
<h4 class="subsubheading" id="Inputs-18">Inputs</h4>
<p><var class="var">i2c</var> - instance of <var class="var">octave_i2c</var> class.<br>
<var class="var">data</var> - data, of type uint8, to be written to the slave device.
</p>
<h4 class="subsubheading" id="Outputs-18">Outputs</h4>
<p>Upon successful completion, i2c_write() shall return the number of bytes written as the result <var class="var">n</var>.
</p></dd></dl>
<hr>
</div>
</div>
<div class="section-level-extent" id="Modbus">
<div class="nav-panel">
<p>
Next: <a href="#Parallel" accesskey="n" rel="next">Parallel</a>, Previous: <a href="#I2C" accesskey="p" rel="prev">I2C</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="Modbus-1">3.5 Modbus</h3>
<a class="index-entry-id" id="index-Modbus"></a>
<ul class="mini-toc">
<li><a href="#g_t_0040octave_005fmodbus_002fget" accesskey="1">@octave_modbus/get</a></li>
<li><a href="#g_t_0040octave_005fmodbus_002fmaskWrite" accesskey="2">@octave_modbus/maskWrite</a></li>
<li><a href="#g_t_0040octave_005fmodbus_002fread" accesskey="3">@octave_modbus/read</a></li>
<li><a href="#g_t_0040octave_005fmodbus_002fset" accesskey="4">@octave_modbus/set</a></li>
<li><a href="#g_t_0040octave_005fmodbus_002fwrite" accesskey="5">@octave_modbus/write</a></li>
<li><a href="#g_t_0040octave_005fmodbus_002fwriteRead" accesskey="6">@octave_modbus/writeRead</a></li>
<li><a href="#modbus" accesskey="7">modbus</a></li>
</ul>
<div class="subsection-level-extent" id="g_t_0040octave_005fmodbus_002fget">
<h4 class="subsection">3.5.1 @octave_modbus/get</h4>
<a class="index-entry-id" id="index-get-1"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-get-12"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">struct</var> =</code> <strong class="def-name">get</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-get-12'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-get-13"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">field</var> =</code> <strong class="def-name">get</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">property</var>)</code><a class="copiable-link" href='#index-get-13'> ¶</a></span></dt>
<dd><p>Get the properties of modbus object.
</p>
<h4 class="subsubheading" id="Inputs-19">Inputs</h4>
<p><var class="var">dev</var> - instance of <var class="var">octave_modbus</var> class.<br>
<var class="var">property</var> - name of property.<br>
</p>
<h4 class="subsubheading" id="Outputs-19">Outputs</h4>
<p>When <var class="var">property</var> was specified, return the value of that property.<br>
otherwise return the values of all properties as a structure.<br>
</p>
<p><strong class="strong">See also:</strong> @octave_modbus/set.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fmodbus_002fmaskWrite">
<h4 class="subsection">3.5.2 @octave_modbus/maskWrite</h4>
<a class="index-entry-id" id="index-maskWrite"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-maskWrite-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">maskWrite</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">address</var>, <var class="var">andmask</var>, <var class="var">ormask</var>)</code><a class="copiable-link" href='#index-maskWrite-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-maskWrite-2"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">maskWrite</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">address</var>, <var class="var">andmask</var>, <var class="var">ormask</var>, <var class="var">serverid</var>)</code><a class="copiable-link" href='#index-maskWrite-2'> ¶</a></span></dt>
<dd><p>Read holding register at <var class="var">address</var> from modbus device <var class="var">dev</var> apply masking and write the change data.
</p>
<p>writeregister value = (readregister value AND andMask) OR (orMask AND (NOT andMask))
</p>
<h4 class="subsubheading" id="Inputs-20">Inputs</h4>
<p><var class="var">dev</var> - connected modbus device
</p>
<p><var class="var">address</var> - address to read from.
</p>
<p><var class="var">andmask</var> - AND mask to apply to the register
</p>
<p><var class="var">ormask</var> - OR mask to apply to the register
</p>
<p><var class="var">serverId</var> - address to send to (0-247). Default of 1 is used if not specified.
</p>
<h4 class="subsubheading" id="Outputs-20">Outputs</h4>
<p><var class="var">data</var> - data read from the device
</p>
<p><strong class="strong">See also:</strong> modbus.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fmodbus_002fread">
<h4 class="subsection">3.5.3 @octave_modbus/read</h4>
<a class="index-entry-id" id="index-read"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-read-8"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">target</var>, <var class="var">address</var>)</code><a class="copiable-link" href='#index-read-8'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-read-9"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">target</var>, <var class="var">address</var>, <var class="var">count</var>)</code><a class="copiable-link" href='#index-read-9'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-read-10"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">target</var>, <var class="var">address</var>, <var class="var">count</var>, <var class="var">serverId</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-read-10'> ¶</a></span></dt>
<dd><p>Read data from modbus device <var class="var">dev</var> target <var class="var">target</var> starting at address <var class="var">address</var>.
</p>
<h4 class="subsubheading" id="Inputs-21">Inputs</h4>
<p><var class="var">dev</var> - connected modbus device
</p>
<p><var class="var">target</var> - target type to read. One of ’coils’, ’inputs’, ’inputregs’ or ’holdingregs’
</p>
<p><var class="var">address</var> - address to start reading from.
</p>
<p><var class="var">count</var> - number of elements to read. If not provided, count is 1.
</p>
<p><var class="var">serverId</var> - address to send to (0-247). Default of 1 is used if not specified.
</p>
<p><var class="var">precision</var> - Optional precision for how to interpret the read data.
Currently known precision values are uint16 (default), int16, uint32, int32, uint64, uint64, single, double.
</p>
<h4 class="subsubheading" id="Outputs-21">Outputs</h4>
<p><var class="var">data</var> - data read from the device
</p>
<p><strong class="strong">See also:</strong> modbus.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fmodbus_002fset">
<h4 class="subsection">3.5.4 @octave_modbus/set</h4>
<a class="index-entry-id" id="index-set-1"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-_0028obj_002c-2"><span class="category-def">Function File: </span><span><code class="def-type">set</code> <strong class="def-name">(<var class="var">obj</var>,</strong> <code class="def-code-arguments"><var class="var">property</var>,<var class="var">value</var>)</code><a class="copiable-link" href='#index-_0028obj_002c-2'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-_0028obj_002c-3"><span class="category-def">Function File: </span><span><code class="def-type">set</code> <strong class="def-name">(<var class="var">obj</var>,</strong> <code class="def-code-arguments"><var class="var">property</var>,<var class="var">value</var>,…)</code><a class="copiable-link" href='#index-_0028obj_002c-3'> ¶</a></span></dt>
<dd><p>Set the properties of modbus object.
</p>
<h4 class="subsubheading" id="Inputs-22">Inputs</h4>
<p><var class="var">obj</var> - instance of <var class="var">octave_modbus</var> class.<br>
<var class="var">property</var> - name of property.<br>
</p>
<p>If <var class="var">property</var> is a cell so must be <var class="var">value</var>, it sets the values of
all matching properties.
</p>
<p>The function also accepts property-value pairs.
</p>
<h4 class="subsubheading" id="Properties-2">Properties</h4>
<dl class="table">
<dt><var class="var">’Name’</var></dt>
<dd><p>Set the stored string name of the object.
</p>
</dd>
<dt><var class="var">’Timeout’</var></dt>
<dd><p>Set the timeout value.
</p>
</dd>
<dt><var class="var">’Numretries’</var></dt>
<dd><p>Set the numretries value.
</p>
</dd>
<dt><var class="var">’ByteOrder’</var></dt>
<dd><p>Set the byteorder value
</p>
</dd>
<dt><var class="var">’WordOrder’</var></dt>
<dd><p>Set the wordorder value
</p>
</dd>
<dt><var class="var">’UserData’</var></dt>
<dd><p>Set the userdata value
</p>
</dd>
</dl>
<h4 class="subsubheading" id="Outputs-22">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> @octave_modbus/get.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fmodbus_002fwrite">
<h4 class="subsection">3.5.5 @octave_modbus/write</h4>
<a class="index-entry-id" id="index-write"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-write-8"><span class="category-def">: </span><span><strong class="def-name">write</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">target</var>, <var class="var">address</var>, <var class="var">values</var>)</code><a class="copiable-link" href='#index-write-8'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-read-11"><span class="category-def">: </span><span><strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">target</var>, <var class="var">address</var>, <var class="var">values</var>, <var class="var">serverId</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-read-11'> ¶</a></span></dt>
<dd><p>Write data <var class="var">data</var> to modbus device <var class="var">dev</var> target <var class="var">target</var> starting at address <var class="var">address</var>.
</p>
<h4 class="subsubheading" id="Inputs-23">Inputs</h4>
<p><var class="var">dev</var> - connected modbus device
</p>
<p><var class="var">target</var> - target type to read. One of ’coils’ or ’holdingregs’
</p>
<p><var class="var">address</var> - address to start reading from.
</p>
<p><var class="var">data</var> - data to write.
</p>
<p><var class="var">serverId</var> - address to send to (0-247). Default of 1 is used if not specified.
</p>
<p><var class="var">precision</var> - Optional precision for how to interpret the write data.
Currently known precision values are uint16 (default), int16, uint32, int32, uint64, uint64, single, double.
</p>
<h4 class="subsubheading" id="Outputs-23">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> modbus.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fmodbus_002fwriteRead">
<h4 class="subsection">3.5.6 @octave_modbus/writeRead</h4>
<a class="index-entry-id" id="index-writeRead"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-writeRead-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">writeRead</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">writeAddress</var>, <var class="var">values</var>, <var class="var">readAddress</var>, <var class="var">readcount</var>)</code><a class="copiable-link" href='#index-writeRead-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-writeRead-2"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">writeRead</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">writeAddress</var>, <var class="var">values</var>, <var class="var">readAddress</var>, <var class="var">readcount</var>, <var class="var">serverId</var>)</code><a class="copiable-link" href='#index-writeRead-2'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-writeRead-3"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">writeRead</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">writeAddress</var>, <var class="var">values</var>, <var class="var">writePrecision</var>, <var class="var">readAddress</var>, <var class="var">readCount</var>, <var class="var">readPrecision</var>)</code><a class="copiable-link" href='#index-writeRead-3'> ¶</a></span></dt>
<dd><p>Write data <var class="var">values</var> to the modbus device <var class="var">dev</var> holding registers starting at address <var class="var">writeAddress</var>
and then read <var class="var">readCount</var> register values starting at address <var class="var">readAddress</var>.
</p>
<h4 class="subsubheading" id="Inputs-24">Inputs</h4>
<p><var class="var">dev</var> - connected modbus device
</p>
<p><var class="var">writeAddress</var> - address to start writing to.
</p>
<p><var class="var">values</var> - data to write to the device.
</p>
<p><var class="var">readAddress</var> - address to start reading from.
</p>
<p><var class="var">readCount</var> - number of elements to read.
</p>
<p><var class="var">serverId</var> - address to send to (0-247). Default of 1 is used if not specified.
</p>
<p><var class="var">precision</var> - Optional precision for how to interpret the read data.
Currently known precision values are uint16 (default), int16, uint32, int32, uint64, uint64, single, double.
</p>
<h4 class="subsubheading" id="Outputs-24">Outputs</h4>
<p><var class="var">data</var> - data read from the device
</p>
<p><strong class="strong">See also:</strong> modbus.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="modbus">
<h4 class="subsection">3.5.7 modbus</h4>
<a class="index-entry-id" id="index-modbus"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-modbus-1"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">dev</var> =</code> <strong class="def-name">modbus</strong> <code class="def-code-arguments">('tcpip', <var class="var">deviceaddress</var>)</code><a class="copiable-link" href='#index-modbus-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-modbus-2"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">dev</var> =</code> <strong class="def-name">modbus</strong> <code class="def-code-arguments">('tcpip', <var class="var">deviceaddress</var>, <var class="var">remoteport</var>)</code><a class="copiable-link" href='#index-modbus-2'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-modbus-3"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">dev</var> =</code> <strong class="def-name">modbus</strong> <code class="def-code-arguments">('tcpip', <var class="var">deviceaddress</var>, <var class="var">name</var>, <var class="var">value</var>)</code><a class="copiable-link" href='#index-modbus-3'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-modbus-4"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">dev</var> =</code> <strong class="def-name">modbus</strong> <code class="def-code-arguments">('serialrtu', <var class="var">serialport</var>)</code><a class="copiable-link" href='#index-modbus-4'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-modbus-5"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">dev</var> =</code> <strong class="def-name">modbus</strong> <code class="def-code-arguments">('serialrtu', <var class="var">serialport</var>, <var class="var">name</var>, <var class="var">value</var>)</code><a class="copiable-link" href='#index-modbus-5'> ¶</a></span></dt>
<dd>
<p>Open modbus interface using a specified transport of ’tcpip’ or ’serialrtu’.
</p>
<h4 class="subsubheading" id="Inputs-25">Inputs</h4>
<p><var class="var">deviceaddress</var> - the device ip address of type String.<br>
<var class="var">remoteport</var> - the device remote port number. If not specified, a default of 502 will be used.<br>
<var class="var">name</var>, <var class="var">value</var> - Optional name value pairs for setting properties of the object.<br>
<var class="var">serialport</var> - the name of the serial port to connect to. It must be specified when transport is ’serialrtu’.<br>
</p>
<h4 class="subsubheading" id="Common-Input-Name_002c-Value-pairs">Common Input Name, Value pairs</h4>
<dl class="table">
<dt>Timeout</dt>
<dd><p>timeout value used for waiting for data
</p></dd>
<dt>NumRetries</dt>
<dd><p>number of retries after a timeout
</p></dd>
<dt>UserData</dt>
<dd><p>Additional data to attach to the object
</p></dd>
</dl>
<h4 class="subsubheading" id="Serial-RTU-Input-Name_002c-Value-pairs">Serial RTU Input Name, Value pairs</h4>
<dl class="table">
<dt>BaudRate</dt>
<dd><p>Baudrate for the serial port
</p></dd>
<dt>DataBits</dt>
<dd><p>number of databits for serial port
</p></dd>
<dt>Parity</dt>
<dd><p>Parity for serial port (’odd’, ’even’ or ’none’)
</p></dd>
<dt>StopBits</dt>
<dd><p>number of stopbits for serial port
</p></dd>
</dl>
<h4 class="subsubheading" id="Outputs-25">Outputs</h4>
<p>The modbus() shall return instance of <var class="var">octave_modbus</var> class as the result <var class="var">modbus</var>.
</p>
<h4 class="subsubheading" id="Properties-3">Properties</h4>
<p>The modbus object has the following public properties:
</p><dl class="table">
<dt>Name</dt>
<dd><p>name assigned to the modbus object
</p></dd>
<dt>Type</dt>
<dd><p>instrument type ’modbus’ (readonly)
</p></dd>
<dt>Port</dt>
<dd><p>Remote port number or serial port name (readonly)
</p></dd>
<dt>DeviceAddress</dt>
<dd><p>Device address if transport was ’tcpip’ (readonly)
</p></dd>
<dt>Status</dt>
<dd><p>status of the object ’open’ or ’closed’ (readonly)
</p></dd>
<dt>Timeout</dt>
<dd><p>timeout value used for waiting for data
</p></dd>
<dt>NumRetries</dt>
<dd><p>number of retries after a timeout
</p></dd>
<dt>UserData</dt>
<dd><p>Additional data to attach to the object
</p></dd>
</dl>
</dd></dl>
<hr>
</div>
</div>
<div class="section-level-extent" id="Parallel">
<div class="nav-panel">
<p>
Next: <a href="#Serial-_0028Deprecated_0029" accesskey="n" rel="next">Serial (Deprecated)</a>, Previous: <a href="#Modbus" accesskey="p" rel="prev">Modbus</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="Parallel-1">3.6 Parallel</h3>
<a class="index-entry-id" id="index-Parallel"></a>
<ul class="mini-toc">
<li><a href="#g_t_0040octave_005fparallel_002ffclose" accesskey="1">@octave_parallel/fclose</a></li>
<li><a href="#g_t_0040octave_005fparallel_002ffopen" accesskey="2">@octave_parallel/fopen</a></li>
<li><a href="#g_t_0040octave_005fparallel_002ffread" accesskey="3">@octave_parallel/fread</a></li>
<li><a href="#g_t_0040octave_005fparallel_002ffwrite" accesskey="4">@octave_parallel/fwrite</a></li>
<li><a href="#parallel" accesskey="5">parallel</a></li>
<li><a href="#pp_005fclose" accesskey="6">pp_close</a></li>
<li><a href="#pp_005fctrl" accesskey="7">pp_ctrl</a></li>
<li><a href="#pp_005fdata" accesskey="8">pp_data</a></li>
<li><a href="#pp_005fdatadir" accesskey="9">pp_datadir</a></li>
<li><a href="#pp_005fstat">pp_stat</a></li>
</ul>
<div class="subsection-level-extent" id="g_t_0040octave_005fparallel_002ffclose">
<h4 class="subsection">3.6.1 @octave_parallel/fclose</h4>
<a class="index-entry-id" id="index-fclose-2"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fclose-11"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">res</var> =</code> <strong class="def-name">fclose</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-fclose-11'> ¶</a></span></dt>
<dd><p>Closes parallel connection <var class="var">obj</var>
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fparallel_002ffopen">
<h4 class="subsection">3.6.2 @octave_parallel/fopen</h4>
<a class="index-entry-id" id="index-fopen-2"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fopen-11"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">res</var> =</code> <strong class="def-name">fopen</strong> <code class="def-code-arguments">(<var class="var">obj</var>) (dummy)</code><a class="copiable-link" href='#index-fopen-11'> ¶</a></span></dt>
<dd><p>Opens parallel interface <var class="var">obj</var>
</p>
<p>This currently is a dummy function to improve compatibility to MATLAB
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fparallel_002ffread">
<h4 class="subsection">3.6.3 @octave_parallel/fread</h4>
<a class="index-entry-id" id="index-fread-2"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fread-21"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-fread-21'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-22"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>)</code><a class="copiable-link" href='#index-fread-22'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-23"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-fread-23'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-24"><span class="category-def">Function File: </span><span><code class="def-type">[<var class="var">data</var>,<var class="var">count</var>] =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, ...)</code><a class="copiable-link" href='#index-fread-24'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-25"><span class="category-def">Function File: </span><span><code class="def-type">[<var class="var">data</var>,<var class="var">count</var>,<var class="var">errmsg</var>] =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, ...)</code><a class="copiable-link" href='#index-fread-25'> ¶</a></span></dt>
<dd><p>Reads <var class="var">data</var> from parallel instrument
</p>
<h4 class="subsubheading" id="Inputs-26">Inputs</h4>
<p><var class="var">obj</var> is a parallel object.<br>
<var class="var">size</var> Number of values to read. (Default: 1).<br>
<var class="var">precision</var> precision of data.<br>
</p>
<h4 class="subsubheading" id="Outputs-26">Outputs</h4>
<p><var class="var">data</var> The read data.<br>
<var class="var">count</var> values read.<br>
<var class="var">errmsg</var> read operation error message.<br>
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fparallel_002ffwrite">
<h4 class="subsection">3.6.4 @octave_parallel/fwrite</h4>
<a class="index-entry-id" id="index-fwrite-2"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fwrite-17"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">fwrite</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-fwrite-17'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fwrite-18"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">fwrite</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-fwrite-18'> ¶</a></span></dt>
<dd><p>Writes <var class="var">data</var> to parallel instrument
</p>
<h4 class="subsubheading" id="Inputs-27">Inputs</h4>
<p><var class="var">obj</var> is a parallel object.<br>
<var class="var">data</var> data to write.<br>
<var class="var">precision</var> precision of data.<br>
</p>
<h4 class="subsubheading" id="Outputs-27">Outputs</h4>
<p>returns number of bytes written.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="parallel">
<h4 class="subsection">3.6.5 parallel</h4>
<a class="index-entry-id" id="index-parallel"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-parallel-1"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">parallel</var> =</code> <strong class="def-name">parallel</strong> <code class="def-code-arguments">([<var class="var">path</var>], [<var class="var">direction</var>])</code><a class="copiable-link" href='#index-parallel-1'> ¶</a></span></dt>
<dd>
<p>Open Parallel interface.
</p>
<h4 class="subsubheading" id="Inputs-28">Inputs</h4>
<p><var class="var">path</var> - the interface path of type String. If omitted defaults to ’/dev/parport0’.<br>
<var class="var">direction</var> - the direction of interface drivers of type Integer, see: PP_DATADIR for more info.
If omitted defaults to 1 (Input).
</p>
<h4 class="subsubheading" id="Outputs-28">Outputs</h4>
<p>The parallel() shall return instance of <var class="var">octave_parallel</var> class as the result <var class="var">parallel</var>.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="pp_005fclose">
<h4 class="subsection">3.6.6 pp_close</h4>
<a class="index-entry-id" id="index-pp_005fclose"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-pp_005fclose-1"><span class="category-def">Loadable Function: </span><span><strong class="def-name">pp_close</strong> <code class="def-code-arguments">(<var class="var">parallel</var>)</code><a class="copiable-link" href='#index-pp_005fclose-1'> ¶</a></span></dt>
<dd>
<p>Close the interface and release a file descriptor.
</p>
<h4 class="subsubheading" id="Inputs-29">Inputs</h4>
<p><var class="var">parallel</var> - instance of <var class="var">octave_serial</var> class.<br>
</p><h4 class="subsubheading" id="Outputs-29">Outputs</h4>
<p>None
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="pp_005fctrl">
<h4 class="subsection">3.6.7 pp_ctrl</h4>
<a class="index-entry-id" id="index-pp_005fctrl"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-pp_005fctrl-1"><span class="category-def">Loadable Function: </span><span><strong class="def-name">pp_ctrl</strong> <code class="def-code-arguments">(<var class="var">parallel</var>, <var class="var">ctrl</var>)</code><a class="copiable-link" href='#index-pp_005fctrl-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-pp_005fctrl-2"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">c</var> =</code> <strong class="def-name">pp_ctrl</strong> <code class="def-code-arguments">(<var class="var">parallel</var>)</code><a class="copiable-link" href='#index-pp_005fctrl-2'> ¶</a></span></dt>
<dd>
<p>Sets or Read the Control lines.
</p>
<h4 class="subsubheading" id="Inputs-30">Inputs</h4>
<p><var class="var">parallel</var> - instance of <var class="var">octave_parallel</var> class.<br>
<var class="var">ctrl</var> - control parameter to be set of type Byte.
</p>
<h4 class="subsubheading" id="Outputs-30">Outputs</h4>
<p>If <var class="var">ctrl</var> parameter is omitted, the pp_ctrl() shall return current Control lines state as the result <var class="var">c</var>.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="pp_005fdata">
<h4 class="subsection">3.6.8 pp_data</h4>
<a class="index-entry-id" id="index-pp_005fdata"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-pp_005fdata-1"><span class="category-def">Loadable Function: </span><span><strong class="def-name">pp_data</strong> <code class="def-code-arguments">(<var class="var">parallel</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-pp_005fdata-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-pp_005fdata-2"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">d</var> =</code> <strong class="def-name">pp_data</strong> <code class="def-code-arguments">(<var class="var">parallel</var>)</code><a class="copiable-link" href='#index-pp_005fdata-2'> ¶</a></span></dt>
<dd>
<p>Sets or Read the Data lines.
</p>
<h4 class="subsubheading" id="Inputs-31">Inputs</h4>
<p><var class="var">parallel</var> - instance of <var class="var">octave_parallel</var> class.<br>
<var class="var">data</var> - data parameter to be set of type Byte.
</p>
<h4 class="subsubheading" id="Outputs-31">Outputs</h4>
<p>If <var class="var">data</var> parameter is omitted, the pp_data() shall return current Data lines state as the result <var class="var">d</var>.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="pp_005fdatadir">
<h4 class="subsection">3.6.9 pp_datadir</h4>
<a class="index-entry-id" id="index-pp_005fdatadir"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-pp_005fdatadir-1"><span class="category-def">Loadable Function: </span><span><strong class="def-name">pp_datadir</strong> <code class="def-code-arguments">(<var class="var">parallel</var>, <var class="var">direction</var>)</code><a class="copiable-link" href='#index-pp_005fdatadir-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-pp_005fdatadir-2"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">dir</var> =</code> <strong class="def-name">pp_datadir</strong> <code class="def-code-arguments">(<var class="var">parallel</var>)</code><a class="copiable-link" href='#index-pp_005fdatadir-2'> ¶</a></span></dt>
<dd>
<p>Controls the Data line drivers.
</p>
<p>Normally the computer’s parallel port will drive the data lines,
but for byte-wide transfers from the peripheral to the host it is useful to turn off those drivers
and let the peripheral drive the signals. (If the drivers on the computer’s parallel port are left
on when this happens, the port might be damaged.)
</p>
<h4 class="subsubheading" id="Inputs-32">Inputs</h4>
<p><var class="var">parallel</var> - instance of <var class="var">octave_parallel</var> class.<br>
<var class="var">direction</var> - direction parameter of type Integer. Supported values: 0 - the drivers are turned on
(Output/Forward direction); 1 - the drivers are turned off (Input/Reverse direction).
</p>
<h4 class="subsubheading" id="Outputs-32">Outputs</h4>
<p>If <var class="var">direction</var> parameter is omitted, the pp_datadir() shall return current Data direction as the result <var class="var">dir</var>.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="pp_005fstat">
<h4 class="subsection">3.6.10 pp_stat</h4>
<a class="index-entry-id" id="index-pp_005fstat"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-pp_005fstat-1"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">stat</var> =</code> <strong class="def-name">pp_stat</strong> <code class="def-code-arguments">(<var class="var">parallel</var>)</code><a class="copiable-link" href='#index-pp_005fstat-1'> ¶</a></span></dt>
<dd>
<p>Reads the Status lines.
</p>
<h4 class="subsubheading" id="Inputs-33">Inputs</h4>
<p><var class="var">parallel</var> - instance of <var class="var">octave_parallel</var> class.<br>
</p>
<h4 class="subsubheading" id="Outputs-33">Outputs</h4>
<p>The pp_stat() shall return current Status lines state as the result <var class="var">stat</var>.
</p></dd></dl>
<hr>
</div>
</div>
<div class="section-level-extent" id="Serial-_0028Deprecated_0029">
<div class="nav-panel">
<p>
Next: <a href="#Serial-Port" accesskey="n" rel="next">Serial Port</a>, Previous: <a href="#Parallel" accesskey="p" rel="prev">Parallel</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="Serial-_0028Deprecated_0029-1">3.7 Serial (Deprecated)</h3>
<a class="index-entry-id" id="index-Serial-_0028Deprecated_0029"></a>
<ul class="mini-toc">
<li><a href="#g_t_0040octave_005fserial_002ffclose" accesskey="1">@octave_serial/fclose</a></li>
<li><a href="#g_t_0040octave_005fserial_002fflushinput" accesskey="2">@octave_serial/flushinput</a></li>
<li><a href="#g_t_0040octave_005fserial_002fflushoutput" accesskey="3">@octave_serial/flushoutput</a></li>
<li><a href="#g_t_0040octave_005fserial_002ffopen" accesskey="4">@octave_serial/fopen</a></li>
<li><a href="#g_t_0040octave_005fserial_002ffprintf" accesskey="5">@octave_serial/fprintf</a></li>
<li><a href="#g_t_0040octave_005fserial_002ffread" accesskey="6">@octave_serial/fread</a></li>
<li><a href="#g_t_0040octave_005fserial_002ffwrite" accesskey="7">@octave_serial/fwrite</a></li>
<li><a href="#g_t_0040octave_005fserial_002fget" accesskey="8">@octave_serial/get</a></li>
<li><a href="#g_t_0040octave_005fserial_002fserialbreak" accesskey="9">@octave_serial/serialbreak</a></li>
<li><a href="#g_t_0040octave_005fserial_002fset">@octave_serial/set</a></li>
<li><a href="#g_t_0040octave_005fserial_002fsrl_005fbaudrate">@octave_serial/srl_baudrate</a></li>
<li><a href="#g_t_0040octave_005fserial_002fsrl_005fbytesize">@octave_serial/srl_bytesize</a></li>
<li><a href="#g_t_0040octave_005fserial_002fsrl_005fclose">@octave_serial/srl_close</a></li>
<li><a href="#g_t_0040octave_005fserial_002fsrl_005fflush">@octave_serial/srl_flush</a></li>
<li><a href="#g_t_0040octave_005fserial_002fsrl_005fparity">@octave_serial/srl_parity</a></li>
<li><a href="#g_t_0040octave_005fserial_002fsrl_005fstopbits">@octave_serial/srl_stopbits</a></li>
<li><a href="#g_t_0040octave_005fserial_002fsrl_005ftimeout">@octave_serial/srl_timeout</a></li>
<li><a href="#serial">serial</a></li>
<li><a href="#seriallist">seriallist</a></li>
<li><a href="#srl_005fread">srl_read</a></li>
<li><a href="#srl_005fwrite">srl_write</a></li>
</ul>
<div class="subsection-level-extent" id="g_t_0040octave_005fserial_002ffclose">
<h4 class="subsection">3.7.1 @octave_serial/fclose</h4>
<a class="index-entry-id" id="index-fclose-3"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fclose-12"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">res</var> =</code> <strong class="def-name">fclose</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-fclose-12'> ¶</a></span></dt>
<dd><p>Closes SERIAL connection <var class="var">obj</var>
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserial_002fflushinput">
<h4 class="subsection">3.7.2 @octave_serial/flushinput</h4>
<a class="index-entry-id" id="index-flushinput-1"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-flushinput-5"><span class="category-def">Loadable Function: </span><span><strong class="def-name">flushinput</strong> <code class="def-code-arguments">(<var class="var">serial</var>)</code><a class="copiable-link" href='#index-flushinput-5'> ¶</a></span></dt>
<dd>
<p>Flush the pending input, which will also make the BytesAvailable property be 0.
</p>
<h4 class="subsubheading" id="Inputs-34">Inputs</h4>
<p><var class="var">serial</var> - instance of <var class="var">octave_serial</var> class.
</p>
<h4 class="subsubheading" id="Outputs-34">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> srl_flush, flushoutput.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserial_002fflushoutput">
<h4 class="subsection">3.7.3 @octave_serial/flushoutput</h4>
<a class="index-entry-id" id="index-flushoutput-1"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-flushoutput-5"><span class="category-def">Loadable Function: </span><span><strong class="def-name">flushoutput</strong> <code class="def-code-arguments">(<var class="var">serial</var>)</code><a class="copiable-link" href='#index-flushoutput-5'> ¶</a></span></dt>
<dd>
<p>Flush the output buffer.
</p>
<h4 class="subsubheading" id="Inputs-35">Inputs</h4>
<p><var class="var">serial</var> - instance of <var class="var">octave_serial</var> class.
</p>
<h4 class="subsubheading" id="Outputs-35">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> srl_flush, flushinput.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserial_002ffopen">
<h4 class="subsection">3.7.4 @octave_serial/fopen</h4>
<a class="index-entry-id" id="index-fopen-3"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fopen-12"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">res</var> =</code> <strong class="def-name">fopen</strong> <code class="def-code-arguments">(<var class="var">obj</var>) (dummy)</code><a class="copiable-link" href='#index-fopen-12'> ¶</a></span></dt>
<dd><p>Opens SERIAL interface <var class="var">obj</var>
</p>
<p>This currently is a dummy function to improve compatibility to MATLAB
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserial_002ffprintf">
<h4 class="subsection">3.7.5 @octave_serial/fprintf</h4>
<a class="index-entry-id" id="index-fprintf-1"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fprintf-10"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">fprintf</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">template</var> ...)</code><a class="copiable-link" href='#index-fprintf-10'> ¶</a></span></dt>
<dd><p>Writes formatted string <var class="var">template</var> using optional parameters to
serial instrument
</p>
<h4 class="subsubheading" id="Inputs-36">Inputs</h4>
<p><var class="var">obj</var> is a serial object.<br>
<var class="var">template</var> Format template string
</p>
<h4 class="subsubheading" id="Outputs-36">Outputs</h4>
<p><var class="var">numbytes</var> - number of bytes written to the serial device.
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserial_002ffread">
<h4 class="subsection">3.7.6 @octave_serial/fread</h4>
<a class="index-entry-id" id="index-fread-3"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fread-26"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-fread-26'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-27"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>)</code><a class="copiable-link" href='#index-fread-27'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-28"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-fread-28'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-29"><span class="category-def">Function File: </span><span><code class="def-type">[<var class="var">data</var>,<var class="var">count</var>] =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, ...)</code><a class="copiable-link" href='#index-fread-29'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-30"><span class="category-def">Function File: </span><span><code class="def-type">[<var class="var">data</var>,<var class="var">count</var>,<var class="var">errmsg</var>] =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, ...)</code><a class="copiable-link" href='#index-fread-30'> ¶</a></span></dt>
<dd><p>Reads <var class="var">data</var> from serial instrument
</p>
<h4 class="subsubheading" id="Inputs-37">Inputs</h4>
<p><var class="var">obj</var> is a serial object.<br>
<var class="var">size</var> Number of values to read. (Default: 100).<br>
<var class="var">precision</var> precision of data.<br>
</p>
<h4 class="subsubheading" id="Outputs-37">Outputs</h4>
<p><var class="var">data</var> The read data.<br>
<var class="var">count</var> values read.<br>
<var class="var">errmsg</var> read operation error message.<br>
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserial_002ffwrite">
<h4 class="subsection">3.7.7 @octave_serial/fwrite</h4>
<a class="index-entry-id" id="index-fwrite-3"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fwrite-19"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">fwrite</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-fwrite-19'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fwrite-20"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">fwrite</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-fwrite-20'> ¶</a></span></dt>
<dd><p>Writes <var class="var">data</var> to serial instrument
</p>
<h4 class="subsubheading" id="Inputs-38">Inputs</h4>
<p><var class="var">obj</var> is a serial object.<br>
<var class="var">data</var> data to write.<br>
<var class="var">precision</var> precision of data.<br>
</p>
<h4 class="subsubheading" id="Outputs-38">Outputs</h4>
<p>returns number of bytes written.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserial_002fget">
<h4 class="subsection">3.7.8 @octave_serial/get</h4>
<a class="index-entry-id" id="index-get-2"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-get-14"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">struct</var> =</code> <strong class="def-name">get</strong> <code class="def-code-arguments">(<var class="var">serial</var>)</code><a class="copiable-link" href='#index-get-14'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-get-15"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">field</var> =</code> <strong class="def-name">get</strong> <code class="def-code-arguments">(<var class="var">serial</var>, <var class="var">property</var>)</code><a class="copiable-link" href='#index-get-15'> ¶</a></span></dt>
<dd><p>Get the properties of serial object.
</p>
<h4 class="subsubheading" id="Inputs-39">Inputs</h4>
<p><var class="var">serial</var> - instance of <var class="var">octave_serial</var> class.<br>
<var class="var">property</var> - name of property.<br>
</p>
<h4 class="subsubheading" id="Outputs-39">Outputs</h4>
<p>When <var class="var">property</var> was specified, return the value of that property.<br>
otherwise return the values of all properties as a structure.<br>
</p>
<p><strong class="strong">See also:</strong> @octave_serial/set.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserial_002fserialbreak">
<h4 class="subsection">3.7.9 @octave_serial/serialbreak</h4>
<a class="index-entry-id" id="index-serialbreak"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-serialbreak-2"><span class="category-def">Function File: </span><span><strong class="def-name">serialbreak</strong> <code class="def-code-arguments">(<var class="var">serial</var>)</code><a class="copiable-link" href='#index-serialbreak-2'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-serialbreak-3"><span class="category-def">Function File: </span><span><strong class="def-name">serialbreak</strong> <code class="def-code-arguments">(<var class="var">serial</var>, <var class="var">time</var>)</code><a class="copiable-link" href='#index-serialbreak-3'> ¶</a></span></dt>
<dd><p>Send a break to the serial port
</p>
<h4 class="subsubheading" id="Inputs-40">Inputs</h4>
<p><var class="var">serial</var> - serial object<br>
<var class="var">time</var> - number of milliseconds to break for. If not specified a value of 10 will be used.
</p>
<h4 class="subsubheading" id="Outputs-40">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> serial.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserial_002fset">
<h4 class="subsection">3.7.10 @octave_serial/set</h4>
<a class="index-entry-id" id="index-set-2"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-_0028obj_002c-4"><span class="category-def">Function File: </span><span><code class="def-type">set</code> <strong class="def-name">(<var class="var">obj</var>,</strong> <code class="def-code-arguments"><var class="var">property</var>,<var class="var">value</var>)</code><a class="copiable-link" href='#index-_0028obj_002c-4'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-_0028obj_002c-5"><span class="category-def">Function File: </span><span><code class="def-type">set</code> <strong class="def-name">(<var class="var">obj</var>,</strong> <code class="def-code-arguments"><var class="var">property</var>,<var class="var">value</var>,…)</code><a class="copiable-link" href='#index-_0028obj_002c-5'> ¶</a></span></dt>
<dd><p>Set the properties of serial object.
</p>
<h4 class="subsubheading" id="Inputs-41">Inputs</h4>
<p><var class="var">serial</var> - instance of <var class="var">octave_serial</var> class.<br>
<var class="var">property</var> - name of property.<br>
</p>
<p>If <var class="var">property</var> is a cell so must be <var class="var">value</var>, it sets the values of
all matching properties.
</p>
<p>The function also accepts property-value pairs.
</p>
<h4 class="subsubheading" id="Properties-4">Properties</h4>
<dl class="table">
<dt><var class="var">’baudrate’</var></dt>
<dd><p>Set the baudrate of serial port. Supported values by instrument-control:
0, 50, 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800, 9600,
19200, 38400, 57600, 115200 and 230400. The supported baudrate of your
serial port may be different.
</p>
</dd>
<dt><var class="var">’bytesize’</var></dt>
<dd><p>Set the bytesize. Supported values: 5, 6, 7 and 8.
</p>
</dd>
<dt><var class="var">’name’</var></dt>
<dd><p>Set the stored string name of the serial object.
</p>
</dd>
<dt><var class="var">’parity’</var></dt>
<dd><p>Set the parity value. Supported values: Even/Odd/None. This Parameter
must be of type string. It is case insensitive and can be abbreviated
to the first letter only
</p>
</dd>
<dt><var class="var">’stopbits’</var></dt>
<dd><p>Set the number of stopbits. Supported values: 1, 2.
</p>
</dd>
<dt><var class="var">’timeout’</var></dt>
<dd><p>Set the timeout value in tenths of a second. Value of -1 means a
blocking call. Maximum value of 255 (i.e. 25.5 seconds).
</p>
</dd>
<dt><var class="var">’requesttosend’</var></dt>
<dd><p>Set the requesttosend (RTS) line.
</p>
</dd>
<dt><var class="var">’dataterminalready’</var></dt>
<dd><p>Set the dataterminalready (DTR) line.
</p>
</dd>
</dl>
<h4 class="subsubheading" id="Outputs-41">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> @octave_serial/get.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserial_002fsrl_005fbaudrate">
<h4 class="subsection">3.7.11 @octave_serial/srl_baudrate</h4>
<a class="index-entry-id" id="index-srl_005fbaudrate"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-srl_005fbaudrate-1"><span class="category-def">Loadable Function: </span><span><strong class="def-name">srl_baudrate</strong> <code class="def-code-arguments">(<var class="var">serial</var>, <var class="var">baudrate</var>)\</code><a class="copiable-link" href='#index-srl_005fbaudrate-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-srl_005fbaudrate-2"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">br</var> =</code> <strong class="def-name">srl_baudrate</strong> <code class="def-code-arguments">(<var class="var">serial</var>)</code><a class="copiable-link" href='#index-srl_005fbaudrate-2'> ¶</a></span></dt>
<dd>
<p>Set new or get existing serial interface baudrate parameter. Only standard values are supported.
</p>
<h4 class="subsubheading" id="Inputs-42">Inputs</h4>
<p><var class="var">serial</var> - instance of <var class="var">octave_serial</var> class.<br>
<var class="var">baudrate</var> - the baudrate value used. Supported values: 0, 50, 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800, 9600 19200, 38400, 57600, 115200 and 230400.<br>
</p>
<p>If <var class="var">baudrate</var> parameter is omitted, the srl_baudrate() shall return current baudrate value as the result <var class="var">br</var>.
</p>
<h4 class="subsubheading" id="Outputs-42">Outputs</h4>
<p><var class="var">br</var> - The currently set baudrate
</p>
<p>This function is obsolete. Use get and set method instead.
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserial_002fsrl_005fbytesize">
<h4 class="subsection">3.7.12 @octave_serial/srl_bytesize</h4>
<a class="index-entry-id" id="index-srl_005fbytesize"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-srl_005fbytesize-1"><span class="category-def">Loadable Function: </span><span><strong class="def-name">srl_bytesize</strong> <code class="def-code-arguments">(<var class="var">serial</var>, <var class="var">bsize</var>)</code><a class="copiable-link" href='#index-srl_005fbytesize-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-srl_005fbytesize-2"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">bs</var> =</code> <strong class="def-name">srl_bytesize</strong> <code class="def-code-arguments">(<var class="var">serial</var>)</code><a class="copiable-link" href='#index-srl_005fbytesize-2'> ¶</a></span></dt>
<dd>
<p>Set new or get existing serial interface byte size parameter.
</p>
<h4 class="subsubheading" id="Inputs-43">Inputs</h4>
<p><var class="var">serial</var> - instance of <var class="var">octave_serial</var> class.<br>
<var class="var">bsize</var> - byte size of type Integer. Supported values: 5/6/7/8.<br>
</p>
<p>If <var class="var">bsize</var> parameter is omitted, the srl_bytesize() shall return current byte size value
or in case of unsupported setting -1, as the result <var class="var">bs</var>.
</p>
<p>This function is obsolete. Use get and set method instead.
</p>
<h4 class="subsubheading" id="Outputs-43">Outputs</h4>
<p><var class="var">bs</var> -the currently set byte size.
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserial_002fsrl_005fclose">
<h4 class="subsection">3.7.13 @octave_serial/srl_close</h4>
<a class="index-entry-id" id="index-srl_005fclose"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-srl_005fclose-1"><span class="category-def">Loadable Function: </span><span><strong class="def-name">srl_close</strong> <code class="def-code-arguments">(<var class="var">serial</var>)</code><a class="copiable-link" href='#index-srl_005fclose-1'> ¶</a></span></dt>
<dd>
<p>Close the interface and release a file descriptor.
</p>
<h4 class="subsubheading" id="Inputs-44">Inputs</h4>
<p><var class="var">serial</var> - instance of <var class="var">octave_serial</var> class.
</p>
<p>This function is obsolete. Use fclose() method instead.
</p>
<h4 class="subsubheading" id="Outputs-44">Outputs</h4>
<p>None
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserial_002fsrl_005fflush">
<h4 class="subsection">3.7.14 @octave_serial/srl_flush</h4>
<a class="index-entry-id" id="index-srl_005fflush"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-srl_005fflush-1"><span class="category-def">Loadable Function: </span><span><strong class="def-name">srl_flush</strong> <code class="def-code-arguments">(<var class="var">serial</var>, [<var class="var">q</var>])</code><a class="copiable-link" href='#index-srl_005fflush-1'> ¶</a></span></dt>
<dd>
<p>Flush the pending input/output.
</p>
<h4 class="subsubheading" id="Inputs-45">Inputs</h4>
<p><var class="var">serial</var> - instance of <var class="var">octave_serial</var> class.<br>
<var class="var">q</var> - queue selector of type Integer. Supported values:<br>
</p><dl class="table">
<dt>0</dt>
<dd><p>flush untransmitted output
</p></dd>
<dt>1</dt>
<dd><p>flush pending input
</p></dd>
<dt>2</dt>
<dd><p>flush both pending input and untransmitted output.
</p></dd>
</dl>
<p>If <var class="var">q</var> parameter is omitted, the srl_flush() shall flush both, input and output buffers.
</p>
<h4 class="subsubheading" id="Outputs-45">Outputs</h4>
<p>None
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserial_002fsrl_005fparity">
<h4 class="subsection">3.7.15 @octave_serial/srl_parity</h4>
<a class="index-entry-id" id="index-srl_005fparity"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-srl_005fparity-1"><span class="category-def">Loadable Function: </span><span><strong class="def-name">srl_parity</strong> <code class="def-code-arguments">(<var class="var">serial</var>, <var class="var">parity</var>)</code><a class="copiable-link" href='#index-srl_005fparity-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-srl_005fparity-2"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">p</var> =</code> <strong class="def-name">srl_parity</strong> <code class="def-code-arguments">(<var class="var">serial</var>)</code><a class="copiable-link" href='#index-srl_005fparity-2'> ¶</a></span></dt>
<dd>
<p>Set new or get existing serial interface parity parameter. Even/Odd/None values are supported.
</p>
<h4 class="subsubheading" id="Inputs-46">Inputs</h4>
<p><var class="var">serial</var> - instance of <var class="var">octave_serial</var> class.<br>
<var class="var">parity</var> - parity value of type String. Supported values:
Even/Odd/None (case insensitive, can be abbreviated to the first letter only)<br>
</p>
<p>If <var class="var">parity</var> parameter is omitted, the srl_parity() shall return current parity value as the result <var class="var">p</var>.
</p>
<p>This function is obsolete. Use get and set method instead.
</p>
<h4 class="subsubheading" id="Outputs-46">Outputs</h4>
<p><var class="var">p</var> - The currently set parity
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserial_002fsrl_005fstopbits">
<h4 class="subsection">3.7.16 @octave_serial/srl_stopbits</h4>
<a class="index-entry-id" id="index-srl_005fstopbits"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-srl_005fstopbits-1"><span class="category-def">Loadable Function: </span><span><strong class="def-name">srl_stopbits</strong> <code class="def-code-arguments">(<var class="var">serial</var>, <var class="var">stopb</var>)</code><a class="copiable-link" href='#index-srl_005fstopbits-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-srl_005fstopbits-2"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">sb</var> =</code> <strong class="def-name">srl_stopbits</strong> <code class="def-code-arguments">(<var class="var">serial</var>)</code><a class="copiable-link" href='#index-srl_005fstopbits-2'> ¶</a></span></dt>
<dd>
<p>Set new or get existing serial interface stop bits parameter. Only 1 or 2 stop bits are supported.
</p>
<h4 class="subsubheading" id="Inputs-47">Inputs</h4>
<p><var class="var">serial</var> - instance of <var class="var">octave_serial</var> class.<br>
<var class="var">stopb</var> - number of stop bits used. Supported values: 1, 2.<br>
</p>
<h4 class="subsubheading" id="Outputs-47">Outputs</h4>
<p>If <var class="var">stopb</var> parameter is omitted, the srl_stopbits() shall return current stop bits value as the result <var class="var">sb</var>.
</p>
<p>This function is obsolete. Use get and set method instead.
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserial_002fsrl_005ftimeout">
<h4 class="subsection">3.7.17 @octave_serial/srl_timeout</h4>
<a class="index-entry-id" id="index-srl_005ftimeout"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-srl_005ftimeout-1"><span class="category-def">Loadable Function: </span><span><strong class="def-name">srl_timeout</strong> <code class="def-code-arguments">(<var class="var">serial</var>, <var class="var">timeout</var>)</code><a class="copiable-link" href='#index-srl_005ftimeout-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-srl_005ftimeout-2"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">t</var> =</code> <strong class="def-name">srl_timeout</strong> <code class="def-code-arguments">(<var class="var">serial</var>)</code><a class="copiable-link" href='#index-srl_005ftimeout-2'> ¶</a></span></dt>
<dd>
<p>Set new or get existing serial interface timeout parameter used for srl_read() requests. The timeout value is specified in tenths of a second.
</p>
<h4 class="subsubheading" id="Inputs-48">Inputs</h4>
<p><var class="var">serial</var> - instance of <var class="var">octave_serial</var> class.<br>
<var class="var">timeout</var> - srl_read() timeout value in tenths of a second.
A value of -1 means a blocking call. Maximum value of 255 (i.e. 25.5 seconds).<br>
</p>
<h4 class="subsubheading" id="Outputs-48">Outputs</h4>
<p>If <var class="var">timeout</var> parameter is omitted, the srl_timeout() shall return current timeout value as the result <var class="var">t</var>.
</p>
<p>This function is obsolete. Use get and set method instead.
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="serial">
<h4 class="subsection">3.7.18 serial</h4>
<a class="index-entry-id" id="index-serial"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-serial-1"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">serial</var> =</code> <strong class="def-name">serial</strong> <code class="def-code-arguments">([<var class="var">path</var>], [<var class="var">baudrate</var>], [<var class="var">timeout</var>])</code><a class="copiable-link" href='#index-serial-1'> ¶</a></span></dt>
<dd>
<p>Open serial interface.
</p>
<h4 class="subsubheading" id="Inputs-49">Inputs</h4>
<p><var class="var">path</var> - the interface path of type String. <br>
<var class="var">baudrate</var> - the baudrate of interface. If omitted defaults to 115200. <br>
<var class="var">timeout</var> - the interface timeout value. If omitted defaults to blocking call.
</p>
<h4 class="subsubheading" id="Outputs-49">Outputs</h4>
<p>The serial() shall return an instance of <var class="var">octave_serial</var> class as the result <var class="var">serial</var>.
</p><h4 class="subsubheading" id="Properties-5">Properties</h4>
<p>The serial object has the following public properties:
</p><dl class="table">
<dt>name</dt>
<dd><p>name assigned to the object
</p></dd>
<dt>type</dt>
<dd><p>instrument type ’serial’ (readonly)
</p></dd>
<dt>port</dt>
<dd><p>OS specific port name (readonly)
</p></dd>
<dt>status</dt>
<dd><p>status of the object ’open’ or ’closed’ (readonly)
</p></dd>
<dt>timeout</dt>
<dd><p>timeout value used for waiting for data
</p></dd>
<dt>bytesavailable</dt>
<dd><p>number of bytes currently available to read (readonly)
</p></dd>
<dt>stopbits</dt>
<dd><p>number of stopbits to use
</p></dd>
<dt>requesttosend</dt>
<dd><p>request to send state - ’on’ or ’off’
</p></dd>
<dt>parity</dt>
<dd><p>Parity setting ’none’, ’even’, ’odd’
</p></dd>
<dt>bytesize</dt>
<dd><p>Number of bits to a byte (7 or 8)
</p></dd>
<dt>baudrate</dt>
<dd><p>Baudrate setting
</p></dd>
<dt>dataterminalready</dt>
<dd><p>state of dataterminal ready - ’on’ or ’off’
</p></dd>
<dt>pinstatus</dt>
<dd><p>current state of pins (readonly)
</p></dd>
</dl>
</dd></dl>
</div>
<div class="subsection-level-extent" id="seriallist">
<h4 class="subsection">3.7.19 seriallist</h4>
<a class="index-entry-id" id="index-seriallist"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-seriallist-1"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">list</var> =</code> <strong class="def-name">seriallist</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href='#index-seriallist-1'> ¶</a></span></dt>
<dd><p>Returns a list of all serial ports detected in the system.
</p>
<h4 class="subsubheading" id="Inputs-50">Inputs</h4>
<p>None
</p>
<h4 class="subsubheading" id="Outputs-50">Outputs</h4>
<p><var class="var">list</var> is a string cell array of serial ports names detected
in the system.
</p>
<p><strong class="strong">See also:</strong> instrhwinfo("serial").
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="srl_005fread">
<h4 class="subsection">3.7.20 srl_read</h4>
<a class="index-entry-id" id="index-srl_005fread"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-srl_005fread-1"><span class="category-def">Loadable Function: </span><span><code class="def-type">[<var class="var">data</var>, <var class="var">count</var>] =</code> <strong class="def-name">srl_read</strong> <code class="def-code-arguments">(<var class="var">serial</var>, <var class="var">n</var>)</code><a class="copiable-link" href='#index-srl_005fread-1'> ¶</a></span></dt>
<dd>
<p>Read from serial interface.
</p>
<h4 class="subsubheading" id="Inputs-51">Inputs</h4>
<p><var class="var">serial</var> - instance of <var class="var">octave_serial</var> class.<br>
<var class="var">n</var> - number of bytes to attempt to read of type Integer.
</p>
<h4 class="subsubheading" id="Outputs-51">Outputs</h4>
<p>The srl_read() shall return number of bytes successfully read in <var class="var">count</var> as Integer and the bytes themselves in <var class="var">data</var> as uint8 array.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="srl_005fwrite">
<h4 class="subsection">3.7.21 srl_write</h4>
<a class="index-entry-id" id="index-srl_005fwrite"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-srl_005fwrite-1"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">n</var> =</code> <strong class="def-name">srl_write</strong> <code class="def-code-arguments">(<var class="var">serial</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-srl_005fwrite-1'> ¶</a></span></dt>
<dd>
<p>Write data to a serial interface.
</p>
<h4 class="subsubheading" id="Inputs-52">Inputs</h4>
<p><var class="var">serial</var> - instance of <var class="var">octave_serial</var> class.<br>
<var class="var">data</var> - data to be written to the serial interface. Can be either of String or uint8 type.
</p>
<h4 class="subsubheading" id="Outputs-52">Outputs</h4>
<p>Upon successful completion, srl_write() shall return the number of bytes written as the result <var class="var">n</var>.
</p></dd></dl>
<hr>
</div>
</div>
<div class="section-level-extent" id="Serial-Port">
<div class="nav-panel">
<p>
Next: <a href="#SPI" accesskey="n" rel="next">SPI</a>, Previous: <a href="#Serial-_0028Deprecated_0029" accesskey="p" rel="prev">Serial (Deprecated)</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="Serial-Port-1">3.8 Serial Port</h3>
<a class="index-entry-id" id="index-Serial-Port"></a>
<ul class="mini-toc">
<li><a href="#g_t_0040octave_005fserialport_002fconfigureTerminator" accesskey="1">@octave_serialport/configureTerminator</a></li>
<li><a href="#g_t_0040octave_005fserialport_002fflush" accesskey="2">@octave_serialport/flush</a></li>
<li><a href="#g_t_0040octave_005fserialport_002ffprintf" accesskey="3">@octave_serialport/fprintf</a></li>
<li><a href="#g_t_0040octave_005fserialport_002ffread" accesskey="4">@octave_serialport/fread</a></li>
<li><a href="#g_t_0040octave_005fserialport_002ffwrite" accesskey="5">@octave_serialport/fwrite</a></li>
<li><a href="#g_t_0040octave_005fserialport_002fget" accesskey="6">@octave_serialport/get</a></li>
<li><a href="#g_t_0040octave_005fserialport_002fgetpinstatus" accesskey="7">@octave_serialport/getpinstatus</a></li>
<li><a href="#g_t_0040octave_005fserialport_002fread" accesskey="8">@octave_serialport/read</a></li>
<li><a href="#g_t_0040octave_005fserialport_002fserialbreak" accesskey="9">@octave_serialport/serialbreak</a></li>
<li><a href="#g_t_0040octave_005fserialport_002fset">@octave_serialport/set</a></li>
<li><a href="#g_t_0040octave_005fserialport_002fsetDTR">@octave_serialport/setDTR</a></li>
<li><a href="#g_t_0040octave_005fserialport_002fsetRTS">@octave_serialport/setRTS</a></li>
<li><a href="#g_t_0040octave_005fserialport_002fwrite">@octave_serialport/write</a></li>
<li><a href="#serialport">serialport</a></li>
<li><a href="#serialportlist">serialportlist</a></li>
</ul>
<div class="subsection-level-extent" id="g_t_0040octave_005fserialport_002fconfigureTerminator">
<h4 class="subsection">3.8.1 @octave_serialport/configureTerminator</h4>
<a class="index-entry-id" id="index-configureTerminator"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-configureTerminator-4"><span class="category-def">Function File: </span><span><strong class="def-name">configureTerminator</strong> <code class="def-code-arguments">(<var class="var">serial</var>, <var class="var">term</var>)</code><a class="copiable-link" href='#index-configureTerminator-4'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-configureTerminator-5"><span class="category-def">Function File: </span><span><strong class="def-name">configureTerminator</strong> <code class="def-code-arguments">(<var class="var">serial</var>, <var class="var">readterm</var>, <var class="var">writeterm</var>)</code><a class="copiable-link" href='#index-configureTerminator-5'> ¶</a></span></dt>
<dd><p>Set terminator for ASCII string manipulation
</p>
<h4 class="subsubheading" id="Inputs-53">Inputs</h4>
<p><var class="var">serial</var> - serialport object<br>
<var class="var">term</var> - terminal value for both read and write<br>
<var class="var">readterm</var> = terminal value type for read data<br>
<var class="var">writeterm</var> = terminal value for written data<br>
</p>
<p>The terminal can be either strings "cr", "lf" (default), "lf/cr" or an integer between 0 to 255.
</p>
<h4 class="subsubheading" id="Outputs-53">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> serialport.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserialport_002fflush">
<h4 class="subsection">3.8.2 @octave_serialport/flush</h4>
<a class="index-entry-id" id="index-flush"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-flush-6"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">flush</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-flush-6'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-flush-7"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">flush</strong> <code class="def-code-arguments">(<var class="var">dev</var>, "input")</code><a class="copiable-link" href='#index-flush-7'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-flush-8"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">flush</strong> <code class="def-code-arguments">(<var class="var">dev</var>, "output")</code><a class="copiable-link" href='#index-flush-8'> ¶</a></span></dt>
<dd><p>Flush the serial port buffers
</p>
<h4 class="subsubheading" id="Inputs-54">Inputs</h4>
<p><var class="var">dev</var> - connected serialport device
</p>
<p>If an additional parameter is provided of "input" or "output",
then only the input or output buffer will be flushed
</p>
<h4 class="subsubheading" id="Outputs-54">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> serialport.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserialport_002ffprintf">
<h4 class="subsection">3.8.3 @octave_serialport/fprintf</h4>
<a class="index-entry-id" id="index-fprintf-2"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fprintf-11"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">fprintf</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">template</var> ...)</code><a class="copiable-link" href='#index-fprintf-11'> ¶</a></span></dt>
<dd><p>Writes formatted string <var class="var">template</var> using optional parameters to
serialport instrument
</p>
<h4 class="subsubheading" id="Inputs-55">Inputs</h4>
<p><var class="var">obj</var> is a serialport object.<br>
<var class="var">template</var> Format template string
</p>
<h4 class="subsubheading" id="Outputs-55">Outputs</h4>
<p><var class="var">numbytes</var> - number of bytes written to the serial device.
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserialport_002ffread">
<h4 class="subsection">3.8.4 @octave_serialport/fread</h4>
<a class="index-entry-id" id="index-fread-4"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fread-31"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-fread-31'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-32"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>)</code><a class="copiable-link" href='#index-fread-32'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-33"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-fread-33'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-34"><span class="category-def">Function File: </span><span><code class="def-type">[<var class="var">data</var>,<var class="var">count</var>] =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, ...)</code><a class="copiable-link" href='#index-fread-34'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-35"><span class="category-def">Function File: </span><span><code class="def-type">[<var class="var">data</var>,<var class="var">count</var>,<var class="var">errmsg</var>] =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, ...)</code><a class="copiable-link" href='#index-fread-35'> ¶</a></span></dt>
<dd><p>Reads <var class="var">data</var> from serial port instrument
</p>
<h4 class="subsubheading" id="Inputs-56">Inputs</h4>
<p><var class="var">obj</var> is a serialport object.<br>
<var class="var">size</var> Number of values to read.<br>
<var class="var">precision</var> precision of data.<br>
</p>
<h4 class="subsubheading" id="Outputs-56">Outputs</h4>
<p><var class="var">data</var> The read data.<br>
<var class="var">count</var> number of values read.<br>
<var class="var">errmsg</var> read operation error message.<br>
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserialport_002ffwrite">
<h4 class="subsection">3.8.5 @octave_serialport/fwrite</h4>
<a class="index-entry-id" id="index-fwrite-4"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fwrite-21"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">fwrite</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-fwrite-21'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fwrite-22"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">fwrite</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-fwrite-22'> ¶</a></span></dt>
<dd><p>Writes <var class="var">data</var> to serial port instrument
</p>
<h4 class="subsubheading" id="Inputs-57">Inputs</h4>
<p><var class="var">obj</var> is a serial port object.<br>
<var class="var">data</var> data to write.<br>
<var class="var">precision</var> precision of data.<br>
</p>
<h4 class="subsubheading" id="Outputs-57">Outputs</h4>
<p>returns number of bytes written.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserialport_002fget">
<h4 class="subsection">3.8.6 @octave_serialport/get</h4>
<a class="index-entry-id" id="index-get-3"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-get-16"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">struct</var> =</code> <strong class="def-name">get</strong> <code class="def-code-arguments">(<var class="var">serial</var>)</code><a class="copiable-link" href='#index-get-16'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-get-17"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">field</var> =</code> <strong class="def-name">get</strong> <code class="def-code-arguments">(<var class="var">serial</var>, <var class="var">property</var>)</code><a class="copiable-link" href='#index-get-17'> ¶</a></span></dt>
<dd><p>Get the properties of serialport object.
</p>
<h4 class="subsubheading" id="Inputs-58">Inputs</h4>
<p><var class="var">serial</var> - instance of <var class="var">octave_serialport</var> class.<br>
<var class="var">property</var> - name of property.<br>
</p>
<h4 class="subsubheading" id="Outputs-58">Outputs</h4>
<p>When <var class="var">property</var> was specified, return the value of that property.<br>
otherwise return the values of all properties as a structure.<br>
</p>
<p><strong class="strong">See also:</strong> @octave_serial/set.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserialport_002fgetpinstatus">
<h4 class="subsection">3.8.7 @octave_serialport/getpinstatus</h4>
<a class="index-entry-id" id="index-getpinstatus"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-getpinstatus-1"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">status</var></code> <strong class="def-name">getpinstatus</strong> <code class="def-code-arguments">(<var class="var">serial</var>)</code><a class="copiable-link" href='#index-getpinstatus-1'> ¶</a></span></dt>
<dd><p>Get status of serial pins
</p>
<h4 class="subsubheading" id="Inputs-59">Inputs</h4>
<p><var class="var">serial</var> - serial object<br>
</p>
<h4 class="subsubheading" id="Outputs-59">Outputs</h4>
<p><var class="var">status</var> - a structure with the logic names of ClearToSend, DataSetReady, CarrierDetect, and RingIndicator
</p>
<p><strong class="strong">See also:</strong> serialport.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserialport_002fread">
<h4 class="subsection">3.8.8 @octave_serialport/read</h4>
<a class="index-entry-id" id="index-read-1"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-read-12"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">count</var>)</code><a class="copiable-link" href='#index-read-12'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-read-13"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">count</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-read-13'> ¶</a></span></dt>
<dd><p>Read a specified number of values from a serialport
using optional precision for valuesize.
</p>
<h4 class="subsubheading" id="Inputs-60">Inputs</h4>
<p><var class="var">dev</var> - connected serialport device
</p>
<p><var class="var">count</var> - number of elements to read
</p>
<p><var class="var">precision</var> - Optional precision for the output data read data.
Currently known precision values are uint8 (default), int8, uint16, int16, uint32, int32, uint64, uint64
</p>
<h4 class="subsubheading" id="Outputs-60">Outputs</h4>
<p><var class="var">data</var> - data read from the device
</p>
<p><strong class="strong">See also:</strong> serialport.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserialport_002fserialbreak">
<h4 class="subsection">3.8.9 @octave_serialport/serialbreak</h4>
<a class="index-entry-id" id="index-serialbreak-1"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-serialbreak-4"><span class="category-def">Function File: </span><span><strong class="def-name">serialbreak</strong> <code class="def-code-arguments">(<var class="var">serial</var>)</code><a class="copiable-link" href='#index-serialbreak-4'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-serialbreak-5"><span class="category-def">Function File: </span><span><strong class="def-name">serialbreak</strong> <code class="def-code-arguments">(<var class="var">serial</var>, <var class="var">time</var>)</code><a class="copiable-link" href='#index-serialbreak-5'> ¶</a></span></dt>
<dd><p>Send a break to the serial port
</p>
<h4 class="subsubheading" id="Inputs-61">Inputs</h4>
<p><var class="var">serial</var> - serialport object<br>
<var class="var">time</var> - number of milliseconds to break for. If not specified a value of 10 will be used.
</p>
<h4 class="subsubheading" id="Outputs-61">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> serial.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserialport_002fset">
<h4 class="subsection">3.8.10 @octave_serialport/set</h4>
<a class="index-entry-id" id="index-set-3"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-_0028obj_002c-6"><span class="category-def">Function File: </span><span><code class="def-type">set</code> <strong class="def-name">(<var class="var">obj</var>,</strong> <code class="def-code-arguments"><var class="var">property</var>,<var class="var">value</var>)</code><a class="copiable-link" href='#index-_0028obj_002c-6'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-_0028obj_002c-7"><span class="category-def">Function File: </span><span><code class="def-type">set</code> <strong class="def-name">(<var class="var">obj</var>,</strong> <code class="def-code-arguments"><var class="var">property</var>,<var class="var">value</var>,…)</code><a class="copiable-link" href='#index-_0028obj_002c-7'> ¶</a></span></dt>
<dd><p>Set the properties of serialport object.
</p>
<h4 class="subsubheading" id="Inputs-62">Inputs</h4>
<p><var class="var">serial</var> - instance of <var class="var">octave_serialport</var> class.<br>
<var class="var">property</var> - name of property.<br>
</p>
<p>If <var class="var">property</var> is a cell so must be <var class="var">value</var>, it sets the values of
all matching properties.
</p>
<p>The function also accepts property-value pairs.
</p>
<h4 class="subsubheading" id="Properties-6">Properties</h4>
<dl class="table">
<dt><var class="var">’baudrate’</var></dt>
<dd><p>Set the baudrate of serial port. Supported values by instrument-control:
0, 50, 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800, 9600,
19200, 38400, 57600, 115200 and 230400. The supported baudrate of your
serial port may be different.
</p>
</dd>
<dt><var class="var">’bytesize’</var></dt>
<dd><p>Set the bytesize. Supported values: 5, 6, 7 and 8.
</p>
</dd>
<dt><var class="var">’name’</var></dt>
<dd><p>Set the stored string name of the serial object.
</p>
</dd>
<dt><var class="var">’parity’</var></dt>
<dd><p>Set the parity value. Supported values: Even/Odd/None. This Parameter
must be of type string. It is case insensitive and can be abbreviated
to the first letter only
</p>
</dd>
<dt><var class="var">’stopbits’</var></dt>
<dd><p>Set the number of stopbits. Supported values: 1, 2.
</p>
</dd>
<dt><var class="var">’timeout’</var></dt>
<dd><p>Set the timeout value in tenths of a second. Value of -1 means a
blocking call. Maximum value of 255 (i.e. 25.5 seconds).
</p>
</dd>
<dt><var class="var">’requesttosend’</var></dt>
<dd><p>Set the requesttosend (RTS) line.
</p>
</dd>
<dt><var class="var">’dataterminalready’</var></dt>
<dd><p>Set the dataterminalready (DTR) line.
</p>
</dd>
</dl>
<h4 class="subsubheading" id="Outputs-62">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> @octave_serialport/-get.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserialport_002fsetDTR">
<h4 class="subsection">3.8.11 @octave_serialport/setDTR</h4>
<a class="index-entry-id" id="index-setDTR"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-setDTR-1"><span class="category-def">: </span><span><strong class="def-name">setDTR</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">true_false</var>)</code><a class="copiable-link" href='#index-setDTR-1'> ¶</a></span></dt>
<dd><p>Set the state of the DTR line
</p>
<h4 class="subsubheading" id="Inputs-63">Inputs</h4>
<p><var class="var">dev</var> - connected serial device.<br>
<var class="var">true_false</var> - state to set the line.<br>
</p>
<h4 class="subsubheading" id="Outputs-63">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> serialport, getpinstatus, setRTS.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserialport_002fsetRTS">
<h4 class="subsection">3.8.12 @octave_serialport/setRTS</h4>
<a class="index-entry-id" id="index-setRTS"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-setRTS-1"><span class="category-def">: </span><span><strong class="def-name">setRTS</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">true_false</var>)</code><a class="copiable-link" href='#index-setRTS-1'> ¶</a></span></dt>
<dd><p>Set the state of the RTS line
</p>
<h4 class="subsubheading" id="Inputs-64">Inputs</h4>
<p><var class="var">dev</var> - connected serial device.<br>
<var class="var">true_false</var> - state to set the line.<br>
</p>
<h4 class="subsubheading" id="Outputs-64">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> serialport, getpinstatus.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fserialport_002fwrite">
<h4 class="subsection">3.8.13 @octave_serialport/write</h4>
<a class="index-entry-id" id="index-write-1"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-write-9"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">write</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-write-9'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-write-10"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">write</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-write-10'> ¶</a></span></dt>
<dd><p>Writes <var class="var">data</var> to serialport instrument
</p>
<h4 class="subsubheading" id="Inputs-65">Inputs</h4>
<p><var class="var">obj</var> is a serialport object.<br>
<var class="var">data</var> data to write.<br>
<var class="var">precision</var> precision of data.<br>
</p>
<h4 class="subsubheading" id="Outputs-65">Outputs</h4>
<p>returns number of bytes written.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="serialport">
<h4 class="subsection">3.8.14 serialport</h4>
<a class="index-entry-id" id="index-serialport"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-serialport-1"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">serial</var> =</code> <strong class="def-name">serialport</strong> <code class="def-code-arguments">([<var class="var">path</var>], [<var class="var">baudrate</var>])</code><a class="copiable-link" href='#index-serialport-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-serialport-2"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">serial</var> =</code> <strong class="def-name">serialport</strong> <code class="def-code-arguments">([<var class="var">path</var>], [<var class="var">propname</var>, <var class="var">propvalue</var>])</code><a class="copiable-link" href='#index-serialport-2'> ¶</a></span></dt>
<dd>
<p>Open serial port interface.
</p>
<h4 class="subsubheading" id="Inputs-66">Inputs</h4>
<p><var class="var">path</var> - the interface path of type String. <br>
<var class="var">baudrate</var> - the baudrate of interface.<br>
<var class="var">propname</var>,<var class="var">propvalue</var> - property name/value pairs.
</p>
<p>Known input properties:
</p><dl class="table">
<dt>BaudRate</dt>
<dd><p>Numeric baudrate value
</p></dd>
<dt>Timeout</dt>
<dd><p>Numeric timeout value in seconds or -1 to wait forever
</p></dd>
<dt>StopBits</dt>
<dd><p>number of stopbits to use
</p></dd>
<dt>Parity</dt>
<dd><p>Parity setting ’none’, ’even’, ’odd’
</p></dd>
<dt>DataBits</dt>
<dd><p>Number of bits to a byte (5 to 8)
</p></dd>
<dt>FlowControl</dt>
<dd><p>Number of bits to a byte ’none’, ’hardware’, ’software’
</p></dd>
</dl>
<h4 class="subsubheading" id="Outputs-66">Outputs</h4>
<p>The serialport() shall return an instance of <var class="var">octave_serialport</var> class as the result <var class="var">serial</var>.
</p>
<h4 class="subsubheading" id="Properties-7">Properties</h4>
<p>The serial object has the following public properties:
</p><dl class="table">
<dt>Name</dt>
<dd><p>name assigned to the object
</p></dd>
<dt>Type</dt>
<dd><p>instrument type ’serial’ (readonly)
</p></dd>
<dt>Port</dt>
<dd><p>OS specific port name (readonly)
</p></dd>
<dt>Status</dt>
<dd><p>status of the object ’open’ or ’closed’ (readonly)
</p></dd>
<dt>Timeout</dt>
<dd><p>timeout value used for waiting for data
</p></dd>
<dt>NumBytesAvailable</dt>
<dd><p>number of bytes currently available to read (readonly)
</p></dd>
<dt>NumBytesWritten</dt>
<dd><p>number of bytes written (readonly)
</p></dd>
<dt>StopBits</dt>
<dd><p>number of stopbits to use
</p></dd>
<dt>Parity</dt>
<dd><p>Parity setting ’none’, ’even’, ’odd’
</p></dd>
<dt>DataBits</dt>
<dd><p>Number of bits to a byte (5 to 8)
</p></dd>
<dt>BaudRate</dt>
<dd><p>Baudrate setting
</p></dd>
<dt>FlowControl</dt>
<dd><p>Number of bits to a byte ’none’, ’hardware’, ’software’
</p></dd>
<dt>PinStatus</dt>
<dd><p>current state of pins (readonly)
</p></dd>
<dt>UserData</dt>
<dd><p>user defined data
</p></dd>
</dl>
</dd></dl>
</div>
<div class="subsection-level-extent" id="serialportlist">
<h4 class="subsection">3.8.15 serialportlist</h4>
<a class="index-entry-id" id="index-serialportlist"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-serialportlist-1"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">list</var> =</code> <strong class="def-name">serialportlist</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href='#index-serialportlist-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-serialportlist-2"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">list</var> =</code> <strong class="def-name">serialportlist</strong> <code class="def-code-arguments">("all")</code><a class="copiable-link" href='#index-serialportlist-2'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-serialportlist-3"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">list</var> =</code> <strong class="def-name">serialportlist</strong> <code class="def-code-arguments">("available")</code><a class="copiable-link" href='#index-serialportlist-3'> ¶</a></span></dt>
<dd><p>Returns a list of all serial ports detected in the system.
</p>
<h4 class="subsubheading" id="Inputs-67">Inputs</h4>
<p>’all’ - show all serial ports (same as providing no arguments)
’available’ - show only serial ports that are available for use
</p>
<h4 class="subsubheading" id="Outputs-67">Outputs</h4>
<p><var class="var">list</var> is a string cell array of serial ports names detected
in the system.
</p>
<p><strong class="strong">See also:</strong> instrhwinfo("serialport").
</p></dd></dl>
<hr>
</div>
</div>
<div class="section-level-extent" id="SPI">
<div class="nav-panel">
<p>
Next: <a href="#TCP-_0028Deprecated_0029" accesskey="n" rel="next">TCP (Deprecated)</a>, Previous: <a href="#Serial-Port" accesskey="p" rel="prev">Serial Port</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="SPI-1">3.9 SPI</h3>
<a class="index-entry-id" id="index-SPI"></a>
<ul class="mini-toc">
<li><a href="#g_t_0040octave_005fspi_002ffclose" accesskey="1">@octave_spi/fclose</a></li>
<li><a href="#g_t_0040octave_005fspi_002ffopen" accesskey="2">@octave_spi/fopen</a></li>
<li><a href="#g_t_0040octave_005fspi_002ffread" accesskey="3">@octave_spi/fread</a></li>
<li><a href="#g_t_0040octave_005fspi_002ffwrite" accesskey="4">@octave_spi/fwrite</a></li>
<li><a href="#g_t_0040octave_005fspi_002fget" accesskey="5">@octave_spi/get</a></li>
<li><a href="#g_t_0040octave_005fspi_002fread" accesskey="6">@octave_spi/read</a></li>
<li><a href="#g_t_0040octave_005fspi_002fset" accesskey="7">@octave_spi/set</a></li>
<li><a href="#g_t_0040octave_005fspi_002fwrite" accesskey="8">@octave_spi/write</a></li>
<li><a href="#g_t_0040octave_005fspi_002fwriteAndRead" accesskey="9">@octave_spi/writeAndRead</a></li>
<li><a href="#spi">spi</a></li>
<li><a href="#spi_005fclose">spi_close</a></li>
<li><a href="#spi_005fread">spi_read</a></li>
<li><a href="#spi_005fwrite">spi_write</a></li>
<li><a href="#spi_005fwriteAndRead">spi_writeAndRead</a></li>
</ul>
<div class="subsection-level-extent" id="g_t_0040octave_005fspi_002ffclose">
<h4 class="subsection">3.9.1 @octave_spi/fclose</h4>
<a class="index-entry-id" id="index-fclose-4"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fclose-13"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">res</var> =</code> <strong class="def-name">fclose</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-fclose-13'> ¶</a></span></dt>
<dd><p>Closes SPI connection <var class="var">obj</var>
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fspi_002ffopen">
<h4 class="subsection">3.9.2 @octave_spi/fopen</h4>
<a class="index-entry-id" id="index-fopen-4"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fopen-13"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">res</var> =</code> <strong class="def-name">fopen</strong> <code class="def-code-arguments">(<var class="var">obj</var>) (dummy)</code><a class="copiable-link" href='#index-fopen-13'> ¶</a></span></dt>
<dd><p>Opens SPI connection <var class="var">obj</var>
</p>
<p>This currently is a dummy function to improve compatibility to MATLAB
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fspi_002ffread">
<h4 class="subsection">3.9.3 @octave_spi/fread</h4>
<a class="index-entry-id" id="index-fread-5"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fread-36"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-fread-36'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-37"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>)</code><a class="copiable-link" href='#index-fread-37'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-38"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-fread-38'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-39"><span class="category-def">Function File: </span><span><code class="def-type">[<var class="var">data</var>,<var class="var">count</var>] =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, ...)</code><a class="copiable-link" href='#index-fread-39'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-40"><span class="category-def">Function File: </span><span><code class="def-type">[<var class="var">data</var>,<var class="var">count</var>,<var class="var">errmsg</var>] =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, ...)</code><a class="copiable-link" href='#index-fread-40'> ¶</a></span></dt>
<dd><p>Reads <var class="var">data</var> from a SPI instrument
</p>
<h4 class="subsubheading" id="Inputs-68">Inputs</h4>
<p><var class="var">obj</var> is a SPI object.<br>
<var class="var">size</var> Number of values to read. (Default: 10).<br>
<var class="var">precision</var> precision of data.<br>
</p>
<h4 class="subsubheading" id="Outputs-68">Outputs</h4>
<p><var class="var">data</var> data values.<br>
<var class="var">count</var> number of values read.<br>
<var class="var">errmsg</var> read operation error message.<br>
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fspi_002ffwrite">
<h4 class="subsection">3.9.4 @octave_spi/fwrite</h4>
<a class="index-entry-id" id="index-fwrite-5"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fwrite-23"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">fwrite</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-fwrite-23'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fwrite-24"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">fwrite</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-fwrite-24'> ¶</a></span></dt>
<dd><p>Writes <var class="var">data</var> to SPI instrument
</p>
<h4 class="subsubheading" id="Inputs-69">Inputs</h4>
<p><var class="var">obj</var> is a SPI object.<br>
<var class="var">data</var> data to write.<br>
<var class="var">precision</var> precision of data.<br>
</p>
<h4 class="subsubheading" id="Outputs-69">Outputs</h4>
<p>returns number of bytes written.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fspi_002fget">
<h4 class="subsection">3.9.5 @octave_spi/get</h4>
<a class="index-entry-id" id="index-get-4"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-get-18"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">struct</var> =</code> <strong class="def-name">get</strong> <code class="def-code-arguments">(<var class="var">spi</var>)</code><a class="copiable-link" href='#index-get-18'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-get-19"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">field</var> =</code> <strong class="def-name">get</strong> <code class="def-code-arguments">(<var class="var">spi</var>, <var class="var">property</var>)</code><a class="copiable-link" href='#index-get-19'> ¶</a></span></dt>
<dd><p>Get the properties of spi object.
</p>
<h4 class="subsubheading" id="Inputs-70">Inputs</h4>
<p><var class="var">spi</var> - instance of <var class="var">octave_spi</var> class.<br>
</p>
<p><var class="var">property</var> - name of property.<br>
</p>
<h4 class="subsubheading" id="Properties-8">Properties</h4>
<dl class="table">
<dt><var class="var">’name’</var></dt>
<dd><p>Name for the spi socket.
</p>
</dd>
<dt><var class="var">’bitrate’</var></dt>
<dd><p>The bitrate for the spi object.
</p>
</dd>
<dt><var class="var">’clockpolarity’</var></dt>
<dd><p>The clock polarity for the spi object of ’idlehigh’ or ’idlelow’.
</p>
</dd>
<dt><var class="var">’clockphase’</var></dt>
<dd><p>The clock phase for the spi object of ’firstedge’ or ’secondedge’.
</p>
</dd>
<dt><var class="var">’port’</var></dt>
<dd><p>The device port name.
</p>
</dd>
<dt><var class="var">’status’</var></dt>
<dd><p>The device status of ’open’ or ’closed’
</p></dd>
</dl>
<h4 class="subsubheading" id="Outputs-70">Outputs</h4>
<p>When <var class="var">property</var> was specified, return the value of that property.<br>
otherwise return the values of all properties as a structure.<br>
</p>
<p><strong class="strong">See also:</strong> @octave_spi/set.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fspi_002fread">
<h4 class="subsection">3.9.6 @octave_spi/read</h4>
<a class="index-entry-id" id="index-read-2"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-read-14"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-read-14'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-read-15"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>)</code><a class="copiable-link" href='#index-read-15'> ¶</a></span></dt>
<dd><p>Reads <var class="var">data</var> from SPI instrument
</p>
<h4 class="subsubheading" id="Inputs-71">Inputs</h4>
<p><var class="var">obj</var> is a SPI object.<br>
<var class="var">size</var> Number of values to read. (Default: 10).<br>
</p>
<h4 class="subsubheading" id="Outputs-71">Outputs</h4>
<p><var class="var">data</var> data values.<br>
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fspi_002fset">
<h4 class="subsection">3.9.7 @octave_spi/set</h4>
<a class="index-entry-id" id="index-set-4"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-_0028obj_002c-8"><span class="category-def">Function File: </span><span><code class="def-type">set</code> <strong class="def-name">(<var class="var">obj</var>,</strong> <code class="def-code-arguments"><var class="var">property</var>,<var class="var">value</var>)</code><a class="copiable-link" href='#index-_0028obj_002c-8'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-_0028obj_002c-9"><span class="category-def">Function File: </span><span><code class="def-type">set</code> <strong class="def-name">(<var class="var">obj</var>,</strong> <code class="def-code-arguments"><var class="var">property</var>,<var class="var">value</var>,…)</code><a class="copiable-link" href='#index-_0028obj_002c-9'> ¶</a></span></dt>
<dd><p>Set the properties of spi object.
</p>
<h4 class="subsubheading" id="Inputs-72">Inputs</h4>
<p><var class="var">obj</var> - instance of <var class="var">octave_spi</var> class.<br>
<var class="var">property</var> - name of property.<br>
</p>
<p>If <var class="var">property</var> is a cell so must be <var class="var">value</var>, it sets the values of
all matching properties.
</p>
<p>The function also accepts property-value pairs.
</p>
<h4 class="subsubheading" id="Properties-9">Properties</h4>
<dl class="table">
<dt><var class="var">’name’</var></dt>
<dd><p>Set the name for the spi socket.
</p>
</dd>
<dt><var class="var">’bitrate’</var></dt>
<dd><p>Set the bitrate for the spi object.
</p>
</dd>
<dt><var class="var">’clockpolarity’</var></dt>
<dd><p>Set the clock polarity for the spi object of ’idlehigh’ or ’idlelow’.
</p>
</dd>
<dt><var class="var">’clockphase’</var></dt>
<dd><p>Set the clock phase for the spi object of ’firstedge’ or ’secondedge’.
</p>
</dd>
</dl>
<h4 class="subsubheading" id="Outputs-72">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> @octave_spi/get.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fspi_002fwrite">
<h4 class="subsection">3.9.8 @octave_spi/write</h4>
<a class="index-entry-id" id="index-write-2"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fwrite-25"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">fwrite</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-fwrite-25'> ¶</a></span></dt>
<dd><p>Writes <var class="var">data</var> to SPI instrument
</p>
<h4 class="subsubheading" id="Inputs-73">Inputs</h4>
<p><var class="var">obj</var> is a SPI object.<br>
<var class="var">data</var> data to write.<br>
</p>
<h4 class="subsubheading" id="Outputs-73">Outputs</h4>
<p>returns number of bytes written.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fspi_002fwriteAndRead">
<h4 class="subsection">3.9.9 @octave_spi/writeAndRead</h4>
<a class="index-entry-id" id="index-writeAndRead"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-writeAndRead-1"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">writeAndRead</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">wrdata</var>)</code><a class="copiable-link" href='#index-writeAndRead-1'> ¶</a></span></dt>
<dd><p>Writes and reads <var class="var">data</var> from SPI instrument
</p>
<h4 class="subsubheading" id="Inputs-74">Inputs</h4>
<p><var class="var">obj</var> is a SPI object.<br>
<var class="var">wrdata</var> Data to write.<br>
</p>
<h4 class="subsubheading" id="Outputs-74">Outputs</h4>
<p><var class="var">data</var> data values read.<br>
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="spi">
<h4 class="subsection">3.9.10 spi</h4>
<a class="index-entry-id" id="index-spi"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-spi-1"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">spi</var> =</code> <strong class="def-name">spi</strong> <code class="def-code-arguments">([<var class="var">port_path</var>])</code><a class="copiable-link" href='#index-spi-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-spi-2"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">spi</var> =</code> <strong class="def-name">spi</strong> <code class="def-code-arguments">([<var class="var">port_path</var>], [<var class="var">propname</var>, <var class="var">propvalue</var>])</code><a class="copiable-link" href='#index-spi-2'> ¶</a></span></dt>
<dd>
<p>Open a spi interface.
</p>
<h4 class="subsubheading" id="Inputs-75">Inputs</h4>
<p><var class="var">port_path</var> - the interface device port/path of type String. If omitted defaults to
’/dev/spi-0’. <br>
<var class="var">propname</var>,<var class="var">propvalue</var> - property name/value pairs.
</p>
<p>Known input properties:
</p><dl class="table">
<dt>name</dt>
<dd><p>Name of the object
</p></dd>
<dt>bitrate</dt>
<dd><p>Numeric bitrate value
</p></dd>
<dt>clockpolarity</dt>
<dd><p>Clock polarity: idlehigh or idlelow.
</p></dd>
<dt>clockphase</dt>
<dd><p>Clock phase value: firstedge or secondedge
</p></dd>
</dl>
<h4 class="subsubheading" id="Outputs-75">Outputs</h4>
<p><var class="var">spi</var> - An instance of <var class="var">octave_spi</var> class.
</p>
<h4 class="subsubheading" id="Properties-10">Properties</h4>
<p>The spi object has the following properties:
</p><dl class="table">
<dt>name</dt>
<dd><p>Name of the object
</p></dd>
<dt>status</dt>
<dd><p>Open or closed status of object (readonly).
</p></dd>
<dt>bitrate</dt>
<dd><p>Numeric bitrate value
</p></dd>
<dt>clockpolarity</dt>
<dd><p>Clock polarity: idlehigh or idlelow.
</p></dd>
<dt>clockphase</dt>
<dd><p>Clock phase value: firstedge or secondedge
</p></dd>
<dt>port</dt>
<dd><p>The interface driver port (readonly)
</p></dd>
</dl>
</dd></dl>
</div>
<div class="subsection-level-extent" id="spi_005fclose">
<h4 class="subsection">3.9.11 spi_close</h4>
<a class="index-entry-id" id="index-spi_005fclose"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-spi_005fclose-1"><span class="category-def">Loadable Function: </span><span><strong class="def-name">spi_close</strong> <code class="def-code-arguments">(<var class="var">spi</var>)</code><a class="copiable-link" href='#index-spi_005fclose-1'> ¶</a></span></dt>
<dd>
<p>Close the interface and release a file descriptor.
</p>
<h4 class="subsubheading" id="Inputs-76">Inputs</h4>
<p><var class="var">spi</var> - instance of <var class="var">octave_spi</var> class.<br>
</p>
<h4 class="subsubheading" id="Outputs-76">Outputs</h4>
<p>None
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="spi_005fread">
<h4 class="subsection">3.9.12 spi_read</h4>
<a class="index-entry-id" id="index-spi_005fread"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-spi_005fread-1"><span class="category-def">Loadable Function: </span><span><code class="def-type">[<var class="var">data</var>, <var class="var">count</var>] =</code> <strong class="def-name">spi_read</strong> <code class="def-code-arguments">(<var class="var">spi</var>, <var class="var">n</var>)</code><a class="copiable-link" href='#index-spi_005fread-1'> ¶</a></span></dt>
<dd>
<p>Read from spi slave device.
</p>
<h4 class="subsubheading" id="Inputs-77">Inputs</h4>
<p><var class="var">spi</var> - instance of <var class="var">octave_spi</var> class.<br>
<var class="var">n</var> - number of bytes to attempt to read of type Integer.
</p>
<h4 class="subsubheading" id="Outputs-77">Outputs</h4>
<p>The spi_read() shall return number of bytes successfully read in <var class="var">count</var> as Integer and the bytes themselves in <var class="var">data</var> as uint8 array.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="spi_005fwrite">
<h4 class="subsection">3.9.13 spi_write</h4>
<a class="index-entry-id" id="index-spi_005fwrite"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-spi_005fwrite-1"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">n</var> =</code> <strong class="def-name">spi_write</strong> <code class="def-code-arguments">(<var class="var">spi</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-spi_005fwrite-1'> ¶</a></span></dt>
<dd>
<p>Write data to a spi slave device.
</p>
<h4 class="subsubheading" id="Inputs-78">Inputs</h4>
<p><var class="var">spi</var> - instance of <var class="var">octave_spi</var> class.<br>
<var class="var">data</var> - data, of type uint8, to be written to the slave device.
</p>
<h4 class="subsubheading" id="Outputs-78">Outputs</h4>
<p>Upon successful completion, spi_write() shall return the number of bytes written as the result <var class="var">n</var>.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="spi_005fwriteAndRead">
<h4 class="subsection">3.9.14 spi_writeAndRead</h4>
<a class="index-entry-id" id="index-spi_005fwriteAndRead"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-spi_005fwriteAndRead-1"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">rddata</var> =</code> <strong class="def-name">spi_writeAndRead</strong> <code class="def-code-arguments">(<var class="var">spi</var>, <var class="var">wrdata</var>)</code><a class="copiable-link" href='#index-spi_005fwriteAndRead-1'> ¶</a></span></dt>
<dd>
<p>Write data to a spi slave device and then read same number of values.
</p>
<h4 class="subsubheading" id="Inputs-79">Inputs</h4>
<p><var class="var">spi</var> - instance of <var class="var">octave_spi</var> class.<br>
<var class="var">wrdata</var> - data, of type uint8, to be written to the slave device.<br>
</p>
<h4 class="subsubheading" id="Outputs-79">Outputs</h4>
<p>Upon successful completion, spi_writeAndRead() shall return the bytes read.
</p></dd></dl>
<hr>
</div>
</div>
<div class="section-level-extent" id="TCP-_0028Deprecated_0029">
<div class="nav-panel">
<p>
Next: <a href="#TCP-Client" accesskey="n" rel="next">TCP Client</a>, Previous: <a href="#SPI" accesskey="p" rel="prev">SPI</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="TCP-_0028Deprecated_0029-1">3.10 TCP (Deprecated)</h3>
<a class="index-entry-id" id="index-TCP-_0028Deprecated_0029"></a>
<ul class="mini-toc">
<li><a href="#g_t_0040octave_005ftcp_002ffclose" accesskey="1">@octave_tcp/fclose</a></li>
<li><a href="#g_t_0040octave_005ftcp_002fflush" accesskey="2">@octave_tcp/flush</a></li>
<li><a href="#g_t_0040octave_005ftcp_002fflushinput" accesskey="3">@octave_tcp/flushinput</a></li>
<li><a href="#g_t_0040octave_005ftcp_002fflushoutput" accesskey="4">@octave_tcp/flushoutput</a></li>
<li><a href="#g_t_0040octave_005ftcp_002ffopen" accesskey="5">@octave_tcp/fopen</a></li>
<li><a href="#g_t_0040octave_005ftcp_002ffprintf" accesskey="6">@octave_tcp/fprintf</a></li>
<li><a href="#g_t_0040octave_005ftcp_002ffread" accesskey="7">@octave_tcp/fread</a></li>
<li><a href="#g_t_0040octave_005ftcp_002ffwrite" accesskey="8">@octave_tcp/fwrite</a></li>
<li><a href="#g_t_0040octave_005ftcp_002fget" accesskey="9">@octave_tcp/get</a></li>
<li><a href="#g_t_0040octave_005ftcp_002fread">@octave_tcp/read</a></li>
<li><a href="#g_t_0040octave_005ftcp_002fset">@octave_tcp/set</a></li>
<li><a href="#g_t_0040octave_005ftcp_002fwrite">@octave_tcp/write</a></li>
<li><a href="#tcp">tcp</a></li>
<li><a href="#tcp_005fclose">tcp_close</a></li>
<li><a href="#tcp_005fread">tcp_read</a></li>
<li><a href="#tcp_005ftimeout">tcp_timeout</a></li>
<li><a href="#tcp_005fwrite">tcp_write</a></li>
<li><a href="#tcpip">tcpip</a></li>
</ul>
<div class="subsection-level-extent" id="g_t_0040octave_005ftcp_002ffclose">
<h4 class="subsection">3.10.1 @octave_tcp/fclose</h4>
<a class="index-entry-id" id="index-fclose-5"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fclose-14"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">res</var> =</code> <strong class="def-name">fclose</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-fclose-14'> ¶</a></span></dt>
<dd><p>Closes TCP connection <var class="var">obj</var>
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005ftcp_002fflush">
<h4 class="subsection">3.10.2 @octave_tcp/flush</h4>
<a class="index-entry-id" id="index-flush-1"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-flush-9"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">flush</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-flush-9'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-flush-10"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">flush</strong> <code class="def-code-arguments">(<var class="var">dev</var>, "input")</code><a class="copiable-link" href='#index-flush-10'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-flush-11"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">flush</strong> <code class="def-code-arguments">(<var class="var">dev</var>, "output")</code><a class="copiable-link" href='#index-flush-11'> ¶</a></span></dt>
<dd><p>Flush the tcp socket buffers
</p>
<h4 class="subsubheading" id="Inputs-80">Inputs</h4>
<p><var class="var">dev</var> - connected tcp device
</p>
<p>If an additional parameter is provided of "input" or "output",
then only the input or output buffer will be flushed
</p>
<h4 class="subsubheading" id="Outputs-80">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> serialport.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005ftcp_002fflushinput">
<h4 class="subsection">3.10.3 @octave_tcp/flushinput</h4>
<a class="index-entry-id" id="index-flushinput-2"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-flushinput-6"><span class="category-def">Loadable Function: </span><span><strong class="def-name">flushinput</strong> <code class="def-code-arguments">(<var class="var">tcp</var>)</code><a class="copiable-link" href='#index-flushinput-6'> ¶</a></span></dt>
<dd>
<p>Flush the pending input, which will also make the BytesAvailable property be 0.
</p>
<h4 class="subsubheading" id="Inputs-81">Inputs</h4>
<p><var class="var">tcp</var> - instance of <var class="var">octave_tcp</var> class.
</p>
<h4 class="subsubheading" id="Outputs-81">Outputs</h4>
<p>None.
</p>
<p><strong class="strong">See also:</strong> flushoutput.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005ftcp_002fflushoutput">
<h4 class="subsection">3.10.4 @octave_tcp/flushoutput</h4>
<a class="index-entry-id" id="index-flushoutput-2"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-flushoutput-6"><span class="category-def">Loadable Function: </span><span><strong class="def-name">flushoutput</strong> <code class="def-code-arguments">(<var class="var">tcp</var>)</code><a class="copiable-link" href='#index-flushoutput-6'> ¶</a></span></dt>
<dd>
<p>Flush the output buffer.
</p>
<h4 class="subsubheading" id="Inputs-82">Inputs</h4>
<p><var class="var">tcp</var> - instance of <var class="var">octave_tcp</var> class.
</p>
<h4 class="subsubheading" id="Outputs-82">Outputs</h4>
<p>None.
</p>
<p><strong class="strong">See also:</strong> flushinput.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005ftcp_002ffopen">
<h4 class="subsection">3.10.5 @octave_tcp/fopen</h4>
<a class="index-entry-id" id="index-fopen-5"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fopen-14"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">res</var> =</code> <strong class="def-name">fopen</strong> <code class="def-code-arguments">(<var class="var">obj</var>) (dummy)</code><a class="copiable-link" href='#index-fopen-14'> ¶</a></span></dt>
<dd><p>Opens TCP connection <var class="var">obj</var>
</p>
<p>This currently is a dummy function to improve compatibility to MATLAB
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005ftcp_002ffprintf">
<h4 class="subsection">3.10.6 @octave_tcp/fprintf</h4>
<a class="index-entry-id" id="index-fprintf-3"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fprintf-12"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">fprintf</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">template</var> ...)</code><a class="copiable-link" href='#index-fprintf-12'> ¶</a></span></dt>
<dd><p>Writes formatted string <var class="var">template</var> using optional parameters to
TCP instrument
</p>
<h4 class="subsubheading" id="Inputs-83">Inputs</h4>
<p><var class="var">obj</var> is a TCP object.<br>
<var class="var">template</var> Format template string
</p>
<h4 class="subsubheading" id="Outputs-83">Outputs</h4>
<p>Number of characters written
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005ftcp_002ffread">
<h4 class="subsection">3.10.7 @octave_tcp/fread</h4>
<a class="index-entry-id" id="index-fread-6"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fread-41"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-fread-41'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-42"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>)</code><a class="copiable-link" href='#index-fread-42'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-43"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-fread-43'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-44"><span class="category-def">Function File: </span><span><code class="def-type">[<var class="var">data</var>,<var class="var">count</var>] =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, ...)</code><a class="copiable-link" href='#index-fread-44'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-45"><span class="category-def">Function File: </span><span><code class="def-type">[<var class="var">data</var>,<var class="var">count</var>,<var class="var">errmsg</var>] =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, ...)</code><a class="copiable-link" href='#index-fread-45'> ¶</a></span></dt>
<dd><p>Reads <var class="var">data</var> from TCP instrument
</p>
<h4 class="subsubheading" id="Inputs-84">Inputs</h4>
<p><var class="var">obj</var> is a TCP object.<br>
<var class="var">size</var> Number of values to read. (Default: 100).<br>
<var class="var">precision</var> precision of data.<br>
</p>
<h4 class="subsubheading" id="Outputs-84">Outputs</h4>
<p><var class="var">data</var> data read.<br>
<var class="var">count</var> values read.<br>
<var class="var">errmsg</var> read operation error message.<br>
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005ftcp_002ffwrite">
<h4 class="subsection">3.10.8 @octave_tcp/fwrite</h4>
<a class="index-entry-id" id="index-fwrite-6"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fwrite-26"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">fwrite</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-fwrite-26'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fwrite-27"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">fwrite</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-fwrite-27'> ¶</a></span></dt>
<dd><p>Writes <var class="var">data</var> to TCP instrument
</p>
<h4 class="subsubheading" id="Inputs-85">Inputs</h4>
<p><var class="var">obj</var> is a TCP object.<br>
<var class="var">data</var> data to write.<br>
<var class="var">precision</var> precision of data.<br>
</p>
<h4 class="subsubheading" id="Outputs-85">Outputs</h4>
<p>returns number of bytes written.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005ftcp_002fget">
<h4 class="subsection">3.10.9 @octave_tcp/get</h4>
<a class="index-entry-id" id="index-get-5"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-get-20"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">struct</var> =</code> <strong class="def-name">get</strong> <code class="def-code-arguments">(<var class="var">tcp</var>)</code><a class="copiable-link" href='#index-get-20'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-get-21"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">field</var> =</code> <strong class="def-name">get</strong> <code class="def-code-arguments">(<var class="var">tcp</var>, <var class="var">property</var>)</code><a class="copiable-link" href='#index-get-21'> ¶</a></span></dt>
<dd><p>Get the properties of tcp object.
</p>
<h4 class="subsubheading" id="Inputs-86">Inputs</h4>
<p><var class="var">tcp</var> - instance of <var class="var">octave_tcp</var> class.<br>
<var class="var">property</var> - name of property.<br>
</p>
<h4 class="subsubheading" id="Outputs-86">Outputs</h4>
<p>When <var class="var">property</var> was specified, return the value of that property.<br>
otherwise return the values of all properties as a structure.<br>
</p>
<p><strong class="strong">See also:</strong> @octave_tcp/set.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005ftcp_002fread">
<h4 class="subsection">3.10.10 @octave_tcp/read</h4>
<a class="index-entry-id" id="index-read-3"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-read-16"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-read-16'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-read-17"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>)</code><a class="copiable-link" href='#index-read-17'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-read-18"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>, <var class="var">datatype</var>)</code><a class="copiable-link" href='#index-read-18'> ¶</a></span></dt>
<dd><p>Reads <var class="var">data</var> from TCP instrument
</p>
<h4 class="subsubheading" id="Inputs-87">Inputs</h4>
<p><var class="var">obj</var> is a TCP object.<br>
<var class="var">size</var> Number of values to read. (Default: 100).<br>
<var class="var">datatype</var> datatype of data.<br>
</p>
<h4 class="subsubheading" id="Outputs-87">Outputs</h4>
<p><var class="var">data</var> data read.<br>
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005ftcp_002fset">
<h4 class="subsection">3.10.11 @octave_tcp/set</h4>
<a class="index-entry-id" id="index-set-5"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-_0028obj_002c-10"><span class="category-def">Function File: </span><span><code class="def-type">set</code> <strong class="def-name">(<var class="var">obj</var>,</strong> <code class="def-code-arguments"><var class="var">property</var>,<var class="var">value</var>)</code><a class="copiable-link" href='#index-_0028obj_002c-10'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-_0028obj_002c-11"><span class="category-def">Function File: </span><span><code class="def-type">set</code> <strong class="def-name">(<var class="var">obj</var>,</strong> <code class="def-code-arguments"><var class="var">property</var>,<var class="var">value</var>,…)</code><a class="copiable-link" href='#index-_0028obj_002c-11'> ¶</a></span></dt>
<dd><p>Set the properties of tcp object.
</p>
<h4 class="subsubheading" id="Inputs-88">Inputs</h4>
<p>If <var class="var">property</var> is a cell so must be <var class="var">value</var>, it sets the values of
all matching properties.
</p>
<p>The function also accepts property-value pairs.
</p>
<h4 class="subsubheading" id="Properties-11">Properties</h4>
<dl class="table">
<dt><var class="var">’name’</var></dt>
<dd><p>Set the name for the tcp socket.
</p>
</dd>
<dt><var class="var">’remotehost’</var></dt>
<dd><p>Set the remote host name for the tcp socket.
</p>
</dd>
<dt><var class="var">’remoteport’</var></dt>
<dd><p>Set the remote port for the tcp socket.
</p>
</dd>
<dt><var class="var">’timeout’</var></dt>
<dd><p>Set the timeout value in seconds. Value of -1 means a
blocking call.
</p>
</dd>
</dl>
<h4 class="subsubheading" id="Outputs-88">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> @octave_tcp/get.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005ftcp_002fwrite">
<h4 class="subsection">3.10.12 @octave_tcp/write</h4>
<a class="index-entry-id" id="index-write-3"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-write-11"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">write</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-write-11'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-write-12"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">write</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>, <var class="var">datatype</var>)</code><a class="copiable-link" href='#index-write-12'> ¶</a></span></dt>
<dd><p>Writes <var class="var">data</var> to TCP instrument
</p>
<h4 class="subsubheading" id="Inputs-89">Inputs</h4>
<p><var class="var">obj</var> is a TCP object.<br>
<var class="var">data</var> data to write.<br>
<var class="var">datatype</var> datatype of data. If not specified, it defaults to "uint8".<br>
</p>
<h4 class="subsubheading" id="Outputs-89">Outputs</h4>
<p>returns number of bytes written.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="tcp">
<h4 class="subsection">3.10.13 tcp</h4>
<a class="index-entry-id" id="index-tcp"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-tcp-1"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">tcp</var> =</code> <strong class="def-name">tcp</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href='#index-tcp-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-tcp-2"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">tcp</var> =</code> <strong class="def-name">tcp</strong> <code class="def-code-arguments">(<var class="var">ipaddress</var>)</code><a class="copiable-link" href='#index-tcp-2'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-tcp-3"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">tcp</var> =</code> <strong class="def-name">tcp</strong> <code class="def-code-arguments">(<var class="var">ipaddress</var>, <var class="var">port</var>)</code><a class="copiable-link" href='#index-tcp-3'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-tcp-4"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">tcp</var> =</code> <strong class="def-name">tcp</strong> <code class="def-code-arguments">(<var class="var">ipaddress</var>, <var class="var">port</var>, <var class="var">timeout</var>)</code><a class="copiable-link" href='#index-tcp-4'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-tcp-5"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">tcp</var> =</code> <strong class="def-name">tcp</strong> <code class="def-code-arguments">(<var class="var">ipaddress</var>, [<var class="var">propertyname</var>, <var class="var">propertyvalue</var>])</code><a class="copiable-link" href='#index-tcp-5'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-tcp-6"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">tcp</var> =</code> <strong class="def-name">tcp</strong> <code class="def-code-arguments">(<var class="var">ipaddress</var>, <var class="var">port</var>, [<var class="var">propertyname</var>, <var class="var">propertyvalue</var>])</code><a class="copiable-link" href='#index-tcp-6'> ¶</a></span></dt>
<dd>
<p>Open tcp interface.
</p>
<h4 class="subsubheading" id="Inputs-90">Inputs</h4>
<p><var class="var">ipaddress</var> - the ip address of type String. If omitted defaults to ’127.0.0.1’.<br>
<var class="var">port</var> - the port number to connect. If omitted defaults to 23.<br>
<var class="var">timeout</var> - the interface timeout value. If omitted defaults to blocking call.<br>
<var class="var">propname</var>,<var class="var">propvalue</var> - property name/value pairs.
</p>
<p>Known input properties:
</p><dl class="table">
<dt>name</dt>
<dd><p>name value
</p></dd>
<dt>timeout</dt>
<dd><p>Numeric timeout value or -1 to wait forever
</p></dd>
</dl>
<h4 class="subsubheading" id="Outputs-90">Outputs</h4>
<p>The tcp() shall return instance of <var class="var">octave_tcp</var> class as the result <var class="var">tcp</var>.
</p><h4 class="subsubheading" id="Properties-12">Properties</h4>
<p>The tcp object has the following public properties:
</p><dl class="table">
<dt>name</dt>
<dd><p>name assigned to the tcp object
</p></dd>
<dt>type</dt>
<dd><p>instrument type ’tcp’ (readonly)
</p></dd>
<dt>localport</dt>
<dd><p>local port number (readonly)
</p></dd>
<dt>remoteport</dt>
<dd><p>remote port number
</p></dd>
<dt>remotehost</dt>
<dd><p>remote host
</p></dd>
<dt>status</dt>
<dd><p>status of the object ’open’ or ’closed’ (readonly)
</p></dd>
<dt>timeout</dt>
<dd><p>timeout value in seconds used for waiting for data
</p></dd>
<dt>bytesavailable</dt>
<dd><p>number of bytes currently available to read (readonly)
</p></dd>
</dl>
</dd></dl>
</div>
<div class="subsection-level-extent" id="tcp_005fclose">
<h4 class="subsection">3.10.14 tcp_close</h4>
<a class="index-entry-id" id="index-tcp_005fclose"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-tcp_005fclose-1"><span class="category-def">Loadable Function: </span><span><strong class="def-name">tcp_close</strong> <code class="def-code-arguments">(<var class="var">tcp</var>)</code><a class="copiable-link" href='#index-tcp_005fclose-1'> ¶</a></span></dt>
<dd>
<p>Close the interface and release a file descriptor.
</p>
<h4 class="subsubheading" id="Inputs-91">Inputs</h4>
<p><var class="var">tcp</var> - instance of <var class="var">octave_tcp</var> class.
</p>
<h4 class="subsubheading" id="Outputs-91">Outputs</h4>
<p>None
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="tcp_005fread">
<h4 class="subsection">3.10.15 tcp_read</h4>
<a class="index-entry-id" id="index-tcp_005fread"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-tcp_005fread-1"><span class="category-def">Loadable Function: </span><span><code class="def-type">[<var class="var">data</var>, <var class="var">count</var>] =</code> <strong class="def-name">tcp_read</strong> <code class="def-code-arguments">(<var class="var">tcp</var>, <var class="var">n</var>, <var class="var">timeout</var>)</code><a class="copiable-link" href='#index-tcp_005fread-1'> ¶</a></span></dt>
<dd>
<p>Read from tcp interface.
</p>
<h4 class="subsubheading" id="Inputs-92">Inputs</h4>
<p><var class="var">tcp</var> - instance of <var class="var">octave_tcp</var> class.<br>
<var class="var">n</var> - number of bytes to attempt to read of type Integer<br>
<var class="var">timeout</var> - timeout in ms if different from default of type Integer
</p>
<h4 class="subsubheading" id="Outputs-92">Outputs</h4>
<p><var class="var">count</var> - number of bytes successfully read as an Integer<br>
<var class="var">data</var> - data bytes themselves as uint8 array.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="tcp_005ftimeout">
<h4 class="subsection">3.10.16 tcp_timeout</h4>
<a class="index-entry-id" id="index-tcp_005ftimeout"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-tcp_005ftimeout-1"><span class="category-def">Loadable Function: </span><span><strong class="def-name">tcp_timeout</strong> <code class="def-code-arguments">(<var class="var">tcp</var>, <var class="var">timeout</var>)</code><a class="copiable-link" href='#index-tcp_005ftimeout-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-tcp_005ftimeout-2"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">t</var> =</code> <strong class="def-name">tcp_timeout</strong> <code class="def-code-arguments">(<var class="var">tcp</var>)</code><a class="copiable-link" href='#index-tcp_005ftimeout-2'> ¶</a></span></dt>
<dd>
<p>Set new or get existing tcp interface timeout parameter used for tcp_read() requests. The timeout value is specified in milliseconds.
</p>
<h4 class="subsubheading" id="Inputs-93">Inputs</h4>
<p><var class="var">tcp</var> - instance of <var class="var">octave_tcp</var> class.<br>
<var class="var">timeout</var> - tcp_read() timeout value in milliseconds. Value of -1 means a blocking call.
</p>
<h4 class="subsubheading" id="Outputs-93">Outputs</h4>
<p>If <var class="var">timeout</var> parameter is omitted, the tcp_timeout() shall return current timeout value as the result <var class="var">t</var>.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="tcp_005fwrite">
<h4 class="subsection">3.10.17 tcp_write</h4>
<a class="index-entry-id" id="index-tcp_005fwrite"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-tcp_005fwrite-1"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">n</var> =</code> <strong class="def-name">tcp_write</strong> <code class="def-code-arguments">(<var class="var">tcp</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-tcp_005fwrite-1'> ¶</a></span></dt>
<dd>
<p>Write data to a tcp interface.
</p>
<h4 class="subsubheading" id="Inputs-94">Inputs</h4>
<p><var class="var">tcp</var> - instance of <var class="var">octave_tcp</var> class.<br>
<var class="var">data</var> - data to be written to the tcp interface. Can be either of String or uint8 type.
</p>
<h4 class="subsubheading" id="Outputs-94">Outputs</h4>
<p>Upon successful completion, tcp_write() shall return the number of bytes written as the result <var class="var">n</var>.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="tcpip">
<h4 class="subsection">3.10.18 tcpip</h4>
<a class="index-entry-id" id="index-tcpip"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-tcpip-1"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">tcp</var> =</code> <strong class="def-name">tcpip</strong> <code class="def-code-arguments">(<var class="var">host</var>, [<var class="var">port</var>], [<var class="var">PropertyName</var>, <var class="var">PropertyValue</var>...])</code><a class="copiable-link" href='#index-tcpip-1'> ¶</a></span></dt>
<dd><p>Matlab compatible wrapper to the tcp interface.
</p>
<p>NOTE: tcpip has been deprecated. Use tcpclient instead
</p>
<h4 class="subsubheading" id="Inputs-95">Inputs</h4>
<p><var class="var">host</var> - the host name or ip.<br>
<var class="var">port</var> - the port number to connect. If omitted defaults to 80.<br>
<var class="var">PropertyName</var>, <var class="var">PropertyValue</var> - Optional property name, value pairs to set on the tcp object.<br>
</p>
<h4 class="subsubheading" id="Properties-13">Properties</h4>
<p>Currently the only known properties are "timeout" and "name".
</p>
<h4 class="subsubheading" id="Outputs-95">Outputs</h4>
<p>tcpip will return an instance of <var class="var">octave_tcp</var> class as the result.
</p></dd></dl>
<hr>
</div>
</div>
<div class="section-level-extent" id="TCP-Client">
<div class="nav-panel">
<p>
Next: <a href="#TCP-Server" accesskey="n" rel="next">TCP Server</a>, Previous: <a href="#TCP-_0028Deprecated_0029" accesskey="p" rel="prev">TCP (Deprecated)</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="TCP-Client-2">3.11 TCP Client</h3>
<a class="index-entry-id" id="index-TCP-Client"></a>
<ul class="mini-toc">
<li><a href="#g_t_0040octave_005ftcpclient_002fconfigureTerminator" accesskey="1">@octave_tcpclient/configureTerminator</a></li>
<li><a href="#g_t_0040octave_005ftcpclient_002fflush" accesskey="2">@octave_tcpclient/flush</a></li>
<li><a href="#g_t_0040octave_005ftcpclient_002fget" accesskey="3">@octave_tcpclient/get</a></li>
<li><a href="#g_t_0040octave_005ftcpclient_002fread" accesskey="4">@octave_tcpclient/read</a></li>
<li><a href="#g_t_0040octave_005ftcpclient_002fset" accesskey="5">@octave_tcpclient/set</a></li>
<li><a href="#g_t_0040octave_005ftcpclient_002fwrite" accesskey="6">@octave_tcpclient/write</a></li>
<li><a href="#tcpclient" accesskey="7">tcpclient</a></li>
</ul>
<div class="subsection-level-extent" id="g_t_0040octave_005ftcpclient_002fconfigureTerminator">
<h4 class="subsection">3.11.1 @octave_tcpclient/configureTerminator</h4>
<a class="index-entry-id" id="index-configureTerminator-1"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-configureTerminator-6"><span class="category-def">Function File: </span><span><strong class="def-name">configureTerminator</strong> <code class="def-code-arguments">(<var class="var">tcp</var>, <var class="var">term</var>)</code><a class="copiable-link" href='#index-configureTerminator-6'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-configureTerminator-7"><span class="category-def">Function File: </span><span><strong class="def-name">configureTerminator</strong> <code class="def-code-arguments">(<var class="var">tcp</var>, <var class="var">readterm</var>, <var class="var">writeterm</var>)</code><a class="copiable-link" href='#index-configureTerminator-7'> ¶</a></span></dt>
<dd><p>Set terminator on a tcpclient object for ASCII string manipulation
</p>
<h4 class="subsubheading" id="Inputs-96">Inputs</h4>
<p><var class="var">tcp</var> - tcpclient object<br>
<var class="var">term</var> - terminal value for both read and write<br>
<var class="var">readterm</var> = terminal value type for read data<br>
<var class="var">writeterm</var> = terminal value for written data<br>
</p>
<p>The terminal can be either strings "cr", "lf" (default), "lf/cr" or an integer between 0 to 255.
</p>
<h4 class="subsubheading" id="Outputs-96">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> tcpport.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005ftcpclient_002fflush">
<h4 class="subsection">3.11.2 @octave_tcpclient/flush</h4>
<a class="index-entry-id" id="index-flush-2"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-flush-12"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">flush</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-flush-12'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-flush-13"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">flush</strong> <code class="def-code-arguments">(<var class="var">dev</var>, "input")</code><a class="copiable-link" href='#index-flush-13'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-flush-14"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">flush</strong> <code class="def-code-arguments">(<var class="var">dev</var>, "output")</code><a class="copiable-link" href='#index-flush-14'> ¶</a></span></dt>
<dd><p>Flush the tcpclient socket buffers
</p>
<h4 class="subsubheading" id="Inputs-97">Inputs</h4>
<p><var class="var">dev</var> - connected tcpclient device
</p>
<p>If an additional parameter is provided of "input" or "output",
then only the input or output buffer will be flushed
</p>
<h4 class="subsubheading" id="Outputs-97">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> serialport.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005ftcpclient_002fget">
<h4 class="subsection">3.11.3 @octave_tcpclient/get</h4>
<a class="index-entry-id" id="index-get-6"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-get-22"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">struct</var> =</code> <strong class="def-name">get</strong> <code class="def-code-arguments">(<var class="var">tcpclient</var>)</code><a class="copiable-link" href='#index-get-22'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-get-23"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">field</var> =</code> <strong class="def-name">get</strong> <code class="def-code-arguments">(<var class="var">tcpclient</var>, <var class="var">property</var>)</code><a class="copiable-link" href='#index-get-23'> ¶</a></span></dt>
<dd><p>Get the properties of tcpclient object.
</p>
<h4 class="subsubheading" id="Inputs-98">Inputs</h4>
<p><var class="var">tcpclient</var> - instance of <var class="var">octave_tcpclient</var> class.<br>
<var class="var">property</var> - name of property.<br>
</p>
<h4 class="subsubheading" id="Outputs-98">Outputs</h4>
<p>When <var class="var">property</var> was specified, return the value of that property.<br>
otherwise return the values of all properties as a structure.<br>
</p>
<p><strong class="strong">See also:</strong> @octave_tcpclient/set.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005ftcpclient_002fread">
<h4 class="subsection">3.11.4 @octave_tcpclient/read</h4>
<a class="index-entry-id" id="index-read-4"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-read-19"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-read-19'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-read-20"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>)</code><a class="copiable-link" href='#index-read-20'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-read-21"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>, <var class="var">datatype</var>)</code><a class="copiable-link" href='#index-read-21'> ¶</a></span></dt>
<dd><p>Reads <var class="var">data</var> from TCP instrument
</p>
<h4 class="subsubheading" id="Inputs-99">Inputs</h4>
<p><var class="var">obj</var> is a TCP object.<br>
<var class="var">size</var> Number of values to read. (Default: NumBytesAvailable).<br>
<var class="var">datatype</var> datatype of data.<br>
</p>
<h4 class="subsubheading" id="Outputs-99">Outputs</h4>
<p><var class="var">data</var> data read.<br>
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005ftcpclient_002fset">
<h4 class="subsection">3.11.5 @octave_tcpclient/set</h4>
<a class="index-entry-id" id="index-set-6"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-_0028obj_002c-12"><span class="category-def">Function File: </span><span><code class="def-type">set</code> <strong class="def-name">(<var class="var">obj</var>,</strong> <code class="def-code-arguments"><var class="var">property</var>,<var class="var">value</var>)</code><a class="copiable-link" href='#index-_0028obj_002c-12'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-_0028obj_002c-13"><span class="category-def">Function File: </span><span><code class="def-type">set</code> <strong class="def-name">(<var class="var">obj</var>,</strong> <code class="def-code-arguments"><var class="var">property</var>,<var class="var">value</var>,…)</code><a class="copiable-link" href='#index-_0028obj_002c-13'> ¶</a></span></dt>
<dd><p>Set the properties of tcpclient object.
</p>
<h4 class="subsubheading" id="Inputs-100">Inputs</h4>
<p>If <var class="var">property</var> is a cell so must be <var class="var">value</var>, it sets the values of
all matching properties.
</p>
<p>The function also accepts property-value pairs.
</p>
<h4 class="subsubheading" id="Properties-14">Properties</h4>
<dl class="table">
<dt><var class="var">’Name’</var></dt>
<dd><p>Set the name for the tcpclient socket.
</p>
</dd>
<dt><var class="var">’UserData’</var></dt>
<dd><p>Set user data for the tcpclient socket.
</p>
</dd>
<dt><var class="var">’Timeout’</var></dt>
<dd><p>Set the timeout value in seconds. Value of -1 means a
blocking call.
</p>
</dd>
</dl>
<h4 class="subsubheading" id="Outputs-100">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> @octave_tcpclient/get.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005ftcpclient_002fwrite">
<h4 class="subsection">3.11.6 @octave_tcpclient/write</h4>
<a class="index-entry-id" id="index-write-4"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-write-13"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">write</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-write-13'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-write-14"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">write</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>, <var class="var">datatype</var>)</code><a class="copiable-link" href='#index-write-14'> ¶</a></span></dt>
<dd><p>Writes <var class="var">data</var> to TCP instrument
</p>
<h4 class="subsubheading" id="Inputs-101">Inputs</h4>
<p><var class="var">obj</var> is a TCPclient object.<br>
<var class="var">data</var> data to write.<br>
<var class="var">datatype</var> datatype of data. If not specified, it defaults to "uint8".<br>
</p>
<h4 class="subsubheading" id="Outputs-101">Outputs</h4>
<p>returns number of bytes written.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="tcpclient">
<h4 class="subsection">3.11.7 tcpclient</h4>
<a class="index-entry-id" id="index-tcpclient"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-tcpclient-1"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">tcpclient</var> =</code> <strong class="def-name">tcpclient</strong> <code class="def-code-arguments">(<var class="var">ipaddress</var>, <var class="var">port</var>)</code><a class="copiable-link" href='#index-tcpclient-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-tcpclient-2"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">tcpclient</var> =</code> <strong class="def-name">tcpclient</strong> <code class="def-code-arguments">(<var class="var">ipaddress</var>, <var class="var">port</var>, [<var class="var">propertyname</var>, <var class="var">propertyvalue</var>])</code><a class="copiable-link" href='#index-tcpclient-2'> ¶</a></span></dt>
<dd>
<p>Open tcpclient interface.
</p>
<h4 class="subsubheading" id="Inputs-102">Inputs</h4>
<p><var class="var">ipaddress</var> - the ip address of type String.<br>
<var class="var">port</var> - the port number to connect.<br>
<var class="var">propname</var>,<var class="var">propvalue</var> - property name/value pairs.
</p>
<p>Known input properties:
</p><dl class="table">
<dt>Name</dt>
<dd><p>name value
</p></dd>
<dt>Timeout</dt>
<dd><p>Numeric timeout value or -1 to wait forever
</p></dd>
<dt>UserData</dt>
<dd><p>User data value.
</p></dd>
</dl>
<h4 class="subsubheading" id="Outputs-102">Outputs</h4>
<p>The tcpclient() shall return instance of <var class="var">octave_tcpclient</var> class as the result <var class="var">tcpclient</var>.
</p>
<h4 class="subsubheading" id="Properties-15">Properties</h4>
<p>The tcpclient object has the following public properties:
</p><dl class="table">
<dt>Name</dt>
<dd><p>name assigned to the tcpclient object
</p></dd>
<dt>Type</dt>
<dd><p>instrument type ’tcpclient’ (readonly)
</p></dd>
<dt>Port</dt>
<dd><p>remote port number (Readonly)
</p></dd>
<dt>Address</dt>
<dd><p>remote host address (Readonly)
</p></dd>
<dt>Status</dt>
<dd><p>status of the object ’open’ or ’closed’ (readonly)
</p></dd>
<dt>Timeout</dt>
<dd><p>timeout value in seconds used for waiting for data
</p></dd>
<dt>NumBytesAvailable</dt>
<dd><p>number of bytes currently available to read (readonly)
</p></dd>
<dt>NumBytesWritten</dt>
<dd><p>number of bytes currently available to read (readonly)
</p></dd>
<dt>ByteOrder</dt>
<dd><p>Byte order for data (currently not used)
</p></dd>
<dt>Terminator</dt>
<dd><p>Terminator value used for string data (currently not used)
</p></dd>
<dt>UserData</dt>
<dd><p>User data
</p></dd>
</dl>
</dd></dl>
<hr>
</div>
</div>
<div class="section-level-extent" id="TCP-Server">
<div class="nav-panel">
<p>
Next: <a href="#UDP-_0028Deprecated_0029" accesskey="n" rel="next">UDP (Deprecated)</a>, Previous: <a href="#TCP-Client" accesskey="p" rel="prev">TCP Client</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="TCP-Server-1">3.12 TCP Server</h3>
<a class="index-entry-id" id="index-TCP-Server"></a>
<ul class="mini-toc">
<li><a href="#g_t_0040octave_005ftcpserver_002fconfigureTerminator" accesskey="1">@octave_tcpserver/configureTerminator</a></li>
<li><a href="#g_t_0040octave_005ftcpserver_002fflush" accesskey="2">@octave_tcpserver/flush</a></li>
<li><a href="#g_t_0040octave_005ftcpserver_002fget" accesskey="3">@octave_tcpserver/get</a></li>
<li><a href="#g_t_0040octave_005ftcpserver_002fread" accesskey="4">@octave_tcpserver/read</a></li>
<li><a href="#g_t_0040octave_005ftcpserver_002fset" accesskey="5">@octave_tcpserver/set</a></li>
<li><a href="#g_t_0040octave_005ftcpserver_002fwrite" accesskey="6">@octave_tcpserver/write</a></li>
<li><a href="#tcpserver" accesskey="7">tcpserver</a></li>
</ul>
<div class="subsection-level-extent" id="g_t_0040octave_005ftcpserver_002fconfigureTerminator">
<h4 class="subsection">3.12.1 @octave_tcpserver/configureTerminator</h4>
<a class="index-entry-id" id="index-configureTerminator-2"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-configureTerminator-8"><span class="category-def">Function File: </span><span><strong class="def-name">configureTerminator</strong> <code class="def-code-arguments">(<var class="var">tcp</var>, <var class="var">term</var>)</code><a class="copiable-link" href='#index-configureTerminator-8'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-configureTerminator-9"><span class="category-def">Function File: </span><span><strong class="def-name">configureTerminator</strong> <code class="def-code-arguments">(<var class="var">tcp</var>, <var class="var">readterm</var>, <var class="var">writeterm</var>)</code><a class="copiable-link" href='#index-configureTerminator-9'> ¶</a></span></dt>
<dd><p>Set terminator on a tcpserver object for ASCII string manipulation
</p>
<h4 class="subsubheading" id="Inputs-103">Inputs</h4>
<p><var class="var">tcp</var> - tcpserver object<br>
<var class="var">term</var> - terminal value for both read and write<br>
<var class="var">readterm</var> = terminal value type for read data<br>
<var class="var">writeterm</var> = terminal value for written data<br>
</p>
<p>The terminal can be either strings "cr", "lf" (default), "lf/cr" or an integer between 0 to 255.
</p>
<h4 class="subsubheading" id="Outputs-103">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> tcpport.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005ftcpserver_002fflush">
<h4 class="subsection">3.12.2 @octave_tcpserver/flush</h4>
<a class="index-entry-id" id="index-flush-3"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-flush-15"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">flush</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-flush-15'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-flush-16"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">flush</strong> <code class="def-code-arguments">(<var class="var">dev</var>, "input")</code><a class="copiable-link" href='#index-flush-16'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-flush-17"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">flush</strong> <code class="def-code-arguments">(<var class="var">dev</var>, "output")</code><a class="copiable-link" href='#index-flush-17'> ¶</a></span></dt>
<dd><p>Flush the tcpserver socket buffers
</p>
<h4 class="subsubheading" id="Inputs-104">Inputs</h4>
<p><var class="var">dev</var> - connected tcpserver device
</p>
<p>If an additional parameter is provided of "input" or "output",
then only the input or output buffer will be flushed
</p>
<h4 class="subsubheading" id="Outputs-104">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> serialport.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005ftcpserver_002fget">
<h4 class="subsection">3.12.3 @octave_tcpserver/get</h4>
<a class="index-entry-id" id="index-get-7"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-get-24"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">struct</var> =</code> <strong class="def-name">get</strong> <code class="def-code-arguments">(<var class="var">tcpserver</var>)</code><a class="copiable-link" href='#index-get-24'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-get-25"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">field</var> =</code> <strong class="def-name">get</strong> <code class="def-code-arguments">(<var class="var">tcpserver</var>, <var class="var">property</var>)</code><a class="copiable-link" href='#index-get-25'> ¶</a></span></dt>
<dd><p>Get the properties of tcpserver object.
</p>
<h4 class="subsubheading" id="Inputs-105">Inputs</h4>
<p><var class="var">tcpserver</var> - instance of <var class="var">octave_tcpserver</var> class.<br>
<var class="var">property</var> - name of property.<br>
</p>
<h4 class="subsubheading" id="Outputs-105">Outputs</h4>
<p>When <var class="var">property</var> was specified, return the value of that property.<br>
otherwise return the values of all properties as a structure.<br>
</p>
<p><strong class="strong">See also:</strong> @octave_tcpserver/set.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005ftcpserver_002fread">
<h4 class="subsection">3.12.4 @octave_tcpserver/read</h4>
<a class="index-entry-id" id="index-read-5"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-read-22"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-read-22'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-read-23"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>)</code><a class="copiable-link" href='#index-read-23'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-read-24"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>, <var class="var">datatype</var>)</code><a class="copiable-link" href='#index-read-24'> ¶</a></span></dt>
<dd><p>Reads <var class="var">data</var> from TCP instrument
</p>
<h4 class="subsubheading" id="Inputs-106">Inputs</h4>
<p><var class="var">obj</var> is a TCP Server object.<br>
<var class="var">size</var> Number of values to read. (Default: NumBytesAvailable).<br>
<var class="var">datatype</var> datatype of data.<br>
</p>
<h4 class="subsubheading" id="Outputs-106">Outputs</h4>
<p><var class="var">data</var> data read.<br>
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005ftcpserver_002fset">
<h4 class="subsection">3.12.5 @octave_tcpserver/set</h4>
<a class="index-entry-id" id="index-set-7"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-_0028obj_002c-14"><span class="category-def">Function File: </span><span><code class="def-type">set</code> <strong class="def-name">(<var class="var">obj</var>,</strong> <code class="def-code-arguments"><var class="var">property</var>,<var class="var">value</var>)</code><a class="copiable-link" href='#index-_0028obj_002c-14'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-_0028obj_002c-15"><span class="category-def">Function File: </span><span><code class="def-type">set</code> <strong class="def-name">(<var class="var">obj</var>,</strong> <code class="def-code-arguments"><var class="var">property</var>,<var class="var">value</var>,…)</code><a class="copiable-link" href='#index-_0028obj_002c-15'> ¶</a></span></dt>
<dd><p>Set the properties of tcpserver object.
</p>
<h4 class="subsubheading" id="Inputs-107">Inputs</h4>
<p>If <var class="var">property</var> is a cell so must be <var class="var">value</var>, it sets the values of
all matching properties.
</p>
<p>The function also accepts property-value pairs.
</p>
<h4 class="subsubheading" id="Properties-16">Properties</h4>
<dl class="table">
<dt><var class="var">’Name’</var></dt>
<dd><p>Set the name for the tcpserver socket.
</p>
</dd>
<dt><var class="var">’UserData’</var></dt>
<dd><p>Set user data for the tcpserver socket.
</p>
</dd>
<dt><var class="var">’Timeout’</var></dt>
<dd><p>Set the timeout value in seconds. Value of -1 means a
blocking call.
</p>
</dd>
</dl>
<h4 class="subsubheading" id="Outputs-107">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> @octave_tcpserver/get.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005ftcpserver_002fwrite">
<h4 class="subsection">3.12.6 @octave_tcpserver/write</h4>
<a class="index-entry-id" id="index-write-5"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-write-15"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">write</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-write-15'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-write-16"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">write</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>, <var class="var">datatype</var>)</code><a class="copiable-link" href='#index-write-16'> ¶</a></span></dt>
<dd><p>Writes <var class="var">data</var> to TCP instrument
</p>
<h4 class="subsubheading" id="Inputs-108">Inputs</h4>
<p><var class="var">obj</var> is a TCPServer object.<br>
<var class="var">data</var> data to write.<br>
<var class="var">datatype</var> datatype of data. If not specified, it defaults to "uint8".<br>
</p>
<h4 class="subsubheading" id="Outputs-108">Outputs</h4>
<p>returns number of bytes written.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="tcpserver">
<h4 class="subsection">3.12.7 tcpserver</h4>
<a class="index-entry-id" id="index-tcpserver"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-tcpserver-1"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">tcpserver</var> =</code> <strong class="def-name">tcpserver</strong> <code class="def-code-arguments">(<var class="var">ipaddress</var>, <var class="var">port</var>)</code><a class="copiable-link" href='#index-tcpserver-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-tcpserver-2"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">tcpserver</var> =</code> <strong class="def-name">tcpserver</strong> <code class="def-code-arguments">(<var class="var">port</var>)</code><a class="copiable-link" href='#index-tcpserver-2'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-tcpserver-3"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">tcpserver</var> =</code> <strong class="def-name">tcpserver</strong> <code class="def-code-arguments">(…, [<var class="var">propertyname</var>, <var class="var">propertyvalue</var>])</code><a class="copiable-link" href='#index-tcpserver-3'> ¶</a></span></dt>
<dd>
<p>Open tcpserver interface.
</p>
<h4 class="subsubheading" id="Inputs-109">Inputs</h4>
<p><var class="var">ipaddress</var> - the ip address of type String.<br>
<var class="var">port</var> - the port number to bind.<br>
<var class="var">propname</var>,<var class="var">propvalue</var> - property name/value pairs.
</p>
<p>Known input properties:
</p><dl class="table">
<dt>Name</dt>
<dd><p>name value
</p></dd>
<dt>Timeout</dt>
<dd><p>Numeric timeout value or -1 to wait forever
</p></dd>
<dt>UserData</dt>
<dd><p>User data value.
</p></dd>
</dl>
<h4 class="subsubheading" id="Outputs-109">Outputs</h4>
<p>The tcpserver() shall return instance of <var class="var">octave_tcpserver</var> class as the result <var class="var">tcpserver</var>.
</p>
<h4 class="subsubheading" id="Properties-17">Properties</h4>
<p>The tcpserver object has the following public properties:
</p><dl class="table">
<dt>Connected</dt>
<dd><p>boolean flag for when connected to a client (Readonly)
</p></dd>
<dt>ClientPort</dt>
<dd><p>connected client port number (Readonly)
</p></dd>
<dt>ClientAddress</dt>
<dd><p>connected client address (Readonly)
</p></dd>
<dt>Name</dt>
<dd><p>name assigned to the tcpserver object
</p></dd>
<dt>Type</dt>
<dd><p>instrument type ’tcpserver’ (readonly)
</p></dd>
<dt>ServerPort</dt>
<dd><p>server port number (Readonly)
</p></dd>
<dt>ServerAddress</dt>
<dd><p>server address (Readonly)
</p></dd>
<dt>Status</dt>
<dd><p>status of the object ’open’ or ’closed’ (readonly)
</p></dd>
<dt>Timeout</dt>
<dd><p>timeout value in seconds used for waiting for data
</p></dd>
<dt>NumBytesAvailable</dt>
<dd><p>number of bytes currently available to read (readonly)
</p></dd>
<dt>NumBytesWritten</dt>
<dd><p>number of bytes currently available to read (readonly)
</p></dd>
<dt>ByteOrder</dt>
<dd><p>Byte order for data (currently not used)
</p></dd>
<dt>Terminator</dt>
<dd><p>Terminator value used for string data (currently not used)
</p></dd>
<dt>UserData</dt>
<dd><p>User data
</p></dd>
</dl>
</dd></dl>
<hr>
</div>
</div>
<div class="section-level-extent" id="UDP-_0028Deprecated_0029">
<div class="nav-panel">
<p>
Next: <a href="#UDP-Port" accesskey="n" rel="next">UDP Port</a>, Previous: <a href="#TCP-Server" accesskey="p" rel="prev">TCP Server</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="UDP-_0028Deprecated_0029-1">3.13 UDP (Deprecated)</h3>
<a class="index-entry-id" id="index-UDP-_0028Deprecated_0029"></a>
<ul class="mini-toc">
<li><a href="#g_t_0040octave_005fudp_002ffclose" accesskey="1">@octave_udp/fclose</a></li>
<li><a href="#g_t_0040octave_005fudp_002fflush" accesskey="2">@octave_udp/flush</a></li>
<li><a href="#g_t_0040octave_005fudp_002fflushinput" accesskey="3">@octave_udp/flushinput</a></li>
<li><a href="#g_t_0040octave_005fudp_002fflushoutput" accesskey="4">@octave_udp/flushoutput</a></li>
<li><a href="#g_t_0040octave_005fudp_002ffopen" accesskey="5">@octave_udp/fopen</a></li>
<li><a href="#g_t_0040octave_005fudp_002ffprintf" accesskey="6">@octave_udp/fprintf</a></li>
<li><a href="#g_t_0040octave_005fudp_002ffread" accesskey="7">@octave_udp/fread</a></li>
<li><a href="#g_t_0040octave_005fudp_002ffwrite" accesskey="8">@octave_udp/fwrite</a></li>
<li><a href="#g_t_0040octave_005fudp_002fget" accesskey="9">@octave_udp/get</a></li>
<li><a href="#g_t_0040octave_005fudp_002fread">@octave_udp/read</a></li>
<li><a href="#g_t_0040octave_005fudp_002fset">@octave_udp/set</a></li>
<li><a href="#g_t_0040octave_005fudp_002fwrite">@octave_udp/write</a></li>
<li><a href="#udp">udp</a></li>
<li><a href="#udp_005fclose">udp_close</a></li>
<li><a href="#udp_005fdemo">udp_demo</a></li>
<li><a href="#udp_005fread">udp_read</a></li>
<li><a href="#udp_005ftimeout">udp_timeout</a></li>
<li><a href="#udp_005fwrite">udp_write</a></li>
</ul>
<div class="subsection-level-extent" id="g_t_0040octave_005fudp_002ffclose">
<h4 class="subsection">3.13.1 @octave_udp/fclose</h4>
<a class="index-entry-id" id="index-fclose-6"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fclose-15"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">res</var> =</code> <strong class="def-name">fclose</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-fclose-15'> ¶</a></span></dt>
<dd><p>Closes UDP connection <var class="var">obj</var>
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fudp_002fflush">
<h4 class="subsection">3.13.2 @octave_udp/flush</h4>
<a class="index-entry-id" id="index-flush-4"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-flush-18"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">flush</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-flush-18'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-flush-19"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">flush</strong> <code class="def-code-arguments">(<var class="var">dev</var>, "input")</code><a class="copiable-link" href='#index-flush-19'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-flush-20"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">flush</strong> <code class="def-code-arguments">(<var class="var">dev</var>, "output")</code><a class="copiable-link" href='#index-flush-20'> ¶</a></span></dt>
<dd><p>Flush the udp socket buffers
</p>
<h4 class="subsubheading" id="Inputs-110">Inputs</h4>
<p><var class="var">dev</var> - open udp device
</p>
<p>If an additional parameter is provided of "input" or "output",
then only the input or output buffer will be flushed
</p>
<h4 class="subsubheading" id="Outputs-110">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> udp.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fudp_002fflushinput">
<h4 class="subsection">3.13.3 @octave_udp/flushinput</h4>
<a class="index-entry-id" id="index-flushinput-3"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-flushinput-7"><span class="category-def">Loadable Function: </span><span><strong class="def-name">flushinput</strong> <code class="def-code-arguments">(<var class="var">udp</var>)</code><a class="copiable-link" href='#index-flushinput-7'> ¶</a></span></dt>
<dd>
<p>Flush the pending input, which will also make the BytesAvailable property be 0.
</p>
<h4 class="subsubheading" id="Inputs-111">Inputs</h4>
<p><var class="var">udp</var> - instance of <var class="var">octave_udp</var> class.
</p>
<h4 class="subsubheading" id="Outputs-111">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> flushoutput.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fudp_002fflushoutput">
<h4 class="subsection">3.13.4 @octave_udp/flushoutput</h4>
<a class="index-entry-id" id="index-flushoutput-3"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-flushoutput-7"><span class="category-def">Loadable Function: </span><span><strong class="def-name">flushoutput</strong> <code class="def-code-arguments">(<var class="var">udp</var>)</code><a class="copiable-link" href='#index-flushoutput-7'> ¶</a></span></dt>
<dd>
<p>Flush the output buffer.
</p>
<h4 class="subsubheading" id="Inputs-112">Inputs</h4>
<p><var class="var">udp</var> - instance of <var class="var">octave_udp</var> class.
</p>
<h4 class="subsubheading" id="Outputs-112">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> flushinput.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fudp_002ffopen">
<h4 class="subsection">3.13.5 @octave_udp/fopen</h4>
<a class="index-entry-id" id="index-fopen-6"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fopen-15"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">res</var> =</code> <strong class="def-name">fopen</strong> <code class="def-code-arguments">(<var class="var">obj</var>) (dummy)</code><a class="copiable-link" href='#index-fopen-15'> ¶</a></span></dt>
<dd><p>Opens UDP connection <var class="var">obj</var>
This currently is a dummy function to improve compatibility to MATLAB
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fudp_002ffprintf">
<h4 class="subsection">3.13.6 @octave_udp/fprintf</h4>
<a class="index-entry-id" id="index-fprintf-4"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fprintf-13"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">fprintf</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">template</var> ...)</code><a class="copiable-link" href='#index-fprintf-13'> ¶</a></span></dt>
<dd><p>Writes formatted string <var class="var">template</var> using optional parameters to
UDP instrument
</p>
<h4 class="subsubheading" id="Inputs-113">Inputs</h4>
<p><var class="var">obj</var> is a UDP object.<br>
<var class="var">template</var> Format template string.<br>
</p>
<h4 class="subsubheading" id="Outputs-113">Outputs</h4>
<p><var class="var">numbytes</var> is the number of bytes written to the device
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fudp_002ffread">
<h4 class="subsection">3.13.7 @octave_udp/fread</h4>
<a class="index-entry-id" id="index-fread-7"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fread-46"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-fread-46'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-47"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>)</code><a class="copiable-link" href='#index-fread-47'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-48"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-fread-48'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-49"><span class="category-def">Function File: </span><span><code class="def-type">[<var class="var">data</var>,<var class="var">count</var>] =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, ...)</code><a class="copiable-link" href='#index-fread-49'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-50"><span class="category-def">Function File: </span><span><code class="def-type">[<var class="var">data</var>,<var class="var">count</var>,<var class="var">errmsg</var>] =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, ...)</code><a class="copiable-link" href='#index-fread-50'> ¶</a></span></dt>
<dd><p>Reads <var class="var">data</var> from UDP instrument
</p>
<h4 class="subsubheading" id="Inputs-114">Inputs</h4>
<p><var class="var">obj</var> is a UDP object.<br>
<var class="var">size</var> Number of values to read. (Default: 100).<br>
<var class="var">precision</var> precision of data.<br>
</p>
<h4 class="subsubheading" id="Outputs-114">Outputs</h4>
<p><var class="var">data</var> data values.<br>
<var class="var">count</var> number of values read.<br>
<var class="var">errmsg</var> read operation error message.<br>
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fudp_002ffwrite">
<h4 class="subsection">3.13.8 @octave_udp/fwrite</h4>
<a class="index-entry-id" id="index-fwrite-7"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fwrite-28"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">fwrite</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-fwrite-28'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fwrite-29"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">fwrite</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-fwrite-29'> ¶</a></span></dt>
<dd><p>Writes <var class="var">data</var> to UDP instrument
</p>
<h4 class="subsubheading" id="Inputs-115">Inputs</h4>
<p><var class="var">obj</var> is a UDP object.<br>
<var class="var">data</var> data to write.<br>
<var class="var">precision</var> precision of data.<br>
</p>
<h4 class="subsubheading" id="Outputs-115">Outputs</h4>
<p>returns number of bytes written.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fudp_002fget">
<h4 class="subsection">3.13.9 @octave_udp/get</h4>
<a class="index-entry-id" id="index-get-8"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-get-26"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">struct</var> =</code> <strong class="def-name">get</strong> <code class="def-code-arguments">(<var class="var">udp</var>)</code><a class="copiable-link" href='#index-get-26'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-get-27"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">field</var> =</code> <strong class="def-name">get</strong> <code class="def-code-arguments">(<var class="var">udp</var>, <var class="var">property</var>)</code><a class="copiable-link" href='#index-get-27'> ¶</a></span></dt>
<dd><p>Get the properties of udp object.
</p>
<h4 class="subsubheading" id="Inputs-116">Inputs</h4>
<p><var class="var">udp</var> - instance of <var class="var">octave_udp</var> class.<br>
</p>
<p><var class="var">property</var> - name of property.<br>
</p>
<h4 class="subsubheading" id="Outputs-116">Outputs</h4>
<p>When <var class="var">property</var> was specified, return the value of that property.<br>
otherwise return the values of all properties as a structure.<br>
</p>
<p><strong class="strong">See also:</strong> @octave_udp/set.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fudp_002fread">
<h4 class="subsection">3.13.10 @octave_udp/read</h4>
<a class="index-entry-id" id="index-read-6"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-read-25"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-read-25'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-read-26"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>)</code><a class="copiable-link" href='#index-read-26'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-read-27"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>, <var class="var">datatype</var>)</code><a class="copiable-link" href='#index-read-27'> ¶</a></span></dt>
<dd><p>Reads <var class="var">data</var> from UDP instrument
</p>
<h4 class="subsubheading" id="Inputs-117">Inputs</h4>
<p><var class="var">obj</var> is a UDP object.<br>
<var class="var">size</var> Number of values to read. (Default: BytesAvailable).<br>
<var class="var">datatype</var> datatype of data.<br>
</p>
<h4 class="subsubheading" id="Outputs-117">Outputs</h4>
<p><var class="var">data</var> data read.<br>
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fudp_002fset">
<h4 class="subsection">3.13.11 @octave_udp/set</h4>
<a class="index-entry-id" id="index-set-8"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-_0028obj_002c-16"><span class="category-def">Function File: </span><span><code class="def-type">set</code> <strong class="def-name">(<var class="var">obj</var>,</strong> <code class="def-code-arguments"><var class="var">property</var>,<var class="var">value</var>)</code><a class="copiable-link" href='#index-_0028obj_002c-16'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-_0028obj_002c-17"><span class="category-def">Function File: </span><span><code class="def-type">set</code> <strong class="def-name">(<var class="var">obj</var>,</strong> <code class="def-code-arguments"><var class="var">property</var>,<var class="var">value</var>,…)</code><a class="copiable-link" href='#index-_0028obj_002c-17'> ¶</a></span></dt>
<dd><p>Set the properties of udp object.
</p>
<h4 class="subsubheading" id="Inputs-118">Inputs</h4>
<p><var class="var">obj</var> - instance of <var class="var">octave_udp</var> class.<br>
<var class="var">property</var> - name of property.<br>
</p>
<p>If <var class="var">property</var> is a cell so must be <var class="var">value</var>, it sets the values of
all matching properties.
</p>
<p>The function also accepts property-value pairs.
</p>
<h4 class="subsubheading" id="Properties-18">Properties</h4>
<dl class="table">
<dt><var class="var">’name’</var></dt>
<dd><p>Set the name for the udp socket.
</p>
</dd>
<dt><var class="var">’remotehost’</var></dt>
<dd><p>Set the remote host name for the udp socket.
</p>
</dd>
<dt><var class="var">’remoteport’</var></dt>
<dd><p>Set the remote port for the udp socket.
</p>
</dd>
<dt><var class="var">’timeout’</var></dt>
<dd><p>Set the timeout value in seconds. Value of -1 means a
blocking call.
</p>
</dd>
</dl>
<h4 class="subsubheading" id="Outputs-118">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> @octave_udp/get.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fudp_002fwrite">
<h4 class="subsection">3.13.12 @octave_udp/write</h4>
<a class="index-entry-id" id="index-write-6"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-write-17"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">write</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-write-17'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-write-18"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">write</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>, <var class="var">destinationAddress</var>, <var class="var">destinationPort</var>))</code><a class="copiable-link" href='#index-write-18'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-write-19"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">write</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>, <var class="var">datatype</var>)</code><a class="copiable-link" href='#index-write-19'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-write-20"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">write</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>, <var class="var">datatype</var>, <var class="var">destinationAddress</var>, <var class="var">destinationPort</var>)</code><a class="copiable-link" href='#index-write-20'> ¶</a></span></dt>
<dd><p>Writes <var class="var">data</var> to UDP instrument
</p>
<h4 class="subsubheading" id="Inputs-119">Inputs</h4>
<p><var class="var">obj</var> is a UDP object.<br>
<var class="var">data</var> data to write.<br>
<var class="var">datatype</var> datatype of data. If not specified defaults to uint8.<br>
<var class="var">destinationAddress</var> ipaddress to send to. If not specified, use the remote address.<br>
<var class="var">destinationPort</var> port to send to. If not specified, use the remote port.<br>
</p>
<h4 class="subsubheading" id="Outputs-119">Outputs</h4>
<p>returns number of bytes written.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="udp">
<h4 class="subsection">3.13.13 udp</h4>
<a class="index-entry-id" id="index-udp"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-udp-1"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">udp</var> =</code> <strong class="def-name">udp</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href='#index-udp-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-udp-2"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">udp</var> =</code> <strong class="def-name">udp</strong> <code class="def-code-arguments">(<var class="var">remoteipaddress</var>, <var class="var">remoteport</var>)</code><a class="copiable-link" href='#index-udp-2'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-udp-3"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">udp</var> =</code> <strong class="def-name">udp</strong> <code class="def-code-arguments">(<var class="var">remoteipaddress</var>, <var class="var">remoteport</var>, [<var class="var">propertyname</var>, <var class="var">propertyvalue</var> ...])</code><a class="copiable-link" href='#index-udp-3'> ¶</a></span></dt>
<dd>
<p>Open udp interface.
</p>
<h4 class="subsubheading" id="Inputs-120">Inputs</h4>
<p><var class="var">remoteipaddress</var> - the ip address of type String. If omitted defaults to ’127.0.0.1’.<br>
<var class="var">remoteport</var> - the port number to connect. If omitted defaults to 23.<br>
<var class="var">localport</var> - the local port number to bind. If omitted defaults to 0<br>
<var class="var">propertyname</var>, <var class="var">propertyvalue</var> - property name/value pair
</p>
<h4 class="subsubheading" id="Outputs-120">Outputs</h4>
<p>The udp() shall return instance of <var class="var">octave_udp</var> class as the result <var class="var">udp</var>.
</p>
<h4 class="subsubheading" id="Properties-19">Properties</h4>
<p>The udp object has the following public properties:
</p><dl class="table">
<dt>name</dt>
<dd><p>name assigned to the udp object
</p></dd>
<dt>type</dt>
<dd><p>instrument type ’udp’ (readonly)
</p></dd>
<dt>localport</dt>
<dd><p>local port number (readonly)
</p></dd>
<dt>localhost</dt>
<dd><p>local host address (readonly)
</p></dd>
<dt>remoteport</dt>
<dd><p>remote port number
</p></dd>
<dt>remotehost</dt>
<dd><p>remote host
</p></dd>
<dt>status</dt>
<dd><p>status of the object ’open’ or ’closed’ (readonly)
</p></dd>
<dt>timeout</dt>
<dd><p>timeout value in seconds used for waiting for data
</p></dd>
<dt>bytesavailable</dt>
<dd><p>number of bytes currently available to read (readonly)
</p></dd>
</dl>
</dd></dl>
</div>
<div class="subsection-level-extent" id="udp_005fclose">
<h4 class="subsection">3.13.14 udp_close</h4>
<a class="index-entry-id" id="index-udp_005fclose"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-udp_005fclose-1"><span class="category-def">Loadable Function: </span><span><strong class="def-name">udp_close</strong> <code class="def-code-arguments">(<var class="var">udp</var>)</code><a class="copiable-link" href='#index-udp_005fclose-1'> ¶</a></span></dt>
<dd>
<p>Close the interface and release a file descriptor.
</p>
<h4 class="subsubheading" id="Inputs-121">Inputs</h4>
<p><var class="var">udp</var> - instance of <var class="var">octave_udp</var> class.
</p>
<h4 class="subsubheading" id="Inputs-122">Inputs</h4>
<p>None
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="udp_005fdemo">
<h4 class="subsection">3.13.15 udp_demo</h4>
<a class="index-entry-id" id="index-udp_005fdemo"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-udp_005fdemo-1"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">result</var> =</code> <strong class="def-name">udp_demo</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href='#index-udp_005fdemo-1'> ¶</a></span></dt>
<dd><p>Run test SNTP demonstration for udp class
</p>
<p><strong class="strong">See also:</strong> udp.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="udp_005fread">
<h4 class="subsection">3.13.16 udp_read</h4>
<a class="index-entry-id" id="index-udp_005fread"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-udp_005fread-1"><span class="category-def">Loadable Function: </span><span><code class="def-type">[<var class="var">data</var>, <var class="var">count</var>] =</code> <strong class="def-name">udp_read</strong> <code class="def-code-arguments">(<var class="var">udp</var>, <var class="var">n</var>, <var class="var">timeout</var>)</code><a class="copiable-link" href='#index-udp_005fread-1'> ¶</a></span></dt>
<dd>
<p>Read from udp interface.
</p>
<h4 class="subsubheading" id="Inputs-123">Inputs</h4>
<p><var class="var">udp</var> - instance of <var class="var">octave_udp</var> class.<br>
<var class="var">n</var> - number of bytes to attempt to read of type Integer<br>
<var class="var">timeout</var> - timeout in ms if different from default of type Integer
</p>
<h4 class="subsubheading" id="Outputs-121">Outputs</h4>
<p>The udp_read() shall return number of bytes successfully read in <var class="var">count</var> as Integer and the bytes themselves in <var class="var">data</var> as uint8 array.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="udp_005ftimeout">
<h4 class="subsection">3.13.17 udp_timeout</h4>
<a class="index-entry-id" id="index-udp_005ftimeout"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-udp_005ftimeout-1"><span class="category-def">Loadable Function: </span><span><strong class="def-name">udp_timeout</strong> <code class="def-code-arguments">(<var class="var">udp</var>, <var class="var">timeout</var>)</code><a class="copiable-link" href='#index-udp_005ftimeout-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-udp_005ftimeout-2"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">t</var> =</code> <strong class="def-name">udp_timeout</strong> <code class="def-code-arguments">(<var class="var">udp</var>)</code><a class="copiable-link" href='#index-udp_005ftimeout-2'> ¶</a></span></dt>
<dd>
<p>Set new or get existing udp interface timeout parameter used for udp_read() requests. The timeout value is specified in milliseconds.
</p>
<h4 class="subsubheading" id="Inputs-124">Inputs</h4>
<p><var class="var">udp</var> - instance of <var class="var">octave_udp</var> class.<br>
<var class="var">timeout</var> - udp_read() timeout value in milliseconds. Value of -1 means a blocking call.
</p>
<h4 class="subsubheading" id="Outputs-122">Outputs</h4>
<p>If <var class="var">timeout</var> parameter is omitted, the udp_timeout() shall return current timeout value as the result <var class="var">t</var>.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="udp_005fwrite">
<h4 class="subsection">3.13.18 udp_write</h4>
<a class="index-entry-id" id="index-udp_005fwrite"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-udp_005fwrite-1"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">n</var> =</code> <strong class="def-name">udp_write</strong> <code class="def-code-arguments">(<var class="var">udp</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-udp_005fwrite-1'> ¶</a></span></dt>
<dd>
<p>Write data to a udp interface.
</p>
<h4 class="subsubheading" id="Inputs-125">Inputs</h4>
<p><var class="var">udp</var> - instance of <var class="var">octave_udp</var> class.<br>
<var class="var">data</var> - data to be written to the udp interface. Can be either of String or uint8 type.
</p>
<h4 class="subsubheading" id="Outputs-123">Outputs</h4>
<p>Upon successful completion, udp_write() shall return the number of bytes written as the result <var class="var">n</var>.
</p></dd></dl>
<hr>
</div>
</div>
<div class="section-level-extent" id="UDP-Port">
<div class="nav-panel">
<p>
Next: <a href="#USBTMC" accesskey="n" rel="next">USBTMC</a>, Previous: <a href="#UDP-_0028Deprecated_0029" accesskey="p" rel="prev">UDP (Deprecated)</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="UDP-Port-2">3.14 UDP Port</h3>
<a class="index-entry-id" id="index-UDP-Port"></a>
<ul class="mini-toc">
<li><a href="#g_t_0040octave_005fudpport_002fconfigureMulticast" accesskey="1">@octave_udpport/configureMulticast</a></li>
<li><a href="#g_t_0040octave_005fudpport_002fconfigureTerminator" accesskey="2">@octave_udpport/configureTerminator</a></li>
<li><a href="#g_t_0040octave_005fudpport_002fflush" accesskey="3">@octave_udpport/flush</a></li>
<li><a href="#g_t_0040octave_005fudpport_002ffprintf" accesskey="4">@octave_udpport/fprintf</a></li>
<li><a href="#g_t_0040octave_005fudpport_002ffread" accesskey="5">@octave_udpport/fread</a></li>
<li><a href="#g_t_0040octave_005fudpport_002ffwrite" accesskey="6">@octave_udpport/fwrite</a></li>
<li><a href="#g_t_0040octave_005fudpport_002fget" accesskey="7">@octave_udpport/get</a></li>
<li><a href="#g_t_0040octave_005fudpport_002fread" accesskey="8">@octave_udpport/read</a></li>
<li><a href="#g_t_0040octave_005fudpport_002fset" accesskey="9">@octave_udpport/set</a></li>
<li><a href="#g_t_0040octave_005fudpport_002fwrite">@octave_udpport/write</a></li>
<li><a href="#g_t_0040octave_005fudpport_002fwriteline">@octave_udpport/writeline</a></li>
<li><a href="#udpport">udpport</a></li>
</ul>
<div class="subsection-level-extent" id="g_t_0040octave_005fudpport_002fconfigureMulticast">
<h4 class="subsection">3.14.1 @octave_udpport/configureMulticast</h4>
<a class="index-entry-id" id="index-configureMulticast"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-configureMulticast_0028_0028dev_002c"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">configureMulticast((<var class="var">dev</var>,</strong> <code class="def-code-arguments"><var class="var">address</var>)</code><a class="copiable-link" href='#index-configureMulticast_0028_0028dev_002c'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-configureMulticast_0028_0028dev_002c-1"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">configureMulticast((<var class="var">dev</var>,</strong> <code class="def-code-arguments"><var class="var">"off"</var>)</code><a class="copiable-link" href='#index-configureMulticast_0028_0028dev_002c-1'> ¶</a></span></dt>
<dd><p>Configure udpport device to receive multicast data
</p>
<h4 class="subsubheading" id="Inputs-126">Inputs</h4>
<p><var class="var">dev</var> - open udpport device
</p>
<p>If <var class="var">address</var> is ’off’ disable udp multicast. Otherwise it is the multicast address to use.
</p>
<h4 class="subsubheading" id="Outputs-124">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> udpport.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fudpport_002fconfigureTerminator">
<h4 class="subsection">3.14.2 @octave_udpport/configureTerminator</h4>
<a class="index-entry-id" id="index-configureTerminator-3"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-configureTerminator-10"><span class="category-def">Function File: </span><span><strong class="def-name">configureTerminator</strong> <code class="def-code-arguments">(<var class="var">udp</var>, <var class="var">term</var>)</code><a class="copiable-link" href='#index-configureTerminator-10'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-configureTerminator-11"><span class="category-def">Function File: </span><span><strong class="def-name">configureTerminator</strong> <code class="def-code-arguments">(<var class="var">udp</var>, <var class="var">readterm</var>, <var class="var">writeterm</var>)</code><a class="copiable-link" href='#index-configureTerminator-11'> ¶</a></span></dt>
<dd><p>Set terminator for ASCII string manipulation
</p>
<h4 class="subsubheading" id="Inputs-127">Inputs</h4>
<p><var class="var">udp</var> - udpport object<br>
<var class="var">term</var> - terminal value for both read and write<br>
<var class="var">readterm</var> = terminal value type for read data<br>
<var class="var">writeterm</var> = terminal value for written data<br>
</p>
<p>The terminal can be either strings "cr", "lf" (default), "lf/cr" or an integer between 0 to 255.
</p>
<h4 class="subsubheading" id="Outputs-125">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> udpport.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fudpport_002fflush">
<h4 class="subsection">3.14.3 @octave_udpport/flush</h4>
<a class="index-entry-id" id="index-flush-5"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-flush-21"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">flush</strong> <code class="def-code-arguments">(<var class="var">dev</var>)</code><a class="copiable-link" href='#index-flush-21'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-flush-22"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">flush</strong> <code class="def-code-arguments">(<var class="var">dev</var>, "input")</code><a class="copiable-link" href='#index-flush-22'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-flush-23"><span class="category-def">: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">flush</strong> <code class="def-code-arguments">(<var class="var">dev</var>, "output")</code><a class="copiable-link" href='#index-flush-23'> ¶</a></span></dt>
<dd><p>Flush the udpport socket buffers
</p>
<h4 class="subsubheading" id="Inputs-128">Inputs</h4>
<p><var class="var">dev</var> - open udpport device
</p>
<p>If an additional parameter is provided of "input" or "output",
then only the input or output buffer will be flushed
</p>
<h4 class="subsubheading" id="Outputs-126">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> udpport.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fudpport_002ffprintf">
<h4 class="subsection">3.14.4 @octave_udpport/fprintf</h4>
<a class="index-entry-id" id="index-fprintf-5"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fprintf-14"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">fprintf</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">template</var> ...)</code><a class="copiable-link" href='#index-fprintf-14'> ¶</a></span></dt>
<dd><p>Writes formatted string <var class="var">template</var> using optional parameters to
UDP instrument
</p>
<h4 class="subsubheading" id="Inputs-129">Inputs</h4>
<p><var class="var">obj</var> is a UDPPort object.<br>
<var class="var">template</var> Format template string.<br>
</p>
<h4 class="subsubheading" id="Outputs-127">Outputs</h4>
<p><var class="var">numbytes</var> is the number of bytes written to the device
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fudpport_002ffread">
<h4 class="subsection">3.14.5 @octave_udpport/fread</h4>
<a class="index-entry-id" id="index-fread-8"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fread-51"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-fread-51'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-52"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>)</code><a class="copiable-link" href='#index-fread-52'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-53"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-fread-53'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-54"><span class="category-def">Function File: </span><span><code class="def-type">[<var class="var">data</var>,<var class="var">count</var>] =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, ...)</code><a class="copiable-link" href='#index-fread-54'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-55"><span class="category-def">Function File: </span><span><code class="def-type">[<var class="var">data</var>,<var class="var">count</var>,<var class="var">errmsg</var>] =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, ...)</code><a class="copiable-link" href='#index-fread-55'> ¶</a></span></dt>
<dd><p>Reads <var class="var">data</var> from UDP instrument
</p>
<h4 class="subsubheading" id="Inputs-130">Inputs</h4>
<p><var class="var">obj</var> is a UDP port object.<br>
<var class="var">size</var> Number of values to read. (Default: 100).<br>
<var class="var">precision</var> precision of data.<br>
</p>
<h4 class="subsubheading" id="Outputs-128">Outputs</h4>
<p><var class="var">data</var> data values.<br>
<var class="var">count</var> number of values read.<br>
<var class="var">errmsg</var> read operation error message.<br>
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fudpport_002ffwrite">
<h4 class="subsection">3.14.6 @octave_udpport/fwrite</h4>
<a class="index-entry-id" id="index-fwrite-8"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fwrite-30"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">fwrite</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-fwrite-30'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fwrite-31"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">fwrite</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-fwrite-31'> ¶</a></span></dt>
<dd><p>Writes <var class="var">data</var> to UDP instrument
</p>
<h4 class="subsubheading" id="Inputs-131">Inputs</h4>
<p><var class="var">obj</var> is a UDP port object.<br>
<var class="var">data</var> data to write.<br>
<var class="var">precision</var> precision of data.<br>
</p>
<h4 class="subsubheading" id="Outputs-129">Outputs</h4>
<p>returns number of bytes written.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fudpport_002fget">
<h4 class="subsection">3.14.7 @octave_udpport/get</h4>
<a class="index-entry-id" id="index-get-9"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-get-28"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">struct</var> =</code> <strong class="def-name">get</strong> <code class="def-code-arguments">(<var class="var">udpport</var>)</code><a class="copiable-link" href='#index-get-28'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-get-29"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">field</var> =</code> <strong class="def-name">get</strong> <code class="def-code-arguments">(<var class="var">udpport</var>, <var class="var">property</var>)</code><a class="copiable-link" href='#index-get-29'> ¶</a></span></dt>
<dd><p>Get the properties of udpport object.
</p>
<h4 class="subsubheading" id="Inputs-132">Inputs</h4>
<p><var class="var">udpport</var> - instance of <var class="var">octave_udpport</var> class.<br>
</p>
<p><var class="var">property</var> - name of property.<br>
</p>
<h4 class="subsubheading" id="Outputs-130">Outputs</h4>
<p>When <var class="var">property</var> was specified, return the value of that property.<br>
otherwise return the values of all properties as a structure.<br>
</p>
<p><strong class="strong">See also:</strong> @octave_udpport/set.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fudpport_002fread">
<h4 class="subsection">3.14.8 @octave_udpport/read</h4>
<a class="index-entry-id" id="index-read-7"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-read-28"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-read-28'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-read-29"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>)</code><a class="copiable-link" href='#index-read-29'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-read-30"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">read</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>, <var class="var">datatype</var>)</code><a class="copiable-link" href='#index-read-30'> ¶</a></span></dt>
<dd><p>Reads <var class="var">data</var> from UDP instrument
</p>
<h4 class="subsubheading" id="Inputs-133">Inputs</h4>
<p><var class="var">obj</var> is a UDP object.<br>
<var class="var">size</var> Number of values to read. (Default: BytesAvailable).<br>
<var class="var">datatype</var> datatype of data.<br>
</p>
<h4 class="subsubheading" id="Outputs-131">Outputs</h4>
<p><var class="var">data</var> data read.<br>
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fudpport_002fset">
<h4 class="subsection">3.14.9 @octave_udpport/set</h4>
<a class="index-entry-id" id="index-set-9"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-_0028obj_002c-18"><span class="category-def">Function File: </span><span><code class="def-type">set</code> <strong class="def-name">(<var class="var">obj</var>,</strong> <code class="def-code-arguments"><var class="var">property</var>,<var class="var">value</var>)</code><a class="copiable-link" href='#index-_0028obj_002c-18'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-_0028obj_002c-19"><span class="category-def">Function File: </span><span><code class="def-type">set</code> <strong class="def-name">(<var class="var">obj</var>,</strong> <code class="def-code-arguments"><var class="var">property</var>,<var class="var">value</var>,…)</code><a class="copiable-link" href='#index-_0028obj_002c-19'> ¶</a></span></dt>
<dd><p>Set the properties of udpport object.
</p>
<h4 class="subsubheading" id="Inputs-134">Inputs</h4>
<p><var class="var">obj</var> - instance of <var class="var">octave_udpport</var> class.<br>
<var class="var">property</var> - name of property.<br>
</p>
<p>If <var class="var">property</var> is a cell so must be <var class="var">value</var>, it sets the values of
all matching properties.
</p>
<p>The function also accepts property-value pairs.
</p>
<h4 class="subsubheading" id="Properties-20">Properties</h4>
<dl class="table">
<dt><var class="var">’Name’</var></dt>
<dd><p>Set the name for the udpport socket.
</p>
</dd>
<dt><var class="var">’UserData’</var></dt>
<dd><p>Set the user data of the object.
</p>
</dd>
<dt><var class="var">’Timeout’</var></dt>
<dd><p>Set the timeout value in seconds. Value of -1 means a
blocking call.
</p>
</dd>
</dl>
<h4 class="subsubheading" id="Outputs-132">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> @octave_udpport/get.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fudpport_002fwrite">
<h4 class="subsection">3.14.10 @octave_udpport/write</h4>
<a class="index-entry-id" id="index-write-7"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-write-21"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">write</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-write-21'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-write-22"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">write</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>, <var class="var">destinationAddress</var>, <var class="var">destinationPort</var>))</code><a class="copiable-link" href='#index-write-22'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-write-23"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">write</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>, <var class="var">datatype</var>)</code><a class="copiable-link" href='#index-write-23'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-write-24"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">write</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>, <var class="var">datatype</var>, <var class="var">destinationAddress</var>, <var class="var">destinationPort</var>)</code><a class="copiable-link" href='#index-write-24'> ¶</a></span></dt>
<dd><p>Writes <var class="var">data</var> to UDP instrument
</p>
<h4 class="subsubheading" id="Inputs-135">Inputs</h4>
<p><var class="var">obj</var> is a UDPPort object.<br>
<var class="var">data</var> data to write.<br>
<var class="var">datatype</var> datatype of data. If not specified defaults to uint8.<br>
<var class="var">destinationAddress</var> ipaddress to send to. If not specified, use the previously used remote address.<br>
<var class="var">destinationPort</var> port to send to. If not specified, use the remote port.<br>
</p>
<h4 class="subsubheading" id="Outputs-133">Outputs</h4>
<p>returns number of bytes written.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fudpport_002fwriteline">
<h4 class="subsection">3.14.11 @octave_udpport/writeline</h4>
<a class="index-entry-id" id="index-writeline-1"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-writeline-3"><span class="category-def">: </span><span><strong class="def-name">writeline</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-writeline-3'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-writeline-4"><span class="category-def">: </span><span><strong class="def-name">writeline</strong> <code class="def-code-arguments">(<var class="var">dev</var>, <var class="var">data</var>, <var class="var">destaddr</var>, <var class="var">destport</var>)</code><a class="copiable-link" href='#index-writeline-4'> ¶</a></span></dt>
<dd><p>Write data to a udpport including terminator value
</p>
<h4 class="subsubheading" id="Inputs-136">Inputs</h4>
<p><var class="var">dev</var> - connected device
</p>
<p><var class="var">data</var> - ASCII data to write
</p>
<p><var class="var">destaddr</var> - Destination address
</p>
<p><var class="var">destport</var> - Destination port
</p>
<p>Where the address and port is not specified, the previously used address and port is used.
</p>
<h4 class="subsubheading" id="Outputs-134">Outputs</h4>
<p>None
</p>
<p><strong class="strong">See also:</strong> flushoutput.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="udpport">
<h4 class="subsection">3.14.12 udpport</h4>
<a class="index-entry-id" id="index-udpport"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-udpport-1"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">udp</var> =</code> <strong class="def-name">udpport</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href='#index-udpport-1'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-udpport-2"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">udp</var> =</code> <strong class="def-name">udpport</strong> <code class="def-code-arguments">(<var class="var">propertyname</var>, <var class="var">propertyvalue</var> ...)</code><a class="copiable-link" href='#index-udpport-2'> ¶</a></span></dt>
<dd>
<p>Open udpport interface.
</p>
<h4 class="subsubheading" id="Inputs-137">Inputs</h4>
<p><var class="var">propertyname</var>, <var class="var">propertyvalue</var> - property name/value pair
</p>
<p>Known input properties:
</p><dl class="table">
<dt>Name</dt>
<dd><p>name assigned to the udp object
</p></dd>
<dt>LocalPort</dt>
<dd><p>local port number
</p></dd>
<dt>LocalHost</dt>
<dd><p>local host address
</p></dd>
<dt>Timeout</dt>
<dd><p>timeout value in seconds used for waiting for data
</p></dd>
<dt>EnablePortSharing</dt>
<dd><p>Boolean if the socket has port sharing enabled (readonly)
</p></dd>
</dl>
<h4 class="subsubheading" id="Outputs-135">Outputs</h4>
<p>The udpport() shall return instance of <var class="var">octave_udp</var> class as the result <var class="var">udp</var>.
</p>
<h4 class="subsubheading" id="Properties-21">Properties</h4>
<p>The udp object has the following public properties:
</p><dl class="table">
<dt>Name</dt>
<dd><p>name assigned to the udp object
</p></dd>
<dt>Type</dt>
<dd><p>instrument type ’udpport’ (readonly)
</p></dd>
<dt>LocalPort</dt>
<dd><p>local port number (readonly)
</p></dd>
<dt>LocalHost</dt>
<dd><p>local host address (readonly)
</p></dd>
<dt>Status</dt>
<dd><p>status of the object ’open’ or ’closed’ (readonly)
</p></dd>
<dt>Timeout</dt>
<dd><p>timeout value in seconds used for waiting for data
</p></dd>
<dt>NumBytesAvailable</dt>
<dd><p>number of bytes currently available to read (readonly)
</p></dd>
<dt>MulticastGroup</dt>
<dd><p>multicast group socket is subscribed to (readonly)
</p></dd>
<dt>EnableMultcast</dt>
<dd><p>Boolean if the socket has any multicast group it is subscribed to (readonly)
</p></dd>
<dt>EnablePortSharing</dt>
<dd><p>Boolean if the socket has port sharing enabled (readonly)
</p></dd>
<dt>Terminator</dt>
<dd><p>Terminator value used for string data (currently not used)
</p></dd>
</dl>
</dd></dl>
<hr>
</div>
</div>
<div class="section-level-extent" id="USBTMC">
<div class="nav-panel">
<p>
Next: <a href="#VXI11" accesskey="n" rel="next">VXI11</a>, Previous: <a href="#UDP-Port" accesskey="p" rel="prev">UDP Port</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="USBTMC-1">3.15 USBTMC</h3>
<a class="index-entry-id" id="index-USBTMC"></a>
<ul class="mini-toc">
<li><a href="#g_t_0040octave_005fusbtmc_002ffclose" accesskey="1">@octave_usbtmc/fclose</a></li>
<li><a href="#g_t_0040octave_005fusbtmc_002ffopen" accesskey="2">@octave_usbtmc/fopen</a></li>
<li><a href="#g_t_0040octave_005fusbtmc_002ffread" accesskey="3">@octave_usbtmc/fread</a></li>
<li><a href="#g_t_0040octave_005fusbtmc_002ffwrite" accesskey="4">@octave_usbtmc/fwrite</a></li>
<li><a href="#usbtmc" accesskey="5">usbtmc</a></li>
<li><a href="#usbtmc_005fclose" accesskey="6">usbtmc_close</a></li>
<li><a href="#usbtmc_005fread" accesskey="7">usbtmc_read</a></li>
<li><a href="#usbtmc_005fwrite" accesskey="8">usbtmc_write</a></li>
</ul>
<div class="subsection-level-extent" id="g_t_0040octave_005fusbtmc_002ffclose">
<h4 class="subsection">3.15.1 @octave_usbtmc/fclose</h4>
<a class="index-entry-id" id="index-fclose-7"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fclose-16"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">res</var> =</code> <strong class="def-name">fclose</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-fclose-16'> ¶</a></span></dt>
<dd><p>Closes USBTMC connection <var class="var">obj</var>
</p>
<h4 class="subsubheading" id="Inputs-138">Inputs</h4>
<p><var class="var">obj</var> is a usbtmc object.<br>
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fusbtmc_002ffopen">
<h4 class="subsection">3.15.2 @octave_usbtmc/fopen</h4>
<a class="index-entry-id" id="index-fopen-7"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fopen-16"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">res</var> =</code> <strong class="def-name">fopen</strong> <code class="def-code-arguments">(<var class="var">obj</var>) (dummy)</code><a class="copiable-link" href='#index-fopen-16'> ¶</a></span></dt>
<dd><p>Opens USBTMC connection <var class="var">obj</var>
This currently is a dummy function to improve compatibility to MATLAB
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fusbtmc_002ffread">
<h4 class="subsection">3.15.3 @octave_usbtmc/fread</h4>
<a class="index-entry-id" id="index-fread-9"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fread-56"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-fread-56'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-57"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>)</code><a class="copiable-link" href='#index-fread-57'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-58"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-fread-58'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-59"><span class="category-def">Function File: </span><span><code class="def-type">[<var class="var">data</var>,<var class="var">count</var>] =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, ...)</code><a class="copiable-link" href='#index-fread-59'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-60"><span class="category-def">Function File: </span><span><code class="def-type">[<var class="var">data</var>,<var class="var">count</var>,<var class="var">errmsg</var>] =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, ...)</code><a class="copiable-link" href='#index-fread-60'> ¶</a></span></dt>
<dd><p>Reads <var class="var">data</var> from usbtmc instrument
</p>
<h4 class="subsubheading" id="Inputs-139">Inputs</h4>
<p><var class="var">obj</var> is a usbtmc object.<br>
<var class="var">size</var> Number of values to read. (Default: 100).<br>
<var class="var">precision</var> precision of data.<br>
</p>
<h4 class="subsubheading" id="Outputs-136">Outputs</h4>
<p><var class="var">data</var> The read data.<br>
<var class="var">count</var> values read.<br>
<var class="var">errmsg</var> read operation error message.<br>
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fusbtmc_002ffwrite">
<h4 class="subsection">3.15.4 @octave_usbtmc/fwrite</h4>
<a class="index-entry-id" id="index-fwrite-9"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fwrite-32"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">fwrite</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-fwrite-32'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fwrite-33"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">fwrite</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-fwrite-33'> ¶</a></span></dt>
<dd><p>Writes <var class="var">data</var> to an usbtmc instrument
</p>
<h4 class="subsubheading" id="Inputs-140">Inputs</h4>
<p><var class="var">obj</var> is a usbtmc object.<br>
<var class="var">data</var> data to write.<br>
<var class="var">precision</var> precision of data.<br>
</p>
<h4 class="subsubheading" id="Outputs-137">Outputs</h4>
<p>returns number of bytes written.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="usbtmc">
<h4 class="subsection">3.15.5 usbtmc</h4>
<a class="index-entry-id" id="index-usbtmc"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-usbtmc-1"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">usbtmc</var> =</code> <strong class="def-name">usbtmc</strong> <code class="def-code-arguments">(<var class="var">path</var>)</code><a class="copiable-link" href='#index-usbtmc-1'> ¶</a></span></dt>
<dd>
<p>Open usbtmc interface.
</p>
<h4 class="subsubheading" id="Inputs-141">Inputs</h4>
<p><var class="var">path</var> - the interface path of type String. If omitted defaults to ’/dev/usbtmc0’.
</p>
<h4 class="subsubheading" id="Outputs-138">Outputs</h4>
<p>The usbtmc() shall return instance of <var class="var">octave_usbtmc</var> class as the result <var class="var">usbtmc</var>.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="usbtmc_005fclose">
<h4 class="subsection">3.15.6 usbtmc_close</h4>
<a class="index-entry-id" id="index-usbtmc_005fclose"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-usbtmc_005fclose-1"><span class="category-def">Loadable Function: </span><span><strong class="def-name">usbtmc_close</strong> <code class="def-code-arguments">(<var class="var">usbtmc</var>)</code><a class="copiable-link" href='#index-usbtmc_005fclose-1'> ¶</a></span></dt>
<dd>
<p>Close the interface and release a file descriptor.
</p>
<h4 class="subsubheading" id="Inputs-142">Inputs</h4>
<p><var class="var">usbtmc</var> - instance of <var class="var">octave_usbtmc</var> class.
</p><h4 class="subsubheading" id="Outputs-139">Outputs</h4>
<p>None
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="usbtmc_005fread">
<h4 class="subsection">3.15.7 usbtmc_read</h4>
<a class="index-entry-id" id="index-usbtmc_005fread"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-usbtmc_005fread-1"><span class="category-def">Loadable Function: </span><span><code class="def-type">[<var class="var">data</var>, <var class="var">count</var>] =</code> <strong class="def-name">usbtmc_read</strong> <code class="def-code-arguments">(<var class="var">usbtmc</var>, <var class="var">n</var>)</code><a class="copiable-link" href='#index-usbtmc_005fread-1'> ¶</a></span></dt>
<dd>
<p>Read from usbtmc slave device.
</p>
<h4 class="subsubheading" id="Inputs-143">Inputs</h4>
<p><var class="var">usbtmc</var> - instance of <var class="var">octave_usbtmc</var> class.<br>
<var class="var">n</var> - number of bytes to attempt to read of type Integer.
</p>
<h4 class="subsubheading" id="Outputs-140">Outputs</h4>
<p><var class="var">count</var> - the number of bytes successfully read as an Integer.<br>
<var class="var">data</var> - the read bytes as a uint8 array.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="usbtmc_005fwrite">
<h4 class="subsection">3.15.8 usbtmc_write</h4>
<a class="index-entry-id" id="index-usbtmc_005fwrite"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-usbtmc_005fwrite-1"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">n</var> =</code> <strong class="def-name">usbtmc_write</strong> <code class="def-code-arguments">(<var class="var">usbtmc</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-usbtmc_005fwrite-1'> ¶</a></span></dt>
<dd>
<p>Write data to a usbtmc slave device.
</p>
<h4 class="subsubheading" id="Inputs-144">Inputs</h4>
<p><var class="var">usbtmc</var> - instance of <var class="var">octave_usbtmc</var> class.<br>
<var class="var">data</var> - data, of type uint8, to be written to the slave device.
</p>
<h4 class="subsubheading" id="Outputs-141">Outputs</h4>
<p>Upon successful completion, usbtmc_write() shall return the number of bytes written as the result <var class="var">n</var>.
</p></dd></dl>
<hr>
</div>
</div>
<div class="section-level-extent" id="VXI11">
<div class="nav-panel">
<p>
Previous: <a href="#USBTMC" accesskey="p" rel="prev">USBTMC</a>, Up: <a href="#Function-Reference" accesskey="u" rel="up">Function Reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="VXI11-1">3.16 VXI11</h3>
<a class="index-entry-id" id="index-VXI11"></a>
<ul class="mini-toc">
<li><a href="#g_t_0040octave_005fvxi11_002ffclose" accesskey="1">@octave_vxi11/fclose</a></li>
<li><a href="#g_t_0040octave_005fvxi11_002ffopen" accesskey="2">@octave_vxi11/fopen</a></li>
<li><a href="#g_t_0040octave_005fvxi11_002ffread" accesskey="3">@octave_vxi11/fread</a></li>
<li><a href="#g_t_0040octave_005fvxi11_002ffwrite" accesskey="4">@octave_vxi11/fwrite</a></li>
<li><a href="#vxi11" accesskey="5">vxi11</a></li>
<li><a href="#vxi11_005fclose" accesskey="6">vxi11_close</a></li>
<li><a href="#vxi11_005fread" accesskey="7">vxi11_read</a></li>
<li><a href="#vxi11_005fwrite" accesskey="8">vxi11_write</a></li>
</ul>
<div class="subsection-level-extent" id="g_t_0040octave_005fvxi11_002ffclose">
<h4 class="subsection">3.16.1 @octave_vxi11/fclose</h4>
<a class="index-entry-id" id="index-fclose-8"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fclose-17"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">res</var> =</code> <strong class="def-name">fclose</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-fclose-17'> ¶</a></span></dt>
<dd><p>Closes VXI11 connection <var class="var">obj</var>
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fvxi11_002ffopen">
<h4 class="subsection">3.16.2 @octave_vxi11/fopen</h4>
<a class="index-entry-id" id="index-fopen-8"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fopen-17"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">res</var> =</code> <strong class="def-name">fopen</strong> <code class="def-code-arguments">(<var class="var">obj</var>) (dummy)</code><a class="copiable-link" href='#index-fopen-17'> ¶</a></span></dt>
<dd><p>Opens VXI11 connection <var class="var">obj</var>
This currently is a dummy function to improve compatibility to MATLAB
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fvxi11_002ffread">
<h4 class="subsection">3.16.3 @octave_vxi11/fread</h4>
<a class="index-entry-id" id="index-fread-10"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fread-61"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href='#index-fread-61'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-62"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>)</code><a class="copiable-link" href='#index-fread-62'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-63"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">data</var> =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">size</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-fread-63'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-64"><span class="category-def">Function File: </span><span><code class="def-type">[<var class="var">data</var>,<var class="var">count</var>] =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, ...)</code><a class="copiable-link" href='#index-fread-64'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fread-65"><span class="category-def">Function File: </span><span><code class="def-type">[<var class="var">data</var>,<var class="var">count</var>,<var class="var">errmsg</var>] =</code> <strong class="def-name">fread</strong> <code class="def-code-arguments">(<var class="var">obj</var>, ...)</code><a class="copiable-link" href='#index-fread-65'> ¶</a></span></dt>
<dd><p>Reads <var class="var">data</var> from vxi11 instrument
</p>
<h4 class="subsubheading" id="Inputs-145">Inputs</h4>
<p><var class="var">obj</var> is a vxi11 object.<br>
<var class="var">size</var> Number of values to read. (Default: 100).<br>
<var class="var">precision</var> precision of data.<br>
</p>
<h4 class="subsubheading" id="Outputs-142">Outputs</h4>
<p><var class="var">data</var> The read data.<br>
<var class="var">count</var> values read.<br>
<var class="var">errmsg</var> read operation error message.<br>
</p>
</dd></dl>
</div>
<div class="subsection-level-extent" id="g_t_0040octave_005fvxi11_002ffwrite">
<h4 class="subsection">3.16.4 @octave_vxi11/fwrite</h4>
<a class="index-entry-id" id="index-fwrite-10"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-fwrite-34"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">fwrite</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-fwrite-34'> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-fwrite-35"><span class="category-def">Function File: </span><span><code class="def-type"><var class="var">numbytes</var> =</code> <strong class="def-name">fwrite</strong> <code class="def-code-arguments">(<var class="var">obj</var>, <var class="var">data</var>, <var class="var">precision</var>)</code><a class="copiable-link" href='#index-fwrite-35'> ¶</a></span></dt>
<dd><p>Writes <var class="var">data</var> to vxi11 instrument
</p>
<h4 class="subsubheading" id="Inputs-146">Inputs</h4>
<p><var class="var">obj</var> is a vxi11 object.<br>
<var class="var">data</var> data to write.<br>
<var class="var">precision</var> precision of data.<br>
</p>
<h4 class="subsubheading" id="Outputs-143">Outputs</h4>
<p>returns number of bytes written.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="vxi11">
<h4 class="subsection">3.16.5 vxi11</h4>
<a class="index-entry-id" id="index-vxi11"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-vxi11-1"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">vxi11</var> =</code> <strong class="def-name">vxi11</strong> <code class="def-code-arguments">(<var class="var">ip</var>,<var class="var">instr</var>)</code><a class="copiable-link" href='#index-vxi11-1'> ¶</a></span></dt>
<dd>
<p>Open vxi11 interface.
</p>
<p><var class="var">ip</var> - the ip address of type String. If omitted defaults to ’127.0.0.1’.
<var class="var">instr</var> - the instrument name of type String. If omitted defaults to ’instr0’.
</p>
<p>The vxi11() shall return instance of <var class="var">octave_vxi11</var> class as the result <var class="var">vxi11</var>.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="vxi11_005fclose">
<h4 class="subsection">3.16.6 vxi11_close</h4>
<a class="index-entry-id" id="index-vxi11_005fclose"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-vxi11_005fclose-1"><span class="category-def">Loadable Function: </span><span><strong class="def-name">vxi11_close</strong> <code class="def-code-arguments">(<var class="var">vxi11</var>)</code><a class="copiable-link" href='#index-vxi11_005fclose-1'> ¶</a></span></dt>
<dd>
<p>Close the interface and release a file descriptor.
</p>
<p><var class="var">vxi11</var> - instance of <var class="var">octave_vxi11</var> class.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="vxi11_005fread">
<h4 class="subsection">3.16.7 vxi11_read</h4>
<a class="index-entry-id" id="index-vxi11_005fread"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-vxi11_005fread-1"><span class="category-def">Loadable Function: </span><span><code class="def-type">[<var class="var">data</var>, <var class="var">count</var>] =</code> <strong class="def-name">vxi11_read</strong> <code class="def-code-arguments">(<var class="var">vxi11</var>, <var class="var">n</var>)</code><a class="copiable-link" href='#index-vxi11_005fread-1'> ¶</a></span></dt>
<dd>
<p>Read from vxi11 slave device.
</p>
<p><var class="var">vxi11</var> - instance of <var class="var">octave_vxi11</var> class.<br>
<var class="var">n</var> - number of bytes to attempt to read of type Integer.
</p>
<p>The vxi11_read() shall return number of bytes successfully read in <var class="var">count</var> as Integer and the bytes themselves in <var class="var">data</var> as uint8 array.
</p></dd></dl>
</div>
<div class="subsection-level-extent" id="vxi11_005fwrite">
<h4 class="subsection">3.16.8 vxi11_write</h4>
<a class="index-entry-id" id="index-vxi11_005fwrite"></a>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-vxi11_005fwrite-1"><span class="category-def">Loadable Function: </span><span><code class="def-type"><var class="var">n</var> =</code> <strong class="def-name">vxi11_write</strong> <code class="def-code-arguments">(<var class="var">vxi11</var>, <var class="var">data</var>)</code><a class="copiable-link" href='#index-vxi11_005fwrite-1'> ¶</a></span></dt>
<dd>
<p>Write data to a vxi11 slave device.
</p>
<p><var class="var">vxi11</var> - instance of <var class="var">octave_vxi11</var> class.<br>
<var class="var">data</var> - data to be written to the slave device. Can be either of String or uint8 type.
</p>
<p>Upon successful completion, vxi11_write() shall return the number of bytes written as the result <var class="var">n</var>.
</p></dd></dl>
<hr>
</div>
</div>
</div>
<div class="appendix-level-extent" id="Copying">
<div class="nav-panel">
<p>
Next: <a href="#Index" accesskey="n" rel="next">Index</a>, Previous: <a href="#Function-Reference" accesskey="p" rel="prev">Function Reference</a>, Up: <a href="#Top" accesskey="u" rel="up">Introduction</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h2 class="appendix" id="GNU-General-Public-License">Appendix A GNU General Public License</h2>
<a class="index-entry-id" id="index-warranty"></a>
<a class="index-entry-id" id="index-copyright"></a>
<div class="center">Version 3, 29 June 2007
</div>
<div class="display">
<pre class="display-preformatted">Copyright © 2007 Free Software Foundation, Inc. <a class="url" href="http://fsf.org/">http://fsf.org/</a>
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
</pre></div>
<h3 class="heading" id="Preamble">Preamble</h3>
<p>The GNU General Public License is a free, copyleft license for
software and other kinds of works.
</p>
<p>The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom
to share and change all versions of a program—to make sure it remains
free software for all its users. We, the Free Software Foundation,
use the GNU General Public License for most of our software; it
applies also to any other work released this way by its authors. You
can apply it to your programs, too.
</p>
<p>When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
</p>
<p>To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you
have certain responsibilities if you distribute copies of the
software, or if you modify it: responsibilities to respect the freedom
of others.
</p>
<p>For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too,
receive or can get the source code. And you must show them these
terms so they know their rights.
</p>
<p>Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
</p>
<p>For the developers’ and authors’ protection, the GPL clearly explains
that there is no warranty for this free software. For both users’ and
authors’ sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
</p>
<p>Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the
manufacturer can do so. This is fundamentally incompatible with the
aim of protecting users’ freedom to change the software. The
systematic pattern of such abuse occurs in the area of products for
individuals to use, which is precisely where it is most unacceptable.
Therefore, we have designed this version of the GPL to prohibit the
practice for those products. If such problems arise substantially in
other domains, we stand ready to extend this provision to those
domains in future versions of the GPL, as needed to protect the
freedom of users.
</p>
<p>Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish
to avoid the special danger that patents applied to a free program
could make it effectively proprietary. To prevent this, the GPL
assures that patents cannot be used to render the program non-free.
</p>
<p>The precise terms and conditions for copying, distribution and
modification follow.
</p>
<h3 class="heading" id="TERMS-AND-CONDITIONS">TERMS AND CONDITIONS</h3>
<ol class="enumerate" start="0">
<li> Definitions.
<p>“This License” refers to version 3 of the GNU General Public License.
</p>
<p>“Copyright” also means copyright-like laws that apply to other kinds
of works, such as semiconductor masks.
</p>
<p>“The Program” refers to any copyrightable work licensed under this
License. Each licensee is addressed as “you”. “Licensees” and
“recipients” may be individuals or organizations.
</p>
<p>To “modify” a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of
an exact copy. The resulting work is called a “modified version” of
the earlier work or a work “based on” the earlier work.
</p>
<p>A “covered work” means either the unmodified Program or a work based
on the Program.
</p>
<p>To “propagate” a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
</p>
<p>To “convey” a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user
through a computer network, with no transfer of a copy, is not
conveying.
</p>
<p>An interactive user interface displays “Appropriate Legal Notices” to
the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
</p>
</li><li> Source Code.
<p>The “source code” for a work means the preferred form of the work for
making modifications to it. “Object code” means any non-source form
of a work.
</p>
<p>A “Standard Interface” means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
</p>
<p>The “System Libraries” of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
“Major Component”, in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
</p>
<p>The “Corresponding Source” for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work’s
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
</p>
<p>The Corresponding Source need not include anything that users can
regenerate automatically from other parts of the Corresponding Source.
</p>
<p>The Corresponding Source for a work in source code form is that same
work.
</p>
</li><li> Basic Permissions.
<p>All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
</p>
<p>You may make, run and propagate covered works that you do not convey,
without conditions so long as your license otherwise remains in force.
You may convey covered works to others for the sole purpose of having
them make modifications exclusively for you, or provide you with
facilities for running those works, provided that you comply with the
terms of this License in conveying all material for which you do not
control copyright. Those thus making or running the covered works for
you must do so exclusively on your behalf, under your direction and
control, on terms that prohibit them from making any copies of your
copyrighted material outside their relationship with you.
</p>
<p>Conveying under any other circumstances is permitted solely under the
conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
</p>
</li><li> Protecting Users’ Legal Rights From Anti-Circumvention Law.
<p>No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
</p>
<p>When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such
circumvention is effected by exercising rights under this License with
respect to the covered work, and you disclaim any intention to limit
operation or modification of the work as a means of enforcing, against
the work’s users, your or third parties’ legal rights to forbid
circumvention of technological measures.
</p>
</li><li> Conveying Verbatim Copies.
<p>You may convey verbatim copies of the Program’s source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
</p>
<p>You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
</p>
</li><li> Conveying Modified Source Versions.
<p>You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these
conditions:
</p>
<ol class="enumerate" type="a" start="1">
<li> The work must carry prominent notices stating that you modified it,
and giving a relevant date.
</li><li> The work must carry prominent notices stating that it is released
under this License and any conditions added under section 7. This
requirement modifies the requirement in section 4 to “keep intact all
notices”.
</li><li> You must license the entire work, as a whole, under this License to
anyone who comes into possession of a copy. This License will
therefore apply, along with any applicable section 7 additional terms,
to the whole of the work, and all its parts, regardless of how they
are packaged. This License gives no permission to license the work in
any other way, but it does not invalidate such permission if you have
separately received it.
</li><li> If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your work
need not make them do so.
</li></ol>
<p>A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
“aggregate” if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation’s users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
</p>
</li><li> Conveying Non-Source Forms.
<p>You may convey a covered work in object code form under the terms of
sections 4 and 5, provided that you also convey the machine-readable
Corresponding Source under the terms of this License, in one of these
ways:
</p>
<ol class="enumerate" type="a" start="1">
<li> Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium customarily
used for software interchange.
</li><li> Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a written
offer, valid for at least three years and valid for as long as you
offer spare parts or customer support for that product model, to give
anyone who possesses the object code either (1) a copy of the
Corresponding Source for all the software in the product that is
covered by this License, on a durable physical medium customarily used
for software interchange, for a price no more than your reasonable
cost of physically performing this conveying of source, or (2) access
to copy the Corresponding Source from a network server at no charge.
</li><li> Convey individual copies of the object code with a copy of the written
offer to provide the Corresponding Source. This alternative is
allowed only occasionally and noncommercially, and only if you
received the object code with such an offer, in accord with subsection
6b.
</li><li> Convey the object code by offering access from a designated place
(gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to copy
the object code is a network server, the Corresponding Source may be
on a different server (operated by you or a third party) that supports
equivalent copying facilities, provided you maintain clear directions
next to the object code saying where to find the Corresponding Source.
Regardless of what server hosts the Corresponding Source, you remain
obligated to ensure that it is available for as long as needed to
satisfy these requirements.
</li><li> Convey the object code using peer-to-peer transmission, provided you
inform other peers where the object code and Corresponding Source of
the work are being offered to the general public at no charge under
subsection 6d.
</li></ol>
<p>A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
</p>
<p>A “User Product” is either (1) a “consumer product”, which means any
tangible personal property which is normally used for personal,
family, or household purposes, or (2) anything designed or sold for
incorporation into a dwelling. In determining whether a product is a
consumer product, doubtful cases shall be resolved in favor of
coverage. For a particular product received by a particular user,
“normally used” refers to a typical or common use of that class of
product, regardless of the status of the particular user or of the way
in which the particular user actually uses, or expects or is expected
to use, the product. A product is a consumer product regardless of
whether the product has substantial commercial, industrial or
non-consumer uses, unless such uses represent the only significant
mode of use of the product.
</p>
<p>“Installation Information” for a User Product means any methods,
procedures, authorization keys, or other information required to
install and execute modified versions of a covered work in that User
Product from a modified version of its Corresponding Source. The
information must suffice to ensure that the continued functioning of
the modified object code is in no case prevented or interfered with
solely because modification has been made.
</p>
<p>If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
</p>
<p>The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or
updates for a work that has been modified or installed by the
recipient, or for the User Product in which it has been modified or
installed. Access to a network may be denied when the modification
itself materially and adversely affects the operation of the network
or violates the rules and protocols for communication across the
network.
</p>
<p>Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
</p>
</li><li> Additional Terms.
<p>“Additional permissions” are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
</p>
<p>When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
</p>
<p>Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders
of that material) supplement the terms of this License with terms:
</p>
<ol class="enumerate" type="a" start="1">
<li> Disclaiming warranty or limiting liability differently from the terms
of sections 15 and 16 of this License; or
</li><li> Requiring preservation of specified reasonable legal notices or author
attributions in that material or in the Appropriate Legal Notices
displayed by works containing it; or
</li><li> Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
</li><li> Limiting the use for publicity purposes of names of licensors or
authors of the material; or
</li><li> Declining to grant rights under trademark law for use of some trade
names, trademarks, or service marks; or
</li><li> Requiring indemnification of licensors and authors of that material by
anyone who conveys the material (or modified versions of it) with
contractual assumptions of liability to the recipient, for any
liability that these contractual assumptions directly impose on those
licensors and authors.
</li></ol>
<p>All other non-permissive additional terms are considered “further
restrictions” within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
</p>
<p>If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
</p>
<p>Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions; the
above requirements apply either way.
</p>
</li><li> Termination.
<p>You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
</p>
<p>However, if you cease all violation of this License, then your license
from a particular copyright holder is reinstated (a) provisionally,
unless and until the copyright holder explicitly and finally
terminates your license, and (b) permanently, if the copyright holder
fails to notify you of the violation by some reasonable means prior to
60 days after the cessation.
</p>
<p>Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
</p>
<p>Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
</p>
</li><li> Acceptance Not Required for Having Copies.
<p>You are not required to accept this License in order to receive or run
a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
</p>
</li><li> Automatic Licensing of Downstream Recipients.
<p>Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
</p>
<p>An “entity transaction” is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party’s predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
</p>
<p>You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
</p>
</li><li> Patents.
<p>A “contributor” is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor’s “contributor version”.
</p>
<p>A contributor’s “essential patent claims” are all patent claims owned
or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, “control” includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
</p>
<p>Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor’s essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
</p>
<p>In the following three paragraphs, a “patent license” is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To “grant” such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
</p>
<p>If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. “Knowingly relying” means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient’s use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
</p>
<p>If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
</p>
<p>A patent license is “discriminatory” if it does not include within the
scope of its coverage, prohibits the exercise of, or is conditioned on
the non-exercise of one or more of the rights that are specifically
granted under this License. You may not convey a covered work if you
are a party to an arrangement with a third party that is in the
business of distributing software, under which you make payment to the
third party based on the extent of your activity of conveying the
work, and under which the third party grants, to any of the parties
who would receive the covered work from you, a discriminatory patent
license (a) in connection with copies of the covered work conveyed by
you (or copies made from those copies), or (b) primarily for and in
connection with specific products or compilations that contain the
covered work, unless you entered into that arrangement, or that patent
license was granted, prior to 28 March 2007.
</p>
<p>Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
</p>
</li><li> No Surrender of Others’ Freedom.
<p>If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey
a covered work so as to satisfy simultaneously your obligations under
this License and any other pertinent obligations, then as a
consequence you may not convey it at all. For example, if you agree
to terms that obligate you to collect a royalty for further conveying
from those to whom you convey the Program, the only way you could
satisfy both those terms and this License would be to refrain entirely
from conveying the Program.
</p>
</li><li> Use with the GNU Affero General Public License.
<p>Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
</p>
</li><li> Revised Versions of this License.
<p>The Free Software Foundation may publish revised and/or new versions
of the GNU General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.
</p>
<p>Each version is given a distinguishing version number. If the Program
specifies that a certain numbered version of the GNU General Public
License “or any later version” applies to it, you have the option of
following the terms and conditions either of that numbered version or
of any later version published by the Free Software Foundation. If
the Program does not specify a version number of the GNU General
Public License, you may choose any version ever published by the Free
Software Foundation.
</p>
<p>If the Program specifies that a proxy can decide which future versions
of the GNU General Public License can be used, that proxy’s public
statement of acceptance of a version permanently authorizes you to
choose that version for the Program.
</p>
<p>Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
</p>
</li><li> Disclaimer of Warranty.
<p>THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT
WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
CORRECTION.
</p>
</li><li> Limitation of Liability.
<p>IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
</p>
</li><li> Interpretation of Sections 15 and 16.
<p>If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
</p>
</li></ol>
<h3 class="heading" id="END-OF-TERMS-AND-CONDITIONS">END OF TERMS AND CONDITIONS</h3>
<h3 class="heading" id="How-to-Apply-These-Terms-to-Your-New-Programs">How to Apply These Terms to Your New Programs</h3>
<p>If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these
terms.
</p>
<p>To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the “copyright” line and a pointer to where the full notice is found.
</p>
<div class="example smallexample">
<pre class="example-preformatted"><var class="var">one line to give the program's name and a brief idea of what it does.</var>
Copyright (C) <var class="var">year</var> <var class="var">name of author</var>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <a class="url" href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>.
</pre></div>
<p>Also add information on how to contact you by electronic and paper mail.
</p>
<p>If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
</p>
<div class="example smallexample">
<pre class="example-preformatted"><var class="var">program</var> Copyright (C) <var class="var">year</var> <var class="var">name of author</var>
This program comes with ABSOLUTELY NO WARRANTY; for details type ‘<samp class="samp">show w</samp>’.
This is free software, and you are welcome to redistribute it
under certain conditions; type ‘<samp class="samp">show c</samp>’ for details.
</pre></div>
<p>The hypothetical commands ‘<samp class="samp">show w</samp>’ and ‘<samp class="samp">show c</samp>’ should show
the appropriate parts of the General Public License. Of course, your
program’s commands might be different; for a GUI interface, you would
use an “about box”.
</p>
<p>You should also get your employer (if you work as a programmer) or school,
if any, to sign a “copyright disclaimer” for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<a class="url" href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>.
</p>
<p>The GNU General Public License does not permit incorporating your
program into proprietary programs. If your program is a subroutine
library, you may consider it more useful to permit linking proprietary
applications with the library. If this is what you want to do, use
the GNU Lesser General Public License instead of this License. But
first, please read <a class="url" href="http://www.gnu.org/philosophy/why-not-lgpl.html">http://www.gnu.org/philosophy/why-not-lgpl.html</a>.
</p>
<hr>
</div>
<div class="unnumbered-level-extent" id="Index">
<div class="nav-panel">
<p>
Previous: <a href="#Copying" accesskey="p" rel="prev">GNU General Public License</a>, Up: <a href="#Top" accesskey="u" rel="up">Introduction</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h2 class="unnumbered" id="Index-1">Index</h2>
<div class="printindex cp-printindex">
<table class="cp-letters-header-printindex"><tr><th>Jump to: </th><td><a class="summary-letter-printindex" href="#Index_cp_letter-B"><b>B</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-C"><b>C</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-F"><b>F</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-G"><b>G</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-I"><b>I</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-L"><b>L</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-M"><b>M</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-O"><b>O</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-P"><b>P</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-R"><b>R</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-S"><b>S</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-T"><b>T</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-U"><b>U</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-V"><b>V</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-W"><b>W</b></a>
</td></tr></table>
<table class="cp-entries-printindex" border="0">
<tr><td></td><th class="entries-header-printindex">Index Entry</th><td> </td><th class="sections-header-printindex"> Section</th></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th id="Index_cp_letter-B">B</th><td></td><td></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-Basic-Usage-Overview">Basic Usage Overview</a>:</td><td> </td><td class="printindex-index-section"><a href="#Basic-Usage-Overview">Basic Usage Overview</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th id="Index_cp_letter-C">C</th><td></td><td></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-clrdevice">clrdevice</a>:</td><td> </td><td class="printindex-index-section"><a href="#GPIB">GPIB</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-Common-Functions">Common Functions</a>:</td><td> </td><td class="printindex-index-section"><a href="#Common-Functions">Common Functions</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-configureMulticast">configureMulticast</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-Port">UDP Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-configureTerminator">configureTerminator</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-Port">Serial Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-configureTerminator-1">configureTerminator</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-Client">TCP Client</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-configureTerminator-2">configureTerminator</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-Server">TCP Server</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-configureTerminator-3">configureTerminator</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-Port">UDP Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-copyright">copyright</a>:</td><td> </td><td class="printindex-index-section"><a href="#Copying">Copying</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th id="Index_cp_letter-F">F</th><td></td><td></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fclose">fclose</a>:</td><td> </td><td class="printindex-index-section"><a href="#GPIB">GPIB</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fclose-1">fclose</a>:</td><td> </td><td class="printindex-index-section"><a href="#I2C">I2C</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fclose-2">fclose</a>:</td><td> </td><td class="printindex-index-section"><a href="#Parallel">Parallel</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fclose-3">fclose</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-_0028Deprecated_0029">Serial (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fclose-4">fclose</a>:</td><td> </td><td class="printindex-index-section"><a href="#SPI">SPI</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fclose-5">fclose</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-_0028Deprecated_0029">TCP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fclose-6">fclose</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-_0028Deprecated_0029">UDP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fclose-7">fclose</a>:</td><td> </td><td class="printindex-index-section"><a href="#USBTMC">USBTMC</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fclose-8">fclose</a>:</td><td> </td><td class="printindex-index-section"><a href="#VXI11">VXI11</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-flush">flush</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-Port">Serial Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-flush-1">flush</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-_0028Deprecated_0029">TCP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-flush-2">flush</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-Client">TCP Client</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-flush-3">flush</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-Server">TCP Server</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-flush-4">flush</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-_0028Deprecated_0029">UDP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-flush-5">flush</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-Port">UDP Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-flushinput">flushinput</a>:</td><td> </td><td class="printindex-index-section"><a href="#Common-Functions">Common Functions</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-flushinput-1">flushinput</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-_0028Deprecated_0029">Serial (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-flushinput-2">flushinput</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-_0028Deprecated_0029">TCP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-flushinput-3">flushinput</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-_0028Deprecated_0029">UDP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-flushoutput">flushoutput</a>:</td><td> </td><td class="printindex-index-section"><a href="#Common-Functions">Common Functions</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-flushoutput-1">flushoutput</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-_0028Deprecated_0029">Serial (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-flushoutput-2">flushoutput</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-_0028Deprecated_0029">TCP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-flushoutput-3">flushoutput</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-_0028Deprecated_0029">UDP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fopen">fopen</a>:</td><td> </td><td class="printindex-index-section"><a href="#GPIB">GPIB</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fopen-1">fopen</a>:</td><td> </td><td class="printindex-index-section"><a href="#I2C">I2C</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fopen-2">fopen</a>:</td><td> </td><td class="printindex-index-section"><a href="#Parallel">Parallel</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fopen-3">fopen</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-_0028Deprecated_0029">Serial (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fopen-4">fopen</a>:</td><td> </td><td class="printindex-index-section"><a href="#SPI">SPI</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fopen-5">fopen</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-_0028Deprecated_0029">TCP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fopen-6">fopen</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-_0028Deprecated_0029">UDP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fopen-7">fopen</a>:</td><td> </td><td class="printindex-index-section"><a href="#USBTMC">USBTMC</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fopen-8">fopen</a>:</td><td> </td><td class="printindex-index-section"><a href="#VXI11">VXI11</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fprintf">fprintf</a>:</td><td> </td><td class="printindex-index-section"><a href="#GPIB">GPIB</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fprintf-1">fprintf</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-_0028Deprecated_0029">Serial (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fprintf-2">fprintf</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-Port">Serial Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fprintf-3">fprintf</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-_0028Deprecated_0029">TCP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fprintf-4">fprintf</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-_0028Deprecated_0029">UDP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fprintf-5">fprintf</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-Port">UDP Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fread">fread</a>:</td><td> </td><td class="printindex-index-section"><a href="#GPIB">GPIB</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fread-1">fread</a>:</td><td> </td><td class="printindex-index-section"><a href="#I2C">I2C</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fread-2">fread</a>:</td><td> </td><td class="printindex-index-section"><a href="#Parallel">Parallel</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fread-3">fread</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-_0028Deprecated_0029">Serial (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fread-4">fread</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-Port">Serial Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fread-5">fread</a>:</td><td> </td><td class="printindex-index-section"><a href="#SPI">SPI</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fread-6">fread</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-_0028Deprecated_0029">TCP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fread-7">fread</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-_0028Deprecated_0029">UDP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fread-8">fread</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-Port">UDP Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fread-9">fread</a>:</td><td> </td><td class="printindex-index-section"><a href="#USBTMC">USBTMC</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fread-10">fread</a>:</td><td> </td><td class="printindex-index-section"><a href="#VXI11">VXI11</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fscanf">fscanf</a>:</td><td> </td><td class="printindex-index-section"><a href="#GPIB">GPIB</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-Function-Reference">Function Reference</a>:</td><td> </td><td class="printindex-index-section"><a href="#Function-Reference">Function Reference</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fwrite">fwrite</a>:</td><td> </td><td class="printindex-index-section"><a href="#GPIB">GPIB</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fwrite-1">fwrite</a>:</td><td> </td><td class="printindex-index-section"><a href="#I2C">I2C</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fwrite-2">fwrite</a>:</td><td> </td><td class="printindex-index-section"><a href="#Parallel">Parallel</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fwrite-3">fwrite</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-_0028Deprecated_0029">Serial (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fwrite-4">fwrite</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-Port">Serial Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fwrite-5">fwrite</a>:</td><td> </td><td class="printindex-index-section"><a href="#SPI">SPI</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fwrite-6">fwrite</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-_0028Deprecated_0029">TCP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fwrite-7">fwrite</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-_0028Deprecated_0029">UDP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fwrite-8">fwrite</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-Port">UDP Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fwrite-9">fwrite</a>:</td><td> </td><td class="printindex-index-section"><a href="#USBTMC">USBTMC</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-fwrite-10">fwrite</a>:</td><td> </td><td class="printindex-index-section"><a href="#VXI11">VXI11</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th id="Index_cp_letter-G">G</th><td></td><td></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-General">General</a>:</td><td> </td><td class="printindex-index-section"><a href="#General">General</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-get">get</a>:</td><td> </td><td class="printindex-index-section"><a href="#I2C">I2C</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-get-1">get</a>:</td><td> </td><td class="printindex-index-section"><a href="#Modbus">Modbus</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-get-2">get</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-_0028Deprecated_0029">Serial (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-get-3">get</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-Port">Serial Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-get-4">get</a>:</td><td> </td><td class="printindex-index-section"><a href="#SPI">SPI</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-get-5">get</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-_0028Deprecated_0029">TCP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-get-6">get</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-Client">TCP Client</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-get-7">get</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-Server">TCP Server</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-get-8">get</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-_0028Deprecated_0029">UDP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-get-9">get</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-Port">UDP Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-getpinstatus">getpinstatus</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-Port">Serial Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-GPIB">GPIB</a>:</td><td> </td><td class="printindex-index-section"><a href="#GPIB">GPIB</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-gpib">gpib</a>:</td><td> </td><td class="printindex-index-section"><a href="#GPIB">GPIB</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-gpib_005fclose">gpib_close</a>:</td><td> </td><td class="printindex-index-section"><a href="#GPIB">GPIB</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-gpib_005fread">gpib_read</a>:</td><td> </td><td class="printindex-index-section"><a href="#GPIB">GPIB</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-gpib_005ftimeout">gpib_timeout</a>:</td><td> </td><td class="printindex-index-section"><a href="#GPIB">GPIB</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-gpib_005fwrite">gpib_write</a>:</td><td> </td><td class="printindex-index-section"><a href="#GPIB">GPIB</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th id="Index_cp_letter-I">I</th><td></td><td></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-I2C">I2C</a>:</td><td> </td><td class="printindex-index-section"><a href="#I2C">I2C</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-i2c">i2c</a>:</td><td> </td><td class="printindex-index-section"><a href="#I2C">I2C</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-i2c_005faddr">i2c_addr</a>:</td><td> </td><td class="printindex-index-section"><a href="#I2C">I2C</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-i2c_005fclose">i2c_close</a>:</td><td> </td><td class="printindex-index-section"><a href="#I2C">I2C</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-i2c_005fread">i2c_read</a>:</td><td> </td><td class="printindex-index-section"><a href="#I2C">I2C</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-i2c_005fwrite">i2c_write</a>:</td><td> </td><td class="printindex-index-section"><a href="#I2C">I2C</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-Installing-and-loading">Installing and loading</a>:</td><td> </td><td class="printindex-index-section"><a href="#Installing-and-loading">Installing and loading</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-instrhelp">instrhelp</a>:</td><td> </td><td class="printindex-index-section"><a href="#General">General</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-instrhwinfo">instrhwinfo</a>:</td><td> </td><td class="printindex-index-section"><a href="#General">General</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th id="Index_cp_letter-L">L</th><td></td><td></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-Loading">Loading</a>:</td><td> </td><td class="printindex-index-section"><a href="#Installing-and-loading">Installing and loading</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th id="Index_cp_letter-M">M</th><td></td><td></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-maskWrite">maskWrite</a>:</td><td> </td><td class="printindex-index-section"><a href="#Modbus">Modbus</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-Modbus">Modbus</a>:</td><td> </td><td class="printindex-index-section"><a href="#Modbus">Modbus</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-modbus">modbus</a>:</td><td> </td><td class="printindex-index-section"><a href="#Modbus">Modbus</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th id="Index_cp_letter-O">O</th><td></td><td></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-Off_002dline-install">Off-line install</a>:</td><td> </td><td class="printindex-index-section"><a href="#Installing-and-loading">Installing and loading</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-Online-install">Online install</a>:</td><td> </td><td class="printindex-index-section"><a href="#Installing-and-loading">Installing and loading</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th id="Index_cp_letter-P">P</th><td></td><td></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-Parallel">Parallel</a>:</td><td> </td><td class="printindex-index-section"><a href="#Parallel">Parallel</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-parallel">parallel</a>:</td><td> </td><td class="printindex-index-section"><a href="#Parallel">Parallel</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-pp_005fclose">pp_close</a>:</td><td> </td><td class="printindex-index-section"><a href="#Parallel">Parallel</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-pp_005fctrl">pp_ctrl</a>:</td><td> </td><td class="printindex-index-section"><a href="#Parallel">Parallel</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-pp_005fdata">pp_data</a>:</td><td> </td><td class="printindex-index-section"><a href="#Parallel">Parallel</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-pp_005fdatadir">pp_datadir</a>:</td><td> </td><td class="printindex-index-section"><a href="#Parallel">Parallel</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-pp_005fstat">pp_stat</a>:</td><td> </td><td class="printindex-index-section"><a href="#Parallel">Parallel</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th id="Index_cp_letter-R">R</th><td></td><td></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-read">read</a>:</td><td> </td><td class="printindex-index-section"><a href="#Modbus">Modbus</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-read-1">read</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-Port">Serial Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-read-2">read</a>:</td><td> </td><td class="printindex-index-section"><a href="#SPI">SPI</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-read-3">read</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-_0028Deprecated_0029">TCP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-read-4">read</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-Client">TCP Client</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-read-5">read</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-Server">TCP Server</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-read-6">read</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-_0028Deprecated_0029">UDP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-read-7">read</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-Port">UDP Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-readbinblock">readbinblock</a>:</td><td> </td><td class="printindex-index-section"><a href="#Common-Functions">Common Functions</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-readline">readline</a>:</td><td> </td><td class="printindex-index-section"><a href="#Common-Functions">Common Functions</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-Requirements">Requirements</a>:</td><td> </td><td class="printindex-index-section"><a href="#Installing-and-loading">Installing and loading</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-resolvehost">resolvehost</a>:</td><td> </td><td class="printindex-index-section"><a href="#General">General</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th id="Index_cp_letter-S">S</th><td></td><td></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-serial">serial</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-_0028Deprecated_0029">Serial (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-Serial-_0028Deprecated_0029">Serial (Deprecated)</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-_0028Deprecated_0029">Serial (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-Serial-Port">Serial Port</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-Port">Serial Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-serialbreak">serialbreak</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-_0028Deprecated_0029">Serial (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-serialbreak-1">serialbreak</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-Port">Serial Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-seriallist">seriallist</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-_0028Deprecated_0029">Serial (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-serialport">serialport</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-Port">Serial Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-serialportlist">serialportlist</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-Port">Serial Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-set">set</a>:</td><td> </td><td class="printindex-index-section"><a href="#I2C">I2C</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-set-1">set</a>:</td><td> </td><td class="printindex-index-section"><a href="#Modbus">Modbus</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-set-2">set</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-_0028Deprecated_0029">Serial (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-set-3">set</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-Port">Serial Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-set-4">set</a>:</td><td> </td><td class="printindex-index-section"><a href="#SPI">SPI</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-set-5">set</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-_0028Deprecated_0029">TCP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-set-6">set</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-Client">TCP Client</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-set-7">set</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-Server">TCP Server</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-set-8">set</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-_0028Deprecated_0029">UDP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-set-9">set</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-Port">UDP Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-setDTR">setDTR</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-Port">Serial Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-setRTS">setRTS</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-Port">Serial Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-SPI">SPI</a>:</td><td> </td><td class="printindex-index-section"><a href="#SPI">SPI</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-spi">spi</a>:</td><td> </td><td class="printindex-index-section"><a href="#SPI">SPI</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-spi_005fclose">spi_close</a>:</td><td> </td><td class="printindex-index-section"><a href="#SPI">SPI</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-spi_005fread">spi_read</a>:</td><td> </td><td class="printindex-index-section"><a href="#SPI">SPI</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-spi_005fwrite">spi_write</a>:</td><td> </td><td class="printindex-index-section"><a href="#SPI">SPI</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-spi_005fwriteAndRead">spi_writeAndRead</a>:</td><td> </td><td class="printindex-index-section"><a href="#SPI">SPI</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-spoll">spoll</a>:</td><td> </td><td class="printindex-index-section"><a href="#GPIB">GPIB</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-srl_005fbaudrate">srl_baudrate</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-_0028Deprecated_0029">Serial (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-srl_005fbytesize">srl_bytesize</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-_0028Deprecated_0029">Serial (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-srl_005fclose">srl_close</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-_0028Deprecated_0029">Serial (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-srl_005fflush">srl_flush</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-_0028Deprecated_0029">Serial (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-srl_005fparity">srl_parity</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-_0028Deprecated_0029">Serial (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-srl_005fread">srl_read</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-_0028Deprecated_0029">Serial (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-srl_005fstopbits">srl_stopbits</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-_0028Deprecated_0029">Serial (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-srl_005ftimeout">srl_timeout</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-_0028Deprecated_0029">Serial (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-srl_005fwrite">srl_write</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-_0028Deprecated_0029">Serial (Deprecated)</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th id="Index_cp_letter-T">T</th><td></td><td></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-tcp">tcp</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-_0028Deprecated_0029">TCP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-TCP-_0028Deprecated_0029">TCP (Deprecated)</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-_0028Deprecated_0029">TCP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-TCP-Client">TCP Client</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-Client">TCP Client</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-TCP-Server">TCP Server</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-Server">TCP Server</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-tcpclient">tcpclient</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-Client">TCP Client</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-tcpip">tcpip</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-_0028Deprecated_0029">TCP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-tcpserver">tcpserver</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-Server">TCP Server</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-tcp_005fclose">tcp_close</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-_0028Deprecated_0029">TCP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-tcp_005fread">tcp_read</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-_0028Deprecated_0029">TCP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-tcp_005ftimeout">tcp_timeout</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-_0028Deprecated_0029">TCP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-tcp_005fwrite">tcp_write</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-_0028Deprecated_0029">TCP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-trigger">trigger</a>:</td><td> </td><td class="printindex-index-section"><a href="#GPIB">GPIB</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th id="Index_cp_letter-U">U</th><td></td><td></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-udp">udp</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-_0028Deprecated_0029">UDP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-UDP-_0028Deprecated_0029">UDP (Deprecated)</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-_0028Deprecated_0029">UDP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-UDP-Port">UDP Port</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-Port">UDP Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-udpport">udpport</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-Port">UDP Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-udp_005fclose">udp_close</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-_0028Deprecated_0029">UDP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-udp_005fdemo">udp_demo</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-_0028Deprecated_0029">UDP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-udp_005fread">udp_read</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-_0028Deprecated_0029">UDP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-udp_005ftimeout">udp_timeout</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-_0028Deprecated_0029">UDP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-udp_005fwrite">udp_write</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-_0028Deprecated_0029">UDP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-USBTMC">USBTMC</a>:</td><td> </td><td class="printindex-index-section"><a href="#USBTMC">USBTMC</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-usbtmc">usbtmc</a>:</td><td> </td><td class="printindex-index-section"><a href="#USBTMC">USBTMC</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-usbtmc_005fclose">usbtmc_close</a>:</td><td> </td><td class="printindex-index-section"><a href="#USBTMC">USBTMC</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-usbtmc_005fread">usbtmc_read</a>:</td><td> </td><td class="printindex-index-section"><a href="#USBTMC">USBTMC</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-usbtmc_005fwrite">usbtmc_write</a>:</td><td> </td><td class="printindex-index-section"><a href="#USBTMC">USBTMC</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th id="Index_cp_letter-V">V</th><td></td><td></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-VXI11">VXI11</a>:</td><td> </td><td class="printindex-index-section"><a href="#VXI11">VXI11</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-vxi11">vxi11</a>:</td><td> </td><td class="printindex-index-section"><a href="#VXI11">VXI11</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-vxi11_005fclose">vxi11_close</a>:</td><td> </td><td class="printindex-index-section"><a href="#VXI11">VXI11</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-vxi11_005fread">vxi11_read</a>:</td><td> </td><td class="printindex-index-section"><a href="#VXI11">VXI11</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-vxi11_005fwrite">vxi11_write</a>:</td><td> </td><td class="printindex-index-section"><a href="#VXI11">VXI11</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th id="Index_cp_letter-W">W</th><td></td><td></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-warranty">warranty</a>:</td><td> </td><td class="printindex-index-section"><a href="#Copying">Copying</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-Windows-install">Windows install</a>:</td><td> </td><td class="printindex-index-section"><a href="#Installing-and-loading">Installing and loading</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-write">write</a>:</td><td> </td><td class="printindex-index-section"><a href="#Modbus">Modbus</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-write-1">write</a>:</td><td> </td><td class="printindex-index-section"><a href="#Serial-Port">Serial Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-write-2">write</a>:</td><td> </td><td class="printindex-index-section"><a href="#SPI">SPI</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-write-3">write</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-_0028Deprecated_0029">TCP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-write-4">write</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-Client">TCP Client</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-write-5">write</a>:</td><td> </td><td class="printindex-index-section"><a href="#TCP-Server">TCP Server</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-write-6">write</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-_0028Deprecated_0029">UDP (Deprecated)</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-write-7">write</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-Port">UDP Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-writeAndRead">writeAndRead</a>:</td><td> </td><td class="printindex-index-section"><a href="#SPI">SPI</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-writebinblock">writebinblock</a>:</td><td> </td><td class="printindex-index-section"><a href="#Common-Functions">Common Functions</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-writeline">writeline</a>:</td><td> </td><td class="printindex-index-section"><a href="#Common-Functions">Common Functions</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-writeline-1">writeline</a>:</td><td> </td><td class="printindex-index-section"><a href="#UDP-Port">UDP Port</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-writeread">writeread</a>:</td><td> </td><td class="printindex-index-section"><a href="#Common-Functions">Common Functions</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-writeRead">writeRead</a>:</td><td> </td><td class="printindex-index-section"><a href="#Modbus">Modbus</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
</table>
<table class="cp-letters-footer-printindex"><tr><th>Jump to: </th><td><a class="summary-letter-printindex" href="#Index_cp_letter-B"><b>B</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-C"><b>C</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-F"><b>F</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-G"><b>G</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-I"><b>I</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-L"><b>L</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-M"><b>M</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-O"><b>O</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-P"><b>P</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-R"><b>R</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-S"><b>S</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-T"><b>T</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-U"><b>U</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-V"><b>V</b></a>
<a class="summary-letter-printindex" href="#Index_cp_letter-W"><b>W</b></a>
</td></tr></table>
</div>
</div>
</div>
</body>
</html>
|
