Skip to content

metalizzsas/NusterKit

Repository files navigation

Nuster Kit

Create your machine automation using JSON !

🤖 Core concepts

Nuster aims to simplify machine automation using Javascript and JSON. turbine and ui packages work in synergy to control your machine.

Currently Nuster can handle:

  • Cycles
  • Custom settings for cycles
  • Maintenant tasks
  • IO Management
  • Machine documentations

To access IO Controllers, Turbine connects to network devices using industrial protocols such as:

  • Modbus/TCP
  • Ethernet/IP (Compatibility is limited due to the ts-enip package)

👾 How to use

Docker images for ui and turbine are created for each release:

Turbine should be customized from your needs with the /data/machines mounting point. Follow the readme.md of turbine to create machine custom definitions.

📝 Development

This monorepo uses pnpm workspaces. Start developing using:

pnpm run dev

This will start a simulation-server instance that will wait a configuration from turbine.

🗂️ Packages

The following packages are essentials for our system.

Packages Description Changelog
UI UI Provided to machine screens Link
Turbine REST Api that drives machines Link
Simulation Server REST backend that simulates a hardware machine Link
Simulation UI UI App that interacts with simulation server Link

❓ How to contribute

Create a pull request and generate a changeset for the stuff you have added using pnpm changeset