YSdi12Port (Yoctopuce Java API 2.1.11632-SNAPSHOT API)

java.lang.Object
- com.yoctopuce.YoctoAPI.YFunction
- - com.yoctopuce.YoctoAPI.YSdi12Port

```
public class YSdi12Port
extends YFunction
```
YSdi12Port Class: SDI12 port control interface The YSdi12Port class allows you to fully drive a Yoctopuce SDI12 port. It can be used to send and receive data, and to configure communication parameters (baud rate, bit count, parity, flow control and protocol). Note that Yoctopuce SDI12 ports are not exposed as virtual COM ports. They are meant to be used in the same way as all Yoctopuce devices.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`YSdi12Port.TimedReportCallback` TimedReportCallback for Sdi12Port
`static interface`	`YSdi12Port.UpdateCallback` Deprecated UpdateCallback for Sdi12Port

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`_command`
`protected String`	`_currentJob`
`protected int`	`_errCount`
`protected int`	`_eventPos`
`protected int`	`_jobMaxSize`
`protected int`	`_jobMaxTask`
`protected String`	`_lastMsg`
`protected String`	`_protocol`
`protected byte[]`	`_rxbuff`
`protected int`	`_rxbuffptr`
`protected int`	`_rxCount`
`protected int`	`_rxMsgCount`
`protected int`	`_rxptr`
`protected String`	`_serialMode`
`protected String`	`_startupJob`
`protected int`	`_txCount`
`protected int`	`_txMsgCount`
`protected YSdi12Port.UpdateCallback`	`_valueCallbackSdi12Port`
`protected int`	`_voltageLevel`
`static String`	`COMMAND_INVALID` invalid command value
`static String`	`CURRENTJOB_INVALID` invalid currentJob value
`static int`	`ERRCOUNT_INVALID` invalid errCount value
`static int`	`JOBMAXSIZE_INVALID` invalid jobMaxSize value
`static int`	`JOBMAXTASK_INVALID` invalid jobMaxTask value
`static String`	`LASTMSG_INVALID` invalid lastMsg value
`static String`	`PROTOCOL_INVALID` invalid protocol value
`static int`	`RXCOUNT_INVALID` invalid rxCount value
`static int`	`RXMSGCOUNT_INVALID` invalid rxMsgCount value
`static String`	`SERIALMODE_INVALID` invalid serialMode value
`static String`	`STARTUPJOB_INVALID` invalid startupJob value
`static int`	`TXCOUNT_INVALID` invalid txCount value
`static int`	`TXMSGCOUNT_INVALID` invalid txMsgCount value
`static int`	`VOLTAGELEVEL_INVALID`
`static int`	`VOLTAGELEVEL_OFF` invalid voltageLevel value
`static int`	`VOLTAGELEVEL_RS232`
`static int`	`VOLTAGELEVEL_RS485`
`static int`	`VOLTAGELEVEL_SDI12`
`static int`	`VOLTAGELEVEL_TTL1V8`
`static int`	`VOLTAGELEVEL_TTL3V`
`static int`	`VOLTAGELEVEL_TTL3VR`
`static int`	`VOLTAGELEVEL_TTL5V`
`static int`	`VOLTAGELEVEL_TTL5VR`

Fields inherited from class com.yoctopuce.YoctoAPI.YFunction
_advertisedValue, _cacheExpiration, _className, _dataStreams, _func, _funId, _hwId, _lastErrorMsg, _lastErrorType, _logicalName, _serial, _userData, _valueCallbackFunction, _yapi, ADVERTISEDVALUE_INVALID, FUNCTIONDESCRIPTOR_INVALID, LOGICALNAME_INVALID

Constructor Summary

Constructors
Modifier Constructor and Description

protected YSdi12Port(String func)

protected YSdi12Port(YAPIContext ctx, String func)

