Lesser fork of retropilot-server https://spacecruft.org/retropilot/retropilot-server/

Go to file

Florian Brede a933eadb6e Update README.md		2021-05-23 02:34:33 +02:00
cabana	TODO: directly bundled a compiled & fixed version of cabana in .../cabana/	2021-05-23 02:28:33 +02:00
certs	TODO: initial retropilot-server commit	2021-05-16 04:35:18 +02:00
controllers	Added tests	2021-05-22 17:33:28 +01:00
models	split api & useradmin into their own routes	2021-05-21 23:17:11 +01:00
routes	TODO: replaced sendmail by nodemailer to allow using a proper & authenticated smtp endpoint.	2021-05-23 02:18:11 +02:00
static	TODO: initial retropilot-server commit	2021-05-16 04:35:18 +02:00
test	Update test name	2021-05-22 20:42:56 +01:00
.gitignore	Added tests	2021-05-22 17:33:28 +01:00
LICENSE	Initial commit	2021-05-16 04:24:48 +02:00
README.md	Update README.md	2021-05-23 02:34:33 +02:00
config.sample.js	TODO: directly bundled a compiled & fixed version of cabana in .../cabana/	2021-05-23 02:28:33 +02:00
database.empty.sqlite	Partial refactoring of v1.3/:dongleId/upload_url/, less code, started putting things into their own models.	2021-05-19 22:55:19 +01:00
package.json	TODO: replaced sendmail by nodemailer to allow using a proper & authenticated smtp endpoint.	2021-05-23 02:18:11 +02:00
server.js	TODO: directly bundled a compiled & fixed version of cabana in .../cabana/	2021-05-23 02:28:33 +02:00
worker.js	Merge pull request #3 from AdamSBlack/main	2021-05-23 01:21:24 +02:00

README.md

retropilot-server

Replacement for comma.ai backend and useradmin dashboard. Bundled with a modified version of comma's cabana to allow viewing & analyzing drives.

If you don't want to host your own instance, check out https://api.retropilot.org/useradmin for a hosted version of the backend, useradmin and cabana.

[Server] Summary

The server consists of 2 node scripts.

server.js is using expressjs and runs the backend (file upload / communication with openpilot) and the useradmin dashboard to manage / view / download drives & logs. worker.js is a background worker that is processing drives (analyzing video files & logs) to prepare drives for playback in cabana and to gather statistics. It automatically terminates itself after 60 minutes to make sure the video/log libraries do not cause memory leaks.

Both scripts can be started with a cronjob each minute, they use locking to make sure they run exclusively.

Attention: Minimum required node version is node 10.

[Server] Installation

npm install
cp config.sample.js config.js
cp database.empty.sqlite database.sqlite
> EDIT config.js

[Server] Running

node -r esm server.js

node -r esm worker.js

[Server] CABANA Support

A compiled version of a custom cabana fork (https://github.com/florianbrede-ayet/retropilot-cabana) is directly bundled in the cabana/ subdirectory and will be served by the express app. After starting server.js, cabana is ready to use.

Preparing OpenPilot Device

Option (a) By modying endpoint URL in OpenPilot

The only replacement required in code is in common/api/__init__.py:

def api_get(endpoint, method='GET', timeout=None, access_token=None, **params):
  backend = "https://api.commadotai.com/" # replace with the RetroPilot server

Option (b) Without code changes (not functional yet)

Re-Registering OpenPilot Device

To re-register a freon previously registered on comma or a different server, you have to remove the old dongleId and reboot:

rm /data/params/d/DongleID
reboot

Current Limitations

Right now, the OpenPilot dashboard does not display any statistics or pairing status. The reason is that at least pre 0.8.3, the offroad.apk with react and comma-api is for some reason either ignoring /etc/hosts changes or not accepting the certificate from Preparing > Option b).

Right now statistics are only available through the RetroPilot Useradmin, the beauty however is that the Pairing-QR-Code is always available so it's easy to unpair and repair the device to a different account on the RetroPilot Server.