Protocol Developer

Example scripts

For all Script commands we offer here at examples to download.

• example_3964
  Communication with 3964R or 3964 needs an initialization before data exchange is possible. You need to set the ReceiveBuffer and the maximum number of bytes to receive.
• example_3964R
  Communication with 3964R or 3964 needs an initialization before data exchange is possible. You need to set the ReceiveBuffer and the maximum number of bytes to receive.
• example_ASCII_IP
  This script demonstrates the conversion of a buffer containing an IP-address as an ASCII-String into a Long variable. This long variable could be used wherever an IP-address is necessary.
• example_Basisboard_Set_RS_FB_StateLED
  Sets the given parameter to the const-value. The parameter is one of the parameters defined for this command, the value must be one of the valid values for this parameter.
• example_Basisboard_Set_RS_StateLED
  Sets the given parameter to the const-value. The parameter is one of the parameters defined for this command, the value must be one of the valid values for this parameter.
• example_CalcChecksum
  This command calculates a checksum with the given method for a number of bytes in the device's memory. The variable source is a buffer containing the data the checksum should be calculated for. Destination is a word variable which holds the checksum after the routine finishes with return code OK. The number of characters is a variable which holds the number of bytes the checksum should be calculated for. Checksum method defines which method should be used for calculation.
• example_Calculate
  This command is used for assigning the result of a mathematical or logical operation of exactly two operators to a given variable.
• example_CAN_Layer_2
  If you like to use CAN Layer 2 we provide a mechanism to access every CAN Message without any Filter. Please note that in this case, the data format for ReadBus and Write bus differs from other functionality. From now on, we have The COB-ID of the message to be read or send in the first 2 bytes of the data area.
• example_Convert
  Use this command if you like to change its data format. It is possible to convert 3 bytes ASCII to a binary word value or vice versa. All known conversion types are usable either for source and for destination, so data conversion is possible from every data representation to another.
• example_CopyIndex
  this command copies a number of bytes from a source to a destination. A Source is given by a variable identifier and an offset within the source buffer. The destination is also given by a variable identifier and the offset is given in a variable too.
• Example_copy_data
  Copy a number of bytes from one variable to another. The number of bytes is a variable containing the number of bytes, Source and Destination are meant to be Buffer variables; it is also possible to use an ordinal variable as a byte, word or long instead. If necessary it is possible to indicate an ordinal variable.
• Example_CO_V4
  Every Script MUST have the following ObjectTable, and length MUST be: ((number of objects) + 2) * 12 If length is not correct, there will be big problems by running the script! var a_ObjectTable : buffer[48]; (2 Objects + 2) * 12 = 48 This line MUST done befor CANopen-objects will be created InitObjectTable ( 2 , a_ObjectTable[0] ) ; 2=number of objects
• example_define_memory
  A constant value is transfered into the memory used by the given variable. This command is used to predefine a variable with a constant value.
• Example_delay
  Execution of the actual script is delayed for given time. The time is in milliseconds and can take directly values from 0 to 65535. It is not possible to hold the time in a variable.
• example_DIN19244 (Master)
  This command exchanges data with DIN 19244 routine. Sendbuffer and Receivebuffer must have a special data format. See DIN19244 specification for details. After data was sent by the gateway the routine waits for a response.
• example_DN_IC_init
  Example for Script DeviceNet parameter into the EDS file and the settings of the script.
• example_DN_Init
  Example for Script DeviceNet parameter into the EDS file and the settings of the script.
• Example_EmptyFile
  This file generates an empty but valid script this script only contains information about its last compilation
• example_Errorcode
  Sets the given parameter to the const-value. The parameter is one of the parameters defined for this command, the value must be one of the valid values for this parameter.
• example_FB-AN
  This script realized a script for our filedbus-fieldbus gateway where one side is CANopen
• example_FB-FB-CO
  This script realized a script for our filedbus-fieldbus gateway where one side is CANopen.
• example_FB-FB-DN
  This script realized a script for our filedbus-fieldbus gateway where one side is DeviceNet
