Skip to content

Commit

Permalink
change root folder to spatialToolbox
Browse files Browse the repository at this point in the history
  • Loading branch information
valentinptc committed Mar 7, 2020
1 parent 9ded123 commit 1002306
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 19 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Vuforia Spatial Edge Server

The Spatial Edge Server is the backbone of the Vuforia Toolbox system. Every
The Spatial Edge Server is the backbone of the Vuforia Spatial 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](https://github.com/ptcrealitylab/vuforia-toolbox-ios) or [Vuforia Toolbox
Android](https://github.com/ptcrealitylab/vuforia-toolbox-android)
can be found in the [Vuforia Spatial Toolbox
iOS](https://github.com/ptcrealitylab/vuforia-spatial-toolbox-ios) or [Vuforia Spatial Toolbox
Android](https://github.com/ptcrealitylab/vuforia-spatial-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](LICENSE) before use.
The Vuforia Spatial 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](LICENSE) before use.

Join the conversations in our [discourse forum](https://forum.spatialtoolbox.vuforia.com) if you have questions, ideas want to collaborate or just say hi.

Expand All @@ -24,13 +24,13 @@ software on Node 6, 8, and 10 with 10 being our recommended platform.
Second, clone this repository into your desired directory:

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

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

```bash
cd vuforia-toolbox-server
cd vuforia-spatial-edge-server
npm install
```

Expand All @@ -42,7 +42,7 @@ cd addons
git clone https://github.com/ptcrealitylab/vuforia-spatial-core-addon
cd vuforia-spatial-core-addon
npm install
cd ../.. # return to the main vuforia-toolbox-server directory
cd ../.. # return to the main vuforia-spatial-edge-server directory
```

You can now run the server using the following command:
Expand All @@ -60,7 +60,7 @@ 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, run the following command in your vuforia-toolbox-server
testing locally, run the following command in your vuforia-spatial-edge-server
folder:

```bash
Expand Down
2 changes: 1 addition & 1 deletion libraries/gitInterface.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ var path = require('path');

var utilities = require('./utilities');
var identityFile = '/.identity/object.json';
var homeDirectory = path.join(path.join(os.homedir(), 'Documents'), 'realityobjects');
var homeDirectory = path.join(path.join(os.homedir(), 'Documents'), 'spatialToolbox');
var git = require('simple-git')(homeDirectory);


Expand Down
2 changes: 1 addition & 1 deletion libraries/hardwareInterfaces.js
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ function EmptyNode(nodeName, type) {
*/

/**
* @desc This function writes the values passed from the hardware interface to the RealityObjects server.
* @desc This function writes the values passed from the hardware interface to the spatial edge server.
* @param {string} objectName The name of the RealityInterface
* @param {string} nodeName The name of the IO point
* @param {value} value The value to be passed on
Expand Down
2 changes: 1 addition & 1 deletion libraries/utilities.js
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ var path = require('path');
var hardwareInterfaces = {};

var identityFolderName = '.identity'; // TODO: get this from server.js
var homedir = path.join(path.join(os.homedir(), 'Documents'), 'realityobjects');
var homedir = path.join(path.join(os.homedir(), 'Documents'), 'spatialToolbox');
var hardwareIdentity = homedir + '/.identity';

exports.writeObject = function (objectLookup, folder, id) {
Expand Down
2 changes: 1 addition & 1 deletion libraries/webFrontend.js
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ exports.printFolder = function (objects, objectsPath, debug, objectInterfaceName
tempFiles.splice(0, 1);
}

// populate the data for each object template on the frontend, using data from each directory found in the realityobjects
// populate the data for each object template on the frontend, using data from each directory found in the Spatial Toolbox
tempFiles.forEach(function(objectKey) {

var thisObjectKey = objectKey;
Expand Down
2 changes: 1 addition & 1 deletion libraries/webInterface/gui/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@
To add some placeholder content, click on Add Frame, and give your frame a name.
</div>
<div class="serverDescription" id="frameAddedDescription">
Now, when you view the specified image or object target, you should see the default UI appear. You can edit this content by editing the index.html file for this frame, in your realityobjects directory.<br>
Now, when you view the specified image or object target, you should see the default UI appear. You can edit this content by editing the index.html file for this frame, in your spatial Toolbox directory.<br>
<br>
To toggle additional help messages in the future, click the Show/Hide Help button in the upper right corner.
</div>
Expand Down
8 changes: 4 additions & 4 deletions server.js
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ const path = require('path');

// All objects are stored in this folder:
// Look for objects in the user Documents directory instead of __dirname+"/objects"
var objectsPath = path.join(path.join(os.homedir(), 'Documents'), 'realityobjects');
var objectsPath = path.join(path.join(os.homedir(), 'Documents'), 'spatialToolbox');

const addonPaths = [
path.join(__dirname, 'addons'),
Expand Down Expand Up @@ -647,7 +647,7 @@ var executeSetups = function () {
executeSetups();

/**
* Initialize worldObject to contents of realityobjects/_WORLD_local/.identity/object.json
* Initialize worldObject to contents of spatialToolbox/_WORLD_local/.identity/object.json
* Create the json file if doesn't already exist
*/
function loadWorldObject() {
Expand Down Expand Up @@ -3572,7 +3572,7 @@ function objectWebServer() {
});

/**
* Overwrites the 'enabled' property in the realityObjects/.identity/hardwareInterfaceName/settings.json
* Overwrites the 'enabled' property in the spatialToolbox/.identity/hardwareInterfaceName/settings.json
* If the file is new (empty), write a default json blob into it with the new enabled value
* @param {string} interfaceName
* @param {boolean} shouldBeEnabled
Expand Down Expand Up @@ -3746,7 +3746,7 @@ function objectWebServer() {
});

/**
* Previously, retrieved the worldObject from the realityobjects/.identity/_WORLD_OBJECT_/ folder
* Previously, retrieved the worldObject from the spatialToolbox/.identity/_WORLD_OBJECT_/ folder
* Now it is deprecated, because world objects are discovered using UDP broadcasts
*/
webServer.get('/worldObject/', function(req, res) {
Expand Down

0 comments on commit 1002306

Please sign in to comment.