Skip to content

Latest commit

 

History

History
488 lines (429 loc) · 28 KB

README.md

File metadata and controls

488 lines (429 loc) · 28 KB

gSender logogSender: connect to and control Grbl-based CNCs

gSender is a feature-packed CNC interface software designed to be clean and easy to learn while retaining a depth of capabilities for advanced users. Its development was begun out of a passion for hobby CNC machines: an interface rebuilt to suit the needs of the at-home CNC user.

  • Accepts standard, GRBL-compliant g-code and has been verified to work with many of the common CAM programs
  • Began development to bring new concepts to the existing landscape of GRBL senders in an effort to advance functionality and ease-of-use
  • Javascript-based CNC interface software which leverages Electron for cross platform use
  • Is a branch off of the popular CNCjs CNC controller interface

Some things that we’re looking to accomplish with this sender:

  • Reliability of operation
  • Accommodates all ranges of computing systems (low-end PC to RasPi | ‘light mode’)
  • Clean and easy to use no matter your previous CNC experience
  • Makes available all normally expected functions
  • Addresses common error throwing conditions automatically
  • Built-in gadgets for surface probing, stock flattening, firmware editing, and g-code editing with syntax highlighting, command navigation, and more
  • 3D cutting visualization

gSender

💻 Download Github All Releases

gSender is available for the following systems and does not yet support headless Pi operation

Windows
Windows (x32)
Windows
Windows (x64)
Mac
Mac (Intel)
Linux
Linux
RasPi
Ras Pi
AvailableEXE Available EXE Available DMG Available DEB Available ApIm

Check out the latest releases here.

📦 Current Features

  • GRBL controllers supported
  • Smart machine connection
  • 3-axis digital readout (DRO) with manual value entry
  • All-directional jogging with XY diagonals, jog presets, and incremental/continuous single-button handling
  • Zero-setting and gotos (independent and combined)
  • Probing in any direction plus safe continuity detection ensures no broken cutting tools
  • Full imperial/metric compatibility
  • Responsive screen design and workspace customizations including visualizer light and dark theme
  • 3D toolpath visualization (no machine connection required)
  • File insight on load (feed range, spindle range, tools used, estimated cutting time, and overall, max, and min dimensions)
  • Feed override and active job status indicators
  • Fully exposed keyboard shortcuts for external keyboard/keypad control
  • Joystick support built-in for a variety of controllers
  • Safe height movements - accommodates machines with or without endstops
  • Homing cycle and quick-movement locations available for machines with homing hardware
  • Full spindle/laser support via manual control widgets, active alerting, and live overrides
  • Full mist/flood coolant support via manual control widgets and active alerting
  • Macros buttons (rearrangeable) with enhanced macro variables and individually assignable keyboard shortcuts
  • Lightweight mode reduces processing intensity on less powerful hardware or when running larger files
  • Easy workspace swapping for more advanced jigging or alignment work
  • Optional automatic handling for common error throwing g-code
  • Firmware tool for easier GRBL EEPROM changes, loading defaults, and GRBL flashing
  • Surfacing tool auto-generates surfacing g-code based on machine cutting area and other preferences, ready to execute
  • Calibration tool for axis alignment - a step by step process to make sure your CNC is square
  • Movement tuning tool for calibrating motor axis movements
  • Tool change functionality - pause, ignore, or run code blocks on M6 commands
  • Start-from-line functionality to resume jobs part-way through in case of failure of abort
  • Outline functionality indicates the rough bounds of the job before cutting
  • Customizable g-code injection at job start & end
  • Tooltips for data entry points
  • Alarm warning explanations to better contextualize CNC errors
  • Sleep management to keep PC awake during g-code sending
  • Pre-built machine profiles, including:
    • LongMill
    • Shapeoko
    • X-carve
    • OpenBuilds CNCs
    • 3018 CNC & PROVer
    • BobsCNC CNCs
    • CNC4Newbie CNCs
    • Mill Right CNCs
    • Ooznest WorkBee
    • Nomad
    • Carvey
    • Mill One, and more...

🎓 Documentation

All up-to-date documentation on gSender can be found here: https://sienci.com/gsender-documentation/

