yoctolib-esm

/********************************************************************* * * $Id: yocto_serialport.ts 63482 2024-11-26 09:29:16Z seb $ * * Implements the high-level API for SnoopingRecord 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'; /** * YSnoopingRecord Class: Intercepted serial message description, returned by serialPort.snoopMessages method * * */ export declare class YSnoopingRecord { _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 YSnoopingRecord { } /** * YSerialPort Class: serial port control interface, available for instance in the Yocto-RS232, the * Yocto-RS485-V2 or the Yocto-Serial * * The YSerialPort class allows you to fully drive a Yoctopuce serial 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 serial 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 YSerialPort 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: YSerialPort.VOLTAGELEVEL; _serialMode: string; _valueCallbackSerialPort: YSerialPort.ValueCallback | null; _rxptr: number; _rxbuff: Uint8Array; _rxbuffptr: number; _eventPos: number; _eventCallback: YSerialPort.SnoopingCallback | null; 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: YSerialPort.VOLTAGELEVEL; readonly VOLTAGELEVEL_TTL3V: YSerialPort.VOLTAGELEVEL; readonly VOLTAGELEVEL_TTL3VR: YSerialPort.VOLTAGELEVEL; readonly VOLTAGELEVEL_TTL5V: YSerialPort.VOLTAGELEVEL; readonly VOLTAGELEVEL_TTL5VR: YSerialPort.VOLTAGELEVEL; readonly VOLTAGELEVEL_RS232: YSerialPort.VOLTAGELEVEL; readonly VOLTAGELEVEL_RS485: YSerialPort.VOLTAGELEVEL; readonly VOLTAGELEVEL_TTL1V8: YSerialPort.VOLTAGELEVEL; readonly VOLTAGELEVEL_SDI12: YSerialPort.VOLTAGELEVEL; readonly VOLTAGELEVEL_INVALID: YSerialPort.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: YSerialPort.VOLTAGELEVEL; static readonly VOLTAGELEVEL_TTL3V: YSerialPort.VOLTAGELEVEL; static readonly VOLTAGELEVEL_TTL3VR: YSerialPort.VOLTAGELEVEL; static readonly VOLTAGELEVEL_TTL5V: YSerialPort.VOLTAGELEVEL; static readonly VOLTAGELEVEL_TTL5VR: YSerialPort.VOLTAGELEVEL; static readonly VOLTAGELEVEL_RS232: YSerialPort.VOLTAGELEVEL; static readonly VOLTAGELEVEL_RS485: YSerialPort.VOLTAGELEVEL; static readonly VOLTAGELEVEL_TTL1V8: YSerialPort.VOLTAGELEVEL; static readonly VOLTAGELEVEL_SDI12: YSerialPort.VOLTAGELEVEL; static readonly VOLTAGELEVEL_INVALID: YSerialPort.VOLTAGELEVEL; static readonly SERIALMODE_INVALID: string; constructor(yapi: YAPIContext, func: string); imm_parseAttr(name: string, val: any): number; _internalEventCallback(YSerialPort_obj: YSerialPort, str_value: string): Promise<void>; /** * 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 YSerialPort.RXCOUNT_INVALID. */ get_rxCount(): Promise<number>; /** * 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 YSerialPort.TXCOUNT_INVALID. */ get_txCount(): Promise<number>; /** * 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 YSerialPort.ERRCOUNT_INVALID. */ get_errCount(): Promise<number>; /** * 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 YSerialPort.RXMSGCOUNT_INVALID. */ get_rxMsgCount(): Promise<number>; /** * 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 YSerialPort.TXMSGCOUNT_INVALID. */ get_txMsgCount(): Promise<number>; /** * Returns the latest message fully received (for Line, Frame and Modbus protocols). * * @return a string corresponding to the latest message fully received (for Line, Frame and Modbus protocols) * * On failure, throws an exception or returns YSerialPort.LASTMSG_INVALID. */ get_lastMsg(): Promise<string>; /** * 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 YSerialPort.CURRENTJOB_INVALID. */ get_currentJob(): Promise<string>; /** * 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<number>; /** * 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 YSerialPort.STARTUPJOB_INVALID. */ get_startupJob(): Promise<string>; /** * 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<number>; /** * 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 YSerialPort.JOBMAXTASK_INVALID. */ get_jobMaxTask(): Promise<number>; /** * 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 YSerialPort.JOBMAXSIZE_INVALID. */ get_jobMaxSize(): Promise<number>; get_command(): Promise<string>; set_command(newval: string): Promise<number>; /** * 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, * "StxEtx" for ASCII messages delimited by STX/ETX codes, * "Frame:[timeout]ms" for binary messages separated by a delay time, * "Modbus-ASCII" for MODBUS messages in ASCII mode, * "Modbus-RTU" for MODBUS messages in RTU mode, * "Wiegand-ASCII" for Wiegand messages in ASCII mode, * "Wiegand-26","Wiegand-34", etc for Wiegand messages in byte mode, * "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 YSerialPort.PROTOCOL_INVALID. */ get_protocol(): Promise<string>; /** * Changes the type of protocol used over the serial line. * Possible values are "Line" for ASCII messages separated by CR and/or LF, * "StxEtx" for ASCII messages delimited by STX/ETX codes, * "Frame:[timeout]ms" for binary messages separated by a delay time, * "Modbus-ASCII" for MODBUS messages in ASCII mode, * "Modbus-RTU" for MODBUS messages in RTU mode, * "Wiegand-ASCII" for Wiegand messages in ASCII mode, * "Wiegand-26","Wiegand-34", etc for Wiegand messages in byte mode, * "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<number>; /** * Returns the voltage level used on the serial line. * * @return a value among YSerialPort.VOLTAGELEVEL_OFF, YSerialPort.VOLTAGELEVEL_TTL3V, * YSerialPort.VOLTAGELEVEL_TTL3VR, YSerialPort.VOLTAGELEVEL_TTL5V, YSerialPort.VOLTAGELEVEL_TTL5VR, * YSerialPort.VOLTAGELEVEL_RS232, YSerialPort.VOLTAGELEVEL_RS485, YSerialPort.VOLTAGELEVEL_TTL1V8 and * YSerialPort.VOLTAGELEVEL_SDI12 corresponding to the voltage level used on the serial line * * On failure, throws an exception or returns YSerialPort.VOLTAGELEVEL_INVALID. */ get_voltageLevel(): Promise<YSerialPort.VOLTAGELEVEL>; /** * 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 YSerialPort.VOLTAGELEVEL_OFF, YSerialPort.VOLTAGELEVEL_TTL3V, * YSerialPort.VOLTAGELEVEL_TTL3VR, YSerialPort.VOLTAGELEVEL_TTL5V, YSerialPort.VOLTAGELEVEL_TTL5VR, * YSerialPort.VOLTAGELEVEL_RS232, YSerialPort.VOLTAGELEVEL_RS485, YSerialPort.VOLTAGELEVEL_TTL1V8 and * YSerialPort.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: YSerialPort.VOLTAGELEVEL): Promise<number>; /** * Returns the serial port communication parameters, as a string such as * "9600,8N1". The string includes the baud rate, the number of data bits, * the parity, and the number of stop bits. An optional suffix is included * if flow control is active: "CtsRts" for hardware handshake, "XOnXOff" * for logical flow control and "Simplex" for acquiring a shared bus using * the RTS line (as used by some RS485 adapters for instance). * * @return a string corresponding to the serial port communication parameters, as a string such as * "9600,8N1" * * On failure, throws an exception or returns YSerialPort.SERIALMODE_INVALID. */ get_serialMode(): Promise<string>; /** * Changes the serial port communication parameters, with a string such as * "9600,8N1". The string includes the baud rate, the number of data bits, * the parity, and the number of stop bits. An optional suffix can be added * to enable flow control: "CtsRts" for hardware handshake, "XOnXOff" * for logical flow control and "Simplex" for acquiring a shared bus using * the RTS line (as used by some RS485 adapters for instance). * 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 * "9600,8N1" * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ set_serialMode(newval: string): Promise<number>; /** * Retrieves a serial 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 serial port is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method YSerialPort.isOnline() to test if the serial port is * indeed online at a given time. In case of ambiguity when looking for * a serial 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 serial port, for instance * RS232MK1.serialPort. * * @return a YSerialPort object allowing you to drive the serial port. */ static FindSerialPort(func: string): YSerialPort; /** * Retrieves a serial 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 serial port is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method YSerialPort.isOnline() to test if the serial port is * indeed online at a given time. In case of ambiguity when looking for * a serial 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 serial port, for instance * RS232MK1.serialPort. * * @return a YSerialPort object allowing you to drive the serial port. */ static FindSerialPortInContext(yctx: YAPIContext, func: string): YSerialPort; /** * 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: YSerialPort.ValueCallback | null): Promise<number>; _invokeValueCallback(value: string): Promise<number>; sendCommand(text: string): Promise<number>; /** * 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<string>; /** * 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<string[]>; /** * 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<number>; /** * Returns the current absolute stream position pointer of the API object. * * @return the absolute position index for next read operations. */ read_tell(): Promise<number>; /** * 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<number>; end_tell(): Promise<number>; /** * 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<string>; /** * 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<string>; /** * 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<number>; /** * 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<number>; /** * 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<number>; /** * 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<number>; /** * 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<number>; /** * 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<number>; /** * 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<number>; /** * 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<number>; /** * 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<number>; /** * 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<number>; /** * 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<string>; /** * 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<Uint8Array>; /** * 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<number[]>; /** * 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<string>; /** * Emits a BREAK condition on the serial interface. When the specified * duration is 0, the BREAK signal will be exactly one character wide. * When the duration is between 1 and 100, the BREAK condition will * be hold for the specified number of milliseconds. * * @param duration : 0 for a standard BREAK, or duration between 1 and 100 ms * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ sendBreak(duration: number): Promise<number>; /** * Manually sets the state of the RTS line. This function has no effect when * hardware handshake is enabled, as the RTS line is driven automatically. * * @param val : 1 to turn RTS on, 0 to turn RTS off * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ set_RTS(val: number): Promise<number>; /** * Reads the level of the CTS line. The CTS line is usually driven by * the RTS signal of the connected serial device. * * @return 1 if the CTS line is high, 0 if the CTS line is low. * * On failure, throws an exception or returns a negative error code. */ get_CTS(): Promise<number>; /** * Retrieves messages (both direction) in the serial port buffer, starting at current position. * This function will only compare and return printable characters in the message strings. * Binary protocols are handled as hexadecimal strings. * * 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 YSnoopingRecord objects containing the messages found, if any. * Binary messages are converted to hexadecimal representation. * * On failure, throws an exception or returns an empty array. */ snoopMessagesEx(maxWait: number, maxMsg: number): Promise<YSnoopingRecord[]>; /** * Retrieves messages (both direction) in the serial port buffer, starting at current position. * This function will only compare and return printable characters in the message strings. * Binary protocols are handled as hexadecimal strings. * * 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 YSnoopingRecord objects containing the messages found, if any. * Binary messages are converted to hexadecimal representation. * * On failure, throws an exception or returns an empty array. */ snoopMessages(maxWait: number): Promise<YSnoopingRecord[]>; /** * Registers a callback function to be called each time that a message is sent or * received by the serial port. 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 four arguments: * the YSerialPort object that emitted the event, and * the YSnoopingRecord object that describes the message * sent or received. * On failure, throws an exception or returns a negative error code. */ registerSnoopingCallback(callback: YSerialPort.SnoopingCallback | null): Promise<number>; _internalEventHandler(advstr: string): Promise<number>; /** * Sends an ASCII string to the serial port, preceeded with an STX code and * followed by an ETX code. * * @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. */ writeStxEtx(text: string): Promise<number>; /** * Sends a MODBUS message (provided as a hexadecimal string) to the serial port. * The message must start with the slave address. The MODBUS CRC/LRC is * automatically added by the function. This function does not wait for a reply. * * @param hexString : a hexadecimal message string, including device address but no CRC/LRC * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ writeMODBUS(hexString: string): Promise<number>; /** * Sends a message to a specified MODBUS slave connected to the serial port, and reads the * reply, if any. The message is the PDU, provided as a vector of bytes. * * @param slaveNo : the address of the slave MODBUS device to query * @param pduBytes : the message to send (PDU), as a vector of bytes. The first byte of the * PDU is the MODBUS function code. * * @return the received reply, as a vector of bytes. * * On failure, throws an exception or returns an empty array (or a MODBUS error reply). */ queryMODBUS(slaveNo: number, pduBytes: number[]): Promise<number[]>; /** * Reads one or more contiguous internal bits (or coil status) from a MODBUS serial device. * This method uses the MODBUS function code 0x01 (Read Coils). * * @param slaveNo : the address of the slave MODBUS device to query * @param pduAddr : the relative address of the first bit/coil to read (zero-based) * @param nBits : the number of bits/coils to read * * @return a vector of integers, each corresponding to one bit. * * On failure, throws an exception or returns an empty array. */ modbusReadBits(slaveNo: number, pduAddr: number, nBits: number): Promise<number[]>; /** * Reads one or more contiguous input bits (or discrete inputs) from a MODBUS serial device. * This method uses the MODBUS function code 0x02 (Read Discrete Inputs). * * @param slaveNo : the address of the slave MODBUS device to query * @param pduAddr : the relative address of the first bit/input to read (zero-based) * @param nBits : the number of bits/inputs to read * * @return a vector of integers, each corresponding to one bit. * * On failure, throws an exception or returns an empty array. */ modbusReadInputBits(slaveNo: number, pduAddr: number, nBits: number): Promise<number[]>; /** * Reads one or more contiguous internal registers (holding registers) from a MODBUS serial device. * This method uses the MODBUS function code 0x03 (Read Holding Registers). * * @param slaveNo : the address of the slave MODBUS device to query * @param pduAddr : the relative address of the first holding register to read (zero-based) * @param nWords : the number of holding registers to read * * @return a vector of integers, each corresponding to one 16-bit register value. * * On failure, throws an exception or returns an empty array. */ modbusReadRegisters(slaveNo: number, pduAddr: number, nWords: number): Promise<number[]>; /** * Reads one or more contiguous input registers (read-only registers) from a MODBUS serial device. * This method uses the MODBUS function code 0x04 (Read Input Registers). * * @param slaveNo : the address of the slave MODBUS device to query * @param pduAddr : the relative address of the first input register to read (zero-based) * @param nWords : the number of input registers to read * * @return a vector of integers, each corresponding to one 16-bit input value. * * On failure, throws an exception or returns an empty array. */ modbusReadInputRegisters(slaveNo: number, pduAddr: number, nWords: number): Promise<number[]>; /** * Sets a single internal bit (or coil) on a MODBUS serial device. * This method uses the MODBUS function code 0x05 (Write Single Coil). * * @param slaveNo : the address of the slave MODBUS device to drive * @param pduAddr : the relative address of the bit/coil to set (zero-based) * @param value : the value to set (0 for OFF state, non-zero for ON state) * * @return the number of bits/coils affected on the device (1) * * On failure, throws an exception or returns zero. */ modbusWriteBit(slaveNo: number, pduAddr: number, value: number): Promise<number>; /** * Sets several contiguous internal bits (or coils) on a MODBUS serial device. * This method uses the MODBUS function code 0x0f (Write Multiple Coils). * * @param slaveNo : the address of the slave MODBUS device to drive * @param pduAddr : the relative address of the first bit/coil to set (zero-based) * @param bits : the vector of bits to be set (one integer per bit) * * @return the number of bits/coils affected on the device * * On failure, throws an exception or returns zero. */ modbusWriteBits(slaveNo: number, pduAddr: number, bits: number[]): Promise<number>; /** * Sets a single internal register (or holding register) on a MODBUS serial device. * This method uses the MODBUS function code 0x06 (Write Single Register). * * @param slaveNo : the address of the slave MODBUS device to drive * @param pduAddr : the relative address of the register to set (zero-based) * @param value : the 16 bit value to set * * @return the number of registers affected on the device (1) * * On failure, throws an exception or returns zero. */ modbusWriteRegister(slaveNo: number, pduAddr: number, value: number): Promise<number>; /** * Sets several contiguous internal registers (or holding registers) on a MODBUS serial device. * This method uses the MODBUS function code 0x10 (Write Multiple Registers). * * @param slaveNo : the address of the slave MODBUS device to drive * @param pduAddr : the relative address of the first internal register to set (zero-based) * @param values : the vector of 16 bit values to set * * @return the number of registers affected on the device * * On failure, throws an exception or returns zero. */ modbusWriteRegisters(slaveNo: number, pduAddr: number, values: number[]): Promise<number>; /** * Sets several contiguous internal registers (holding registers) on a MODBUS serial device, * then performs a contiguous read of a set of (possibly different) internal registers. * This method uses the MODBUS function code 0x17 (Read/Write Multiple Registers). * * @param slaveNo : the address of the slave MODBUS device to drive * @param pduWriteAddr : the relative address of the first internal register to set (zero-based) * @param values : the vector of 16 bit values to set * @param pduReadAddr : the relative address of the first internal register to read (zero-based) * @param nReadWords : the number of 16 bit values to read * * @return a vector of integers, each corresponding to one 16-bit register value read. * * On failure, throws an exception or returns an empty array. */ modbusWriteAndReadRegisters(slaveNo: number, pduWriteAddr: number, values: number[], pduReadAddr: number, nReadWords: number): Promise<number[]>; /** * Continues the enumeration of serial ports started using yFirstSerialPort(). * Caution: You can't make any assumption about the returned serial ports order. * If you want to find a specific a serial port, use SerialPort.findSerialPort() * and a hardwareID or a logical name. * * @return a pointer to a YSerialPort object, corresponding to * a serial port currently online, or a null pointer * if there are no more serial ports to enumerate. */ nextSerialPort(): YSerialPort | null; /** * Starts the enumeration of serial ports currently accessible. * Use the method YSerialPort.nextSerialPort() to iterate on * next serial ports. * * @return a pointer to a YSerialPort object, corresponding to * the first serial port currently online, or a null pointer * if there are none. */ static FirstSerialPort(): YSerialPort | null; /** * Starts the enumeration of serial ports currently accessible. * Use the method YSerialPort.nextSerialPort() to iterate on * next serial ports. * * @param yctx : a YAPI context. * * @return a pointer to a YSerialPort object, corresponding to * the first serial port currently online, or a null pointer * if there are none. */ static FirstSerialPortInContext(yctx: YAPIContext): YSerialPort | null; } export declare namespace YSerialPort { 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: YSerialPort, value: string): void; } interface SnoopingCallback { (func: YSerialPort, rec: YSnoopingRecord): void; } }