Run the example

  1. Install and run the device gateway
  2. Download the C# client library
  3. Copy the root certificate of the device gateway to your working directory. As default, the certificate(ca.crt) resides in cert of the installation directory.
  4. The quick start example uses grpc-dotnet. You can change the example/quick/quick.csproj file as needed.

  5. Change the gateway and the device information in example/quick/Program.cs as needed.

     // the path of the root certificate
 private const string GATEWAY_CA_FILE = "../../../cert/gateway/ca.crt";

 // the address of the gateway
 private const string GATEWAY_ADDR = "192.168.0.2";
 private const int GATEWAY_PORT = 4000;

 // the ip address of the target device
 private const string DEVICE_ADDR = "192.168.0.110";
 private const int DEVICE_PORT = 51211;

  6. Build and run.

     cd example/quick
 dotnet run

1. Overview

You can use the services in the following steps.

  1. Create a Channel and connect to the gateway.

     var channelCredentials = new SslCredentials(File.ReadAllText(caFile));

 Channel channel = new Channel(serverAddr, serverPort, channelCredentials);

  2. Create a service client such as Connect.Connect.ConnectClient using the channel. For the available services and functions, please refer to the API reference.

     Connect.Connect.ConnectClient connectClient = new Connect.Connect.ConnectClient(channel);

  3. Call the functions of the service using the client.

     var connectInfo = new ConnectInfo{ IPAddr = deviceAddr, Port = devicePort, UseSSL = true };
 var request = new ConnectRequest{ ConnectInfo = connectInfo };
 var response = connectClient.Connect(request);

The classes in the example namespace are written for showing the usage of the corresponding APIs. In your applications, you don’t have to use these sample classes.

2. Connect to the device gateway

The first thing to do is to connect to the device gateway and get a Channel, which will be used for further communication. You have to know the address and port number of the gateway. And, you should also have the root certificate of the gateway for TLS/SSL communication.

// An example class encapsulating communication with the gateway
class GrpcClient
{
  private Channel channel;

  public Channel GetChannel() {
    return channel;
  }

  public void Close() {
    channel.ShutdownAsync().Wait();
  }
}

class GatewayClient : GrpcClient {
  public void Connect(string caFile, string serverAddr, int serverPort) {
    var channelCredentials = new SslCredentials(File.ReadAllText(caFile));

    channel = new Channel(serverAddr, serverPort, channelCredentials);
  } 
}

  1. Create the GatewayClient.

     var gatewayClient = new GatewayClient();

  2. Connect to the gateway.

     gatewayClient.Connect(GATEWAY_CA_FILE, GATEWAY_ADDR, GATEWAY_PORT);

3. Connect to BioStar devices

There are three ways to manage the connections with BioStar devices. This example shows only the synchronous API. For the other APIs, refer to the Connect API and the tutorial.

// An example class showing the usage of the Connect API
class ConnectSvc
{
  private Connect.Connect.ConnectClient connectClient;

  public ConnectSvc(Channel channel) {
    connectClient = new Connect.Connect.ConnectClient(channel);
  }

  public RepeatedField<Connect.DeviceInfo> GetDeviceList() {
    var request = new GetDeviceListRequest{};
    var response = connectClient.GetDeviceList(request);

    return response.DeviceInfos;
  }

  public uint Connect(String deviceAddr, int devicePort) {
    var connectInfo = new ConnectInfo{ IPAddr = deviceAddr, Port = devicePort, UseSSL = true };

    var request = new ConnectRequest{ ConnectInfo = connectInfo };
    var response = connectClient.Connect(request);

    return response.DeviceID;
  } 

  public void Disconnect(uint deviceID) {
    var request = new DisconnectRequest{};
    request.DeviceIDs.Add(deviceID);

    var response = connectClient.Disconnect(request);
  }     
}

  1. Create the ConnectSvc. It makes the Connect.Connect.ConnectClient internally.

     ConnectSvc connectSvc = new ConnectSvc(grpcClient.GetChannel());

  2. Connect to the specified device. As default, the device is not set to use SSL. To use SSL, you have to enable it first using Connect.EnableSSL. The returned device ID will be used for other APIs.

     var devID = connectSvc.Connect(DEVICE_ADDR, DEVICE_PORT);

  3. Get the devices, which are managed by the gateway.

     var devList = connectSvc.GetDeviceList();

  4. Disconnect the device.

     connectSvc.Disconnect(devID);