If you encounter issues or would like to recommend improvements for gSender, there's a link for feedback submission on the documentation page. We also have a place for discussion on our forum: https://forum.sienci.com/c/gsender/

📃 Example Files

If you'd like to test gSender's capabilities, there are several gcode files in the examples directory that can be downloaded and run locally.

💼 License

gSender is free software, provided as-is and available under the GNU GPLv3 license.

👓 Further Use

gSender is also designed in a way that it can be run locally on your computer browser or otherwise compiled for use on other systems which aren't listed in the downloads. There will soon be documentation on how you can set this up yourself listed below once there's been a bit more testing completed.

🕣 Development History

1.1.7 (October 26th, 2022)

  • Fix for XYZ probe profile when $13 enabled
  • Fix for machine position overflowing bounds
  • Fix for some keybinds no longer recognizing when they were released

1.1.6 (October 19th, 2022)

  • Improved surfacing tool - pattern now ramps in to support more surfacing bit types, cut direction is reversible, able to start from center, can copy gcode to clipboard for saving.
  • Major improvements to visualizer memory usage and parsing speed
  • Start from line should account for maximum file Z height when moving into position to account for situations where Z0 is set at the spoilboard.
  • Probe code should always return to exact starting location instead of approximating it.
  • Improvements to firmware flashing UX - can now select profile and port inside tool.
  • Fix for auto-probe code movements being too small when "$13 report as inches" EEPROM value enabled
  • Go To buttons only use safe height if below that position when limit switches enabled to avoid moving downwards.
  • Fixed values in some machine profiles.
  • Added machine state guards to some keyboard shortcuts.
  • UI Modals now more difficult to close accidentally.
  • Bracket Comments on M0/M1 now emitted to UI.
  • Laser offsets preferences allow negative values again
  • Bounding Box variables once again available to macros
  • Mac version now exits completely on close.
  • Higher UI clarity when connecting to board with invalid/unrecognizable firmware
  • Styling changes in Firmware Tool
  • Fixed overflow when OS had screen zoom above 100%.

1.1.4 (August 26th, 2022)

  • Fixed firmware tool control for setting $23
  • Flashing again available without connecting to device
  • Improvements to continuous jogging (thanks @cotepat)
  • Fixed issue with some settings not properly persisting
  • Outline tool improvements - moved to worker thread, G0 movements included, tweaks to accuracy
  • More accurate file length estimates when connected - virtualizer now uses EEPROM acceleration values
  • Probe function now available in manual tool change
  • Better datafilter for invalid UTF8/UTF16 characters

1.1.3 (August 12th, 2022)

  • Added profiles for Longmill extension kits
  • Machine profile removed from preferences and placed in firmware tool
  • Fixed incorrect default values in some machine profiles
  • Test mode now restores WCS after the soft reset performed while exiting check mode.
  • Fixed issue with test mode that would occasionally have it start running the file after test was complete
  • Fixed issue with continuous jog when soft limits were enabled and report in inches EEPROM value was enabled
  • Firmware tool improvements - new convenient profile selection, setting search, performance improvments, highlighted changed values
  • Improvements to value inputs - should no longer default to min value if there is too long a pause in typing
  • Surfacing labels changed to X/Y rather than length/width
  • Minor styling changes

1.1.2 (July 15th, 2022)

  • Fix for start button sometimes not working when "Start Event" block enabled but empty
  • Laser offsets applied more intelligently
  • Fixed styling regression in probe widget height
  • Infrastructure for edge version

1.1.1 (July 4th, 2022)

  • Reversion of electron 18 patch to fix issue where application would hang on splash screen
  • Patch notes now displayed in "About" section of preferences
  • Laser offsets no longer applied on laser mode toggle if set to 0.
  • Added new machine profiles for Bluecarve and Yorahome CNC.
  • Dependency updates

