Quick Start Guide for Device Gateway

Run the example

1. Install and run the device gateway
2. Download the Java 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 Gradle for its project. You can change the build.gradle file as needed.

5. Change the gateway and the device information in src/main/java/com/supremainc/sdk/example/quick/QuickStart.java as needed.

    // the path of the root certificate
    private static final String GATEWAY_CA_FILE = "cert/gateway/ca.crt";
   
    // the address of the gateway
    private static final String GATEWAY_ADDR = "192.168.0.2";
    private static final int GATEWAY_PORT = 4000;
   
    // the ip address of the target device
    private static final String DEVICE_ADDR = "192.168.0.110"; 
    private static final int DEVICE_PORT = 51211;
   

6. Build.

    ./gradlew installDist
   

7. Run.

    ./build/install/java/bin/quickStart
   

1. Overview

You can use the G-SDK services in the following steps.

1. Connect to the gateway and get a ManagedChannel.

    ManagedChannel channel = NettyChannelBuilder.forAddress(serverAddr, serverPort)
    .sslContext(GrpcSslContexts.forClient().trustManager(new File(certFile)).build())
    .build();
   

2. Create a service stub such as ConnectGrpc.ConnectBlockingStub using the channel. For the available services and functions, please refer to the API reference.

    ConnectGrpc.ConnectBlockingStub connectStub = ConnectGrpc.newBlockingStub(channel);
   

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

    ConnectInfo connInfo = ConnectInfo.newBuilder().setIPAddr(deviceIP).setPort(devicePort).setUseSSL(useSSL).build();
    ConnectRequest request = ConnectRequest.newBuilder().setConnectInfo(connInfo).build();
    ConnectResponse response = connectStub.connect(request);
   

The classes of com.supremainc.sdk.example.* 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 ManagedChannel, 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
public class GrpcClient {
  private ManagedChannel channel;

  public ManagedChannel getChannel() {
    return channel;
  }
}

public class GatewayClient extends GrpcClient {  // certFile is the pathname of the root certificate
  public void connect(String certFile, String gatewayAddr, int gatewayPort) throws Exception {
    channel = NettyChannelBuilder.forAddress(gatewayAddr, gatewayPort)
    .sslContext(GrpcSslContexts.forClient().trustManager(new File(certFile)).build())
    .build();
  }
}

1. Create the GatewayClient.

    GatewayClient client = new GatewayClient();
   

2. Connect to the gateway.

    try {
      client.connect(GATEWAY_CA_FILE, GATEWAY_ADDR, GATEWAY_PORT);
    } catch (Exception e) {
      System.out.printf("Cannot connect to the device gateway: %s", e); 
      System.exit(-1);
    }
   

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
public class ConnectSvc {
  private final ConnectGrpc.ConnectBlockingStub connectStub;

  public ConnectSvc(ConnectGrpc.ConnectBlockingStub stub) {
    connectStub = stub;
  }

  public List<DeviceInfo> getDeviceList() throws Exception {
    GetDeviceListRequest request = GetDeviceListRequest.newBuilder().build();
    GetDeviceListResponse response;
    
    response = connectStub.getDeviceList(request);
    return response.getDeviceInfosList();
  } 

  public int connect(ConnectInfo connInfo) throws Exception {
    ConnectRequest request = ConnectRequest.newBuilder().setConnectInfo(connInfo).build();
    ConnectResponse response = connectStub.connect(request);

    return response.getDeviceID();
  }

  public void disconnect(int deviceID) throws Exception {
    DisconnectRequest request = DisconnectRequest.newBuilder().addDeviceIDs(deviceID).build();
    DisconnectResponse response = connectStub.disconnect(request);
  }
}

1. Create the ConnectSvc. It makes the ConnectGrpc.ConnectBlockingStub internally.

    ConnectSvc connectSvc = new ConnectSvc(ConnectGrpc.newBlockingStub(client.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.

    ConnectInfo connInfo = ConnectInfo.newBuilder().setIPAddr(deviceAddr).setPort(devicePort).setUseSSL(useSSL).build();
   
    int deviceID = connectSvc.connect(connInfo);    
   

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

    List<DeviceInfo> devInfo = connectSvc.getDeviceList(); 
   

4. Disconnect the device.

    connectSvc.disconnect(deviceID);
   

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
public class DeviceSvc {
  private final DeviceGrpc.DeviceBlockingStub deviceStub;

  public DeviceSvc(DeviceGrpc.DeviceBlockingStub stub) {
    deviceStub = stub;
  }

  public FactoryInfo getInfo(int deviceID) throws Exception {
    GetInfoRequest request = GetInfoRequest.newBuilder().setDeviceID(deviceID).build();
    GetInfoResponse response;

    response = deviceStub.getInfo(request);
    return response.getInfo();
  } 

  public CapabilityInfo getCapabilityInfo(int deviceID) throws Exception {
    GetCapabilityInfoRequest request = GetCapabilityInfoRequest.newBuilder().setDeviceID(deviceID).build();
    GetCapabilityInfoResponse response;

    response = deviceStub.getCapabilityInfo(request);
    return response.getCapInfo();
  } 
}

1. Create the DeviceSvc. It makes the DeviceGrpc.DeviceBlockingStub internally.

    DeviceSvc deviceSvc = new DeviceSvc(DeviceGrpc.newBlockingStub(client.getChannel())); 
   

2. Get the version information of the device.

    FactoryInfo versionInfo = 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.

    CapabilityInfo 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
public class FingerSvc {
  private final FingerGrpc.FingerBlockingStub fingerStub;

  public FingerSvc(FingerGrpc.FingerBlockingStub stub) {
    fingerStub = stub;
  }

  public ByteString scan(int deviceID, TemplateFormat templateFormat, int qualityThreshold) throws Exception {
    ScanRequest request = ScanRequest.newBuilder().setDeviceID(deviceID).setTemplateFormat(templateFormat).setQualityThreshold(qualityThreshold).build();
    ScanResponse response = fingerStub.scan(request);

    return response.getTemplateData();
  } 

  public ByteString getImage(int deviceID) throws Exception {
    GetImageRequest request = GetImageRequest.newBuilder().setDeviceID(deviceID).build();
    GetImageResponse response = fingerStub.getImage(request);

    return response.getBMPImage();
  }  

  public FingerConfig getConfig(int deviceID) throws Exception {
    GetConfigRequest request = GetConfigRequest.newBuilder().setDeviceID(deviceID).build();
    GetConfigResponse response = fingerStub.getConfig(request);

    return response.getConfig();
  }
}

1. Create the FingerSvc. It makes the FingerGrpc.FingerBlockingStub internally.

    FingerSvc fingerSvc = new FingerSvc(FingerGrpc.newBlockingStub(client.getChannel())); 
   

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

    ByteString templateData = ingerSvc.scan(deviceID, TemplateFormat.TEMPLATE_FORMAT_SUPREMA, QUALITY_THRESHOLD);
   

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

    byte[] bmpImage = fingerSvc.getImage(deviceID).toByteArray();;
    FileOutputStream bmpFile = new FileOutputStream(FINGERPRINT_IMAGE_FILE);
    bmpFile.write(bmpImage);
    bmpFile.close();
   

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

    FingerConfig 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
public class CardSvc {
  private final CardGrpc.CardBlockingStub cardStub;

  public CardSvc(CardGrpc.CardBlockingStub stub) {
    cardStub = stub;
  }

  public CardData scan(int deviceID) throws Exception {
    ScanRequest request = ScanRequest.newBuilder().setDeviceID(deviceID).build();
    ScanResponse response = cardStub.scan(request);

    return response.getCardData();
  } 

  public List<BlacklistItem> getBlacklist(int deviceID) throws Exception {
    GetBlacklistRequest request = GetBlacklistRequest.newBuilder().setDeviceID(deviceID).build();
    GetBlacklistResponse response = cardStub.getBlacklist(request);

    return response.getBlacklistList();
  }

  public void addBlacklist(int deviceID, List<BlacklistItem> cardInfos) throws Exception {
    AddBlacklistRequest request = AddBlacklistRequest.newBuilder().setDeviceID(deviceID).addAllCardInfos(cardInfos).build();
    cardStub.addBlacklist(request);
  }

  public void deleteBlacklist(int deviceID, List<BlacklistItem> cardInfos) throws Exception {
    DeleteBlacklistRequest request = DeleteBlacklistRequest.newBuilder().setDeviceID(deviceID).addAllCardInfos(cardInfos).build();
    cardStub.deleteBlacklist(request);
  }
}

1. Create the CardSvc. It makes the CardGrpc.CardBlockingStub internally.

    CardSvc cardSvc = new CardSvc(CardGrpc.newBlockingStub(client.getChannel())); 
   

2. Scan a card.

    CardData 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
    List<BlacklistItem> blacklist = cardSvc.getBlacklist(deviceID);
   
    // Add new items into the blacklist
    List<BlacklistItem> newBlacklist = new ArrayList<BlacklistItem>();
   
    for(int i = 0; i < NUM_OF_BLACKLIST_ITEM; i++) {
      BlacklistItem item = BlacklistItem.newBuilder().setCardID(ByteString.copyFromUtf8(Integer.toString(FIRST_BLACKLISTED_CARD_ID + i))).setIssueCount(ISSUE_COUNT).build();
      newBlacklist.add(item);
    }
   
    cardSvc.addBlacklist(deviceID, newBlacklist);
   

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
public class UserSvc {
  private final UserGrpc.UserBlockingStub userStub;

  public UserSvc(UserGrpc.UserBlockingStub stub) {
    userStub = stub;
  }

  public List<UserHdr> getList(int deviceID) throws Exception {
    GetListRequest request = GetListRequest.newBuilder().setDeviceID(deviceID).build();
    GetListResponse response = userStub.getList(request);

    return response.getHdrsList();
  } 

  public List<UserInfo> getUser(int deviceID, List<String> userIDs) throws Exception {
    GetRequest request = GetRequest.newBuilder().setDeviceID(deviceID).addAllUserIDs(userIDs).build();
    GetResponse response = userStub.get(request);

    return response.getUsersList();
  }

  public void enroll(int deviceID, List<UserInfo> users) throws Exception {
    EnrollRequest request = EnrollRequest.newBuilder().setDeviceID(deviceID).addAllUsers(users).build();
    EnrollResponse response = userStub.enroll(request);
  }

  public void delete(int deviceID, List<String> userIDs) throws Exception {
    DeleteRequest request = DeleteRequest.newBuilder().setDeviceID(deviceID).addAllUserIDs(userIDs).build();
    DeleteResponse response = userStub.delete(request);
  }

  public void setFinger(int deviceID, List<UserFinger> userFingers) throws Exception {
    SetFingerRequest request = SetFingerRequest.newBuilder().setDeviceID(deviceID).addAllUserFingers(userFingers).build();
    SetFingerResponse response = userStub.setFinger(request);
  }
}

1. Create the UserSvc. It makes the UserGrpc.UserBlockingStub internally.

    UserSvc userSvc = new UserSvc(UserGrpc.newBlockingStub(client.getChannel())); 
   

2. Get the user list and detailed information.

    // Get the user list
    List<UserHdr> userHdrs = userSvc.getList(deviceID);
   
    // Extract user IDs from the list
    List<String> userIDs = new ArrayList<String>();
    ListIterator<UserHdr> hdrIter = userHdrs.listIterator();
   
    while(hdrIter.hasNext()) {
      userIDs.add(hdrIter.next().getID());
    }
   
    // Get the user information with the user IDs
    List<UserInfo> userInfos = userSvc.getUser(deviceID, userIDs);
   

3. Enroll new users.

    List<UserInfo> newUsers = new ArrayList<UserInfo>();
    List<String> newUserIDs = new ArrayList<String>();
   
    for(int i = 0; i < NUM_OF_NEW_USER; i++) {
      UserHdr hdr = UserHdr.newBuilder().setID(String.format("%d", (int)(Math.random() * Integer.MAX_VALUE))).build();
      newUsers.add(UserInfo.newBuilder().setHdr(hdr).build());
      newUserIDs.add(hdr.getID());
    }
   
    userSvc.enroll(deviceID, newUsers);
   

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

    List<UserFinger> userFingers = new ArrayList<UserFinger>();
       
    // Scan the first fingerprint
    byte[] firstTemplate = fingerSvc.scan(deviceID, TemplateFormat.TEMPLATE_FORMAT_SUPREMA, QUALITY_THRESHOLD);
   
    // Scan the second fingerprint of the same finger
    byte[] secondTemplate = fingerSvc.scan(deviceID, TemplateFormat.TEMPLATE_FORMAT_SUPREMA, QUALITY_THRESHOLD);
   
    FingerData fingerData = FingerData.newBuilder().setIndex(0).setFlag(0).addTemplates(ByteString.copyFrom(firstTemplate)).addTemplates(ByteString.copyFrom(secondTemplate)).build();
    userFingers.add(UserFinger.newBuilder().setUserID(userID).addFingers(fingerData).build());
   
    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
public class EventSvc {
  private final EventGrpc.EventBlockingStub eventStub;
  private CancellableContext monitoringCtx;

  public EventSvc(EventGrpc.EventBlockingStub stub) {
    eventStub = stub;
    monitoringCtx = null;
  }

  public void setCancellableContext(CancellableContext ctx) {
    monitoringCtx = ctx;
  }

  public EventGrpc.EventBlockingStub getStub() {
    return eventStub;
  }

  public List<EventLog> getLog(int deviceID, int startEventID, int maxNumOfLog) throws Exception {
    GetLogRequest request = GetLogRequest.newBuilder().setDeviceID(deviceID).setStartEventID(startEventID).setMaxNumOfLog(maxNumOfLog).build();
    GetLogResponse response;

    response = eventStub.getLog(request);
    return response.getEventsList();
  } 

  public List<ImageLog> getImageLog(int deviceID, int startEventID, int maxNumOfLog) throws Exception {
    GetImageLogRequest request = GetImageLogRequest.newBuilder().setDeviceID(deviceID).setStartEventID(startEventID).setMaxNumOfLog(maxNumOfLog).build();
    GetImageLogResponse response;

    response = eventStub.getImageLog(request);
    return response.getImageEventsList();
  } 

  public void startMonitoring(int deviceID) throws Exception {
    EnableMonitoringRequest enableRequest = EnableMonitoringRequest.newBuilder().setDeviceID(deviceID).build();
    eventStub.enableMonitoring(enableRequest);

    new Thread(new EventMonitoring(this, deviceID)).start();
  }

  public void stopMonitoring(int deviceID) throws Exception {
    DisableMonitoringRequest disableRequest = DisableMonitoringRequest.newBuilder().setDeviceID(deviceID).build();
    eventStub.disableMonitoring(disableRequest);

    if(monitoringCtx != null) {
      monitoringCtx.cancel(null);
    }
  }
}

1. Create the EventSvc. It makes the EventGrpc.EventBlockingStub internally.

    EventSvc eventSvc = new EventSvc(EventGrpc.newBlockingStub(client.getChannel()));
   

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

    List<EventLog> 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.

    List<ImageLog> imageEvents = eventSvc.getImageLog(deviceID, 0, MAX_NUM_OF_IMAGE_LOG);
   
    if(imageEvents.size() > 0) {
      FileOutputStream jpgFile = new FileOutputStream(LOG_IMAGE_FILE);
      jpgFile.write(imageEvents.get(0).getJPGImage().toByteArray());
      jpgFile.close();      
    }
   

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

    // Enable monitoring of the device
    EnableMonitoringRequest enableRequest = EnableMonitoringRequest.newBuilder().setDeviceID(deviceID).build();
    eventStub.enableMonitoring(enableRequest);
   
    // Start monitoring thread for receiving events asynchronously
    eventSvc.startMonitoring(deviceID);
   

    // A utility class for showing how to receive real-time events
    class EventMonitoring implements Runnable {
      private static final int MONITORING_QUEUE_SIZE = 8;
   
      private final EventSvc eventSvc;
      private final int deviceID;
   
      public EventMonitoring(EventSvc svc, int devID) {
        eventSvc = svc;
        deviceID = devID;
      }
   
      public void run() {
        CancellableContext monitoringCtx = Context.current().withCancellation();
        Context prevCtx = monitoringCtx.attach();
   
        eventSvc.setCancellableContext(monitoringCtx);
   
        try {
          SubscribeRealtimeLogRequest subscribeRequest = SubscribeRealtimeLogRequest.newBuilder().setQueueSize(MONITORING_QUEUE_SIZE).addDeviceIDs(deviceID).build();
          Iterator<EventLog> eventStream = eventSvc.getStub().subscribeRealtimeLog(subscribeRequest);
   
          System.out.println("Start receiving real-time events");
   
          while(eventStream.hasNext()) {
            EventLog eventLog = eventStream.next();
            System.out.printf("Event: %s\n", eventLog);
          }
        } catch(Exception e) {
          System.out.printf("Monitoring error: %s\n", e);
        } finally {
          monitoringCtx.detach(prevCtx);
        }
      }
    }