Constructors
Modifier	Constructor and Description
`protected`	`YSdi12Port(String func)`
`protected`	`YSdi12Port(YAPIContext ctx, String func)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`_invokeValueCallback(String value)`
`protected void`	`_parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val)`
`YSdi12SensorInfo`	`changeAddress(String oldAddress, String newAddress)` Changes the address of the selected sensor, and returns the sensor information with the new address.
`ArrayList<YSdi12SensorInfo>`	`discoverAllSensors()` Sends a discovery command to the bus, and reads all sensors information reply.
`YSdi12SensorInfo`	`discoverSingleSensor()` Sends a discovery command to the bus, and reads the sensor information reply.
`int`	`end_tell()`
`static YSdi12Port`	`FindSdi12Port(String func)` Retrieves an SDI12 port for a given identifier.
`static YSdi12Port`	`FindSdi12PortInContext(YAPIContext yctx, String func)` Retrieves an SDI12 port for a given identifier in a YAPI context.
`static YSdi12Port`	`FirstSdi12Port()` Starts the enumeration of SDI12 ports currently accessible.
`static YSdi12Port`	`FirstSdi12PortInContext(YAPIContext yctx)` Starts the enumeration of SDI12 ports currently accessible.
`String`	`get_command()`
`String`	`get_currentJob()` Returns the name of the job file currently in use.
`int`	`get_errCount()` Returns the total number of communication errors detected since last reset.
`int`	`get_jobMaxSize()` Returns maximum size allowed for job files.
`int`	`get_jobMaxTask()` Returns the maximum number of tasks in a job that the device can handle.
`String`	`get_lastMsg()` Returns the latest message fully received.
`String`	`get_protocol()` Returns the type of protocol used over the serial line, as a string.
`int`	`get_rxCount()` Returns the total number of bytes received since last reset.
`int`	`get_rxMsgCount()` Returns the total number of messages received since last reset.
`String`	`get_serialMode()` Returns the serial port communication parameters, as a string such as "1200,7E1,Simplex".
`String`	`get_startupJob()` Returns the job file to use when the device is powered on.
`int`	`get_txCount()` Returns the total number of bytes transmitted since last reset.
`int`	`get_txMsgCount()` Returns the total number of messages send since last reset.
`int`	`get_voltageLevel()` Returns the voltage level used on the serial line.
`String`	`getCurrentJob()` Returns the name of the job file currently in use.
`int`	`getErrCount()` Returns the total number of communication errors detected since last reset.
`int`	`getJobMaxSize()` Returns maximum size allowed for job files.
`int`	`getJobMaxTask()` Returns the maximum number of tasks in a job that the device can handle.
`String`	`getLastMsg()` Returns the latest message fully received.
`String`	`getProtocol()` Returns the type of protocol used over the serial line, as a string.
`int`	`getRxCount()` Returns the total number of bytes received since last reset.
`int`	`getRxMsgCount()` Returns the total number of messages received since last reset.
`YSdi12SensorInfo`	`getSensorInformation(String sensorAddr)` Sends a information command to the bus, and reads sensors information selected.
`String`	`getSerialMode()` Returns the serial port communication parameters, as a string such as "1200,7E1,Simplex".
`String`	`getStartupJob()` Returns the job file to use when the device is powered on.
`int`	`getTxCount()` Returns the total number of bytes transmitted since last reset.
`int`	`getTxMsgCount()` Returns the total number of messages send since last reset.
`int`	`getVoltageLevel()` Returns the voltage level used on the serial line.
`YSdi12Port`	`nextSdi12Port()` Continues the enumeration of SDI12 ports started using yFirstSdi12Port().
`String`	`queryHex(String hexString, int maxWait)` Sends a binary message to the serial port, and reads the reply, if any.
`String`	`queryLine(String query, int maxWait)` Sends a text line query to the serial port, and reads the reply, if any.
`String`	`querySdi12(String sensorAddr, String cmd, int maxWait)` Sends a SDI-12 query to the bus, and reads the sensor immediate reply.
`int`	`read_avail()` Returns the number of bytes available to read in the input buffer starting from the current absolute stream position pointer of the API object.
`int`	`read_seek(int absPos)` Changes the current internal stream position to the specified value.
`int`	`read_tell()` Returns the current absolute stream position pointer of the API object.
`ArrayList<Integer>`	`readArray(int nChars)` Reads data from the receive buffer as a list of bytes, starting at current stream position.
`byte[]`	`readBin(int nChars)` Reads data from the receive buffer as a binary buffer, starting at current stream position.
`int`	`readByte()` Reads one byte from the receive buffer, starting at current stream position.
`ArrayList<Double>`	`readConcurrentMeasurements(String sensorAddr)` Sends a information command to the bus, and reads sensors information selected.
`String`	`readHex(int nBytes)` Reads data from the receive buffer as a hexadecimal string, starting at current stream position.
`String`	`readLine()` Reads a single line (or message) from the receive buffer, starting at current stream position.
`ArrayList<String>`	`readMessages(String pattern, int maxWait)` Searches for incoming messages in the serial port receive buffer matching a given pattern, starting at current position.
`ArrayList<Double>`	`readSensor(String sensorAddr, String measCmd, int maxWait)` Sends a mesurement command to the SDI-12 bus, and reads the sensor immediate reply.
`String`	`readStr(int nChars)` Reads data from the receive buffer as a string, starting at current stream position.
`int`	`registerValueCallback(YSdi12Port.UpdateCallback callback)` Registers the callback function that is invoked on every change of advertised value.
`int`	`requestConcurrentMeasurements(String sensorAddr)` Sends a information command to the bus, and reads sensors information selected.
`int`	`reset()` Clears the serial port buffer and resets counters to zero.
`int`	`selectJob(String jobfile)` Load and start processing the specified job file.
`int`	`sendCommand(String text)`
`int`	`set_command(String newval)`
`int`	`set_currentJob(String newval)` Selects a job file to run immediately.
`int`	`set_protocol(String newval)` Changes the type of protocol used over the serial line.
`int`	`set_serialMode(String newval)` Changes the serial port communication parameters, with a string such as "1200,7E1,Simplex".
`int`	`set_startupJob(String newval)` Changes the job to use when the device is powered on.
`int`	`set_voltageLevel(int newval)` Changes the voltage type used on the serial line.
`int`	`setCurrentJob(String newval)` Selects a job file to run immediately.
`int`	`setProtocol(String newval)` Changes the type of protocol used over the serial line.
`int`	`setSerialMode(String newval)` Changes the serial port communication parameters, with a string such as "1200,7E1,Simplex".
`int`	`setStartupJob(String newval)` Changes the job to use when the device is powered on.
`int`	`setVoltageLevel(int newval)` Changes the voltage type used on the serial line.
`ArrayList<YSdi12SnoopingRecord>`	`snoopMessages(int maxWait)` Retrieves messages (both direction) in the SDI12 port buffer, starting at current position.
`ArrayList<YSdi12SnoopingRecord>`	`snoopMessagesEx(int maxWait, int maxMsg)` Retrieves messages (both direction) in the SDI12 port buffer, starting at current position.
`int`	`uploadJob(String jobfile, String jsonDef)` Saves the job definition string (JSON data) into a job file.
`int`	`writeArray(ArrayList<Integer> byteList)` Sends a byte sequence (provided as a list of bytes) to the serial port.
`int`	`writeBin(byte[] buff)` Sends a binary buffer to the serial port, as is.
`int`	`writeByte(int code)` Sends a single byte to the serial port.
`int`	`writeHex(String hexString)` Sends a byte sequence (provided as a hexadecimal string) to the serial port.
`int`	`writeLine(String text)` Sends an ASCII string to the serial port, followed by a line break (CR LF).
`int`	`writeStr(String text)` Sends an ASCII string to the serial port, as is.

Methods inherited from class com.yoctopuce.YoctoAPI.YFunction
_AddToCache, _clearDataStreamCache, _decode_json_int, _decode_json_string, _download, _escapeAttr, _FindFromCache, _FindFromCacheInContext, _get_json_path_struct, _get_json_path, _is_valid_pass, _json_get_array, _json_get_key, _json_get_string, _parse, _parserHelper, _setAttr, _throw, _UpdateTimedReportCallbackList, _UpdateValueCallbackList, _upload, _upload, _uploadEx, clearCache, describe, errMessage, errorMessage, errorType, errType, FindFunction, FindFunctionInContext, FirstFunction, FirstFunctionInContext, functionDescriptor, get_advertisedValue, get_errorMessage, get_errorType, get_friendlyName, get_functionDescriptor, get_functionId, get_hardwareId, get_logicalName, get_module, get_serialNumber, get_userData, getAdvertisedValue, getErrorMessage, getErrorType, getFriendlyName, getFunctionDescriptor, getFunctionId, getHardwareId, getLogicalName, getModule, getUserData, isOnline, isReadOnly, load, loadAttribute, module, muteValueCallbacks, nextFunction, registerValueCallback, set_advertisedValue, set_logicalName, set_userData, setLogicalName, setUserData, toString, unmuteValueCallbacks, userData

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - RXCOUNT_INVALID
```
public static final int RXCOUNT_INVALID
```
    invalid rxCount value
    
    See Also:
    
    Constant Field Values
  - TXCOUNT_INVALID
```
public static final int TXCOUNT_INVALID
```
    invalid txCount value
    
    See Also:
    
    Constant Field Values
  - ERRCOUNT_INVALID
```
public static final int ERRCOUNT_INVALID
```
    invalid errCount value
    
    See Also:
    
    Constant Field Values
  - RXMSGCOUNT_INVALID
```
public static final int RXMSGCOUNT_INVALID
```
    invalid rxMsgCount value
    
    See Also:
    
    Constant Field Values
  - TXMSGCOUNT_INVALID
```
public static final int TXMSGCOUNT_INVALID
```
    invalid txMsgCount value
    
    See Also:
    
    Constant Field Values
  - LASTMSG_INVALID
```
public static final String LASTMSG_INVALID
```
    invalid lastMsg value
    
    See Also:
    
    Constant Field Values
  - CURRENTJOB_INVALID
```
public static final String CURRENTJOB_INVALID
```
    invalid currentJob value
    
    See Also:
    
    Constant Field Values
  - STARTUPJOB_INVALID
```
public static final String STARTUPJOB_INVALID
```
    invalid startupJob value
    
    See Also:
    
    Constant Field Values
  - JOBMAXTASK_INVALID
```
public static final int JOBMAXTASK_INVALID
```
    invalid jobMaxTask value
    
    See Also:
    
    Constant Field Values
  - JOBMAXSIZE_INVALID
```
public static final int JOBMAXSIZE_INVALID
```
    invalid jobMaxSize value
    
    See Also:
    
    Constant Field Values
  - COMMAND_INVALID
```
public static final String COMMAND_INVALID
```
    invalid command value
    
    See Also:
    
    Constant Field Values
  - PROTOCOL_INVALID
```
public static final String PROTOCOL_INVALID
```
    invalid protocol value
    
    See Also:
    
    Constant Field Values
  - VOLTAGELEVEL_OFF
```
public static final int VOLTAGELEVEL_OFF
```
    invalid voltageLevel value
    
    See Also:
    
    Constant Field Values
  - VOLTAGELEVEL_TTL3V
```
public static final int VOLTAGELEVEL_TTL3V
```
    See Also:
    
    Constant Field Values
  - VOLTAGELEVEL_TTL3VR
```
public static final int VOLTAGELEVEL_TTL3VR
```
    See Also:
    
    Constant Field Values
  - VOLTAGELEVEL_TTL5V
```
public static final int VOLTAGELEVEL_TTL5V
```
    See Also:
    
    Constant Field Values
  - VOLTAGELEVEL_TTL5VR
```
public static final int VOLTAGELEVEL_TTL5VR
```
    See Also:
    
    Constant Field Values
  - VOLTAGELEVEL_RS232
```
public static final int VOLTAGELEVEL_RS232
```
    See Also:
    
    Constant Field Values
  - VOLTAGELEVEL_RS485
```
public static final int VOLTAGELEVEL_RS485
```
    See Also:
    
    Constant Field Values
  - VOLTAGELEVEL_TTL1V8
```
public static final int VOLTAGELEVEL_TTL1V8
```
    See Also:
    
    Constant Field Values
  - VOLTAGELEVEL_SDI12
```
public static final int VOLTAGELEVEL_SDI12
```
    See Also:
    
    Constant Field Values
  - VOLTAGELEVEL_INVALID
```
public static final int VOLTAGELEVEL_INVALID
```
    See Also:
    
    Constant Field Values
  - SERIALMODE_INVALID
```
public static final String SERIALMODE_INVALID
```
    invalid serialMode value
    
    See Also:
    
    Constant Field Values
  - _rxCount
```
protected int _rxCount
```
  - _txCount
```
protected int _txCount
```
  - _errCount
```
protected int _errCount
```
  - _rxMsgCount
```
protected int _rxMsgCount
```
  - _txMsgCount
```
protected int _txMsgCount
```
  - _lastMsg
```
protected String _lastMsg
```
  - _currentJob
```
protected String _currentJob
```
  - _startupJob
```
protected String _startupJob
```
  - _jobMaxTask
```
protected int _jobMaxTask
```
  - _jobMaxSize
```
protected int _jobMaxSize
```
  - _command
```
protected String _command
```
  - _protocol
```
protected String _protocol
```
  - _voltageLevel
```
protected int _voltageLevel
```
  - _serialMode
```
protected String _serialMode
```
  - _valueCallbackSdi12Port
```
protected YSdi12Port.UpdateCallback _valueCallbackSdi12Port
```
  - _rxptr
```
protected int _rxptr
```
  - _rxbuff
```
protected byte[] _rxbuff
```
  - _rxbuffptr
```
protected int _rxbuffptr
```
  - _eventPos
```
protected int _eventPos
```
- Constructor Detail
  - YSdi12Port
```
protected YSdi12Port(YAPIContext ctx,
                     String func)