1.1.0 (June 24th, 2022)

  • Fix for start g-code event not sending entire code block in some situations and make it more consistent in all situations
  • Firmware now highlights settings that are different from default for Sienci machines
  • Support for edge/beta channels for those who want to opt into new features for testing
  • Improvements to controller movement using joystick
  • Brighter cut lines in visualizer
  • More sensible timeout on fetching updates
  • MK2 12X30 configuration now properly selectable
  • Added Mist, flood, and stop coolant keyboard shortcuts
  • Fixed issue with surfacing spiral pattern where center strip could be missed with some parameters
  • Fixed issue in calibration where the direction it asked you to move gantries wasn't correct in some situations.
  • Laser offset no longer resets to previous value on toggle of laser mode
  • Numerous surfacing tooltip and unit conversion issues fixed
  • Surfacing now lets you select M3 or M4 movement
  • Rapid position buttons now use $27 pulloff value for determining final positions
  • Outline tool now stores and restores modals on completion
  • Improvements to settings storage and persistence
  • Migrated from Electron 10 to Electron 18

1.0.6 (April 14th, 2022)

  • Fixed issue that could cause continuous jog to fail in some situations with soft limits enabled
  • Fixed issues with start probe and confirm probe keybinds
  • Laser offset now saved and applied correctly
  • Fixed mouse button combination that could crash visualizer
  • WCS is reset to current selection on job stop
  • Movement modal included in start-from-line functionality
  • Start-from-line should prefer selected WCS if different from default G54
  • Fixed issue with spindle max/min not saving in some situations
  • Disabled surfacing generation when job is running
  • Laser/Spindle EEPROM ($31) and spindle/laser min/max should more accurately be reflected in firmware UI
  • Macro movement and re-ordering should be easier and more consistent.
  • Start-from-line should use a more sane decimal place for position values
  • Rapid position buttons should now account for machines not running Sienci-specific firmware and offset position from 0.
  • Dependency updates

1.0.5 (March 4th, 2022)

  • Tool commands now emitted to UI if they occur alongside M6 commands
  • Start from line should more consistently set feedrate/spindle rate
  • Fixed issue where laser min and laser max were reversed on initializing laser mode.
  • Rewrite of jog UI control to gain more consistent behaviour
  • Alterations to jog keybinds to gain more consistent behaviour
  • Added logic on toolchange to prevent sender from starting before post hook is complete
  • Alterations to profile default spindle min and max and laser min and max values

1.0.4 (February 15th, 2022)

  • Add support for distinct Spindle max and Spindle Min while in laser or spindle mode
  • "Pause" toolchange workflow renamed to "Manual", and now allows jogging and macros to be run
  • Default feedrate in "start from line" now reflects file unit modal
  • Fixed issue where units weren't consistent on Go-To buttons leading to Z plunge
  • Tool diameter selection hidden on Z probe to prevent user confusion.
  • Lowered minimum resolution from 1280X960 to 1024X768 and added responsiveness to account for that.
  • Trimmed machine profile list to generic set and made it more obvious that machine dimensions are as reported from EEPROM.
  • Added MK2 machine profiles and support for default settings for new machines.
  • Updated firmware images for MK1 and MK2
  • Fixed regression where comments weren't properly stripped before sending to GBRL
  • Corrections to Auto-diameter probe profiles
  • Fixed issue where T commands could cause errors when on a line with M6 commands
  • Stop job should now consistently reset board (0x18) as intended
  • Fixed various tooltip errors
  • Fixed issue where calibration tools weren't using correct jog controls

1.0.3 (December 22nd, 2021)

  • ; Comments are now emitted to UI on M0, M1, and M6 workflow stops
  • Fixed issue where jog cancel realtime command wasn't properly sent to controller
  • Fixed issue where default values instead of custom jog speeds weren't used on initial program load
  • Start from line now sends more modals to make sure IoT devices are enabled if that line is skipped
  • Improvements to outline feature - head should now return to original position, better support for disjointed/tiled carves
  • Fixed timestamps from causing UI elements to jump around
  • Fixed DRO being cut off on small resolutions or screen sizes
  • Fixed application not being full-screen on startup
  • Increases on movement limits for jog presets
  • UI fields should be more easily clearable and return to previous value if not changed
  • Workflow controls no longer disappear during jogging
  • Changes to updater to prevent 32 bit application updating to 64 bit
  • Added new laser support preferences with basic offset
  • Alarm 2 should now be unlockable
  • Fixed edge case where surfacing would leave an unfinished pass in the center
  • Updates to serial connection library and workflow
  • New touchplate images and support for upcoming auto-diameter touchplate