4. Device

Using the Device API, you can get the information of the specified device.

// An example class showing the usage of the Device API
class DeviceSvc
{
  private Device.Device.DeviceClient deviceClient;

  public DeviceSvc(Channel channel) {
    deviceClient = new Device.Device.DeviceClient(channel);
  }

  public FactoryInfo GetInfo(uint deviceID) {
    var request = new GetInfoRequest{ DeviceID = deviceID };
    var response = deviceClient.GetInfo(request);

    return response.Info;
  }

  public CapabilityInfo GetCapabilityInfo(uint deviceID) {
    var request = new GetCapabilityInfoRequest{ DeviceID = deviceID };
    var response = deviceClient.GetCapabilityInfo(request);

    return response.CapInfo;
  }
}

  1. Create the DeviceSvc. It makes the Device.Device.DeviceClient internally.

     DeviceSvc deviceSvc = new DeviceSvc(grpcClient.GetChannel());

  2. Get the version information of the device.

     var info = deviceSvc.GetInfo(deviceID);

  3. Get the capability information of the device. Each device type has its own capability. For example, CapabilityInfo.faceSupported will be true only for FaceStation 2 and FaceLite.

     var capInfo = deviceSvc.GetCapabilityInfo(deviceID);

5. Fingerprint

Using the Finger API, you can scan a fingerprint, get the last-scanned image, and configure the fingerprint options.

// An example class showing the usage of the Finger API
class FingerSvc
{
  private Finger.Finger.FingerClient fingerClient;

  public FingerSvc(Channel channel) {
    fingerClient = new Finger.Finger.FingerClient(channel);
  }

  public ByteString Scan(uint deviceID, Finger.TemplateFormat templateFormat, uint qualityThreshold) {
    var request = new ScanRequest{ DeviceID = deviceID, TemplateFormat = templateFormat, QualityThreshold = qualityThreshold };
    var response = fingerClient.Scan(request);

    Console.WriteLine("Template Score: {0}", response.QualityScore);

    return response.TemplateData;
  }

  public ByteString GetImage(uint deviceID) {
    var request = new GetImageRequest{ DeviceID = deviceID };
    var response = fingerClient.GetImage(request);

    return response.BMPImage;
  }

  public FingerConfig GetConfig(uint deviceID) {
    var request = new Finger.GetConfigRequest{ DeviceID = deviceID };
    var response = fingerClient.GetConfig(request);

    return response.Config;
  }
}

  1. Create the FingerSvc. It makes the Finger.Finger.FingerClient internally.

    
 FingerSvc fingerSvc = new FingerSvc(grpcClient.GetChannel());

  2. Scan a fingerprint on the device and get the template data. You can assign this template to a user using User.SetFinger.

     var templateData = fingerSvc.Scan(deviceID, Finger.TemplateFormat.Suprema, QUALITY_THRESHOLD);

  3. Get the scanned fingerprint image and save it to a BMP file.

     var bmpImage = fingerSvc.GetImage(deviceID);
 File.WriteAllBytes(FINGERPRINT_IMAGE_FILE, bmpImage.ToByteArray());

  4. Get the fingerprint configuration. To change some of its options, call Finger.SetConfig.

     var fingerConfig = fingerSvc.GetConfig(deviceID);

6. Card

Using the Card API, you can scan/write cards, manage the blacklist, and configure the card options.

// An example class showing the usage of the Card API
class CardSvc
{
  private Card.Card.CardClient cardClient;

  public CardSvc(Channel channel) {
    cardClient = new Card.Card.CardClient(channel);
  }

  public CardData Scan(uint deviceID) {
    var request = new ScanRequest{ DeviceID = deviceID };
    var response = cardClient.Scan(request);

    return response.CardData;
  }

  public RepeatedField<Card.BlacklistItem> GetBlacklist(uint deviceID) {
    var request = new GetBlacklistRequest{ DeviceID = deviceID };
    var response = cardClient.GetBlacklist(request);

    return response.Blacklist;
  }

  public void AddBlacklist(uint deviceID, Card.BlacklistItem[] cardInfos) {
    var request = new AddBlacklistRequest{ DeviceID = deviceID };
    request.CardInfos.AddRange(cardInfos);

    cardClient.AddBlacklist(request);
  }