```
    Parameters:
    
    func - : functionid
  - YSdi12Port
```
protected YSdi12Port(String func)
```
    Parameters:
    
    func - : functionid
- Method Detail
  - _parseAttr
```
protected void _parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val)
                   throws Exception
```
    Overrides:
    
    _parseAttr in class YFunction
    
    Throws:
    
    Exception
  - get_rxCount
```
public int get_rxCount()
                throws YAPI_Exception
```
    Returns the total number of bytes received since last reset.
    
    Returns:
    
    an integer corresponding to the total number of bytes received since last reset
    
    Throws:
    
    YAPI_Exception - on error
  - getRxCount
```
public int getRxCount()
               throws YAPI_Exception
```
    Returns the total number of bytes received since last reset.
    
    Returns:
    
    an integer corresponding to the total number of bytes received since last reset
    
    Throws:
    
    YAPI_Exception - on error
  - get_txCount
```
public int get_txCount()
                throws YAPI_Exception
```
    Returns the total number of bytes transmitted since last reset.
    
    Returns:
    
    an integer corresponding to the total number of bytes transmitted since last reset
    
    Throws:
    
    YAPI_Exception - on error
  - getTxCount
```
public int getTxCount()
               throws YAPI_Exception
```
    Returns the total number of bytes transmitted since last reset.
    
    Returns:
    
    an integer corresponding to the total number of bytes transmitted since last reset
    
    Throws:
    
    YAPI_Exception - on error
  - get_errCount
```
public int get_errCount()
                 throws YAPI_Exception
