Telestion Project RocketSound

This repository holds project-specific resources for RocketSound.

It contains the Telestion Application which connects to the RocketSound Interface, handles incoming data and prepares them for the connected clients.

The graphical Telestion Client connects to the Telestion Application and visualizes incoming data in a clear way.

Installation

The Application

To set up the Telestion Application, please go to the latest release of the project and download the telestion-project-rocketsound-vX.X.X.zip: https://github.com/wuespace/telestion-project-rocketsound/releases/latest

Extract it with your favorite archiver.

Start the application with docker-compose. Type in your terminal:

docker-compose up -d

and docker-compose does the rest for you. 😉

Connecting the Serial Device

Now you need to send and receive messages from and to the serial device. Please install python and the pySerial package.

Then download this script: https://github.com/pyserial/pyserial/blob/master/examples/tcp_serial_redirect.py

Please open a shell or command line and call the script with the required arguments:

python ./tcp_serial_redirect.py -c localhost:9871 /dev/pts/6 38400
# or
python ./tcp_serial_redirect.py -c localhost:9871 /dev/ttyUSB1 57600
# or
python ./tcp_serial_redirect.py -c localhost:9871 COM6 57600

And thats it! The serial-to-tcp adapter transmits the information between the serial device and the Telestion Application.

When you want to stop the Application, call:

docker-compose down

And terminate the serial-to-tcp adapter.

The Client

For the Client setup, you simply need to go to the latest release in GitHub and download the suitable installer for your operating system: https://github.com/wuespace/telestion-project-rocketsound/releases/latest

Then install the Client and start it.

A window should show up displaying a login page. Please first check the backend server URL and enter the URL given from the Application management script. It should look something like http://192.168.0.10:9870/bridge. If you running the Telestion Application on the same system, you can leave the URL like it is.

Then enter your given credentials from the Telestion team and press "Login".

The first dashboard should show up and the connection indicator in the navigation bar should switch to "Connected". If this is not the case, please log out again via the avatar menu in the upper right corner and re-check if the entered backend server URL is correct. When the Client still doesn't connect, please inform the Telestion team so we can debug this issue.

Building

To build the projects from source, please take a look into the part specific descriptions:

This repository

The overall file structure of this monorepo looks like this:

.
├── .github
│   ├── workflows (CI configuration)
│   └── dependabot.yml (Dependabot config)
├── application
|   ├── conf (the verticle configuration for the Application)
|   ├── src (the source files of the Telestion Application)
|   ├── Dockerfile (the definition to successfully build a Docker image from the compiled Application sources)
|   ├── build.gradle (manages dependencies and the build process via Gradle)
|   ├── gradle.properties (contains the required tokens to access required dependencies)
|   ├── gradlew (the current gradle executable for UNIX-based systems)
|   └── gradlew.bat (the current gradle executable for Windows systems)
├── client
|   ├── public (template webpage folder where React will engage)
|   ├── src (the source files of the Telestion Client)
|   └── package.json (manages dependencies and the build process via npm)
├── CHANGELOG.md (DON'T TOUCH! Automatically generated Changelog)
├── README.md (you're here :P)
├── project.json (contains the current project information like the current version etc.)
└── telestion-application (DON'T TOUCH! Used as an indicator for our automation tools)

The Application and the Client folders contain their own README.md that describe the different parts more specific.

Contributing

For the documentation on contributing to this repository, please take a look at the Contributing Guidelines.

Contributors

Thank you to all contributors of this repository:

Made with contributors-img.

About

This is part of Telestion, a project by WüSpace e.V..

wuespace / telestion-project-rocketsound Goto Github PK