  public void DeleteBlacklist(uint deviceID, Card.BlacklistItem[] cardInfos) {
    var request = new DeleteBlacklistRequest{ DeviceID = deviceID };
    request.CardInfos.AddRange(cardInfos);

    cardClient.DeleteBlacklist(request);
  }
}

  1. Create the CardSvc. It makes the Card.Card.CardClient internally.

     CardSvc cardSvc = new CardSvc(grpcClient.GetChannel());

  2. Scan a card.

     var cardData = cardSvc.Scan(deviceID);

  3. BioStar devices manage a blacklist to disable disqualified cards. You can get/add/delete blacklisted cards.

     // Get the current blacklist
 var blacklist = cardSvc.GetBlacklist(deviceID);

 // Add new items into the blacklist
 var newCardInfos = new Card.BlacklistItem[NUM_OF_BLACKLIST_ITEM];

 for(int i = 0; i < NUM_OF_BLACKLIST_ITEM; i++) {
   newCardInfos[i] = new Card.BlacklistItem{ CardID = ByteString.CopyFromUtf8(String.Format("{0}", FIRST_BLACKLISTED_CARD_ID + i)), IssueCount = ISSUE_COUNT };
 }

 cardSvc.AddBlacklist(deviceID, newCardInfos);

7. User

Using the User API, you can get/enroll/delete users. You can also set fingerprints/cards/groups to users.

// An example class showing the usage of the User API
class UserSvc
{
  private User.User.UserClient userClient;

  public UserSvc(Channel channel) {
    userClient = new User.User.UserClient(channel);
  }

  public RepeatedField<User.UserHdr> GetList(uint deviceID) {
    var request = new GetListRequest{ DeviceID = deviceID };
    var response = userClient.GetList(request);

    return response.Hdrs;
  }

  public RepeatedField<User.UserInfo> GetUser(uint deviceID, string[] userIDs) {
    var request = new GetRequest{ DeviceID = deviceID };
    request.UserIDs.AddRange(userIDs);

    var response = userClient.Get(request);

    return response.Users;
  } 

  public void Enroll(uint deviceID, User.UserInfo[] users) {
    var request = new EnrollRequest{ DeviceID = deviceID };
    request.Users.AddRange(users);

    var response = userClient.Enroll(request);
  }

  public void Delete(uint deviceID, string[] userIDs) {
    var request = new DeleteRequest{ DeviceID = deviceID };
    request.UserIDs.AddRange(userIDs);

    var response = userClient.Delete(request);
  }

  public void SetFinger(uint deviceID, User.UserFinger[] userFingers) {
    var request = new SetFingerRequest{ DeviceID = deviceID };
    request.UserFingers.AddRange(userFingers);

    var response = userClient.SetFinger(request);
  }   
}

  1. Create the UserSvc. It makes the User.User.UserClient internally.

     UserSvc userSvc = new UserSvc(grpcClient.GetChannel());

  2. Get the user list and detailed information.

     // Get the user list
 var userList = userSvc.GetList(deviceID);

 // Extract user IDs from the list
 string[] userIDs = new string[userList.Count];

 for(int i = 0; i < userList.Count; i++) {
   userIDs[i] = userList[i].ID;
 }

 // Get the user information with the user IDs
 var users = userSvc.GetUser(deviceID, userIDs);

  3. Enroll new users.

     var newUsers = new User.UserInfo[NUM_OF_NEW_USER];
 var newUserIDs = new String[NUM_OF_NEW_USER];
 var rnd = new Random();

 for(int i = 0; i < NUM_OF_NEW_USER; i++) {
   var hdr = new User.UserHdr{ ID = String.Format("{0}", rnd.Next()) };
   newUsers[i] = new User.UserInfo{ Hdr = hdr };
   newUserIDs[i] = hdr.ID;
 }

 userSvc.Enroll(deviceID, newUsers);

  4. Set fingerprints to users. You can also set cards, access groups, and job codes in similar fashion.

     var userFingers = new User.UserFinger[1];
 userFingers[0] = new User.UserFinger{ UserID = userID };
    
 // Scan the first fingerprint
 var firstTemplate = fingerSvc.Scan(deviceID, Finger.TemplateFormat.Suprema, QUALITY_THRESHOLD);

 // Scan the second fingerprint of the same finger
 var secondTemplate = fingerSvc.Scan(deviceID, Finger.TemplateFormat.Suprema, QUALITY_THRESHOLD);

 var fingerData = new Finger.FingerData{ Index = 0, Flag = 0 };
 fingerData.Templates.Add(firstTemplate);
 fingerData.Templates.Add(secondTemplate);

 userFingers[0].Fingers.Add(fingerData);

 userSvc.SetFinger(deviceID, userFingers);

  5. Delete new users.

     userSvc.Delete(deviceID, newUserIDs);

