Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/sorrir/configurator

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/sorrir/configurator
Owner: sorrir
Created: 2022-01-28T00:42:51.000Z (almost 3 years ago)
Default Branch: master
Last Pushed: 2022-11-15T16:17:52.000Z (about 2 years ago)
Last Synced: 2024-05-12T06:41:36.522Z (7 months ago)
Language: TypeScript
Size: 14.6 KB
Stars: 2
Watchers: 4
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Install via npm
```
$ npm install --production
$ npm run-script build
```

# Start and initialize the server
```
$ npm run start
$ npm run-script load-setup-info -- -s /path/to/sorrir-app/info/setupInfo.json
$ npm run-script load-devices-info -- -d
```

# Example Usage

## Use the rest-api to create component instances

```
$ curl -d '{
"name": "user",
"component": "user",
"startState": "userStartState"
}' -X POST http://localhost:3000/add-component-instance -H 'Content-Type: application/json'

$ curl -d '{
"name": "component",
"component": "component",
"startState": "componentStartState"
}' -X POST http://localhost:3000/add-component-instance -H 'Content-Type: application/json'

```

## Use the rest-api to auto-connect compatible ports
```
$ curl -d '{}' -X POST http://localhost:3000/add-connections-auto -H 'Content-Type: application/json'
```

## Use the rest-api to create units for component encapsulation
```
$ curl -d '{
"count": 2
}' -X POST http://localhost:3000/create-units -H 'Content-Type: application/json'
```

## Use the rest-api to place component instances on units
```
$ curl -d '{
"name": "user",
"component": "user",
"unit": "unit_1"
}' -X POST http://localhost:3000/map-component-instance-to-unit -H 'Content-Type: application/json'

$ curl -d '{
"name": "component",
"component": "component",
"unit": "unit_2"
}' -X POST http://localhost:3000/map-component-instance-to-unit -H 'Content-Type: application/json'
```

## Use the rest-api to place units to devices
```
$ curl -d '{
"unit": "unit_1",
"device": "ext"
}' -X POST http://localhost:3000/map-unit-to-device -H 'Content-Type: application/json'

$ curl -d '{
"unit": "unit_2",
"device": "jetson-01"
}' -X POST http://localhost:3000/map-unit-to-device -H 'Content-Type: application/json'
```

## Use the rest-api to change a connection's protocol
Needs to be done *after* components have been placed on units and all units have been mapped to devices.
```
$ curl -d '{
"sourceComponent":"component",
"sourcePort":"TO_USER",
"targetComponent":"user",
"targetPort":"FROM_COMPONENT",
"protocol":"BLUETOOTH"
}' -X POST http://localhost:3000/change-unit-connection-protocol -H 'Content-Type: application/json'
```

## Use the rest-api to generate configuration file for application
```
curl -d '{}' -X GET http://localhost:3000/get-setup -H 'Content-Type: application/json' > setup.json
```

## Use the rest-api to generate final configuration file for orchestrator
```
curl -d '{}' -X GET http://localhost:3000/get-configuration -H 'Content-Type: application/json' > configuration.json
```