Vuforia Spatial Edge Server

The Spatial Edge Server is the backbone of the Vuforia Toolbox system. Every device in the system, from an iPhone to an industrial robot arm, will run an instance of this server. This README outlines how to install the server on larger scale devices with command line access like laptops or desktops. Running on embedded devices may require more preparation. App-specific documentation can be found in the Vuforia Toolbox iOS or Vuforia Toolbox Android repositories.

Read First

The Vuforia Spatial Toolbox and Vuforia Spatial Edge Server make up a shared research platform for exploring spatial computing as a community. This research platform is not an out of the box production-ready enterprise solution. Please read the MPL 2.0 license before use.

Join the conversations in our discourse forum if you have questions, ideas want to collaborate or just say hi.

Installation

First, install Node.js. We currently test our software on Node 12, 14, 16, and 18 with 16 being our recommended platform.

Second, clone this repository into your desired directory:

git clone https://github.com/ptcrealitylab/vuforia-spatial-edge-server.git

Next, enter the vuforia-toolbox-server directory and install all dependencies.

cd vuforia-spatial-edge-server
npm install

Now, initialize the core add-on git submodule and install its dependencies.

git submodule update --init --recursive
cd addons/vuforia-spatial-core-addon
npm install
cd ../.. # return to the main vuforia-toolbox-server directory

Finally, configure and generate a local self-signed certificate.

cp scripts/cert.conf.template scripts/cert.conf
# edit scripts/cert.conf to include your local ip address if desired
vim scripts/cert.conf
./scripts/generate_cert.sh or ./scripts/generate_cert.ps1 (for windows)

If desired, you can now add this certificate (cert.pem) to your local trusted certificate store (e.g. Keychain on macOS) to not have to manually add it to each browser's cert store. For more information on trusting on iOS, see this guide

You can now run the server using the following command:

npm start

Contributing

We highly encourage you to contribute any code changes by making pull requests on GitHub. Fork this repository using the button on the top right, make and commit your changes, then GitHub will prompt you to make a pull request.

Automated Tests

Note that we do run some automated testing to ensure that our code remains consistently styled and functional. If you want to see the results of this testing locally, you can follow this Github Actions workflow.

git clone --recurse-submodules https://github.com/ptcrealitylab/vuforia-spatial-edge-server.git
cd vuforia-spatial-edge-server
./scripts/ci.sh

The most important parts of the workflow are running the commands of scripts/ci.sh to setup (note that some repos may not be available, causing test failures locally). After this, you can run tests using the following command in your vuforia-toolbox-server folder:

npm run test

The changes and untracked files in the spatialToolbox data folder added by scripts/ci.sh must be reset in between tests. To do so, run the following:

cd spatialToolbox && git reset --hard HEAD && git clean -fd && cd ..

Debugging

If you encounter a problem while developing, you can specify the LOG_MODULES or LOG_LEVEL environment variables. LOG_MODULES will filter debug logs to a specific file or directory. LOG_LEVEL will set the minimum console level to be logged. For example, on Mac/Linux the following command will only print log messages that originate from hardware interfaces:

LOG_MODULES=interfaces node index.js

This command hides all console messages except for those made using console.error:

LOG_LEVEL=error node index.js

This command would limit messages to the gitInterface.js and envelope.js files:

LOG_MODULES=gitInterface,envelope node index.js

LOG_MODULES is a list of comma-separated file names, folder names, or keywords that are checked against each log message's originating file's path.

Windows

To specify environmental variables like LOG_MODULES and LOG_LEVEL use the following in PowerShell:

$env:LOG_MODULES="interfaces"
node index.js

Specifying Services

This is an advanced option, not meant for general use at this point in time.

To specify a list of services that will be included in the heartbeats sent from this server, run the command like so:

node server.js --services world service2 service3

The world service in particular is used to request that scans for new World Objects get sent to this server rather than other servers on the local network that do not specify this service (by default, all servers have the same priority and the user must choose among them).

Additional Server Addons

There are several useful server addons that we do not include in the base server. For example, installing the include the edge agent and remote operator addons will enable your server to act as a standalone remote operator host behind our cloud proxy. Note that the edge agent addon is currently private but will be open-sourced soon.

For each addon you want to install follow these steps, substituting the github url as necessary:

cd addons
git clone https://github.com/ptcrealitylab/vuforia-spatial-remote-operator-addon
git clone [email protected]:ptcrealitylab/vuforia-spatial-edge-agent-addon
cd vuforia-spatial-remote-operator-addon
npm install
cd .. # return to the addons directory
cd vuforia-spatial-edge-agent-addon
npm install