SDK0005_BioStar SDK for beginners.pdf

8/11/2019 SDK0005_BioStar SDK for beginners.pdf

1/20

BioStar SDKFor beginners


2/20

2Suprema Inc.

Table of Contents

Introduction to BioStar SDK

Direct mode & Server mode Device Matching & Server Matching (in Server mode)

Comparison between Server mode & Direct mode

BioStar APIs

Communication (Direct Mode Only)

Device Control (Server Mode & Direct Mode)

User Management (Server Mode & Direct Mode)

Configuration (Server Mode & Direct Mode)

Access Control (Server Mode & Direct Mode)

Smartcard, Log (Server Mode & Direct Mode)

Startup (Server Mode Only)

Initialize (Server Mode Only) Communication (Server mode Only)

Log (Server mode Only)

Authentication / Matching (Server mode Only)


3/20

3Suprema Inc.

Introduction to BioStar SDK

Suprema

BioStar

S/W

BioStar

SDK

My Style,

My Application

(Using BioStar SDK)Control

Control


4/20

4Suprema Inc.

Server

Direct Mode & Server Mode

Connection

Device

Configure

Setting

Enroll

User Authentication

ReadLog

Using Direct Mode

Server

Connected

Device

Configure

Setting

Initialize and Start

Realtime Log

Using Server Mode

DisconnectDisconnected

Callback function in server mode

BioStar SDK supports 2 type of mode to connect a device.

Server Mode Direct Mode


5/20

5Suprema Inc.

Device Matching & Server Matching (in Server mode)

Authentication

Server

Connection

Device

Configure

Setting

Enroll User

(If you want

device matching)

Initializing and Start

Device Matching

Realtime Log

Disconnected

Authentication

Server

Connection

Device

Configure

Setting

Enroll User

(No need)

Initializing and Start

Server Matching

Realtime Log

Disconnected

X

Matching

Matching Result


6/20

6Suprema Inc.

Comparison between Server Mode & Direct Mode

Server mode Direct mode

Connection Device Server Server Device

Read/Write

Configuration

to Device

O O

User Enroll Server matching : Not required.Device matching : Required.

Device matching : Required.

Matching Server matching (Using BioMini SDK)

Device matching

Device matching

Get Log Receive Automatically,

Call ReadLog periodically

Call ReadLog periodically

Constraints Not available in case of

Device (Public IP Address) &

Server (Internal IP Address)

Not available in case of

Server (Public IP Address) &

Device (Internal IP Address)


7/207Suprema Inc.

BioStar APIs Communication (Direct Mode Only)

Communication API BS_OpenSocket

BS_OpenInteralUDP

BS_OpenSerial

BS_OpenSerial485

BS_OpenUSB

Server Connection Device

Connect

Communication API BS_CloseSocket

BS_CloseInteralUDP

BS_CloseSerial BS_CloseSerial485

BS_CloseUSB

Server Close Device

Disconnect


8/208Suprema Inc.

BioStar APIs Device Control (Server Mode & Direct Mode)

Device API BS_Reset

BS_DisableCommunication

BS_Disable

BS_Enable

BS_SetDeviceID

Server Get/Set Device

Device Control

Display Setup API BS_SetBackground

BS_SetSound

BS_SetLanguageFile

BS_SendNotice

Server Set Device

Display & Sound Configuration


9/209Suprema Inc.

BioStar APIs User Management (Server mode & Direct mode)

User Management API BS_EnrollUserEx

BS_EnrollMultipleUserEx

BS_ReadRFCardIDEx

BS_GetUserEx

BS_DeleteUser


User Management


10/20


11/2011

Suprema Inc.

BioStar APIs Access Control (Server mode & Direct mode)

Access Control API BS_SetAllTimeScheduleEx

BS_setAllHolidayEx

BS_GetAllAccessGroupEx

BS_RelayControlEx

BS_DoorControl


Access Control


12/20


13/2013

Suprema Inc.

Server API

Server API


14/2014

Suprema Inc.

BioStar APIs Startup (Server Mode Only)

Server API BS_StartServerApp

Server

Start in server mode

Device

Start Server

Server API BS_StopServerApp

Server

Stop server mode

Device

Stop Server


15/2015

Suprema Inc.

BioStar APIs Initialize (Server Mode Only)

Server API BS_SetConnectedCallback

BS_SetDisconnectedCallback

BS_SetRequestStartedCallback

BS_SetLogCallback

BS_SetImageLogCallback

BS_SetRequestUserInfoCallback BS_SetRequestMatchingCallback

Server

Register Callback function

Device

Registration of Callback


16/20

16Suprema Inc.

BioStar APIs Communication (Server Mode Only)

Server API Defined Connected Callback

Function is called.

If a device is connected to theserver, this function is calledautomatically.

ServerConnected

Device

Connected Callback

Server API Defined Disconnected Callback

function is called.

If a device is disconnected to

the server, this function iscalled automatically.

ServerDisconnected

Device

Disconnected Callback


17/20

17Suprema Inc.

BioStar APIs Log (Server Mode Only)

Server API Defined Log Callback function is

called.

If a log is created, this functionis called.

ServerLog Received

Device

Log Callback

Server API Defined Imagelog Callback

function is called.

If an image log is created, this

function is called.

ServerImage Log

Device

Imagelog Callback


18/20

18Suprema Inc.

BioStar APIs Authentication / Matching (Server Mode Only)

Server API Defined UserInfo Callback

function is called.

This function is called in belowcases.

- Card verification.

- ID + Password (Fingerprint, )

- Card + Fingerprint (ID + FP, )

Server

User Authentication

Device

UserInfo Callback

Server API Defined Matching Callback

function is called.

If a user tries to identify/verify

a finger, this function is called.

ServerMatching

Device

Matching Callback


19/20

19Suprema Inc.

How to Set A Device In Direct Mode

Open

Int hTcpCon;BS_OpenSocket (hTCPConn, )

Server

Connect Device

In Direct Mode

Get Handle of Device

Device

Device

Control (handle)

Server

Control

BEConfigData cd;

// Set My Configure

cd.wiegandMode = xxxBS_WriteConfig (hTCPConn, , &cd)

Open and Get handle.

Directly control by the handle.


20/20

SDK0005_BioStar SDK for beginners.pdf

Documents

Transcript of SDK0005_BioStar SDK for beginners.pdf