Show / Hide Table of Contents

Class RFIDScanner

小型RFIDリーダとの通信機能を持つクラスです。

このクラスが定義する各メソッドは、一部を除き

Open
メソッドを先に実行する必要があります。

Open
メソッド実行前に当該メソッドを呼び出した場合、速やかに
RFIDScannerException
がスローされます。

また、上記状況以外でも、すべてのメソッドは

RFIDScannerException
をスローする可能性があることに注意してください。

Inheritance
System.Object
RFIDScanner
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: TFSW.BUD01
Assembly: TFSW_RFIDScanner.dll
Syntax
public class RFIDScanner

Constructors

RFIDScanner()

Declaration
public RFIDScanner()

Properties

DataReceivedHandler

Declaration
public RFIDScanner.DataReceived DataReceivedHandler { get; set; }
Property Value
Type Description
RFIDScanner.DataReceived

Methods

Close()

接続済みのデバイスを切断します。

Declaration
public void Close()

ControlRssiMonitor(Boolean)

ハンディ接続モードにおいて、RSSI値を取得するかどうかを設定します。

Declaration
public void ControlRssiMonitor(bool enabled)
Parameters
Type Name Description
System.Boolean enabled

RSSI値を取得する場合 true

ControlUsb(Boolean)

USB通信機能のオープン/クローズを制御します。

Declaration
public void ControlUsb(bool enabled)
Parameters
Type Name Description
System.Boolean enabled

USB通信機能をオープンする場合は true

DeleteRecords()

すべてのタグ・レコードを削除します。

Declaration
public void DeleteRecords()

Finalize()

Declaration
protected void Finalize()

GetBleFirmwareInformation()

BLEファームウェア情報を取得します。

Declaration
public FirmwareInformation GetBleFirmwareInformation()
Returns
Type Description
FirmwareInformation

BLEファームウェア情報

GetInformation()

当該デバイスの各種情報を取得します。

Declaration
public DeviceInformation GetInformation()
Returns
Type Description
DeviceInformation

取得したデバイス情報

GetInternalComPort()

当該デバイスを示すシリアルポートのインスタンスを取得します。 このメソッドはシリアルポートに対して何か特別な処理を加える可能性を考慮して提供されています。 取得したポートの取り扱いには十分ご注意ください。

Declaration
public SerialPort GetInternalComPort()
Returns
Type Description
System.IO.Ports.SerialPort

GetMainFirmwareInformation()

メイン・ファームウェア情報を取得します。

Declaration
public FirmwareInformation GetMainFirmwareInformation()
Returns
Type Description
FirmwareInformation

ファームウェア情報

GetOutRecord()

タグ・レコード・ファイル内の最も古いタグ・レコードを取得し、取得したレコードを削除します。

Declaration
public TagInformation GetOutRecord()
Returns
Type Description
TagInformation

GetPollingSetting()

タグ・ポーリングの各種パラメータを取得します。

Declaration
public Region GetPollingSetting()
Returns
Type Description
Region

GetQValue()

当該デバイスに設定されているQ値を取得します。

Declaration
public int GetQValue()
Returns
Type Description
System.Int32

Q値

GetRecordCount()

タグ・レコードの件数を取得します。

Declaration
public int GetRecordCount()
Returns
Type Description
System.Int32

IsOpened()

シリアルポートが開いているかどうかを取得します。

Declaration
public bool IsOpened()
Returns
Type Description
System.Boolean

ポートが開いている場合 true

Open(String)

指定されたCOMポートデバイスへの接続を行います。 このメソッドは、他のすべてのメソッドの実行前に呼出す必要があります。

Declaration
public void Open(string port)
Parameters
Type Name Description
System.String port

接続するデバイスのCOMポート名(COMxx)

OperateSuspend()

当該デバイスのステートを Suspended へ突入させます。

Declaration
public void OperateSuspend()

OperateWorking()

当該デバイスのステートを Working へ突入させます。

Declaration
public void OperateWorking()

OperateWorking(Int32)

当該デバイスのステートを、指定された稼働滞留時間付きで Working へ突入させます。

Declaration
public void OperateWorking(int second)
Parameters
Type Name Description
System.Int32 second

稼働滞留時間(秒)

Exceptions
Type Condition
RFIDScannerException

second が 1 ~ 255 の範囲にない場合

ReadTag(Int32, Int32, Int32)

タグの指定されたメモリバンクからデータを読み出します。

Declaration
public string ReadTag(int bank, int offset, int dataCount)
Parameters
Type Name Description
System.Int32 bank

読み出すメモリバンク。1:EPC、2:TID、3:USER

System.Int32 offset

読出し開始位置(ワード長)

System.Int32 dataCount

読出しデータのワード長

Returns
Type Description
System.String

タグから読みだしたデータ

Remarks

このメソッドの実装は以下と等価です。

ReadTag(bank, offset, length, 0x00, 0x20, "00");
See Also
ReadTag(Int32, Int32, Int32, Int32, Int32, String)

