/********************************************************************* * * $Id: yocto_sdi12port.ts 54279 2023-04-28 10:11:03Z seb $ * * Implements the high-level API for Sdi12SnoopingRecord functions * * - - - - - - - - - License information: - - - - - - - - - * * Copyright (C) 2011 and beyond by Yoctopuce Sarl, Switzerland. * * Yoctopuce Sarl (hereafter Licensor) grants to you a perpetual * non-exclusive license to use, modify, copy and integrate this * file into your software for the sole purpose of interfacing * with Yoctopuce products. * * You may reproduce and distribute copies of this file in * source or object form, as long as the sole purpose of this * code is to interface with Yoctopuce products. You must retain * this notice in the distributed source file. * * You should refer to Yoctopuce General Terms and Conditions * for additional information regarding your rights and * obligations. * * THE SOFTWARE AND DOCUMENTATION ARE PROVIDED 'AS IS' WITHOUT * WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING * WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY, FITNESS * FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO * EVENT SHALL LICENSOR BE LIABLE FOR ANY INCIDENTAL, SPECIAL, * INDIRECT OR CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA, * COST OF PROCUREMENT OF SUBSTITUTE GOODS, TECHNOLOGY OR * SERVICES, ANY CLAIMS BY THIRD PARTIES (INCLUDING BUT NOT * LIMITED TO ANY DEFENSE THEREOF), ANY CLAIMS FOR INDEMNITY OR * CONTRIBUTION, OR OTHER SIMILAR COSTS, WHETHER ASSERTED ON THE * BASIS OF CONTRACT, TORT (INCLUDING NEGLIGENCE), BREACH OF * WARRANTY, OR OTHERWISE. * *********************************************************************/ import { YAPIContext, YFunction } from './yocto_api.js'; /** * YSdi12SnoopingRecord Class: Intercepted SDI12 message description, returned by sdi12Port.snoopMessages method * * */ export declare class YSdi12SnoopingRecord { _tim: number; _pos: number; _dir: number; _msg: string; constructor(str_json: string); /** * Returns the elapsed time, in ms, since the beginning of the preceding message. * * @return the elapsed time, in ms, since the beginning of the preceding message. */ get_time(): number; /** * Returns the absolute position of the message end. * * @return the absolute position of the message end. */ get_pos(): number; /** * Returns the message direction (RX=0, TX=1). * * @return the message direction (RX=0, TX=1). */ get_direction(): number; /** * Returns the message content. * * @return the message content. */ get_message(): string; } export declare namespace YSdi12SnoopingRecord { } /** * 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. */ /** @extends {YFunction} **/ export declare class YSdi12SensorInfo { _sdi12Port: YSdi12Port; _isValid: boolean; _addr: string; _proto: string; _mfg: string; _model: string; _ver: string; _sn: string; _valuesDesc: string[][]; constructor(sdi12Port: YSdi12Port, str_json: string); _throw(errcode: number, msg: string, retVal?: any): any; /** * Returns the sensor state. * * @return the sensor state. */ isValid(): Promise; /** * Returns the sensor address. * * @return the sensor address. */ get_sensorAddress(): Promise; /** * Returns the compatible SDI-12 version of the sensor. * * @return the compatible SDI-12 version of the sensor. */ get_sensorProtocol(): Promise; /** * Returns the sensor vendor identification. * * @return the sensor vendor identification. */ get_sensorVendor(): Promise; /** * Returns the sensor model number. * * @return the sensor model number. */ get_sensorModel(): Promise; /** * Returns the sensor version. * * @return the sensor version. */ get_sensorVersion(): Promise; /** * Returns the sensor serial number. * * @return the sensor serial number. */ get_sensorSerial(): Promise; /** * Returns the number of sensor measurements. * This function only works if the sensor is in version 1.4 SDI-12 * and supports metadata commands. * * @return the number of sensor measurements. */ get_measureCount(): Promise; /** * Returns the sensor measurement command. * This function only works if the sensor is in version 1.4 SDI-12 * and supports metadata commands. * * @param measureIndex : measurement index * * @return the sensor measurement command. * On failure, throws an exception or returns an empty string. */ get_measureCommand(measureIndex: number): Promise; /** * Returns sensor measurement position. * This function only works if the sensor is in version 1.4 SDI-12 * and supports metadata commands. * * @param measureIndex : measurement index * * @return the sensor measurement command. * On failure, throws an exception or returns 0. */ get_measurePosition(measureIndex: number): Promise; /** * Returns the measured value symbol. * This function only works if the sensor is in version 1.4 SDI-12 * and supports metadata commands. * * @param measureIndex : measurement index * * @return the sensor measurement command. * On failure, throws an exception or returns an empty string. */ get_measureSymbol(measureIndex: number): Promise; /** * Returns the unit of the measured value. * This function only works if the sensor is in version 1.4 SDI-12 * and supports metadata commands. * * @param measureIndex : measurement index * * @return the sensor measurement command. * On failure, throws an exception or returns an empty string. */ get_measureUnit(measureIndex: number): Promise; /** * Returns the description of the measured value. * This function only works if the sensor is in version 1.4 SDI-12 * and supports metadata commands. * * @param measureIndex : measurement index * * @return the sensor measurement command. * On failure, throws an exception or returns an empty string. */ get_measureDescription(measureIndex: number): Promise; get_typeMeasure(): Promise; imm_parseInfoStr(infoStr: string): void; _queryValueInfo(): Promise; } export declare namespace YSdi12SensorInfo { } /** * 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. */ /** @extends {YFunction} **/ export declare class YSdi12Port extends YFunction { _className: string; _rxCount: number; _txCount: number; _errCount: number; _rxMsgCount: number; _txMsgCount: number; _lastMsg: string; _currentJob: string; _startupJob: string; _jobMaxTask: number; _jobMaxSize: number; _command: string; _protocol: string; _voltageLevel: YSdi12Port.VOLTAGELEVEL; _serialMode: string; _valueCallbackSdi12Port: YSdi12Port.ValueCallback | null; _rxptr: number; _rxbuff: Uint8Array; _rxbuffptr: number; _eventPos: number; readonly RXCOUNT_INVALID: number; readonly TXCOUNT_INVALID: number; readonly ERRCOUNT_INVALID: number; readonly RXMSGCOUNT_INVALID: number; readonly TXMSGCOUNT_INVALID: number; readonly LASTMSG_INVALID: string; readonly CURRENTJOB_INVALID: string; readonly STARTUPJOB_INVALID: string; readonly JOBMAXTASK_INVALID: number; readonly JOBMAXSIZE_INVALID: number; readonly COMMAND_INVALID: string; readonly PROTOCOL_INVALID: string; readonly VOLTAGELEVEL_OFF: YSdi12Port.VOLTAGELEVEL; readonly VOLTAGELEVEL_TTL3V: YSdi12Port.VOLTAGELEVEL; readonly VOLTAGELEVEL_TTL3VR: YSdi12Port.VOLTAGELEVEL; readonly VOLTAGELEVEL_TTL5V: YSdi12Port.VOLTAGELEVEL; readonly VOLTAGELEVEL_TTL5VR: YSdi12Port.VOLTAGELEVEL; readonly VOLTAGELEVEL_RS232: YSdi12Port.VOLTAGELEVEL; readonly VOLTAGELEVEL_RS485: YSdi12Port.VOLTAGELEVEL; readonly VOLTAGELEVEL_TTL1V8: YSdi12Port.VOLTAGELEVEL; readonly VOLTAGELEVEL_SDI12: YSdi12Port.VOLTAGELEVEL; readonly VOLTAGELEVEL_INVALID: YSdi12Port.VOLTAGELEVEL; readonly SERIALMODE_INVALID: string; static readonly RXCOUNT_INVALID: number; static readonly TXCOUNT_INVALID: number; static readonly ERRCOUNT_INVALID: number; static readonly RXMSGCOUNT_INVALID: number; static readonly TXMSGCOUNT_INVALID: number; static readonly LASTMSG_INVALID: string; static readonly CURRENTJOB_INVALID: string; static readonly STARTUPJOB_INVALID: string; static readonly JOBMAXTASK_INVALID: number; static readonly JOBMAXSIZE_INVALID: number; static readonly COMMAND_INVALID: string; static readonly PROTOCOL_INVALID: string; static readonly VOLTAGELEVEL_OFF: YSdi12Port.VOLTAGELEVEL; static readonly VOLTAGELEVEL_TTL3V: YSdi12Port.VOLTAGELEVEL; static readonly VOLTAGELEVEL_TTL3VR: YSdi12Port.VOLTAGELEVEL; static readonly VOLTAGELEVEL_TTL5V: YSdi12Port.VOLTAGELEVEL; static readonly VOLTAGELEVEL_TTL5VR: YSdi12Port.VOLTAGELEVEL; static readonly VOLTAGELEVEL_RS232: YSdi12Port.VOLTAGELEVEL; static readonly VOLTAGELEVEL_RS485: YSdi12Port.VOLTAGELEVEL; static readonly VOLTAGELEVEL_TTL1V8: YSdi12Port.VOLTAGELEVEL; static readonly VOLTAGELEVEL_SDI12: YSdi12Port.VOLTAGELEVEL; static readonly VOLTAGELEVEL_INVALID: YSdi12Port.VOLTAGELEVEL; static readonly SERIALMODE_INVALID: string; constructor(yapi: YAPIContext, func: string); imm_parseAttr(name: string, val: any): number; /** * Returns the total number of bytes received since last reset. * * @return an integer corresponding to the total number of bytes received since last reset * * On failure, throws an exception or returns YSdi12Port.RXCOUNT_INVALID. */ get_rxCount(): Promise; /** * Returns the total number of bytes transmitted since last reset. * * @return an integer corresponding to the total number of bytes transmitted since last reset * * On failure, throws an exception or returns YSdi12Port.TXCOUNT_INVALID. */ get_txCount(): Promise; /** * Returns the total number of communication errors detected since last reset. * * @return an integer corresponding to the total number of communication errors detected since last reset * * On failure, throws an exception or returns YSdi12Port.ERRCOUNT_INVALID. */ get_errCount(): Promise; /** * Returns the total number of messages received since last reset. * * @return an integer corresponding to the total number of messages received since last reset * * On failure, throws an exception or returns YSdi12Port.RXMSGCOUNT_INVALID. */ get_rxMsgCount(): Promise; /** * Returns the total number of messages send since last reset. * * @return an integer corresponding to the total number of messages send since last reset * * On failure, throws an exception or returns YSdi12Port.TXMSGCOUNT_INVALID. */ get_txMsgCount(): Promise; /** * Returns the latest message fully received. * * @return a string corresponding to the latest message fully received * * On failure, throws an exception or returns YSdi12Port.LASTMSG_INVALID. */ get_lastMsg(): Promise; /** * Returns the name of the job file currently in use. * * @return a string corresponding to the name of the job file currently in use * * On failure, throws an exception or returns YSdi12Port.CURRENTJOB_INVALID. */ get_currentJob(): Promise; /** * Selects a job file to run immediately. If an empty string is * given as argument, stops running current job file. * * @param newval : a string * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ set_currentJob(newval: string): Promise; /** * Returns the job file to use when the device is powered on. * * @return a string corresponding to the job file to use when the device is powered on * * On failure, throws an exception or returns YSdi12Port.STARTUPJOB_INVALID. */ get_startupJob(): Promise; /** * 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. * * @param newval : a string corresponding to the job to use when the device is powered on * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ set_startupJob(newval: string): Promise; /** * Returns the maximum number of tasks in a job that the device can handle. * * @return an integer corresponding to the maximum number of tasks in a job that the device can handle * * On failure, throws an exception or returns YSdi12Port.JOBMAXTASK_INVALID. */ get_jobMaxTask(): Promise; /** * Returns maximum size allowed for job files. * * @return an integer corresponding to maximum size allowed for job files * * On failure, throws an exception or returns YSdi12Port.JOBMAXSIZE_INVALID. */ get_jobMaxSize(): Promise; get_command(): Promise; set_command(newval: string): Promise; /** * 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. * * @return a string corresponding to the type of protocol used over the serial line, as a string * * On failure, throws an exception or returns YSdi12Port.PROTOCOL_INVALID. */ get_protocol(): Promise; /** * 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. * * @param newval : a string corresponding to the type of protocol used over the serial line * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ set_protocol(newval: string): Promise; /** * Returns the voltage level used on the serial line. * * @return 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 * * On failure, throws an exception or returns YSdi12Port.VOLTAGELEVEL_INVALID. */ get_voltageLevel(): Promise; /** * 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. * * @param 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 * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ set_voltageLevel(newval: YSdi12Port.VOLTAGELEVEL): Promise; /** * 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. * * @return a string corresponding to the serial port communication parameters, as a string such as * "1200,7E1,Simplex" * * On failure, throws an exception or returns YSdi12Port.SERIALMODE_INVALID. */ get_serialMode(): Promise; /** * 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. * * @param newval : a string corresponding to the serial port communication parameters, with a string such as * "1200,7E1,Simplex" * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ set_serialMode(newval: string): Promise; /** * 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. * * @param func : a string that uniquely characterizes the SDI12 port, for instance * MyDevice.sdi12Port. * * @return a YSdi12Port object allowing you to drive the SDI12 port. */ static FindSdi12Port(func: string): YSdi12Port; /** * 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. * * @param yctx : a YAPI context * @param func : a string that uniquely characterizes the SDI12 port, for instance * MyDevice.sdi12Port. * * @return a YSdi12Port object allowing you to drive the SDI12 port. */ static FindSdi12PortInContext(yctx: YAPIContext, func: string): YSdi12Port; /** * 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. * * @param 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. * @noreturn */ registerValueCallback(callback: YSdi12Port.ValueCallback | null): Promise; _invokeValueCallback(value: string): Promise; sendCommand(text: string): Promise; /** * 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. * * @return a string with a single line of text * * On failure, throws an exception or returns a negative error code. */ readLine(): Promise; /** * 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). * * @param 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. * @param maxWait : the maximum number of milliseconds to wait for a message if none is found * in the receive buffer. * * @return an array of strings containing the messages found, if any. * Binary messages are converted to hexadecimal representation. * * On failure, throws an exception or returns an empty array. */ readMessages(pattern: string, maxWait: number): Promise; /** * 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. * * @param absPos : the absolute position index for next read operations. * * @return nothing. */ read_seek(absPos: number): Promise; /** * Returns the current absolute stream position pointer of the API object. * * @return the absolute position index for next read operations. */ read_tell(): Promise; /** * Returns the number of bytes available to read in the input buffer starting from the * current absolute stream position pointer of the API object. * * @return the number of bytes available to read */ read_avail(): Promise; end_tell(): Promise; /** * 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. * * @param query : the line query to send (without CR/LF) * @param maxWait : the maximum number of milliseconds to wait for a reply. * * @return the next text line received after sending the text query, as a string. * Additional lines can be obtained by calling readLine or readMessages. * * On failure, throws an exception or returns an empty string. */ queryLine(query: string, maxWait: number): Promise; /** * 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. * * @param hexString : the message to send, coded in hexadecimal * @param maxWait : the maximum number of milliseconds to wait for a reply. * * @return the next frame received after sending the message, as a hex string. * Additional frames can be obtained by calling readHex or readMessages. * * On failure, throws an exception or returns an empty string. */ queryHex(hexString: string, maxWait: number): Promise; /** * Saves the job definition string (JSON data) into a job file. * The job file can be later enabled using selectJob(). * * @param jobfile : name of the job file to save on the device filesystem * @param jsonDef : a string containing a JSON definition of the job * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ uploadJob(jobfile: string, jsonDef: string): Promise; /** * 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. * * @param jobfile : name of the job file (on the device filesystem) * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ selectJob(jobfile: string): Promise; /** * Clears the serial port buffer and resets counters to zero. * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ reset(): Promise; /** * Sends a single byte to the serial port. * * @param code : the byte to send * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ writeByte(code: number): Promise; /** * Sends an ASCII string to the serial port, as is. * * @param text : the text string to send * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ writeStr(text: string): Promise; /** * Sends a binary buffer to the serial port, as is. * * @param buff : the binary buffer to send * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ writeBin(buff: Uint8Array): Promise; /** * Sends a byte sequence (provided as a list of bytes) to the serial port. * * @param byteList : a list of byte codes * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ writeArray(byteList: number[]): Promise; /** * Sends a byte sequence (provided as a hexadecimal string) to the serial port. * * @param hexString : a string of hexadecimal byte codes * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ writeHex(hexString: string): Promise; /** * Sends an ASCII string to the serial port, followed by a line break (CR LF). * * @param text : the text string to send * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ writeLine(text: string): Promise; /** * 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. * * @return the next byte * * On failure, throws an exception or returns a negative error code. */ readByte(): Promise; /** * 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. * * @param nChars : the maximum number of characters to read * * @return a string with receive buffer contents * * On failure, throws an exception or returns a negative error code. */ readStr(nChars: number): Promise; /** * 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. * * @param nChars : the maximum number of bytes to read * * @return a binary object with receive buffer contents * * On failure, throws an exception or returns a negative error code. */ readBin(nChars: number): Promise; /** * 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. * * @param nChars : the maximum number of bytes to read * * @return a sequence of bytes with receive buffer contents * * On failure, throws an exception or returns an empty array. */ readArray(nChars: number): Promise; /** * 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. * * @param nBytes : the maximum number of bytes to read * * @return a string with receive buffer contents, encoded in hexadecimal * * On failure, throws an exception or returns a negative error code. */ readHex(nBytes: number): Promise; /** * 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. * * @param sensorAddr : the sensor address, as a string * @param cmd : the SDI12 query to send (without address and exclamation point) * @param maxWait : the maximum timeout to wait for a reply from sensor, in millisecond * * @return the reply returned by the sensor, without newline, as a string. * * On failure, throws an exception or returns an empty string. */ querySdi12(sensorAddr: string, cmd: string, maxWait: number): Promise; /** * 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. * * @return the reply returned by the sensor, as a YSdi12SensorInfo object. * * On failure, throws an exception or returns an empty string. */ discoverSingleSensor(): Promise; /** * 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. * * @return all the information from every connected sensor, as an array of YSdi12SensorInfo object. * * On failure, throws an exception or returns an empty string. */ discoverAllSensors(): Promise; /** * 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. * * @param sensorAddr : the sensor address, as a string * @param measCmd : the SDI12 query to send (without address and exclamation point) * @param maxWait : the maximum timeout to wait for a reply from sensor, in millisecond * * @return the reply returned by the sensor, without newline, as a list of float. * * On failure, throws an exception or returns an empty string. */ readSensor(sensorAddr: string, measCmd: string, maxWait: number): Promise; /** * 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. * * @param oldAddress : Actual sensor address, as a string * @param newAddress : New sensor address, as a string * * @return the sensor address and information , as a YSdi12SensorInfo object. * * On failure, throws an exception or returns an empty string. */ changeAddress(oldAddress: string, newAddress: string): Promise; /** * 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. * * @param sensorAddr : Sensor address, as a string * * @return the reply returned by the sensor, as a YSdi12Port object. * * On failure, throws an exception or returns an empty string. */ getSensorInformation(sensorAddr: string): Promise; /** * 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. * * @param sensorAddr : Sensor address, as a string * * @return the reply returned by the sensor, as a YSdi12Port object. * * On failure, throws an exception or returns an empty string. */ readConcurrentMeasurements(sensorAddr: string): Promise; /** * 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. * * @param sensorAddr : Sensor address, as a string * * @return the reply returned by the sensor, as a YSdi12Port object. * * On failure, throws an exception or returns an empty string. */ requestConcurrentMeasurements(sensorAddr: string): Promise; /** * 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). * * @param maxWait : the maximum number of milliseconds to wait for a message if none is found * in the receive buffer. * @param maxMsg : the maximum number of messages to be returned by the function; up to 254. * * @return an array of YSdi12SnoopingRecord objects containing the messages found, if any. * * On failure, throws an exception or returns an empty array. */ snoopMessagesEx(maxWait: number, maxMsg: number): Promise; /** * 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). * * @param maxWait : the maximum number of milliseconds to wait for a message if none is found * in the receive buffer. * * @return an array of YSdi12SnoopingRecord objects containing the messages found, if any. * * On failure, throws an exception or returns an empty array. */ snoopMessages(maxWait: number): Promise; /** * 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. * * @return 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. */ nextSdi12Port(): YSdi12Port | null; /** * Starts the enumeration of SDI12 ports currently accessible. * Use the method YSdi12Port.nextSdi12Port() to iterate on * next SDI12 ports. * * @return a pointer to a YSdi12Port object, corresponding to * the first SDI12 port currently online, or a null pointer * if there are none. */ static FirstSdi12Port(): YSdi12Port | null; /** * Starts the enumeration of SDI12 ports currently accessible. * Use the method YSdi12Port.nextSdi12Port() to iterate on * next SDI12 ports. * * @param yctx : a YAPI context. * * @return a pointer to a YSdi12Port object, corresponding to * the first SDI12 port currently online, or a null pointer * if there are none. */ static FirstSdi12PortInContext(yctx: YAPIContext): YSdi12Port | null; } export declare namespace YSdi12Port { const enum VOLTAGELEVEL { OFF = 0, TTL3V = 1, TTL3VR = 2, TTL5V = 3, TTL5VR = 4, RS232 = 5, RS485 = 6, TTL1V8 = 7, SDI12 = 8, INVALID = -1 } interface ValueCallback { (func: YSdi12Port, value: string): void; } }