1.0.2 (December 3rd, 2021)

  • Fixed regression with XYZ probe
  • Fixed regression in probe preferences

1.0.1 (November 26th, 2021)

  • Rapid position buttons now use EEPROM values for more accurate movements and machine profile limits should be set from EEPROM on connect
  • Spindle rate hidden by default - Spindle/Laser must be toggled on in machine profile to view overrides during job run
  • Surfacing tool now runs last pass in Zig-Zag pattern
  • Added support for $13 in feedrate reporting
  • Safe height should no longer send router to Z0
  • Added new machine profiles
  • Fix for F-key shortcuts not working
  • Added missing units
  • G28 commands no longer ignored
  • Alterations to XY probing
  • More accurate error line reporting
  • Various styling issue fixed

1.0.0 (Oct 29, 2021)

  • Unlock button on UI to avoid homing/unlock from M0 state
  • More user-friendly number inputs that allow clearing are more forgiving on changing value
  • Minimize Renders turned on by default when lite mode toggled on
  • Styling changes to probe widget
  • Various UI look and feel changes
  • New machine profiles
  • Slight alteration to colour of lines that have entered planner to make them more visible
  • Fixed issue with jog/play shortcuts
  • Fixed bug where homing using the visualizer Home button did not unlock rapid position buttons
  • Fixed issue where firmware settings could be sent when machine was locked/alarmed resulting in settings not updating
  • Fixed issue where M0 commands in toolchange hooks would result in post hook not executing

Open Beta 0.7.5 (Oct 22, 2021)

  • Improvements to surfacing tool - new motions and layout
  • Improvements to pause commands (M0/M1) in macros
  • WCS dropdown now accurately reflects workspace modal
  • Improvements to flashing workflow and reduced situations where it's possible to fail
  • Improvements to probe settings
  • Fixed issue with quick movement buttons
  • Fixed issue with soft limit behaviour and continuous jogging if firmware flag to set machine 0,0,0 not set
  • Fixed issue with imperial units and continuous jogging with soft limits enabled
  • Fixed numerous UI inconsistencies and other styling issues

Open Beta 0.7.4 (Oct 08, 2021)

  • Minimize render mode for visualizer to improve performance
  • Visualizer improvements to render speed
  • Fix render worker being started if visualizer disabled
  • Probe dimensions correctly update if changed in preferences
  • Can once again copy from console
  • Redesigned probe module
  • Fix for quick-movement buttons if home set to back-left
  • Fix for T commands on the same line as M6 commands
  • Fixed firmware tool values occasionally not reflecting actual EEPROM settings
  • Style changes

Open Beta 0.7.3 (Sept 20, 2021)

  • Code signed! (this means security certification - i.e. no more firewall warnings)
  • New recognized CNCs added and unrecognized devices are now accessible from the connection widget
  • UI fixes for incorrect baud rate
  • New EEPROM categories for easier navigation
  • Clearer Help menu
  • More fixes and improvements to endstop-related functions
  • New LongMill default firmware that better supports endstops
  • Fix for jog not stopping immediately due to debounce
  • Various styling fixes

Open Beta 0.7.2 (Sept 10, 2021)

  • Manual value entry for X, Y, and Z locations by clicking on the location indicator
  • Re-designed job progress indicator that better shows operating time and path of current file
  • Now able to use variables in start/stop g-code blocks and tool changing
  • Ability to enable or disable start/stop g-code blocks without clearing code
  • Updates to included firmware image and Longmill default EEPROM settings in firmware tool to support endstops
  • Endstop buttons now appear automatically if homing is enabled, and the home button is available on machine connect
  • Rapid position buttons now available and updated to use new firmware settings
  • Individual X and Y axis Go To buttons now use safe height if set in preferences, GotoXYZ0 now changed to GotoXY0, and safe height now complies to endstop-enabled machines and doesn’t descend after movement
  • Better support of physical hold/unhold buttons on Longboard controller
  • Tweaks to Z jogging to reduce runaway issues
  • Fixed hard limit alarms to allow easier resuming of workflow
  • Fixed bug with Z movement at end of surfacing program in imperial units
  • Joystick jogging should now send jog cancel at direction control release
  • Fixed last line run to reset on job completion

