Quick Start Guide for Device Gateway

Run the example

Install and run the device gateway
Download the C++ client library
Copy the root certificate of the gateway to your working directory. As default, the certificate(ca.crt) resides in cert of the installation directory.
The quick start example uses CMake. You can change the CMakeLists.txt file as needed.

Change the gateway and the device information in example/quick/main.cpp as needed.

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

 // the address of the gateway
 const std::string GATEWAY_ADDR = "192.168.0.2";
 const int GATEWAY_PORT = 4000;
    
 // the ip address of the target device
 const std::string DEVICE_IP = "192.168.0.110";
 const int DEVICE_PORT = 51211;
 const bool USE_SSL = false;

Build and run.
- Windows
```
cmake .
```
  Open quick.vcxproj in Visual Studio and build it.
```
./Debug/quick
```
- Linux
```
cmake .
make quick
./quick
```

1. Overview

You can use the services in the following steps.

Create a grpc::Channel and connect to the gateway.

 std::ifstream certFile(GATEWAY_CA_FILE);
 std::stringstream certBuf;
 certBuf << certFile.rdbuf();
    
 grpc::SslCredentialsOptions sslOpts;
 sslOpts.pem_root_certs = certBuf.str();
 auto channelCreds = grpc::SslCredentials(sslOpts);

 std::stringstream gatewayAddr;
 gatewayAddr << GATEWAY_ADDR << ":" << GATEWAY_PORT;

 grpc::Channel channel = grpc::CreateChannel(gatewayAddr.str(),  channelCreds);

Create a service stub such as Connect::Stub using the channel. For the available services and functions, please refer to the API reference.
```
 std::unique_ptr<Connect::Stub> stub = Connect::NewStub(channel)
```

Call the functions of the service using the client.

 ConnectRequest request;
 *request.mutable_connectinfo() = connInfo;

 ConnectResponse response;
 ClientContext context;

 Status status = stub->Connect(&context, request, &response);

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 gateway

The first thing to do is to connect to the device gateway and get a grpc::Channel, which will be used for further communication. You have to know the IP 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 {
public:
  GrpcClient() {}
  virtual ~GrpcClient() {}

  std::shared_ptr<Channel> GetChannel() {
    return channel_;
  } 

protected:
  std::shared_ptr<Channel> channel_;
};

class GatewayClient : public GrpcClient {
public:    
  bool Connect(std::string ipAddr, int port, std::string caFile);
};

bool GatewayClient::Connect(std::string ipAddr, int port, std::string caFile) {
  std::ifstream certFile(caFile);
  std::stringstream certBuf;
  certBuf << certFile.rdbuf();
  
  grpc::SslCredentialsOptions sslOpts;
  sslOpts.pem_root_certs = certBuf.str();
  auto channelCreds = grpc::SslCredentials(sslOpts);

  std::stringstream gatewayAddr;
  gatewayAddr << ipAddr << ":" << port;

  channel_ = grpc::CreateChannel(gatewayAddr.str(),  channelCreds);

  return channel_ != NULL;
}

Create the GatewayClient.

 auto gatewayClient = std::make_shared<GatewayClient>();

Connect to the gateway.

 gatewayClient->Connect(GATEWAY_ADDR, GATEWAY_PORT, GATEWAY_CA_FILE);

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 {
public:
  ConnectSvc(std::shared_ptr<Channel> channel)
      : stub_(Connect::NewStub(channel)) {}

private:
  std::unique_ptr<Connect::Stub> stub_;
};

Status ConnectSvc::Connect(ConnectInfo& connInfo, uint32_t* deviceID) {
  ConnectRequest request;
  *request.mutable_connectinfo() = connInfo;

  ConnectResponse response;
  ClientContext context;

  Status status = stub_->Connect(&context, request, &response);

  *deviceID = response.deviceid();

  return status;
}