```
    Returns the total number of communication errors detected since last reset.
    
    Returns:
    
    an integer corresponding to the total number of communication errors detected since last reset
    
    Throws:
    
    YAPI_Exception - on error
  - getErrCount
```
public int getErrCount()
                throws YAPI_Exception
```
    Returns the total number of communication errors detected since last reset.
    
    Returns:
    
    an integer corresponding to the total number of communication errors detected since last reset
    
    Throws:
    
    YAPI_Exception - on error
  - get_rxMsgCount
```
public int get_rxMsgCount()
                   throws YAPI_Exception
```
    Returns the total number of messages received since last reset.
    
    Returns:
    
    an integer corresponding to the total number of messages received since last reset
    
    Throws:
    
    YAPI_Exception - on error
  - getRxMsgCount
```
public int getRxMsgCount()
                  throws YAPI_Exception
```
    Returns the total number of messages received since last reset.
    
    Returns:
    
    an integer corresponding to the total number of messages received since last reset
    
    Throws:
    
    YAPI_Exception - on error
  - get_txMsgCount
```
public int get_txMsgCount()
                   throws YAPI_Exception
```
    Returns the total number of messages send since last reset.
    
    Returns:
    
    an integer corresponding to the total number of messages send since last reset
    
    Throws:
    
    YAPI_Exception - on error
  - getTxMsgCount
```
public int getTxMsgCount()
                  throws YAPI_Exception
```
    Returns the total number of messages send since last reset.
    
    Returns:
    
    an integer corresponding to the total number of messages send since last reset
    
    Throws:
    
    YAPI_Exception - on error
  - get_lastMsg
```
public String get_lastMsg()
                   throws YAPI_Exception
```
    Returns the latest message fully received.
    
    Returns:
    
    a string corresponding to the latest message fully received
    
    Throws:
    
    YAPI_Exception - on error
  - getLastMsg
```
public String getLastMsg()
                  throws YAPI_Exception
```
    Returns the latest message fully received.
    
    Returns:
    
    a string corresponding to the latest message fully received
    
    Throws:
    
    YAPI_Exception - on error
  - get_currentJob
```
public String get_currentJob()
                      throws YAPI_Exception
```
    Returns the name of the job file currently in use.
    
    Returns:
    
    a string corresponding to the name of the job file currently in use
    
    Throws:
    
    YAPI_Exception - on error
  - getCurrentJob
```
public String getCurrentJob()
                     throws YAPI_Exception
```
    Returns the name of the job file currently in use.
    
    Returns:
    
    a string corresponding to the name of the job file currently in use
    
    Throws:
    
    YAPI_Exception - on error
  - set_currentJob
```
public int set_currentJob(String newval)
                   throws YAPI_Exception
```
    Selects a job file to run immediately. If an empty string is given as argument, stops running current job file.
    
    Parameters:
    
    newval - : a string
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setCurrentJob
```
public int setCurrentJob(String newval)
                  throws YAPI_Exception
```
    Selects a job file to run immediately. If an empty string is given as argument, stops running current job file.
    
    Parameters:
    
    newval - : a string
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_startupJob
```
public String get_startupJob()
                      throws YAPI_Exception
```
    Returns the job file to use when the device is powered on.
    
    Returns:
    
    a string corresponding to the job file to use when the device is powered on
    
    Throws:
    
    YAPI_Exception - on error
  - getStartupJob
```
public String getStartupJob()
                     throws YAPI_Exception
```
    Returns the job file to use when the device is powered on.
    
    Returns:
    
    a string corresponding to the job file to use when the device is powered on
    
    Throws:
    
    YAPI_Exception - on error
  - set_startupJob
```
public int set_startupJob(String newval)
                   throws YAPI_Exception
```
    Changes the job to use when the device is powered on. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a string corresponding to the job to use when the device is powered on
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setStartupJob
```
public int setStartupJob(String newval)
                  throws YAPI_Exception
```
    Changes the job to use when the device is powered on. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a string corresponding to the job to use when the device is powered on
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_jobMaxTask
```
public int get_jobMaxTask()
                   throws YAPI_Exception
```
    Returns the maximum number of tasks in a job that the device can handle.
    
    Returns:
    
    an integer corresponding to the maximum number of tasks in a job that the device can handle
    
    Throws:
    
    YAPI_Exception - on error
  - getJobMaxTask
```
public int getJobMaxTask()
                  throws YAPI_Exception
```
    Returns the maximum number of tasks in a job that the device can handle.
    
    Returns:
    
    an integer corresponding to the maximum number of tasks in a job that the device can handle
    
    Throws:
    
    YAPI_Exception - on error
  - get_jobMaxSize
```
public int get_jobMaxSize()
                   throws YAPI_Exception
```
    Returns maximum size allowed for job files.
    
    Returns:
    
    an integer corresponding to maximum size allowed for job files
    
    Throws:
    
    YAPI_Exception - on error
  - getJobMaxSize
```
public int getJobMaxSize()
                  throws YAPI_Exception
```
    Returns maximum size allowed for job files.
    
    Returns:
    
    an integer corresponding to maximum size allowed for job files
    
    Throws:
    
    YAPI_Exception - on error
  - get_command
```
public String get_command()
                   throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - set_command
```
public int set_command(String newval)
                throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - get_protocol
```
public String get_protocol()
                    throws YAPI_Exception
```
    Returns the type of protocol used over the serial line, as a string. Possible values are "Line" for ASCII messages separated by CR and/or LF, "Frame:[timeout]ms" for binary messages separated by a delay time, "Char" for a continuous ASCII stream or "Byte" for a continuous binary stream.
    
    Returns:
    
    a string corresponding to the type of protocol used over the serial line, as a string
    
    Throws:
    
    YAPI_Exception - on error
  - getProtocol
```
public String getProtocol()
                   throws YAPI_Exception
```
    Returns the type of protocol used over the serial line, as a string. Possible values are "Line" for ASCII messages separated by CR and/or LF, "Frame:[timeout]ms" for binary messages separated by a delay time, "Char" for a continuous ASCII stream or "Byte" for a continuous binary stream.
    
    Returns:
    
    a string corresponding to the type of protocol used over the serial line, as a string
    
    Throws:
    
    YAPI_Exception - on error
  - set_protocol
```
public int set_protocol(String newval)
                 throws YAPI_Exception
