wuespace/telestion-rocketsound-psc

Telestion Project-Specific Client for the Rocketsound project. Public => Signed CLA required for contribution!

⚠️ Attention!

This repository is no longer the main development tree for the RocketSound Client and therefore deprecated.
Please use the new combined project repository instead: telestion-project-rocketsound

Telestion Rocketsound PSC

This Telestion PSC (Project-Specific Client) was bootstrapped with the Telestion Client CLI.

Getting started

NOTE: All commands below, unless otherwise specified, should get executed in the cloned project's root folder (that contains the package.json) or a subfolder thereof.

The first step is to install the development dependencies. They are defined in package.json and you can install them with the following command:

npm ci

Running

To build and run the project in development mode, execute:

npm start

Build and deploy

The build command generates a ready-to-deploy web application and native app.

To build the entire project, run:

npm run build

Project structure

The project structure is like the structure created by create-react-app (CRA), plus some special structures:

.
├── public (static files, cf. CRA documentation)
│   ├── index.html
│   ├── favicon.ico
│   └── [...]
├── src
│   ├── components
│   │   ├── app.tsx (the overall PSC React App)
│   │   ├── header.tsx (the header component)
│   │   └── login-page.tsx (the login page)
│   ├── model
│   │   └── sample-user-config.ts (the initial user config)
│   ├── widgets
│   │   ├── sample-widget (a sample widget included in the template)
│   │   │   ├── index.ts (widget meta model, including a unique widget name)
│   │   │   └── widget.tsx (widget component definition)
│   │   └── index.ts (array of widgets)
│   ├── index.css
│   ├── index.tsx
│   └── [...]
├── package.json
├── README.md (you're here :P)
├── telestion.config.js (configuration of the PSC, such as plugins, etc.)
└── tsconfig.json (configuration for TypeScript compilation)

Learn More

To get started with PSC Development, you can take a look at the PSC Developer Manual. It contains many explanations of the most important concepts, practical guides, references, and more.

You can find the latest versions (in PDF format) in the Documentation Repo Releases.

For a full API Reference of all the Telestion Client APIs, check out the documentation of the Telestion Client: https://wuespace.github.io/telestion-client/

To learn React, check out the React documentation.

telestion-rocketsound-psc's Issues

Merge this repo with telestion-rocketsound

I think it is a good idea to have one repository for the projects containing all the project code. So we don't need to maintain two repositories for the same project and have a single starting point. Since both code bases are not inferring with each other we could easily copy the files.

Adopt to new message definitions

Defect widgets:

• GPS Map
• Spectrum (possible backend fault)

Missing widgets:

• Amplitude (amp, freq1, fre2)
• Velocity (measured, estimated)

'npm start' fails with an error

I wanted to start the application after a clean pull from main and called npm ci and npm start. Then I got the following stack trace:

npm start

> [email protected] start C:\Users\...\telestion-rocketsound-psc
> npm run start:electron


> [email protected] start:electron C:\Users\...\telestion-rocketsound-psc
> tc-cli start --electron

C:\Users\...\telestion-rocketsound-psc\node_modules\@wuespace\telestion-client-cli\src\commands\build.js:29
                await compileElectronMainThread(projectRoot, config?.plugins || []);
                                                                    ^

SyntaxError: Unexpected token '.'
    at wrapSafe (internal/modules/cjs/loader.js:1053:16)
    at Module._compile (internal/modules/cjs/loader.js:1101:27)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1157:10)
    at Module.load (internal/modules/cjs/loader.js:985:32)
    at Function.Module._load (internal/modules/cjs/loader.js:878:14)
    at Module.require (internal/modules/cjs/loader.js:1025:19)
    at Object.require (internal/modules/cjs/helpers.js:72:18)
    at C:\Users\...\telestion-rocketsound-psc\node_modules\require-directory\index.js:76:17
    at Array.forEach (<anonymous>)
    at Object.requireDirectory (C:\Users\...\telestion-rocketsound-psc\node_modules\require-directory\index.js:59:24)
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] start:electron: `tc-cli start --electron`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] start:electron script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     C:\Users\...\AppData\Roaming\npm-cache\_logs\2021-03-10T10_38_18_651Z-debug.log
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] start: `npm run start:electron`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] start script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     C:\Users\...\AppData\Roaming\npm-cache\_logs\2021-03-10T10_38_18_674Z-debug.log

Note: I removed my username from the logs. Do you need additional information like some logs?

Add dashboards for different program states

Please add the following dashboards to the application:

• Overview (see #68 image)
• Sounding Rocket
  • State Widget
  • Amplitude Graph Widget
  • Spectrum Graph Widget
  • Velocity Graph Widget
• System State
  • State Widget
  • Baro Graph Widget
  • NineDOF Widget
  • Map (when possible)
• Recovery
  • Map Widget (bigg boyyy)

correlates with #67