Open Beta 0.7.1 (August 20, 2021)

  • Improvements to UI connection to CNC machine to prevent frequent disconnections during long job runs
  • Program will now prevent your computer from going into sleep mode during long jobs
  • Several styling fixes across the UI
  • Fixed issue with machine locking up after pressing the jog control buttons in some situations
  • Fixed issue with program freezing after a job has finished

Open Beta 0.7.0 (August 13, 2021)

  • Start from line feature
  • Sortable macros
  • Preliminary support for joystick control and keybinding
  • Improvements to outline tool to prevent moving below the Z 0 on completion
  • Fixed issue where file would be re-rendered or unloaded when connecting and disconnecting
  • Fixed issue where inch grid lines weren't aligned with zero point
  • Improvements to file loading speed
  • Improvements to visualization and rendering speed
  • Improvements to file parsing speed
  • Various library upgrades aimed at improving performance and preventing UI hanging

Open Beta 0.6.9 (July 23, 2021)

  • New outline tool which will generate and run a rough outline of a loaded project file
  • Fixes for load file window not appearing in rare circumstances, jogging runaway in rare circumstances, and probe settings not being reflected in probe module until restart
  • Fixed issue with surfacing tool limits and ease of changing inputs

Open Beta 0.6.8 (July 8, 2021)

  • Fix for duplicated keybinds
  • Fix for Carbide Create files and M0 commands
  • Fix for new macros not appearing as possible keybinds
  • Optional updates for future versions
  • New logging engine for electron app
  • Socket polling to help keep connection alive
  • PowerSaveBlock added to reduce cases of machine sleeping while running long jobs
  • Alterations to load file to hopefully reduces cases of the dialog appearing in some users

Open Beta 0.6.7 (July 1, 2021)

  • New Movement Tuning tool that can be used to calibrate motor axis movements
  • New feature for running G-code at program Start and Stop - enter and save your own commands in the settings
  • More exposed keyboard shortcut options and new categorization
  • Now able to assign shortcuts to macros!
  • Added coolant buttons and status indicator
  • Better M0/M1 command support - notification in the UI when command encountered and easier to resume the program
  • Clearer visualization due to reduced rapid line opacity
  • Improvements to the surfacing tool limits and settings persisting
  • Ability to reset gSender settings to default
  • Added reconnect logic to client to reduce instances of UI no longer updating on long jobs
  • Fixed an issue where the "Home machine" button wouldn't disappear on homing cycle
  • Fixed an issue where macro exports were unable to be re-imported
  • Fixed issue with jogging while $15 was enabled
  • Other minor bug fixes

Open Beta 0.6.6 (June 11, 2021)

  • Sticky folders! Load files from the last place you navigated to
  • New tool change functionality - can now pause, ignore, or run code blocks on M6 commands
  • Added a prototype Calibration tool for axis alignment - step by step process to make sure your CNC is square
  • Alarm warnings now show an explanation of what the alarm code means
  • Faster splash screen
  • Spindle/Laser ‘active’ state changes are now updated more quickly in the UI along with other Laser widget improvements
  • Copy and paste text from the terminal
  • Tweaks to handling correct units display in overrides and surfacing
  • Refactored file information to Redux
  • Loads of small bug fixes pertaining to keyboard shortcuts, jogging, probing, comment processing, and the firmware tool
  • Minor styling changes

Open Beta 0.6.5 (May 28, 2021)

  • New tool for surfacing
  • Moved most controllerEvent listeners to redux store to improve performance
  • Improved Job Time Estimation
  • Updates to Laser/Spindle widget to better track on/off state
  • New 'About' information
  • Fixed file units mismatch with preferred units

Open Beta 0.6.4 (May 14, 2021)

  • Improvements to job handling
  • Tooltips created for data entry points
  • Splash screen tweaks
  • Working PI build!?

