RM003602-0404
|
|
|
Top Searches for this datasheet
LAPTOP SERVICE MANUAL - LAPTOP SERVICE MANUAL
laptop - laptop
irobex - irobex
hyperterminal - hyperterminal
RM003602-0404 - RM003602-0404
eZ80L92/F91/F92
ZirDADemo Application Commands
RM003602-0404
ZiLOG Worldwide Headquarters Race Street Jose, 95126 Telephone: 408.558.8500 Fax: 408.558.8300 www.ZiLOG.com
This publication subject replacement later edition. determine whether later edition exists, request copies publications, contact:
ZiLOG Worldwide Headquarters Race Street, Jose, 95126-3432 Telephone: 408.558.8500 Fax: 408.558.8300 www.ZiLOG.com
Document Disclaimer
ZiLOG registered trademark ZiLOG Inc. United States other countries. other products and/or service names mentioned herein trademarks companies with which they associated. ©2004 ZiLOG, Inc. rights reserved. Information this publication concerning devices, applications, technology described intended suggest possible uses superseded. ZiLOG, INC. DOES ASSUME LIABILITY PROVIDE REPRESENTATION ACCURACY INFORMATION, DEVICES, TECHNOLOGY DESCRIBED THIS DOCUMENT. ZiLOG ALSO DOES ASSUME LIABILITY INTELLECTUAL PROPERTY INFRINGEMENT RELATED MANNER INFORMATION, DEVICES, TECHNOLOGY DESCRIBED HEREIN OTHERWISE. Devices sold ZiLOG, Inc. covered warranty limitation liability provisions appearing ZiLOG, Inc. Terms Conditions Sale. ZiLOG, Inc. makes warranty merchantability fitness purpose Except with express written approval ZiLOG, information, devices, technology critical components life support systems authorized. licenses conveyed, implicitly otherwise, this document under intellectual property rights.
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
Table Contents
List Tables List Figures viii Introduction About This Manual Intended Audience Manual Organization. Related Documents Definitions. Manual Conventions Safeguards Trademarks ZirDADemo Application Overview ZirDADemo Architecture Functions Used ZirDADemo Application. Executing ZirDADemo Application Pre-requisites File Transfer Using Single Command Transferring File from eZ80® Device Transferring File from eZ80® Device Transferring File from Laptop eZ80® Device Transferring Received File back Laptop File Transfer Using Multiple Commands Transferring File from eZ80® Device Laptop Aborting File Transfer Progress File Transfer Between ZirDA-based eZ80® Platforms Using ZirDADemo Application Chat Service Interoperability ZirDADemo Application Commands ZirDADemo Application Command Descriptions Common IrDA Commands
RM003602-0404
Table Contents
eZ80L92/F91/F92 ZirDADemo Application Commands
help actirda deactirda. getirstats setqos dscv dump disp. Using IrOBEX InBOX Service obconn obput obget obabort obdisc Generic IrOBEX File Transfer Commands obsendfile. obsendobj obdemo obgetdefault obsendvcard obgetobj IrOBEX Statistics obstats obdispobj Using IrCOMM (3-Wire Raw) conn send disc commdemo Appendix A-The ZiLOG Website Preprinted Documentation
Table Contents
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
Customer Feedback
RM003602-0404
Table Contents
eZ80L92/F91/F92 ZirDADemo Application Commands
Table Contents
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
List Tables
Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Table Related ZirDA Documents Definition Common IrDA Terms. mon_task.c Functions mon_uart.c Functions Shell_main.c Function ZirDADemo Application IrOBEX Client Callback Functions ZirDADemo Application IrOBEX Server Callback Functions ZirDADemo Application IrOBEX Commands Process Functions ZirDAIrOBEX Server Functions ZirDADemo Application IrCOMM Commands Process Functions ZirDADemo Application IrCOMM Client/Server Callback Functions Third-Party Interoperable ZirDADemo Application Commands Common IrDA Commands IrOBEX InBOX Service Commands IrOBEX File Object Transfer Commands. IrOBEX Statistics Commands IrCOMM Commands
RM003602-0404
List Tables
eZ80L92/F91/F92 ZirDADemo Application Commands
viii
List Figures
Figure ZirDA Demo Architecture showing Control Flow
List Figures
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
Introduction
This reference manual describes ZiLOG IrDA Demo application (ZirDADemo application) provides description commands associated with ZirDADemo application available part ZirDA1.0 release ZiLOG's eZ80Acclaim!product line. ZirDA1.0 ZiLOG's IrDA stack implementation that runs eZ80L92 microprocessor, eZ80F91 eZ80F92 microcontrollers. ZirDADemo application commands described this reference manual used test functionality ZirDAstack.
About This Manual
ZiLOG recommends that user read understand everything this manual before using product. have designed this manual used reference guide ZirDADemo application commands.
Intended Audience
This document provides reference information application developers product development engineers toward understanding ZirDAimplementation executing demo application provided along with ZirDAstack. purpose this reference manual serve guide toward executing ZirDADemo application understand ZirDAstack implementation.
Manual Organization
This ZirDADemo Application Commands Reference Manual divided into four chapters. brief description each these chapters follows.
RM003602-0404
Introduction
eZ80L92/F91/F92 ZirDADemo Application Commands
Introduction
Presents introduction ZirDADemo Application Commands Reference Manual terms intended audience, manual organization, references, conventions.
ZirDADemo Application Overview
Presents overview ZirDADemo application developed ZirDA stack running eZ80L92/F91/F92 devices.
Executing ZirDADemo Application
Contains steps showing execute ZirDADemo application commands between eZ80®-based ZirDAstack another IrDAcompatible device such personal digital assistant (PDA) Laptop.
ZirDADemo Application Command Descriptions
Contains detailed descriptions ZirDADemo application commands.
Related Documents
ZiLOG recommends that user thoroughly familiar with ZirDAand ZiLOG Real-time Kernel (RZK) documentation listed Table
Table Related ZirDA Documents ZirDA1.0 IrOBEX Reference Manual ZirDA1.0 IrCOMM Reference Manual ZirDA
RM0005 RM0004 RM0007
Common
Introduction
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
Table Related ZirDA Documents (Continued) User Manual* UM0075
Note: *Assuming have installed ZirDA1.0, this document located following filepath your <RZK Installed Dir>\ rzk1.0.0\Docs.
Definitions
Table lists some common IrDA terms.
Table Definition Common IrDA Terms Terms Client/Server Definitions participants IrCOMM communication session divided into clients servers. Clients devices applications that initiate communication. IrDA world they perform discovery, query Information Access Service (IAS), initiate connection. Servers devices applications which clients connect. Printers modems typical servers. When talking printers modems, computers clients. This term used cover computing devices like (for instance Compatibles, MACs), Workstations, PDAs, Palmtops, Electronic Organizers, Control data data other than user data. Typically, control data information that travels nondata circuits serial parallel ports. Data Circuit Equipment-in serial communications, refers device between communication endpoints that facilitates communications process, typically modem. Data Terminal Equipment-in serial communications, refers device endpoint communications path; typically computer terminal. denotes parallel port. denotes serial port.
Computer
Control Data Control Information)
LPT/COM
RM003602-0404
Definitions
eZ80L92/F91/F92 ZirDADemo Application Commands
Table Definition Common IrDA Terms (Continued) Terms Peripherals Type Device Type Device Definitions term peripheral covers devices such printers, modems other devices that traditionally connected computers serial and/or parallel cables. Type devices communication points such computers printers. Type devices those that part communication segment such modems.
Manual Conventions
following conventions adopted provide clarity ease use:
Courier Typeface
Code lines fragments, functions, various executable items distinguished from general text appearing Courier typeface. This convention used within tables.
Safeguards
When using ZirDA1.0 with ZiLOG's development platforms, follow precautions listed below avoid permanent damage platform. Note: Always grounding strap prevent damage resulting from electrostatic discharge (ESD). Power-up precautions Apply power ensure that running properly. Start terminal emulator program
Introduction
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
Apply power through connector development platform. Power-down precautions When powering down, follow sequence below: Quit monitor program. Remove power from development platform.
Trademarks
eZ80® registered trademark ZiLOG, Inc. eZ80Acclaim!is trademark ZiLOG, Inc.
RM003602-0404
Trademarks
eZ80L92/F91/F92 ZirDADemo Application Commands
Introduction
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
ZirDADemo Application Overview
This chapter presents overview ZirDADemo application describes architecture detail. ZirDADemo application simple command-line-based userinteractive application developed showcase features ZirDAstack. ZirDADemo application provides following facilities:
discover IrDA-compatible devices vicinity test features ZirDAIrOBEX IrCOMM application layers send receive objects such vCard from remote IrDA device obtain files data stored remote ZirDA-based eZ80® device ZirDATM-based eZ80® device, using IrOBEX request. conduct chat sessions between ZirDATM-based eZ80® devices.
ZirDADemo Architecture
Figure illustrates ZirDADemo architecture along with control flow tasks. ZirDADemo application provided with ZirDA1.0 stack used server client application. IrCOMM commands provided this reference manual allow application function server client application. However, most IrOBEX commands allow application function client only. When user downloads executes ZirDAstack eZ80® target platforms (eZ80L92/eZ80F91/eZ80F92), list com-
RM003602-0404
ZirDADemo Application Overview
eZ80L92/F91/F92 ZirDADemo Application Commands
mands appears HyperTerminal. control flow initiated when user types command serial communication application such HyperTerminal. Figure numbers represent sequence tasks that occur when user enters command HyperTerminal. Each steps described below.
User Input
UART Msgq
Thread1
OBEX Server/ COMM Server Call_backs
Msgq
ZirDA Demo OBEX/COMM Client Call_backs ZirDA Stack
ZirDA IrOBEX/IrCOMM APIs
Processing functions ZirDA Demo Commands
Figure ZirDADemo Architecture showing Control Flow
When character command received user input, UART interrupt service routine (ISR) called handle UART posts received character message queue, Msgq1.
ZirDADemo Application Overview
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
application thread, Thread1, waits Msgq1 receive characters. Upon receiving character, application thread stores
buffer until entire command received.
When entire command with parameters received, process function associated with that command (P1, P2,.,Px) takes over. process function calls appropriate IrOBEX IrCOMM APIs ZirDAstack. Upon successful return IrOBEX API, Demo application thread waits another message queue, Msgq2, reply from server. case IrCOMM API, upon successful return, Demo application waits Msgq2 only expects reply from remote IrDA device. IrOBEX/IrCOMM APIs process command pass them over ZirDAstack. request response message command sent remote IrDA device. response received from remote IrDA device ZirDAstack. ZirDAstack calls appropriate Client Callback functions. callback functions post received message Msgq2 message queue. associated process function pending Msgq2 receives message (from server). message received printed HyperTerminal console. sequence steps send request from ZirDAstack receive reply from remote IrDA stack complete. following steps detail sequence events occurring when request received from remote IrDA device response sent that device from ZirDAstack.
RM003602-0404
ZirDADemo Architecture
eZ80L92/F91/F92 ZirDADemo Application Commands
ZirDAstack receives request from remote IrDA device. ZirDAstack notifies Demo application through callbacks. callbacks post request Msgq1 message queue. Demo application thread, Thread1, pending Msgq1 receives request. received request printed HyperTerminal console. When IrOBEX request received, ZirDADemo application calls appropriate IrOBEX APIs send response. When IrCOMM message received, depending type request received, application calls another command send response. IrOBEX IrCOMM APIs communicate with ZirDAstack. response sent from ZirDAstack remote IrDA device. Note: Some commands like actirda, deactirda, setqos local calling IrDA device; when user types these commands, associated process function called appropriate ZirDAstack executed. disp, ver, getirstats, obstats, obdispobj ZirDADemo application-specific commands that call ZirDAstack APIs.
Functions Used ZirDADemo Application
This section contains brief explanation functions used ZirDADemo application communicate with ZirDAstack. functions listed according files which they located. These files located following path:
ZirDADemo Application Overview
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
<ZirDA Installed dir>\ZirDA1.0\<target processor>\app\ZirDADemo\
mon_task.c
Table lists functions mon_task.c file used Demo application.
Table mon_task.c Functions Function Name ZabsApplicationEntry* Tasks Performed
Entry point application. Creates thread (Thread1) application. Creates queues-Msgq1 receive data (commands) from user, Msgq2 post messages from callback functions when application receives data from other IrDA device. Forms body application thread. Registers application with IrOBEX and/or IrCOMM layers. Prints Demo command menu HyperTerminal console. Waits message queue (Msgq1) receive data (commands) from user. Upon receiving data from user, function calls associated process function, which turn calls appropriate IrOBEX/IrCOMM APIs. Verifies each character received. Stores character buffer.
mon_main
mon_proc_rx_char
Note: *The execution Demo application begins with this function. implementation this function application-specific. more details this function refer ZirDA1.0 User Manual (UM0145). Please MODIFY this function name.
RM003602-0404
Functions Used ZirDADemo Application
eZ80L92/F91/F92 ZirDADemo Application Commands
mon_uart.c
Table lists functions mon_uart.c file used Demo application.
Table mon_uart.c Functions Function Name mon_init_uart1 Tasks Performed
mon_isr_uart1
Initializes UART1 eZ80L92/F91/F92 module. Provides interrupt service routine UART1. Reads character from UART register. Posts character message queue, Msgq1.
mon_print.c
This file contains functions character from user input (getch()) print received character (putch()) HyperTerminal console.
Shell_Inits.c
This file contains list commands (with their default parameters) their associated process functions. execute process command ZirDADemo application requires following information:
Unique name command that distinguishes from other commands. example, actirda. Number arguments/parameters command. example, Default values arguments/parameters, available. example, "ZirDA"
ZirDADemo Application Overview
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
Process function associated with command. This process function calls appropriate APIs ZirDAstack. example,
callActirDA
Shell_main.c
This file contains function used Demo application interpret commands received from user call associated process function. Table lists single function that handles these tasks.
Table Shell_main.c Function Function Name Shell Tasks performed
Interprets command received from user Calls associated process function command along with received parameters
Obex_cbs.c
This file contains IrOBEX application callbacks that used IrOBEX application layer notify Demo application that request/response received from remote IrDA device. Table lists callback functions that registered Demo
application with IrOBEX layer.
Table ZirDADemo Application IrOBEX Client Callback Functions Name callback ObexClientDiscoverCfm Description This callback function registered with IrOBEX when request made using ObexDiscoverDevices() API. When IrOBEX layer receives reply from server, this callback lists number devices found vicinity with device Name device
RM003602-0404
Functions Used ZirDADemo Application
eZ80L92/F91/F92 ZirDADemo Application Commands
Table ZirDADemo Application IrOBEX Client Callback Functions Name callback ObexClientConnCfm Description This callback function registered with IrOBEX when request made using ObexStartClientTransaction() API. IrOBEX calls this callback when receives reply from server CONNECT request made earlier. This callback function registered with IrOBEX when request made using ObexEndClientTransaction() API. IrOBEX calls this callback when receives reply from server DISCONNECT request made earlier. This callback function registered with IrOBEX when request made using ObexInBOXPut() API. IrOBEX calls this callback when receives reply from server request made earlier. This callback function registered with IrOBEX when request made using ObexAbort API. IrOBEX calls this callback when receives reply from server ABORT request made earlier. This callback function registered with IrOBEX when request made using ObexInBOXGet() API. IrOBEX calls this callback when receives reply from server request made earlier.
ObexClientDiscCfm
ObexClientPutCfm
ObexClientAbortCfm
ObexClientGetCfm
Initially server application listening mode. Requests from client application received form callbacks. server application requires register callbacks using ObexRegisterInboxServer() API.
contents these callbacks printed ObexMonPrintIndCBContents() function. printf() command used print contents. Table lists callbacks their descriptions.
ZirDADemo Application Overview
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
Table ZirDADemo Application IrOBEX Server Callback Functions Callback ObexSrvrConnInd ObexSrvrDiscInd ObexServerGetInd ObexServerPutInd ObexServerAbortInd Description Notifies Demo application that CONNECT request received from client. Notifies Demo application that DISCONNECT request received from client. Notifies Demo application that request received from client. Notifies Demo application that request received from client. Notifies Demo application that ABORT request received from client.
Shell_obex_apis.c
This file contains definitions process functions used make appropriate IrOBEX calls immediately after receiving command from user. Table lists ZirDADemo application IrOBEX commands process functions associated with those commands. table also lists ZirDAstack IrOBEX APIs called process functions.
Table ZirDADemo Application IrOBEX Commands Process Functions Command obconn obdisc Process function CallStartClientTransaction CallEndClientTransaction ZirDAStack IrOBEX APIs ObexDiscoverDevices ObexStartClientTransaction ObexEndClientTransaction
RM003602-0404
Functions Used ZirDADemo Application
eZ80L92/F91/F92 ZirDADemo Application Commands
Table ZirDADemo Application IrOBEX Commands Process Functions Command obput Process function CallPut ZirDAStack IrOBEX APIs ObexInboxPut Before this API, obconn should have been called. ObexInboxGet. Before this API, obconn should have been called. ObexAbort Before this API, obconn obput should have been called. ObexDiscoverDevices ObexStartClientTransaction ObexInboxPut ObexEndClientTransaction ObexDiscoverDevices ObexStartClientTransaction ObexInboxPut ObexEndClientTransaction ObexDiscoverDevices ObexStartClientTransaction ObexInboxPut ObexEndClientTransaction ObexDiscoverDevices ObexStartClientTransaction ObexInboxPut ObexEndClientTransaction
obget
CallGet
obabort
CallAbort
obsendobj
MonObexSendObject
obsendfile
MonObexSendFile
obgetobj
MonObexGetObject
obgetdefault
MonObexGetDefault
obstats
MonObexDisplayStats
ZirDADemo Application Overview
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
Table ZirDADemo Application IrOBEX Commands Process Functions Command obdispobj obdemo Process function MonObexDisplayObj MonObexDemo ZirDAStack IrOBEX APIs -ObexDiscoverDevices ObexStartClientTransaction ObexInboxPut ObexEndClientTransaction
server-side APIs optional, which means that user decide server callbacks whether call server-side APIs allow IrOBEX server send replies automatically. ZirDADemo application provides option call server-side APIs. function these server-side APIs. Table lists server-side APIs.
Table ZirDAIrOBEX Server Functions ObexConnectServerResponse Function Name Description
ObexMonPrintIndCBContents server-side response called when server receives CONNECT request
ObexDisconnectServerResponse ObexMonPrintIndCBContents server-side response called when server receives DISCONNECT request ObexAbortServerResponse ObexMonPrintIndCBContents server-side response called when server receives ABORT request
RM003602-0404
Functions Used ZirDADemo Application
eZ80L92/F91/F92 ZirDADemo Application Commands
Table ZirDAIrOBEX Server Functions ObexPutServerResponse Function Name Description
ObexMonPrintIndCBContents server-side response called when server receives request monProcessObexMessages server-side response called when server receives request
ObexGetServerResponse
more details ZirDAIrOBEX APIs please refer ZirDA1.0 IrOBEX Reference Manual (RM0005).
Shell_comm_apis.c
This file contains definitions process functions that used make appropriate IrCOMM calls immediately after receiving command from user. Table lists ZirDADemo application IrCOMM commands along with process function corresponding ZirDAIrCOMM APIs that called.
Table ZirDADemo Application IrCOMM Commands Process Functions Command conn Process function ChatCommConnectReq ZirDAStack IrCOMM APIs IasGVBCReq, RegisterIrCOMMClient, CommClientSendConnReq CommServerSendConnResp CommDataReq
send
ChatCommConnectResp ChatSendData
ZirDADemo Application Overview
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
Table ZirDADemo Application IrCOMM Commands Process Functions Command disc commdemo Process function ChatDisconnect CommDemoWithPrinter ZirDAStack IrCOMM APIs CommDisconnectReq IasGVBCReq, RegisterIrCOMMClient, CommClientSendConnReq, CommServerSendConnResp, CommDataReq, CommDisconnectReq
Comm_cbs.c
This file contains IrCOMM application callbacks that used IrCOMM application layer notify demo application that request/response received from other IrDA device. Table contains details callbacks provided demo
application IrCOMM Client/Server. When IrCOMM application layer receives request/response from other IrDA device, notifies application through these call backs.
Table ZirDADemo Application IrCOMM Client/Server Callback Functions Call back Comm_Discovery_Confirmation Comm_Discovery_Indication Comm_GVBC_Confirmation Description Notifies Demo application when DISCOVERY response received from server. Notifies Demo application when DISCOVERY request received from client. Notifies Demo application when GVBC (Get Value Class) response containing server LSAP received from server.
RM003602-0404
Functions Used ZirDADemo Application
eZ80L92/F91/F92 ZirDADemo Application Commands
Table ZirDADemo Application IrCOMM Client/Server Callback Functions Call back Comm_Connect_Indication Comm_Connect_Confirmation Comm_Data_Indication Comm_Disconnect_Indication Description Notifies Demo application when CONNECT request received from client. Notifies Demo application when CONNECT response received from server. Notifies Demo application when DATA request received from client/server. Notifies Demo application when DISCONNECT request received from client/server.
ZirDADemo Application Overview
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
Executing ZirDADemo Application
ZirDADemo application source files located following path:
<ZirDA Installed Dir>\ZirDA1.0\<Target processor>\app\ZirDA Demo
project files are:
ZirDADemo_RAM.pro (implementation using RAM) ZirDADemo_Flash.pro (implementation using Flash)
ZirDA Demo application features trace capability. demo application compiled built resulting .lod .hex file downloaded eZ80L92/F91/F92 module eZ80® Development Platform. more details build, download execute ZirDADemo application, refer ZirDA1.0 User Manual (UM0145). When user executes ZirDAstack eZ80® target platforms (eZ80L92/eZ80F91/eZ80F92) list commands appears HyperTerminal. sections this chapter describe execute simple file transfer using ZirDAstack ZirDADemo application. file transfer occurs between eZ80®-based ZirDAstack with ZirDADemo application third party IrDA device that personal digital assistant (PDA) Laptop device.
RM003602-0404
Executing ZirDADemo Application
eZ80L92/F91/F92 ZirDADemo Application Commands
Pre-requisites
ZirDAstack with ZirDADemo application running eZ80® Development Platform with eZ80L92/F91/F92 Modules. running serial communication application such HyperTerminal. PDA/Laptop device
Note: connection setup between eZ80® Development Platform PDA/Laptop, refer ZirDASDK Quick Start Guide (QS0026), ZirDASDK User Manual (UM0145).
File Transfer Using Single Command
This section includes sequence steps followed transfer file between ZirDAeZ80® device remote IrDA device using obsendfile obsendobj command. These commands establish connection, transfer files disconnect link.
Transferring File from eZ80® Device
Follow steps provided below transfer file from eZ80® device. Align eZ80® device with capable IrDA communication. HyperTerminal prompt, enter command activate stack, device name, device type (see actirda command choose appropriate device type number your device type). example,
actirda "ZirDA"
represents activation ZirDAstack with ZirDAdevice
Executing ZirDADemo Application
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
name device type Laptop. HyperTerminal displays IrDA ACTIVE message. enter dscv command HyperTerminal prompt press Enter ZirDAstack discover device. When discovered, device name device displayed HyperTerminal. Beam text data from eZ80® device. Upon receiving ASCII text data, eZ80® device displays data HyperTerminal.
Transferring File from eZ80® Device
Follow steps provided below transfer file (different than received previous section), from eZ80® device PDA. HyperTerminal prompt, enter command activate stack, device name, device type (see actirda command choose appropriate device type number your device type). example,
actirda "ZirDA"
represents activation ZirDAstack with ZirDAdevice name device type Laptop. HyperTerminal displays IrDA ACTIVE. Now, enter obsendobj command with file name text data double quotes press Enter key. example, enter command follows:
obsendobj "ZirDAUM.txt" "eZ80 device sending ZirDA User Manual PDA"
eZ80® device sends ASCII data using OBEX request.
RM003602-0404
Transferring File from eZ80® Device
eZ80L92/F91/F92 ZirDADemo Application Commands
text data received PDA. Upon receiving ASCII text data, remote IrDA displays option save discard ASCII text data received file. Some PDAs generate beep supported enabled) when text data received.
Transferring File from Laptop eZ80® Device
Follow steps provided below transfer file from remote IrDA Laptop device eZ80® device. Align Laptop that capable IrDA communication with eZ80® device. HyperTerminal prompt, enter command activate stack, device name, device type (see actirda command choose appropriate device type number your device type). example,
actirda "ZirDA"
represents activation ZirDAstack with ZirDAdevice name device type Laptop. HyperTerminal displays IrDA ACTIVE message. enter dscv command HyperTerminal prompt press Enter ZirDAstack discover remote IrDA Laptop device. When Laptop discovered, device name device displayed HyperTerminal. Beam text data from remote IrDA Laptop eZ80® device. example, send file with file name "um.txt". Upon receiving ASCII text data, eZ80® device displays received data HyperTerminal.
Executing ZirDADemo Application
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
Transferring Received File back Laptop
Follow steps provided below transfer received file (um.txt) from eZ80® device remote IrDA Laptop device. HyperTerminal prompt, enter command activate stack, device name, device type (see actirda command choose appropriate device type number your device type). example,
actirda "ZirDA"
represents activation ZirDAstack with ZirDAdevice name device type Laptop. HyperTerminal displays IrDA ACTIVE message. HyperTerminal prompt, enter obstats command; file name received from remote Laptop displayed with file size. Now, enter obsendfile "um.txt" HyperTerminal prompt press Enter key. eZ80® device sends ASCII data using OBEX request. Upon receiving ASCII text data, remote IrDA Laptop displays option save discard ASCII text data received file. Some Laptops generate beep supported enabled) when text data received.
File Transfer Using Multiple Commands
This section includes sequence steps followed transfer file between eZ80®-based ZirDAdevice remote IrDA device using multiple ZirDADemo application commands. Users familiar with IrOBEX application layer take advantage these commands execute specific operations using ZirDADemo application. operations that performed these commands include establishing
RM003602-0404
Transferring Received File back Laptop
eZ80L92/F91/F92 ZirDADemo Application Commands
connection, transferring files disconnecting link, addition host other operations described sections that follow.
Transferring File from eZ80® Device Laptop
Follow steps provided below transfer file from eZ80® device remote IrDA Laptop. obconn, obput obdisc commands used this sequence. HyperTerminal prompt, enter command activate stack, device name, device type (see actirda command choose appropriate device type number your device type). example,
actirda "ZirDA"
represents activation ZirDAstack with ZirDAdevice name device type Laptop. HyperTerminal displays IrDA ACTIVE message. Enter obconn command HyperTerminal prompt with object count object length 1000, client packet length 2000 description "Hello from ZirDA". example,
obconn 1000 2000 "Hello from ZirDA"
response from remote Laptop that connection request successful received eZ80® device displayed HyperTerminal console. eZ80® device HyperTerminal prompt, enter obput command, with object name "UM.txt", maximum object length current packet length actual data "ZiLOG IrDA". example,
Executing ZirDADemo Application
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
obput "UM.txt" "ZiLOG IrDA"
eZ80® device sends ASCII data using OBEX request. Upon receieving data, remote IrDA Laptop displays option save discard ASCII text data. When Laptop user accepts data, Laptop sends response back eZ80® device with status "Expecting more Data". eZ80® device HyperTerminal prompt, enter obput command again, with object name "UM.txt", maximum object length current packet length actual data "implementation IrDA stack". example,
obput "UM.txt" "implementation IrDA stack"
eZ80® device sends ASCII data using OBEX request. Upon receiving text data, remote Laptop displays option save discard ASCII text data. remote IrDA Laptop also sends response back eZ80® device with status "Successfully received entire object". Enter obdisc command HyperTerminal prompt with object description "Disconnecting from Laptop". example,
obdisc "Disconnecting from Laptop"
Laptop closes application dialog box, displays data received from eZ80® device.
Aborting File Transfer Progress
Follow steps provided below abort file transfer operation that progress between ZirDATM-eZ80® Laptop remote IrDA Laptop.
RM003602-0404
Aborting File Transfer Progress
eZ80L92/F91/F92 ZirDADemo Application Commands
obconn, obput obabort commands used this sequence. HyperTerminal prompt, enter command activate stack, device name, device type (see actirda command choose appropriate device type number your device type). example,
actirda "ZirDA"
represents activation ZirDAstack with "ZirDA" device name device type Laptop. HyperTerminal displays IrDA ACTIVE message. Enter obconn command HyperTerminal prompt with object count object length 1000, client packet length 2000 description "Hello from ZirDA". example,
obconn 1000 2000 "Hello from ZirDA"
response from remote Laptop that connection request successful received eZ80® device displayed HyperTerminal console. enter obput command HyperTerminal prompt with object name "UM.txt", maximum object length current packet length actual data "implementation IrDA stack". example,
obput "UM.txt" "implementation IrDA stack"
eZ80® device sends ASCII data using OBEX request. Upon receiving text data, remote Laptop displays option save discard ASCII text data.
Executing ZirDADemo Application
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
Enter obabort command HyperTerminal prompt with object description "Aborting file transfer". example,
obabort "Aborting file transfer"
Laptop closes application dialog box, immediately sends DISCONNECT request eZ80® device close connection. eZ80® device receives DISCONNECT INDICATION disconnects link?.
File Transfer Between ZirDA-based eZ80® Platforms
This section provides steps transfer file (ZirDAUM.txt) between ZirDATM-based eZ80® platforms-device device 2-followed steps where device retrieves file from device Both devices connected HyperTerminal applications launched this each devices. Note: connection setup between eZ80® Development Platforms refer ZirDA1.0 User Manual (UM0145). Follow sequence steps provided below transfer retrieve file between ZirDATM-based eZ80® platforms-device device HyperTerminal prompt both devices, enter command activate stack both devices. Enter actirda command with device name, device type (see actirda command choose appropriate device type number your device type). example,
actirda "ZirDA"
RM003602-0404
File Transfer Between ZirDA-based eZ80® Platforms
eZ80L92/F91/F92 ZirDADemo Application Commands
represents activation ZirDAstack with "ZirDA" device name device type Laptop. Note: Although Laptop used this setup, command valid long number specified actirda command device type list used. Both HyperTerminal consoles display IrDA ACTIVE message. enter dscv command device HyperTerminal prompt, press Enter ZirDAstack discover device When device discovered, device name device displayed HyperTerminal device device HyperTerminal prompt, enter obsendobj command with file name text data double quotes press Enter key. example,
obsendobj "ZirDAUM.txt" "eZ80 device sending ZirDA User Manual another eZ80 device"
Device sends ASCII data using OBEX request. Device receives text data from device stores RAM. text data received displayed device HyperTerminal console. device HyperTerminal prompt, enter obgetobj command along with file name. example,
obgetobj "UM.txt"
Device receives request, sends file back device Device receives text data from device stores RAM. text data received from device displayed device HyperTerminal console.
Executing ZirDADemo Application
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
Using ZirDADemo Application Chat Service
sequence commands Chat service ZirDADemo application provided this section. Here again communication between ZirDATM-based eZ80® development platforms-device device Both devices connected HyperTerminal applications launched this each devices. Note: connection setup between eZ80® Development Platforms refer ZirDA1.0 User Manual (UM0145). HyperTerminal prompt both devices, enter command activate stack both devices. Enter actirda command with device name, device type (see actirda command choose appropriate device type number your device type). example,
actirda "ZirDA"
represents activation ZirDAstack with "ZirDA" device name device type Laptop. Note: Although Laptop used this setup, command valid long number specified actirda command device type list used. Both HyperTerminal consoles display IrDA ACTIVE message. HyperTerminal prompt device enter conn command with device name double quotes press Enter key. example,
conn "Jack"
RM003602-0404
Using ZirDADemo Application Chat Service
eZ80L92/F91/F92 ZirDADemo Application Commands
Device sends IrCOMM CONNECT request device Device receives CONNECT request following format:
Jack would like chat with you! wish accept, type 'ans "Your Name"' press Enter.
device HyperTerminal prompt, enter command with device name device example,
"Jill"
device HyperTerminal prompt, following text appears:
Jack>>Jill accepted chat with you.
device HyperTerminal prompt, enter send command with actual message (data). example,
send "How day?"
Device receives data from device prints device HyperTerminal console. Send data from device device similar repeating steps session, device HyperTerminal prompt, enter disc command with description "disconnecting". example,
disc "disconnecting"
Device sends IrCOMM DISCONNECT request; device
Executing ZirDADemo Application
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
receives request prints description device HyperTerminal console follows:
"disconnecting"
Interoperability ZirDADemo Application Commands
Some ZirDADemo application commands interoperable with third-party devices. Table lists commands that used with third-party devices.
Table Third-Party Interoperable ZirDADemo Application Commands Application Layer IrOBEX Interoperable Commands obconn obput obabort obdisc obdemo obsendfile obsendobj obsendvcard IrCOMM commdemo
IrOBEX commands-obget, obgetdefault, obgetobj- used only between eZ80® devices with ZirDAstack. Similarly, IrCOMM commands-conn, ans, send, disc-can used only between eZ80® devices with ZirDAstack.
RM003602-0404 mands
Interoperability ZirDADemo Application Com-
eZ80L92/F91/F92 ZirDADemo Application Commands
Executing ZirDADemo Application
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
ZirDADemo Application Command Descriptions
ZirDADemo application demonstrates ZirDA1.0 IrOBEX IrCOMM services available user. demo application comprises easy-to-use commands
Discover IrDA-compatible devices Connect IrDA-compatible devices Transfer data from IrDA device another
dscv command conducts discover device operation lists devices discovered ZirDADemo application. commands connect with IrDA-compatible device also conducts discover device operation. When more than IrDA-compatible device discovered, system waits user input regarding specific device name before connecting specific device. user input erroneous, ZirDADemo application connects first device list. device discovered, then execution connection command aborted. Command Line Interpreter (CLI) data types ZirDADemo application used send requests IrOBEX/IrCOMM layer. They feature following format:
NUMBER STRING value this data type decimal number. example: value this data type enclosed double quotes (""). example: "Hi, you?" value this data type preceded example: 0x100
RM003602-0404
ZirDADemo Application Command Descrip-
eZ80L92/F91/F92 ZirDADemo Application Commands
Note: Special functions (such arrow keys) supported this release. Invalid Command message appears command prompt when such keys used. maximum 2000 characters/bytes entered command prompt. brief description available commands provided sections that follow. Enter help listing supported commands.
ZirDADemo Application Command Descriptions
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
Common IrDA Commands
quickly Common IrDA commands hyperlinks Table
Table Common IrDA Commands
help actirda deactirda getirstats setqos dscv dump disp
Common IrDA commands begin next page
RM003602-0404
Common IrDA Commands
eZ80L92/F91/F92 ZirDADemo Application Commands
help
Syntax
help
Description This command displays available ZirDADemo application commands. Parameters None Example
ZirDA Demo>>? Available commands are: help disp <"ON" "OFF"> dump <NoOfMessages> IrDA commands actirda <"DevName"> <HintByte> deactirda setqos <BaudRate> <DataSize> <Window Size> getirstats dscv OBEX commands obconn <ObjCnt> <ObjLen> <MaxPktLen> <"Desc"> obput <"ObjName"> <ObjLen> <CurPktLen> <"Data"> obget <"ObjName"> obabort <"Desc">
ZirDADemo Application Command Descriptions
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
obdisc <"Desc"> Generic OBEX File Transfer Commands obdemo obsendfile <"ObjName"> obgetobj <"ObjName"> obsendobj <"ObjName"> <"Data"> obgetdefault (for eZ80L92 only) obsendvcard <"vCardName"> <"OrgName"> <"TEL"> <"EMAIL"> <"Addr(Street)"> <"Addr(City)"> <"Addr(State)"> <"Addr(PIN)"> <"Addr(Country)"> OBEX Statistics obstats obdispobj <"ObjName"> Press IrCOMM commands IrCOMM commands: (for eZ80F91 eZ80F91 only) conn <"Your Name"> <"Your Name"> send <"Chat Msg"> disc <"GoodBye Msg"> ZirDA Demo>>
RM003602-0404
Common IrDA Commands
eZ80L92/F91/F92 ZirDADemo Application Commands
actirda
Syntax
actirda
Description This command activates ZirDAstack. application using stack must first activate stack startup. Parameters
Parameter DevName HintByte Parameter Type STRING NUMBER Valid Range Max: characters) 1-255 Description friendly name device using IrDA. First hint byte set.
hint byte values provided below added multiple devices.
IRDA_DEV_PDA_PALM_TOP IRDA_DEV_COMPUTER IRDA_DEV_PRINTER IRDA_DEV_MODEM IRDA_DEV_FAX
Example
ZirDA Demo>>actirda "ZIrDA" IrDA ACTIVE!
ZirDADemo Application Command Descriptions
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
deactirda
Syntax
deactirda
Description This command deactivates ZirDAstack puts stack power stand-by mode. stack related commands fail after this command executed stack disabled. Parameters None. Example
ZirDA Demo>>deactirda IrDA INACTIVE! ZirDA Demo>>dscv Searching devices. Error discovering devices.
RM003602-0404
Common IrDA Commands
eZ80L92/F91/F92 ZirDADemo Application Commands
getirstats
Syntax
getirstats
Description This command gets statistics ZirDAstack; statistics regarding QOS, device name, hint byte character currently used obtained. Parameters None. Example
ZirDA Demo>>getirstats ******** IrDA Statistics ******** QOS: BaudRate:115200 MaxDataSize:2048 DisconnectTime:3 MaxTurnTime:500 MinTurnTime:10 BOFCount:0 WindowSize:7 DeviceName: "ZIrDA" HintByte: CharacterSet:
ZirDADemo Application Command Descriptions
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
setqos
Syntax
setqos
Description This command sets various (Quality Service) parameters ZirDAstack. Parameters
Parameter BaudRate Parameter Type NUMBER Valid Range Description
Check enumerated Baud rate parameter values baud link. rate irda_enum.h header file Check enumerated Maximum data size parameter values data size irda_enum.h header file Check enumerated Maximum window size parameter values maximum window size irda_enum.h header file
DataSize
NUMBER
WindowSize
NUMBER
Example
ZirDA Demo>>setqos 9600 parameters have been ******** IrDA Statistics ********
RM003602-0404
Common IrDA Commands
eZ80L92/F91/F92 ZirDADemo Application Commands
QOS: BaudRate:9600 MaxDataSize:256 DisconnectTime:3 MaxTurnTime:500 MinTurnTime:10 BOFCount:0 WindowSize:3 DeviceName: "ZIrDA" HintByte: CharacterSet:
ZirDADemo Application Command Descriptions
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
dscv
Syntax
dscv
Description This command used discovery request that looks IrDA-compatible devices present vicinity. Parameters None Example
ZirDA Demo>>dscv <<<<< DISCOVERY CONFIRMATION >>>>> Total number Devices detected: Device 0x31C1 Device Name ZiLOG IrDA Device 0xA16 Device Name Z2KHHRZJYNN ZirDA Demo>>
RM003602-0404
Common IrDA Commands
eZ80L92/F91/F92 ZirDADemo Application Commands
dump
Syntax
dump <NoOfMsgs>
Description This command dumps requested number logged messages onto console. dumps recently logged messages. Interrupts disabled when dump output appears. Note: dump command only before connection established after connection closed. Using dump command during connection cause disconnection, dump data displayed large. Parameters
Parameter NoOfMsgs Parameter Type NUMBER Valid Range 1-50 Description Number logged messages.
Example
ZirDA Demo>>dump tOTALtRACEmSGS 0072 TraceMsgNum:1 3323 IROBEX Msg(0x53): DATA_IND localLsapId:1 remoteLsapId:1 userDataLen:3 userData: TraceMsgNum:2
ZirDADemo Application Command Descriptions
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
3325 IROBEX Msg(0x10): DATA_CONSUMED userDataLen:0 eNDtRACEmSGS
RM003602-0404
Common IrDA Commands
eZ80L92/F91/F92 ZirDADemo Application Commands
disp
Syntax
disp <"ON"> disp <"OFF">
Description This command displays data received from peer stack only when called with option. Parameters
Parameter "ON" "OFF" Parameter Type STRING STRING Description "ON" option allows application display received data. "OFF" does display data.
Note: default display Example
ZirDA Demo>>disp "ON"
ZirDADemo Application Command Descriptions
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
Syntax
Description This command displays version number ZirDAstack. Parameters None Example
ZirDA Demo>>ver ZirDA version
RM003602-0404
Common IrDA Commands
eZ80L92/F91/F92 ZirDADemo Application Commands
Using IrOBEX InBOX Service
quickly IrOBEX InBOX Service commands hyperlinks Table
Table IrOBEX InBOX Service Commands
dscv (common IrOBEX IrCOMM) obconn obput obget obabort obdisc dump (common IrOBEX IrCOMM)
IrOBEX InBOX Service command descriptions begin next page.
ZirDADemo Application Command Descriptions
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
obconn
Syntax
obconn <ObjCnt> <ObjLen> <MaxPktLen> <Desc>
Description This command makes request connected remote IrDAIrOBEX device. Parameters
Parameter ObjCnt Parameter Type NUMBER Valid Range 1-10 Description: Number objects that exchanged during this transaction. combined expected length objects exchanged. Indicates maximum size OBEX packet that device receive. Description request.
ObjLen
NUMBER
MaxPktLen
NUMBER
<4000
Desc
STRING
Example Request from local device:
ZirDA Demo>> obconn 2000 1000 "Are ready file exchange?" Searching devices. <<<<< DISCOVERY CONFIRMATION >>>>> Total number Devices detected: Device 0x31C1
RM003602-0404
Using IrOBEX InBOX Service
eZ80L92/F91/F92 ZirDADemo Application Commands
Device Name ZiLOG IrDA Connecting device ZiLOG IrDA.
Response from remote device local device:
<<<<< CONNECT CONFIRMATION >>>>> Wow! connected Server MaxPktLen 3000 (Server MaxPktLen Maximum Packet Length that Server receive)
Response remote device:
ZirDA Demo>> <<<<< CONNECT INDICATION >>>>> Destination Device 0x200 Client Packet 2000 Server MaxPktLen 3000 objects Length 1000 Description "Are ready file exchange?" Device Name ZiLOG IrDA ZirDA Demo>>
ZirDADemo Application Command Descriptions
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
obput
Syntax
obput <"ObjName"> <TotObjLen> <CurPktLen><"Data">
Description This command request send data remote IrOBEX device. Note: data received larger than only last stored. Parameters
Parameter ObjName TotObjLen CurPktLen Data Parameter Type STRING NUMBER NUMBER STRING Valid Range Description Name Object sent. Length whole object. Length current packet. Actual data sent.
Example Request from local device:
ZirDA Demo>> obput "UM.txt" "Good Morning Everybody!!!!" Transferring file UM.txt.
Response sent from remote device:
<<<<< CONFIRMATION >>>>> Status Successfully transferred data Description Received Data from Client.
RM003602-0404
Using IrOBEX InBOX Service
eZ80L92/F91/F92 ZirDADemo Application Commands
Response received remote device:
ZirDA Demo>> ZirDA Demo>> <<<<< INDICATION >>>>> ObjName UM.txt ObjType NULL Description NULL Status Still more data come MaxObjLen CurPktLen Data Received Good Morning Everybody!!!! <<<<< INDICATION >>>>> ObjName NULL ObjType NULL Description: NULL Status Successfully received data MaxObjLen CurPktLen Data Received
ZirDADemo Application Command Descriptions
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
obget
Syntax
obget <"ObjName">
Description This command used make request obtain data from remote IrOBEX device. Parameters
Parameter ObjName Parameter Type STRING Valid Range Description Name Object received.
Example Request from local device:
ZirDA Demo>>obget "UM.txt" <<<<< CONFIRMATION >>>>> Data Received: Good Morning Everybody!!!!
RM003602-0404
Using IrOBEX InBOX Service
eZ80L92/F91/F92 ZirDADemo Application Commands
obabort
Syntax
obabort <"Desc">
Description This command used send request abort current IrOBEX PUT/GET request. Parameters
Parameter Parameter Type Desc STRING Valid Range Description Description request (put/get) being aborted.
Example Request from local device:
ZirDA Demo>>obabort "Aborting." Cancelling file transfer.
Response received remote:
ZirDA Demo>> ZirDA Demo>> <<<<< ABORT INDICATION>>>>> Description Aborting.
Response received local device:
<<<<< ABORT CONFIRMATION >>>>> Description
ZirDADemo Application Command Descriptions
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
obdisc
Syntax
obdisc <"Desc">
Description This command used make request close connection. Parameters
Parameter Desc Parameter Type STRING Valid Range Description Describes reason disconnection.
Example Request local device:
ZirDA Demo>>obdisc "Disconnecting." Disconnecting from peer.
Response received remote:
ZirDA Demo>> ZirDA Demo>> <<<<< DISCONNECT INDICATION>>>>> Description Disconnecting.
Response received local device:
<<<<< DISCONNECT CONFIRMATION >>>>> Disconnect Reason XXXX Description
RM003602-0404
Using IrOBEX InBOX Service
eZ80L92/F91/F92 ZirDADemo Application Commands
Generic IrOBEX File Transfer Commands
quickly IrOBEX file object transfer commands hyperlinks Table
Table IrOBEX File Object Transfer Commands
obsendfile obsendobj obdemo obgetdefault obsendvcard obgetobj
IrOBEX file object transfer command descriptions begin next page.
ZirDADemo Application Command Descriptions
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
obsendfile
Syntax
obsendfile <"ObjName">
Description This command tranfers file, "ObjName", peer stack. takes care operations. Note: dscv command called obsendfile command internally. user prompted enter name device only more than device discovered. obstats command (described IrOBEX Statistics section page used obtain available file objects (ObjName) received from other devices. ObjName supplied does match with these files then default file object, residing local system, used transfer. Parameters
Parameter ObjName Parameter Type STRING Valid Range Description Name file sent.
Example Request from local device:
ZirDA Demo>>obsendfile "um.txt"
Response remote:
<<<<< CONNECT INDICATION >>>>> Destination Device 0xXXXX
RM003602-0404
Generic IrOBEX File Transfer Commands
eZ80L92/F91/F92 ZirDADemo Application Commands
Client Packet XXXX Server MaxPktLen XXXX objects Length XXXX Description NULL Device Name ZiLOG IrDA <<<<< INDICATION >>>>> ObjName um.txt ObjType NULL Description NULL Status Still more data come MaxObjLen Current Packet Length Data Received: Good Morning Everybody!!!! <<<<< INDICATION >>>>> ObjName um.txt ObjType NULL Description NULL Status Successfully received entire object MaxObjLen Current Packet Length Data Received: <<<<< DISCONNECT INDICATION >>>>> Reason Disconnect Description
Response received local device:
Searching devices. <<<<< DISCOVERY CONFIRMATION >>>>> Total number Devices detected:
ZirDADemo Application Command Descriptions
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
Device 0xXXX Device Name YYYYYYYYY Connecting device YYYYYYYYY. <<<<< CONNECT CONFIRMATION >>>>> Wow! connected Server OBEX PktLen 3000 Description Sending um.txt. <<<<< CONFIRMATION >>>>> Status: Successfully sent whole object Description Disconnecting from YYYYYYYYY. <<<<< DISCONNECT CONFIRMATION >>>>> Reason Disconnect Description ZirDA Demo>>
RM003602-0404
Generic IrOBEX File Transfer Commands
eZ80L92/F91/F92 ZirDADemo Application Commands
obsendobj
Syntax
obsendobj <"ObjName"> <"Data">
Description This command tranfers object name provided "ObjName" peer. takes care operations. Parameters
Parameter ObjName Data Parameter Type STRING STRING Valid Range Description Name Object sent. TObject data sent.
Example Request from local device:
ZirDA Demo>>obsendobj "um.txt" "This user manual IrDA" Searching devices.
Response remote:
<<<<< CONNECT INDICATION >>>>> Destination Device 0xXXXX Client Packet XXXX Server MaxPktLen XXXX objects Length XXXX Description
ZirDADemo Application Command Descriptions
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
Device Name ZiLOG IrDA <<<<< INDICATION >>>>> ObjName um.txt ObjType NULL Description NULL Status Still more data come MaxObjLen Current Packet Length Data Received: This user manual IrDA <<<<< INDICATION >>>>> ObjName um.txt ObjType NULL Description NULL Status :Successfully received entire object MaxObjLen Current Packet Length
Data Received:
<<<<< DISCONNECT INDICATION >>>>> Reason Disconnect Description
Response received local device:
<<<<< DISCOVERY CONFIRMATION >>>>> Total number Devices detected: Device 0xXXXX Device Name ZiLOG IrDA Connecting device ZiLOG IrDA. <<<<< CONNECT CONFIRMATION >>>>>
RM003602-0404
Generic IrOBEX File Transfer Commands
eZ80L92/F91/F92 ZirDADemo Application Commands
Wow! connected Server OBEX PktLen 3000 Description Sending um.txt. <<<<< CONFIRMATION >>>>> Status: Successfully sent whole object Description Disconnecting from ZiLOG IrDA. <<<<< DISCONNECT CONFIRMATION >>>>> Reason Disconnect Description ZirDA Demo>>
ZirDADemo Application Command Descriptions
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
obdemo
Syntax
obdemo
Description This command tranfers sample vcard with name "ZirDA Support.vcf" peer stack. takes care dscv/connection/ put/disconnection operations. Parameters None Example Request from local device:
ZirDA Demo>>obdemo
Response remote:
<<<<< CONNECT INDICATION >>>>> Destination Device 0xXXXX Client Packet XXXX Server MaxPktLen XXXX objects Length XXXX Description Device Name ZiLOG IrDA <<<<< INDICATION >>>>> ObjName ZirDA Support.vcf ObjType NULL Description NULL Status Still more data come
RM003602-0404
Generic IrOBEX File Transfer Commands
eZ80L92/F91/F92 ZirDADemo Application Commands
MaxObjLen Current Packet Length Data Received: BEGIN:VCARD VERSION:2.1 ZiLOG Inc. TEL;WORK;VOICE:(408) 558-8500 ORG:ZiLOG Inc. ADR;WORK:;;ZiLOG Inc, Race Street Jose, 95126 LABEL;WORK:ZiLOG Inc, Race Street Jose, 95126 REV:20021130T182351Z END:VCARD <<<<< INDICATION >>>>> ObjName ZirDA Support.vcf ObjType NULL Description NULL Status :Successfully received entire object MaxObjLen Current Packet Length
Data Received:
<<<<< DISCONNECT INDICATION >>>>> Reason Disconnect Description
Response received local device:
<<<<< DISCOVERY CONFIRMATION >>>>>
ZirDADemo Application Command Descriptions
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
Total number Devices detected: Device 0xXXXX Device Name ZiLOG IrDA Connecting device ZiLOG IrDA. <<<<< CONNECT CONFIRMATION >>>>> Wow! connected Server OBEX PktLen 3000 Description Sending um.txt. <<<<< CONFIRMATION >>>>> Status: Successfully sent whole object Description Disconnecting from ZiLOG IrDA. <<<<< DISCONNECT CONFIRMATION >>>>> Reason Disconnect Description ZirDA Demo>>
RM003602-0404
Generic IrOBEX File Transfer Commands
eZ80L92/F91/F92 ZirDADemo Application Commands
obgetdefault
Syntax
obgetdefault
Description This command gets default object from peer stack. Parameters None Example Request from local device:
ZirDA Demo>>obgetdefault
Response from remote:
***************DEFAULT OBJECT******************** BEGIN:VCARD VERSION:2.1 N:ZiLOG Inc. TEL;WORK;VOICE: (408) 558-8500 ORG:ZiLOG Inc. ADR;WORK:;;ZiLOG Inc,532 Race Street,San Jose,CA 95126-3432 LABEL;WORK:ZiLOG Inc,532 Race Street,San Jose,CA 95126-3432 REV:20021130T182351Z END:VCARD
ZirDADemo Application Command Descriptions
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
obsendvcard
Syntax
obsendvcard
Description This command request send vCard remote IrOBEX device. Parameters
Parameter vCardName OrgName EMAIL Addr(Street) Addr(City) Addr(State) Addr(PIN) Addr(Country) Parameter Type STRING STRING STRING STRING STRING STRING STRING STRING STRING Description Name vCard, with `.vcf extension. Name organization. Telephone Number. Person's company's email address. Name street. Name city. Name state. Postal code state/city/town. Name country.
Example Request from local device:
ZirDA Demo>>obsendvcard "ZirDA Demo.vcf" "ZiLOG India Electronics (Pvt) Ltd." "(123) 226-9405" "tech-support@zilog.com" "Race Course Street" "Bangalore" "Karnataka" "560001" "INDIA"
Displayed HyperTerminal, when command entered:
RM003602-0404
Generic IrOBEX File Transfer Commands
eZ80L92/F91/F92 ZirDADemo Application Commands
Searching devices. <<<<< DISCOVERY CONFIRMATION >>>>> Total number Devices detected: Device 0x117B90 Device Name Z2KHHRZJYNN Connecting device Z2KHHRZJYNN. <<<<< CONNECT CONFIRMATION >>>>> Wow! connected Server OBEX PktLen 9983 Description Sending ZirDA Demo.vcf. <<<<< CONFIRMATION >>>>> Status: Successfully sent whole object Description Disconnecting from Z2KHHRZJYNN. <<<<< DISCONNECT CONFIRMATION >>>>> ZirDA Demo>>
ZirDADemo Application Command Descriptions
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
obgetobj
Syntax
obgetobj <"ObjName">
Description This command requests peer stack send object corresponding "ObjName". This command takes care dscv/connection/get/ disconnection operations. Note: entered object name found remote device, then ZirDADemo application gets first object stored object list, which stored remote device. Parameters
Parameter ObjName Parameter Type STRING Valid Range Description Name Object sent.
Example Request from local device:
ZirDA Demo>>obgetobj "um.txt" Searching devices.
Response remote:
ZirDA Demo>> <<<<< CONNECT INDICATION >>>>> Destination Device 0xXXXX Client Packet XXXXX
RM003602-0404
Generic IrOBEX File Transfer Commands
eZ80L92/F91/F92 ZirDADemo Application Commands
Server MaxPktLen XXXXX objects Length XXXXXX Description Device Name YYYYYYYYYYY <<<<< OBEX INDICATION >>>>> Object Name um.txt Object Type Object Description
<<<<< DISCONNECT INDICATION >>>>> Reason Disconnect Description ZirDA Demo>>
Response received local device:
<<<<< DISCOVERY CONFIRMATION >>>>> Total number Devices detected: Device 0xXXXX Device Name YYYYYYYYYYY Connecting device YYYYYYYYYYY. <<<<< CONNECT CONFIRMATION >>>>> Wow! connected Server OBEX PktLen 3000 Description Getting file. <<<<< CONFIRMATION >>>>> Description Data received: Good Morning Everybody!!!!
ZirDADemo Application Command Descriptions
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
Disconnecting from YYYYYYYYYYY. <<<<< DISCONNECT CONFIRMATION >>>>> Reason Disconnect Description ZirDA Demo>>
RM003602-0404
Generic IrOBEX File Transfer Commands
eZ80L92/F91/F92 ZirDADemo Application Commands
IrOBEX Statistics
quickly IrOBEX statistics commands hyperlinks Table 16.These commands provide statistics objects files exchanged using IrOBEX commands.
Table IrOBEX Statistics Commands
obstats obdispobj
IrOBEX statistics command descriptions begin next page.
ZirDADemo Application Command Descriptions
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
obstats
Syntax
obstats
Description This command lists statistics objects/files exchanged using IrOBEX commands. Note: statistics database ZirDADemo application store information about five objects files. Additional entries overwrite oldest entry. When data received more than only most recent10 data saved because application's receive buffers limited Parameters None Example
ZirDA Demo>>obstats <<<<< OBEX STATISTICS >>>>> objects received ObjName ObjType ObjDesc NULL NULL NULL NULL NULL ObjLength 4060 3422 Data Captured 2000 2000
moto.txt text god.txt zilog.txt card.vcf text text NULL
RM003602-0404
IrOBEX Statistics
eZ80L92/F91/F92 ZirDADemo Application Commands
obdispobj
Syntax
obdispobj <"ObjName">
Description This command lists statistics single object exchanged using IrOBEX commands. Note: obstats command list objects. Parameters
Parameter ObjName Parameter Type STRING Valid Range Description Name Object.
Example
ZirDA Demo>>obdispobj "zilog.txt" ObjName zilog.txt ObjType text ObjDesc NULL ObjLength
Data received: Welcome ZiLOG!
ZirDADemo Application Command Descriptions
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
Using IrCOMM (3-Wire Raw)
ZirDA1.0 stack supports IrCOMM commands listed Table links table quickly IrCOMM commands.
Table IrCOMM Commands
dscv (common IrOBEX IrCOMM) conn send disc commdemo dump (common IrOBEX IrCOMM)
IrCOMM commands begin next page.
RM003602-0404
Using IrCOMM (3-Wire Raw)
eZ80L92/F91/F92 ZirDADemo Application Commands
conn
Syntax
conn <"Your Name">
Description This command used make connect request activate link. Parameters
Parameter Parameter Type init-msg STRING Valid Range Description Name individual wishes chat.
Note: conn command makes discovery request before connecting device. more than device discovered, this command connects first device discovered. Example
ZirDA Demo>>conn "Jack" Connecting device: 0x200
When connected:
Jack>> Jack>>
Response remote:
ZirDA Demo>> ZirDA Demo>> Jack would like chat with you! wish accept, type 'ans "Your Name"' press Enter.
ZirDADemo Application Command Descriptions
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
Syntax
<"Your Name">
Description This command connect response accept incoming connection. Parameters
Parameter initial-msg Parameter Type STRING Valid Range Description Name individual accepts chat.
Example
ZirDA Demo>>ans "Jill"
Response remote:
Jack>> Jack>>Jill accepted chat with you.
RM003602-0404
Using IrCOMM (3-Wire Raw)
eZ80L92/F91/F92 ZirDADemo Application Commands
send
Syntax
send <"Chat Msg">
Description This command used data request send data remote Client/ Server. Parameters
Parameter chat-msg Parameter Type STRING Valid Range Description chat message (data transferred).
Example
Susan>>send "How your day?"
Response remote:
Anita>> Anita>> Susan>>How your day?
ZirDADemo Application Command Descriptions
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
disc
Syntax
disc <"Goodbye Msg">
Description This command used disconnect request chat session Client/Server end. Parameters
Parameter goodbye-msg Parameter Type STRING Valid Range Description last chat message.
Example
Helen>>disc "OK, bye, meet morning!" Disconnected!!
Response remote:
Abraham>> Abraham>> Abraham>>OK, bye, meet morning! Disconnected!!
RM003602-0404
Using IrCOMM (3-Wire Raw)
eZ80L92/F91/F92 ZirDADemo Application Commands
commdemo
Syntax
commdemo
Description This command demonstrates Printer inter-operability IrCOMM application layer with 4050N printer. example page printed printer. Parameters None Example
ZirDA Demo>>commdemo Connecting device: 0xXXXX Waiting response from remote. Connected! Sending data. Disconnecting Disconnected!
ZirDADemo Application Command Descriptions
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
Appendix A-The ZiLOG Website
address ZiLOG home page www.zilog.com. ZiLOG website includes valuable information about hardware software development tools documentation, including latest production-released version powerful ZiLOG Developer Studio (ZDS development tool, which easily downloaded from this site. types documentation that available from ZiLOG website include:
Product Specifications User Manuals Application Notes Reference Manuals Product Briefs
Documentation downloaded printed from site.
Preprinted Documentation
Print-on-demand hardcopy documentation obtained from Fatbrain.com. costs documentation vary generally range between $45. Shipment customers expected occur within days receipt order. ZiLOG's online library listed under programming, documentation, microprocessor, microcontroller sections Fatbrain.com website.
RM003602-0404
Appendix A-The ZiLOG Website
eZ80L92/F91/F92 ZirDADemo Application Commands
Appendix A-The ZiLOG Website
RM003602-0404
eZ80L92/F91/F92 ZirDADemo Application Commands
Customer Feedback
note inaccuracies while reading this Reference Manual, please copy complete this form, then mail ZiLOG (see Return Information, below). also welcome your suggestions!
Product Information ZirDADemo Application Commands Reference Manual Serial Board #/Rev. Software Version Document Number Host Computer Description/Type Customer Information Name Company Address City/State/Zip Return Information Race Street Jose, 95126-3432 Telephone: 408.558.8500 Fax: 408.558.8300 ZiLOG Customer Support Problem Description Suggestion Provide complete description problem your suggestion. reporting specific problem, include steps leading occurrence problem. Attach additional pages necessary. Country Phone E-Mail RM003602-0404
RM003602-0404
Customer Feedback
eZ80L92/F91/F92 ZirDADemo Application Commands
Customer Feedback
RM003602-0404
Other recent searches
uPD78F0148HGC-8BT - uPD78F0148HGC-8BT uPD78F0148HGC-8BT Datasheet
TPD1051F - TPD1051F TPD1051F Datasheet
SYM20101 - SYM20101 SYM20101 Datasheet
MMBTSC5084LT1 - MMBTSC5084LT1 MMBTSC5084LT1 Datasheet
M69AW024B - M69AW024B M69AW024B Datasheet
ISL9216 - ISL9216 ISL9216 Datasheet
ISL9217 - ISL9217 ISL9217 Datasheet
CR4340 - CR4340 CR4340 Datasheet
Privacy Policy | Disclaimer
© 2013 Datasheets.org.uk