Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/artcom/eppsa-ips-evaluation

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/artcom/eppsa-ips-evaluation
Owner: artcom
License: mit
Created: 2017-09-28T09:28:17.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2017-10-18T14:48:53.000Z (over 7 years ago)
Last Synced: 2024-11-07T06:36:41.721Z (3 months ago)
Language: JavaScript
Size: 306 KB
Stars: 0
Watchers: 15
Forks: 0
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Indoor Positioning Systems Evaluation Backend

Tools for the evaluation of the quality / accuracy of indoor positioning systems. Node.js application.

## Usage

Service can be configured in the following ways:
- using a ```.config.json``` file based on the ```.config.example.json``` file
- using environmental variables:
- DATABASE
- DATABASE_USER
- DATABASE_PORT
- DATABASE_HOST
- DATABASE_PASSWORD
- QUUPPA_SERVER

```bash
npm install
npm run start
```

## Tests

### Configuration

Tests will use a test database defined int a ```.config.json``` file when the database and Quuppa server environmental
variables are not set

### Run

Tests can be run using

```bash
npm run test
```

Or run on file changes with

```bash
npm run test-watch
```

Test coverage data can be generated with

```bash
npm run test-with-coverage
```

Coverage data can be displayed in a browser at ```coverage/index.html```

## RESTful service

The service exposes a RESTful API on port 3000. The API allows setting up experiments and running them. All POST
requests should contain the header ```Content-Type: application/json```

### Running an experiment

End point: ```/experiments/experiment-name/run```

Accepts POST requests.

After the experiment has been created and set up (define points, nodes and node positions, see **Experiment set up**)

The experiment can be run by sending a POST request to ```/experiments/experiment-name/run``` with:

```json
{
"experimentTypes": ["experiment_type", ...],
"repeats": "integer",
"interval": "integer(milliseconds)"
}
```

The experiments of types ```experimentTypes``` will be run ```repeats``` times at an interval of ```interval```
milliseconds. Postion data will be collected for all nodes defined in nodePositions and stored in PositionData alongside
with position error metrics. Primary error metrics for the complete experiment will be stored in ExperimentMetrics.

The experiment can be re-run after changing the node positions and the data will be stored under the same experiment
name.

Supported experiment types:
- "Quuppa"

### Retrieving experimental data

#### Per point position data

End point: ```/experiments/experiment-name/position-data```

Accepts GET requests. Returns the position data for all point measures for the experiment ```experiment-name``` in the form:

```json
[
{
"pointName": "point_name",
"point": {
"name": "point_name",
"trueCoordinateX": "float",
"trueCoordinateY": "float",
"trueCoordinateZ": "float"
},
"experimentName": "experiment_name",
"localizedNodeId": "node_id",
"localizedNodeName": "node_name",
"node": {
"id": "node_id",
"name": "node_name",
"type": "node_type"
},
"estCoordinateX": "float",
"estCoordinateY": "float",
"estCoordinateZ": "float",
"estZoneLabel": "zone_label",
"latency": "float",
"powerConsumption": "float",
"localizationError2d": "float",
"localizationError3d": "float"
},
...
]
```

#### Experiment metrics

End point: ```/experiments/experiment-name/primary-metrics```

Accepts GET requests. Returns the primary error metrics for the experiment ```experiment-name``` in the form:

```json
{
"experimentName": "experiment_name",
"error2dAverage": "float",
"error2dMin": "float",
"error2dMax": "float",
"error2dVariance": "float",
"error2dMedian": "float",
"error2dRMS": "float",
"error2dPercentile75": "float",
"error2dPercentile90": "float",
"error3dAverage": "float",
"error3dMin": "float",
"error3dMax": "float",
"error3dVariance": "float",
"error3dMedian": "float",
"error3dRMS": "float",
"error3dPercentile75": "float",
"error3dPercentile90": "float",
"zoneAccuracyAverage": "float",
"latencyAverage": "float",
"latencyMin": "float",
"latencyMax": "float",
"latencyVariance": "float",
"latencyMedian": "float",
"latencyRMS": "float",
"latencyPercentile75": "float",
"latencyPercentile90": "float",
"powerConsumptionAverage": "float",
"powerConsumptionMin": "float",
"powerConsumptionMax": "float",
"powerConsumptionVariance": "float",
"powerConsumptionMedian": "float",
"powerConsumptionRMS": "float",
"powerConsumptionPercentile75": "float",
"powerConsumptionPercentile90": "float"
}
```

### Experiment set up

#### Create zones with known borders

End point: ```/zones```

Accepts GET and POST requests.

New zones can be created:

- using a POST request to ```/zones``` with:

```json
{
"name": "zone_name",
"xMin": "float",
"xMax": "float",
"yMin": "float",
"yMax": "float",
"zMin": "float",
"zMax": "float"
}
```

- or in a batch using a POST request to ```/zones``` with:

```json
[
{
"name": "zone_name",
"xMin": "float",
"xMax": "float",
"yMin": "float",
"yMax": "float",
"zMin": "float",
"zMax": "float"
},
...
]
```

Zones can be retrieved:

- using a GET request to ```/zones/zone-name``` and will return:

