Denso BHT-400-CE Reference Manual
Denso BHT-400-CE Reference Manual

Denso BHT-400-CE Reference Manual

Bar code handy terminal class library reference manual
Table of Contents

Advertisement

Quick Links

Bar Code Handy Terminal
BHT -400-CE
Class Library Reference Manual

Advertisement

Table of Contents
loading

Summary of Contents for Denso BHT-400-CE

  • Page 1 Bar Code Handy Terminal BHT -400-CE Class Library Reference Manual...
  • Page 2 Copyright © DENSO WAVE INCORPORATED, 2005 All rights reserved. No part of this publication may be reproduced in any form or by any means without permission in writing from the publisher. Specifications are subject to change without prior notice. All products and company names mentioned in this manual are trademarks or registered trademarks of their...
  • Page 3 Related Manuals Please refer to the following related manuals for further information. • kbifCE User’s Guide • BHT-400-CE API Reference Manual • BHT-400B-CE/400BW-CE User’s Manual Contacts Please forward any opinions or questions that you may have regarding this manual to the address below or contact us by telephone.
  • Page 4: Table Of Contents

    Contents 1. Development Environment .......................1 2. Development Procedure........................2 2.1. Project Creation Procedure......................2 2.2. Assignment Procedure ......................2 3. Device Control ..........................4 4. Barcode Reading..........................5 4.1. Readable Codes........................5 4.2. Trigger Switch Operation Mode....................6 4.3. Display LEDs and Beeper Control ...................7 4.4. Barcode Data ...........................7 4.5.
  • Page 5 11.1. Standby Transition Conditions....................26 11.2. Suspend Transition Conditions.....................27 12. Updating the OS...........................28 13. Status Display..........................29 14. System Information ........................30 15. Data Communication........................31 15.1. IrDA Interface ........................31 15.2. Connector Interface......................31 15.3. File Transfer .........................31 15.4. ActiveSync Auto Connection ....................31 16. Namespaces..........................32 17.
  • Page 6 17.34. NotSupportedException .....................68 17.35. CommSerial........................69 17.36. FileTransfer ........................70 18. Members............................71 18.1. Scanner ..........................71 18.2. Scanner.CodeInfo.......................113 18.3. Scanner.Settings ........................116 18.4. BatteryCollection ....................... 129 18.5. BatteryCollection.Battery....................132 18.6. Backlight..........................142 18.7. Backlight.Settings......................146 18.8. LED ........................... 153 18.9. LED.UsageCollection ......................160 18.10. Beep ..........................161 18.11.
  • Page 7: Development Environment

    1. Development Environment Development tool • Microsoft Visual Studio .NET 2003 Application development kit • This is a redistributable package intended for use by .NET Compact Framework and Service Pack developers. - Assembly required for application development - Tool for application assignment - CPU: ARMV4I - SP3 can be downloaded by accessing the following URL: http://www.microsoft.com/downloads/details.aspx?displaylang=en&FamilyID=7BF313B9-71ED-4E15...
  • Page 8: Development Procedure

    2. Development Procedure 2.1. Project Creation Procedure 1. Store the dedicated BHT class library (dll, xml file) in a suitable folder in the computer used for development. 2. Start up Visual Studio.NET. 3. Select [File] – [New] – [Project…] to create a new project. 4.
  • Page 9 9. Select [Build…] – [Build solution] and then assign a solution. Unless the IP address is changed, step 9 only is required from the second time onwards. When debugging, change both methods from [Build…] – [Build solution] to [Debug] – [Start]. - 3 -...
  • Page 10: Device Control

    3. Device Control The following table lists devices that can be controlled from the dedicated BHT class library and the respective classes used. Function Class Assembly Barcode reading Scanner Wireless communication Backlight Backlight Beeper, vibrator Beep Battery information Battery Keyboard Keys DNWA.BHT400CL.dll Power management...
  • Page 11: Barcode Reading

    4. Barcode Reading The barcode reading function has the following features. • Specification of barcode types for which reading is permitted • Specification of the trigger switch operation mode • Specification of the method used to notify the operator that reading is complete •...
  • Page 12: Trigger Switch Operation Mode

    4.2. Trigger Switch Operation Mode The following four modes exist based on differences in the illumination timing and duration of the illumination LED. These modes are specified at the Scanner.RdMode property. Auto-off mode (default) The illumination LED turns ON when the trigger switch is pressed, and turns OFF again when the trigger switch is released or a barcode is read.
  • Page 13: Display Leds And Beeper Control

    4.3. Display LEDs and Beeper Control A notification given to inform the operator that barcode reading has been performed successfully can be controlled as follows. This is specified at the Scanner.RdMode property. • Turn ON/do not turn ON display LEDs. (Default: Turn ON display LEDs.) •...
  • Page 14: Wireless Communication

    5. Wireless Communication 5.1. Wireless Communication System Configuration SS method data communication is performed using a wireless card. Wireless communication between the host computer and BHT is performed via an access point. Please refer to the “BHT-400B-CE/400BW-CE User’s Manual” for further details. The table below shows the wireless communication devices on the BHT-400 and communication state transition for the above system configuration.
  • Page 15: Wireless Communication Parameters

    5.2. Wireless Communication Parameters Make the following system settings in order to establish the wireless communication pathway. • ESSID (Extended Service Set ID) Can be set from the ZeroConfig menu or in the user program. • POWER Can be set from the System menu or in the user program. When making the settings in the System menu, please refer to the “BHT-400B-CE/400BW-CE User’s Manual”...
  • Page 16: Security

    5.3. Security The BHT can be used with following security configurations. • PEAP (802.1x) • EAP-TLS (802.1x) • PEAP (WPA) • EAP-TLS (WPA) • PSK (WPA) Details of the parameters used with the above security configurations are outlined in the table below. (●: Setting enabled, –: Setting disabled) Security Parameter...
  • Page 17: Programming

    5.4. Programming The programming procedure required to connect to the network is as follows. Select the profile to be edited. Use ESSID and Infrastructure to specify the profile. A new profile is created if no profile applicable to the specified ESSID and Infrastructure combination exists. Change parameter 1, parameter 2, ……parameter N for the selected profile.
  • Page 18: Backlight

    6. Backlight The backlight function has the following features. • Backlight control • Backlight control key specification • Backlight illumination duration specification • Brightness adjustment • Backlight OFF/DIM toggle - 12 -...
  • Page 19: Backlight Control

    6.1. Backlight Control The backlight can be controlled using the following methods. • Control by pressing the backlight function control key • Control using the backlight control property The backlight function can be enabled/disabled by pressing the backlight function control key (Default: Hold down [SF] key and press [M4].).
  • Page 20: Backlight Control Key

    6.2. Backlight Control Key The backlight function control key can be specified with the Backlight.Settings.CtrlKey property. The backlight is controlled by holding down the [SF] key and pressing [M4] by default. Furthermore, the current backlight control key can be acquired by reading the property value. Backlight Control Key Setting Backlight Control Key...
  • Page 21: Backlight Illumination Duration

    6.3. Backlight Illumination Duration The backlight illumination duration time can be set at or acquired from the Backlight.Settings.OnTimeBattery /OnTimeACTime property when the backlight is powered by the battery or when the BHT is installed on the CU. The illumination duration default value is 3 seconds when powered by the battery, and 60 seconds when installed on the CU.
  • Page 22: Beeper, Vibrator

    7. Beeper, Vibrator The beeper and vibrator function is equipped with the following features. • The beeper or vibrator is selected and the beeper volume setting made at the system settings. • Sound pattern specification 7.1. Beeper/Vibrator Selection It is possible to select from “Beeper only”, “Vibrator only”, and “Beeper and vibrator”. Sounding of the beeper or activation of the vibrator from the application is controlled using an indexer.
  • Page 23: Beeper Volume

    7.3. Beeper Volume The beeper volume level can be selected from the six levels shown in the table below, however, there are in fact only four levels; OFF, Low, Medium and High. Setting Volume Level Medium High When sounding the beeper from the application, the volume setting is valid only when the frequency is set to “0”, “1”, or “2”.
  • Page 24: Battery Information

    8. Battery Information The battery information function provides the following information. • Battery voltage (mV) • CU installation status (charge status) • Battery level • Battery type There are six battery levels. The battery level is “HIGH” when fully charged and continues to drop to “MID” and then “LOW” and so on as the BHT is used.
  • Page 25: Keyboard

    9. Keyboard The following key functions exist in addition to the standard press/release functions. • Input mode change • Magic key function assignment • [SF] key operation mode change 9.1. Input Mode Change The following input modes are available. • Numeric entry mode (default), function mode (*1) By pressing the [FUNC] key, an icon displays and the mode changes to Function mode, however, the operation for the returned virtual key codes and display characters does not change.
  • Page 26: Numeric Entry Mode

    9.3. Numeric Entry Mode The virtual key codes and display characters returned when keys are pressed in numeric entry mode are shown in “Appendix 2. Virtual Keyboard and Display Characters”. 9.4. Alphabet Entry Mode With the 31-key type BHT-400, it is only possible to use the keys to enter alphabet characters when in this input mode.
  • Page 27: Magic Key Operation

    Keys used for alphabet entry mode The table below lists keys whose operations are different from those in the numeric entry mode. Description Used to enter alphabet characters. The alphabet characters assigned to each key [0] to [9] and period [.] are based on the character codes in “Appendix 2.
  • Page 28: Shift Key Operation

    The default functions for each magic key are as follows. Default Function Default Function [M1] [TAB] [M2] None [M3] Trigger [M3H] Marker light [M4] Trigger [M4H] Marker light [M5] Trigger [M5H] Marker light [SCAN] Trigger The virtual key codes and display characters returned when functions are assigned to magic keys are as follows. Character Parameter Function...
  • Page 29: Auto Repeat Function

    9.7. Auto Repeat Function The key auto repeat function is activated when a single key is held down continuously. The following table shows the list of valid keys and invalid keys for the auto repeat function. 31-key Type 50-key Type •...
  • Page 30: Led

    10. LED The BHT has two LEDs, a display LED (red/blue) to notify the operator that barcode reading is complete, and a charge LED (red/green) to notify the operator of the charge status. The illumination status for the display LED can be controlled from the application. The illumination status is set and acquired using a 2D indexer.
  • Page 31 The red LED is shared with the charge LED and turns ON in either of the following situations. 1. The red LED is turned ON from the application. 2. While the BHT is charging If, therefore, an attempt is made to turn OFF the red LED from the application while charging, the LED will remain - 25 -...
  • Page 32: Power Management

    11. Power Management The four power statuses are listed in the table below. Power ON Standby Suspend Critical OFF (*1) (*2) (*2) TURBO RUN DEEP IDLE SLEEP SLEEP / RUN / IDLE (*1) No processing is performed when the BHT is on standby. Furthermore, ensure to disable standby before accessing the card.
  • Page 33: Suspend Transition Conditions

    11.2. Suspend Transition Conditions The BHT switches to suspend when the power key is pressed, when the event that prohibits suspend has been completed and the auto power OFF time has elapsed, and when the method used to switch to suspend is called from the application.
  • Page 34: Updating The Os

    12. Updating the OS The system can be updated (version update) by creating and executing the update applications discussed in the procedure below while Windows CE is running. Update method using RAM (1) Call up the PwrMng.Shutdown(PwrMng.EN_SHUTDOWN_MODE.SYSMODIFY) method and reboot the BHT (*1).
  • Page 35: Status Display

    13. Status Display Enabling and disabling of the following status display icons can be controlled from the application. Property Icon Meaning High 3.9 V or more Medium Less than 3.9 V Residual battery Battery voltage Less than 3.7 V Warning Less than 3.6 V [SF] key pressed [SF] key...
  • Page 36: System Information

    14. System Information The following system information can be acquired from the BHT. • System version • Machine name • Machine No. • Serial No. • RAM size • ROM size The RAM and ROM size constitute the size of the BHT memory. This does not refer to the amount of available space or user space.
  • Page 37: Data Communication

    15. Data Communication The following communication interfaces can be used for communication with the host computer. Of the three listed below, the IrDA interface and connector interface can be used with the CommSerial class and FileTransfer class in order to create applications. •...
  • Page 38: Namespaces

    16. Namespaces The following three namespaces exist in the BHT-400 class library. Namespace Name Description DNWA.BHTCL Class group used to realize functions unique to the BHT-400. DNWA.Exception Thrown exception class group. DNWA.Tools.BHT.Communication File Transfer, Serial Communication - 32 -...
  • Page 39: Class

    17. Class DNWA.BHTCL Namespace The DNWA.BHTCL namespace includes the following classes. Class Name Description 17.1. Scanner Barcode read control, read results acquisition 17.2. Scanner.CodeInfo Code information 17.3. Scanner.Settings Barcode related system settings 17.4. BatteryCollection Battery collection 17.5. BatteryCollection.Battery Battery information acquisition 17.6.
  • Page 40 DNWA.Exception Namepsace The DNWA.Exception namespace includes the following classes. Class Name Description 17.29. ArgumentException An exception thrown when a specified parameter is invalid. 17.30. ObjectDisposedException An exception thrown when an operation request is issued to a device whose file has not been opened. 17.31.
  • Page 41: Scanner

    17.1. Scanner Controls barcode reading and acquires the read data. For a description of all members of this class, refer to section “18.1. Scanner". Syntax [VB] Public Class Scanner [C#] public class Scanner Namespace DNWA.BHTCL Assembly DNWA.BHT400CL.dll - 35 -...
  • Page 42: Scanner.codeinfo

    17.2. Scanner.CodeInfo Acquires the code information read by the scanner. This class exists within the Scanner class. For a description of all members of this class, refer to section “18.2. Scanner.CodeInfo". Syntax [VB] Public Class Scanner.CodeInfo [C#] public class Scanner.CodeInfo Namespace DNWA.BHTCL Assembly...
  • Page 43: Scanner.settings

    17.3. Scanner.Settings Sets or acquires barcode related parameters. This class exists within the Scanner class. For a description of all members of this class, refer to section “18.3. Scanner.Settings". Syntax [VB] Public Class Scanner.Settings [C#] public class Scanner.Settings Namespace DNWA.BHTCL Assembly DNWA.BHT400CL.dll - 37 -...
  • Page 44: Batterycollection

    17.4. BatteryCollection Acquires information on the battery such as the charge status and output voltage. For a description of all members of this class, refer to section “18.4. BatteryCollection". Syntax [VB] Public Class BatteryCollection [C#] public class BatteryCollection Namespace DNWA.BHTCL Assembly DNWA.BHT400CL.dll - 38 -...
  • Page 45: Batterycollection.battery

    17.5. BatteryCollection.Battery Acquires information on the battery such as the charge status and output voltage. For a description of all members of this class, refer to section “18.5. BatteryCollection.Battery". Syntax [VB] Public Class BatteryCollection.Battery [C#] public class BatteryCollection.Battery Namespace DNWA.BHTCL Assembly DNWA.BHT400CL.dll - 39 -...
  • Page 46: Backlight

    17.6. Backlight Sets or acquires the ON/OFF status of the backlight. For a description of all members of this class, refer to section “18.6. Backlight". Syntax [VB] Public Class Backlight [C#] public class Backlight Namespace DNWA.BHTCL Assembly DNWA.BHT400CL.dll - 40 -...
  • Page 47: Backlight.settings

    17.7. Backlight.Settings Sets or acquires backlight related parameters. This class exists within the Backlight class. For a description of all members of this class, refer to section “18.7. Backlight.Settings". Syntax [VB] Public Class Backlight.Settings [C#] public class Backlight.Settings Namespace DNWA.BHTCL Assembly DNWA.BHT400CL.dll - 41 -...
  • Page 48: Led

    17.8. LED Sets or acquires the LED ON/OFF status. For a description of all members of this class, refer to section “18.8. LED". Syntax [VB] Public Class [C#] public class Namespace DNWA.BHTCL Assembly DNWA.BHT400CL.dll - 42 -...
  • Page 49: Led.usagecollection

    17.9. LED.UsageCollection This class is invalid at the BHT-400. - 43 -...
  • Page 50: Beep

    17.10. Beep Controls the beeping of the beeper and vibration of the vibrator. For a description of all members of this class, refer to section “18.10. Beep". Syntax [VB] Public Class Beep [C#] public class Beep Namespace DNWA.BHTCL Assembly DNWA.BHT400CL.dll - 44 -...
  • Page 51: Beep.settings

    17.11. Beep.Settings Sets or acquires the beeper and vibrator related parameters. This class exists within the Beep class. For a description of all members of this class, refer to section “18.11. Beep.Settings". Syntax [VB] Public Class Beep.Settings [C#] public class Beep.Settings Namespace DNWA.BHTCL...
  • Page 52 17.12. RF Opens and closes wireless communication, and sets or acquires the parameters for wireless communication. For a description of all members of this class, refer to section “18.12. RF". Syntax [VB] Public Class [C#] public class Namespace DNWA.BHTCL Assembly DNWA.BHT400CL.dll - 46 -...
  • Page 53: Rf.profile

    17.13. RF.Profile Sets or acquires properties for the wireless communication profile. This class exists within the RF class. For a description of all members of this class, refer to section “18.13. RF.Profile". Syntax [VB] Public Class RF.Profile [C#] public class RF.Profile Namespace DNWA.BHTCL...
  • Page 54: Rf.settings

    17.14. RF.Settings Sets or acquires the parameters for wireless communication. This class exists within the RF class. For a description of all members of this class, refer to section “18.14. RF.Settings". Syntax [VB] Public Class RF.Settings [C#] public class RF.Settings Namespace DNWA.BHTCL Assembly...
  • Page 55: Rf.wepkeycollection

    17.15. RF.WepKeyCollection Specifies the Wep key. This class exists within the RF class. For a description of all members of this class, refer to section “18.15. RF.WepKeyCollection". Syntax [VB] Public Class RF.WepKeyCollection [C#] public class RF.WepKeyCollection Namespace DNWA.BHTCL Assembly DNWA.BHT400CL.dll - 49 -...
  • Page 56: Rf.sitesurvey

    17.16. RF.SiteSurvey Acquires SiteSurvey data. This class exists within the RF class. For a description of all members of this class, refer to section “18.16. RF.SiteSurvey". Syntax [VB] Public Class RF.SiteSurvey [C#] public class RF.SiteSurvey Namespace DNWA.BHTCL Assembly DNWA.BHT400CL.dll - 50 -...
  • Page 57: Rf.info

    17.17. RF.Info Acquires information on wireless communication. This class exists within the RF class. For a description of all members of this class, refer to section ”18.17. RF.Info". Syntax [VB] Public Class RF.Info [C#] public class RF.Info Namespace DNWA.BHTCL Assembly DNWA.BHT400CL.dll - 51 -...
  • Page 58: Keys

    17.18. Keys Sets or acquires keyboard related parameters and defines the magic key. For a description of all members of this class, refer to section “18.18. Keys". Syntax [VB] Public Class Keys [C#] public class Keys Namespace DNWA.BHTCL Assembly DNWA.BHT400CL.dll - 52 -...
  • Page 59: Keys.settings

    17.19. Keys.Settings Sets or acquires keyboard related parameters. This class exists within the Keys class. For a description of all members of this class, refer to section “18.19. Keys.Settings". Syntax [VB] Public Class Keys.Settings [C#] public class Keys.Settings Namespace DNWA.BHTCL Assembly DNWA.BHT400CL.dll - 53 -...
  • Page 60: Sysinfo

    17.20. SysInfo Sets or acquires system information. For a description of all members of this class, refer to section “18.20. SysInfo". Syntax [VB] Public Class SysInfo [C#] public class SysInfo Namespace DNWA.BHTCL Assembly DNWA.BHT400CL.dll - 54 -...
  • Page 61: Sysinfo.settings

    17.21. SysInfo.Settings Sets or acquires parameters related to the system information. This class exists within the SysInfo class. For a description of all members of this class, refer to section “18.21. SysInfo.Settings". Syntax [VB] Public Class SysInfo.Settings [C#] public class SysInfo.Settings Namespace DNWA.BHTCL...
  • Page 62: Pwrmng

    17.22. PwrMng Sets or acquires power management related parameters for the BHT and controls the shut down process. For a description of all members of this class, refer to section “18.22. PwrMng". Syntax [VB] Public Class PwrMng [C#] public class PwrMng Namespace DNWA.BHTCL...
  • Page 63: Pwrmng.settings

    17.23. PwrMng.Settings Sets or acquires the parameters for power management. This class exists within the PwrMng class. For a description of all members of this class, refer to section “18.23. PwrMng.Settings". Syntax [VB] Public Class PwrMng.Settings [C#] public class PwrMng.Settings Namespace DNWA.BHTCL Assembly...
  • Page 64: Icon

    17.24. Icon Sets or acquires the icon display status (enabled/disabled). For a description of all members of this class, refer to section “18.24. Icon". Syntax [VB] Public Class Icon [C#] public class Icon Namespace DNWA.BHTCL Assembly DNWA.BHT400CL.dll - 58 -...
  • Page 65: Icon.settings

    17.25. Icon.Settings Enables or disables the display of icons. This class exists within the Icon class. For a description of all members of this class, refer to section “18.25. Icon.Settings". Syntax [VB] Public Class Icon.Settings [C#] public class Icon.Settings Namespace DNWA.BHTCL Assembly DNWA.BHT400CL.dll...
  • Page 66: Display

    17.26. Display This function is not supported. - 60 -...
  • Page 67: Display.settings

    17.27. Display.Settings This function is not supported. - 61 -...
  • Page 68: Sysmodification

    17.28. SysModification Updates the BHT system program. For a description of all members of this class, refer to section “18.28. SysModification". Syntax [VB] Public Class SysModification [C#] public class SysModification Namespace DNWA.BHTCL Assembly DNWA.BHT400CL.dll - 62 -...
  • Page 69: Argumentexception

    17.29. ArgumentException An exception that is thrown when the value set in the property or the value of one of the parameters specified in the method is invalid. Syntax [VB] Public Class ArgumentException Inherits System.ArgumentException [C#] public class ArgumentException : System.ArgumentException Namespace DNWA.BHTCL Assembly...
  • Page 70: Objectdisposedexception

    17.30. ObjectDisposedException An exception that is thrown when an operation request is issued to a device whose file has not been opened. Syntax [VB] Public Class ObjectDisposedException Inherits System.ObjectDisposedException [C#] public class ObjectDisposedException : System.ObjectDisposedException Namespace DNWA.BHTCL Assembly DNWA.Exception.dll - 64 -...
  • Page 71: Securityexception

    17.31. SecurityException An exception that is thrown when an open request is issued to a device file for which authorization for opening cannot be obtained (e.g., when the file is already opened). Syntax [VB] Public Class SecurityException Inherits System.SecurityException [C#] public class SecurityException : System.SecurityException...
  • Page 72: Devicenotfoundexception

    17.32. DeviceNotFoundException An exception that is thrown when an operation request is issued to a device that is not installed on the BHT. Syntax [VB] Public Class DeviceNotFoundException Inherits System.IO.FileNotFoundException [C#] public class DeviceNotFoundException : System.IO.FileNotFoundException Namespace DNWA.BHTCL Assembly DNWA.Exception.dll - 66 -...
  • Page 73: Deviceloadexception

    17.33. DeviceLoadException An exception that is thrown when an operation request is issued to a device that is not ready to process it. Syntax [VB] Public Class DeviceLoadException Inherits System.IO.FileLoadException [C#] public class DeviceLoadException : System.IO.FileLoadException Namespace DNWA.BHTCL Assembly DNWA.Exception.dll - 67 -...
  • Page 74: Notsupportedexception

    17.34. NotSupportedException An exception that is thrown when an attempt is made to carry out a function that is not supported. Syntax [VB] Public Class NotSupportedException Inherits System.IO.PlatformNotSupportedException [C#] public class NotSupportedException : System.IO.PlatformNotSupportedException Namespace DNWA.BHTCL Assembly DNWA.Exception.dll - 68 -...
  • Page 75: Commserial

    17.35. CommSerial Sets or acquires the parameters for serial communication and performs data communication. For a description of all members of this class, refer to section “18.29. CommSerial". Syntax [VB] Public Class CommSerial [C#] public class CommSerial Namespace DNWA.Tools.BHT.Communication Assembly DNWA.Tools.BHT.Communication400.dll - 69 -...
  • Page 76: Filetransfer

    17.36. FileTransfer Controls the uploading and downloading of files using the Y-modem protocol. For a description of all members of this class, refer to section “18.30. FileTransfer" Syntax [VB] Public Class FileTransfer [C#] public class FileTransfer Namespace DNWA.Tools.BHT.Communication Assembly DNWA.Tools.BHT.Communication400.dll - 70 -...
  • Page 77: Members

    18. Members 18.1. Scanner Constructor Constructor Name Description Scanner Creates a new instance of the Scanner class. Fields Field Name Description MAX_BAR_LEN Maximum number of digits in barcode MAX_2DCODE_LEN Maximum number of digits in 2D code ALL_BUFFER Used to acquire the contents of the entire buffer by the Input method Properties Property Name Description...
  • Page 78 Events Event Name Description OnDone Occurs when decoding is complete. Enumeration None - 72 -...
  • Page 79 Scanner Initializes a new instance of the Scanner class. Syntax ■ [VB] Public Sub New( ) [C#] public Scanner( ) Parameters ■ None Exceptions ■ None [Ex.] Create a MyScanner Scanner instance. [VB] Dim MyScanner As Scanner = New Scanner [C#] Scanner MyScanner = new Scanner();...
  • Page 80 MAX_BAR_LEN The maximum number of digits in the barcode. This value is fixed (not variable). Syntax ■ [VB] Public Const MAX_BAR_LEN As Integer [C#] public const int MAX_BAR_LEN; [Ex.] Declare a buffer containing a barcode with the maximum number of elements. [VB] Dim ReadBuf(Scanner.MAX_BAR_LEN) As Byte [C#] Byte[] ReadBuf = new byte[Scanner.MAX_BAR_LEN];...
  • Page 81 ALL_BUFFER Specify this parameter during a read operation using the Input method to read the contents of the entire barcode buffer. This value is fixed (not variable). Syntax ■ [VB] Public Const ALL_BUFFER As Integer [C#] public const int ALL_BUFFER; [Ex.] Read all remaining data in the barcode buffer.
  • Page 82 RdMode Sets or acquires Read mode. Syntax ■ [VB] Public Property RdMode As String [C#] public string RdMode {get; set} Property ■ Character string used to specify read mode Default value: "FB" Exceptions ■ None Note ■ The setting for this property will be valid the next time the read operation is enabled. If an invalid character string is specified, no exceptions are thrown immediately, however, an exception is thrown the next time the read operation is enabled.
  • Page 83 Auto-off mode (F) Press the trigger switch to turn ON the illumination LED. The LED turns OFF when the switch is released or when the BHT completes barcode reading. The LED remains illuminated for a maximum of 5 seconds when the trigger switch is held down. The BHT can read barcodes while the illumination LED is ON.
  • Page 84 Notes: If no choice is specified for the read mode, the auto-off mode is selected by default. In momentary switching mode, alternate switching mode, or continuous reading mode, if, after reading a low-quality barcode requiring more than one second to read, the barcode read head remains in close proximity to that barcode, the BHT may re-read the same barcode again at intervals of one second (or longer).
  • Page 85 Beeper control and LED control This property is used to control the action of the beeper and indicator LED when a barcode has been read successfully. This property also allows the vibrator to be controlled with beeper control. Specify the parameters for read mode, beeper control, and LED control with no spaces in between. Specify the parameters for read mode, beeper control, and LED control in this order.
  • Page 86 RdType Sets or acquires the codes that are to be read-enabled. Syntax ■ [VB] Public Property RdType As String [C#] public string RdType {get; set} Property ■ Character string used to specify read-enabled codes Default value: "A,I:4-99,M:1-99,N:3-99,L:1-99,K:1-99,H:3-99,P:1-99" Exceptions ■ None ■...
  • Page 87 The BHT-400B supports universal product codes, Interleaved 2of5 (ITF), Codabar (NW-7), Code-39, Code-93, Code-128, Standard 2of5 (STF), and MSI. It can also read EAN-128 if Code-128 is specified. • Universal product codes (A) [Syntax] A [:[code] [1 character [2 character]][supplemental]] Specify a code from one of the following.
  • Page 88 • Interleaved 2 of 5 (ITF) (I) [Syntax] I [:[mini.no.digits[-max.no.digits]][CD]] The mini.no.digits and max.no.digits are the minimum and maximum numbers of barcode digits to be read by the BHT, respectively. These numbers must both be between 2 and 99 (inclusive) and satisfy the following condition: mini.no.digits ≤...
  • Page 89 • CODABAR (NW-7) (N) [Syntax] N [:[mini.no.digits[-max.no.digits]][startstop][CD]] The mini.no.digits and max.no.digits are the minimum and maximum numbers of barcode digits to be read by the BHT, respectively. These numbers must both be between 3 and 99 (inclusive) and satisfy the following condition: mini.no.digits ≤...
  • Page 90 • CODE-39 (M) [Syntax] M [:[mini.no.digits[-max.no.digits]][CD]] The mini.no.digits and max.no.digits are the minimum and maximum numbers of barcode digits to be read by the BHT, respectively. These do not include the start and stop characters. These numbers must both be between 1 and 99 (inclusive) and satisfy the following condition: mini.no.digits ≤...
  • Page 91 • CODE-93 (L) [Syntax] L [:[mini.no.digits[-max.no.digits]]] The mini.no.digits and max.no.digits are the minimum and maximum numbers of barcode digits to be read by the BHT, respectively. These do not include the start and stop characters or check digits. These numbers must both be between 1 and 99 (inclusive) and satisfy the following condition: mini.no.digits ≤...
  • Page 92 • CODE-128 (K) [Syntax] K [:[mini.no.digits[-max.no.digits]]] The mini.no.digits and max.no.digits are the minimum and maximum numbers of barcode digits to be read by the BHT, respectively. These do not include the start and stop characters or check digits. These numbers must both be between 1 and 99 (inclusive) and satisfy the following condition: mini.no.digits ≤...
  • Page 93 Handling of special characters If the BHT reads a barcode made up of special characters only (such as FNC, CODE-A, CODE-B, CODE-C and SHIFT characters), it will not transfer the data to the barcode buffer. If the beeper is enabled, only the beeper sounds. •...
  • Page 94 • Standard 2 of 5 (STF) (H) [Syntax] H [:[mini.no.digits[-max.no.digits]][CD][startstop]] The mini.no.digits and max.no.digits are the minimum and maximum numbers of barcode digits to be read by the BHT, respectively. These do not include the start and stop characters. These numbers must both be between 1 and 99 (inclusive) and satisfy the following condition: mini.no.digits ≤...
  • Page 95 • MSI (P) [Syntax] P [:[mini.no.digits[-max.no.digits]][CD]] The mini.no.digits and max.no.digits are the minimum and maximum numbers of barcode digits to be read by the BHT, respectively. These do not include the start and stop characters. These numbers must both be between 1 and 99 (inclusive) and satisfy the following condition: mini.no.digits ≤...
  • Page 96 PortOpen Enables or disables barcode reading. Syntax ■ [VB] Public WriteOnly Property PortOpen As Boolean [C#] public bool PortOpen {set} Property ■ Read-enabled (= True), Read-disabled (= False) Default value: False Exceptions ■ Name of Exception Meaning SecurityException Barcode device file already opened ArgumentException The specified read mode was invalid.
  • Page 97 InBufferCount Acquires the number of digits in the barcode remaining in the barcode buffer. Syntax ■ [VB] Public Property ReadOnly InBufferCount As Integer [C#] public int InBufferCount {get} Property ■ Number of digits in the barcode in the barcode buffer Default value: Exceptions ■...
  • Page 98 InBufferType Acquires the type of barcode remaining in the barcode buffer. Syntax ■ [VB] Public Property ReadOnly InBufferType As Char [C#] public char InBufferType {get} Property ■ Type of barcode in the barcode buffer The correlation between code type and InBufferType values is shown below. Code Type InBufferType None (No code read)
  • Page 99 Default value: 0 (Nothing in VB.NET) Exceptions ■ None ■ Note The value is reset to zero (0) when all data is read from the barcode buffer using the Input method and the barcode buffer is empty. The value is reset to zero (0) the moment barcode reading is disabled. [Ex.] Acquire the code type for data remaining in the barcode buffer.
  • Page 100 LastCount Acquires the number of digits in the barcode that was read last. “0” is stored if no barcodes are read since the BHT was last started up. Syntax ■ [VB] Public Property ReadOnly LastCount As Integer [C#] public int LastCount {get} Property...
  • Page 101 LastType Acquires the type of code that was read last. “0” is stored if no barcodes are read since the BHT was last started up. Syntax ■ [VB] Public Property ReadOnly LastType As Integer [C#] public int LastType {get} Property ■...
  • Page 102 LastCodeInfo Acquires information on the code that was read last. Syntax ■ [VB] Public Property ReadOnly LastCodeInfo As Scanner.CodeInfo [C#] public Scanner.CodeInfo LastCodeInfo {get} Property ■ Information on the barcode that was read last The correlation between the barcode type and values is the same as that for the InBufferType.
  • Page 103 LastCodeNum Acquires the number of codes (rows) that were read last. Syntax ■ [VB] Public Property ReadOnly LastCodeNum As Integer [C#] public int LastCodeNum {get} Property ■ Number of barcodes that were read last. If the code that was read last is a multi-line code, the number of rows is returned. If the code that was read last is a composite code, the number of codes constituting the composite code (which is “2”) is returned.
  • Page 104 Input Reads unicoded data from the barcode buffer. Syntax ■ [VB] Public Function Input(ByVal len As Integer) As String [C#] public string Input(int len) Parameters ■ [in] Maximum number of digits in the barcode to be read Specifying Scanner.ALL_BUFFER causes the entire contents of the barcode buffer to be read.
  • Page 105 Input Reads unicoded data from the barcode buffer. ■ Syntax [VB] Public Function Input(ByVal buffer() As Char,ByVal offset As Integer, _ len As Integer) As Integer [C#] public int Input(char[] buffer, int offset, int len) Parameters ■ buffer [out] Destination buffer offset [in] Offset value within buffer indicating the start point of reading Specifying Scanner.ALL_BUFFER causes the entire contents of the barcode buffer to...
  • Page 106 ■ Note Calling this method while barcode reading is disabled will cause an exception to be thrown. [Ex.] Read out the last read data converted to Unicode. [VB] len = MyScanner.Input(buffer, 0, Scanner.ALL_BUFFER) [C#] len = MyScanner.Input(buffer, 0, Scanner.ALL_BUFFER); - 100 -...
  • Page 107 Input Reads binary data from the barcode buffer. ■ Syntax [VB] Public Function Input(ByVal buffer() As Byte, ByVal offset As Integer, _ len As Integer) As Integer [C#] public int Input(byte[] buffer, int offset, int len) Parameters ■ buffer [out] Destination buffer offset [in] Offset value within buffer indicating the start point of reading [in] Maximum number of barcode digits to be read out...
  • Page 108 ■ Note Calling this method while barcode reading is disabled will cause an exception to be thrown. When displaying the read data, it is necessary to use the encoding class and convert to Unicode. [Ex.] Use the ANSI code page encoding currently set in the system and convert to Unicode.
  • Page 109 GetChkDigit Calculates the check digit for the barcode data based on the specified calculation algorithm. Syntax ■ [VB] Public Shared Function GetChkDigit(ByVal bardata As String, _ ByVal type As Char) As Integer [C#] public static int GetChkDigit(string bardata, char type) Parameters ■...
  • Page 110 ■ Note If the barcode data within the code (excluding the check digit positions) contains any characters outside the character set corresponding to the barcode type specified by the check digit type, this function returns "0" and throws an exception. However, if only the check digit positions contain a character outside the valid character set, then this function calculates the correct check digit and returns it as a single-character string.
  • Page 111 When CD type is A(EAN (JAN) or UPC): This function identifies the code type (EAN or UPC) based upon the data length (number of digits) as shown below. If the data length is other than 13, 8, or 7, this function returns "0" and throws an exception. No.
  • Page 112 When CD type is I (ITF): The barcode data must be an even number with two or more digits. Otherwise, this function returns "0" and throws an exception. To check whether the CD is correct, pass a piece of barcode data with a CD to the Scanner.GetChkDigit method as shown below.
  • Page 113 When CD type is H (STF): The barcode data must be two or more digits in length. Otherwise, this function returns "0" and throws an exception. To check whether the CD is correct, pass a piece of barcode data with a CD to the Scanner.GetChkDigit method as shown below.
  • Page 114 When CD type is N (Codabar): The barcode data must be three or more digits in length, including the start and stop characters. Otherwise, this function returns "0" and throws an exception. To check whether the CD is correct, pass a piece of barcode data with a CD to the Scanner.GetChkDigit method as shown below.
  • Page 115 When CD type is M (Code 39): The barcode data must be two or more digits in length, excluding the start and stop characters. Otherwise, this function returns "0" and throws an exception. To check whether the CD is correct, pass a piece of barcode data with a CD to the Scanner.GetChkDigit method as shown below.
  • Page 116 When CD type is P (MSI): The barcode data must be two or more digits in length. Otherwise, this function returns "0" and throws an exception. To calculate a two-digit CD, call this function twice. To check whether the CD is correct, pass a piece of barcode data with a CD to the Scanner.GetChkDigit method as shown below.
  • Page 117 Dispose Frees up all the unmanaged resources. This function must be called before instances of the Scanner class are no longer referenced. Syntax ■ [VB] Public Sub Dispose() [C#] public void Dispose() Parameters ■ None ■ Return value None Exceptions ■...
  • Page 118 OnDone This event occurs when decoding is complete. ■ Syntax [VB] Public Event OnDone As EventHandler [C#] public event EventHandler OnDone ■ Event data The Event Handler has received EventArgs type parameters. The second parameter EventArgs e is always System.EventArgs.Empty. [Ex.] Read data when decoding complete.
  • Page 119: Scanner.codeinfo

    18.2. Scanner.CodeInfo Constructor None Instances cannot be created directly from this class. Fields None Properties Property Name Description Type Code Type Number of digits in code (code length) Methods None Events None Enumeration None - 113 -...
  • Page 120 Type Acquires the code type. ■ Syntax [VB] Public ReadOnly Property Type As Char [C#] public char Type {get;} ■ Property Code type. Refer to InBufferType for the relationship between code types and properties. Default value: 0 Exceptions ■ None [Ex.] Acquire the code type and number of digits in all rows for the data last read.
  • Page 121 Acquires the number of digits in the code (code length). ■ Syntax [VB] Public ReadOnly Property As Integer [C#] public int {get;} ■ Property Number of digits in the code Default value: 0 Exceptions ■ None [Ex.] Acquire the code type and number of digits in all rows for the data last read. [VB] For i = 0 To MyScanner.LastCodeNum len(i) = MyScanner.LastCodeInfo(i).Len...
  • Page 122: Scanner.settings

    18.3. Scanner.Settings Constructor None Instances cannot be created directly from this class. Fields None Properties Property Name Description CRTime Re-read prevention time Invert Enabling/disabling of black-and-white inverted label reading function DecodeLevel Decoding level MinDigitITF Marker mode MinDigitSTF Minimum number of digits in ITF (Interleaved 2of5) MinDigitNW7 Minimum number of digits in STF (Standard 2of5) Marker...
  • Page 123 CRTime Sets or acquires re-read prevention time. ■ Syntax [VB] Public Shared Property CRTime As Integer [C#] public static int CRTime {get; set;} Property ■ Re-read prevention time (in units of 100 msec) Parameter values: 0 to 255 Default value: 10 Exceptions ■...
  • Page 124 Invert Sets or acquires the enabling and disabling of the black-and-white inverted label reading function. Syntax ■ [VB] Public Shared Property Invert As Integer [C#] public static int Invert {get; set;} Property ■ Parameter values: 0: disabled, 1: enabled Default value: 0 Exceptions ■...
  • Page 125 DecodeLevel Sets or acquires the decoding level. ■ Syntax [VB] Public Shared Property DecodeLevel As Integer [C#] public static int DecodeLevel {get; set;} ■ Property Decoding level Parameter values: 1 to 9 Default value: 4 Exceptions ■ Name of Exception Meaning ArgumentException The specified parameter value(s) is invalid.
  • Page 126 MinDigitITF Sets or acquires the minimum number of digits in ITF code. ■ Syntax [VB] Public Shared Property MinDigitITF As Integer [C#] public static int MinDigitITF {get; set;} ■ Property Minimum number of digits Parameter values: 2 to 20 Default value: 4 Exceptions ■...
  • Page 127 MinDigitSTF Sets or acquires the minimum number of digits in STF code. ■ Syntax [VB] Public Shared Property MinDigitSTF As Integer [C#] public static int MinDigitSTF {get; set;} ■ Property Minimum number of digits Parameter values: 1 to 20 Default value: 3 Exceptions ■...
  • Page 128 MinDigitNW7 Sets or acquires the minimum number of digits in NW7 code (CODABAR). ■ Syntax [VB] Public Shared Property MinDigitNW7 As Integer [C#] public static int MinDigitNW7 {get; set;} ■ Property Minimum number of digits Parameter values: 3 to 20 Default value: 4 Exceptions ■...
  • Page 129 Marker Sets or acquires the marker mode. ■ Syntax [VB] Public Shared Property Marker As EN_MARKER [C#] public static EN_MARKER Marker {get; set;} ■ Property Marker mode Parameter values: As listed in EN_MARKER Default value: EN_MARKER.NORMAL Exceptions ■ Name of Exception Meaning ArgumentException The specified parameter value(s) is invalid.
  • Page 130 Reverse Sets or acquires the front-back inverted reading enabled/disabled status. Syntax ■ [VB] Public Shared Property Reverse As Integer [C#] public static int Reverse {get; set;} Property ■ Front-back inverted reading enabled/disabled status Parameter values: 0: Disabled, 1: Enabled Default value: 0 Exceptions ■...
  • Page 131 ScanMode Sets or acquires the scan mode. ■ Syntax [VB] Public Shared Property ScanMode As EN_SCAN_MODE [C#] public static EN_SCAN_MODE ScanMode {get; set;} ■ Property Scan mode Parameter values: As listed in EN_SCAN_MODE Default value: EN_SCAN_MODE.NORMAL Exceptions ■ Name of Exception Meaning ArgumentException The specified parameter value(s) is invalid.
  • Page 132 OptionData Sets or acquires the status of the option data. ■ Syntax [VB] Public Shared Property OptionData As Integer [C#] public static int OptionData {get; set;} ■ Property Option data status Parameter values: 0: Do not append option data 1: Append option data Default value: 0 Exceptions ■...
  • Page 133 EN_MARKER Specifies the marker mode. ■ Syntax [VB] Public Enum EN_MARKER [C#] public enum EN_MARKER ■ Members Member Name Description NORMAL Normal mode AHEAD Ahead mode DISABLE Lighting is disabled Class ■ BHTCL.Scanner.Settings - 127 -...
  • Page 134 EN_SCAN_MODE Specifies the scan mode. ■ Syntax [VB] Public Enum EN_SCAN_MODE [C#] public enum EN_SCAN_MODE ■ Members Member Name Description NORMAL Normal mode POINT Point scan mode Barcode reader mode Class ■ BHTCL.Scanner.Settings - 128 -...
  • Page 135: Batterycollection

    18.4. BatteryCollection Constructor None Acquire battery information by first obtaining an instance of the battery using the "ExistingBatteries" property and then locating it in the corresponding property. Fields Field Name Description COUNT Maximum number of batteries Properties Property Name Description ExistingBatteries Instances of existing batteries Methods...
  • Page 136 COUNT Number of batteries. This value is fixed (not variable). ■ Syntax [VB] Public Const COUNT As Integer [C#] public const int COUNT; [Ex.] Acquire the maximum number of batteries that can be inserted in the BHT-400. [VB] Count = BatteryCollection.COUNT [C#] Count = BatteryCollection.COUNT;...
  • Page 137 ExistingBatteries Acquires instances of existing batteries. ■ Syntax [VB] Public Shared ReadOnly Property ExistingBatteries As Battery() [C#] public static Battery[] ExistingBatteries {get;} ■ Property Battery instances arrangement Exceptions ■ None Note ■ Even if there is no battery in either the grip or BHT body, an arrangement with two elements is created.
  • Page 138: Batterycollection.battery

    18.5. BatteryCollection.Battery Constructor Constructor Name Description Battery Creates a new instance of the Battery class. Fields None Properties Property Name Description Battery ID OnCU CU installation status Voltage Battery voltage Level Battery voltage level Chemistry Battery type Methods None Events None Enumeration Enumeration Name...
  • Page 139 Battery Initializes a new instance of the Battery class. ■ Syntax [VB] Public Sub New(ByVal BatteryID As Integer) [C#] public Battery(int BatteryID) ■ Parameters BatteryID: Battery ID Parameter values: 0: Battery in BHT body, 1: Battery in grip Exceptions ■ None - 133 -...
  • Page 140 Acquires the battery ID. ■ Syntax [VB] Public ReadOnly Property As Integer [C#] public int {get;} ■ Property Parameter values: 0: Battery in BHT body, 1: Battery in grip Exceptions ■ None - 134 -...
  • Page 141 OnCU Acquires the CU installation status for the BHT. ■ Syntax [VB] Public ReadOnly Property OnCU As EN_CHARGE [C#] public EN_CHARGE OnCU {get;} ■ Property CU installation status Default value: Installation status at the time of initialization Exceptions ■ None Note ■...
  • Page 142 Voltage Acquires the battery voltage. ■ Syntax [VB] Public ReadOnly Property Voltage As Integer [C#] public int Voltage {get;} ■ Property Battery voltage (mV) Default value: Battery voltage at the time of initialization Exceptions ■ None Note ■ If the BHT has a battery in the grip only, the battery voltage for the BHT body will be 0 (mV). Similarly, if there is a battery in the BHT body only, the battery voltage for the grip will be 0 (mV).
  • Page 143 Level Acquires the battery voltage level. ■ Syntax [VB] Public ReadOnly Property Level As EN_LEVEL [C#] public EN_LEVEL Level {get;} ■ Property Battery voltage level Default value: Battery voltage level at the time of initialization Exceptions ■ None Note ■ If the BHT has a battery in the grip only, the battery voltage level for the BHT body will be EN_LEVEL.NO_BATTERY.
  • Page 144 Chemistry Acquires the battery type. ■ Syntax [VB] Public ReadOnly Property Chemistry As EN_CHEMISTRY [C#] public EN_CHEMISTRY Chemistry {get;} ■ Property Battery type Default value: Type of battery installed Exceptions ■ None Note ■ If the BHT has a battery in the grip only, the battery type for the BHT body will be EN_CHEMISTRY.UNKNOWN.
  • Page 145 EN_CHARGE Specifies whether the battery is charged or not. ■ Syntax [VB] Public Enum EN_CHARGE [C#] public enum EN_CHARGE ■ Members Member Name Description OFFLINE Not charged ONLINE Charged UNKNOWN Charge status unknown Class ■ Within BHTCL.BatteryCollection.Battery class - 139 -...
  • Page 146 EN_LEVEL Specifies the battery voltage level. ■ Syntax [VB] Public Enum EN_LEVEL [C#] public enum EN_LEVEL ■ Members Member Name Description HIGH 3.9 V or above 3.7 V or above but less than 3.9 V 3.6 V or above but less than 3.7 V WARNING Less than 3.6 V CRITICAL...
  • Page 147 EN_CHEMISTRY Specifies the battery type. ■ Syntax [VB] Public Enum EN_CHEMISTRY [C#] public enum EN_CHEMISTRY ■ Members Member Name Description ALKALINE Alkaline battery NICD Nickel-Cadmium battery NIMH Nickel Metal Hydride battery LION Lithium Ion battery LIPOLY Lithium Polymer battery UNKNOWN Unknown, missing Class ■...
  • Page 148: Backlight

    18.6. Backlight Constructor Constructor Name Description Backlight Creates a new instance of the Backlight class. Fields None Properties Property Name Description Status Backlight is lit. Methods None Events None Enumeration Enumeration Name Description EN_STATUS Backlight is lit. - 142 -...
  • Page 149 Backlight Initializes a new instance of the Backlight class. ■ Syntax [VB] Public Sub New() [C#] public Backlight() ■ Parameters None Exceptions ■ None [Ex.] Create a MyBacklight Backlight instance. [VB] Dim MyBacklight As Backlight = New Backlight [C#] Backlight MyBacklight = new Backlight(); - 143 -...
  • Page 150 Status Sets or acquires the backlight status (whether the backlight is lit). ■ Syntax [VB] Public Shared Property Status As EN_STATUS [C#] public static EN_STATUS Status {get; set;} ■ Property Backlight status (whether the backlight is lit) Parameter values: As listed in EN_STATUS Default value: Backlight status at the time of initialization Exceptions ■...
  • Page 151 EN_STATUS Specifies the backlight status (whether the backlight is lit). ■ Syntax [VB] Public Enum EN_STATUS [C#] public enum EN_STATUS ■ Members Member Name Description ENABLE_ON ENABLE_OFF DISABLE_OFF Disabled Class ■ Within BHTCL.Backlight class - 145 -...
  • Page 152: Backlight.settings

    18.7. Backlight.Settings Constructor None Instances cannot be created directly from this class. Fields None Properties Property Name Description OnTimeBattery "ON" time (when powered by battery) OnTimeAC " ON " time (when installed on CU) CtrlKey Control key Brightness Brightness level PowerSave Brightness when OFF Methods...
  • Page 153 OnTimeBattery Sets or acquires the ON time when the backlight is powered by the battery. ■ Syntax [VB] Public Shared Property OnTimeBattery As Integer [C#] public static int OnTimeBattery {get; set;} ■ Property ON time (in units of 1 sec) Parameter values: 0 to 255 Default value: 3 Exceptions...
  • Page 154 OnTimeAC Sets or acquires the backlight ON time when installed on the CU. ■ Syntax [VB] Public Shared Property OnTimeAC As Integer [C#] public static int OnTimeAC {get; set;} ■ Property ON time (in units of 1 sec) Parameter values: 0 to 255 Default value: 60 Exceptions ■...
  • Page 155 CtrlKey Sets or acquires the control key for turning ON and OFF the backlight. ■ Syntax [VB] Public Shared Property CtrlKey As Integer [C#] public static int CtrlKey {get; set;} ■ Property Backlight ON/OFF control key Parameter values: See table below. Default value: 0x00010204([SF] + [M4]) Exceptions ■...
  • Page 156 Backlight Control Key Setting Backlight Control Key Setting 0x00000201 [SF] + [.] (Period) 0x0001000A 0x00000202 [SF] + [BS] (BackSpace) 0x0001000B 0x00000243 [SF] + [C] (Clear) 0x0001000C [F1] 0x00000101 [F2] 0x00000102 [F3] 0x00000103 [F4] 0x00000104 [F5] 0x00000105 [F6] 0x00000106 [F7] 0x00000107 [F8] 0x00000108 [F9]...
  • Page 157 Brightness Sets or acquires the backlight brightness level. ■ Syntax [VB] Public Shared Property Brightness As Integer [C#] public static int Brightness {get; set;} ■ Property Brightness level Parameter values: 0 (OFF), 1 (dark) to 3 (bright) Default value: 3 Exceptions ■...
  • Page 158 PowerSave Sets or acquires the backlight brightness when OFF. ■ Syntax [VB] Public Shared Property PowerSave As Integer [C#] public static int PowerSave {get; set;} ■ Property Brightness when OFF Parameter values: 0 (OFF), 1 (Dimly) Default value: 0 Exceptions ■...
  • Page 159: Led

    18.8. LED Constructor Constructor Name Description Creates a new instance of the LED class. Fields Field Name Description Usage Restrictions on LED usage (invalid on BHT-400) Properties Property Name Description Item LED ON/OFF status Methods None Events None Enumeration Enumeration Name Description EN_DEVICE LED device...
  • Page 160 Initializes a new instance of the LED class. ■ Syntax [VB] Public Sub New( ) [C#] public LED( ) ■ Parameters None Exceptions ■ None [Ex.] Create a MyLED LED instance. [VB] Dim MyLED As LED = New LED [C#] LED MyLED = new LED(); - 154 -...
  • Page 161 Item Sets or aquires the LED status (ON/OFF) specified by the index. In C#, this property is used as the indexer for the LED class. Syntax ■ [VB] Public Property Item(ByVal device As LED.EN_DEVICE, _ ByVal color As LED.EN_COLOR) As LED.EN_CTRL [C#] public LED.EN_CTRL this[LED.EN_DEVICE device][LED.EN_COLOR color] {get;...
  • Page 162 ■ Note When an indicator LED (=BAR) is specified as "device," selection of the color yellow (=YELLOW) is ignored. In general, indicator LEDs cannot be controlled from the application while barcode reading is enabled. However, if prohibition of operation for a particular indicator LED is specified, it can be controlled from the application.
  • Page 163 EN_DEVICE Specifies the LED device. ■ Syntax [VB] Public Enum EN_DEVICE [C#] public enum EN_DEVICE ■ Members Member Name Description Indicator LED Wireless LED (disabled on BHT-400) Class ■ Within BHTCL.LED class - 157 -...
  • Page 164 EN_COLOR Specifies the LED color. ■ Syntax [VB] Public Enum EN_COLOR [C#] public enum EN_COLOR ■ Members Member Name Description BLUE Blue(=GREEN) GREEN Green YELLOW Yellow (disabled on BHT-400) ■ Class Within BHTCL.LED class - 158 -...
  • Page 165 EN_CTRL Specifies the LED ON/OFF status. ■ Syntax [VB] Public Enum EN_CTRL [C#] public enum EN_CTRL ■ Members Member Name Description LED OFF LED ON Class ■ Within BHTCL.LED class - 159 -...
  • Page 166: Led.usagecollection

    18.9. LED.UsageCollection This class is invalid on the BHT400. - 160 -...
  • Page 167: Beep

    18.10. Beep Constructor Constructor Name Description Beep Creates a new instance of the Beep class. Fields None Properties Property Name Description Item Beep control OnTime ON duration OffTime OFF duration Frequency Beep frequency Count Number of beeps Methods None Events None Enumeration Enumeration Name...
  • Page 168 Beep Initializes a new instance of the Beep class. ■ Syntax [VB] Public Sub New( ) [C#] public Beep( ) ■ Parameters None Exceptions ■ None [Ex.] Create a MyBeep beeper/vibrator instance. [VB] Dim MyBeep As LED = New Beep [C#] LED MyBeep = new Beep();...
  • Page 169 Item Starts or stops the beeping or vibrating of the device specified by the index. In C#, this property is used as the indexer for the Beep class. Syntax ■ [VB] Public WriteOnly Property Item(ByVal device As Beep.EN_DEVICE) _ As Beep.EN_CTRL [C#] public Beep.EN_CTRL this[Beep.EN_DEVICE device]{set;} Parameters...
  • Page 170 OnTime Sets or acquires the ON/OFF duration of the beeper or vibrator. ■ Syntax [VB] Public Property OnTime As Integer [C#] public int OnTime{get; set;} ■ Property ON duration of the beeper or vibrator (in units of 100 msec) Parameter values: 0 to 255 Default value: 5 Exceptions ■...
  • Page 171 OffTime Sets or acquires the OFF duration of the beeper or vibrator. ■ Syntax [VB] Public Property OffTime As Integer [C#] public int OffTime{get; set;} ■ Property OFF duration of the beeper or vibrator (in units of 100 msec) Parameter values: 0 to 255 Default value: 5 Exceptions ■...
  • Page 172 Frequency Sets or acquires the beeping frequency of the beeper. ■ Syntax [VB] Public Property Frequency As Integer [C#] public int Frequency {get; set;} ■ Property Beeping frequency of the beeper (Hz) Parameter values: 0 (698 Hz), 1 (1396 Hz), 2 (2793 Hz), and 39 to 32767 (inclusive) Default value: 2 Exceptions ■...
  • Page 173 Count Sets or acquires the number of beeps or vibrations of the beeper or vibrator. ■ Syntax [VB] Public Property Count As Integer [C#] public int Count {get; set;} ■ Property Number of beeps or vibrations of the beeper or vibrator Parameter values: 0 to 255.
  • Page 174 EN_CTRL Starts or stops the beeping or vibration. ■ Syntax [VB] Public Enum EN_CTRL [C#] public enum EN_CTRL ■ Members Member Name Description Stop the beeping or vibration. Start the beeping or vibration. Class ■ Within BHTCL.BEEP class - 168 -...
  • Page 175: Beep.settings

    18.11. Beep.Settings Constructor None Instances cannot be created directly from this class. Fields None Properties Property Name Description Device Beeper or vibrator Volume Beeper volume VolumeKey Key click sound volume VolumeTap Tap sound volume VolumeHalfKey Half-pressed key click sound volume OnOffLaserKey Trigger switch ON/OFF sound OnOffTrgKey...
  • Page 176 Device Sets or acquires the beeper or vibrator. ■ Syntax [VB] Public Shared Property Device As EN_DEVICE [C#] public static EN_DEVICE Device {get; set;} ■ Property Beeper or vibrator Parameter values: As listed in EN_DEVICE (one of the values or a combination of the values) Default value: EN_DEVICE.BEEP Exceptions...
  • Page 177 Volume Sets or acquires the beeper volume. ■ Syntax [VB] Public Shared Property Volume As EN_VOLUME [C#] public static EN_VOLUME Volume {get; set;} ■ Property Beeper volume Parameter values: As listed in EN_VOLUME Default value: EN_VOLUME.LEVEL5 Exceptions ■ Name of Exception Meaning ArgumentException The specified parameter value(s) is invalid.
  • Page 178 VolumeKey Sets or acquires the volume of a key click. Syntax ■ [VB] Public Shared Property VolumeKey As EN_VOLUME [C#] public static EN_VOLUME VolumeKey {get; set;} Property ■ Sound volume Parameter values: EN_VOLUME values LEVEL_OFF to LEVEL2 Default value: EN_VOLUME.LEVEL2 Exceptions ■...
  • Page 179 VolumeTap Sets or acquires the sound volume of the screen taps. ■ Syntax [VB] Public Shared Property VolumeTap As EN_VOLUME [C#] public static EN_VOLUME VolumeTap {get; set;} ■ Property Sound volume Parameter values: EN_VOLUME values LEVEL_OFF to LEVEL2 Default value: EN_VOLUME.LEVEL2 Exceptions ■...
  • Page 180 VolumeHalfKey Sets or acquires the sound volume of a half-pressed key click. ■ Syntax [VB] Public Shared Property VolumeHalfKey As EN_VOLUME [C#] public static EN_VOLUME VolumeHalfKey {get; set;} ■ Property Sound volume Parameter values: EN_VOLUME values LEVEL_OFF to LEVEL2 Default value: EN_VOLUME.LEVEL_OFF Exceptions ■...
  • Page 181 OnOffLaserKey Sets or acquires the ON/OFF for the sound of the clicking of the laser marker key. Syntax ■ [VB] Public Shared Property OnOffLaserKey As EN_ON_OFF [C#] public static EN_VOLUME OnOffLaserKey {get; set;} Property ■ Clicking sound ON/OFF Parameter values: As listed in EN_ON_OFF Default value: EN_ON_OFF.OFF Exceptions ■...
  • Page 182 OnOffTrgKey Sets or acquires the ON/OFF for the sound of the clicking of the trigger switch. ■ Syntax [VB] Public Shared Property OnOffTrgKey As EN_ON_OFF [C#] public static EN_VOLUME OnOffTrgKey {get; set;} ■ Property Clicking sound ON/OFF Parameter values: As listed in EN_ON_OFF Default value: EN_ON_OFF.OFF Exceptions ■...
  • Page 183 EN_DEVICE Specifies the beeper or vibrator. ■ Syntax [VB] Public [Flags] Enum EN_DEVICE [C#] public [Flags] enum EN_DEVICE ■ Members Member Name Description BEEP Beeper Vibrator Class ■ Within BHTCL.Beep.Settings class - 177 -...
  • Page 184 EN_VOLUME Specifies the beeper volume level. ■ Syntax [VB] Public Enum EN_VOLUME [C#] public enum EN_VOLUME ■ Members Member Name Description LEVEL_OFF LEVEL1 LEVEL2 LEVEL3 LEVEL4 LEVEL5 High Class ■ BHTCL.Beep.Settings - 178 -...
  • Page 185 EN_ON_OFF Specifies the ON/OFF for the clicking sound. ■ Syntax [VB] Public Enum EN_ON_OFF [C#] public enum EN_ON_OFF ■ Members Member Name Description Class ■ BHTCL.Beep.Settings - 179 -...
  • Page 186 18.12. RF Constructor Constructor Name Description Creates a new instance of the RF class. Fields None Properties Property Name Description OpenMode Wireless communication open mode Open Wireless communication open state WepKey Wep key Methods Method Name Description Synchronize Checks the status of synchronization with AP. Events None Enumeration...
  • Page 187 Initializes a new instance of the RF class. ■ Syntax [VB] Public Sub New( ) [C#] public RF( ) ■ Parameters None Exceptions ■ None [Ex.] Create a MyRf RF interface. [VB] Dim MyRf As RF = New RF [C#] RF MyRf = new RF(); - 181 -...
  • Page 188 OpenMode Sets or acquires the wireless open mode. Syntax ■ [VB] Public Property OpenMode As EN_OPEN_MODE [C#] public EN_OPEN_MODE OpenMode{get; set;} Property ■ Wireless communication open mode Parameter values: As listed in EN_OPEN_MODE Default value: EN_OPEN_MODE.NORMAL Exceptions ■ None ■ Note If an invalid value is specified for this property, no exceptions will be thrown immediately;...
  • Page 189 When the property is set to EN_OPENMODE.CONTINUOUSLY and the wireless device is opened: When closing the wireless device, set the property to EN_OPEN_MODE.CONTINUOUSLY and then close the device. The wireless device is not closed even when exiting the application. The wireless device is closed when the EN_OPEN_MODE.CONTINUOUSLY property is specified at another application and the wireless device is closed.
  • Page 190 [Ex.] Close the wireless connection opened from any application (including the current application). [VB] MyRf.Open = True ……… MyRf.OpenMode = RF.EN_OPEN_MODE.CONTINUOUSLY MyRf.Open = False [C#] MyRf.Open = true; ……… MyRf.OpenMode = RF.EN_OPEN_MODE.CONTINUOUSLY; MyRf.Open = false; - 184 -...
  • Page 191 Open Opens or closes wireless communication. ■ Syntax [VB] Public Property Open As Boolean [C#] public bool Open{get; set;} ■ Property Wireless communication open (= True), close (= False) If wireless communication is achieved by setting OpenMode to EN_OPEN_MODE.NORMAL, the status achieved by setting OpenMode to EN_OPEN_MODE.NORMAL will be returned.
  • Page 192 WepKey Generates an instance of the WepKeyCollection. ■ Syntax [VB] Public Shared ReadOnly Property WepKey As WepKeyCollection [C#] public static WepKeyCollection WepKey{get;} ■ Property WepKey instance Default value: null (Nothing at VB.NET) Exceptions ■ None Note ■ An instance cannot be generated directly from WepKeyCollection and therefore WepKey should be obtained with this property.
  • Page 193 Synchronize Checks the status of synchronization with AP. ■ Syntax [VB] Public Shared Function Synchronize(ByVal TimeOut As Integer) _ As Integer [C#] public static int Synchronize(int TimeOut) Parameters ■ TimeOut [in] time-out value until synchronization is established. If RF.SYNC_CHECK is specified, the synchronization status is immediately checked and a result returned.
  • Page 194 [Ex.] Check the synchronization with the AP every second until synchronization is established. [VB] While Not 0 = RF.Synchronize(RF.SYNC_CHECK) Threading.Thread.Sleep(1000) End While [C#] while (0 != RF.Synchronize(RF.SYNC_CHECK)) System.Threading.Thread.Sleep(1000); - 188 -...
  • Page 195 EN_OPEN_MODE Specifies the wireless connection open mode. Syntax ■ [VB] Public Enum EN_OPEN_MODE [C#] public enum EN_OPEN_MODE Members ■ Member Name Description NORMAL Normal mode (*1) CONTINUOUSLY Continuously open mode (*1) (*1) Please refer to the notes for the OpenMode property for further details. - 189 -...
  • Page 196: Rf.profile

    18.13. RF.Profile Constructor Constructor Name Description Profile Specifies ESSID and infrastructure mode, and generates a profile instance. Fields None Properties Property Name Description SSID ESSID InfraMode Infrastructure mode Priority Priority Authentication Authentication method Encryption Encryption method EAP8021x EAP type WepKey WEP key PreSharedKey PreSharedKey...
  • Page 197 Enumeration Enumeration Name Description EN_AUTHENTICATION Authentication method EN_EAP8021X EAP type EN_ENCRYPTION Encryption method EN_INFRA_MODE Infrastructure - 191 -...
  • Page 198 Profile Specifies ESSID and infrastructure mode, and initializes a new instance. ■ Syntax [VB] Public Sub New(ByVal SSID As Integer, _ ByVal infra As EN_INFRA_MODE) [C#] public Profile(string SSID, EN_INFRA_MODE infra) Parameters ■ SSID: ESSID Parameter values: Alphanumeric character string of 32 characters or less infra: Infrastructure mode Parameter values: As listed in EN_INFRA_MODE Exceptions...
  • Page 199 SSID Acquires the profile ESSID. ■ Syntax [VB] Public ReadOnly Property SSID As String [C#] public string SSID {get;} ■ Property ESSID Exceptions ■ - 193 -...
  • Page 200 InfraMode Acquires the profile infrastructure. ■ Syntax [VB] Public ReadOnly Property InfraMode As EN_INFRA_MODE [C#] public EN_INFRA_MODE InfraMode {get;} ■ Property Infrastructure mode Exceptions ■ None - 194 -...
  • Page 201 Priority Sets or acquires the profile priority. ■ Syntax [VB] Public Property Priority As Integer [C#] public int Priority {get; set;} ■ Property Profile priority Parameter values: 1 (high) to 16 (low) Default value: 1 Exceptions ■ Name of Exception Meaning ArgumentException The specified parameter value(s) lies outside the permissible...
  • Page 202 Authentication Sets or acquires the profile authentication method. ■ Syntax [VB] Public Property Authentication As EN_AUTHENTICATION [C#] public EN_AUTHENTICATION Authentication {get; set;} ■ Property Profile authentication method Parameter values: As listed in EN_AUTHENTICATION Default value: EN_AUTHENTICATION.OPEN Exceptions ■ Name of Exception Meaning ArgumentException The specified parameter value(s) lies outside the permissible...
  • Page 203 Encryption Sets or acquires the profile encryption method. ■ Syntax [VB] Public Property Encryption As EN_ENCRYPTION [C#] public EN_ENCRYPTION Encryption {get; set;} ■ Property Profile encryption method Parameter values: As listed in EN_ENCRYPTION Default value: EN_ENCRYPTION.DISABLE Exceptions ■ Name of Exception Meaning ArgumentException The specified parameter value(s) lies outside the permissible...
  • Page 204 EAP8021x Sets or acquires the profile EAP (802.1x) type. ■ Syntax [VB] Public Property EAP8021x As EN_EAP8021X [C#] public EN_EAP8021X EAP8021x {get; set;} ■ Property Profile EAP type Parameter values: As listed in EN_EAP8021X Default value: EN_EAP8021X.DISABLE Exceptions ■ Name of Exception Meaning ArgumentException The specified parameter value(s) lies outside the permissible...
  • Page 205 WepKey Sets the profile WepKey. ■ Syntax [VB] Public WriteOnly Property WepKey As String [C#] public string WepKey {set;} ■ Property Profile WEP key. Parameter values: 10-character alphanumeric character string (40-bit) 26-character alphanumeric character string (128-bit) Exceptions ■ Name of Exception Meaning ArgumentException The specified parameter value(s) lies outside the permissible...
  • Page 206 PreSharedKey Specifies the profile PreSharedKey. Syntax ■ [VB] Public WriteOnly Property PreSharedKey As String [C#] public string PreSharedKey {set;} Property ■ Profile PreSharedKey Parameter values: 64-characters alphanumeric character string in hexadecimal notation, or ASCII character string with 8 characters or more and 63 characters or less Exceptions ■...
  • Page 207 Count Acquires the number of registered profiles. ■ Syntax [VB] Public Shared ReadOnly Property Count As Integer [C#] public static int Count {get;} ■ Property Registered profile count Exceptions ■ None - 201 -...
  • Page 208 Registered Acquires all registered profiles. ■ Syntax [VB] Public Shared ReadOnly Property Registered As RF.Profile[] [C#] public static RF.Profile[] Registered {get;} ■ Property All registered profile instances. Exceptions ■ Note ■ It is necessary to call the RF.Profile.Update method and copy the Zero Config GUI settings to the BHT wireless registry prior to acquiring all registered profiles.
  • Page 209 Update Copies the value set at the Zero Config GUI to the BHT wireless registry referenced by the wireless driver. Syntax ■ [VB] Public Shared Sub Update() [C#] public static void Update() Parameters ■ None Exceptions ■ None Note ■ Call this method first if the value set at the Zero Config GUI is acquired from the class library.
  • Page 210 Commit Reflects the value set from application to the Zero Config GUI. ■ Syntax [VB] Public Shared Sub Commit() [C#] public static void Commit() ■ Parameters None Exceptions ■ None Note ■ Call this method prior to opening the wireless device if the value set from the library is used and a connection is established with the network.
  • Page 211 Remove Deletes registered profiles. ■ Syntax [VB] Public Shared Sub Remove(ByVal ssid As String, ByVal infra As EN_INFRA_MODE) [C#] public static void Remove(string ssid, EN_INFRA_MODE infra) Parameters ■ ssid: Deleted profile ESSID infra: Deleted profile infrastructure mode Exceptions ■ [Ex.] Delete a profile (ESSID:BHT, infra: infrastructure). [VB] RF.Profile.Remove("BHT", EN_INFRA_MODE.INFRASTRUCTURE) [C#] RF.Profile.Remove("BHT", EN_INFRA_MODE.INFRASTRUCTURE);...
  • Page 212 EN_AUTHENTICATION Specifies the authentication method. ■ Syntax [VB] Public Enum EN_AUTHENTICATION [C#] public enum EN_AUTHENTICATION ■ Members Member Name Description OPEN Open SHARED Shared WPAPSK WPA-PSK - 206 -...
  • Page 213 EN_EAP8021X Specifies the EAP type. ■ Syntax [VB] Public Enum EN_EAP8021X [C#] public enum EN_EAP8021X ■ Members Member Name Description DISABLE Disable MD5CHALLENGE MD5-Challenge PEAP PEAP - 207 -...
  • Page 214 EN_ENCRYPTION Specifies the encryption method. ■ Syntax [VB] Public Enum EN_ENCRYPTION [C#] public enum EN_ENCRYPTION ■ Members Member Name Description DISABLE Disable AES (Not Supported) TKIP Tkip - 208 -...
  • Page 215 EN_INFRA_MODE Specifies infrastructure. ■ Syntax [VB] Public Enum EN_INFRA_MODE [C#] public enum EN_INFRA_MODE ■ Members Member Name Description INFRASTRUCTURE Infrastructure ADHOC ad hoc - 209 -...
  • Page 216: Rf.settings

    18.14. RF.Settings Constructor None Instances cannot be created directly from this class. Fields None Properties Property Name Description PowerSave Power save mode Authentication Authentication method DestMACAddress Destination’s MAC address Version Driver version FWVersion Firmware version HWVersion Hardware version MACAddress MAC address SSID1 ESSID1 Methods...
  • Page 217 PowerSave Sets or acquires power save mode. ■ Syntax [VB] Public Shared Property PowerSave As EN_POWERSAVE [C#] public static EN_POWERSAVE PowerSave {get; set;} ■ Property Power save mode Parameter values: As listed in EN_POWERSAVE Default value: EN_POWERSAVE.CAM Exceptions ■ Name of Exception Meaning ArgumentException The specified parameter value(s) is invalid.
  • Page 218 Authentication Sets or acquires the authentication method. ■ Syntax [VB] Public Shared Property Authentication As EN_AUTHENTICATION [C#] public static EN_AUTHENTICATION Authentication {get; set;} ■ Property Authentication method Parameter values: As listed in EN_AUTHENTICATION Exceptions ■ Name of Exception Meaning ArgumentException The specified parameter value(s) is invalid.
  • Page 219 DestMACAddress Sets or acquires the MAC address of the destination AP. ■ Syntax [VB] Public Shared Property DestMACAddress As String [C#] public static string DestMACAddress {get; set;} ■ Property MAC address of AP Default value: null Exceptions ■ Name of Exception Meaning ArgumentException The specified parameter value(s) is invalid.
  • Page 220 Version Acquires the driver version. ■ Syntax [VB] Public Shared ReadOnly Property Version As String [C#] public static string Version {get;} ■ Property Driver version Default value: null Exceptions ■ Name of Exception Meaning DeviceLoadException The NIC device is not ready. [Ex.] Acquire the wireless driver version.
  • Page 221 FWVersion Acquires the firmware version. ■ Syntax [VB] Public Shared ReadOnly Property FWVersion As String [C#] public static string FWVersion {get;} ■ Property Firmware version Default value: null Exceptions ■ Name of Exception Meaning DeviceLoadException The NIC device is not ready. [Ex.] Acquire the wireless F/W version.
  • Page 222 HWVersion Acquires the hardware version. ■ Syntax [VB] Public Shared ReadOnly Property HWVersion As String [C#] public static string HWVersion {get;} ■ Property Hardware version Default value: null Exceptions ■ Name of Exception Meaning DeviceLoadException The NIC device is not ready. [Ex.] Acquire the wireless H/W version.
  • Page 223 MACAddress Acquires the MAC address. ■ Syntax [VB] Public Shared ReadOnly Property MACAddress As String [C#] public static string MACAddress {get;} ■ Property MAC address Default value: null Exceptions ■ Name of Exception Meaning DeviceLoadException The NIC device is not ready. [Ex.] Acquire the MAC address.
  • Page 224 SSID1 Sets or acquires the ESSID. ■ Syntax [VB] Public Shared Property SSID1 As String [C#] public static string SSID1 {get; set;} ■ Property ESSID Default value: "101" Exceptions ■ Name of Exception Meaning ArgumentException The specified parameter value(s) is invalid. Note ■...
  • Page 225 EN_AUTHENTICATION Specifies the authentication method. ■ Syntax [VB] Public Enum EN_AUTHENTICATION [C#] public enum EN_AUTHENTICATION ■ Members Member Name Description OPEN Open Class ■ BHTCL.RF.Settings - 219 -...
  • Page 226 EN_POWERSAVE Specifies power save mode. ■ Syntax [VB] Public Enum EN_POWERSAVE [C#] public enum EN_POWERSAVE ■ Members Member Name Description Continuously Access Mode Max. power consumption Power Save Polling Min. power consumption FULL = CAM MOST = PSP MORE = PSP = PSP LESS = PSP...
  • Page 227: Rf.wepkeycollection

    18.15. RF.WepKeyCollection Constructor None Instances cannot be created directly form this class. Fields None Properties Property Name Description Item Wep key value TransmitKey Wep transmission key Methods None Events None Enumeration None - 221 -...
  • Page 228 Item Sets the value of the Wep key specified by the index. In C#, this property is used as the indexer for the WepKeyCollection class. Syntax ■ [VB] Public WriteOnly Property Item(ByVal KeyNo As Integer) As String [C#] public string this[int KeyNo] {set;} Parameters ■...
  • Page 229 TransmitKey Sets or acquires the Wep transmission key [to be] used. ■ Syntax [VB] Public Default Property TransmitKey As Integer [C#] public static int TransmitKey {get; set;} ■ Property Wep transmission key Default value: Wep transmission key value at the time of initialization. Exceptions ■...
  • Page 230: Rf.sitesurvey

    18.16. RF.SiteSurvey Constructor None Instances cannot be created directly from this class. Fields None Properties Property Name Description Strength Strength Beacon Beacon Link Communication quality Methods None Events None Enumeration Enumeration Name Description EN_LINE_QUALITY Communication quality - 224 -...
  • Page 231 Strength Acquires the radio field strength. Syntax ■ [VB] Public Shared ReadOnly Property Strength As Integer [C#] public static int Strength {get;} Property ■ Radio field strength (%) Default value: Radio field strength at the time of initialization. Exceptions ■ Name of Exception Meaning DeviceNotFoundException No NIC device was found.
  • Page 232 Beacon Acquires the beacon quality. ■ Syntax [VB] Public Shared ReadOnly Property Beacon As Integer [C#] public static int Beacon {get;} ■ Property Beacon quality (%) Default value: Beacon quality at the time of initialization. Exceptions ■ Name of Exception Meaning DeviceNotFoundException No NIC device was found.
  • Page 233 Link Acquires the communication quality. ■ Syntax [VB] Public Shared ReadOnly Property Link As EN_LINE_QUALITY [C#] public static EN_LINE_QUALITY Link {get;} ■ Property Communication quality Default value: Communication quality at the time of initialization. Exceptions ■ Name of Exception Meaning DeviceNotFoundException No NIC device was found.
  • Page 234 EN_LINE_QUALITY Specifies the communication quality. ■ Syntax [VB] Public Enum EN_LINE_QUALITY [C#] public enum EN_LINE_QUALITY ■ Members Member Name Description UNSYNC Not connected (not synchronized) POOR Less than 20% FAIR 20% to 40% GOOD 40% to 75% EXCELLENT 75% or greater ■...
  • Page 235: Rf.info

    18.17. RF.Info Constructor None Instances cannot be created directly from this class. Fields None Properties Property Name Description Rate Communication speed Channel Communication channel APMAC MAC address of destination AP Methods None Events None Enumeration Enumeration Name Description EN_RATE Communication speed - 229 -...
  • Page 236 Rate Acquires the communication speed. ■ Syntax [VB] Public Shared ReadOnly Property Rate As EN_RATE [C#] public static EN_RATE Rate {get;} ■ Property Communication speed Default value: NOT_LINK Exceptions ■ Name of Exception Meaning DeviceNotFoundException No NIC device was found. DeviceLoadException The NIC device is not ready.
  • Page 237 Channel Acquires the communication channel. ■ Syntax [VB] Public Shared ReadOnly Property Channel As Integer [C#] public static int Channel {get;} ■ Property Communication channel Default value: 0 Exceptions ■ Name of Exception Meaning DeviceNotFoundException No NIC device was found. DeviceLoadException The NIC device is not ready.
  • Page 238 APMAC Acquires the MAC address of the currently linked AP. ■ Syntax [VB] Public Shared ReadOnly Property APMAC As String [C#] public static string APMAC {get;} ■ Property MAC address Default value: null Exceptions ■ Name of Exception Meaning DeviceNotFoundException No NIC device was found.
  • Page 239 EN_RATE Specifies the communication speed. ■ Syntax [VB] Public Enum EN_RATE [C#] public enum EN_RATE ■ Members Member Name Description AUTO Auto MBPS1 1 Mbps MBPS2 2 Mbps MBPS5_5 5.5 Mbps MBPS11 11 Mbps MBPS11Over 11 Mbps and over Class ■...
  • Page 240: Keys

    18.18. Keys Constructor None There is no need to create an instance because all the members are static members. Fields Field Name Description Mx, MxH (Mx:M1 to M5, Key code for MagicKey: Mx (M1 to M5), MxH (M3H to M5H) MxH:M3H to M5H) Alphabetic key SCAN...
  • Page 241 Mx, MxH (Mx:M1 to M5, MxH:M3H to M5H) Key code of the magic key and the half-pressed magic key If the [ENTER], [Shift], [TAB], [CTRL], and [Alt] key functions are assigned to these keys, the assigned key code is returned. Syntax ■...
  • Page 242 SCAN Key code for [SCAN] key ■ Syntax [VB] Public Const SCAN As Windows.Forms.Keys [C#] public const SCAN Windows.Forms.Keys SCAN; FUNC Key code for [FUNC] key Syntax ■ [VB] Public Const FUNC As System.Windows.Forms.Keys [C#] public const System.Windows.Forms.Keys FUNC; - 236 -...
  • Page 243 SEND Key code for [SEND] key Syntax ■ [VB] Public Const SEND As System.Windows.Forms.Keys [C#] public const System.Windows.Forms.Keys SEND; [Ex.] Display the pressed key. [VB] Private Form1_KeyDown(ByVal sender Object, ByVal System.Windows.Forms.KeyEventArgs) Handles MyBase.KeyDown Select Case e.KeyCode Case DNWA.BHTCL.Keys.M1 Console.WriteLine("[M1] key is down") Case DNWA.BHTCL.Keys.ALP Console.WriteLine("[ALP] key is down") Case DNWA.BHTCL.Keys.SCAN...
  • Page 244 [C#] private void Form1_KeyDown(object sender, KeyEventArgs e) switch(e.KeyCode) case DNWA.BHTCL.Keys.M1: Console.WriteLine("[M1] key is down"); break; case DNWA.BHTCL.Keys.ALP: Console.WriteLine("[ALP] key is down"); break; case DNWA.BHTCL.Keys.SCAN: Console.WriteLine("[SCAN] key is down"); break; case DNWA.BHTCL.Keys.FUNC: Console.WriteLine("[FUNC] key is down"); break; case DNWA.BHTCL.Keys.SEND: Console.WriteLine("[SEND] key is down"); break;...
  • Page 245: Keys.settings

    18.19. Keys.Settings Constructor None Instances cannot be created directly from this class. Fields None Properties Property Name Description ShiftMode [SF] key operation mode MxMode(Mx : M1 to M5, Magic key function M3H,M4H,M5H) Mx: M1 to M5 keys, MxH: M3H to M5H keys ScanMode SCAN key method InputMethod...
  • Page 246 ShiftMode Sets or acquires the operation mode for the [SF] key. ■ Syntax [VB] Public Shared Property ShiftMode As EN_SHIFT_MODE [C#] public static EN_SHIFT_MODE ShiftMode {get; set;} ■ Property Operation mode Parameter values: As listed in EN_SHIFT_MODE Default value: EN_SHIFT_MODE.NON_LOCK Exceptions ■...
  • Page 247 MxMode(Mx : M1 to M5, M3H,M4H,M5H) Sets or acquires the operation mode for the magic key, including that when the key is half-pressed. Syntax ■ [VB] Public Shared Property MxMode As EN_MX_MODE [C#] public static EN_MX_MODE MxMode {get; set;} Property ■...
  • Page 248 ScanMode Sets or acquires the operation mode for the [SCAN] key. ■ Syntax [VB] Public Shared Property ScanMode As EN_MX_MODE [C#] public static EN_MX_MODE ScanMode {get; set;} ■ Property Operation mode Parameter values: As listed in EN_MX_MODE with the exception of EN_MX.MODE.IM Default value: EN_MX_MODE.TRG Exceptions ■...
  • Page 249 InputMethod Sets or acquires the input method. ■ Syntax [VB] Public Shared Property InputMethod As EN_INPUT_METHOD [C#] public static EN_INPUT_METHOD InputMethod {get; set;} ■ Property Input method Parameter values: As listed in EN_INPUT_METHOD (one of the values or a combination of the values) Default value: EN_ INPUT_METHOD.NUMERIC Exceptions...
  • Page 250 FuncMode Sets or acquires function mode. Syntax ■ [VB] Public Shared Property FuncMode As EN_FUNC_MODE [C#] public static EN_FUNC_MODE FuncMode {get; set;} Property ■ Input method Parameter values: As listed in EN_FUNC_MODE (one of the values or a combination of the values) Default value: EN_FUNC_MODE.NON_FUNCTION Exceptions...
  • Page 251 PwrDownTime Sets or acquires the length of time the PWR key is pressed down until the power turns OFF. ■ Syntax [VB] Public Shared Property PwrDownTime As Integer [C#] public static int PwrDownTime {get; set;} ■ Property Length of time key pressed down (in units of 100msec) Parameter values: 1 to 255 Default value: 5 Exceptions...
  • Page 252 AllowChangeIM Sets or acquires the enabling/disabling of the transition to the alphabet entry mode. ■ Syntax [VB] Public Shared Property AllowChangeIM As EN_CHANGE_IM [C#] public static EN_CHANGE_IM AllowChangeIM {get; set;} ■ Property Enable/disable Parameter values: As listed in EN_CHANGE_IM Default value: EN_CHANGE_IM.ENABLE Exceptions ■...
  • Page 253 KeyboardType Acquires the keyboard type. ■ Syntax [VB] Public Shared ReadOnly Property KeyboardType As EN_KEYBOARD_TYPE [C#] public static EN_KEYBOARD_TYPE KeyboardType {get;} Property ■ Keyboard type Exceptions ■ None [Ex.] Check the key type. [VB] If DNWA.BHTCL.Keys.Settings.KeyboardType = _ Keys.Settings.EN_KEYBOARD_TYPE.TYPE1 Then Console.WriteLine("31 keys") Else Console.WriteLine("50 keys")
  • Page 254 HandleStatus Acquires the grip handle status (connected/not connected). ■ Syntax [VB] Public Shared ReadOnly Property HandleStatus As EN_HANDLE_STATUS [C#] public static EN_HANDLE_STATUS HandleStatus {get;} Property ■ Grip handle status Exceptions ■ None [Ex.] Check the grip handle connection status [VB] If DNWA.BHTCL.Keys.Settings.HandleStatus = _ Keys.Settings.EN_HANDLE_STATUS.LOADED Then Console.WriteLine("Grip handle is loaded.")
  • Page 255 EN_SHIFT_MODE Specifies the operation mode for the Shift (SF) key. ■ Syntax [VB] Public Enum EN_SHIFT_MODE [C#] public enum EN_SHIFT_MODE ■ Members Member Name Description NON_LOCK Normal ONE_LOCK Onetime lock mode Class ■ BHTCL.Keys.Settings - 249 -...
  • Page 256 EN_MX_MODE Specifies the key function. ■ Syntax [VB] Public Enum EN_MX_MODE [C#] public enum EN_MX_MODE ■ Members Member Name Description NONE None ENTER Enter key Trigger key SHIFT Shift key BACKLIGHT Backlight control key Tab key Input method switching key LASER Laser ON/OFF key CTRL...
  • Page 257 EN_INPUT_METHOD Specifies the input method. ■ Syntax [VB] Public Enum EN_INPUT_METHOD [C#] public enum EN_INPUT_METHOD ■ Members Member Name Description NUMERIC Numeric entry mode ALPHABET Alphabet entry mode Class ■ BHTCL.Keys.Settings - 251 -...
  • Page 258 EN_FUNC_MODE Specifies function mode/non-function mode. Syntax ■ [VB] Public Enum EN_ FUNC_METHOD [C#] public enum EN_FUNC_METHOD Members ■ Member Name Description FUNCTION Function mode NON_FUNCTION Non-function mode Class ■ BHTCL.Keys.Settings - 252 -...
  • Page 259 EN_CHANGE_IM Specifies whether to enable or disable input method switching. ■ Syntax [VB] Public Enum EN_CHANGE_IM [C#] public enum EN_CHANGE_IM ■ Members Member Name Description ENABLE Enable DISABLE Disable Class ■ BHTCL.Keys.Settings - 253 -...
  • Page 260 EN_KEYBOARD_TYPE Specifies the keyboard type. ■ Syntax [VB] Public Enum EN_KEYBOARD_TYPE [C#] public enum EN_KEYBOARD_TYPE ■ Members Member Name Description TYPE1 31-key TYPE2 50-key Class ■ BHTCL.Keys.Settings - 254 -...
  • Page 261: Sysinfo

    18.20. SysInfo Constructor None There is no need to create an instance because all the members are static members. Fields None Properties None Methods None Events None Enumeration None - 255 -...
  • Page 262: Sysinfo.settings

    18.21. SysInfo.Settings Constructor None Instances cannot be created directly from this class. Fields None Properties Property Name Description OSVersion System version MachineName Machine name MachineNumber Product number SerialNumber Serial number RAMSize RAM size ROMSize ROM size Methods None Events None Enumeration None - 256 -...
  • Page 263 OSVersion Acquires the operating system (OS) version. ■ Syntax [VB] Public Shared ReadOnly Property OSVersion As String [C#] public static string OSVersion {get;} ■ Property System version (4 digits) Exceptions ■ None [Ex.] Acquire the system version. [VB] Dim OSVer As String = SysInfo.Settings.OSVersion [C#] string OSVer = SysInfo.Settings.OSVersion;...
  • Page 264 MachineName Acquires the machine name. ■ Syntax [VB] Public Shared ReadOnly Property MachineName As String [C#] public static string MachineName {get;} ■ Property Machine name Exceptions ■ None [Ex.] Acquire the machine name. [VB] Dim MachineName As String = SysInfo.Settings.MachineName [C#] string MachineName = SysInfo.Settings.MachineName;...
  • Page 265 MachineNumber Acquires the machine number. ■ Syntax [VB] Public Shared ReadOnly Property MachineNumber As String [C#] public static string MachineNumber {get;} ■ Property Machine number Exceptions ■ None [Ex.] Acquire the machine number. [VB] Dim MachineNumber As String = SysInfo.Settings.MachineNumber [C#] string MachineNumber = SysInfo.Settings.MachineNumber;...
  • Page 266 SerialNumber Sets or acquires the serial number. ■ Syntax [VB] Public Shared Property SerialNumber As String [C#] public static string SerialNumber {get;set;} ■ Property Serial number Parameter values: 6-digit character string Default value: Last 6 digits of serial number (S/N) on the back of the BHT. Exceptions ■...
  • Page 267 RAMSize Acquires the size (capacity) of the BHT RAM. ■ Syntax [VB] Public Shared ReadOnly Property RAMSize As Integer [C#] public static int RAMSize {get;} ■ Property Capacity (Byte) Exceptions ■ None [Ex.] Acquire the capacity of the BHT RAM. [VB] Dim RAMSize As Integer = SysInfo.Settings.RAMSize [C#] string RAMSize = SysInfo.Settings.RAMSize;...
  • Page 268 ROMSize Acquires the size (capacity) of the BHT ROM. ■ Syntax [VB] Public Shared ReadOnly Property ROMSize As Integer [C#] public static int ROMSize {get;} ■ Property Capacity (Byte) Exceptions ■ None [Ex.] Acquire the capacity of the BHT ROM. [VB] Dim ROMSize As Integer = SysInfo.Settings.ROMSize [C#] string ROMSize = SysInfo.Settings.ROMSize;...
  • Page 269: Pwrmng

    18.22. PwrMng Constructor None There is no need to create an instance because all the members are static members. Fields None Properties None Methods Method Name Description Shutdown Shuts down the power in such a way that the system will be started in the specified mode next time it is turned ON.
  • Page 270 Shutdown Shuts down the power in such a way that the next time the system is turned ON, it will start up in the mode specified by the parameter. Syntax ■ [VB] Public Shared Sub Shutdown (ByVal mode As EN_SHUTDOWN_MODE) [C#] public static void Shutdown(EN_SHUTDOWN_MODE mode) ■...
  • Page 271 [Ex.] Switch to suspend. [VB] PwrMng.Shutdown(PwrMng.EN_SHUTDOWN_MODE.SUSPEND) [C#] PwrMng.Shutdown(PwrMng.EN_SHUTDOWN_MODE.SUSPEND); - 265 -...
  • Page 272 EN_SHUTDOWN_MODE Specifies the operation mode to be entered at the next start-up after shutdown. ■ Syntax [VB] Public Enum EN_SHUTDOWN_MODE [C#] public enum EN_SHUTDOWN_MODE ■ Members Member Name Description WARM Warm-boot SUSPEND Suspend COLD_BOOT_REGINIT Cold-boot, with registry initialized COLD_BOOT_REGREMAIN Cold-boot, with registry saved SYSMODIFY Update OS COLD...
  • Page 273: Pwrmng.settings

    18.23. PwrMng.Settings Constructor None Instances cannot be created directly from this class. Fields None Properties Property Name Description StandbyTime Standby transition time AutoPowerOffBattery Auto-power-OFF time (battery-powered) AutoPowerOffExt Auto-power-OFF time (installed on CU) CPUClock CPU clock Methods None Events None Enumeration None - 267 -...
  • Page 274 StandbyTime Sets or Acquires the standby transition time. ■ Syntax [VB] Public Shared Property StandbyTime As Integer [C#] public static int StandbyTime {get; set;} ■ Property Transition time (in units of 100 msec) Parameter values: 0 to 255 Default value: 10 Exceptions ■...
  • Page 275 AutoPowerOffBattery Sets or acquires the automatic power-OFF time when powered by the battery. ■ Syntax [VB] Public Shared Property AutoPowerOffBattery As Integer [C#] public static int AutoPowerOffBattery {get; set;} ■ Property Auto-power-off time (in units of 1 sec) Parameter values: 0 to System.Int32.MaxValue Default value: 180 Exceptions ■...
  • Page 276 AutoPowerOffExt Sets or acquires the automatic power-OFF time when the BHT is installed on the CU. ■ Syntax [VB] Public Shared Property AutoPowerOffExt As Integer [C#] public static int AutoPowerOffExt {get; set;} ■ Property Automatic power-off time (in units of 1 sec) Parameter values: 0 to System.Int32.MaxValue Default value: 0 (The system will not be turned OFF automatically.) Exceptions...
  • Page 277 CPUClock Sets or acquires the CPU clock speed. ■ Syntax [VB] Public Shared Property CPUClock As EN_CPU_CLOCK [C#] public static EN_CPU_CLOCK CPUClock {get; set;} ■ Property CPU clock Parameter values: As listed in EN_CPU_CLOCK Default value: EN_CPU_CLOCK.NORMAL Exceptions ■ Name of Exception Meaning ArgumentException The specified parameter value(s) is invalid.
  • Page 278 EN_CPU_CLOCK Specifies the CPU clock. ■ Syntax [VB] Public Enum EN_CPU_CLOCK [C#] public enum EN_CPU_CLOCK ■ Members Member Name Description NORMAL Normal FAST Fast Class ■ BHTCL.Pwrmng.Settings - 272 -...
  • Page 279: Icon

    18.24. Icon Constructor None There is no need to create an instance because all the members are static members. Fields None Properties None Methods None Events None Enumeration None - 273 -...
  • Page 280: Icon.settings

    18.25. Icon.Settings Constructor None Instances cannot be created directly from this class. Fields None Properties Property Name Description ShiftKey Enables/disables display of the battery icon. Battery Enables/disables display of the icon indicating that the SF key is pressed down. Standby Enables/disables display of the icon indicating standby transition state.
  • Page 281 ShiftKey Sets or acquires the display status (enabled/disabled) of the icon indicating that key input is in shift mode. Syntax ■ [VB] Public Shared Property ShiftKey As EN_STATUS [C#] public static EN_STATUS ShiftKey {get; set;} Property ■ Display enabled/disabled Parameter values: As listed in EN_STATUS Default value: EN_STATUS.ENABLE Exceptions ■...
  • Page 282 Battery Sets or acquires the display status (enabled/disabled) of the icon indicating the residual charge of the battery. Syntax ■ [VB] Public Shared Property Battery As EN_STATUS [C#] public static EN_STATUS Battery {get; set;} Property ■ Display enabled/disabled Parameter values: As listed in EN_STATUS Default value: EN_STATUS.ENABLE Exceptions ■...
  • Page 283 Standby Sets or acquires the display status (enabled/disabled) of the icon indicating the standby transition state. Syntax ■ [VB] Public Shared Property Standby As EN_STATUS [C#] public static EN_STATUS Standby {get; set;} Property ■ Display enabled/disabled Parameter values: As listed in EN_STATUS Default value: EN_STATUS.ENABLE Exceptions ■...
  • Page 284 Wireless Sets or acquires the display status (enabled/disabled) of the icon indicating that the BHT is in wireless communication mode. Syntax ■ [VB] Public Shared Property Wireless As EN_STATUS [C#] public static EN_STATUS Wireless {get; set;} Property ■ Display enabled/disabled Parameter values: As listed in EN_STATUS Default value: EN_STATUS.ENABLE Exceptions...
  • Page 285 Sets or acquires the display status (enabled/disabled) of the Software Input Panel (SIP) icon. ■ Syntax [VB] Public Shared Property As EN_STATUS [C#] public static EN_STATUS {get; set;} ■ Property Display enabled/disabled Parameter values: As listed in EN_STATUS Default value: EN_STATUS.DISABLE Exceptions ■...
  • Page 286 Alphabet Sets or acquires the display status (enabled/disabled) of the icon indicating the alphabet entry mode. Syntax ■ [VB] Public Shared Property Alphabet As EN_STATUS [C#] public static EN_STATUS Alphabet {get; set;} Property ■ Display enabled/disabled Parameter values: As listed in EN_STATUS Default value: EN_STATUS.ENABLE Exceptions ■...
  • Page 287 Func Sets or acquires the display status (enabled/disabled) of the icon indicating the function mode. ■ Syntax [VB] Public Shared Property Func As EN_STATUS [C#] public static EN_STATUS Func {get; set;} ■ Property Display enabled/disabled Parameter values: As listed in EN_STATUS Default value: EN_STATUS.ENABLE Exceptions ■...
  • Page 288 EN_STATUS Enables/disables icon display. ■ Syntax [VB] Public Enum EN_STATUS [C#] public enum EN_STATUS ■ Members Member Name Description DISABLE Display is disabled. ENABLE Display is enabled. Class ■ BHTCL.Icon.Settings - 282 -...
  • Page 289: Display

    18.26. Display This function is not supported. - 283 -...
  • Page 290: Display.settings

    18.27. Display.Settings This function is not supported. - 284 -...
  • Page 291: Sysmodification

    18.28. SysModification Constructor Constructor Name Description SysModification Creates a new instance of the SysModification class. Fields None Properties Property Name Description FileName OS reconfiguration filename Mode Reboot mode after turning the power OFF Methods Method Name Description Execute Execute OS updating Events None Enumeration...
  • Page 292 SysModification Initializes a new instance of the SysModificaiton class. ■ Syntax [VB] Public Sub New( ) [C#] public SysModification( ) ■ Parameters None Exceptions ■ None [Ex.] Create the OS update instance. [VB] Dim MySysMod As SysModification = New SysModification [C#] SysModification MySysMod = new SysModification();...
  • Page 293 FileName Specifies the OS update filename. ■ Syntax [VB] Public Property FileName As String [C#] public string FileName{get; set;} ■ Property Filename Default value: "" The file name must contain the absolute path of the file. Set the path name to ”\SysModify\”. Ensure that the file extension is ”.zl”.
  • Page 294 Mode Specifies the operation mode after updating the OS. ■ Syntax [VB] Public Property Mode As EN_MODE [C#] public EN_MODE Mode{get; set;} ■ Property Operation mode Parameter values: As listed in EN_MODE Default value: EN_MODE.POWEROFF Exceptions ■ None Note ■ Even if you specify an invalid file name or a non-existent file, no exceptions will be thrown immediately.
  • Page 295 Execute Executes the OS update. ■ Syntax [VB] Public Sub Execute() [C#] public void Execute() Parameters ■ None Return value ■ None ■ Exceptions Name of Exception Meaning FileNotFoundException The file specified by FileName does not exist. ArgumentException The specified file name is invalid. The specified mode is invalid.
  • Page 296 [C#] MySysMod.FileName = @“\SysModification\BHT400New.zl”; MySysMod.Mode = SysModification.EN_MODE.POWEROFF; MySysMod.Execute(); - 290 -...
  • Page 297 EN_MODE Specifies the operation mode to be entered after updating the OS. ■ Syntax [VB] Public Enum EN_MODE [C#] public enum EN_MODE ■ Members Member Name Description POWEROFF Power OFF (The system will be cold-booted next time it is turned ON.) Class ■...
  • Page 298: Commserial

    18.29. CommSerial Constructor Constructor Name Description CommSerial Creates a new instance of the CommSerial class. Fields Field Name Description DEFAULT_PORT Default value for the COM port to be used Properties Property Name Description WaitEvent Specifies a wait event. SignaledEvent Acquires the event that has occurred. InBufferCount Size of data in the receive buffer OutBufferCount...
  • Page 299 CommSerial Initializes a new instance of the CommSerial class. ■ Syntax [VB] Public Sub New( ) [C#] public CommSerial( ) ■ Parameters None Exceptions ■ None [Ex.] Create a MyComm CommSerial instance. [VB] Dim MyComm As CommSerial = New CommSerial [C#] CommSerial MyComm = new CommSerial();...
  • Page 300 DEFAULT_PORT Default value of the port number. This value is read-only. ■ Syntax [VB] Public ReadOnly DEFAULT_PORT As Integer [C#] public readonly int DEFAULT_PORT; - 294 -...
  • Page 301 WaitEvent Sets or acquires the event to wait for. ■ Syntax [VB] Public Property WaitEvent As EN_EVENT [C#] public EN_EVENT WaitEvent {get; set;} ■ Property Event to wait for Parameter values: As listed in EN_EVENT Default value: EN_EVENT.NONE Exceptions ■ Name of Exception Meaning ObjectDisposedException...
  • Page 302 SignaledEvent Acquires the last serial communication event that occurred. ■ Syntax [VB] Public ReadOnly Property SignaledEvent As EN_EVENT [C#] public EN_EVENT SignaledEvent {get} ■ Property Event to wait for Parameter values: As listed in EN_EVENT Default value: EN_EVENT.NONE Exceptions ■ None Note ■...
  • Page 303 InBufferCount Acquires the size of meaningful data in the receive buffer (in buffer). ■ Syntax [VB] Public Property ReadOnly InBufferCount As Integer [C#] public int InBufferCount {get} ■ Property Size of meaningful data in the receive buffer (in buffer) (bytes) Exceptions ■...
  • Page 304 OutBufferCount Acquires the size of meaningful data in the send buffer (out buffer). ■ Syntax [VB] Public Property ReadOnly OutBufferCount As Integer [C#] public int OutBufferCount {get} ■ Property Size of meaningful data in the send buffer (out buffer) (bytes) Exceptions ■...
  • Page 305 PortOpen Opens/closes the COM port. ■ Syntax [VB] Public Property PortOpen As Boolean [C#] public bool PortOpen {get;set} ■ Property COM port status: Open (=True), Disabled (=False) Default value: False Exceptions ■ Name of Exception Meaning DevNotFoundException No COM port exists. ObjectDisposedException The COM port has not been opened (i.e., The COM port is closed).
  • Page 306 Port Specifies the COM port number. ■ Syntax [VB] Public Property Port As Integer [C#] public bool Port {get; set} ■ Property An integer indicating the port number Parameter value(s): 1: Connector interface, 4: IrDA Default value: 4 Exceptions ■ Name of Exception Meaning InvalidOperationException...
  • Page 307 Params Sets the following communication parameters in alphabetic characters: Baud rate, parity bit, data size, and stop bit Syntax ■ [VB] Public Property Params As String [C#] public string Params {get; set} Property ■ Character string representing the communication parameters Syntax : "BBBB,P,D,S"...
  • Page 308 Exceptions ■ Name of Exception Meaning ObjectDisposedException The COM port has not been opened yet. ArgumentException The specified parameter value(s) lies outside the permissible range. [Ex.] Specify a baud rate of 115200 bps, set the parity to none, the data length to 8 bits, and the stop bit to 1 bit.
  • Page 309 Input Reads data from the receive buffer. ■ Syntax [VB] Public Function Input(ByVal buffer() As Byte, ByVal offset As Integer, _ ByVal len As Integer) As Integer [C#] public int Input(byte[] buffer, int offset, int len) Parameters ■ buffer [out] Destination buffer offset [in] Offset from the beginning of the destination buffer indicating the start point of the read data...
  • Page 310 [Ex.] Read out all data remaining in the receive buffer. [VB] While MyComm.InBufferCount > 0 len = MyComm.Input(buffer, 0, buffer.Length) End While [C#] while (MyComm.InBufferCount > 0) len = MyComm.Input(buffer, 0, buffer.Length); - 304 -...
  • Page 311 Output Writes data into the send buffer. ■ Syntax [VB] Public Sub Output(ByVal buffer() As Byte, ByVal offset As Integer, _ ByVal len As Integer) [C#] public void Output(byte[] buffer, int offset, int len) Parameters ■ buffer [in] Source buffer offset [in] Offset from the beginning of the source buffer indicating the start point of the data [in] Maximum length of the buffer into which data is to be written...
  • Page 312 [Ex.] Send the len(byte) data when there is no longer any data in the send buffer. [VB] If MyComm.OutBufferCount = 0 Then MyComm.Output(buffer, 0, len) End If [C#] if (MyComm.OutBufferCount == 0) MyComm.Output(buffer, 0, len); - 306 -...
  • Page 313 Dispose Frees up all unmanaged resources. This function must be called before instances of the CommSerial class are no longer referenced. Syntax ■ [VB] Public Sub Dispose() [C#] public void Dispose() Parameters ■ None Return value ■ None Exceptions ■ None Note ■...
  • Page 314 OnDone Occurs when a COM event has occurred. ■ Syntax [VB] Public Event OnDone As EventHandler [C#] public event EventHandler OnDone ■ Event data The Event Handler has received EventArgs type parameters. The second parameter EventArgs e is always System.EventArgs.Empty. To identify the type of the event that has occurred, retrieve SignaledEvent.
  • Page 315 EN_EVENT Specifies the event type. ■ Syntax [VB] [Flags]Public Enum EN_EVENT [C#] [Flags]public enum EN_EVENT ■ Members Member Name Description NONE None RECEIVE Receive Class ■ Within CommSerial class - 309 -...
  • Page 316: Filetransfer

    18.30. FileTransfer Constructor Constructor Name Description FileTransfer Creates a new instance of the FileTransfer class. Fields Field Name Description DEFAULT_PORT Default COM port number to be used Properties Property Name Description Port Number of the COM port to be used Baud Communication rate Parity...
  • Page 317 Events Event Name Description OnDone Occurs when transfer processing has been completed. OnTransferring Information on the file is stored during the transfer. Enumeration Enumeration Name Description EN_BAUD Communication baud rate EN_PARITY Parity bit EN_STOPBITS Stop bit EN_STATUS File transfer status EN_RESULT Transfer processing result - 311 -...
  • Page 318 FileTransfer Initializes a new instance of the FileTransfer class. ■ Syntax [VB] Public Sub New( ) [C#] public FileTransfer( ) ■ Parameters None Exceptions ■ None [Ex.] Create a FileTransfer class instance. [VB] Dim MyFileTransfer As FileTransfer = New FileTransfer [C#] FileTransfer MyFileTransfer = new FileTransfer();...
  • Page 319 Port Sets the COM port number. ■ Syntax [VB] Public Property Port As Integer [C#] public int Port {get; set} ■ Property COM port number Parameter value(s): 1: Connector interface, 4: IrDA Default value: 4 Exceptions ■ Name of Exception Meaning InvalidOperationException The COM port is already open.
  • Page 320 Baud Sets the communication rate. ■ Syntax [VB] Public Property Baud As EN_BAUD [C#] public EN_BAUD Baud {get; set} ■ Property Communication rate. Parameter values: As listed in EN_BAUD BPS300, BPS600, BPS1200, BPS2400, BPS4800, BPS9600, BPS19200, BPS38400, BPS57600, BPS115200 (connector interface communication) BPS9600, BPS19200, BPS38400, BPS57600, BPS115200 (IrDA communication) Default value:...
  • Page 321 Parity Specifies the parity scheme to be used. ■ Syntax [VB] Public Property Parity As EN_PARITY [C#] public EN_PARITY Parity {get; set} ■ Property Parity Parameter values: As listed in EN_PARITY NOPARITY, ODDPARITY, EVENPARITY (connector interface communication) NOPARITY (IrDA communication) Default value: EN_PARITY.NOPARITY ■...
  • Page 322 StopBits Specifies the number of stop bits to be used. ■ Syntax [VB] Public Property StopBits As EN_STOPBITS [C#] public EN_STOPBITS StopBits {get; set} ■ Property Stop bits Parameter values: As listed in EN_STOPBITS ONEBIT, TWOBITS (connector interface communication) ONEBIT (IrDA communication) Default value: EN_STOPBITS.
  • Page 323 Path Specifies the folder in which the send file or receive file is [to be] located. ■ Syntax [VB] Public Property Path As String [C#] public string Path {get; set} Property ■ Absolute path Default value: @"\" Maximum length: 259 characters (including the path name and the file name) Exceptions ■...
  • Page 324 TransferringEventInterval Sets the interval for creating transferring events (OnTransferring). ■ Syntax [VB] Public Property TransferringEventInterval As Integer [C#] public int TransferringEventInterval {get; set} ■ Property Event interval (in units of 100 msec) Parameter values: 0 and above, but less than System.Int32.MaxValue Default value: 0 0: No event will occur.
  • Page 325 Status Acquires the file transfer status. ■ Syntax [VB] Public ReadOnly Property Status As EN_STATUS [C#] public EN_STATUS Status {get; } ■ Property File transfer status Parameter values: as listed in EN_STATUS Default value: EN_STATUS.READY Exceptions ■ None [Ex.] Acquire the file transfer status. [VB] Dim Status As FileTransfer.EN_STATUS = MyFileTransfer.Status [C#] FileTransfer.EN_STATUS Status = MyFileTransfer.Status;...
  • Page 326 FileCount Acquires the file number of the file being transferred. ■ Syntax [VB] Public ReadOnly Property FileCount As Integer [C#] public int FileCount {get; } ■ Property File number. (A serial number starting with the first file transferred as file number 1.) Default value: 0 Exceptions ■...
  • Page 327 AddFile Adds a file to be transferred. ■ Syntax [VB] Public Sub AddFile(ByVal fileName As String) [C#] public void AddFile(string fileName); ■ Parameters fileName [in] Name of the file to be added (This should not include the path.) Maximum length: 90 characters Return value ■...
  • Page 328 ClearFile Clears the contents of the file that was added by AddFile. ■ Syntax [VB] Public Sub ClearFile() [C#] public void ClearFile(); ■ Parameters None Return value ■ None Exceptions ■ None [Ex.] Clear the file to be sent. [VB] MyFileTransfer.ClearFile() [C#] MyFileTransfer.ClearFile();...
  • Page 329 Input Receives a file. ■ Syntax [VB] Public Sub Input() [C#] public void Input(); ■ Parameters None Return value ■ None Exceptions ■ Name of Exception Meaning SecurityException The port has already opened by another application. DeviceNotFoundException The COM port specified at Port does not exist. [Ex.] Receive a file.
  • Page 330 Output Sends the contents of the file that was specified by AddFile. ■ Syntax [VB] Public Sub Output() [C#] public void Output(); ■ Parameters None Return value ■ None Exceptions ■ Name of Exception Meaning SecurityException The port has already opened by another application. DeviceNotFoundException The COM port specified at Port does not exist.
  • Page 331 Abort Aborts the file transfer that is already in progress. ■ Syntax [VB] Public Sub Abort() [C#] public void Abort(); ■ Parameters None Return value ■ None Exceptions ■ None Note ■ Execution of this method will result in an OnDone event after file transfer has been aborted. [Ex.] Interrupt file transfer.
  • Page 332 Dispose Frees up all unmanaged resources. This function must be called before instances of the FileTransfer class are no longer referenced. Syntax ■ [VB] Public Sub Dispose() [C#] public void Dispose() Parameters ■ None Return value ■ None Exceptions ■ None Note ■...
  • Page 333 OnDone Occurs when a transfer operation is complete. ■ Syntax [VB] Public Event OnDone As TransferredHandler [C#] public event TransferredHandler OnDone ■ Event data The Event Handler has received TransferredEventArgs type parameters. One of the values listed in EN_Result will be stored in Result, the member of the second parameter TransferredEventArgs e.
  • Page 334 OnTransferring Information on the file being transferred will be entered. ■ Syntax [VB] Public Event OnTransferring As TransferringHandler [C#] public event TransferringHandler OnTransferring ■ Event data The Event Handler has received TransferringEventArgs type parameters. The name and size of the file being transferred and the amount of the data that has already been transferred will be stored in TransferringFileInfo, the member of the second parameter TransferringEventArgs e.
  • Page 335 EN_BAUD Specifies the communication rate. ■ Syntax [VB] Public Enum EN_BAUD [C#] public enum EN_BAUD Members ■ Member Name Description BPS110 110 bps BPS300 300 bps BPS600 600 bps BPS1200 1200 bps BPS2400 2400 bps BPS4800 4800 bps BPS9600 9600 bps BPS14400 14400 bps BPS19200...
  • Page 336 EN_PARITY Specifies the parity scheme. ■ Syntax [VB] Public Enum EN_PARITY [C#] public enum EN_PARITY ■ Members Member Name Description NOPARITY No parity ODDPARITY EVENPARITY Even Class ■ Within FileTransfer class - 330 -...
  • Page 337 EN_STOPBITS Specifies the stop bits. ■ Syntax [VB] Public Enum EN_STOPBITS [C#] public enum EN_STOPBITS ■ Members Member Name Description ONEBIT 1 bit TWOBITS 2 bit Class ■ Within FileTransfer class - 331 -...
  • Page 338 EN_STATUS Specifies the file transfer status. ■ Syntax [VB] Public Enum EN_STATUS [C#] public enum EN_STATUS Members ■ Member Name Description READY Ready RECEIVE Receiving SEND Sending Class ■ Within FileTransfer - 332 -...
  • Page 339 EN_RESULT Specifies the results of the file transfer. ■ Syntax [VB] Public Enum EN_RESULT [C#] public enum EN_RESULT ■ Members Member Name Description SUCCESS The file transfer was successfully completed TIMEOUT Timeout OPERATION_ The operation was aborted ABORTED OPEN_FAILED The file could not be opened. INVALID_DATA Invalid data has been received.
  • Page 340: Appendix 1. Key Arrangements

    Appendix 1. Key Arrangements 31-key arrangement (1) Numeric entry M2 M4 M2 M4 SCAN SCAN & SEND SEND FUNC FUNC Normal status Status with [SF] pressed (2) Alphabet entry SCAN A B C D E F a b c d e f G H I J K L M N O...
  • Page 341 50-key arrangement (1) Non-function mode SCAN SCAN & Func Func Normal status Status with [SF] pressed (2) Function mode SCAN SCAN & Func Func - 335 -...
  • Page 342: Appendix 2. Virtual Keyboard And Display Characters

    Appendix 2. Virtual Keyboard and Display Characters 31-key (1) Numeric entry Table 2.1. Virtual key codes and character codes when in 31-key type numeric entry mode Normal Status With [SF] Key Pressed Virtual Key Code Virtual Key Code Character Character Location Code Code...
  • Page 343 (2) Alphabet entry Table 2.2. Virtual key codes and character codes when in 31-key type alphabet entry mode Virtual Key Code Character Code Key Location Constant Value Time Time Time Time Time Time Time (*1) (*1) (*1) (*1) (*1) (*1) (*1) (*1) (*1)
  • Page 344 50-key (1) Non-function mode Table 2.3. 50-key type virtual key codes and character codes (non-function mode) Normal Status With [SF] Key Pressed Virtual Key Code Virtual Key Code Character Character Location Code Code Constant Value Constant Value − ← ← −...
  • Page 345 Table 2.3. (cont.) 50-key type virtual key codes and character codes (non-function mode) Normal Status With [SF] Key Pressed Virtual Key Code Virtual Key Code Character Character Location Code Code Constant Value Constant Value ← ← 58 (X) 78 (x) ←...
  • Page 346 Table 2.4. (cont.) 50-key type virtual key codes and character codes (non-function mode) Normal Status With [SHIFT] Key Pressed Virtual Key Code Virtual Key Code Character Character Location Code Code Constant Value Constant Value − ← ← − − ← ←...
  • Page 347 BHT-400-CE Class Library Reference Manual December, 2005 First Release DENSO WAVE INCORPORATED Automatic Data Capture Division - 341 -...

Table of Contents