Denso BHT-700-WM Reference guide

GPRS Class Library

Reference Manual

Bar Code Handy Terminal

BHT-700-WM

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

respective holders.

Update

Version Date Detail

1.0 March, 2009 First Release

2.0 July, 2009 Added “Operating Precautions”

Modified following parameters of functions.

- GetSIMPINPUKCounter

- SetNecessarySIMPIN

- SetRadioBand

- GetOperatorInfo

- SendSMS

3.0 September, 2009 Added “1. Programing”

Introduction

This reference manual is intended for software developers using VB.NET or C# to develop software applications using

GPRS(EDGE) functions for the BHT-700.

 Operating Precautions

When you develop software applications using GPRS(EDGE) functions, you need to copy GPRSLIB.dll supplied with

GPRS Class Library to a Windows folder of BHT-700.

Otherwise the applications you developed can’t operate properly.

 Related Manuals

Please refer to the following related manuals for further information.

• BHT-700-WM Class Library Reference Manual

 Contacts

Please forward any opinions or questions that you may have regarding this manual to the address below or contact us

by telephone.

DENSO WAVE INCORPORATED

MT Bldg. Hall No.2, 4-2-12,Toranomon, Minato-ku, Tokyo, 105-0001 Japan

Tel: +81-3-5472-0477

 Latest Information

Please access our Web site using the following URL for the latest information on this manual and our full range of

products.

http://www.denso-wave.com/

More detailed information is available for product owners at our dedicated Web site (QBNet) for registered users.

Please access the above URL for user registration and details on QBNet.

- i -

Contents

1. Programing ......................................................................................................................................................................................... 1

2. GPRS class........................................................................................................................................................................................ 2

3. SMS information structure ........................................................................................................................................................31

4. Operator list structure................................................................................................................................................................35

5. Operator structure .......................................................................................................................................................................36

6. Time structure................................................................................................................................................................................37

7. error code.........................................................................................................................................................................................38

- ii -

- 1 -

1. Programing

Procedure for GRPS's connection

Step1 : Insert SIM card into BHT

Step2 : Power on GPRS module.

use "PowerOn" method

Step3 : Open COM port to send a control command to the GPRS module.

use "OpenCom" method

Step4 : Check the authentication status of SIM PIN authentication.

use "GetSIMPINStatus" method

Step5 : Input PIN code If PIN code is necessary at 4.

use "SetSIMPIN" method

Step6 : Set a radio frequency band.

use "SetRadioBand" method

Step7 : After within around 60 sec, GPRS complete to connect to a base station. (Notes)

(Notes) It is long time to connect to a base station at the first time.

- 2 -

2. GPRS class

 Constructor

There is no need to create an instance because all the members are static members

 Methods

Method Name Description

PowerOn Turn ON GPRS module

PowerOff Turn OFF GPRS module

OpenCom Open GPRS COM port

CloseCom Close GPRS COM port

GetSIMPINStatus Get the SIM PIN authentication status

GetSIMPINPUKCounter Get the number of attempts still available for entering the

PIN/PUK code

SetSIMPIN Set the SIM PIN for GSM network registration

ChangeSIMPIN Change SIM PIN for GSM network registration

SetNecessarySIMPIN Select whether SIM PIN is necessary or not

SetSIMPUK Set the SIM PUK to unlock the PIN-lock issue and assign a

new PIN code for next registration

SetRadioBand Select radio frequency band

GetSignalStrength Get the RSSI

GetModuleVersion Get the firmware version of module

GetAllOperatorCnt Acquire the number of total operator

GetAllOperatorInfo Acquire all the operator name

GetOperatorListCnt Acquire the number of visible operator

GetOperatorListInfo Acquire all the visible operator name

GetOperatorInfo Get the operator name

SetSMSStorageDest Specify destination storing received short message

DeleteSMS Delete short message

ReadSMS Read short message

SendSMS Send short message

WriteSMSToMem Write short message into the memory

SendSMSFromMem Send short message stored in the memory

GetSMSListCnt Acquire the number of SMS stored in the memory or UIM

 Enumeration

Enumeration Name Description

EN_SIMSTATUS SIM authentication state

EN_RADIOBAND Radio band

EN_STORAGESMS Storage area to save short message

- 3 -

PowerOn

Turn the power of GPRS module on.

￭ Syntax

[VB]

Public Shared Function PowerOn() As UInt32

