Skip to content

Commit

Permalink
Merge pull request #4 from ut-issl/feature/update_readme
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
meltingrabbit authored Jul 5, 2022
2 parents d6b89b7 + e2a760a commit e77ba41
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# WINGS
Web-based INterface Ground-station Software
WINGS is a software processing telemetry and command for satellites and satellite componetns. WINGS is a web application which can be used from both web browsers and http api requests. WINGS supports [C2A](https://github.com/ut-issl/c2a-core)-styled and ISSL-styled telemetry and command formats. Users can implement other formats.
Usually, interface software is required for the connection between WINGS and satellites. [WINGS_TMTC_IF](https://github.com/ut-issl/wings-tmtc-if) is such software which supports COM port and socket connection. Users can implement other interface software.
WINGS is a software processing telemetry and command for satellites and satellite components. WINGS is a web application that can be used from both web browsers and HTTP API requests. WINGS supports [C2A](https://github.com/ut-issl/c2a-core)-styled and ISSL-styled telemetry and command formats. Users can implement other formats.
Usually, interface software is required for the connection between WINGS and satellites. [WINGS_TMTC_IF](https://github.com/ut-issl/wings-tmtc-if) is such software that supports COM port and socket connection. Users can implement other interface software.
WINGS uses [ASP .NET](https://github.com/dotnet/aspnetcore) for backend software, MySQL for database, and [React](https://github.com/facebook/react) for frontend software.

## Getting Started for User
## Getting Started for Users
### Prerequisites
The application listed below is required:
+ [Docker](https://docs.docker.com/get-docker/)
Expand All @@ -15,7 +15,7 @@ The application listed below is required:
2. Navigate to the desired location for the repository.
3. Clone the repository.
4. Make sure that docker is running.
5. Create dokcer images in the directory containing `docker-compose.yml`.
5. Create docker images in the directory containing `docker-compose.yml`.
```
docker-compose build
```
Expand All @@ -31,19 +31,19 @@ The application listed below is required:
docker-compose down
```
### Operation
1. Fulfill comment and select a component in main page.
2. Click operation start bottun.
3. Connect WINGS_TMTC_IF to the operation.
4. Click operation join bottun.
5. You can show telemetry and send command while joining operation.
1. Fulfill comment and select a component in the main page.
2. Click the operation start button.
3. Connect WINGS_TMTC_IF to the the operation.
4. Click the operation join button.
5. You can show telemetries and send commands while joining the operation.
### Command
- You can send commands by clicking command line and pushing `"Shift" + "Return"` keys.
- If you want to use command files, click "+" button in command file tabs.
- If you want to add unplanned commands, select command in "Command Selection" area and click "add" button.
### Telemetry
- You can show telemetry by cliking "+" bottun, selecting showing type and telemetry packet names, and cliking "Open" button.
- You can show telemetry by clicking "+" button, selecting showing type and telemetry packet names, and clicking "Open" button.
- "packet" type just shows telemetry values.
- "graph" type shows telemetry graphs.
- You can save and restore telemetry showing layouts (click "Layouts" button).
Expand Down

0 comments on commit e77ba41

Please sign in to comment.