ReadTag(Int32, Int32, Int32, Int32, Int32, String)

タグの指定されたメモリバンクからデータを読み出します。

Declaration
public string ReadTag(int bank, int offset, int dataCount, int maskLength, int maskPoint, string maskValue)
Parameters
Type Name Description
System.Int32 bank

読み出すメモリバンク。1:EPC、2:TID、3:USER

System.Int32 offset

読出し開始位置(ワード長)

System.Int32 dataCount

読出しデータのワード長

System.Int32 maskLength

有効マスクのビット長

System.Int32 maskPoint

マスクを適用するEPCバンク内の先頭ビット位置(0x20以降が指定可能)

System.String maskValue

読取対象とするEPCの指定(16進数文字列)

Returns
Type Description
System.String
Exceptions
Type Condition
RFIDScannerException

・指定されたメモリバンクの読み出しがサポートされていない場合 ・読出し開始位置/ワード長が範囲外の場合

Restart()

当該デバイスを製造初期状態へ初期化後、再起動します。

Declaration
public void Restart()

SendDirectCommand(Byte[])

指定したコマンドを当該デバイスへ発行します。

Declaration
public ResponseData SendDirectCommand(byte[] command)
Parameters
Type Name Description
System.Byte[] command

発行するコマンド

Returns
Type Description
ResponseData
Remarks

このメソッドの実装は以下と等価です。

SendDirectCommand(command, 2000)

SendDirectCommand(Byte[], Int32)

指定したコマンドを当該デバイスへ発行します。

Declaration
public ResponseData SendDirectCommand(byte[] command, int timeout)
Parameters
Type Name Description
System.Byte[] command

発行するコマンド

System.Int32 timeout

発行時のタイムアウト設定(ミリ秒)

Returns
Type Description
ResponseData

SetBuzzerSetting(Int32)

ブザーの活用方法を設定します。

Declaration
public void SetBuzzerSetting(int buzzerPattern)
Parameters
Type Name Description
System.Int32 buzzerPattern

発音パターン。2連発のブザー音の場合は 1、単発のブザー音の場合 0

SetFunctions(Boolean, Boolean, Boolean, Boolean, Boolean)

当該デバイスに装備されている各種周辺機能の活用を設定します。

Declaration
public void SetFunctions(bool vibrate, bool buzzer, bool led, bool rfKey, bool powerKey)
Parameters
Type Name Description
System.Boolean vibrate

バイブレータを有効にする場合 true

System.Boolean buzzer

ブザーを有効にする場合 true

System.Boolean led

LEDを有効にする場合 true

System.Boolean rfKey

RFキーを有効にする場合 true

System.Boolean powerKey

Powerキーを有効にする場合 true

SetPollingPolicy(ConnectMode, ReadPolicy)

ポーリング・ポリシーをモード単位で設定します。

Declaration
public void SetPollingPolicy(ConnectMode mode, ReadPolicy policy)
Parameters
Type Name Description
ConnectMode mode

ポリシーの設定先となる動作モード

ReadPolicy policy

ポーリング・ポリシー

Exceptions
Type Condition
RFIDScannerException

指定されたポリシーが動作モードに適用できない場合

SetPollingSetting(Region.Code, Int32[], Boolean)

タグ・ポーリングの各種パラメータを設定します。

Declaration
public void SetPollingSetting(Region.Code name, int[] channels, bool lbt)
Parameters
Type Name Description
Region.Code name

運用地域指定

System.Int32[] channels

有効にするチャネル番号

System.Boolean lbt

LBT制御を有効にする場合 true

Remarks

指定された運用地域に適用できない設定は無視されます。 また、チャネル番号は指定した運用地域で使用可能なチャネル番号を1つ以上指定する必要があります。

SetPollingTarget(EPCLength)

タグ・ポーリング対象を設定します。

Declaration
public void SetPollingTarget(EPCLength epcLength)
Parameters
Type Name Description
EPCLength epcLength

読取対象とするEPCの最大長(これを超えるタグは読取らない)。

Remarks

デバイス内にタグレコードが蓄積されている場合、コマンドは正常に処理されません。

SetQValue(Int32)

指定されたQ値を小型RFIDリーダへ設定します。

Declaration
public void SetQValue(int qValue)
Parameters
Type Name Description
System.Int32 qValue

設定するQ値 ( 1 ~ 8 )

SetTime(DateTimeOffset)

当該デバイスへ日時を設定します。 日時は、1970年1月1日0時0分16秒(UTC)以降が有効です。

Declaration
public void SetTime(DateTimeOffset datetime)
Parameters
Type Name Description
System.DateTimeOffset datetime

デバイスに設定する日時

StartPolling()

タグ・ポーリングを開始します。

Declaration
public void StartPolling()

StopPolling()

タグ・ポーリングを停止します。

Declaration
public void StopPolling()
Back to top Generated by DocFX