```
    Changes the type of protocol used over the serial line. Possible values are "Line" for ASCII messages separated by CR and/or LF, "Frame:[timeout]ms" for binary messages separated by a delay time, "Char" for a continuous ASCII stream or "Byte" for a continuous binary stream. The suffix "/[wait]ms" can be added to reduce the transmit rate so that there is always at lest the specified number of milliseconds between each bytes sent. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a string corresponding to the type of protocol used over the serial line
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setProtocol
```
public int setProtocol(String newval)
                throws YAPI_Exception
```
    Changes the type of protocol used over the serial line. Possible values are "Line" for ASCII messages separated by CR and/or LF, "Frame:[timeout]ms" for binary messages separated by a delay time, "Char" for a continuous ASCII stream or "Byte" for a continuous binary stream. The suffix "/[wait]ms" can be added to reduce the transmit rate so that there is always at lest the specified number of milliseconds between each bytes sent. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a string corresponding to the type of protocol used over the serial line
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_voltageLevel
```
public int get_voltageLevel()
                     throws YAPI_Exception
```
    Returns the voltage level used on the serial line.
    
    Returns:
    
    a value among YSdi12Port.VOLTAGELEVEL_OFF, YSdi12Port.VOLTAGELEVEL_TTL3V, YSdi12Port.VOLTAGELEVEL_TTL3VR, YSdi12Port.VOLTAGELEVEL_TTL5V, YSdi12Port.VOLTAGELEVEL_TTL5VR, YSdi12Port.VOLTAGELEVEL_RS232, YSdi12Port.VOLTAGELEVEL_RS485, YSdi12Port.VOLTAGELEVEL_TTL1V8 and YSdi12Port.VOLTAGELEVEL_SDI12 corresponding to the voltage level used on the serial line
    
    Throws:
    
    YAPI_Exception - on error
  - getVoltageLevel
```
public int getVoltageLevel()
                    throws YAPI_Exception
```
    Returns the voltage level used on the serial line.
    
    Returns:
    
    a value among YSdi12Port.VOLTAGELEVEL_OFF, YSdi12Port.VOLTAGELEVEL_TTL3V, YSdi12Port.VOLTAGELEVEL_TTL3VR, YSdi12Port.VOLTAGELEVEL_TTL5V, YSdi12Port.VOLTAGELEVEL_TTL5VR, YSdi12Port.VOLTAGELEVEL_RS232, YSdi12Port.VOLTAGELEVEL_RS485, YSdi12Port.VOLTAGELEVEL_TTL1V8 and YSdi12Port.VOLTAGELEVEL_SDI12 corresponding to the voltage level used on the serial line
    
    Throws:
    
    YAPI_Exception - on error
  - set_voltageLevel
```
public int set_voltageLevel(int newval)
                     throws YAPI_Exception
```
    Changes the voltage type used on the serial line. Valid values will depend on the Yoctopuce device model featuring the serial port feature. Check your device documentation to find out which values are valid for that specific model. Trying to set an invalid value will have no effect. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a value among YSdi12Port.VOLTAGELEVEL_OFF, YSdi12Port.VOLTAGELEVEL_TTL3V, YSdi12Port.VOLTAGELEVEL_TTL3VR, YSdi12Port.VOLTAGELEVEL_TTL5V, YSdi12Port.VOLTAGELEVEL_TTL5VR, YSdi12Port.VOLTAGELEVEL_RS232, YSdi12Port.VOLTAGELEVEL_RS485, YSdi12Port.VOLTAGELEVEL_TTL1V8 and YSdi12Port.VOLTAGELEVEL_SDI12 corresponding to the voltage type used on the serial line
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setVoltageLevel
```
public int setVoltageLevel(int newval)
                    throws YAPI_Exception
```
    Changes the voltage type used on the serial line. Valid values will depend on the Yoctopuce device model featuring the serial port feature. Check your device documentation to find out which values are valid for that specific model. Trying to set an invalid value will have no effect. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a value among YSdi12Port.VOLTAGELEVEL_OFF, YSdi12Port.VOLTAGELEVEL_TTL3V, YSdi12Port.VOLTAGELEVEL_TTL3VR, YSdi12Port.VOLTAGELEVEL_TTL5V, YSdi12Port.VOLTAGELEVEL_TTL5VR, YSdi12Port.VOLTAGELEVEL_RS232, YSdi12Port.VOLTAGELEVEL_RS485, YSdi12Port.VOLTAGELEVEL_TTL1V8 and YSdi12Port.VOLTAGELEVEL_SDI12 corresponding to the voltage type used on the serial line
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_serialMode
```
public String get_serialMode()
                      throws YAPI_Exception
```
    Returns the serial port communication parameters, as a string such as "1200,7E1,Simplex". The string includes the baud rate, the number of data bits, the parity, and the number of stop bits. The suffix "Simplex" denotes the fact that transmission in both directions is multiplexed on the same transmission line.
    
    Returns:
    
    a string corresponding to the serial port communication parameters, as a string such as "1200,7E1,Simplex"
    
    Throws:
    
    YAPI_Exception - on error
  - getSerialMode
```
public String getSerialMode()
                     throws YAPI_Exception
```
    Returns the serial port communication parameters, as a string such as "1200,7E1,Simplex". The string includes the baud rate, the number of data bits, the parity, and the number of stop bits. The suffix "Simplex" denotes the fact that transmission in both directions is multiplexed on the same transmission line.
    
    Returns:
    
    a string corresponding to the serial port communication parameters, as a string such as "1200,7E1,Simplex"
    
    Throws:
    
    YAPI_Exception - on error
  - set_serialMode
```
public int set_serialMode(String newval)
                   throws YAPI_Exception
```
    Changes the serial port communication parameters, with a string such as "1200,7E1,Simplex". The string includes the baud rate, the number of data bits, the parity, and the number of stop bits. The suffix "Simplex" denotes the fact that transmission in both directions is multiplexed on the same transmission line. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a string corresponding to the serial port communication parameters, with a string such as "1200,7E1,Simplex"
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setSerialMode
```
public int setSerialMode(String newval)
                  throws YAPI_Exception