```json
{
"name": "zone_name",
"xMin": "float",
"xMax": "float",
"yMin": "float",
"yMax": "float",
"zMin": "float",
"zMax": "float"
}
```

- or in batch using a GET request to ```/zones``` and will return:

```json
[
{
"name": "zone_name",
"xMin": "float",
"xMax": "float",
"yMin": "float",
"yMax": "float",
"zMin": "float",
"zMax": "float"
},
...
]
```

#### Create zone sets

End point: ```/zone-sets```

Accepts GET, POST and DELETE requests.

New zone sets can be created:

- using a POST request to ```/zone-sets``` with:

```json
{ "name": "set_name" }
```

All zones sets can be retrieved:

- using a GET request to ```/zone-sets``` and will return:

```json
[
{
"name": "set_name",
"zones": [
{
"name": "zone_name",
"xMin": "float",
"xMax": "float",
"yMin": "float",
"yMax": "float",
"zMin": "float",
"zMax": "float"
},
...
]
},
...
]
```

A single zone set can be retrieved:

- using a GET request to ```/zone-sets/set-name``` and will return:

```json
{
"name": "set_name",
"zones": [
{
"name": "zone_name",
"xMin": "float",
"xMax": "float",
"yMin": "float",
"yMax": "float",
"zMin": "float",
"zMax": "float"
},
...
]
}
```

A set can be deleted:

-using a DELETE request to ```/zone-sets/set-name``` and will return:

```json
{ "zoneSetName": "set_name" }
```

A zone can be added to a set:

- using a POST request to ```/zone-sets/set-name``` with:

```json
{ "zoneName": "zone_name" }
```

A zone can be removed from a set:

- using a DELETE request to ```/zone-sets/set-name/zone-name``` and will return:

```json
{
"zoneSetName": "set_name",
"zoneName": "zone_name"
}
```

#### Create points with known coordinates

End point: ```/points```

Accepts GET and POST requests.

New points can be created:

- using a POST request to ```/points``` with:

```json
{
"name": "point_name",
"trueCoordinateX": "float",
"trueCoordinateY": "float",
"trueCoordinateZ": "float"
}
```

- or in a batch using a POST request to ```/points``` with:

```json
[
{
"name": "point_name",
"trueCoordinateX": "float",
"trueCoordinateY": "float",
"trueCoordinateZ": "float"
},
...
]
```

Points can be retrieved:

- using a GET request to ```/points/point-name``` and will return:

```json
{
"name": "point_name",
"trueCoordinateX": "float",
"trueCoordinateY": "float",
"trueCoordinateZ": "float"
}
```

- or in a batch using a GET request to ```/points``` and will return:

```json
[
{
"name": "point_name",
"trueCoordinateX": "float",
"trueCoordinateY": "float",
"trueCoordinateZ": "float"
},
...
]
```

#### Create nodes to be positioned

End point: ```/nodes```

Accepts GET and POST requests.

New nodes can be created:

- using a POST request to ```/nodes``` with:

```json
{
"id": "node_id",
"name": "node_name",
"type": "node_type"
}
```

- or in a batch using a POST request to ```/nodes``` with:

```json
[
{
"id": "node_id",
"name": "node_name",
"type": "node_type"
},
...
]
```

Nodes can be retrieved:

- using a GET request to ```/nodes/node-name``` and will return:

```json
{
"id": "node_id",
"name": "node_name",
"type": "node_type"
}
```

- or in a batch using a GET request to ```/nodes``` and will return:

```json
[
{
"id": "node_id",
"name": "node_name",
"type": "node_type"
},
...
]
```

#### Create experiment

End point: ```/experiments```

Accepts GET, POST and DELETE requests.

New experiment can be created:

- using a POST request to ```/experiments``` with:

```json
{
"name": "experiment_name"
}
```

Experiments can be retrieved:

- using a GET request to ```/experiments/experiment-name``` and will return:

```json
{
"name": "experiment_name"
}
```

- or in a batch using a GET request to ```/experiments``` and will return:

```json
[
{
"name": "experiment_name"
},
...
]
```

Experiments and all associated data (experiment metrics, position data, node positions) can be deleted using a DELETE request at ```/experiments/experiment-name```

#### Define node positions

End point: ```/experiments/experiment-name/node-positions```

Accepts GET and POST requests.

Node positions can be defined or modified:

- using a POST request to ```/experiments/experiment-name/node-positions``` with:

```json
{
"localizedNodeName": "node_name", "pointName": "point_name"
}
```

- or in a batch using a POST request to ```/experiments/experiment-name/node-positions``` with:

```json
[
{
"localizedNodeName": "node_name", "pointName": "point_name"
},
...
]
```

Node positions can be retrieved:

- using a GET request to ```/experiments/experiment-name/node-positions/node-name``` and will return:

```json
{
"localizedNodeName": "node_name", "pointName": "point_name", "experimentName": "experiment_name"
}
```

- or in a batch using a GET request to ```/experiments/experiment-name/node-positions``` and will return:

```json
[
{
"localizedNodeName": "node_name", "pointName": "point_name", "experimentName": "experiment_name"
},
...
]
```