wpilibsuite/wpilib-docs

Cross compile WPILib to Javascript for use in interactive docs tutorials

Open

#1,831 opened on May 23, 2022

View on GitHub
 (5 comments) (1 reaction) (0 assignees)JavaScript (297 forks)auto 404
Component: ControlsHelp Wanted

Repository metrics

Stars
 (187 stars)
PR merge metrics
 (PR metrics pending)

Description

Emscripten lets you cross compile C++ into Javascript. We could use this to run potentially any part of WPILib simulation in a browser.

Apparently Eigen works fine with this: https://eigen.tuxfamily.narkive.com/Yf7dM1wo/status-of-building-with-emscripten-running-code-in-a-web-browser. At the very least, we could cross compile our DARE solver so we can use it in the forthcoming PID tuning interactive tutorial.

If possible, I'd suggest writing a makefile that invokes em++ on each .cpp file and generates a .js file so the docs can just call JS functions.

Contributor guide

Research direction
Set up an Emscripten build system to compile WPILib C++ sources to JavaScript, starting with the DARE solver, and create a makefile that invokes em++ on each .cpp file.
Tech stack
cppjavascript
Domain
documentationtoolingbuild system
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++JavaScriptMakefile
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30