```
    Changes the serial port communication parameters, with a string such as "1200,7E1,Simplex". The string includes the baud rate, the number of data bits, the parity, and the number of stop bits. The suffix "Simplex" denotes the fact that transmission in both directions is multiplexed on the same transmission line. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a string corresponding to the serial port communication parameters, with a string such as "1200,7E1,Simplex"
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - FindSdi12Port
```
public static YSdi12Port FindSdi12Port(String func)
```
    Retrieves an SDI12 port for a given identifier. The identifier can be specified using several formats:
    - FunctionLogicalName
    - ModuleSerialNumber.FunctionIdentifier
    - ModuleSerialNumber.FunctionLogicalName
    - ModuleLogicalName.FunctionIdentifier
    - ModuleLogicalName.FunctionLogicalName
    This function does not require that the SDI12 port is online at the time it is invoked. The returned object is nevertheless valid. Use the method YSdi12Port.isOnline() to test if the SDI12 port is indeed online at a given time. In case of ambiguity when looking for an SDI12 port by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name. If a call to this object's is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.
    Parameters:
    
    func - : a string that uniquely characterizes the SDI12 port, for instance MyDevice.sdi12Port.
    
    Returns:
    
    a YSdi12Port object allowing you to drive the SDI12 port.
  - FindSdi12PortInContext
```
public static YSdi12Port FindSdi12PortInContext(YAPIContext yctx,
                                                String func)
```
    Retrieves an SDI12 port for a given identifier in a YAPI context. The identifier can be specified using several formats:
    - FunctionLogicalName
    - ModuleSerialNumber.FunctionIdentifier
    - ModuleSerialNumber.FunctionLogicalName
    - ModuleLogicalName.FunctionIdentifier
    - ModuleLogicalName.FunctionLogicalName
    This function does not require that the SDI12 port is online at the time it is invoked. The returned object is nevertheless valid. Use the method YSdi12Port.isOnline() to test if the SDI12 port is indeed online at a given time. In case of ambiguity when looking for an SDI12 port by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.
    Parameters:
    
    yctx - : a YAPI context
    
    func - : a string that uniquely characterizes the SDI12 port, for instance MyDevice.sdi12Port.
    
    Returns:
    
    a YSdi12Port object allowing you to drive the SDI12 port.
  - registerValueCallback
```
public int registerValueCallback(YSdi12Port.UpdateCallback callback)
```
    Registers the callback function that is invoked on every change of advertised value. The callback is invoked only during the execution of ySleep or yHandleEvents. This provides control over the time when the callback is triggered. For good responsiveness, remember to call one of these two functions periodically. To unregister a callback, pass a null pointer as argument.
    
    Parameters:
    
    callback - : the callback function to call, or a null pointer. The callback function should take two arguments: the function object of which the value has changed, and the character string describing the new advertised value.
  - _invokeValueCallback
```
public int _invokeValueCallback(String value)
```
    Overrides:
    
    _invokeValueCallback in class YFunction
  - sendCommand
```
public int sendCommand(String text)
                throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - readLine
```
public String readLine()
                throws YAPI_Exception
```
    Reads a single line (or message) from the receive buffer, starting at current stream position. This function is intended to be used when the serial port is configured for a message protocol, such as 'Line' mode or frame protocols. If data at current stream position is not available anymore in the receive buffer, the function returns the oldest available line and moves the stream position just after. If no new full line is received, the function returns an empty line.
    
    Returns:
    
    a string with a single line of text
    
    Throws:
    
    YAPI_Exception - on error
  - readMessages
```
public ArrayList<String> readMessages(String pattern,
                                      int maxWait)
                               throws YAPI_Exception
```
    Searches for incoming messages in the serial port receive buffer matching a given pattern, starting at current position. This function will only compare and return printable characters in the message strings. Binary protocols are handled as hexadecimal strings. The search returns all messages matching the expression provided as argument in the buffer. If no matching message is found, the search waits for one up to the specified maximum timeout (in milliseconds).
    
    Parameters:
    
    pattern - : a limited regular expression describing the expected message format, or an empty string if all messages should be returned (no filtering). When using binary protocols, the format applies to the hexadecimal representation of the message.
    
    maxWait - : the maximum number of milliseconds to wait for a message if none is found in the receive buffer.
    
    Returns:
    
    an array of strings containing the messages found, if any. Binary messages are converted to hexadecimal representation.
    
    Throws:
    
    YAPI_Exception - on error
  - read_seek
```
public int read_seek(int absPos)
```
    Changes the current internal stream position to the specified value. This function does not affect the device, it only changes the value stored in the API object for the next read operations.
    
    Parameters:
    
    absPos - : the absolute position index for next read operations.
    
    Returns:
    
    nothing.
  - read_tell
```
public int read_tell()
```
    Returns the current absolute stream position pointer of the API object.
    
    Returns:
    
    the absolute position index for next read operations.
  - read_avail
```
public int read_avail()
               throws YAPI_Exception
```
    Returns the number of bytes available to read in the input buffer starting from the current absolute stream position pointer of the API object.
    
    Returns:
    
    the number of bytes available to read
    
    Throws:
    
    YAPI_Exception
  - end_tell
```
public int end_tell()
             throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - queryLine
```
public String queryLine(String query,
                        int maxWait)
                 throws YAPI_Exception
```
    Sends a text line query to the serial port, and reads the reply, if any. This function is intended to be used when the serial port is configured for 'Line' protocol.
    
    Parameters:
    
    query - : the line query to send (without CR/LF)
    
    maxWait - : the maximum number of milliseconds to wait for a reply.
    
    Returns:
    
    the next text line received after sending the text query, as a string. Additional lines can be obtained by calling readLine or readMessages.
    
    Throws:
    
    YAPI_Exception - on error
  - queryHex
```
public String queryHex(String hexString,
                       int maxWait)
                throws YAPI_Exception
```
    Sends a binary message to the serial port, and reads the reply, if any. This function is intended to be used when the serial port is configured for Frame-based protocol.
    
    Parameters:
    
    hexString - : the message to send, coded in hexadecimal
    
    maxWait - : the maximum number of milliseconds to wait for a reply.
    
    Returns:
    
    the next frame received after sending the message, as a hex string. Additional frames can be obtained by calling readHex or readMessages.
    
    Throws:
    
    YAPI_Exception - on error
  - uploadJob
```
public int uploadJob(String jobfile,
                     String jsonDef)
              throws YAPI_Exception
```
    Saves the job definition string (JSON data) into a job file. The job file can be later enabled using selectJob().
    
    Parameters:
    
    jobfile - : name of the job file to save on the device filesystem
    
    jsonDef - : a string containing a JSON definition of the job
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - selectJob
```
public int selectJob(String jobfile)
              throws YAPI_Exception