• Example_FB-FB-EN
  This script realized a script for our fieldbus-fieldbus gateway where one side is Ethernet
• example_FB-FB-PB
  This script realized a script for our filedbus-fieldbus gateway where one side is Profibus-DP
• example_FB-FB_autodetect
  This script realized a script for every filedbus-fieldbus gateway where one side is fieldbus
• example_FBRS_Init
  init 2. RS interface (fieldbus)
• example_FE_ModbusTCP
  This script realized the Modbus-RTU-function described in UNIGATE Manual
• example_FE_WebServer
  It is necessary to initialize the Fast Ethernet device with this command. A Fast Ethernet device is capable of having 4 IP-connections simultaneously; even a UDP is treated as a "connection". In configmode you have a FTP-connection and a Telnet-connection. With this FTP-connection you have the possibility to read and write the Script.
• example_FieldbusID
  Sets the given parameter to the const-value. The parameter is one of the parameters defined for this command, the value must be one of the valid values for this parameter.
• example_float_math
  This command is used for calculating floating values.
• example_Get_FieldbusLen
  read or write the actual size of the bus input side, input is seen from the device's view.
• example_gw_control_set_baudrate
  Sets the given parameter to the const-value. The parameter is one of the parameters defined for this command, the value must be one of the valid values for this parameter.
• example_gw_control_set_RS_StateLED
  only for SC Set RS_State_LED will set the bicolor Led on the RS side
• example_gw_control_set_select_ID
  only for SC Set SelectID will set static the 4 yew Led´s on the RS side
• example_gw_control_set_warningTime
  only for SC Set Errorcode will set the 4 yew led´s on the RS side during a default value of 60.000 ms (1 min) or your customer value.
• example_IC_CO_set_ID_and_baudrate_with_basebord
  This example need the base board to set the CO ID and baudrate over the dip switch. Sets the given parameter to the const-value. The parameter is one of the parameters defined for this command, the value must be one of the valid values for this parameter.
• example_IC_functions_DirectAccess
  This value is to be used for ShiftRegisterInputType and ShiftRegisterOutputType. It is necessary to set Input and Output Type to the same value. This is a possibility to direct access the µP port pins.
• example_IC_RS_ModbusMaster
  Transparenter data exchange RS-interface <-> ModbusMasterRTU fieldbus RS
• example_InitFastEthernet
  It is necessary to initialize the Fast Ethernet device with this command. A Fast Ethernet device is capable of having 4 IP-connections simultaneously; even a UDP is treated as a "connection". In configmode you have a FTP-connection and a Telnet-connection. With this FTP-connection you have the possibility to read and write the Script.
• example_InitFIFO
  Sets a virtual ringbuffer to a user defined lenght.
• example_LON
  LON defines a number of SNVT In and SNVT Out variables. A variable is always seen from the LON device, this means an In-variable is received by a LON device. It is necessary to tell the gateway which Input and Output variables are to be used. This is done with the commands LonInMapping and LonOutMapping. All SNVT's which should be available on LON-side are declared by those two commands. All SNVT-types available are given in the map-table, which is a normal script buffer variable. This variable consists of a number of bytes, and each byte defines an SNVT-type. The commands LonInMapping / LonOutMapping create all requested SNVT's. LON variables of type 0 are defined by the commands Set (BusInputSize,x) and Set (BusOutputSize, x). By setting BusInputsize or BusOutputSize to a value greater 0 a variable of type with the given size is created. If the given size is 0 or the command is never called no SNVT 0 is created. The similar behaviour is available for output data.
• example_math_conv_ASCII_Dyn
  Use this command if you like to change its data format. It is possible to convert 3 bytes ASCII to a binary word value or vice versa. All known conversion types are usable either for source and for destination, so data conversion is possible from every data representation to another.
• example_math_conv_float_real
  Use this command if you like to change its data format. It is possible to convert 3 bytes ASCII to a binary word value or vice versa. All known conversion types are usable either for source and for destination, so data conversion is possible from every data representation to another.