8. Event

Using the Event API, you can read event logs stored in devices. You can also receive real-time events after enabling monitoring.

// An example class showing the usage of the Event API
class EventSvc
{
  private const int MONITORING_QUEUE_SIZE = 8;

  private Event.Event.EventClient eventClient;
  private CancellationTokenSource cancellationTokenSource;

  public EventSvc(Channel channel) {
    eventClient = new Event.Event.EventClient(channel);
  }

  public RepeatedField<Event.EventLog> GetLog(uint deviceID, uint startEventID, uint maxNumOfLog) {
    var request = new GetLogRequest{ DeviceID = deviceID, StartEventID = startEventID, MaxNumOfLog = maxNumOfLog };
    var response = eventClient.GetLog(request);

    return response.Events;
  }

  public RepeatedField<Event.ImageLog> GetImageLog(uint deviceID, uint startEventID, uint maxNumOfLog) {
    var request = new GetImageLogRequest{ DeviceID = deviceID, StartEventID = startEventID, MaxNumOfLog = maxNumOfLog };
    var response = eventClient.GetImageLog(request);

    return response.ImageEvents;
  }    

  public void StartMonitoring(uint deviceID) {
    var enableRequest = new EnableMonitoringRequest{ DeviceID = deviceID };
    eventClient.EnableMonitoring(enableRequest);

    var subscribeRequest = new SubscribeRealtimeLogRequest{ DeviceIDs = {deviceID}, QueueSize = MONITORING_QUEUE_SIZE };
    var call = eventClient.SubscribeRealtimeLog(subscribeRequest);

    cancellationTokenSource = new CancellationTokenSource();

    ReceiveEvents(call.ResponseStream, cancellationTokenSource.Token);
  }

  public void StopMonitoring(uint deviceID) {
    var disableRequest = new DisableMonitoringRequest{ DeviceID = deviceID };
    eventClient.DisableMonitoring(disableRequest);

    if(cancellationTokenSource != null) {
      cancellationTokenSource.Cancel();
    }
  }    
}

  1. Create the EventSvc. It makes the Event.Event.EventClient internally.

     EventSvc eventSvc = new EventSvc(grpcClient.GetChannel());

  2. Get event logs. You can specify the first ID and the maximum number of events to be returned.

     var events = eventSvc.GetLog(deviceID, 0, MAX_NUM_OF_LOG);

  3. Get image logs in JPG format. Only the devices with the CapabilityInfo.imageLogSupported can store image logs. You can also specify the event types to save image logs using Event.SetImageFilter.

     var imageEvents = eventSvc.GetImageLog(deviceID, 0, MAX_NUM_OF_IMAGE_LOG);

 if(imageEvents.Count > 0) {
   File.WriteAllBytes(LOG_IMAGE_FILE, imageEvents[0].JPGImage.ToByteArray());
 }

  4. Enable event monitoring of the device and receive real-time events asynchronously.

     // Enable monitoring of the device
 var enableRequest = new EnableMonitoringRequest{ DeviceID = deviceID };
 eventClient.EnableMonitoring(enableRequest);

 // Start monitoring thread for receiving events asynchronously
 var subscribeRequest = new SubscribeRealtimeLogRequest{ DeviceIDs = {deviceID}, QueueSize = MONITORING_QUEUE_SIZE };
 var call = eventClient.SubscribeRealtimeLog(subscribeRequest);

 cancellationTokenSource = new CancellationTokenSource();

 ReceiveEvents(call.ResponseStream, cancellationTokenSource.Token);

     // An async function showing how to receive real-time events
 static async void ReceiveEvents(IAsyncStreamReader<EventLog> stream, CancellationToken token) {
   Console.WriteLine("Start receiving real-time events");

   try {
     while(await stream.MoveNext(token)) {
       var eventLog = stream.Current;
       Console.WriteLine("Event: {0}", eventLog);        
     }
   } catch (Exception e) {
     Console.WriteLine("Monitoring error: {0}", e);
   } finally {
     Console.WriteLine("Stop receiving real-time events");
   }
 }

Updated: