Skip to content
This repository has been archived by the owner on Jun 15, 2023. It is now read-only.

Latest commit

 

History

History
38 lines (30 loc) · 2.22 KB

README.md

File metadata and controls

38 lines (30 loc) · 2.22 KB
Raw

Controller

status tests issues last commit FOSSA Status

Production

View guides, documentation and more at cloud-cnc.github.io

Development

Note: This repository contains all files for running a controller. Controller(s) are typically ran on computers with close proximity to the CNC machines.

Installation

  1. Setup a core server instance
  2. Create the controller entry via the web GUI to get a controller ID + key.
  3. Install dependencies via running npm i
  4. Modify the config file (default.js) to add the ID + key and to customize your controller
  5. Run npm start to start the controller
  6. If you need any additional help, feel free to ask in the Spectrum channel

Development

NPM Scripts

Name Description
coverage Run all unit tests and generate coverage reports
lint Lint everything with ES Lint
start Start the controller in production mode
start:development Start the controller in development mode - uses mock serialport bindings, logs to console
start:e2e Start the controller in E2E testing mode - uses IPC serialport bindings, disables logging
start:unit Start the controller in unit testing mode - disables logging
test Run all unit tests

License

FOSSA Status