npComp plugin

npCompCreate

Create a new instance of an Comp object. The result variable store the instance ID (a numeric value) of the created object, which you can use later on other plugin actions.

↑↑

npCompDestroy

Destroy a previously created instanace of an Comp object. Specify the instance ID of the object that you what to destroy. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] variable store information about the error.

↑↑

npCompDestroyAll

Destroy all previously created instances of Comp objects.

↑↑

npCompEnumPorts

Enumerate the system COM ports in the specified variables. The list variable store the available COM identifiers in an Array form. The list count variable store the number of available COM ports, or, in other words, the maximum index for the Array stored in the list variable. If the system have no COM ports available then the list count variable store "0". Below you can view an example of how enumerate the system COM ports and used it to fill a NeoBook ListBox object.

npCompEnumPorts "[CompPorts]" "[CompPortsCount]"

If "[CompPortsCount]" "=" "0"
  Alertbox "Warning" "Sorry, no COM ports found. The program cannot continue."
  Exit "" ""
EndIf

Loop "1" "[CompPortsCount]" "[I]"
  ListBoxAddItem "CompPortsList" "0" "[CompPorts[I]]"
EndLoop
SetVar "[CompPortsList]" "[CompPorts1]"

You must use one of the COM ports identifiers in the npCompOpenPort action in order to open such port.

↑↑

npCompOpenPort

Open the specified port name using the specified Comp object instance. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] variable store information about the error.

↑↑

npCompClosePort

Close the specified port name using the specified Comp object instance. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] variable store information about the error.

↑↑

npCompIsPortOpen

Check if the specified Comp object have previously opened certain COM port. The result variable store "True" if the specified COM port is open or "False" when not. The result variable can also store "False" if an error occur. In this last case the [LastError] variable store information about the error.

↑↑

npCompReadString

Read the specified count of string chars from the specified Comp object open COM port. The action does not return until count bytes are read or timeout elapses (You can specify read timeouts using the npCompSetOptions action). Even when this action can be executed in whatever place, the most common use is into the subroutine specified in the npOnCompRxChar action. The result variable store the input readed string. The result variable can also store "False" if an error occur. In this last case the [LastError] variable store information about the error.

↑↑

npCompWriteString

Write the specified string chars to the specified Comp object open COM port. The action does not return until the whole string is written or timeout elapses (You can specify write timeouts using the npCompSetOptions action). The result variable store the number of bytes that are actually written. The result variable can also store "False" if an error occur. In this last case the [LastError] variable store information about the error.

↑↑

npCompSetOptions

Specify general options of a Comp object instance. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] variable store information about the error. The available actions are described below:

BaudRate BaudRate represents the speed at which characters are sent or received via RS232 conection. Both sides of connection should have the same BaudRate. If BaudRate has a value of brCustom, CustomBaud is used to set the baud rate. The possible values are: brCustom, br110, br300, br600, br1200, br2400, br4800, br9600,br14400, br19200, br38400, br56000, br57600 or br115200. The default value is br9600.
CustomBaud Use this option to set the custom baud rate for character transmission. Of BaudRate is not set to brCustom, this option has no effect.
InputBuffer Specify the recommended size, in bytes, of the device's internal input buffer. Default value is "1024". Note that input buffer site are only a recommended buffer size: serial driver accepts this values, but it is free to use any other input buffer scheme.
OutputBuffer Specify the recommended size, in bytes, of the device's internal output buffer. Default value is "1024". Note that output buffer site are only a recommended buffer size: serial driver accepts this values, but it is free to use any other output buffer scheme.
DataBits Sets the number of bits in the bytes transmitted and received. The possible values are: dbFive, dbSix, dbSeven or dbEight. The default value is dbEight. Use of 5 data bits with 2 stop bits is invalid combination, as is 6, 7 or 8 data bits with 1.5 stop bits.
DiscardNull Specifies whether null bytes are discarded. If this property is "True", null bytes are discarded when received. The default value is "False".
EventChar Specifies the ASCII value of the character to signal an event. Note that both npOnCompRxFlag and npOnCompRxChar event/subroutines are executed when the event char arrives. The default value is [#0].
ControlDTR Sets DTR (data-terminal-ready) flow control type. The possible values are: dtrDisable, dtrEnable or dtrHandshake. dtrDisable disables the DTR line when the device is opened and leaves it disabled. dtrEnable enables the DTR line when the device is opened and leaves it on. dtrHandshake enables DTR handshaking. If handshaking is enabled, it is an error for the application to adjust the line by using the npCompSetDTR action. The default value is dtrDisable.
ControlRTS Sets RTS (request-to-send) flow control type. The possible values are: dtrDisable, dtrEnable, dtrHandshake or dtrToggle. dtrDisable disables the RTS line when the device is opened and leaves it disabled. dtrEnable enables the RTS line when the device is opened and leaves it on. dtrHandshake enables RTS handshaking. The driver raises the RTS line when the "type-ahead" (input) buffer is less than one-half full and lowers the RTS line when the buffer is more than three-quarters full. If handshaking is enabled, it is an error for the application to adjust the line by using the npCompSetRTS action. dtrToggle specifies that the RTS line will be high if bytes are available for transmission. After all buffered bytes have been sent, the RTS line will be low. The default value is rtsDisable.
DSRSensitivity Specifies whether the communications driver is sensitive to the state of the DSR signal. If this option is "True", the driver ignores any bytes received, unless the DSR input line is high. The default value is: "False".
OutCTSFlow Specifies whether the CTS (clear-to-send) signal is monitored for output flow control. If this option is "True" and CTS is turned off, output is suspended until CTS is sent again. The default value is: "False".
OutDSRFlow Specifies whether the DSR (data-set-ready) signal is monitored for output flow control. If this option is True and DSR is turned off, output is suspended until DSR is sent again. The default value is: "False".
TxContinueOnXoff Specifies whether transmission stops when the input buffer is full and the driver has transmitted the XoffChar character. If this option is "True", transmission continues after the driver has transmitted the XoffChar character to stop receiving bytes. If this option is "False", transmission does not continue until the driver has transmitted the XonChar character to resume reception. The default value is: "False".
XOnChar Specifies the value of the Xon character for both transmission and reception. This is usally charachter of ASCII code 17. The default value is: "[#17]".
XoffChar Specifies the value of the Xoff character for both transmission and reception. This is usally charachter of ASCII code 19. The default value is: "[#19]".
XonXoffIn Specifies whether Xon/Xoff flow control is used during reception. If this option is "True", the XoffChar character is sent when the input buffer comes within maximum byte limit of being full, and the XonChar character is sent when the input buffer comes within minimum byte limit of being empty. The default value is: "False".
XonXoffOut Specifies whether Xon/Xoff flow control is used during transmission. If this option is "True", transmission stops when the XoffChar character is received and starts again when the XonChar character is received. The default value is: "False".
ParityBits Specifies the parity scheme to be used. This option can be one of the following values: prNone, prOdd, prEven, prMark or prSpace, which correspond with: "No parity", "Odd", "Even", "Mark" and "Space". The default value is: prNone.
ParityCheck Specifies whether parity checking is enabled. If this option is "True", parity checking is performed and errors are reported. The default value is: "False".
ParityReplace Specifies whether bytes received with parity errors are replaced with the character specified by the "ParityReplaceChar" option. If this option is "True" and "ParityCheck" option is also "True", replacement occurs. The default value is: "False".
ParityReplaceChar Specifies the ASCII value of the character used to replace bytes received with a parity error. The default value is: "[#0]".
TimeoutReadInterval * Specifies the maximum time, in milliseconds, allowed to elapse between the arrival of two characters on the communications line. During a read operation, the time period begins when the first character is received. If the interval between the arrival of any two characters exceeds this amount, the read operation is completed and any buffered data is returned. A value of zero indicates that interval time-outs are not used. A value of -1, combined with zero values for both the TimeoutReadTotalConstant and TimeoutReadTotalMultiplier options, specifies that the read operation is to return immediately with the characters that have already been received, even if no characters have been received. The default value is: "-1".
TimeoutReadTotalConstant * Specifies the constant, in milliseconds, used to calculate the total time-out period for read operations. For each read operation, this value is added to the product of the TimeoutReadTotalMultiplier option and the requested number of bytes. A value of zero for both the TimeoutReadTotalMultiplier and TimeoutReadTotalConstant options indicates that total time-outs are not used for read operations. If an application sets TimeoutReadInterval and TimeoutReadTotalMultiplier to "-1" and sets TimeoutReadTotalConstant to a value greater than zero, one of the following occurs when the read action is called: 1º If there are any characters in the input buffer, read action returns immediately with the characters in the buffer. 2º If there are no characters in the input buffer, read action waits until a character arrives and then returns immediately. 3º If no character arrives within the time specified by ReadTotalConstant, read action times out. The default value is: "0".
TimeoutReadTotalMultiplier * Specifies the multiplier, in milliseconds, used to calculate the total time-out period for read operations. For each read operation, this value is multiplied by the requested number of bytes to be read. A value of zero for both TimeoutReadInterval the and TimeoutReadTotalConstant options indicates that total time-outs are not used for read operations. The default value is: "0".
TimeoutWriteTotalConstant * Specifies the constant, in milliseconds, used to calculate the total time-out period for write operations. For each write operation, this value is added to the product of the TimeoutWriteTotalMultiplier option and the number of bytes to be written. A value of zero for both the TimeoutWriteTotalMultiplier and TimeoutWriteTotalConstant options indicates that total time-outs are not used for write operations. The default value is: "1000".
TimeoutWriteTotalMultiplier * Specifies the multiplier, in milliseconds, used to calculate the total time-out period for write operations. For each write operation, this value is multiplied by the number of bytes to be written. A value of zero for both the TimeoutReadTotalMultiplier and TimeoutWriteTotalConstant options indicates that total time-outs are not used for write operations. The default value is: "100".
StopBits Sets the number of stop bits per character. StopBits can be set to one of the following values: sbOneStopBit, sbOne5StopBits or sbTwoStopBits, which correspond with "1 stop bit per byte", "1.5 stop bits per byte" and "2 stop bits per byte". Note that use of 5 data bits with 2 stop bits is invalid combination, as is 6, 7 or 8 data bits with 1.5 stop bits. The default value is: sbOneStopBit.

* Read and write timeout options defines detailed timeout settings for read and write operations. When timeout for specific operation elapses, operation is aborted, however, no errors are reported.

Two types of time-outs are enabled by the time-out parameters. An interval time-out occurs when the time between the receipt of any two characters exceeds a specified number of milliseconds. Timing starts when the first character is received and is restarted when each new character is received. A total time-out occurs when the total amount of time consumed by a read operation exceeds a calculated number of milliseconds. Timing starts immediately when the I/O operation begins. Write operations support only total time-outs. Read operations support both interval and total time-outs, which can be used separately or combined.

The time, in milliseconds, of the total time-out period for a read or write operation is calculated by using the multiplier and constant:

Timeout = (MULTIPLIER * number_of_bytes) + CONSTANT

↑↑

npCompGetOptions

Retrieve general options from a Comp object instance. The available options and possible values are described in the npCompSetOptions action. The result variable store the value of the specified option. The result variable can also store "False" if an error occur. In this last case the [LastError] variable store information about the error.

↑↑

npCompInputCount

Retrieve the number of bytes in input buffer in the specified Comp object instance. The result variable store the input buffer size in bytes. The result variable can also store "False" if an error occur. In this last case the [LastError] variable store information about the error.

↑↑

npCompOuptutCount

Retrieve the number of bytes in output buffer in the specified Comp object instance. The result variable store the output buffer size in bytes. The result variable can also store "False" if an error occur. In this last case the [LastError] variable store information about the error.

↑↑

npCompClearInput

Clear the input buffer of the specified Comp object instance. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] variable store information about the error.