[C#]

public static UInt32 PowerOn();

￭ Return value

error code

0 : Normal end

Other than 0 : Abnormal end. For more detail, refer to

7. error code.

- 4 -

PowerOff

Turn the power of GPRS module off.

￭ Syntax

[VB]

Public Shared Function PowerOff() As UInt32

[C#]

public static UInt32 PowerOff();

￭ Return value

error code

0 : Normal end

Other than 0 : Abnormal end. For more detail, refer to

7. error code.

- 5 -

OpenCom

Open the COM port for GPRS function.

￭ Syntax

[VB]

Public Shared Function OpenCom() As UInt32

[C#]

public static UInt32 OpenCom();

￭ Return value

error code

0 : Normal end

Other than 0 : Abnormal end. For more detail, refer to

7. error code.

- 6 -

CloseCom

Close the COM port of GPRS.

￭ Syntax

[VB]

Public Shared Function CloseCom() As UInt32

[C#]

public static UInt32 CloseCom();

￭ Return value

error code

0 : Normal end

Other than 0 : Abnormal end. For more detail, refer to

7. error code.

- 7 -

GetSIMPINStatus

Get the SIM PIN authentication state.

￭ Syntax

[VB]

Public Shared Function GetSimPINStatus( _

ByRef status As EN_SIMSTATUS) As UInt32

[C#]

public static UInt32 GetSimPINStatus(out EN_SIMSTATUS staus);

￭ Parameters

status

[out] Authentication state

￭ Return value

error code

0 : Normal end

Other than 0 : Abnormal end. For more detail, refer to

7. error code.

- 8 -

GetSIMPINPUKCounter

Get the number of attempts still available for entering the PIN/PUK code.

￭ Syntax

[VB]

Public Shared Function GetSIMPINPUKCounter( _

ByRef PINCount As UInt32, _

ByRef PUKCount As UInt32) As UInt32

[C#]

public static UInt32 GetSIMPINPUKCounter(

out UInt32 PINCount, out UInt32 PUKCount);

￭ Parameters

PINCount

[out] available attempts number for entering the PIN code

PUKCount

[out] available attempts number for entering the PUK code

￭ Return value

error code

0 : Normal end

Other than 0 : Abnormal end. For more detail, refer to

7. error code.

- 9 -

SetSIMPIN

Set the SIM PIN for GSM network registration.

￭ Syntax

[VB]

Public Shared Function SetSIMPIN(ByVal PIN As String) As UInt32

[C#]

public static UInt32 SetSIMPIN(string PIN);

￭ Parameters

[in ] SIM PIN

￭ Return value

error code

0 : Normal end

Other than 0 : Abnormal end. For more detail, refer to

7. error code.

- 10 -

ChangeSIMPIN

Change SIM PIN for GSM network registration.

￭ Syntax

[VB]

Public Shared Function ChangeSIMPIN _

(ByVal PIN As String, ByVal newPIN As String) As UInt32

[C#]

public static UInt32 ChangeSIMPIN(string PIN, string newPIN);

￭ Parameters

[in ] (old)PIN

newPIN

[in ] new PIN

Settable value : string which length is from 4 digits to 8 digits.

￭ Return value

error code

0 : Normal end

Other than 0 : Abnormal end. For more detail, refer to

7. error code.

- 11 -

SetNecessarySIMPIN

Select whether SIM PIN is necessary or not.

￭ Syntax

[VB]

Public Shared Function SetNecessarySIMPIN _

(ByVal req As Boolean, ByVal PIN As String) As UInt32

[C#]

public static UInt32 SetNecessarySIMPIN(bool req, string PIN);

￭ Parameters

req

[in ] PIN is necessary(=true) or unncessary(=false)

[in ] SIM PIN

￭ Return value

error code

0 : Normal end

Other than 0 : Abnormal end. For more detail, refer to

7. error code.

- 12 -

SetSIMPUK

Set the SIM PUK to unlock the PIN-lock issue and assign a new PIN code for next registration.

￭ Syntax

[VB]

Public Shared Function SetSIMPUK( _

ByVal puk As String, ByVal pin As String) As UInt32

[C#]

public static UInt32 SetSIMPUK(string puk, string pin);

￭ Parameters

puk

[in ] PUK code

[in ] new SIM PIN code

￭ Return value

error code

0 : Normal end

Other than 0 : Abnormal end. For more detail, refer to

7. error code.

- 13 -

SetRadioBand

Select radio frequency band.

￭ Syntax

[VB]

Public Shared Function SetRadioBand( _

ByVal prefBand As EN_RADIOBAND, _

ByVal enableBand As EN_RADIOBAND) As UInt32

[C#]

public static UInt32 SetRadioBand(

EN_RADIOBAND prefBand, EN_RADIOBAND enableBand);

￭ Parameters

prefBand

[in ] preference band selection.

The selectable band is as following table.

enableBand

[in ] permitted band selection.

The selectable band is as following table.

band specification

GSM900 GSM900MHz

GSM1800 GSM1800MHz

GSM900 + GSM1800 GSM900MHz and GSM1800MHz

GSM1900 GSM1900MHz

GSM900 + GSM1900 GSM900MHz and GSM1900MHz

GSM850 GSM850MHz

GSM850 + GSM1800 GSM850MHz and GSM1800MHz

GSM850 + GSM1900 GSM850MHz and GSM1900MHz

￭ Return value

error code

0 : Normal end

Other than 0 : Abnormal end. For more detail, refer to

7. error code.

- 14 -

GetSignalStrength

Get the signal strength.

￭ Syntax

[VB]

Public Shared Function GetSignalStrength( _

ByRef RSSI As UInt32, ByRef BER As UInt32) As UInt32

[C#]

public static UInt32 GetSignalStrength(

out UInt32 RSSI, out UInt32 BER);

￭ Parameters

RSSI

[out] signal strength

rssi specification

0 -113 dBm or less

1 -111 dBm

2…30 -109…-53 dBm

31 -51 dBm or greater

99 Not known or not detectable

BER

[in ] Bit Error Rate

￭ Return value

error code

0 : Normal end

Other than 0 : Abnormal end. For more detail, refer to

7. error code.

- 15 -

GetModuleVersion

Get the firmware version of module.

￭ Syntax

[VB]

Public Shared Function GetModuleVersion( _

ByVal version As System.Text.StringBuilder) As UInt32

[C#]

public static UInt32 GetModuleVersion(

System.Text.StringBuilder version);

￭ Parameters

version

[out] F/W version

￭ Return value

error code

0 : Normal end

Other than 0 : Abnormal end. For more detail, refer to

7. error code.

Page is loading ...

Denso BHT-700-WM Reference guide

Denso BHT-700-WM Reference guide

Related papers

Other documents