Moxa Technologies NPort PCG Manual

Programmable Communication Gateway

Programmer’s Guide

First Edition, April 2003

Moxa Technologies Co., Ltd.

Tel: +866-2-8919-1230

Fax: +886-2-8919-1231

www.moxa.com

[email protected]

Programmer’s Guide for NPort PCG

The software described in this manual is furnished under a license agreement and

may be used only in accordance with the terms of that agreement.

Moxa Technologies Co., Ltd.

Reproduction without permission is prohibited.

Trademarks

MOXA is a registered trademark of

Moxa Technologies Co., Ltd.

All other trademarks or registered marks in this manual belong to their respective

manufacturers.

Disclaimer

Information in this document is subject to change without notice and does not

represent a commitment on the part of Moxa.

Moxa provides this document “as is,” without warranty of any kind, either

expressed or implied, including, but not limited to, the particular purpose. Moxa

reserves the right to make improvements and/or changes to this manual or the

product(s) and/or program(s) described herein at any time.

Information provided in this manual is intended to be accurate and reliable.

However, Moxa Technologies assumes no responsibility for its use, or for any

infringements on the rights of fourth parties which may result from its use.

This manual could include unintentional technical or typographical errors.

Changes are periodically made to the information herein, with the changes

incorporated into new editions of the publication.

MOXA Internet Services

Customer satisfaction is our number one concern. To ensure that customers

receive the full benefit of our products, Moxa Internet Services has been set up to

provide technical support, driver updates, product information, and user’s manual

updates.

The following services are provided:

E-mail for technical support

address: support@moxa.com.tw

World Wide Web site for product information

address: http://www.moxa.com

http://www.moxa.com.tw

Table of Contents

1. Introduction ................................................................................... 1-1

Moxa OS ...................................................................................................1-1

SDK (Software Development Kit) ............................................................1-1

User Application Space ..................................................................1-2

SDK Function Group Overview.....................................................1-2

2. Installing SDK ................................................................................ 2-1

System Requirements ................................................................................2-1

Installing SDK...........................................................................................2-2

Desktop Icons............................................................................................2-3

Setting Up Environment Variables ............................................................2-3

3. Developing User Applications ..................................................... 3-1

Application Development Flow.................................................................3-1

Development System.................................................................................3-2

Source Code Editing..................................................................................3-3

Compiling and Linking your Application..................................................3-3

Creating a Make File ......................................................................3-3

Generating a COM file...................................................................3-4

Using COM2AP ........................................................................................3-4

Intellectual Property Protection......................................................3-4

Embedding a Private Key in your Application...............................3-4

Embedding a Private Key from the Command Line ......................3-5

Using SDK Manager .................................................................................3-6

Searching for NPort PCGs .............................................................3-6

Selecting/Deselecting PCGs.........................................................3-10

Configuring an NPort PCG ..........................................................3-12

Application Download .................................................................3-20

Run Application / Debug..............................................................3-22

Example Programs ..................................................................................3-25

4. Application Deployment ............................................................... 4-1

Changing Default Settings for Multiple PCGs ..........................................4-1

Creating System Firmware—COM2FRM.................................................4-2

Command Line Usage....................................................................4-3

Field Utility ....................................................................................4-3

Developing a PCG Utility .........................................................................4-4

DSCI Library..................................................................................4-4

AP ID .............................................................................................4-4

5 PCG FAQs.......................................................................................... 5-1

1Introduction

NPort Programmable Communication Gateway (PCG) is a stand-alone, programmable

communication device with RS-232/422/485 and Ethernet interface for industrial

automation. PCG provides a Moxa embedded OS (Moxa OS) and TCP/IP

communication stack, and Software Development Kit (SDK) that allows system

integrators to build up their own proprietary solution without using traditional PCs.

Moxa OS

NPort PCG has an embedded, small footprint, multi-tasking OS developed by

Moxa Technologies Co. Ltd. It was developed originally for TCP/IP-based

Terminal Server products starting in 1996. It is a powerful and reliable software

