Giter VIP home page Giter VIP logo

openrov-cockpit's Introduction

Views in the last 24 hours Build Status Scrutinizer Quality Score ![Gitter](https://badges.gitter.im/Join Chat.svg)

OpenROV Cockpit

"OpenROV is a DIY telerobotics community centered around underwater exploration & adventure." One goal of OpenROV is to have onboard video for live viewing as the user operates the ROV. Enter: OpenROV Cockpit.

The Cockpit project provides the UI and system integration to the hardware of the ROV. It is a node.js application that is intended to run on the ROV directly that serves a HTML5 Single Page Application to a browser which uses either keyboard, gamepad, or touch to send commands back to the ROV.

Cockpit provides a socket.io based API for low latency communication with the ROV.

Getting started

Get a working environment

On a beaglebone: If you just getting started and want to have working environment for the OpenROV Cockpit, we recommend that you start with using our lastest stable release as reference from the readme in openrov-software

On a computer: Follow our developer guide: https://github.com/OpenROV/openrov-software/tree/master/developer_guide

Key Related Projects

openrov-cockpit is one of serveral packages that are combined together to enable control of an ROV. Refer to the openrov-software for a list of the other pacakges.

Requirements for running without a video abstaction

Plugins

You can create your own plugins and share them with the community. Take a look at our openrov-grunt-init-plugin project.

How to Contribute

  1. Fork the project in github

  2. Add an issue to the issue list for the changes you want to make. Browse the issues lists for many of the fixes and enhancement requests if you are looking for ideas.

  3. Make your changes and or fixes.

  4. Test them locally on your ROV or using the mock framework for node if you don't have one.

  5. Send a pull request back to the Master repository.

Someone on the team will review the pull request and ensure the changes work on the ROVs before approving the pull request.

env 'plugins__ui-manager__selectedUI=new-ui' USE_MOCK=true video_port=8092 photoDirectory="/tmp" plugins__video__forward_camera_url="http://localhost:8092/?action=stream" configfile="/tmp/rovconfig.js" forever -w -c 'node --debug' cockpit.js

openrov-cockpit's People

Contributors

brianadams avatar codewithpassion avatar dominik-fretz avatar simonech avatar bransorem avatar smurthas avatar samccone avatar fusion94 avatar depperson avatar estackpole avatar lavirott avatar jtrezzo avatar v1o avatar ohcolinho avatar jacobrosenthal avatar kevingrandon avatar mikemccand avatar frgtn avatar davidtlang avatar jjshoe avatar

Watchers

Kevin Mallery 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.