Skip to content
This repository has been archived by the owner on Mar 13, 2020. It is now read-only.
/ cancloud Public archive
forked from CSS-Electronics/cancloud

CANcloud - open source telematics platform

License

Notifications You must be signed in to change notification settings

MatinF/cancloud

 
 

Repository files navigation

CANcloud - Open Source Telematics Platform

CANcloud is an open source portal for managing CAN bus data recorded via the CANedge2.

The tool is a simple front-end that can be hosted on a web server and accessed via your browser.

At CSS Electronics, we always host the latest version of CANcloud - but you can build, customize & host it yourself as well.


Key features

1. Securely login to any S3 server by providing your endpoint, credentials and bucket name
2. List all objects within an S3 bucket in a folder structure hierarchy
3. Easily navigate between connected CANedge2 devices via the sidebar
4. Download, share & delete objects - or upload files (e.g. firmware.bin for firmware over-the-air)
5. Configure CANedge devices via an online editor - and submit for easy over-the-air updates
6. Encrypt configuration passwords using the built-in encryption tool
7. Add device meta data (incl. pictures and searchable name/group/subgroup)
8. Easily customize the portal with your own logo and CSS styling (see `src/browser/index.html`)
9. Build the offline configuration editor, usable without an internet connection


Documentation

For more details on CANcloud and the CANedge2 see below:


Installation

Deployment (development mode)

  1. Clone the repository
  2. Run npm install in the folder to install application dependencies
  3. Run npm start to run application in development mode

Deployment (production)

  1. Run npm run build
  2. Copy the contents of the site folder to your web server

You can now access your own self-hosted version of CANcloud - incl. any customizations made.

Deployment (offline editor)

  1. Run npm run simple
  2. Copy the offline editor from the simple folder

Example of login details

If you have set up e.g. an AWS S3 server and bucket, your login details could look as below:

endpoint: https://s3.amazonaws.com
accessKey: LBIDJHBOIZQ3XBJ23UUQ
secretKey: Jxasdeue3324e3/wqe9wewdcxsa219421Hsj
bucket: aws-cancloud-bucket

Note the following:

  • When logging into a MinIO server the port should be included (e.g. https://5.103.118.41:9000)
  • You need to create your bucket before you can login (i.e. outside of CANcloud, e.g. in your AWS console)
  • For some S3 servers (e.g. AWS), you may need to change the CORS config - see the getting started docs

Contribution & support

Feature suggestions, pull requests or questions are welcome!

You can contact us at CSS Electronics below:


Dependencies

CANcloud uses a number of libraries - the most important are:

  • minio: CANcloud utilizes some of the core structure & S3 SDK calls from the MinIO browser
  • react-jsonschema-form: This library enables the configuration editor GUI

About

CANcloud - open source telematics platform

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 85.6%
  • CSS 8.3%
  • HTML 6.1%