Status ConnectSvc::GetDeviceList(RepeatedPtrField<DeviceInfo>* deviceInfos) {
  GetDeviceListRequest request;
  GetDeviceListResponse response;
  ClientContext context;

  Status status = stub_->GetDeviceList(&context, request, &response);

  *deviceInfos = response.deviceinfos();

  return status;
}

Status ConnectSvc::Disconnect(std::vector<uint32_t>& deviceIDs) {
  DisconnectRequest request;
  for(int i = 0; i < deviceIDs.size(); i++) {
    request.add_deviceids(deviceIDs[i]);
  }

  DisconnectResponse response;
  ClientContext context;

  Status status = stub_->Disconnect(&context, request, &response);

  return status;
}  

Create the ConnectSvc. It makes the Connect::Stub internally.

 std::shared_ptr<ConnectSvc> connectSvc = std::make_shared<ConnectSvc>(gatewayClient->GetChannel());

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;
 connInfo.set_ipaddr(ipAddr);
 connInfo.set_port(port);
 connInfo.set_usessl(useSSL);

 uint32_t deviceID = 0;
 Status status = connectSvc->Connect(connInfo, &deviceID);

Get the devices, which are managed by the gateway.

 RepeatedPtrField<DeviceInfo> deviceInfos;
 Status status = connectSvc->GetDeviceList(&deviceInfos);

Disconnect the device.
```
 connectSvc->Disconnect(deviceIDs);
```

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 {
public:
  DeviceSvc(std::shared_ptr<Channel> channel)
    : stub_(Device::NewStub(channel)) {}

private:
  std::unique_ptr<Device::Stub> stub_;
};

Status DeviceSvc::GetInfo(uint32_t deviceID, FactoryInfo* info) {
  GetInfoRequest request;
  request.set_deviceid(deviceID);

  GetInfoResponse response;
  ClientContext context;

  Status status = stub_->GetInfo(&context, request, &response);

  *info = response.info();

  return status;
}

Status DeviceSvc::GetCapabilityInfo(uint32_t deviceID, CapabilityInfo* info) {
  GetCapabilityInfoRequest request;
  request.set_deviceid(deviceID);

  GetCapabilityInfoResponse response;
  ClientContext context;

  Status status = stub_->GetCapabilityInfo(&context, request, &response);

  *info = response.capinfo();

  return status;
}

Create the DeviceSvc. It makes the Device::Stub internally.
```
 DeviceSvc deviceSvc(client->GetChannel());
```

Get the version information of the device.

 FactoryInfo devInfo;
 Status status = deviceSvc.GetInfo(deviceID, &devInfo);

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;
 Status status = deviceSvc.GetCapabilityInfo(deviceID, &capInfo);
```

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 {
public:
  FingerSvc(std::shared_ptr<Channel> channel)
    : stub_(Finger::NewStub(channel)) {}

private:
  std::unique_ptr<Finger::Stub> stub_;
};

Status FingerSvc::Scan(uint32_t deviceID, TemplateFormat templateFormat, uint32_t threshold, std::string& templateData) {
  ScanRequest request;
  request.set_deviceid(deviceID);
  request.set_templateformat(templateFormat);
  request.set_qualitythreshold(threshold);

  ScanResponse response;
  ClientContext context;

  Status status = stub_->Scan(&context, request, &response);

  templateData = response.templatedata();

  return status;
}

Status FingerSvc::GetImage(uint32_t deviceID, std::string& bmpImage) {
  GetImageRequest request;
  request.set_deviceid(deviceID);

  GetImageResponse response;
  ClientContext context;

  Status status = stub_->GetImage(&context, request, &response);

  bmpImage = response.bmpimage(); 

  return status;
}

Status FingerSvc::GetConfig(uint32_t deviceID, FingerConfig* config) {
  GetConfigRequest request;
  request.set_deviceid(deviceID);

  GetConfigResponse response;
  ClientContext context;

  Status status = stub_->GetConfig(&context, request, &response);

  *config = response.config(); 

  return status;
}	

Create the FingerSvc. It makes the Finger::Stub internally.
```
 FingerSvc fingerSvc(client->GetChannel());
