Coder Social home page Coder Social logo

raysajuuk / bambuboard Goto Github PK

View Code? Open in Web Editor NEW

This project forked from t0nyz0/bambuboard

0.0 0.0 0.0 107 KB

Bambu Dashboard for viewing real time data from the Bambu X1 Carbon 3D printer.

License: MIT License

JavaScript 68.55% CSS 14.75% HTML 16.70%

bambuboard's Introduction

BambuBoard

Bambu Dashboard for viewing real time data from the Bambu X1 Carbon 3D printer.

Demonstration Videos:

Regular Speed Video: Observe the dashboard functionality at a standard pace.

Recording.2023-11-21.133859.mp4

Accelerated Startup Video: Watch the dashboard in action at 2.5x speed during a printer startup sequence.

Bambu.mp4

Running on physical dashboard:

image

BambuBoard Setup Guide

Welcome to the BambuBoard Setup Guide. This document will walk you through the process of cloning the BambuBoard repository and setting up Node.js on your Raspberry Pi to run the BambuBoard dashboard.

Step 1: Install Node.js

Node.js is required to run the BambuBoard application. Here's how to install it on your Raspberry Pi:

  1. Open a terminal on your Raspberry Pi.
  2. Update your package list:
    sudo apt update
    
  3. Upgrade your packages to their latest versions:
    sudo apt full-upgrade
    
  4. Install Node.js:
    sudo apt install nodejs
    
  5. (Optional) Install npm, Node.js' package manager:
    sudo apt install npm
    
  6. Verify the installation by checking the version of Node.js and npm:
    node -v
    npm -v
    

Step 2: Clone the BambuBoard Repository

To get the BambuBoard code, you need to clone its repository from GitHub:

  1. Navigate to the directory where you want to clone the repository:
    cd /path/to/directory
    
  2. Clone the repository:
    git clone https://github.com/t0nyz0/BambuBoard.git
    
  3. Change into the cloned repository's directory:
    cd BambuBoard
    
  4. Update the bambuConnection.js with your settings! This is important.
    sudo nano bambuConnection.js
    

Note: CTRL+X to exit nano, make sure to hit Y to confirm saving changes.

Step 3: Install Dependencies

BambuBoard may have Node.js dependencies that need to be installed:

  1. Within the BambuBoard directory, install the dependencies:
    npm install
    

Step 4: Run the Application

To start the BambuBoard dashboard:

  1. Run the application:
    node bambuConnection.js
    

Step 5: Accessing the Dashboard

Once the application is running, you can access the BambuBoard dashboard via a web browser on the Raspberry Pi or another device on the same network. Open your browser and navigate to:

http://raspberrypi.local:8080

Replace 8080 with the actual port number if BambuBoard runs on a different port. (Configured in bambuConnection.js)

Note: If this doesnt work, try IP address of Raspberry Pi.

Troubleshooting

If you encounter any issues, consider the following:

  • Check that you have the correct permissions to clone the repository and install Node.js packages.
  • Verify that the Raspberry Pi's firewall settings are not blocking the BambuBoard application.

Future Development Plans:

(Completed 11/24/23) Investigating the integration of native MQTT capabilities using libraries like Paho or MQTT.js.

(Completed) Upcoming updates will include photos of the actual dashboard setup to demonstrate its real-world application.

  1. Add instructions on how to make the raspberry pi automatically boot into kiosk mode. Many tutorials online if you need immediate direction.
  2. Webcam feed from inside the printer added to the dashboard? (Currently in development)

Known Limitations:

The AMS (Automated Material System) filament remaining percentage displayed on the dashboard may not always be 100% accurate, as the printer estimates filament usage. Stay tuned for updates and enhancements to BambuBoard, and feel free to contribute to its development. Your feedback and suggestions are always welcome!

bambuboard's People

Contributors

t0nyz0 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.