Closed Beta 0.6.0 (May 7, 2021)

  • Altered how files are loaded to improve UI performance
  • Added estimated time to run calculation on file load
  • File attributes now persists on disconnect
  • Fixed issues with macro editing and adding

Closed Beta 0.5.8 (Apr 30, 2021)

  • New experimental Winx32 and RasPi builds
  • Firmware tool improvements and bug fixes
  • More accurate parsing of tool and spindle speeds
  • Various keybind bug fixes, addressing special characters
  • Added recent files button and file unloading
  • New 'Check mode' state for testing files before starting job
  • Verbose commands now in console
  • New macro behaviours and import/export
  • gSender now officially licensed under GPLv3
  • Homing state and other small bugs and styling fixes
  • New logo/branding throughout!

Closed Beta 0.5.6 (Apr 1, 2021)

  • Fixed jog stepping with keybindings, continuous jogging bugs, and other jogging unreliabilities
  • Added new keybindings for improved, keyboard-based actions (unsure if issues with particular symbols such as '*' have persisted)
  • Took another look through to ensure proper unit consistency and conversion
  • Repairs to probing
  • More work done on the Firmware tool for refined functions and display
  • Indication of current jog preset selected
  • New base modals created for use across tools and confirmations

Closed Beta 0.5.5 (Mar 26, 2021)

  • Added combo laser/spindle widget (toggleable in settings)
  • Re-designed location widget
  • Re-designed layout of job status information to include min and max extents for file dimensions
  • Added safe-height retraction settings for goto XYZ0 (accessible in settings)
  • Added splash screen on application load
  • Migration to most recent Electron release plus implemented logging

Closed Beta 0.5.4 (Mar 19, 2021)

  • Set up in-app feedback submission button
  • Better formatting and sizing of various gSender elements
  • New visualizer theme "light mode" available in settings
  • Experimental "lightweight" options to reduce visualizer rendering computation (meant for less powerful hardware)
  • Keybinding tweaks to prevent jogging runaway and other small bugs
  • New bottom, left-hand toast notifications for feedback on certain actions
  • Imperial / metric units should now extend to all aspects of the sender
  • Buttons to goto X, Y, and Z individually
  • Better handling of Alarm states with unlock
  • New g-code validation on file load and job run
  • New feature to automatically download updates for future gSender Windows versions
  • Better handling of movement cancel button so that all positioning-related movements should be able to be cancelled
  • Migration to most recent React
  • New in-app updating management prompted via server releases

Closed Beta 0.1 (Mar 5, 2021)

  • gSender decided as official name :D
  • Buttons added for homing, quick-travel, jog cancel, diagonal jog, and an awesome isocube!
  • New macros widget
  • New customizable settings: jogging presets, baud rate, and more.
  • Visual overhaul on settings, probing, file attributes, and visual consistency across entire program
  • Logo implemented and the loading of Louis
  • Responsiveness overhaul on entire program
  • Mac (intel) version released March 8

Closed Alpha 3.0 (Feb 19, 2021)

  • Continuous jogging!
  • Unit switching in settings (metric/imperial)
  • Keybinding functionality to jog and other key functions with keypresses (can change bindings in settings)
  • Probe returning to original position
  • New, separate settings files won't interfere with CNCjs
  • Small colour and styling changes to hopefully increase clarity of items on the screen
  • Some responsiveness addressed to help keep sender looking good across many screen sizes (though we still have a ways to go)
  • Fixes to excessive decimal places in some areas
  • New Firmware Tool in progress but will probably break your board right now

Closed Alpha 2.0 (Feb 5, 2021)

  • Resolved non-functional buttons, missing console, and some errors during sending
  • New jogging widget and jog presets
  • Improved probe function plus probe continuity checking
  • New file attributes on load
  • More visual improvements and a large buildout in new settings options

Closed Alpha 1.0 (Jan 29, 2021)

  • Still highly dependant on great infrastructure created by the CNCjs team
  • Established Electron installer, git, and certificates
  • Large visual overhaul in how widgets and displayed and operational flow of sender
  • New probing widget, machine profiles, settings, and visualizer

Notable features still in progress:

  • G-code editing
  • Pendant
  • Full 3D Visualization