```

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

 std::string templateData;
 Status status = fingerSvc.Scan(deviceID, finger::TEMPLATE_FORMAT_SUPREMA, QUALITY_THRESHOLD, templateData);

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

 std::string bmpImage;
 status = fingerSvc.GetImage(deviceID, bmpImage);

 std::ofstream bmpFile(FINGERPRINT_IMAGE_NAME, std::ios::binary);
 bmpFile.write(bmpImage.data(), bmpImage.size());
 bmpFile.close();    

Get the fingerprint configuration. To change some of its options, call Finger.SetConfig.
```
 FingerConfig config;
 status = fingerSvc.GetConfig(deviceID, &config);
```

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 {
public:
  CardSvc(std::shared_ptr<Channel> channel)
    : stub_(Card::NewStub(channel)) {}

private:
  std::unique_ptr<Card::Stub> stub_;
};

Status CardSvc::Scan(uint32_t deviceID, CardData* cardData) {
  ScanRequest request;
  request.set_deviceid(deviceID);

  ScanResponse response;
  ClientContext context;

  Status status = stub_->Scan(&context, request, &response);

  *cardData = response.carddata();

  return status;
}

Status CardSvc::GetBlacklist(uint32_t deviceID, RepeatedPtrField<BlacklistItem>* blacklist) {
  GetBlacklistRequest request;
  request.set_deviceid(deviceID);

  GetBlacklistResponse response;
  ClientContext context;

  Status status = stub_->GetBlacklist(&context, request, &response);

  *blacklist = response.blacklist();

  return status;    
}

Status CardSvc::AddBlacklist(uint32_t deviceID, RepeatedPtrField<BlacklistItem>* cardInfos) {
  AddBlacklistRequest request;
  request.set_deviceid(deviceID);
  *request.mutable_cardinfos() = *cardInfos;

  AddBlacklistResponse response;
  ClientContext context;

  Status status = stub_->AddBlacklist(&context, request, &response);

  return status;    
}  

Status CardSvc::DeleteBlacklist(uint32_t deviceID, RepeatedPtrField<BlacklistItem>* cardInfos) {
  DeleteBlacklistRequest request;
  request.set_deviceid(deviceID);
  *request.mutable_cardinfos() = *cardInfos;

  DeleteBlacklistResponse response;
  ClientContext context;

  Status status = stub_->DeleteBlacklist(&context, request, &response);

  return status;    
}  

Create the CardSvc. It makes the Card::Stub internally.
```
 CardSvc cardSvc(client->GetChannel());