```
    Load and start processing the specified job file. The file must have been previously created using the user interface or uploaded on the device filesystem using the uploadJob() function.
    
    Parameters:
    
    jobfile - : name of the job file (on the device filesystem)
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - reset
```
public int reset()
          throws YAPI_Exception
```
    Clears the serial port buffer and resets counters to zero.
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - writeByte
```
public int writeByte(int code)
              throws YAPI_Exception
```
    Sends a single byte to the serial port.
    
    Parameters:
    
    code - : the byte to send
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - writeStr
```
public int writeStr(String text)
             throws YAPI_Exception
```
    Sends an ASCII string to the serial port, as is.
    
    Parameters:
    
    text - : the text string to send
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - writeBin
```
public int writeBin(byte[] buff)
             throws YAPI_Exception
```
    Sends a binary buffer to the serial port, as is.
    
    Parameters:
    
    buff - : the binary buffer to send
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - writeArray
```
public int writeArray(ArrayList<Integer> byteList)
               throws YAPI_Exception
```
    Sends a byte sequence (provided as a list of bytes) to the serial port.
    
    Parameters:
    
    byteList - : a list of byte codes
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - writeHex
```
public int writeHex(String hexString)
             throws YAPI_Exception
```
    Sends a byte sequence (provided as a hexadecimal string) to the serial port.
    
    Parameters:
    
    hexString - : a string of hexadecimal byte codes
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - writeLine
```
public int writeLine(String text)
              throws YAPI_Exception
```
    Sends an ASCII string to the serial port, followed by a line break (CR LF).
    
    Parameters:
    
    text - : the text string to send
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - readByte
```
public int readByte()
             throws YAPI_Exception
```
    Reads one byte from the receive buffer, starting at current stream position. If data at current stream position is not available anymore in the receive buffer, or if there is no data available yet, the function returns YAPI.NO_MORE_DATA.
    
    Returns:
    
    the next byte
    
    Throws:
    
    YAPI_Exception - on error
  - readStr
```
public String readStr(int nChars)
               throws YAPI_Exception
```
    Reads data from the receive buffer as a string, starting at current stream position. If data at current stream position is not available anymore in the receive buffer, the function performs a short read.
    
    Parameters:
    
    nChars - : the maximum number of characters to read
    
    Returns:
    
    a string with receive buffer contents
    
    Throws:
    
    YAPI_Exception - on error
  - readBin
```
public byte[] readBin(int nChars)
               throws YAPI_Exception
```
    Reads data from the receive buffer as a binary buffer, starting at current stream position. If data at current stream position is not available anymore in the receive buffer, the function performs a short read.
    
    Parameters:
    
    nChars - : the maximum number of bytes to read
    
    Returns:
    
    a binary object with receive buffer contents
    
    Throws:
    
    YAPI_Exception - on error
  - readArray
```
public ArrayList<Integer> readArray(int nChars)
                             throws YAPI_Exception
```
    Reads data from the receive buffer as a list of bytes, starting at current stream position. If data at current stream position is not available anymore in the receive buffer, the function performs a short read.
    
    Parameters:
    
    nChars - : the maximum number of bytes to read
    
    Returns:
    
    a sequence of bytes with receive buffer contents
    
    Throws:
    
    YAPI_Exception - on error
  - readHex
```
public String readHex(int nBytes)
               throws YAPI_Exception
```
    Reads data from the receive buffer as a hexadecimal string, starting at current stream position. If data at current stream position is not available anymore in the receive buffer, the function performs a short read.
    
    Parameters:
    
    nBytes - : the maximum number of bytes to read
    
    Returns:
    
    a string with receive buffer contents, encoded in hexadecimal
    
    Throws:
    
    YAPI_Exception - on error
  - querySdi12
```
public String querySdi12(String sensorAddr,
                         String cmd,
                         int maxWait)
                  throws YAPI_Exception
```
    Sends a SDI-12 query to the bus, and reads the sensor immediate reply. This function is intended to be used when the serial port is configured for 'SDI-12' protocol.
    
    Parameters:
    
    sensorAddr - : the sensor address, as a string
    
    cmd - : the SDI12 query to send (without address and exclamation point)
    
    maxWait - : the maximum timeout to wait for a reply from sensor, in millisecond
    
    Returns:
    
    the reply returned by the sensor, without newline, as a string.
    
    Throws:
    
    YAPI_Exception - on error
  - discoverSingleSensor
```
public YSdi12SensorInfo discoverSingleSensor()
                                      throws YAPI_Exception
```
    Sends a discovery command to the bus, and reads the sensor information reply. This function is intended to be used when the serial port is configured for 'SDI-12' protocol. This function work when only one sensor is connected.
    
    Returns:
    
    the reply returned by the sensor, as a YSdi12SensorInfo object.
    
    Throws:
    
    YAPI_Exception - on error
  - discoverAllSensors
```
public ArrayList<YSdi12SensorInfo> discoverAllSensors()
                                               throws YAPI_Exception
```
    Sends a discovery command to the bus, and reads all sensors information reply. This function is intended to be used when the serial port is configured for 'SDI-12' protocol.
    
    Returns:
    
    all the information from every connected sensor, as an array of YSdi12SensorInfo object.
    
    Throws:
    
    YAPI_Exception - on error
  - readSensor
```
public ArrayList<Double> readSensor(String sensorAddr,
                                    String measCmd,
                                    int maxWait)
                             throws YAPI_Exception
```
    Sends a mesurement command to the SDI-12 bus, and reads the sensor immediate reply. The supported commands are: M: Measurement start control M1...M9: Additional measurement start command D: Measurement reading control This function is intended to be used when the serial port is configured for 'SDI-12' protocol.
    
    Parameters:
    
    sensorAddr - : the sensor address, as a string
    
    measCmd - : the SDI12 query to send (without address and exclamation point)
    
    maxWait - : the maximum timeout to wait for a reply from sensor, in millisecond
    
    Returns:
    
    the reply returned by the sensor, without newline, as a list of float.
    
    Throws:
    
    YAPI_Exception - on error
  - changeAddress
```
public YSdi12SensorInfo changeAddress(String oldAddress,
                                      String newAddress)
                               throws YAPI_Exception