platform with user-friendly SDK. Its major features are:

 16-bit, Unix-like embedded operating system

 Small footprint (<300 KB with TCP/IP protocol stack)

 Preemptive scheduler

 Stream I/O

 Standard BSD Sockets for TCP/IP programming with multi-TCP session support

SDK (Software Development Kit)

To assist in the development of NPort PCG applications, Moxa provides a

comprehensive and easy-to-use SDK, designed for use on Windows

95/98/ME/NT/2000/XP platforms. The main features are as follows.

 Borland™ Turbo C 2.01 compiler

 SDK libraries with more than 100 function calls

 SDK Manager and COM2AP utilities for software download and troubleshooting

 PComm Terminal Emulator

 More than 20 example programs

 Documentation

 Single-task user program

 64 KB of user program space (tiny mode in Turbo C)

Other advanced features include:

 COM2FRM utility for advanced application deployment

 DSCI library for utility development

1-2

User Application Space

The user application space available on an NPort PCG is a full 64 KB. This is

because the serial I/O, Ethernet, and TCP/IP protocol stack buffers occupy part

of the kernel space. In general, this amount of space is sufficient for protocol

conversions, and is sufficient for even more complex applications, such as

Modbus conversion.

SDK Function Group Overview

The SDK Library contains six groups of function calls. The following table lists

the six function call groups along with their primary function.

SDK Library Function Group Overview

Function Call Group Description

Serial I/O API Serial communication function calls that follow

the same style as PComm Library. This API

includes communication parameters, character

read/write, block read/write, I/O control, break

generation, and more.

BSD Socket API Standard BSD Socket API for TCP/IP

programming. Supports TCP and UDP

communication.

Simplified Socket API Simplified TCP/IP programming. Supports TCP

and UDP communication.

System Control API Overall system control for NPort PCG including

Watchdog timer enable/disable, system clock

settings, system configuration, system restart,

interrupt handling, and serial interface selection.

Flash Access API Read, write, erase user storage space on flash.

There are 32 KB for NPort 4511.

Debug API For sending messages to the debug window in

SDK Manager.

2Installing SDK

This chapter covers:

 How to install SDK utilities and Library

 How to install the Turbo C compiler and environmental variables

 The location of Libraries and Example Files

System Requirements

You will need to have the following items available to use SDK’s development

tools:

 Windows 9x, NT, ME, 2000, or XP operating system

 At least 64 MB of RAM

 At least 15 MB of hard disk space

2-2

Installing SDK

To install Moxa SDK on a Windows system, insert the software CD-ROM

included with the product into your computer’s CD-ROM drive. The installation

program should start automatically. Simply follow the onscreen instructions to

complete the installation.

The installation procedure installs the following files:

Directory Sub Directory\Files Description

…\SDK \Document\  NPort 4511 hardware installation guide

 Programmer’s guide

 API Reference

\Example\ SDK example files

\Firmware\np4511.rom Kernel firmware for NPort 4511

\Include\ This directory contains all declaration files

sdkdbg.h Debug symbol API declarations

sdkflash.h Flash access API declaration

sdknet.h Simplified Sockets API declaration

sdksio.h Serial I/O API declaration

sdksock.h BSD socket API declaration

Sdksys.h System API declaration

\Library\

C0sdk.obj

This directory contains the SDK Library files

Object code for all APIs.

Moxa_sdk.lib API library for NPort 4511 SDK.

\Utility\ This directory contains SDK Manager,

COM2AP, COM2FRM, MoxaTerm utilities

along with correspond help file.

\Dscilib\Library\ This directory contains library for utility

development on Windows

Dsci.dll DLL file for DSCI (Device Server Control

Interface) API

Dsci.h Declaration file for DSCI API

Dsci.lib Library file for DSCI API

\Dscilib\Example\ Example program for DSCI

…\TC tcc.exe Turbo C 2.01 compiler

tlink.exe Turbo C 2.01 linker

\Include\ Include file for Turbo C.

\Lib\ Library file for Turbo C

2-3

Desktop Icons

The SDK installation places three program icons on your computer’s desktop

that serve as shortcuts to the following programs: NPort SDK Manager,

