Giter VIP home page Giter VIP logo

rov-remote's Introduction

Rov-Remote

Intro

This project aims at remotely controlling an ROV, by providing a PWA (Progressive Web Application) running on any browser capable devices.

UI is specifically suitable for touch devices such as smartphones by displaying virtual joysticks on screen (based on nippleJS lib)

This web app is supposed to work in parallel with a remote server which will receive rover commands. The server must process requests from client either by providing a REST api or WebSockets communication implementation.

For better performance in real time application, it is advised to choose Websockets as the mean of communication between client/server. This PWA supports both (see code in WebInterfaces)

Server projects examples for both ESP32 and RPI can be found here:

  • ESP with websockets: rov-control-esp
  • RPI with REST api: rov-control-pi.

Usage

Use yarn run start or npm run start or directly from VSCode click 'start' in npm scripts to launch application.

To do a production build, launch the 'build' scripts as before. Serve the static files from output 'build' folder.

Advanced usage

You can automate deployment for targets such as ESP32 or rapsberry boards using following taylored scripts.

Before you need to adjust settings to your configuration.

See examples of projects as mentionned before: rov-control-esp and rov-control-pi.

For ESP, you'll need a platformIO project setup to build and upload filesystem image to host web application. Path to external ESP PlatformIO project, should be configured in ESP scripts:

It should be then served on target device with a static http webserver (for instance ESPAsyncWebServer on ESP32 or Nginx on RPI).

-build:nochunk: sub task calling custom script build-no-split.js doing a production build without code splitting

-ESP: exportBuildFiles: removes hashes from build files and copy them to a custom directory which must point to ESP32 project's directory

-PI:deploy: customized script to scp PRD build to a raspberry

How it works

Whenever controls are moved on UI, it sends request in this form:

rov-remote's People

Contributors

etienne-85 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.