This SDK serves three purposes:
- Provide a streaming interface between cloud and frontend using grpc-web
- Provide a client integration with robotics services REST API
- Manage video streaming through Janus WebRTC server
Install (useful guide)
First, install Node Version Manager (nvm)
$ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
$ nvm install --lts
Second, install Yarn package manager
$ curl -o- -L https://yarnpkg.com/install.sh | bash
restart terminal or source ~/.bashrc
(on mac: source ~/.zshrc
)
Check whether you have the protobuf
packages installed (e.g., run protoc --version
). To install for Mac, run brew install protobuf@3
.
Then, build the stubs from the project root folder:
./protos/build-proto-browser.sh
First, compile the project:
$ yarn compile
To package the library, run:
$ yarn package