• example_MemoryCharPos
  This procedure searches a buffer variable for the appearance of a single character (given in variable b_SearchChar). w_Length is a In-Out-Variable and must contain the number of bytes to be searched and returns the index of the first appearance of the character. If the character is not part of the searchstring the MaxBytes variable contains value 0xFFFF after execution. You may optionally give a dynamic start index where the search should start from (the variable w_Index of type word).
• example_MemoryCompare
  The purpose of this command is to find a difference in two buffers. You must give a length (how many bytes should be compared), which must be a word value. a_Source1 and a_Source2 are the buffers to be compared. You may optionally give two word variables as start indices where comparison should start in the buffer (using a variable here means this values may be dynamically, instead of using a static, fixed index for the buffer variable. After the execution of this command, the variable w_length holds the result, so any value previously contained in this variable may be modified. The result is 0, if both buffers are identical for the given length, 0 : B1=B2 ; The result is 1, if buffer B1 are greater B2 for the given length, 1 : B1>B2 ; The result is 2, if buffer B2 are greater B1 for the given length, 2 : B1<B2 ;
• example_MemorySearchString
  This procedure searches a buffer a_Source1 for the appearance of a string (given in buffer a_Source2 with the length w_Length2). w_Length1 is a In-Out-Variable and must contain the number of bytes to be searched and returns the index of the first appearance of the string from the main buffer (a_source1) , independent if you use an optional parameter.. If the string is not part of the searchstring the w_Length1 variable contains value 0xFFFF after execution. Optional parameter [w_index1, w_index2]: You may optionally give a dynamic start index where the search should start from (the variable w_Index1/w_Index2 is type word).
• Example_Modbus-RTU (Master)
  This command takes two buffers and sends the data given in the variable Source. Source contains all data necessary for a Modbus RTU record except the CRC checksum. This checksum is generated by the function itself. The function returns the number of bytes received by the Modbus Slave. If a timeout occurs this value is 0. If no timeout occurs the function copies the slave's response data into the variable Destination. You can also set the timeout (before "BusStart") for the response with "Set ( ModbusRTUTimeout , 0 ) ; // 0..65535"
• Example_Modbus-RTU (Slave)
  This script realized the Modbus-RTU-SLAVE function Communication - Modbus - Read modbus Slave Data Write Modbus Slave Data
• Example_Modbus-RTU (Slave) für IC Basisb
  This script realized the Modbus-RTU-SLAVE function - for IC Basisboard with LED display. Communication - Modbus - Read modbus Slave Data Write Modbus Slave Data
• example_ModbusTCP
  This script demonstrates the usage of script commands relating to Modbus TCP
• example_ModBus_Slv
  This script realized the Modbus-RTU-SLAVE function Communication - Modbus - Read modbus Slave Data Write Modbus Slave Data
• example_ParamBusStateLED
  This script shows how the state of the bus may be detected from a script.
• example_Printf_ANSI_C
  Convert a long or float value into a "printf" string from the standard ANSI_C compiler
• example_Profibus_DiagnoseData
  For UNIGATE Profibus SC/IC it is possible to set after "BusStart" a "user diagnostic" data to the PLC.
• example_Profibus_DPV1
  This script needs a hardware which is capable of running DPV1, you will receive errors if your hardware does not support DPV1. This command is used to initialize a object, which should be read or write by an acyclic profibus call. You must provide a Channel number, which is a byte value in the range of 1..255. You must provide the Slot, which corresponds to the Profibus DPV1 Slot Number. Possible values are from 0..254. Provide an Index as a value in the range 0..254, and a length of the object, which is in the range of 1..79 byte. Your a_Data buffer must be big enough to get hold of all data bytes defined by the objects length. Every time a Master write data into an object the b_Changed variable is set to "1", so the script may process the date in the a_Data buffer.
• example_Profibus_IC_DPV1
  This script needs a IC-hardware which is capable of running DPV1, you will receive errors if your hardware does not support DPV1. This command is used to initialize a object, which should be read or write by an acyclic profibus call. You must provide a Channel number, which is a byte value in the range of 1..255. You must provide the Slot, which corresponds to the Profibus DPV1 Slot Number. Possible values are from 0..254. Provide an Index as a value in the range 0..254, and a length of the object, which is in the range of 1..79 byte. Your a_Data buffer must be big enough to get hold of all data bytes defined by the objects length. Every time a Master write data into an object the b_Changed variable is set to "1", so the script may process the date in the a_Data buffer.
• example_Profibus_ParameterData
  For UNIGATE Profibus SC/IC it is possible to read out after "BusStart" the parameter data from the PLC. Make sure that the value of "w_NumberChar" has the calculate lenght. If the lenght is to long for the hardware you get an Error. If the lenght is notequal you get from the PLC, the PLC shows an "parameter fail" and the UNIGATE doesn´t work. If the lenght is equal and the UNIGATE works without an error, the parameter data are stored in variable "a_source" after "BusStart" and Wait ( Bus_Active ) ;.
• example_ReadWriteEEROM
  This script demonstrates saving a number of values permanently in the devices EEROM those values remain even if the device is restarted.
• example_Reset
  It is possible to perform a Hardware Reset of the µP by performing a command to the predefined name Reset;. This name is to be used from script revision 25 and higher. Using this command in earlier scrip revisions lead to undefined behaviour.
• example_RS485
  Determine the kind of the RS interface. Possible values range from 0 to 2, reflecting RS232, RS422 and RS485. If you like to use a UNIGATE-SC in RS485 mode or if you like to use a UNIGATE-IC's TE pin set the corresponding RS-type.
• example_RSModBusRTUSlv
  Only for RS RS Hardware. This script realized the Modbus-RTU-SLAVE function on the fieldbus side. Communication - Modbus - FBRS Modbus RTU Slv Read FBRS Modbus RTU Slv Write
• Example_RS_output
  SendRS writes the given number of characters to the output buffer of the gateway. As the Buffer is filled with data the hardware (no longer the software) is responsible for accessing serial lines. With the action SendRS the script has no more control over the data, it is not possible to clear output string etc. Number is a variable (word) containing the number of bytes to be sent, source is a variable (byte, word, long, ...) containing the data itself.
• example_SendEMail
  This script demonstrates sending an EMail values given for IP Addresses etc may not work because you need your valid values. the EMail is defined by variables and send once after sending the script stops. no other communication is used.
• example_SetSerialInBufLen
  Set the system serial input buffer to a user defined lenght. The serial input data stored now in the buffer "a_Source".
• example_ShiftRegister_Basis_FB_FB
  Example for shift registers and the base board the LED's of the base board are connected to the shift register. In this example a simple value is shifted, so some LED are on and some other are off. The calculate function ignores any overflow, so we have an ring counter, and the 4 yellow LEDs behave like a binary counter. This script will compile and run from Version 1.28 of Protocol Developer, earlier Versions produce compile errors.
• example_ShiftRegister_Basis_IC
  Example for shift registers and the base board. The LED's of the base board are connected to the shift register. In this example a simple value is shifted, so some LED are on and some other are off. The calculate function ignores any overflow, so we have an ring counter, and the 4 yellow LEDs behave like a binary counter. This script will compile and run from Version 1.28 of Protocol Developer, earlier Versions produce compile errors.
• example_Transparent_IC
  Transparent 1 Byte I/O create for UNIGATE IC and basis board.
• example_Transparent_IC_CO
  Transparent 8 Byte I/O create for UNIGATE IC-CO and basis board.
• example_Transparent_IC_DN
  Transparent I/O create for UNIGATE IC (DeviceNet) and basis board.
• example_Transparent_IC_Profibus
  Transparent 1 Byte I/O create for UNIGATE IC (Profibus) and basis board.
• Example_VersionInfo
  This Script demonstrates the usage of the script Info commands. The commands defines some texts, which are displayed in the devices boot message.
• example_WaitBusDataChanged
  The command waits the given time for changing busdata. The number of bytes set in the variable Watchsize are observed. If no byte of the observed changes a timeout (return code 2) occurs. The command immediately return on changing data. If the value for timeout is 0 then the commands wait infinite. The value for the Watchsize should never be 0.