EPSON OPOS ADK MANUAL APPLICATION DEVELOPMENT GUIDE LineDisplay (DM-D110/ DM-D120/ DM-D210) Version 2.61 Feb.
Notes (1) Reproduction of any part of this documentation by any means is prohibited. (2) The contents of this documentation are subject to change without notice. (3) Comments and notification of any mistakes in this documentation are gratefully accepted. (4) This software cannot be used with other equipment that the specified. (5) EPSON will not be responsible for any consequences resulting from the use of any information in this documentation.
Version 2.61 Feb. 2008 Contents Section 1. Introduction ........................................................................................................1 Section 2. Details on Settings.............................................................................................2 2.1 Device Information ....................................................................................................2 2.2 References of Firmware Versions .............................................................
Version 2.61 Feb. 2008 Section 1. Introduction This manual describes the method of use and related items, including device-specific precautions, when the LineDisplay device is used with EPSON OPOS ADK. Before the LineDisplay can be used, the EPSON OPOS ADK should be installed and the devices to be used should be set using the SetupPOS utility. For setting methods, see the Section 2 of this manual. This manual applies to the following devices.
Version 2.61 Feb. 2008 Section 2. Details on Settings This section describes connection configurations and how to make the settings for the LineDisplay devices. 2.1 Device Information The DeviceDescription and DeviceName for each model are as follows.
Version 2.61 Feb. 2008 2.3 Settings of DIP Switches and Hardware Confirm that the following settings have been made correctly. D110, D120, D210 No. Setting 1 OFF 2 OFF 3 OFF 4 OFF 5 ON 6 OFF 7 ON 8 OFF Recommend Settable Settable Settable Settable Settable Settable Recommended Settings of DIP-switches become valid only after the power has been turned on. • For D110, D120, D210 Settings of 1 and 8 of DIP-SW1 can be changed, but it is recommended to set to OFF position.
Version 2.61 Feb. 2008 2.4 Setting of Devices The SetupPOS utility should be used for setting devices. For more detail, refer to "EPSON OPOS ADK MANUAL User's Manual (Installer/ SetupPOS/ TMUSB)". 1) Setting of USB devices When using a USB port, select devices with “U” appended to the end of the device name using the SetupPOS utility. DM-D110U/D210U 2) Device Specific Settings Not applicable 2.
Version 2.61 Feb. 2008 The default settings are as shown in the following table. Setting Information Set value Baud rate 9600 Bit length 8 bits Parity NONE Stop bit 1 bit Handshake DTR/DSR Output buffer length 1024 Output interval time 500 When a display is hydra-connected to a printer, all display settings are exactly the same as the connected printer. In the case of some printers, the output buffer length may not be compatible with the default of the display.
Version 2.61 Feb. 2008 2.6 Connection Configuration There are two ways to connect the EPSON DM series LineDisplay; i.e, as independent devices or as slave devices connected by hydra settings through a printer. However, when using a USB connection, only the hydra-connection that the device is connected to the printer’s DM connector can be used. When using as an independent device, connect the display directly to the COM port on the PC or the IT(IR).
Version 2.61 Feb. 2008 (2) Connecting a display through a printer using modular connector (PCs) (Y Connection(Hydra Connection)) Host Device → PC Device POS Printer (RS232C,USB) PC: → LineDisplay (Modular) COM1-COM10 (serial), USB1-USBx (the USB port number differs with the environment in which it is used. For details, refer to "EPSON OPOS ADK MANUAL User's Manual (Installer/ SetupPOS/ TMUSB)".
Version 2.61 Feb. 2008 used (serial port) For the printer’s DIP Switches, the switch used for the customer display must be set to ON. Y(hydra) settings must have been correctly made using the SetupPOS utility. When using USB port connection, the display’s modular connection must be made to the USB I/F-BOARD and not to the printer’s DM-D connector.
Version 2.61 Feb. 2008 Section 3. Function Details This section describes the functions of the LineDisplay device in details. Supplementary explanation of the parts not described in detail in "UPOS" is also given here. 3.1 CheckHealth Method 3.1.1 Internal Test When executed, communications with the display is performed and the result is returned. Nothing is shown on the display. When the method is executed by OPOS_CH_INTERNAL, the character strings of the CheckHealthText property is as follows.
Version 2.61 Feb. 2008 After executing the CheckHealth method, be sure to confirm the returned value. If an error has occurred, there is no point in referring to the CheckHalthText property. For details on the occurred error, refer to the Section 6 of this manual. 3.1.3 Interactive Test Executes interactive CheckHealth test. When executed, the following dialog box is displayed. When [Start] is selected, the following character strings are sent to and displayed on the display.
Version 2.61 Feb. 2008 3.2 Property Set Values and Default Values 3.2.
Version 2.61 Feb. 2008 Code page setting range and default value Set Value (DM-D110, D120, D210) 437 *1, 850, 852, 858, 860, 863, 865, 866, 932, 998, CaracterSetList 999, 1252, 254, 255 *1 Denotes the default value. Relations between CharacterSet and set values *1 CharacterSet Page No.
Version 2.61 Feb. 2008 Set values of other properties Property Name Set Value Set Value (DM-D110/D120) (DM-D210) 4 2 20 0 20-7E 7 5 FALSE 0 0 0 2x20 4 2 20 20 20-7E 7 5 FALSE 0 0 0 2x20 DeviceWindow DeviceRows DeviceColumns DeviceDescriptors CustomGlyphList GlyphHeight GlyphWidth MapCharacterSet MaximumX MaximumY ScreenMode ScreenModeList 3.3 Restrictions on Parameters for Methods Method Name CreateWindow Parameter WindowHeight WindowWidth Max. Value Up to 1024 Up to 1024 3.
Version 2.61 Feb. 2008 Modify the MarqueeType property in the disable condition or after executing the ReleaseDevice method. Then, the display will take place in accordance with the modified MarqueeType property when the ClaimDevice method is executed and the DeviceEnabled property is set to TRUE. 3.4.3 Teletype Display Outside the Viewport Only the characters displayed inside the viewport are teletyped.
Version 2.61 Feb. 2008 One character is shown at a time inside the viewport during the first 6 seconds. 1 4 2 5 3 6 After that, the display position changes instantly without waiting for the interval set as the InterCharacterWait time. 1 4 7 0 3 2 5 8 1 3 6 9 2 However, since the data is longer than the window, scrolling occurs. 4 7 5 8 6 9 At this point, the “789”, newly displayed inside the viewport by scrolling, is displayed by teletype.
Version 2.61 Feb. 2008 Section 4. Expanded Functions This section describes the expanded functions of the LineDisplay device. 4.1 DirectIO Function The usage of the DirectIO method and DirectIOEvent event is described below. 4.1.1 DirectIO Method Syntax DirectIO Command As Long, pData As Long, pString As String Parameter Explanation Command Output format. Normally set to DISP_DI_OUTPUT*. pData Not used. Normally DISP_DI_DUMMY will be entered.
Version 2.61 Feb. 2008 Prerequisites Open, Claim & Enable 4.1.2 DirectIOEvent Event No applicable 4.2 List of Commands Usable with DirectIO The commands that can be output using DirectIO are described below. Outputting other than these commands will affect the OPOS settings and subsequent operation of OPOS cannot be guaranteed.
Version 2.61 Feb. 2008 Section 5. Device Specific Programming This section describes device specific programming of the LineDisplay devices. 5.1 Issuing ESC/POS Commands The EPSON DM series LineDisplay supports various ESC/POS commands. The DirectIO method is used to output these commands. For the DirectIO method specifications, see the Section 4 of this manual.
Version 2.61 Feb. 2008 Section 6. Error Information This section describes the error codes that may result from execution of LineDisplay methods. The common properties and methods are described in "EPSON OPOS ADK MANUAL APPLICATION DEVELOPMENT GUIDE GENERAL DEVELOPMENT". Refer to this guide for more information. 6.1 ResultCode List 6.1.1 When Executing Properties The ResultCode and ResultCodeExtended when properties are executed are as follows.
Version 2.61 Property Name CharacterSet CurrentWindow CursorRow CursorColumn CursorUpdate MarqueeType MarqueeFormat MarqueeUnitWait MarqueeRepeatWait ResultCode ResultCodeExtended Feb. 2008 Meaning OPOS_SUCCESS 0 Refer to UPOS Specifications. OPOS_E_CLOSED 0 Refer to UPOS Specifications. OPOS_E_CLAIMED 0 Refer to UPOS Specifications. OPOS_E_NOTCLAIMED 0 Refer to UPOS Specifications. OPOS_E_DISABLED 0 Refer to UPOS Specifications.
Version 2.61 Property Name InterCaracterWait BlinkRate CursorType MapCharacterSet ScreenMode *1 ResultCode ResultCodeExtended Feb. 2008 Meaning OPOS_SUCCESS 0 Refer to UPOS Specifications. OPOS_E_CLOSED 0 Refer to UPOS Specifications. OPOS_E_ILLEGAL OPOS_EX_BADPROPVAL Set value is illegal. OPOS_SUCCESS 0 Refer to UPOS Specifications. OPOS_E_CLOSED 0 Refer to UPOS Specifications. OPOS_E_ILLEGAL OPOS_EX_BADPROPVAL Set value is illegal. OPOS_EX_INCAPABLE Function cannot be used.
Version 2.61 Feb. 2008 6.1.2 When Executing Methods The ResultCode and ResultCodeExtended when methods are executed are as follows. Method Name DisplayText ResultCode ResultCodeExtended Meaning OPOS_SUCCESS 0 Refer to UPOS Specifications. OPOS_E_CLOSED 0 Refer to UPOS Specifications. OPOS_E_NOTCLAIMED 0 Refer to UPOS Specifications. OPOS_E_DISABLED 0 Refer to UPOS Specifications. OPOS_E_CLAIMED 0 Refer to UPOS Specifications.
Version 2.61 Method Name (DisplayTextAt) ResultCode OPOS_E_FAILURE ResultCodeExtended OPOS_EX_MICRMODE ClearText Refer to UPOS Specifications. 0 Refer to UPOS Specifications. OPOS_E_CLOSED 0 Refer to UPOS Specifications. OPOS_E_NOTCLAIMED 0 Refer to UPOS Specifications. OPOS_E_DISABLED 0 Refer to UPOS Specifications. OPOS_E_CLAIMED 0 Refer to UPOS Specifications. OPOS_E_ILLEGAL OPOS_EX_INVALIDMODE Marquee is under execution. OPOS_EX_DEVBUSY Device is busy.
Version 2.61 Method Name RefreshWindow ResultCode Feb. 2008 ResultCodeExtended Meaning OPOS_SUCCESS 0 Refer to UPOS Specifications. OPOS_E_CLOSED 0 Refer to UPOS Specifications. OPOS_E_NOTCLAIMED 0 Refer to UPOS Specifications. OPOS_E_DISABLED 0 Refer to UPOS Specifications. OPOS_E_CLAIMED 0 Refer to UPOS Specifications. OPOS_E_ILLEGAL OPOS_EX_INVALIDMODE Marquee is under execution. OPOS_EX_BADPARAM+1 The window specified in the Window parameter does not exist.
Version 2.61 Method Name SetDescriptor ResultCode ResultCodeExtended Feb. 2008 Meaning OPOS_SUCCESS 0 Refer to UPOS Specifications. OPOS_E_CLOSED 0 Refer to UPOS Specifications. OPOS_E_NOTCLAIMED 0 Refer to UPOS Specifications. OPOS_E_DISABLED 0 Refer to UPOS Specifications. OPOS_E_CLAIMED 0 Refer to UPOS Specifications. OPOS_E_ILLEGAL OPOS_EX_BADPARAM+1 Descriptor parameter is illegal. OPOS_EX_BADPARAM+2 Attribute parameter is illegal. OPOS_EX_INCAPABLE CapDescriptors is False.
Version 2.61 Method Name DefineGlyph ResultCode Feb. 2008 ResultCodeExtended Meaning OPOS_SUCCESS 0 Refer to UPOS Specifications. OPOS_E_CLOSED 0 Refer to UPOS Specifications. OPOS_E_NOTCLAIME 0 Refer to UPOS Specifications. OPOS_E_CLAIMED 0 Refer to UPOS Specifications. OPOS_E_DISABLED 0 Refer to UPOS Specifications. OPOS_E_ILLEGAL OPOS_EX_INCAPABLE CapCustomGlyph is FALSE. D OPOS_EX_BADPARAM+1 A character code outside the range set with CustomGlyphList is used.
Version 2.61 Method Name SetBitmap ResultCode Feb. 2008 ResultCodeExtended Meaning OPOS_SUCCESS 0 Refer to UPOS Specifications. OPOS_E_CLOSED 0 Refer to UPOS Specifications. OPOS_E_NOTCLAIME 0 Refer to UPOS Specifications. OPOS_E_DISABLED 0 Refer to UPOS Specifications. OPOS_E_CLAIMED 0 Refer to UPOS Specifications. OPOS_E_ILLEGAL OPOS_EX_INCAPABLE CapBitmap is FALSE. OPOS_EX_BADPARAM+1 ViewportRow parameter is illegal. OPOS_EX_BADPARAM+2 ViewportColumn parameter is D illegal.
Version 2.61 Feb. 2008 6.2 Remedial Actions for Principal Errors ResultCodeExtended Remedy OPOS_EX_DEVBUSY, If the power to the display is disconnected, it is necessary to once OPOS_EX_TIMEOUT apply Close and then invoke Open/Claim/Enable again. OPOS_EPTR_COVER_OPEN, Confirm the status of the printer, and then execute the methods and OPOS_EPTR_JRN(REC)_EMPTY, properties again.
Version 2.61 Feb. 2008 Section 7. Warnings When using the DirectIO method to issue a command, be sure to read the instructions on the particular command in the product manual. When adding a device by hydra settings, the port information should be in accordance with the settings of the parent device. When the DirectIO method is used to send data to the display, there may be data within the range from &H80 to &HFF that is not sent correctly.
Version 2.61 Feb. 2008 The number of Glyph characters that can be defined by the DefineGlyph method is decided by each model. Model Number of characters DM-D110, DM-D120, DM-D210 95 characters The error code differs by that timing when the power is turned OFF.
