# doc-cache created by Octave 8.4.0
# name: cache
# type: cell
# rows: 3
# columns: 16
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 9
clrdevice


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 111
 -- Function File: clrdevice (OBJ)
     Send clear command to Clear GPIB instrument.

     OBJ is a GPIB object


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 44
Send clear command to Clear GPIB instrument.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 10
flushinput


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 202
 -- flushinput (DEV)
     Flush the instruments input buffers

     Inputs
     ......

     DEV - connected device or array of devices

     Outputs
     .......

     None

     See also: flushoutput.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 35
Flush the instruments input buffers



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 11
flushoutput


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 203
 -- flushoutput (DEV)
     Flush the instruments output buffers

     Inputs
     ......

     DEV - connected device or array of devices

     Outputs
     .......

     None

     See also: flushinput.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 36
Flush the instruments output buffers



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 9
instrhelp


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 348
 -- instrhelp ()
 -- instrhelp (FUNCNAME)
 -- instrhelp (OBJ)
     Display instrument help

     Inputs
     ......

     FUNCNAME - function to display help about.
     OBJ - object to display help about.

     If no input is provided, the function will display and overview of
     the package functionality.

     Outputs
     .......

     None


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 23
Display instrument help



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 11
instrhwinfo


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 1250
 -- Function File: [LIST] = instrhwinfo ()
 -- Function File: LIST = instrhwinfo (INTERFACE)
     Query available hardware for instrument-control

     When run without any input parameters, instrhwinfo will provide the
     toolbox information and a list of supported interfaces.

     Inputs
     ......

     INTERFACE is the instrument interface to query.  When provided,
     instrhwinfo will provide information on the specified interface.

     Currently only interface "serialport","i2c" and "spi" and is
     supported, which will provide a list of available serial ports or
     i2c ports.

     Outputs
     .......

     If an output variable is provided, the function will store the
     information to the variable, otherwise it will be displayed to the
     screen.

     Example
     .......

          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
             }



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 47
Query available hardware for instrument-control



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 12
readbinblock


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 330
 -- DATA = readbinblock (DEV)
 -- DATA = readbinblock (DEV, DATATYPE)
     read a binblock of data from a instrument device

     Inputs
     ......

     DEV - connected device

     DATATYPE - optional data type to read data as (default ’uint8’)

     Outputs
     .......

     DATA - data read

     See also: flushoutput.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 48
read a binblock of data from a instrument device



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 8
readline


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 231
 -- DATA = readline (DEV)
     read data from a instrument device excluding terminator value

     Inputs
     ......

     DEV - connected device

     Outputs
     .......

     DATA - ASCII data read

     See also: flushoutput.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 61
read data from a instrument device excluding terminator value



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 10
seriallist


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 290
 -- Function File: LIST = seriallist ()
     Returns a list of all serial ports detected in the system.

     Inputs
     ......

     None

     Outputs
     .......

     LIST is a string cell array of serial ports names detected in the
     system.

     See also: instrhwinfo("serial").


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 58
Returns a list of all serial ports detected in the system.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 14
serialportlist


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 537
 -- Function File: LIST = serialportlist ()
 -- Function File: LIST = serialportlist ("all")
 -- Function File: LIST = serialportlist ("available")
     Returns a list of all serial ports detected in the system.

     Inputs
     ......

     ’all’ - show all serial ports (same as providing no arguments)
     ’available’ - show only serial ports that are available for use

     Outputs
     .......

     LIST is a string cell array of serial ports names detected in the
     system.

     See also: instrhwinfo("serialport").


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 58
Returns a list of all serial ports detected in the system.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 5
spoll


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 245
 -- Function File: OUT = spoll (OBJ)
 -- Function File: [OUT,STATUSBYTE] = spoll (OBJ)
     Serial polls GPIB instruments.

     OBJ is a GPIB object or a cell array of GPIB objects

     OUT GPIB objects ready for service STATUSBYTE status Byte


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 30
Serial polls GPIB instruments.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 5
tcpip


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 632
 -- Function File: TCP = tcpip (HOST, [PORT], [PROPERTYNAME,
          PROPERTYVALUE...])
     Matlab compatible wrapper to the tcp interface.

     NOTE: tcpip has been deprecated.  Use tcpclient instead

     Inputs
     ......

     HOST - the host name or ip.
     PORT - the port number to connect.  If omitted defaults to 80.
     PROPERTYNAME, PROPERTYVALUE - Optional property name, value pairs
     to set on the tcp object.

     Properties
     ..........

     Currently the only known properties are "timeout" and "name".

     Outputs
     .......

     tcpip will return an instance of OCTAVE_TCP class as the result.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 47
Matlab compatible wrapper to the tcp interface.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 7
trigger


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 90
 -- Function File: trigger (OBJ)
     Triggers GPIB instrument.

     OBJ is a GPIB object


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 25
Triggers GPIB instrument.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 8
udp_demo


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 107
 -- Function File: RESULT = udp_demo ()
     Run test SNTP demonstration for udp class

     See also: udp.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 41
Run test SNTP demonstration for udp class



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 13
writebinblock


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 514
 -- writebinblock (DEV, DATA, DATATYPE)
     Write a IEEE 488.2 binblock of data to a instrument device

     binblock formatted data is defined as:

     #<A><B><C>

     where: <A> ASCII number containing the length of part <B>

     <B> ASCII number containing the number of bytes of <C>

     <C> Binary data block

     Inputs
     ......

     DEV - connected device

     DATA - binary data to send

     DATATYPE - datatype to send data as

     Outputs
     .......

     None

     See also: flushoutput.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 58
Write a IEEE 488.2 binblock of data to a instrument device



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 9
writeline


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 245
 -- writeline (DEV, DATA)
     Write data to a instrument device including terminator value

     Inputs
     ......

     DEV - connected device

     DATA - ASCII data to write

     Outputs
     .......

     None

     See also: flushoutput.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 60
Write data to a instrument device including terminator value



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 9
writeread


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 279
 -- DATA = writeread (DEV, COMMAND)
     write a ASCII command and read data from a instrument device.

     Inputs
     ......

     DEV - connected device

     COMMAND - ASCII command

     Outputs
     .......

     DATA - ASCII data read

     See also: readline, writeline.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 61
write a ASCII command and read data from a instrument device.