↑↑

npCompClearOutput

Clear the output buffer of the specified Comp object instance. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] variable store information about the error.

↑↑

npCompSetDTR

Enable or disable DTR (data-terminal-ready) signal in the specified Comp object instance. If the ControlDTR option is set to dtrHandshake, it is an error for the application to execute this action and an error is raised. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] variable store information about the error.

↑↑

npCompSetRTS

Enable or disable RTS (request-to-send) signal in the specified Comp object instance. If the ControlRTS option is set to rtsHandshake, it is an error for the application to execute this action and an error is raised. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] variable store information about the error.

↑↑

npCompSetBreak

Set break or non-break transmission state in the specified Comp object instance. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] variable store information about the error.

↑↑

npCompSetXonXoff

Simulate Xon/Xoff character arrival in the specified Comp object instance. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] variable store information about the error.

↑↑

npCompSignals

Determine the state of signals in the specified Comp object instance. To determine the change of signals use the appropiate event action. This action can determine the state of the following signals: CTS: Clear-to-send, DSR: Data-set-ready, Ring: Ring indicator, RLSD: Receive-line-signal-detected.

The result variable is conformed by the specified variable followed by the appropiate signal name: [ResultVar.CTS], [ResultVar.DSR], [ResultVar.Ring] and [ResultVar.RLSD]. This variables can be "True" or "False", depending on the signal high state. The result variable also can store "False" if an error occur. In this last case the [LastError] variable store information about the error.

↑↑

npCompStateFlags

Retrieve information about serial communication device in the specified Comp object instance. The result variable is conformed by the specified variable followed by the appropiate flag name, as you can in the below list.

