Installation

To write your applications in Node.js, you have to install the client library first.

API reference

G-SDK API

The common APIs defined using gRPC.

Node.js API

The language specific APIs to use the gRPC APIs.

Tutorials

In addition to the API reference, you can also refer to the following tutorials.

In some environments, you might fail to connect to the gateway while running the examples. To narrow down the connection issues, enable the gRPC debugging as below.

  $ export GRPC_VERBOSITY=DEBUG && GRPC_TRACE=all node quick.js

Quick Start Guide for Device Gateway

The guide will show you how to use the basic APIs for the device gateway in Node.js.

Connect API

To manage BioStar devices, you have to connect them to the gateway first. The tutorial will show you how to connect to the devices and configure the related options.

Quick Start Guide for Master Gateway

The guide will show you how to use the basic APIs for the master gateway in Node.js.

Connect Master API

With the master gateway, you have to connect to devices via device gateways. The tutorial will show you how to connect to the devices and configure the related options.

User API

The tutorial shows how to enroll users and add credentials to them. It also illustrates how to get the event logs with filters.

Event API

The tutorial shows how to get event logs from the devices.

T&A API

The tutorial shows how to configure and get the T&A events.

Door API

Door is the basic unit of access control. The tutorial shows how to configure doors and access groups.

Schedule API

Schedule is used for configuring access groups, actions, zones, etc. The tutorial shows how to configure weekly and daily schedules.

Trigger & Action API

The tutorial shows how to configure triggers and actions.

Thermal API

The tutorial shows how to configure the options related to the thermal camera.

Wiegand API

You have to configure Wiegand formats to interface with 3rd party readers or controllers. The tutorial shows how to configure two widely used formats.

Anti Passback API

The tutorial shows how to configure an anti passback zone consisting of devices connected by RS485.

Server API

The tutorial shows how to implement server matching.

Status API

With headless devices such as BioEntry W2, you can configure the LED and buzzer signals for specified status.

User Synchronization

This example shows how to synchronize user information between devices. You can also learn how to use realtime monitoring and XXX_Multi commands.

Updated: