Perle Systems DS1, TS2 Custom App/Plugin

181

Management

Custom App/Plugin

Overview

You can create custom applications for the IOLAN by using the Perle SDK. See the SDK

Programmer’s Guide (the SDK and guide are accessible via a request form located on the Perle

website at www.perle.com/supportfiles/SDK_Request.shtml) for information about the

functions that are supported. You must download the program and any ancillary files to the IOLAN

and set the Serial Port Profile to Custom App/Plugin to run a custom application. You must also

specify the program executable in the Command Line parameter.

A custom application or plugin can be run on the serial port. In this situation, the application will start

once the serial port is activated and operate solely on the context of that serial port and any network

communications related to that serial port. You could run a different custom application on each serial

port. The serial port custom application or plugin is configured by specifying the Custom

App/Plugin profile for the serial port.

The system level custom application or plugin will begin execution immediately following the system

startup. It runs on the context of the whole system and can access network communications as well as

any or all serial ports.

Field Description

Community The name of the group that devices and management stations running SNMP

belong to. Community only applies to SNMP v1 and v2c.

Inform Timeout This is only used for Info rm traps. Select the number of second s to wait for the

acknowledgement of the trap. T

Default: 1 second.

Retires This is only used for Inform traps. Select the number of times the trap will be

sent if no acknowledgement is received.

Default: 3

V3 Trap User This field identifies the system sending the traps to the host receiving the traps.

Same user name is used for all traps sent by this system.

V3 EngineID This is the current Engine ID. The Engine ID is a string which uniquely identifies

this SNMP agent.

V3 Use Default

EngineID

When this field is selected, the firmware will use the default Engine ID. The de-

fault Engine ID uses the MAC address of the Ethernet interface to ensure that the

Engine ID is unique to this agent.

V3 Create

EngineID Using

String

The string entered in this field will be combined with the defined string in hex of

800007AE04 to form the EngineID. Ensure each string is unique for each

IOLAN on your network.

Contents