```

Scan a card.

 CardData cardData;
 Status status = cardSvc.Scan(deviceID, &cardData);

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

 // Get the current blacklist
 RepeatedPtrField<BlacklistItem> blacklist;
 status = cardSvc.GetBlacklist(deviceID, &blacklist);

 // Add new items into the blacklist
 RepeatedPtrField<BlacklistItem> cardInfos;
 for(int i = 0; i < NUM_OF_BLACKLIST_ITEM; i++) {
   BlacklistItem cardInfo;
   *cardInfo.mutable_cardid() = std::to_string(FIRST_BLACKLISTED_CARD_ID + i);
   cardInfo.set_issuecount(ISSUE_COUNT);

   cardInfos.Add(std::forward<BlacklistItem>(cardInfo));
 }

 status = cardSvc.AddBlacklist(deviceID, &cardInfos);

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 {
public:
  UserSvc(std::shared_ptr<Channel> channel)
      : stub_(User::NewStub(channel)) {}

private:
  std::unique_ptr<User::Stub> stub_;
};

Status UserSvc::GetList(uint32_t deviceID, RepeatedPtrField<UserHdr>* userList) {
  GetListRequest request;
  request.set_deviceid(deviceID);

  GetListResponse response;
  ClientContext context;

  Status status = stub_->GetList(&context, request, &response);

  *userList = response.hdrs();

  return status;
}

Status UserSvc::GetUser(uint32_t deviceID, RepeatedPtrField<std::string>* userIDs, RepeatedPtrField<UserInfo>* userInfos) {
  GetRequest request;
  request.set_deviceid(deviceID);
  *request.mutable_userids() = *userIDs;

  GetResponse response;
  ClientContext context;

  Status status = stub_->Get(&context, request, &response);

  *userInfos = response.users();

  return status;
}

Status UserSvc::Enroll(uint32_t deviceID, RepeatedPtrField<UserInfo>& userInfos) {
  EnrollRequest request;
  request.set_deviceid(deviceID);
  *request.mutable_users() = userInfos;

  EnrollResponse response;
  ClientContext context;

  Status status = stub_->Enroll(&context, request, &response);

  return status;
}

Status UserSvc::SetFinger(uint32_t deviceID, RepeatedPtrField<UserFinger>& userFingers) {
  SetFingerRequest request;
  request.set_deviceid(deviceID);
  *request.mutable_userfingers() = userFingers;

  SetFingerResponse response;
  ClientContext context;

  Status status = stub_->SetFinger(&context, request, &response);

  return status;
}

Status UserSvc::Delete(uint32_t deviceID, std::vector<std::string> &userIDs) {
  DeleteRequest request;
  request.set_deviceid(deviceID);
  for(int i = 0; i < userIDs.size(); i++) {
    request.add_userids(userIDs[i]);
  }    
  
  DeleteResponse response;
  ClientContext context;

  Status status = stub_->Delete(&context, request, &response);

  return status;    
}

Create the UserSvc. It makes the User::Stub internally.
```
 UserSvc userSvc(client->GetChannel());