COM2AP, and Terminal Emulator.

Setting Up Environment Variables

During the installation procedure, the SDK setup program automatically sets up

your environment variables for the Turbo C compiler. You may also set up the

environment variables manually from Control panel System, or you can add

a command line to autoexec.bat.

Assuming the installed directory for SDK is C:\PCGSDK, the command lines are

as follows:

path=c:\pcgsdk\tc;%path%

set INCLUDE=c:\pcgsdk\tc\include

set LIB=c:\pcgsdk\tc\lib

Tabla de contenidos

Otros manuales de Puerta de Moxa Technologies

Moxa Technologies

Moxa Technologies MGate-4101-MB-PBS Manual de usuario

Moxa Technologies

Moxa Technologies MGate 5102-PBM-PN Manual de usuario

Moxa Technologies

Moxa Technologies MGATE EIP3000 DF1 Manual de usuario

Moxa Technologies

Moxa Technologies NPort Z3150 Manual de usuario

Moxa Technologies

Moxa Technologies NPort 5610 series Hoja de instrucciones

Moxa Technologies

Moxa Technologies 6110 Manual de usuario

Moxa Technologies

Moxa Technologies OnCell G3470A-LTE-EU-T Manual de usuario

Moxa Technologies

Moxa Technologies MGate MB3170 Manual de usuario

Moxa Technologies

Moxa Technologies MGate 5122 Series Manual de usuario

Moxa Technologies

Moxa Technologies MGate EIP3170 Manual de usuario

Moxa Technologies

Moxa Technologies MGate 5119 Series Manual de usuario

Moxa Technologies

Moxa Technologies OnCell Series Manual de usuario

Moxa Technologies

Moxa Technologies Mgate MB3660 Manual de usuario

Moxa Technologies

Moxa Technologies MGate MB3000 Modbus Manual de usuario

Moxa Technologies

Moxa Technologies NPort 6110 Manual de usuario

Moxa Technologies

Moxa Technologies MGate MB3480 Manual de usuario

Moxa Technologies

Moxa Technologies MGate 5103 Manual de usuario

Moxa Technologies

Moxa Technologies OnCell G3111 Manual de usuario

Moxa Technologies

Moxa Technologies CCG-1500 Series Manual de usuario

Moxa Technologies

Moxa Technologies AIG-501-T-AZU-LX Manual de usuario

Moxa Technologies

Moxa Technologies OnCell G3150A-LTE-EU-T Manual de usuario

Moxa Technologies

Moxa Technologies MGate 5109 Manual de usuario

Moxa Technologies

Moxa Technologies SMG-6100 Manual de usuario

Moxa Technologies

Moxa Technologies MGate 5135 Series Manual de usuario

Manuales populares de Puerta de otras marcas

LST

LST M500RFE-AS Manual de usuario

Kinnex

Kinnex Media Gateway Manual de usuario

2N Telekomunikace

2N Telekomunikace 2N StarGate Manual de usuario

Mitsubishi Heavy Industries

Mitsubishi Heavy Industries Superlink SC-WBGW256 Manual de usuario

ZyXEL Communications

ZyXEL Communications ZYWALL2 ET 2WE Manual de usuario

Telsey

Telsey CPVA 500 - SIP Manual de usuario

RTA

RTA 460A-NNA4 Hoja de especificaciones

Shaw

Shaw Gateway HDPVR Manual de usuario

ABB

ABB VSN900 Guía de inicio rápido

Commander

Commander Pulse Manual de usuario

2N Telekomunikace

2N Telekomunikace ATEUS EasyGate 501309E Manual de usuario

NETGEAR

NETGEAR C6300BD Manual de usuario

Amit

Amit CDW531AM Manual de usuario

HMS

HMS Netbiter EasyConnect EC150 Manual de usuario

Huawei

Huawei EchoLife HG620 Manual de usuario

AT&T

AT&T U-verse 3801 Manual de uso y cuidado

Logic IO

Logic IO RTCU MX2 turbo Manual de usuario

Suttle

Suttle MediaMAX MXM-521 Manual de usuario