Main Page Preface About This Book Intended Audience Documentation Typeface Conventions Online Help T able of Contents Preface .................................................................................3 Chapter 1 Introduction......................................................20 Chapter 2 Hardware and Connectivity ............................24 Chapter 3 Configuration Methods ...................................30 Chapter 4 Getting Started.................................................46 Chapter 5 Using DeviceManager and WebManager.......54 Chapter 6 Configuring Serial Ports .................................62 Serial Port Profiles..................................................................... 65 Advanced.................................................................................. 114 Chapter 7 Network Settings ...........................................118 Introduction.............................................................................. 118 IP Settings ................................................................................ 119 Advanced.................................................................................. 123 Chapter 8 Configuring Users .........................................126 Adding/Editing Users .............................................................. 128 Chapter 9 Configuring Security .....................................135 Channels................................................................................... 143 Chapter 10 Configuring I/O Interfaces...........................137 I/O UDP...................................................................................... 162 I/O Modbus Slave..................................................................... 165 Modbus I/O Access.................................................................. 166 TruePort I/O .............................................................................. 171 Accessing I/O Data Via TruePort............................................ 173 Chapter 11 Configuring the System ..............................178 Management............................................................................. 179 Chapter 12 Controlling the I/O Channels ......................186 Chapter 13 System Administration................................188 Appendix A Virtual Modem AT Commands ..................202 Appendix B Pinouts and Cabling Diagrams .................204 Appendix C Setting Jumpers .........................................212 Appendix D I/O Wiring Diagrams...................................217 Wiring I/O Diagrams................................................................. 217 Appendix E TruePort Utility............................................222 Appendix F Accessories.................................................225 Appendix G Troubleshooting.........................................232 Appendix H Data Logging ..............................................240 Page Introduction About the IOLAN IOLAN Family Models IOLAN Features Hardware Software Accessing the IOLAN General Features Security Hardware and Connectivity IOLAN Components Whats Included What You Need to Supply Available Accessories Power Supply Specifications Desktop Models Serial Only Models I/O Models Getting to Know Your IOLAN DS1 TS2 I/O Top View End View Console/Serial Switch Console Mode Serial Mode Powering Up the IOLAN Models with Barrel Connector +- Models with Terminal Block Connector 9-30 VDC Left Right Configuration Methods Configuration Methods Overview Configures an IP Address Requires a Configured IP Address Easy Config Wizard DeviceManager Connecting to the IOLAN Using DeviceManager Page Using DeviceManager Navigating the Options Downloading the Configuration WebManager Connecting to the IOLAN Using WebManager Page Using WebManager Command Line Interface Connecting to the IOLAN Using the CLI Through the Network Through the Serial Port Using the CLI Menu Connecting to the IOLAN Using the Menu Using the Menu DHCP/BOOTP Connecting to the IOLAN Using DHCP/BOOTP Using DHCP/BOOTP DHCP/BOOTP Parameters SNMP Connecting to the IOLAN Using SNMP Using the SNMP MIB Getting Started Easy Configuration Wizard Setting Up the Network Using DeviceManager Using WebManager Using a Direct Serial Connection to Specify an IP Address Using a Direct Serial Connection to Enable BOOTP/DHCP Using ARP-Ping For an IPv6 Network Setting Up the Serial Port(s) Page Setting Up Users Using DeviceManager and WebManager Navigating DeviceManager/WebManager DeviceManager WebManager Using DeviceManager to Connect to the IOLAN Starting a New Session Assigning a Temporary IP Address to a New IOLAN Adding/Deleting IOLANs Manually Logging in to the IOLAN Using WebManager to Connect to the IOLAN Logging into the IOLAN Configuration Files Creating a New IOLAN Configuration in DeviceManager Opening an Existing Configuration File Managing the IOLAN Configuring Serial Ports Serial Ports Functionality Page Resetting a Serial Port Serial Port Profiles Common Tabs Hardware Tab Field Descriptions Page Packet Forwarding Tab Field Descriptions Page Console Management Profile Page Page Page TruePort Profile Page Adding/Editing Additional TruePort Hosts Page Page Page Page TCP Sockets Profile Page Adding/Editing Additional Hosts Page Page Page UDP Sockets Profile Page Page Page Terminal Profile Page Page Page User Service Settings Login Settings Telnet Settings Serial Tunneling Profile Page Page Virtual Modem Profile Page Page Page Phone Number to Host Mapping VModem Phone Number Entry Control Signal I/O Profile Input Signal Field Descriptions Output Signal Field Descriptions Modbus Gateway Profile Page Advanced Field Descriptions Modbus Slave IP Settings Field Descriptions Adding/Editing Modbus Slave IP Settings Page Modbus Slave Advanced Settings Field Descriptions Custom Application Profile General Tab Field Description Advanced Advanced Serial Settings Tab Modems Tab Adding/Editing a Modem Page TruePort Bau d Rate Tab Network Settings IP Settings IPv4 Settings IPv6 Settings Adding/Editing a Custom IPv6 Address Advanced Advanced Host Table Adding/Editing a Host Route List Adding/Editing Routes Page Configuring Users Page Adding/Editing Users General Tab Page Services Tab Advanced Tab Sessions Tab Page Serial Port Access Tab Configuring Security Services Functionality Field Descriptions Configuring I/O Interfaces Technical Specifications Digital I/O Digital Input Digital Output Settings I/O Access Functionality Advanced Slave Modbus Settings Failsafe Timer Functionality UDP Functionality I/O UDP Settings Temperature Functionality Channels Analog Page Digital Input Page Digital Output Page Page Relay Page Digital I/O Extension Page Digital Input/DSR/DCD/CTS Digital Output/Relay/DTR/RTS Page Adding/Editing Additional Hosts Page Temperature Page Alarm Settings Basic Analog Alarm Settings Advanced Analog Alarm Settings I/O UDP UDP Unicast Format UDP Broadcast Packet Analog Section Digital/Relay Section Serial Pin Signal Section UDP Unicast Example I/O Modbus Slave Modbus Serial Application Connected to the Serial Port Modbus Serial Application Connected to the Network Modbus TCP Application Modbus I/O Access Function Codes I/O Coil/Register Descriptions Serial Port Coil/Register Descriptions A4/T4 Registers A4D2/A4R2 Registers D4/D2R2 Registers Serial Pin Signals TruePort I/O TruePort/Modbus Combination API Over TruePort Only Accessing I/O Data Via TruePort Introduction Setup Format of API Commands Get Commands Command Format Response Format Set Commands Command Format Successful Response Format Unsuccessful Response Format Error Codes I/O SNMP Traps Configuring the System Alerts Syslog Management SNMP SNMP Traps Tab Field Descriptions Custom App/Plugin Field Description Advanced Login Tab Field Descriptions Bootup Files Tab Field Descriptions Message of the Day (MOTD) Tab Field Descriptions TFTP Tab Field Descriptions Controlling the I/O Channels I/O Channels Page System Administration Managing Configuration Files Saving Configuration Files Downloading Configuration Files Downloading Configuration Files to Multiple IOLANs Uploading Configuration Files Specifying a Custom Factory Default Configuration Resetting the IOLAN to the Default Configuration Downloading IOLAN Firmware Calibrating I/O Calibrating Analog Input Page Calibrating Temperature Input Calibrating Thermocouple Calibrating RTD Calibrating Analog Channels Resetting Calibration Data Setting the IOLANs Date and Time Rebooting the IOLAN Resetting the IOLAN to Factory Defaults Language Support Loading a Supplied Language Translation Guidance Software Upgrades and Language Files Downloading Terminal Definitions Creating Terminal Definition Files Resetting Configuration Parameters Lost admin Password Virtual Modem AT Commands A Virtual Modem Initialization Commands Page Pinouts and Cabling Diagrams B Pin 14 Pin 25 Serial Pinouts DB25 Female Pin 1 Pin 25 Pin 14 Pin 13 RJ45 DB9 Male (Serial Only) DB9 Male I/O EIA-232 Cabling Diagrams Terminal DB25 Connector DB25 Male DB25 Female RJ45 DB9 Male Modem DB25 Connector DB25 Male RJ45 DB9 Male Setting Jumpers C 1-Port IOLAN IOLAN DB25 Male/Female IOLAN RJ45 IOLAN DB9 2-Port IOLAN Digital I/O Module Analog Input Module I/O Wiring Diagrams D Wiring I/O Diagrams Digital I/O Digital Input Wet Contact Digital Output Sink Digital Output Source Analog Input Current Volt age Temperature Input Thermocouple Relay Output Normally Open Contact Normally Closed Contact TruePort Utility E TruePort Network API I/O Access Over TruePort API Request Format API Response Format Error Codes Accessories F Starter Kit (Adapters/Cable) RJ45F to DB25M DTE Crossover Adapter RJ45F to DB25M DCE Modem Adapter RJ45F to DB25F DTE Crossover Adapter RJ45F to DB9M DTE Crossover Adapter RJ45F to DB9F DTE Crossover Adapter Sun/Cisco RJ45M Connector Cable for Rack Mount Models Page Troubleshooting G Hardware Problems Communication Issues DeviceManager Problems Host Problems Login Problems Page Problems with Terminals Unknown IP Address DHCP/BOOTP Problems Language Problems Long Reboot Cycle I/O Models IPv6 Issues Contacting Technical Support Making a Technical Support Query Who To Contact Have Your Product Information Ready Making a support query via the Perle web page Repair Procedure Feedback on this Manual Data Logging H Trueport Profile TCP Socket Profile Modbus Remapping I Modbus Remapping Feature Create a configuration file Line format for one UID is: Page Glossary Page Index A B C D O P R S T