```

Get the user list and detailed information.

 // Get the user list
 RepeatedPtrField<UserHdr> userList;
 Status status = userSvc.GetList(deviceID, &userList);

 // Extract user IDs from the list
 RepeatedPtrField<std::string> userIDs;

 for(int i = 0; i < userList.size(); i++) {
   std::cout << userList[i].ShortDebugString() << std::endl;

   userIDs.Add((std::string)(userList[i].id())); 
 }

 // Get the user information with the user IDs
 RepeatedPtrField<UserInfo> userInfos;
 status = userSvc.GetUser(deviceID, &userIDs, &userInfos)

Enroll new users.

 RepeatedPtrField<UserInfo> newUserInfos;
 std::vector<std::string> newUserIDs;

 srand(time(NULL));

 for(int i = 0; i < NUM_OF_NEW_USER; i++) {
   UserInfo userInfo;

   std::string userID = std::to_string(rand());
   *userInfo.mutable_hdr()->mutable_id() = userID;
      
   newUserInfos.Add(std::forward<UserInfo>(userInfo));
   newUserIDs.push_back(userID);
 }

 status = userSvc.Enroll(deviceID, newUserInfos);

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

 FingerData fingerData;

 std::cout << ">>> Scan a finger for " << userID << std::endl;
 std::string templateData;

 status = fingerSvc.Scan(deviceID, finger::TEMPLATE_FORMAT_SUPREMA, QUALITY_THRESHOLD, templateData);

 fingerData.add_templates(templateData);

 std::cout << ">>> Scan the same finger for " << userID << std::endl;

 status = fingerSvc.Scan(deviceID, finger::TEMPLATE_FORMAT_SUPREMA, QUALITY_THRESHOLD, templateData);

 fingerData.add_templates(templateData);  

 RepeatedPtrField<UserFinger> userFingers;
    
 UserFinger userFinger;
 userFinger.set_userid(userID);
 userFinger.mutable_fingers()->Add(std::forward<FingerData>(fingerData));

 userFingers.Add(std::forward<UserFinger>(userFinger));

 status = userSvc.SetFinger(deviceID, userFingers);

Delete new users.

 status = 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 {
public:
  EventSvc(std::shared_ptr<Channel> channel)
      : stub_(Event::NewStub(channel)) {}

  std::unique_ptr<ClientReader<EventLog>> Subscribe(ClientContext* context, int queueSize);

private:
  std::unique_ptr<Event::Stub> stub_;
};

Status EventSvc::GetLog(uint32_t deviceID, int startEventID, int maxNumOfLog, RepeatedPtrField<EventLog>* events) {
  GetLogRequest request;
  request.set_deviceid(deviceID);
  request.set_starteventid(startEventID);
  request.set_maxnumoflog(maxNumOfLog);

  GetLogResponse response;
  ClientContext context;

  Status status = stub_->GetLog(&context, request, &response);

  *events = response.events();

  return status;
}

Status EventSvc::GetImageLog(uint32_t deviceID, int startEventID, int maxNumOfLog, RepeatedPtrField<ImageLog>* events) {
  GetImageLogRequest request;
  request.set_deviceid(deviceID);
  request.set_starteventid(startEventID);
  request.set_maxnumoflog(maxNumOfLog);

  GetImageLogResponse response;
  ClientContext context;

  Status status = stub_->GetImageLog(&context, request, &response);

  *events = response.imageevents();

  return status;
}

Status EventSvc::EnableMonitoring(uint32_t deviceID) {
  EnableMonitoringRequest request;
  request.set_deviceid(deviceID);

  EnableMonitoringResponse response;
  ClientContext context;

  Status status = stub_->EnableMonitoring(&context, request, &response);

  return status;
}

Status EventSvc::DisableMonitoring(uint32_t deviceID) {
  DisableMonitoringRequest request;
  request.set_deviceid(deviceID);

  DisableMonitoringResponse response;
  ClientContext context;

  Status status = stub_->DisableMonitoring(&context, request, &response);

  return status;
}

std::unique_ptr<ClientReader<EventLog>> EventSvc::Subscribe(ClientContext* context, int queueSize) {
  SubscribeRealtimeLogRequest request;
  request.set_queuesize(queueSize);

  return stub_->SubscribeRealtimeLog(context, request);
}

Create the EventSvc. It makes the Event::Stub internally.
```
 EventSvc eventSvc(client->GetChannel());
```

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

 RepeatedPtrField<EventLog> events;
 Status status = eventSvc.GetLog(deviceID, START_EVENT_ID, MAX_NUM_OF_LOG, &events);

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.

 RepeatedPtrField<ImageLog> imageEvents;
 status = eventSvc.GetImageLog(deviceID, START_EVENT_ID, MAX_NUM_OF_IMAGE_LOG, &imageEvents);

 if(imageEvents.size() > 0) {
   std::ofstream jpgFile(IMAGE_LOG_FILE, std::ios::binary);
   jpgFile.write(imageEvents[0].jpgimage().data(), imageEvents[0].jpgimage().size());
   jpgFile.close();
 }    

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

 // Enable monitoring of the device
 status = eventSvc.EnableMonitoring(deviceID);

 ClientContext context;
 std::unique_ptr<ClientReader<EventLog>> eventReader(eventSvc.Subscribe(&context, EVENT_QUEUE_SIZE));

 int numOfRealtimeEvents = 0;

 std::cout << std::endl << ">>> Generate " << NUM_OF_REALTIME_LOG << " realtime events..." << std::endl;

 EventLog realtimeEvent;

 while(numOfRealtimeEvents < NUM_OF_REALTIME_LOG) {
   if(!eventReader->Read(&realtimeEvent)) {
     std::cerr << "Cannot receive realtime events!" << std::endl;
     break;
   }

   std::cout << realtimeEvent.ShortDebugString() << std::endl;

   numOfRealtimeEvents++;
 }

 context.TryCancel();
 eventReader->Finish();
 eventSvc.DisableMonitoring(deviceID); 