Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/martinfk/vrgio
https://github.com/martinfk/vrgio
Last synced: 12 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/martinfk/vrgio
- Owner: MartinFk
- Created: 2021-10-07T15:38:29.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-09-03T05:59:03.000Z (about 2 years ago)
- Last Synced: 2024-10-11T10:26:10.994Z (about 1 month ago)
- Language: C#
- Size: 76.7 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# VRGiO
## 1.1 VRGiO WEMOS Features
Following are the main functions currently supported by the .
- Register cube with unique IP address with the server
- Listen to requests from other cubes and perform any actuation/action based on request data
## 1.2 VRGiO Server Features
Following are the main functions supported by the server.
- Register cube with unique IP address
- Attach two components (cubes) to each other
- Remove bi-directional connection in Graph between two nodes representing the physical components that got attached to each other
- Total count of components registered
- Retrieve metadata about any given node using its IP address as the identifier. For inspecting any node for its neighbors and its own type.
- Actuates the physical component or performs message passing from one component to another
- Visualizes the entire Graph with all components shown
- The details for each feature can be accessed using the following URL after you run the server
[http://localhost:8000/docs](http://0.0.0.0:8000/docs)
## 1.3 VRGiO Server Setup Guide
### 1.3.1.1 Build the Docker Image
```bash
cd /vrgio/server/
docker build . -t vrgio_server
```
### 1.3.1.2 Start the Docker Container
```bash
docker run -p 8000:8000 vrgio_server
```
### 1.3.1.3 Access the server UI
```bash
http://0.0.0.0:8000/docs
```
### 1.3.2 Alternatively run server without Docker
```bash
cd /vrgio/server/
pip3 install -r requirements.txt
uvicorn server:app
```
For windows:
```bash
cd /vrgio/server/
python3 -m pip install -r requirements.txt
python3 -m uvicorn server:app
```