# MicroWeldr
A Python package that converts SVG files to Prusa Core One G-code for plastic "spot" welding applications. The package processes SVG vector graphics and generates G-code that creates weld spots along the paths without extruding any plastic material.
**Optimized for Prusa Core One**: Includes chamber temperature control (M141/M191), proper bed dimensions (250×220×270mm), CoreXY-specific settings, and **layed back mode** *(currently not working)* - designed for when your printer is positioned on its back (door pointing up) so liquids can be pipetted into pouches and gravity holds them in place before heat sealing.
This allows for rapid microfluidics prototyping with a 3d printer.
While the edges are not as smooth as a laser weld, the 3d printer is more available than a laser welder.
## Project Structure
```
microweldr/
├── microweldr/ # Main package
│ ├── core/ # Core functionality
│ ├── validation/ # Validation modules
│ ├── animation/ # Animation generation
│ └── cli/ # Command line interface
├── tests/ # Test suite
│ ├── unit/ # Unit tests
│ └── integration/ # Integration tests
├── examples/ # Example files and configurations
├── docs/ # Documentation
└── pyproject.toml # Poetry configuration
```
## Features
- **SVG Processing**: Converts SVG paths, lines, circles, and rectangles to weld points
- **Color-based Weld Types**:
- Black elements → Normal welds
- Blue elements → Light welds (lower temperature, shorter welding time)
- Red elements → Stop points (pause for user intervention)
- **Configurable Parameters**: TOML-based configuration for temperatures, heights, and timing
- **Bed Leveling**: Optional automatic bed leveling (can be disabled)
- **Animation Output**: Generates animated SVG showing the welding sequence
- **Proper G-code Structure**: Includes heating, cooling, and safety procedures
- **PrusaLink Integration**: Direct G-code submission to Prusa MINI via PrusaLink API
## Installation
### **From PyPI (Recommended)**
```bash
pip install microweldr
```
That's it! All validation and development tools are included by default.
### **Development Installation**
```bash
# Clone repository
git clone https://github.com/retospect/microweldr.git
cd microweldr
# Install in editable mode
pip install -e .
```
## Available Commands
After installation, these console commands are available:
### **Main Commands**
```bash
# SVG to G-code conversion
microweldr input.svg -o output.gcode
# Print with automatic monitoring
microweldr input.svg --submit-to-printer --monitor
microweldr input.svg --submit-to-printer --monitor --monitor-mode pipetting
```
### **Utility Commands**
```bash
# Printer control tool
microweldr-control status # Check printer status
microweldr-control monitor # Monitor current print
microweldr-control stop # Stop current print
# Test PrusaLink connection
microweldr-test
```
## Configuration
Edit `config.toml` to adjust welding parameters:
```toml
[temperatures]
bed_temperature = 80 # °C
nozzle_temperature = 200 # °C for normal welds
chamber_temperature = 35 # °C - Core One chamber temperature
use_chamber_heating = false # Set to false to disable chamber heating (useful if sensor is not working)
[movement]
move_height = 5.0 # mm - safe travel height
weld_height = 0.2 # mm - welding height
[normal_welds]
weld_temperature = 200 # °C
dot_spacing = 0.3 # mm - final desired spacing
initial_dot_spacing = 8.0 # mm - spacing for first pass (wider)
cooling_time_between_passes = 2.0 # seconds - cooling between passes
[light_welds]
weld_temperature = 180 # °C - lower temperature
welding_time = 0.3 # seconds - shorter time
dot_spacing = 0.3 # mm - final desired spacing
initial_dot_spacing = 12.0 # mm - spacing for first pass (wider)
cooling_time_between_passes = 1.5 # seconds - cooling between passes
[nozzle]
outer_diameter = 0.4 # mm - nozzle outer diameter
inner_diameter = 0.2 # mm - nozzle inner diameter (opening)
[animation]
time_between_welds = 0.1 # seconds - time between weld points in animation
pause_time = 3.0 # seconds - how long pause messages are displayed
min_animation_duration = 10.0 # seconds - minimum total animation time
```
### Configuration File Loading
MicroWeldr looks for configuration files in the following order (first found wins):
#### **Main Configuration (`config.toml`)**
1. **Command line specified**: `-c custom_config.toml` or `--config custom_config.toml`
2. **Current directory**: `./config.toml`
3. **Examples directory**: `./examples/config.toml` (if running from repo root)
4. **Package defaults**: Built-in fallback configuration
#### **Secrets Configuration (`secrets.toml`)**
Used for PrusaLink printer connection settings:
1. **Command line specified**: `--secrets-config custom_secrets.toml`
2. **Current directory**: `./secrets.toml`
3. **Examples directory**: `./examples/secrets.toml`
4. **No secrets file**: PrusaLink features disabled (local G-code generation only)
#### **Configuration Hierarchy**
- **Built-in defaults** provide base configuration
- **Main config file** overrides defaults
- **Command line arguments** override config file settings
- **SVG attributes** override all other settings (per-element)
#### **File Locations Examples**
```bash
# Using default config in current directory
microweldr input.svg # Uses ./config.toml
# Using custom config file
microweldr input.svg -c my_config.toml # Uses my_config.toml
# Using custom secrets file
microweldr input.svg --secrets-config my_secrets.toml
# Both custom configs
microweldr input.svg -c my_config.toml --secrets-config my_secrets.toml
```
#### **Config File Templates**
- **`config.toml`**: Main welding parameters (temperatures, speeds, etc.)
- **`examples/config.toml`**: Optimized settings for new users
- **`secrets.toml`**: PrusaLink connection settings (not in git)
- **`secrets.toml.template`**: Template for PrusaLink setup
#### **Missing Files Behavior**
- **No config.toml**: Uses built-in defaults (safe for basic operation)
- **No secrets.toml**: PrusaLink disabled, local G-code generation only
- **Invalid config**: Falls back to defaults with warnings
- **Partial config**: Missing sections use defaults
## Layed Back Mode (⚠️ EXPERIMENTAL - NOT WORKING YET)
**⚠️ WARNING: Layed back mode is currently under development and does not work properly. Use standard upright mode for reliable operation.**
The SVG welder was designed to support "layed back printer operation" - when your printer is chillin' on its back with the door pointing up for easy access to microfluidic devices. However, this mode is currently experiencing technical issues.
### **Known Issues:**
- ❌ Calibration conflicts with manual positioning
- ❌ Z-axis homing issues when printer is on its back
- ❌ Coordinate system needs adjustment for inverted orientation
- ❌ Safety features need refinement for this configuration
### **Current Recommendation:**
```toml
[printer]
layed_back_mode = false # Use standard upright mode for now
```
### **Future Development:**
Once the issues are resolved, layed back mode will provide:
- Easy access for pipetting and microfluidic operations
- Manual positioning with trusted coordinates
- Optimized G-code for inverted printer orientation
### **📍 Manual Positioning Required**
**IMPORTANT**: Before starting any print (your printer is trusting you completely!):
1. **Manually position** the print head to the **rear right corner** of the bed
2. **Set Z-height manually** - position nozzle at desired starting height above bed
3. **All positioning trusted** - the printer is chillin' and trusts your complete setup
4. **G92 X0 Y0 Z0** sets all axes as origin (no automatic homing performed)
### **🛡️ Safety Features for Layed Back Mode**
- ✅ **No automatic homing** (prevents all endpoint errors when printer is on its back)
- ✅ **Fully manual positioning** (complete trust in your setup for all axes)
- ✅ **No bed leveling** (too risky when printer is layed back)
- ✅ **Slower movements** (3000 mm/min travel, 150 mm/min Z-axis - no rush!)
- ✅ **Disabled stepper timeout** (M84 S0 - printer stays relaxed)
- ✅ **Gentle Z positioning** (slow movements to avoid crashes)
### **⚙️ Standard Mode (For Uptight Printers)**
Set `layed_back_mode = false` for normal upright printer operation with full homing and bed leveling.
## PrusaLink Configuration
To enable direct G-code submission to your Prusa Core One, you need to configure PrusaLink access:
### 1. Setup PrusaLink on Your Printer
- Enable PrusaLink on your Prusa Core One (should be enabled by default on newer firmware)
- Connect your printer to your network (WiFi or Ethernet)
- Note your printer's IP address (check printer display or router) or find its `.local` hostname
### 2. Find Your Printer's Address
You can use either:
- **IP Address**: Check your printer's display or router's connected devices
- **.local hostname**: Usually `prusacoreone.local` or similar (check printer display for exact name)
### 3. Get Authentication Credentials
**Choose ONE method:**
**Method A: LCD Password (Recommended - Easier)**
- Check your printer's LCD display for the password (usually shown in network settings)
- No web interface setup needed
**Method B: API Key (Alternative)**
- Open your printer's web interface: `http://YOUR_PRINTER_IP` or `http://prusacoreone.local`
- Go to Settings → API
- Generate or copy your API key
### 4. Configure secrets.toml
Copy the template and fill in your details:
```bash
cp secrets.toml.template secrets.toml
```
Edit `secrets.toml`:
```toml
[prusalink]
host = "192.168.1.100" # Your printer's IP address
# OR use .local hostname:
# host = "prusacoreone.local" # More convenient, doesn't change with DHCP
# Method A: LCD Password (recommended)
username = "maker" # Default username (usually "maker")
password = "your-lcd-password" # Password from printer's LCD display
# Method B: API Key (alternative - comment out Method A if using this)
# username = "maker"
# api_key = "your-api-key-here" # From printer's web interface
default_storage = "local" # "local" or "usb"
auto_start_print = true # Whether to start printing immediately
timeout = 30 # Connection timeout in seconds
```
### 5. Test Connection
```bash
microweldr-test
```
### 6. Submit G-code to Printer
```bash
# Generate and submit G-code (starts printing immediately with default config)
microweldr input.svg --submit-to-printer
# Force immediate printing (overrides config)
microweldr input.svg --submit-to-printer --auto-start-print
# Use USB storage instead of local
microweldr input.svg --submit-to-printer --printer-storage usb
# Upload without starting (override config default)
microweldr input.svg --submit-to-printer --no-auto-start
# Queue the file for later printing (clearer intent)
microweldr input.svg --submit-to-printer --queue-only
```
## Printing Modes
The SVG welder supports three different printing modes when submitting to your printer:
### **🚀 Immediate Printing** (Default)
Files are uploaded and printing starts immediately:
```bash
microweldr input.svg --submit-to-printer
# or force immediate printing:
microweldr input.svg --submit-to-printer --auto-start-print
```
### **📋 Queue Mode**
Files are uploaded and queued for later printing:
```bash
microweldr input.svg --submit-to-printer --queue-only
```
Use this when:
- You want to prepare multiple files
- The printer is currently busy
- You want to review the file before printing
### **📁 Upload Only**
Files are uploaded without any automatic behavior:
```bash
microweldr input.svg --submit-to-printer --no-auto-start
```
## Usage
### Basic Usage
```bash
# Convert SVG to G-code
microweldr input.svg
# Using the module directly
python -m microweldr.cli.main input.svg
```
### Advanced Options
```bash
# Specify output file
microweldr input.svg -o output.gcode
# Skip bed leveling
microweldr input.svg --skip-bed-leveling
# Use custom configuration
microweldr input.svg -c custom_config.toml
# Skip animation generation
microweldr input.svg --no-animation
# Skip validation
microweldr input.svg --no-validation
# Verbose output
microweldr input.svg --verbose
```
### Quick Start with Examples
```bash
# Run with example files
make run-example
make run-comprehensive
```
### Command Line Options
- `input_svg`: Input SVG file path (required)
- `-o, --output`: Output G-code file path (default: input_name.gcode)
- `-c, --config`: Configuration file path (default: config.toml)
- `--skip-bed-leveling`: Skip automatic bed leveling
- `--no-animation`: Skip generating animation SVG
- `--no-validation`: Skip validation steps
- `--verbose, -v`: Enable verbose output
- `--weld-sequence`: Welding sequence algorithm (linear, binary, farthest, skip)
- `--submit-to-printer`: Submit G-code to PrusaLink after generation
- `--secrets-config`: Path to secrets configuration file (default: secrets.toml)
- `--printer-storage`: Target storage on printer (local or usb)
- `--auto-start-print`: Automatically start printing after upload (overrides config)
- `--no-auto-start`: Do not start printing after upload (overrides config)
- `--queue-only`: Queue the file without starting (clearer intent than --no-auto-start)
## SVG Requirements
### Coordinate System
- SVG coordinates should be in millimeters
- Origin (0,0) corresponds to the printer bed origin
### Element Processing Order
- Elements are processed in order of their SVG ID attributes
- IDs with numeric components are sorted numerically
- Elements without IDs are processed last
### Color-Based Weld Types
MicroWeldr interprets SVG element colors to determine weld behavior:
#### **Recognized Colors:**
- **Black elements** (default): Normal welding with full temperature and multi-pass
- **Blue elements**: Light welding with reduced temperature and shorter welding time
- **Red elements**: Stop points with custom pause messages for manual intervention
- **Pink/Magenta elements**: Pipetting stops for microfluidic device filling
#### **Other Colors (Ignored):**
- **All other colors** (green, orange, purple, yellow, etc.): **Completely ignored** - no G-code generated
- **Gray elements**: Ignored (commonly used for labels and annotations)
- **White elements**: Ignored
- **Any unlisted color**: Ignored and skipped during processing
#### **Color Specification:**
Colors can be specified via:
- `stroke` attribute: `stroke="black"`
- `fill` attribute: `fill="blue"`
- `style` attribute: `style="fill:red;stroke:none"`
#### **Best Practice for Labels:**
Use non-weld colors (orange, purple, green, gray) for text labels and annotations to prevent unintended G-code generation:
```xml
<!-- These will be ignored (no welding) -->
<text fill="orange">Temperature: 130°C</text>
<text fill="purple">Dwell: 0.1s</text>
<text fill="gray">Calibration Grid</text>
```
### Pipetting Stops for Microfluidics 🧪
**Pink/Magenta elements** create pipetting stops specifically designed for microfluidic device operation:
**Supported Colors:**
- `magenta`, `pink`, `fuchsia`
- `#ff00ff`, `#f0f`, `#ff69b4`, `#ffc0cb`
- `rgb(255,0,255)`, `rgb(255,105,180)`, `rgb(255,192,203)`
**Use Cases:**
- **Reagent filling**: Pause to add reagents to pouches
- **Sample injection**: Stop for sample introduction
- **Buffer addition**: Add buffers or washing solutions
- **Collection**: Insert collection tubes or containers
**Example:**
```xml
<!-- Pipetting stop with custom message -->
<circle cx="60" cy="50" r="8" fill="magenta"
title="Fill with 10μL reagent A using micropipette"/>
```
### Custom Pause Messages
Both red elements (stop points) and pink elements (pipetting stops) can include custom messages displayed on the printer screen. Messages can be specified using any of these SVG attributes (in order of priority):
- `data-message="Your custom message"` - Recommended custom data attribute
- `title="Your custom message"` - Standard SVG title attribute
- `desc="Your custom message"` - SVG description element
- `aria-label="Your custom message"` - Accessibility label
If no message is specified, the default "Manual intervention required" will be used.
**Example:**
```xml
<!-- Stop with custom message -->
<circle cx="50" cy="50" r="2" fill="red" data-message="Check weld quality and adjust temperature"/>
<!-- Stop using title attribute -->
<rect x="10" y="10" width="5" height="5" fill="red" title="Insert second plastic sheet"/>
```
### Special SVG Attributes
MicroWeldr recognizes several custom SVG attributes that allow fine-grained control over welding parameters and behavior:
#### **Custom Pause Messages**
Control what message appears on the printer screen during stops:
- **`data-message="text"`** - Custom pause message (recommended)
- **`title="text"`** - Standard SVG title attribute
- **`desc="text"`** - SVG description element
- **`aria-label="text"`** - Accessibility label
**Priority Order**: `data-message` > `title` > `desc` > `aria-label` > default message
#### **Custom Welding Parameters**
Override default welding settings per element:
- **`data-temp="180"`** - Custom temperature in °C
- **`data-welding-time="0.5"`** - Custom welding time in seconds
- **`data-height="0.03"`** - Custom weld height in mm
- **`data-spacing="1.5"`** - Custom dot spacing in mm
#### **Processing Control**
Control how elements are processed:
- **`data-skip="true"`** - Skip this element entirely
- **`data-priority="10"`** - Processing priority (lower = earlier)
- **`id="weld_001"`** - Element ID for ordering (numeric IDs sorted)
#### **Animation Control**
Customize animation appearance:
- **`data-animate="false"`** - Exclude from animation
- **`data-color="#ff0000"`** - Custom animation color
- **`data-delay="2.0"`** - Extra delay before this element (seconds)
#### **Complete Example**
```xml
<!-- Normal weld with custom parameters -->
<line x1="10" y1="10" x2="50" y2="10"
stroke="black"
data-temp="160"
data-welding-time="0.3"
data-height="0.025"
id="weld_001"/>
<!-- Stop point with custom message and priority -->
<circle cx="30" cy="30" r="2"
fill="red"
data-message="Insert reagent tube and press continue"
data-priority="5"
title="Reagent insertion point"/>
<!-- Light weld with custom spacing -->
<path d="M 60,20 L 80,20 L 80,40 Z"
stroke="blue"
data-spacing="0.8"
data-animate="true"
data-color="#00aaff"/>
<!-- Pipetting stop with custom parameters -->
<rect x="70" y="50" width="5" height="5"
fill="magenta"
data-message="Pipette 5μL sample into chamber"
data-delay="1.0"
aria-label="Sample injection point"/>
```
#### **Parameter Inheritance**
- **Global defaults** from `config.toml` apply to all elements
- **Color-based defaults** (normal/light welds) override global defaults
- **Custom attributes** override both global and color-based defaults
- **Invalid values** fall back to defaults with warnings
#### **Validation**
- Temperature: 100-300°C (validated against printer limits)
- **Welding time**: 0.1-5.0 seconds (prevents damage)
- Height: 0.01-1.0 mm (prevents crashes)
- Spacing: 0.1-10.0 mm (reasonable welding density)
### Supported SVG Elements
- `<path>` - Follows path commands (M, L, Z supported)
- `<line>` - Straight lines between two points
- `<circle>` - Circular paths
- `<rect>` - Rectangular paths
## G-code Output
The generated G-code includes:
1. **Initialization**: Homing, absolute positioning
2. **Bed Leveling**: Optional automatic bed leveling (G29)
3. **Heating**: Bed and nozzle to specified temperatures
4. **User Pause**: For inserting plastic sheets (M0)
5. **Multi-Pass Welding Process**:
- **Pass 1**: Create initial dots with wide spacing (allows plastic to set)
- **Cooling Period**: Wait between passes for plastic to cool
- **Pass 2+**: Fill in between previous dots until desired density achieved
- Each dot: Move to position → Lower → Dwell → Raise
6. **Cooldown**: Lower temperatures and home axes
## Sending G-code to Prusa Printer
Once you've generated the G-code file, you can send it to your Prusa Core One printer using several methods:
### Method 1: PrusaConnect (Recommended)
**Best for**: Remote monitoring and cloud-based printing
1. **Upload via Web Interface**:
- Open [connect.prusa3d.com](https://connect.prusa3d.com) in your browser
- Log in to your Prusa account
- Select your printer from the dashboard
- Click "Upload G-code" or drag and drop your `.gcode` file
- The file will be transferred to your printer automatically
2. **Start the Print**:
- The G-code will appear in your printer's file list
- Select the file on the printer's touchscreen
- Press "Print" to begin the welding process
- Monitor progress remotely via PrusaConnect dashboard
### Method 2: USB Drive
**Best for**: Offline printing and large files
1. **Prepare USB Drive**:
- Use a FAT32 formatted USB drive
- Copy your `.gcode` file to the root directory or a folder
- Safely eject the USB drive from your computer
2. **Load on Printer**:
- Insert the USB drive into the printer's USB port
- Navigate to "Print from USB" on the touchscreen
- Browse and select your G-code file
- Press "Print" to start welding
### Method 3: PrusaLink (Local Network)
**Best for**: Local network printing without cloud dependency
1. **Access PrusaLink Interface**:
- Find your printer's IP address (Settings → Network → Wi-Fi Info)
- Open `http://[printer-ip-address]` in your browser
- Or use the Prusa app to connect locally
2. **Upload G-code**:
- Click "Upload G-code" in the PrusaLink interface
- Select your `.gcode` file
- The file transfers directly to the printer over your local network
3. **Start Printing**:
- Select the uploaded file from the printer's interface
- Begin the welding process
### Pre-Print Checklist
Before starting the welding process:
#### **Printer Preparation**
- [ ] **Clean the bed**: Remove any residue from previous prints
- [ ] **Check nozzle**: Ensure nozzle is clean and appropriate for welding
- [ ] **Verify temperatures**: Confirm bed and nozzle temperature settings match your plastic
- [ ] **Load filament**: Even though no extrusion occurs, some printers require filament to be loaded
#### **Material Preparation**
- [ ] **Plastic sheets ready**: Have your plastic sheets cut to size and ready to insert
- [ ] **Film securing**: Consider using magnets to hold down bubble film (⚠️ **Warning**: heated bed may be hot!)
- [ ] **Height clearance**: Ensure travel height (`move_height`) is higher than any magnets to prevent head crashes
- [ ] **Workspace clear**: Ensure adequate ventilation for plastic welding
- [ ] **Safety equipment**: Have appropriate safety gear (ventilation, eye protection)
#### **G-code Verification**
- [ ] **Review animation**: Check the generated `*_animation.svg` file to verify weld pattern
- [ ] **Validate settings**: Confirm temperatures and timing are appropriate for your materials
- [ ] **Check pause points**: Note where manual intervention will be required
### During the Welding Process
#### **Initial Setup Phase**
1. **Homing**: Printer will home all axes automatically
2. **Bed Leveling**: If enabled, automatic bed leveling will run (G29)
3. **Heating**: Bed and nozzle will heat to specified temperatures
4. **User Pause**: Printer will pause with message "Insert plastic sheets and press continue"
#### **Welding Phase**
1. **Multi-pass welding**: Printer follows the programmed sequence
2. **Pause points**: Respond to custom pause messages (red elements in SVG)
3. **Monitor progress**: Watch for proper weld formation and material behavior
4. **Temperature management**: Printer automatically manages heating between weld types
#### **Completion**
1. **Cooldown**: Printer will automatically cool down nozzle and bed
2. **Homing**: Final homing sequence
3. **Completion message**: Printer indicates welding is complete
### Troubleshooting Transfer Issues
#### **File Not Recognized**
- Ensure file has `.gcode` extension
- Check file size (some methods have limits)
- Verify G-code syntax with a G-code viewer
#### **Connection Problems**
- **PrusaConnect**: Check internet connection and printer online status
- **PrusaLink**: Verify printer and computer are on same network
- **USB**: Try different USB drive or reformat as FAT32
#### **Upload Failures**
- Check available storage space on printer
- Try smaller file sizes or reduce complexity
- Restart printer network connection if needed
### File Management Tips
- **Organize files**: Use descriptive names like `project_name_v1.gcode`
- **Keep backups**: Save both SVG source and generated G-code files
- **Version control**: Include date/version in filenames for tracking
- **Clean up**: Regularly remove old files from printer storage
### Safety Reminders
- **Never leave unattended**: Always supervise the welding process
- **Emergency stop**: Know how to use the printer's emergency stop function
- **Ventilation**: Ensure adequate ventilation for plastic welding fumes
- **Temperature safety**: Be cautious around heated components
## Multi-Pass Welding System
The welder implements an intelligent multi-pass system that allows plastic to cool between welding operations:
### How It Works
1. **Initial Pass**: Places dots with wide spacing (`initial_dot_spacing`)
2. **Cooling Period**: Waits for `cooling_time_between_passes` to let plastic cool
3. **Subsequent Passes**: Progressively fills in between existing dots
4. **Final Density**: Achieves the desired `dot_spacing` through multiple passes
### Benefits
- **Prevents Overheating**: Allows plastic to cool between passes
- **Better Quality**: Reduces warping and material degradation
- **Consistent Results**: Each dot gets proper cooling time
- **Automatic Calculation**: Number of passes calculated from spacing ratio
### Configuration Example
```toml
[normal_welds]
dot_spacing = 2.0 # Final 2mm spacing
initial_dot_spacing = 8.0 # Start with 8mm spacing
cooling_time_between_passes = 2.0 # 2 seconds between passes
```
This creates **3 passes**: 8mm → 4mm → 2mm spacing with 2-second cooling between each pass.
## Animation Output
The script generates an enhanced animated SVG file showing:
- **Realistic nozzle rings** that flip into existence at each weld point
- **Temperature-based visualization** with color-coded heat zones
- **Overlapping ring patterns** showing actual nozzle contact areas
- **Pause messages displayed** with yellow background and red text
- **Timing information** displayed in header (duration, intervals, pause time)
- **Enhanced legend** with nozzle ring examples and dimensions
- **Endless loop animation** with realistic timing
### Animation Features
- **Realistic nozzle visualization**: Shows outer diameter (contact area) and inner diameter (heated zone)
- **Flip animation**: Nozzle rings scale and flip into existence with realistic physics
- **Temperature visualization**: Orange/red rings for normal welds, blue rings for light welds
- **Heat effects**: Subtle glow animation around weld points
- **Configurable nozzle dimensions**: Set actual nozzle OD/ID in configuration
- **10x scale factor**: Nozzle dimensions scaled up for visibility in animation
- **Pause message display**: Stop points show custom messages for specified `pause_time`
- **Smart duration calculation**: Automatically calculates total time based on weld count and pauses
## Validation Features
MicroWeldr automatically validates all inputs and outputs:
### Input SVG Validation
- **Structure Check**: Verifies proper SVG root element and namespace
- **Attribute Validation**: Checks for required width/height attributes
- **Syntax Validation**: Uses lxml for robust XML syntax checking
### G-code Output Validation
- **Command Verification**: Validates G-code syntax and structure
- **Sequence Checking**: Ensures proper initialization, homing, and temperature commands
- **Movement Validation**: Confirms presence of required movement commands
- **Safety Verification**: Checks for proper heating/cooling sequences
### Animation SVG Validation
- **Element Counting**: Verifies presence of animation and circle elements
- **Structure Validation**: Ensures proper SVG animation syntax
- **Content Verification**: Confirms animation elements match expected output
All validation is **non-blocking** - the script continues processing even if validation fails, but provides detailed feedback about any issues found.
## Sample Files
The repository includes several example files:
- **`example.svg`**: Basic demonstration of all weld types and pause messages
- **`pause_examples.svg`**: Comprehensive examples of different pause message attributes
- **`comprehensive_sample.svg`**: Full-featured sample demonstrating all capabilities including:
- Multiple normal weld shapes (lines, rectangles, circles, complex paths)
- Light weld patterns with curved paths
- Stop points with various message attributes
- Processing order indicators
- Complete workflow demonstration
## Example Workflow
1. Create an SVG file with your welding pattern (or use `comprehensive_sample.svg`)
2. Use black paths for normal welds, blue for light welds
3. Add red elements where you need manual stops with custom messages
4. Run the script: `python svg_to_gcode_welder.py pattern.svg`
5. Review validation output for any issues
6. Load the generated G-code file on your Prusa Core One
7. Insert plastic sheets when prompted
8. Monitor the welding process and respond to custom pause messages
## Safety Notes
- Always supervise the welding process
- Ensure proper ventilation when welding plastics
- Verify temperatures are appropriate for your plastic materials
- Test with small samples before full production runs
- The script includes safety pauses - use them to check progress
## Troubleshooting
### Common Issues
- **SVG not parsing**: Ensure SVG uses standard elements and attributes
- **Wrong coordinates**: Verify SVG units are in millimeters
- **Missing weld points**: Check dot spacing configuration
- **Temperature issues**: Adjust temperatures in config.toml for your materials
### Debug Tips
- Check the generated animation SVG to verify path interpretation
- Use a G-code viewer to preview the toolpath
- Start with simple test patterns before complex designs
## Running the Examples
### For Installed Package
If you've installed microweldr as a package:
```bash
# Install the package
pip install microweldr
# Run examples (assuming you have the example files)
microweldr example.svg
microweldr example.svg --verbose
microweldr example.svg -o my_output.gcode
```
### For Development/Source Code
If you're working with the source code:
```bash
# Setup (one-time)
python -m venv venv
source venv/bin/activate # macOS/Linux (venv\Scripts\activate on Windows)
pip install -e .
# Run examples (with venv activated)
microweldr examples/example.svg
microweldr examples/comprehensive_sample.svg
microweldr examples/example.svg --verbose
# Alternative methods
python -m microweldr.cli.main examples/example.svg
```
**📖 For detailed development setup, see [DEVELOPMENT.md](DEVELOPMENT.md)**
### Example Files Included
- **`examples/example.svg`**: Basic demonstration with normal welds, light welds, and stop points
- **`examples/comprehensive_sample.svg`**: Full-featured demo showing all capabilities
- **`examples/pause_examples.svg`**: Examples of different pause message formats
- **`examples/config.toml`**: Complete configuration file with all parameters
### Expected Output
Each run generates:
- **G-code file**: `example.gcode` - Ready to load on Prusa Core One
- **Animation file**: `example_animation.svg` - Visual preview of welding sequence
- **Console output**: Processing details and validation results
### Alternative Run Methods
```bash
# Using Python module (with virtual environment activated)
python -m microweldr.cli.main examples/example.svg
# With custom configuration
microweldr examples/example.svg -c my_config.toml
```
## Materials Guide
### Bubble Film Polypropylene Orientation
When working with bubble film rolls for microfluidic device creation:
**🔍 Identifying the Polypropylene Side:**
- **Smooth side**: This is the **polypropylene layer** - use this side for welding
- **Bubble side**: This is typically polyethylene - **do not weld this side**
**📏 Proper Orientation:**
- Place bubble film with **smooth side UP** on the printer bed
- The welding nozzle should contact the **smooth polypropylene surface**
- Bubbles should face **DOWN** toward the bed
**🌡️ Temperature Guidelines:**
- **Polypropylene welding**: 160-180°C (use light welds for thin films)
- **Test first**: Always test weld parameters on scrap material
- **Avoid overheating**: Polypropylene can degrade above 200°C
**⚠️ Safety Notes:**
- Ensure adequate ventilation when welding plastics
- Test weld strength before using for critical applications
- Different bubble film manufacturers may use different material combinations
**💡 Pro Tip:**
Use the `data-temp` attribute in your SVG to fine-tune welding temperature for different areas:
```xml
<line stroke="black" data-temp="165" data-welding-time="0.2" />
```
## License
This project is open source. Use at your own risk and ensure proper safety precautions when operating 3D printing equipment.
Raw data
{
"_id": null,
"home_page": null,
"name": "microweldr",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.8.1",
"maintainer_email": null,
"keywords": "svg, gcode, 3d-printing, welding, prusa",
"author": "Your Name",
"author_email": "your.email@example.com",
"download_url": "https://files.pythonhosted.org/packages/8f/36/5904807021d9f3afa743ba0790b3ee4b5d6d155a18c9a7fc583a22e933c7/microweldr-3.0.2.tar.gz",
"platform": null,
"description": "# MicroWeldr\n\nA Python package that converts SVG files to Prusa Core One G-code for plastic \"spot\" welding applications. The package processes SVG vector graphics and generates G-code that creates weld spots along the paths without extruding any plastic material.\n\n**Optimized for Prusa Core One**: Includes chamber temperature control (M141/M191), proper bed dimensions (250\u00d7220\u00d7270mm), CoreXY-specific settings, and **layed back mode** *(currently not working)* - designed for when your printer is positioned on its back (door pointing up) so liquids can be pipetted into pouches and gravity holds them in place before heat sealing.\n\nThis allows for rapid microfluidics prototyping with a 3d printer.\nWhile the edges are not as smooth as a laser weld, the 3d printer is more available than a laser welder.\n\n## Project Structure\n\n```\nmicroweldr/\n\u251c\u2500\u2500 microweldr/ # Main package\n\u2502 \u251c\u2500\u2500 core/ # Core functionality\n\u2502 \u251c\u2500\u2500 validation/ # Validation modules\n\u2502 \u251c\u2500\u2500 animation/ # Animation generation\n\u2502 \u2514\u2500\u2500 cli/ # Command line interface\n\u251c\u2500\u2500 tests/ # Test suite\n\u2502 \u251c\u2500\u2500 unit/ # Unit tests\n\u2502 \u2514\u2500\u2500 integration/ # Integration tests\n\u251c\u2500\u2500 examples/ # Example files and configurations\n\u251c\u2500\u2500 docs/ # Documentation\n\u2514\u2500\u2500 pyproject.toml # Poetry configuration\n```\n\n## Features\n\n- **SVG Processing**: Converts SVG paths, lines, circles, and rectangles to weld points\n- **Color-based Weld Types**:\n - Black elements \u2192 Normal welds\n - Blue elements \u2192 Light welds (lower temperature, shorter welding time)\n - Red elements \u2192 Stop points (pause for user intervention)\n- **Configurable Parameters**: TOML-based configuration for temperatures, heights, and timing\n- **Bed Leveling**: Optional automatic bed leveling (can be disabled)\n- **Animation Output**: Generates animated SVG showing the welding sequence\n- **Proper G-code Structure**: Includes heating, cooling, and safety procedures\n- **PrusaLink Integration**: Direct G-code submission to Prusa MINI via PrusaLink API\n\n## Installation\n\n### **From PyPI (Recommended)**\n```bash\npip install microweldr\n```\n\nThat's it! All validation and development tools are included by default.\n\n### **Development Installation**\n```bash\n# Clone repository\ngit clone https://github.com/retospect/microweldr.git\ncd microweldr\n\n# Install in editable mode\npip install -e .\n```\n\n## Available Commands\n\nAfter installation, these console commands are available:\n\n### **Main Commands**\n```bash\n# SVG to G-code conversion\nmicroweldr input.svg -o output.gcode\n\n# Print with automatic monitoring\nmicroweldr input.svg --submit-to-printer --monitor\nmicroweldr input.svg --submit-to-printer --monitor --monitor-mode pipetting\n```\n\n### **Utility Commands**\n```bash\n# Printer control tool\nmicroweldr-control status # Check printer status\nmicroweldr-control monitor # Monitor current print\nmicroweldr-control stop # Stop current print\n\n# Test PrusaLink connection\nmicroweldr-test\n```\n\n## Configuration\n\nEdit `config.toml` to adjust welding parameters:\n\n```toml\n[temperatures]\nbed_temperature = 80 # \u00b0C\nnozzle_temperature = 200 # \u00b0C for normal welds\nchamber_temperature = 35 # \u00b0C - Core One chamber temperature\nuse_chamber_heating = false # Set to false to disable chamber heating (useful if sensor is not working)\n\n[movement]\nmove_height = 5.0 # mm - safe travel height\nweld_height = 0.2 # mm - welding height\n\n[normal_welds]\nweld_temperature = 200 # \u00b0C\ndot_spacing = 0.3 # mm - final desired spacing\ninitial_dot_spacing = 8.0 # mm - spacing for first pass (wider)\ncooling_time_between_passes = 2.0 # seconds - cooling between passes\n\n[light_welds]\nweld_temperature = 180 # \u00b0C - lower temperature\nwelding_time = 0.3 # seconds - shorter time\ndot_spacing = 0.3 # mm - final desired spacing\ninitial_dot_spacing = 12.0 # mm - spacing for first pass (wider)\ncooling_time_between_passes = 1.5 # seconds - cooling between passes\n\n[nozzle]\nouter_diameter = 0.4 # mm - nozzle outer diameter\ninner_diameter = 0.2 # mm - nozzle inner diameter (opening)\n\n[animation]\ntime_between_welds = 0.1 # seconds - time between weld points in animation\npause_time = 3.0 # seconds - how long pause messages are displayed\nmin_animation_duration = 10.0 # seconds - minimum total animation time\n```\n\n### Configuration File Loading\n\nMicroWeldr looks for configuration files in the following order (first found wins):\n\n#### **Main Configuration (`config.toml`)**\n1. **Command line specified**: `-c custom_config.toml` or `--config custom_config.toml`\n2. **Current directory**: `./config.toml`\n3. **Examples directory**: `./examples/config.toml` (if running from repo root)\n4. **Package defaults**: Built-in fallback configuration\n\n#### **Secrets Configuration (`secrets.toml`)**\nUsed for PrusaLink printer connection settings:\n\n1. **Command line specified**: `--secrets-config custom_secrets.toml`\n2. **Current directory**: `./secrets.toml`\n3. **Examples directory**: `./examples/secrets.toml`\n4. **No secrets file**: PrusaLink features disabled (local G-code generation only)\n\n#### **Configuration Hierarchy**\n- **Built-in defaults** provide base configuration\n- **Main config file** overrides defaults\n- **Command line arguments** override config file settings\n- **SVG attributes** override all other settings (per-element)\n\n#### **File Locations Examples**\n```bash\n# Using default config in current directory\nmicroweldr input.svg # Uses ./config.toml\n\n# Using custom config file\nmicroweldr input.svg -c my_config.toml # Uses my_config.toml\n\n# Using custom secrets file\nmicroweldr input.svg --secrets-config my_secrets.toml\n\n# Both custom configs\nmicroweldr input.svg -c my_config.toml --secrets-config my_secrets.toml\n```\n\n#### **Config File Templates**\n- **`config.toml`**: Main welding parameters (temperatures, speeds, etc.)\n- **`examples/config.toml`**: Optimized settings for new users\n- **`secrets.toml`**: PrusaLink connection settings (not in git)\n- **`secrets.toml.template`**: Template for PrusaLink setup\n\n#### **Missing Files Behavior**\n- **No config.toml**: Uses built-in defaults (safe for basic operation)\n- **No secrets.toml**: PrusaLink disabled, local G-code generation only\n- **Invalid config**: Falls back to defaults with warnings\n- **Partial config**: Missing sections use defaults\n\n## Layed Back Mode (\u26a0\ufe0f EXPERIMENTAL - NOT WORKING YET)\n\n**\u26a0\ufe0f WARNING: Layed back mode is currently under development and does not work properly. Use standard upright mode for reliable operation.**\n\nThe SVG welder was designed to support \"layed back printer operation\" - when your printer is chillin' on its back with the door pointing up for easy access to microfluidic devices. However, this mode is currently experiencing technical issues.\n\n### **Known Issues:**\n- \u274c Calibration conflicts with manual positioning\n- \u274c Z-axis homing issues when printer is on its back\n- \u274c Coordinate system needs adjustment for inverted orientation\n- \u274c Safety features need refinement for this configuration\n\n### **Current Recommendation:**\n```toml\n[printer]\nlayed_back_mode = false # Use standard upright mode for now\n```\n\n### **Future Development:**\nOnce the issues are resolved, layed back mode will provide:\n- Easy access for pipetting and microfluidic operations\n- Manual positioning with trusted coordinates\n- Optimized G-code for inverted printer orientation\n\n### **\ud83d\udccd Manual Positioning Required**\n**IMPORTANT**: Before starting any print (your printer is trusting you completely!):\n1. **Manually position** the print head to the **rear right corner** of the bed\n2. **Set Z-height manually** - position nozzle at desired starting height above bed\n3. **All positioning trusted** - the printer is chillin' and trusts your complete setup\n4. **G92 X0 Y0 Z0** sets all axes as origin (no automatic homing performed)\n\n### **\ud83d\udee1\ufe0f Safety Features for Layed Back Mode**\n- \u2705 **No automatic homing** (prevents all endpoint errors when printer is on its back)\n- \u2705 **Fully manual positioning** (complete trust in your setup for all axes)\n- \u2705 **No bed leveling** (too risky when printer is layed back)\n- \u2705 **Slower movements** (3000 mm/min travel, 150 mm/min Z-axis - no rush!)\n- \u2705 **Disabled stepper timeout** (M84 S0 - printer stays relaxed)\n- \u2705 **Gentle Z positioning** (slow movements to avoid crashes)\n\n### **\u2699\ufe0f Standard Mode (For Uptight Printers)**\nSet `layed_back_mode = false` for normal upright printer operation with full homing and bed leveling.\n\n## PrusaLink Configuration\n\nTo enable direct G-code submission to your Prusa Core One, you need to configure PrusaLink access:\n\n### 1. Setup PrusaLink on Your Printer\n- Enable PrusaLink on your Prusa Core One (should be enabled by default on newer firmware)\n- Connect your printer to your network (WiFi or Ethernet)\n- Note your printer's IP address (check printer display or router) or find its `.local` hostname\n\n### 2. Find Your Printer's Address\nYou can use either:\n- **IP Address**: Check your printer's display or router's connected devices\n- **.local hostname**: Usually `prusacoreone.local` or similar (check printer display for exact name)\n\n### 3. Get Authentication Credentials\n**Choose ONE method:**\n\n**Method A: LCD Password (Recommended - Easier)**\n- Check your printer's LCD display for the password (usually shown in network settings)\n- No web interface setup needed\n\n**Method B: API Key (Alternative)**\n- Open your printer's web interface: `http://YOUR_PRINTER_IP` or `http://prusacoreone.local`\n- Go to Settings \u2192 API\n- Generate or copy your API key\n\n### 4. Configure secrets.toml\nCopy the template and fill in your details:\n```bash\ncp secrets.toml.template secrets.toml\n```\n\nEdit `secrets.toml`:\n```toml\n[prusalink]\nhost = \"192.168.1.100\" # Your printer's IP address\n# OR use .local hostname:\n# host = \"prusacoreone.local\" # More convenient, doesn't change with DHCP\n\n# Method A: LCD Password (recommended)\nusername = \"maker\" # Default username (usually \"maker\")\npassword = \"your-lcd-password\" # Password from printer's LCD display\n\n# Method B: API Key (alternative - comment out Method A if using this)\n# username = \"maker\"\n# api_key = \"your-api-key-here\" # From printer's web interface\n\ndefault_storage = \"local\" # \"local\" or \"usb\"\nauto_start_print = true # Whether to start printing immediately\ntimeout = 30 # Connection timeout in seconds\n```\n\n### 5. Test Connection\n```bash\nmicroweldr-test\n```\n\n### 6. Submit G-code to Printer\n```bash\n# Generate and submit G-code (starts printing immediately with default config)\nmicroweldr input.svg --submit-to-printer\n\n# Force immediate printing (overrides config)\nmicroweldr input.svg --submit-to-printer --auto-start-print\n\n# Use USB storage instead of local\nmicroweldr input.svg --submit-to-printer --printer-storage usb\n\n# Upload without starting (override config default)\nmicroweldr input.svg --submit-to-printer --no-auto-start\n\n# Queue the file for later printing (clearer intent)\nmicroweldr input.svg --submit-to-printer --queue-only\n```\n\n## Printing Modes\n\nThe SVG welder supports three different printing modes when submitting to your printer:\n\n### **\ud83d\ude80 Immediate Printing** (Default)\nFiles are uploaded and printing starts immediately:\n```bash\nmicroweldr input.svg --submit-to-printer\n# or force immediate printing:\nmicroweldr input.svg --submit-to-printer --auto-start-print\n```\n\n### **\ud83d\udccb Queue Mode**\nFiles are uploaded and queued for later printing:\n```bash\nmicroweldr input.svg --submit-to-printer --queue-only\n```\nUse this when:\n- You want to prepare multiple files\n- The printer is currently busy\n- You want to review the file before printing\n\n### **\ud83d\udcc1 Upload Only**\nFiles are uploaded without any automatic behavior:\n```bash\nmicroweldr input.svg --submit-to-printer --no-auto-start\n```\n\n## Usage\n\n### Basic Usage\n```bash\n# Convert SVG to G-code\nmicroweldr input.svg\n\n# Using the module directly\npython -m microweldr.cli.main input.svg\n```\n\n### Advanced Options\n```bash\n# Specify output file\nmicroweldr input.svg -o output.gcode\n\n# Skip bed leveling\nmicroweldr input.svg --skip-bed-leveling\n\n# Use custom configuration\nmicroweldr input.svg -c custom_config.toml\n\n# Skip animation generation\nmicroweldr input.svg --no-animation\n\n# Skip validation\nmicroweldr input.svg --no-validation\n\n# Verbose output\nmicroweldr input.svg --verbose\n```\n\n### Quick Start with Examples\n```bash\n# Run with example files\nmake run-example\nmake run-comprehensive\n```\n\n### Command Line Options\n- `input_svg`: Input SVG file path (required)\n- `-o, --output`: Output G-code file path (default: input_name.gcode)\n- `-c, --config`: Configuration file path (default: config.toml)\n- `--skip-bed-leveling`: Skip automatic bed leveling\n- `--no-animation`: Skip generating animation SVG\n- `--no-validation`: Skip validation steps\n- `--verbose, -v`: Enable verbose output\n- `--weld-sequence`: Welding sequence algorithm (linear, binary, farthest, skip)\n- `--submit-to-printer`: Submit G-code to PrusaLink after generation\n- `--secrets-config`: Path to secrets configuration file (default: secrets.toml)\n- `--printer-storage`: Target storage on printer (local or usb)\n- `--auto-start-print`: Automatically start printing after upload (overrides config)\n- `--no-auto-start`: Do not start printing after upload (overrides config)\n- `--queue-only`: Queue the file without starting (clearer intent than --no-auto-start)\n\n## SVG Requirements\n\n### Coordinate System\n- SVG coordinates should be in millimeters\n- Origin (0,0) corresponds to the printer bed origin\n\n### Element Processing Order\n- Elements are processed in order of their SVG ID attributes\n- IDs with numeric components are sorted numerically\n- Elements without IDs are processed last\n\n### Color-Based Weld Types\n\nMicroWeldr interprets SVG element colors to determine weld behavior:\n\n#### **Recognized Colors:**\n- **Black elements** (default): Normal welding with full temperature and multi-pass\n- **Blue elements**: Light welding with reduced temperature and shorter welding time\n- **Red elements**: Stop points with custom pause messages for manual intervention\n- **Pink/Magenta elements**: Pipetting stops for microfluidic device filling\n\n#### **Other Colors (Ignored):**\n- **All other colors** (green, orange, purple, yellow, etc.): **Completely ignored** - no G-code generated\n- **Gray elements**: Ignored (commonly used for labels and annotations)\n- **White elements**: Ignored\n- **Any unlisted color**: Ignored and skipped during processing\n\n#### **Color Specification:**\nColors can be specified via:\n- `stroke` attribute: `stroke=\"black\"`\n- `fill` attribute: `fill=\"blue\"` \n- `style` attribute: `style=\"fill:red;stroke:none\"`\n\n#### **Best Practice for Labels:**\nUse non-weld colors (orange, purple, green, gray) for text labels and annotations to prevent unintended G-code generation:\n```xml\n<!-- These will be ignored (no welding) -->\n<text fill=\"orange\">Temperature: 130\u00b0C</text>\n<text fill=\"purple\">Dwell: 0.1s</text>\n<text fill=\"gray\">Calibration Grid</text>\n```\n\n### Pipetting Stops for Microfluidics \ud83e\uddea\n\n**Pink/Magenta elements** create pipetting stops specifically designed for microfluidic device operation:\n\n**Supported Colors:**\n- `magenta`, `pink`, `fuchsia`\n- `#ff00ff`, `#f0f`, `#ff69b4`, `#ffc0cb`\n- `rgb(255,0,255)`, `rgb(255,105,180)`, `rgb(255,192,203)`\n\n**Use Cases:**\n- **Reagent filling**: Pause to add reagents to pouches\n- **Sample injection**: Stop for sample introduction\n- **Buffer addition**: Add buffers or washing solutions\n- **Collection**: Insert collection tubes or containers\n\n**Example:**\n```xml\n<!-- Pipetting stop with custom message -->\n<circle cx=\"60\" cy=\"50\" r=\"8\" fill=\"magenta\"\n title=\"Fill with 10\u03bcL reagent A using micropipette\"/>\n```\n\n### Custom Pause Messages\n\nBoth red elements (stop points) and pink elements (pipetting stops) can include custom messages displayed on the printer screen. Messages can be specified using any of these SVG attributes (in order of priority):\n\n- `data-message=\"Your custom message\"` - Recommended custom data attribute\n- `title=\"Your custom message\"` - Standard SVG title attribute\n- `desc=\"Your custom message\"` - SVG description element\n- `aria-label=\"Your custom message\"` - Accessibility label\n\nIf no message is specified, the default \"Manual intervention required\" will be used.\n\n**Example:**\n```xml\n<!-- Stop with custom message -->\n<circle cx=\"50\" cy=\"50\" r=\"2\" fill=\"red\" data-message=\"Check weld quality and adjust temperature\"/>\n\n<!-- Stop using title attribute -->\n<rect x=\"10\" y=\"10\" width=\"5\" height=\"5\" fill=\"red\" title=\"Insert second plastic sheet\"/>\n```\n\n### Special SVG Attributes\n\nMicroWeldr recognizes several custom SVG attributes that allow fine-grained control over welding parameters and behavior:\n\n#### **Custom Pause Messages**\nControl what message appears on the printer screen during stops:\n\n- **`data-message=\"text\"`** - Custom pause message (recommended)\n- **`title=\"text\"`** - Standard SVG title attribute \n- **`desc=\"text\"`** - SVG description element\n- **`aria-label=\"text\"`** - Accessibility label\n\n**Priority Order**: `data-message` > `title` > `desc` > `aria-label` > default message\n\n#### **Custom Welding Parameters**\nOverride default welding settings per element:\n\n- **`data-temp=\"180\"`** - Custom temperature in \u00b0C\n- **`data-welding-time=\"0.5\"`** - Custom welding time in seconds \n- **`data-height=\"0.03\"`** - Custom weld height in mm\n- **`data-spacing=\"1.5\"`** - Custom dot spacing in mm\n\n#### **Processing Control**\nControl how elements are processed:\n\n- **`data-skip=\"true\"`** - Skip this element entirely\n- **`data-priority=\"10\"`** - Processing priority (lower = earlier)\n- **`id=\"weld_001\"`** - Element ID for ordering (numeric IDs sorted)\n\n#### **Animation Control**\nCustomize animation appearance:\n\n- **`data-animate=\"false\"`** - Exclude from animation\n- **`data-color=\"#ff0000\"`** - Custom animation color\n- **`data-delay=\"2.0\"`** - Extra delay before this element (seconds)\n\n#### **Complete Example**\n```xml\n<!-- Normal weld with custom parameters -->\n<line x1=\"10\" y1=\"10\" x2=\"50\" y2=\"10\"\n stroke=\"black\"\n data-temp=\"160\"\n data-welding-time=\"0.3\"\n data-height=\"0.025\"\n id=\"weld_001\"/>\n\n<!-- Stop point with custom message and priority -->\n<circle cx=\"30\" cy=\"30\" r=\"2\"\n fill=\"red\"\n data-message=\"Insert reagent tube and press continue\"\n data-priority=\"5\"\n title=\"Reagent insertion point\"/>\n\n<!-- Light weld with custom spacing -->\n<path d=\"M 60,20 L 80,20 L 80,40 Z\"\n stroke=\"blue\"\n data-spacing=\"0.8\"\n data-animate=\"true\"\n data-color=\"#00aaff\"/>\n\n<!-- Pipetting stop with custom parameters -->\n<rect x=\"70\" y=\"50\" width=\"5\" height=\"5\"\n fill=\"magenta\"\n data-message=\"Pipette 5\u03bcL sample into chamber\"\n data-delay=\"1.0\"\n aria-label=\"Sample injection point\"/>\n```\n\n#### **Parameter Inheritance**\n- **Global defaults** from `config.toml` apply to all elements\n- **Color-based defaults** (normal/light welds) override global defaults \n- **Custom attributes** override both global and color-based defaults\n- **Invalid values** fall back to defaults with warnings\n\n#### **Validation**\n- Temperature: 100-300\u00b0C (validated against printer limits)\n- **Welding time**: 0.1-5.0 seconds (prevents damage)\n- Height: 0.01-1.0 mm (prevents crashes)\n- Spacing: 0.1-10.0 mm (reasonable welding density)\n\n### Supported SVG Elements\n- `<path>` - Follows path commands (M, L, Z supported)\n- `<line>` - Straight lines between two points\n- `<circle>` - Circular paths\n- `<rect>` - Rectangular paths\n\n## G-code Output\n\nThe generated G-code includes:\n\n1. **Initialization**: Homing, absolute positioning\n2. **Bed Leveling**: Optional automatic bed leveling (G29)\n3. **Heating**: Bed and nozzle to specified temperatures\n4. **User Pause**: For inserting plastic sheets (M0)\n5. **Multi-Pass Welding Process**:\n - **Pass 1**: Create initial dots with wide spacing (allows plastic to set)\n - **Cooling Period**: Wait between passes for plastic to cool\n - **Pass 2+**: Fill in between previous dots until desired density achieved\n - Each dot: Move to position \u2192 Lower \u2192 Dwell \u2192 Raise\n6. **Cooldown**: Lower temperatures and home axes\n\n## Sending G-code to Prusa Printer\n\nOnce you've generated the G-code file, you can send it to your Prusa Core One printer using several methods:\n\n### Method 1: PrusaConnect (Recommended)\n**Best for**: Remote monitoring and cloud-based printing\n\n1. **Upload via Web Interface**:\n - Open [connect.prusa3d.com](https://connect.prusa3d.com) in your browser\n - Log in to your Prusa account\n - Select your printer from the dashboard\n - Click \"Upload G-code\" or drag and drop your `.gcode` file\n - The file will be transferred to your printer automatically\n\n2. **Start the Print**:\n - The G-code will appear in your printer's file list\n - Select the file on the printer's touchscreen\n - Press \"Print\" to begin the welding process\n - Monitor progress remotely via PrusaConnect dashboard\n\n### Method 2: USB Drive\n**Best for**: Offline printing and large files\n\n1. **Prepare USB Drive**:\n - Use a FAT32 formatted USB drive\n - Copy your `.gcode` file to the root directory or a folder\n - Safely eject the USB drive from your computer\n\n2. **Load on Printer**:\n - Insert the USB drive into the printer's USB port\n - Navigate to \"Print from USB\" on the touchscreen\n - Browse and select your G-code file\n - Press \"Print\" to start welding\n\n### Method 3: PrusaLink (Local Network)\n**Best for**: Local network printing without cloud dependency\n\n1. **Access PrusaLink Interface**:\n - Find your printer's IP address (Settings \u2192 Network \u2192 Wi-Fi Info)\n - Open `http://[printer-ip-address]` in your browser\n - Or use the Prusa app to connect locally\n\n2. **Upload G-code**:\n - Click \"Upload G-code\" in the PrusaLink interface\n - Select your `.gcode` file\n - The file transfers directly to the printer over your local network\n\n3. **Start Printing**:\n - Select the uploaded file from the printer's interface\n - Begin the welding process\n\n### Pre-Print Checklist\n\nBefore starting the welding process:\n\n#### **Printer Preparation**\n- [ ] **Clean the bed**: Remove any residue from previous prints\n- [ ] **Check nozzle**: Ensure nozzle is clean and appropriate for welding\n- [ ] **Verify temperatures**: Confirm bed and nozzle temperature settings match your plastic\n- [ ] **Load filament**: Even though no extrusion occurs, some printers require filament to be loaded\n\n#### **Material Preparation**\n- [ ] **Plastic sheets ready**: Have your plastic sheets cut to size and ready to insert\n- [ ] **Film securing**: Consider using magnets to hold down bubble film (\u26a0\ufe0f **Warning**: heated bed may be hot!)\n- [ ] **Height clearance**: Ensure travel height (`move_height`) is higher than any magnets to prevent head crashes\n- [ ] **Workspace clear**: Ensure adequate ventilation for plastic welding\n- [ ] **Safety equipment**: Have appropriate safety gear (ventilation, eye protection)\n\n#### **G-code Verification**\n- [ ] **Review animation**: Check the generated `*_animation.svg` file to verify weld pattern\n- [ ] **Validate settings**: Confirm temperatures and timing are appropriate for your materials\n- [ ] **Check pause points**: Note where manual intervention will be required\n\n### During the Welding Process\n\n#### **Initial Setup Phase**\n1. **Homing**: Printer will home all axes automatically\n2. **Bed Leveling**: If enabled, automatic bed leveling will run (G29)\n3. **Heating**: Bed and nozzle will heat to specified temperatures\n4. **User Pause**: Printer will pause with message \"Insert plastic sheets and press continue\"\n\n#### **Welding Phase**\n1. **Multi-pass welding**: Printer follows the programmed sequence\n2. **Pause points**: Respond to custom pause messages (red elements in SVG)\n3. **Monitor progress**: Watch for proper weld formation and material behavior\n4. **Temperature management**: Printer automatically manages heating between weld types\n\n#### **Completion**\n1. **Cooldown**: Printer will automatically cool down nozzle and bed\n2. **Homing**: Final homing sequence\n3. **Completion message**: Printer indicates welding is complete\n\n### Troubleshooting Transfer Issues\n\n#### **File Not Recognized**\n- Ensure file has `.gcode` extension\n- Check file size (some methods have limits)\n- Verify G-code syntax with a G-code viewer\n\n#### **Connection Problems**\n- **PrusaConnect**: Check internet connection and printer online status\n- **PrusaLink**: Verify printer and computer are on same network\n- **USB**: Try different USB drive or reformat as FAT32\n\n#### **Upload Failures**\n- Check available storage space on printer\n- Try smaller file sizes or reduce complexity\n- Restart printer network connection if needed\n\n### File Management Tips\n\n- **Organize files**: Use descriptive names like `project_name_v1.gcode`\n- **Keep backups**: Save both SVG source and generated G-code files\n- **Version control**: Include date/version in filenames for tracking\n- **Clean up**: Regularly remove old files from printer storage\n\n### Safety Reminders\n\n- **Never leave unattended**: Always supervise the welding process\n- **Emergency stop**: Know how to use the printer's emergency stop function\n- **Ventilation**: Ensure adequate ventilation for plastic welding fumes\n- **Temperature safety**: Be cautious around heated components\n\n## Multi-Pass Welding System\n\nThe welder implements an intelligent multi-pass system that allows plastic to cool between welding operations:\n\n### How It Works\n1. **Initial Pass**: Places dots with wide spacing (`initial_dot_spacing`)\n2. **Cooling Period**: Waits for `cooling_time_between_passes` to let plastic cool\n3. **Subsequent Passes**: Progressively fills in between existing dots\n4. **Final Density**: Achieves the desired `dot_spacing` through multiple passes\n\n### Benefits\n- **Prevents Overheating**: Allows plastic to cool between passes\n- **Better Quality**: Reduces warping and material degradation\n- **Consistent Results**: Each dot gets proper cooling time\n- **Automatic Calculation**: Number of passes calculated from spacing ratio\n\n### Configuration Example\n```toml\n[normal_welds]\ndot_spacing = 2.0 # Final 2mm spacing\ninitial_dot_spacing = 8.0 # Start with 8mm spacing\ncooling_time_between_passes = 2.0 # 2 seconds between passes\n```\n\nThis creates **3 passes**: 8mm \u2192 4mm \u2192 2mm spacing with 2-second cooling between each pass.\n\n## Animation Output\n\nThe script generates an enhanced animated SVG file showing:\n- **Realistic nozzle rings** that flip into existence at each weld point\n- **Temperature-based visualization** with color-coded heat zones\n- **Overlapping ring patterns** showing actual nozzle contact areas\n- **Pause messages displayed** with yellow background and red text\n- **Timing information** displayed in header (duration, intervals, pause time)\n- **Enhanced legend** with nozzle ring examples and dimensions\n- **Endless loop animation** with realistic timing\n\n### Animation Features\n- **Realistic nozzle visualization**: Shows outer diameter (contact area) and inner diameter (heated zone)\n- **Flip animation**: Nozzle rings scale and flip into existence with realistic physics\n- **Temperature visualization**: Orange/red rings for normal welds, blue rings for light welds\n- **Heat effects**: Subtle glow animation around weld points\n- **Configurable nozzle dimensions**: Set actual nozzle OD/ID in configuration\n- **10x scale factor**: Nozzle dimensions scaled up for visibility in animation\n- **Pause message display**: Stop points show custom messages for specified `pause_time`\n- **Smart duration calculation**: Automatically calculates total time based on weld count and pauses\n\n## Validation Features\n\nMicroWeldr automatically validates all inputs and outputs:\n\n### Input SVG Validation\n- **Structure Check**: Verifies proper SVG root element and namespace\n- **Attribute Validation**: Checks for required width/height attributes\n- **Syntax Validation**: Uses lxml for robust XML syntax checking\n\n### G-code Output Validation\n- **Command Verification**: Validates G-code syntax and structure\n- **Sequence Checking**: Ensures proper initialization, homing, and temperature commands\n- **Movement Validation**: Confirms presence of required movement commands\n- **Safety Verification**: Checks for proper heating/cooling sequences\n\n### Animation SVG Validation\n- **Element Counting**: Verifies presence of animation and circle elements\n- **Structure Validation**: Ensures proper SVG animation syntax\n- **Content Verification**: Confirms animation elements match expected output\n\nAll validation is **non-blocking** - the script continues processing even if validation fails, but provides detailed feedback about any issues found.\n\n## Sample Files\n\nThe repository includes several example files:\n\n- **`example.svg`**: Basic demonstration of all weld types and pause messages\n- **`pause_examples.svg`**: Comprehensive examples of different pause message attributes\n- **`comprehensive_sample.svg`**: Full-featured sample demonstrating all capabilities including:\n - Multiple normal weld shapes (lines, rectangles, circles, complex paths)\n - Light weld patterns with curved paths\n - Stop points with various message attributes\n - Processing order indicators\n - Complete workflow demonstration\n\n## Example Workflow\n\n1. Create an SVG file with your welding pattern (or use `comprehensive_sample.svg`)\n2. Use black paths for normal welds, blue for light welds\n3. Add red elements where you need manual stops with custom messages\n4. Run the script: `python svg_to_gcode_welder.py pattern.svg`\n5. Review validation output for any issues\n6. Load the generated G-code file on your Prusa Core One\n7. Insert plastic sheets when prompted\n8. Monitor the welding process and respond to custom pause messages\n\n## Safety Notes\n\n- Always supervise the welding process\n- Ensure proper ventilation when welding plastics\n- Verify temperatures are appropriate for your plastic materials\n- Test with small samples before full production runs\n- The script includes safety pauses - use them to check progress\n\n## Troubleshooting\n\n### Common Issues\n- **SVG not parsing**: Ensure SVG uses standard elements and attributes\n- **Wrong coordinates**: Verify SVG units are in millimeters\n- **Missing weld points**: Check dot spacing configuration\n- **Temperature issues**: Adjust temperatures in config.toml for your materials\n\n### Debug Tips\n- Check the generated animation SVG to verify path interpretation\n- Use a G-code viewer to preview the toolpath\n- Start with simple test patterns before complex designs\n\n## Running the Examples\n\n### For Installed Package\nIf you've installed microweldr as a package:\n\n```bash\n# Install the package\npip install microweldr\n\n# Run examples (assuming you have the example files)\nmicroweldr example.svg\nmicroweldr example.svg --verbose\nmicroweldr example.svg -o my_output.gcode\n```\n\n### For Development/Source Code\nIf you're working with the source code:\n\n```bash\n# Setup (one-time)\npython -m venv venv\nsource venv/bin/activate # macOS/Linux (venv\\Scripts\\activate on Windows)\npip install -e .\n\n# Run examples (with venv activated)\nmicroweldr examples/example.svg\nmicroweldr examples/comprehensive_sample.svg\nmicroweldr examples/example.svg --verbose\n\n# Alternative methods\npython -m microweldr.cli.main examples/example.svg\n```\n\n**\ud83d\udcd6 For detailed development setup, see [DEVELOPMENT.md](DEVELOPMENT.md)**\n\n### Example Files Included\n- **`examples/example.svg`**: Basic demonstration with normal welds, light welds, and stop points\n- **`examples/comprehensive_sample.svg`**: Full-featured demo showing all capabilities\n- **`examples/pause_examples.svg`**: Examples of different pause message formats\n- **`examples/config.toml`**: Complete configuration file with all parameters\n\n### Expected Output\nEach run generates:\n- **G-code file**: `example.gcode` - Ready to load on Prusa Core One\n- **Animation file**: `example_animation.svg` - Visual preview of welding sequence\n- **Console output**: Processing details and validation results\n\n### Alternative Run Methods\n```bash\n# Using Python module (with virtual environment activated)\npython -m microweldr.cli.main examples/example.svg\n\n# With custom configuration\nmicroweldr examples/example.svg -c my_config.toml\n```\n\n## Materials Guide\n\n### Bubble Film Polypropylene Orientation\n\nWhen working with bubble film rolls for microfluidic device creation:\n\n**\ud83d\udd0d Identifying the Polypropylene Side:**\n- **Smooth side**: This is the **polypropylene layer** - use this side for welding\n- **Bubble side**: This is typically polyethylene - **do not weld this side**\n\n**\ud83d\udccf Proper Orientation:**\n- Place bubble film with **smooth side UP** on the printer bed\n- The welding nozzle should contact the **smooth polypropylene surface**\n- Bubbles should face **DOWN** toward the bed\n\n**\ud83c\udf21\ufe0f Temperature Guidelines:**\n- **Polypropylene welding**: 160-180\u00b0C (use light welds for thin films)\n- **Test first**: Always test weld parameters on scrap material\n- **Avoid overheating**: Polypropylene can degrade above 200\u00b0C\n\n**\u26a0\ufe0f Safety Notes:**\n- Ensure adequate ventilation when welding plastics\n- Test weld strength before using for critical applications\n- Different bubble film manufacturers may use different material combinations\n\n**\ud83d\udca1 Pro Tip:**\nUse the `data-temp` attribute in your SVG to fine-tune welding temperature for different areas:\n```xml\n<line stroke=\"black\" data-temp=\"165\" data-welding-time=\"0.2\" />\n```\n\n## License\n\nThis project is open source. Use at your own risk and ensure proper safety precautions when operating 3D printing equipment.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Convert SVG files to Prusa Core One G-code for plastic welding",
"version": "3.0.2",
"project_urls": {
"Repository": "https://github.com/retospect/microweldr"
},
"split_keywords": [
"svg",
" gcode",
" 3d-printing",
" welding",
" prusa"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "aee2bcd4bedc7da8b4043ed25e2123cd6336e739ca53ae6eadcec8e1de14a66c",
"md5": "58d7826da63acd9d48c312ae96743d02",
"sha256": "b42bd3317f8a64264cbe0d26afc8cf8b030080e5b24b304a596e4d57f46e05cf"
},
"downloads": -1,
"filename": "microweldr-3.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "58d7826da63acd9d48c312ae96743d02",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.8.1",
"size": 54753,
"upload_time": "2025-10-25T15:57:53",
"upload_time_iso_8601": "2025-10-25T15:57:53.826691Z",
"url": "https://files.pythonhosted.org/packages/ae/e2/bcd4bedc7da8b4043ed25e2123cd6336e739ca53ae6eadcec8e1de14a66c/microweldr-3.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8f365904807021d9f3afa743ba0790b3ee4b5d6d155a18c9a7fc583a22e933c7",
"md5": "42d6c77b820708a9aff52e6611cae362",
"sha256": "55918c9ebf2bf2b590dbc83cbf6f547ecf157ef2fe58b79226743fdea5d0fa05"
},
"downloads": -1,
"filename": "microweldr-3.0.2.tar.gz",
"has_sig": false,
"md5_digest": "42d6c77b820708a9aff52e6611cae362",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.8.1",
"size": 55096,
"upload_time": "2025-10-25T15:57:55",
"upload_time_iso_8601": "2025-10-25T15:57:55.255940Z",
"url": "https://files.pythonhosted.org/packages/8f/36/5904807021d9f3afa743ba0790b3ee4b5d6d155a18c9a7fc583a22e933c7/microweldr-3.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-25 15:57:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "retospect",
"github_project": "microweldr",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "toml",
"specs": [
[
">=",
"0.10.2"
]
]
},
{
"name": "requests",
"specs": [
[
">=",
"2.28.0"
]
]
},
{
"name": "lxml",
"specs": [
[
">=",
"5.0.0"
]
]
},
{
"name": "xmlschema",
"specs": [
[
">=",
"2.0.0"
]
]
},
{
"name": "gcodeparser",
"specs": [
[
">=",
"0.2.0"
]
]
},
{
"name": "pygcode",
"specs": [
[
">=",
"0.2.0"
]
]
}
],
"lcname": "microweldr"
}
JSON