[ResultVar.CtlHold] Specifies whether transmission is waiting for the CTS (clear-to-send) signal to be sent. If this variable is "True", transmission is waiting.
[ResultVar.DsrHold] Specifies whether transmission is waiting for the DSR (data-set-ready) signal to be sent. If this variable is "True", transmission is waiting.
[ResultVar.RlsHold] Specifies whether transmission is waiting for the RLSD (receive-line-signal-detect) signal to be sent. If this variable is "True", transmission is waiting.
[ResultVar.XoffHold] Specifies whether transmission is waiting because the Xoff character was received. If this variable is "True", transmission is waiting.
[ResultVar.XoffSent] Specifies whether transmission is waiting because the Xoff character was transmitted. If this variable is "True", transmission is waiting. Transmission halts when the Xoff character is transmitted to a system that takes the next character as Xon, regardless of the actual character.
[ResultVar.Eof] Specifies whether the end-of-file (EOF) character has been received. If this variable is "True", the EOF character has been received.
[ResultVar.Txim] If this variable is "True", there is a character queued for transmission that has come to the communications device by way of the npCompTransmitChar action. The communications device transmits such a character ahead of other characters in the device's output buffer.

The result variable also can store "False" if an error occur. In this last case the [LastError] variable store information about the error.

↑↑

npCompTransmitChar

Transmit a character ahead of any pending data in output buffer in the specified Comp object instance. The action is useful for sending an interrupt character (such as a CTRL+C) to a host system. Character transmission is subject to normal flow control and handshaking. If the device is not transmitting, this action cannot be called repeatedly. Once tgus actuib places a character in the output buffer, the character must be transmitted before the function can be called again. If the previous character has not yet been sent, this action raises an error. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] variable store information about the error.

↑↑

npOnCompRxChar

Set a subroutine to be executed when arrived characters arrive to the input buffer in the specified Comp object instance. The count variable store the number of bytes in input buffer waiting to be read. This event is usually used for reading characters from input buffer using read actions. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] variable store information about the error.

↑↑

npOnCompError

Set a subroutine to be executed when a line status error occurs in the specified Comp object instance. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] variable store information about the error.

↑↑

npOnCompBreak

Set a subroutine to be executed when hardware detects a break on input in the specified Comp object instance. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] variable store information about the error.

↑↑

npOnCompRing

Set a subroutine to be executed when Ring indicator is detected in the specified Comp object instance. This event is mainly used when programming modem application. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] variable store information about the error.

↑↑

npOnCompRxFlag

Set a subroutine to be executed when event character arrives in the specified Comp object instance. Set the EventChar option to set event charachter ASCII code. An event character is also placed in input buffer. The only difference between event and non-event character is that event character triggers npOnCompRxChar and npOnCompRxFlag events, while non-event characters triggers only npOnCompRxChar event. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] variable store information about the error.

↑↑

npOnCompTxEmpty

Set a subroutine to be executed when output buffer becomes empty, that is, all characters in output buffer have been transmitted in the specified Comp object instance. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] variable store information about the error.

↑↑

npOnCompCTSChange

Set a subroutine to be executed when CTS (clear-to-send) signal has changed state in the specified Comp object instance. If the OnOff variable is "True", CTS has changed from low to high state. If the "OnOff" variable is "False", CTS has changed from high to low state. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] variable store information about the error.

↑↑

npOnCompDSRChange

Set a subroutine to be executed when DSR (data-set-ready) signal has changed state in the specified Comp object instance. If the "OnOff" argument is "True", DSR has changed from low to high state. If the "OnOff" variable is "False", DSR has changed from high to low state. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] variable store information about the error.

↑↑

npOnCompRLSDChange

Set a subroutine to be executed when RLSD (receive-line-signal-detected) signal has changed state in the specified Comp object instance. If the "OnOff" variable is "True", RLSD has changed from low to high state. If the "OnOff" variable is "False", RLSD has changed from high to low state. The result variable store "True" if everything is OK, or "False" if not. In this last case the [LastError] variable store information about the error.

↑↑

Action errors subroutine

All the NeoPlugins deal with errors in the same way that NeoBook does: when the plugin found an action error the [LastError] variable store information about the error, so you can take care about this variable when execute an action.

But all the NeoPlugins also incorporate an advanced way to deal with possible action errors. You can define a subroutine named OnNeoPluginActionError in order to be executed when some action error are found and you can use this variables inside:

[LastError] The last action error message.
[PluginName] Store the plugin name which cause the error.

Note that this error handling subroutine are shared for all the NeoPlugins, so you no need to specify a subroutine for every plugin you use in your publication because the same subroutine are recognized and automagically used by every NeoPlugin. Below you can view a sample of this subroutine code:

:OnNeoPluginActionError
  AlertBox "NeoPlugin Error" "Error [LastError] in plugin: [PluginName]"
Return

Also note that the use of this NeoPlugins error handling subroutine is completelly optional. You can continue using the [LastError] variable as usual and even use the both methods at the same time.

↑↑