```
    Changes the address of the selected sensor, and returns the sensor information with the new address. This function is intended to be used when the serial port is configured for 'SDI-12' protocol.
    
    Parameters:
    
    oldAddress - : Actual sensor address, as a string
    
    newAddress - : New sensor address, as a string
    
    Returns:
    
    the sensor address and information , as a YSdi12SensorInfo object.
    
    Throws:
    
    YAPI_Exception - on error
  - getSensorInformation
```
public YSdi12SensorInfo getSensorInformation(String sensorAddr)
                                      throws YAPI_Exception
```
    Sends a information command to the bus, and reads sensors information selected. This function is intended to be used when the serial port is configured for 'SDI-12' protocol.
    
    Parameters:
    
    sensorAddr - : Sensor address, as a string
    
    Returns:
    
    the reply returned by the sensor, as a YSdi12Port object.
    
    Throws:
    
    YAPI_Exception - on error
  - readConcurrentMeasurements
```
public ArrayList<Double> readConcurrentMeasurements(String sensorAddr)
                                             throws YAPI_Exception
```
    Sends a information command to the bus, and reads sensors information selected. This function is intended to be used when the serial port is configured for 'SDI-12' protocol.
    
    Parameters:
    
    sensorAddr - : Sensor address, as a string
    
    Returns:
    
    the reply returned by the sensor, as a YSdi12Port object.
    
    Throws:
    
    YAPI_Exception - on error
  - requestConcurrentMeasurements
```
public int requestConcurrentMeasurements(String sensorAddr)
                                  throws YAPI_Exception
```
    Sends a information command to the bus, and reads sensors information selected. This function is intended to be used when the serial port is configured for 'SDI-12' protocol.
    
    Parameters:
    
    sensorAddr - : Sensor address, as a string
    
    Returns:
    
    the reply returned by the sensor, as a YSdi12Port object.
    
    Throws:
    
    YAPI_Exception - on error
  - snoopMessagesEx
```
public ArrayList<YSdi12SnoopingRecord> snoopMessagesEx(int maxWait,
                                                       int maxMsg)
                                                throws YAPI_Exception
```
    Retrieves messages (both direction) in the SDI12 port buffer, starting at current position. If no message is found, the search waits for one up to the specified maximum timeout (in milliseconds).
    
    Parameters:
    
    maxWait - : the maximum number of milliseconds to wait for a message if none is found in the receive buffer.
    
    maxMsg - : the maximum number of messages to be returned by the function; up to 254.
    
    Returns:
    
    an array of YSdi12SnoopingRecord objects containing the messages found, if any.
    
    Throws:
    
    YAPI_Exception - on error
  - snoopMessages
```
public ArrayList<YSdi12SnoopingRecord> snoopMessages(int maxWait)
                                              throws YAPI_Exception
```
    Retrieves messages (both direction) in the SDI12 port buffer, starting at current position. If no message is found, the search waits for one up to the specified maximum timeout (in milliseconds).
    
    Parameters:
    
    maxWait - : the maximum number of milliseconds to wait for a message if none is found in the receive buffer.
    
    Returns:
    
    an array of YSdi12SnoopingRecord objects containing the messages found, if any.
    
    Throws:
    
    YAPI_Exception - on error
  - nextSdi12Port
```
public YSdi12Port nextSdi12Port()
```
    Continues the enumeration of SDI12 ports started using yFirstSdi12Port(). Caution: You can't make any assumption about the returned SDI12 ports order. If you want to find a specific an SDI12 port, use Sdi12Port.findSdi12Port() and a hardwareID or a logical name.
    
    Returns:
    
    a pointer to a YSdi12Port object, corresponding to an SDI12 port currently online, or a null pointer if there are no more SDI12 ports to enumerate.
  - FirstSdi12Port
```
public static YSdi12Port FirstSdi12Port()
```
    Starts the enumeration of SDI12 ports currently accessible. Use the method YSdi12Port.nextSdi12Port() to iterate on next SDI12 ports.
    
    Returns:
    
    a pointer to a YSdi12Port object, corresponding to the first SDI12 port currently online, or a null pointer if there are none.
  - FirstSdi12PortInContext
```
public static YSdi12Port FirstSdi12PortInContext(YAPIContext yctx)
```
    Starts the enumeration of SDI12 ports currently accessible. Use the method YSdi12Port.nextSdi12Port() to iterate on next SDI12 ports.
    
    Parameters:
    
    yctx - : a YAPI context.
    
    Returns:
    
    a pointer to a YSdi12Port object, corresponding to the first SDI12 port currently online, or a null pointer if there are none.

Class YSdi12Port

Nested Class Summary

Field Summary

Fields inherited from class com.yoctopuce.YoctoAPI.YFunction

Constructor Summary

Method Summary

Methods inherited from class com.yoctopuce.YoctoAPI.YFunction

Methods inherited from class java.lang.Object

Field Detail

RXCOUNT_INVALID

TXCOUNT_INVALID

ERRCOUNT_INVALID

RXMSGCOUNT_INVALID

TXMSGCOUNT_INVALID

LASTMSG_INVALID

CURRENTJOB_INVALID

STARTUPJOB_INVALID

JOBMAXTASK_INVALID

JOBMAXSIZE_INVALID

COMMAND_INVALID

PROTOCOL_INVALID

VOLTAGELEVEL_OFF

VOLTAGELEVEL_TTL3V

VOLTAGELEVEL_TTL3VR

VOLTAGELEVEL_TTL5V

VOLTAGELEVEL_TTL5VR

VOLTAGELEVEL_RS232

VOLTAGELEVEL_RS485

VOLTAGELEVEL_TTL1V8

VOLTAGELEVEL_SDI12

VOLTAGELEVEL_INVALID

SERIALMODE_INVALID

_rxCount

_txCount

_errCount

_rxMsgCount

_txMsgCount

_lastMsg

_currentJob

_startupJob

_jobMaxTask

_jobMaxSize

_command

_protocol

_voltageLevel

_serialMode

_valueCallbackSdi12Port

_rxptr

_rxbuff

_rxbuffptr

_eventPos

Constructor Detail

YSdi12Port

YSdi12Port

Method Detail

_parseAttr

get_rxCount

getRxCount

get_txCount

getTxCount

get_errCount

getErrCount

get_rxMsgCount

getRxMsgCount

get_txMsgCount

getTxMsgCount

get_lastMsg

getLastMsg

get_currentJob

getCurrentJob

set_currentJob

setCurrentJob

get_startupJob

getStartupJob

set_startupJob

setStartupJob

get_jobMaxTask

getJobMaxTask

get_jobMaxSize

getJobMaxSize