uv3dp

package module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 7, 2020 License: MIT Imports: 10 Imported by: 12

README

uv3dp

Tools for UV Resin based 3D Printers (in Go)

Supported File Formats

This tool is for devices that use sliced image files for UV resin 3D printers.

Printers known to work with this tool:

Printer File Formats Issues
- uvj Zip file with JSON and image slices
EPAX X1/X10 cbddlp None
EPAX X1-N ctb None
Anycubic Photon photon None
Anycubic Zero pw0 None
Anycubic Photons pws None
Prusa SL1 sl1 None
NOVA3D Elfin cws None
Phrozen Sonic phz None
Zortrax Inkspire zcodex Read-only (for format conversion)

Installation

Command Line Tool (uv3dp)

The command line tool is designed to be used in a 'pipeline' style, for example:

uv3dp foo.sl1 info                    # Shows information about the SL1 file
uv3dp foo.sl1 decimate bar.cbddlp     # Convert and decimates a SL1 file to a CBDDLP file
uv3dp foo.sl1 qux.cbddlp --version 1  # Convert a SL1 file to a Version 1CBDDLP file
Command summary:
Usage:

  uv3dp [options] INFILE [command [options] | OUTFILE]...
  uv3dp [options] @cmdfile.cmd

Options:

  -p, --progress        Show progress during operations
  -v, --verbose count   Verbosity
  -V, --version         Show version

Commands:

  (none)               Translates input file to output file
  bed                  Adjust image for a different bed size/resolution
  bottom               Alters bottom layer exposure
  decimate             Remove outmost pixels of all islands in each layer (reduces over-curing on edges)
  exposure             Alters exposure times
  info                 Dumps information about the printable
  lift                 Alters layer lift properties
  resin                Changes all properties to match a selected resin
  retract              Alters layer retract properties
  select               Select to print only a range of layers

Options for 'bed':

  -M, --machine string             Size preset by machine type (default "EPAX-X1")
  -m, --millimeters float32Slice   Bed size, in millimeters (default [68.040001,120.959999])
  -p, --pixels ints                Bed size, in pixels (default [1440,2560])
  -r, --reflect                    Mirror image along the X axis

Options for 'bottom':

  -c, --count int             Bottom layer count
  -h, --lift-height float32   Bottom layer lift height in mm
  -s, --lift-speed float32    Bottom layer lift speed in mm/min
  -f, --light-off float32     Bottom layer light-off time in seconds
  -o, --light-on float32      Bottom layer light-on time in seconds
  -p, --pwm uint8             Light PWM rate (0..255) (default 255)
  -y, --style string          Bottom layer style - 'fade' or 'slow' (default "slow")

Options for 'decimate':

  -b, --bottom int   Number of bottom layer passes
  -n, --normal int   Number of normal layer passes (default 1)

Options for 'exposure':

  -f, --light-off float32   Normal layer light-off time in seconds
  -o, --light-on float32    Normal layer light-on time in seconds
  -p, --pwm uint8           Light PWM rate (0..255) (default 255)

Options for 'info':

  -e, --exposure   Show summary of the exposure settings (default true)
  -l, --layer      Show layer detail
  -s, --size       Show size summary (default true)

Options for 'lift':

  -h, --height float32   Lift height in mm
  -s, --speed float32    Lift speed in mm/min

Options for 'resin':

  -t, --type string   Resin type [see 'Known resins' in help]

Options for 'retract':

  -h, --height float32   Retract height in mm
  -s, --speed float32    Retract speed in mm/min

Options for 'select':

  -c, --count int   Count of layers to select (-1 for all layers after first) (default -1)
  -f, --first int   First layer to select

Options for '.cbddlp':

  -a, --anti-alias int   Override antialias level (1..16) (default 1)
  -v, --version int      Override header Version (default 2)

Options for '.ctb':

  -e, --encryption-seed uint32   Specify a specific encryption seed
  -v, --version int              Specify the CTB version (2 or 3) (default 2)

Options for '.cws':


Options for '.photon':

  -a, --anti-alias int   Override antialias level (1..16) (default 1)
  -v, --version int      Override header Version (default 1)

Options for '.phz':

  -e, --encryption-seed uint32   Specify a specific encryption seed

Options for '.pw0':

  -a, --anti-alias int   Override antialias level (1,2,4,8) (default 1)

Options for '.pws':

  -a, --anti-alias int   Override antialias level (1,2,4,8) (default 1)

Options for '.sl1':

  -f, --bottom-fade            Fade bottom layers exposure time
  -m, --material-name string   config.init entry 'materialName' (default "3DM-ABS @")

Options for '.uvj':


Options for '.zcodex':


Options for 'empty':

  -M, --machine string             Size preset by machine type (default "photon")
  -m, --millimeters float32Slice   Empty size, in millimeters (default [68.040001,120.959999])
  -p, --pixels ints                Empty size, in pixels (default [1440,2560])

Known machines:

    elfin                Nova3D Elfin            Size: 1410x2550, 73x132 mm,	Format: .cws 
    inkspire            Zortrax Inkspire         Size: 1440x2560, 72x128 mm,	Format: .zcodex 
    ld-002r            Creality LD-002R          Size: 1440x2560, 68x121 mm,	Format: .ctb --version=2
    mars                 Elegoo Mars             Size: 1440x2560, 68x121 mm,	Format: .cbddlp 
    mars2-pro            Elegoo Mars 2 Pro       Size: 1620x2560, 82.6x131 mm,	Format: .ctb --version=3
    photon             Anycubic Photon           Size: 1440x2560, 68x121 mm,	Format: .photon 
    photon0            Anycubic Photon Zero      Size: 480x854, 55.4x98.6 mm,	Format: .pw0 
    photons            Anycubic Photon S         Size: 1440x2560, 68x121 mm,	Format: .pws 
    sl1                   Prusa SL1              Size: 1440x2560, 68x121 mm,	Format: .sl1 
    sonic-mini          Phrozen Sonic Mini       Size: 1080x1920, 68x121 mm,	Format: .phz 
    x1                     EPAX X1               Size: 1440x2560, 68x121 mm,	Format: .cbddlp 
    x10                    EPAX X10              Size: 1600x2560, 135x216 mm,	Format: .cbddlp 
    x10n                   EPAX X10              Size: 1600x2560, 135x216 mm,	Format: .ctb --version=2
    x133                   EPAX X133             Size: 2160x3840, 165x293 mm,	Format: .cbddlp 
    x156                   EPAX X156             Size: 2160x3840, 194x345 mm,	Format: .cbddlp 
    x1k                    EPAX X1K              Size: 1440x2560, 68x121 mm,	Format: .ctb --version=2
    x1n                    EPAX X1N              Size: 1440x2560, 68x121 mm,	Format: .ctb --version=2
    x9                     EPAX X9               Size: 1600x2560, 120x192 mm,	Format: .cbddlp 

Known resins: (from local user ChiTuBox config)

Documentation

Overview

Package uv3dp is a set of tools for data exchange between UV Resin based 3D printers

Index

Constants

View Source 
const (
	PreviewTypeTiny = PreviewType(iota)
	PreviewTypeHuge
)

Variables

View Source 
var (
	MachineFormats = map[string](*MachineFormat){}
)

Functions

func FormatterUsage added in v0.2.0 

func FormatterUsage()

func PrintDuration added in v1.0.0 

func PrintDuration(p Printable) (duration time.Duration)

Get the total print time for a printable

func RegisterFormatter added in v0.2.0 

func RegisterFormatter(suffix string, newFormatter NewFormatter)

func RegisterMachine added in v0.10.0 

func RegisterMachine(name string, machine Machine, extension string, args ...string) (err error)

func RegisterMachines added in v0.10.0 

func RegisterMachines(machineMap map[string]Machine, extension string, args ...string) (err error)

func SetProgress added in v0.7.3 

func SetProgress(prog Progressor)

func WithAllLayers added in v0.6.1 

func WithAllLayers(p Printable, do func(p Printable, n int))

WithAllLayers executes a function in parallel over all of the layers

func WithEachLayer added in v0.7.5 

func WithEachLayer(p Printable, do func(p Printable, n int))

WithEachLayer executes a function in over all of the layers, serially (but possibly out of order)

Types

type Bottom 

type Bottom struct {
	Exposure     // Exposure
	Count    int // Number of bottom layers
}

Bottom layer exposure

type DecimatedPrintable 

type DecimatedPrintable struct {
	Printable
	Passes     int // Number of passes of decimation
	FirstLayer int // First layer to start decimating
	Layers     int // Count of layers to decimate
}

func NewDecimatedPrintable 

func NewDecimatedPrintable(printable Printable) (dp *DecimatedPrintable)

func (*DecimatedPrintable) LayerImage added in v1.0.0 

func (dec *DecimatedPrintable) LayerImage(index int) (ig *image.Gray)

type Exposure 

type Exposure struct {
	LightOnTime   float32 // Exposure time
	LightOffTime  float32 // Cool down time
	LightPWM      uint8   `json:",omitempty"` // PWM from 1..255
	LiftHeight    float32 // mm
	LiftSpeed     float32 // mm/min
	RetractHeight float32 `json:",omitempty"` // mm
	RetractSpeed  float32 `json:",omitempty"` // mm/min
}

Per-layer exposure

func (*Exposure) Duration 

func (exp *Exposure) Duration() (total time.Duration)

Total duration of an exposure

func (*Exposure) Interpolate added in v0.2.3 

func (exp *Exposure) Interpolate(target Exposure, scale float32) (result Exposure)

Interpolate scales settings between this and another Exposure

type Format added in v0.2.0 

type Format struct {
	Formatter
	Suffix   string
	Filename string
}

func NewFormat added in v0.2.0 

func NewFormat(filename string, args []string) (format *Format, err error)

func (*Format) Printable added in v0.2.0 

func (format *Format) Printable() (printable Printable, err error)

func (*Format) SetPrintable added in v0.2.0 

func (format *Format) SetPrintable(printable Printable) (err error)

Write writes a printable to the file format

type Formatter added in v0.2.0 

type Formatter interface {
	Parse(args []string) (err error)
	Parsed() bool
	Args() (args []string)
	NArg() int
	PrintDefaults()

	Decode(reader Reader, size int64) (printable Printable, err error)
	Encode(writer Writer, printable Printable) (err error)
}

Printable file format

type Machine added in v0.10.0 

type Machine struct {
	Vendor string
	Model  string
	Size   MachineSize
}

type MachineFormat added in v0.10.0 

type MachineFormat struct {
	Machine
	Extension string
	Args      []string
}

type MachineSize added in v0.10.0 

type MachineSize struct {
	X, Y     int
	Xmm, Ymm float32
}

type NewFormatter added in v0.2.0 

type NewFormatter func(suffix string) (formatter Formatter)

Printable to file format

type PreviewType 

type PreviewType uint

type Print added in v1.0.0 

type Print struct {
	Properties
}

func NewEmptyPrintable added in v0.2.2 

func NewEmptyPrintable(prop Properties) (p *Print)

func (*Print) Bottom added in v1.0.0 

func (p *Print) Bottom() Bottom

func (*Print) Exposure added in v1.0.0 

func (p *Print) Exposure() Exposure

func (*Print) LayerImage added in v1.0.0 

func (p *Print) LayerImage(index int) (ig *image.Gray)

func (*Print) Metadata added in v1.0.0 

func (p *Print) Metadata(index string) (data interface{}, ok bool)

func (*Print) Preview added in v1.0.0 

func (p *Print) Preview(index PreviewType) (ig image.Image, ok bool)

func (*Print) Size added in v1.0.0 

func (p *Print) Size() Size

type Printable 

type Printable interface {
	Size() Size
	Exposure() Exposure
	Bottom() Bottom
	Preview(index PreviewType) (image.Image, bool)
	MetadataKeys() []string
	Metadata(key string) (data interface{}, ok bool)
	LayerZ(index int) float32
	LayerExposure(index int) Exposure
	LayerImage(index int) *image.Gray
}

type Progress added in v0.7.3 

type Progress struct {
	Progressor
	Completed chan struct{}
	Done      chan struct{}
}

func NewProgress added in v0.7.3 

func NewProgress(total int) (prog *Progress)

func (*Progress) Close added in v0.7.3 

func (prog *Progress) Close()

func (*Progress) Indicate added in v0.7.3 

func (prog *Progress) Indicate()

type Progressor added in v0.7.3 

type Progressor interface {
	Show(percent float32)
	Stop()
}

type Properties 

type Properties struct {
	Size     Size
	Exposure Exposure
	Bottom   Bottom
	Preview  map[PreviewType]image.Image `json:",omitempty"`
	Metadata map[string](interface{})    `json:",omitempty"`
}

func (*Properties) Bounds 

func (prop *Properties) Bounds() image.Rectangle

Get image bounds

func (*Properties) GetMetadataUint8 added in v0.8.4 

func (prop *Properties) GetMetadataUint8(attr string, defValue uint8) (value uint8)

Get metadata

func (*Properties) LayerExposure added in v0.2.3 

func (prop *Properties) LayerExposure(index int) (exposure Exposure)

Exposure gets the default exposure by layer index

func (*Properties) LayerZ added in v0.8.8 

func (prop *Properties) LayerZ(index int) (z float32)

Z get the default Z height at a layer index

func (*Properties) MetadataKeys added in v1.0.0 

func (prop *Properties) MetadataKeys() (keys []string)

type Reader added in v0.2.2 

type Reader interface {
	io.Reader
	io.ReaderAt
}

Reader needs io.ReaderAt for archive/zip

type Size 

type Size struct {
	X, Y        int            // Printable size in pixels (x,y)
	Millimeter  SizeMillimeter // Printable size in mm
	Layers      int
	LayerHeight float32 // Height of an individual layer
}

type SizeMillimeter 

type SizeMillimeter struct {
	X, Y float32
}

type Writer added in v0.2.2 

type Writer interface {
	io.Writer
}

Writer

Source Files

View all Source files

Directories

Path Synopsis
Package cbddlp handle input and output of Chitubox DLP/LCD printables
 Package cbddlp handle input and output of Chitubox DLP/LCD printables
cmd
uv3dp
Package ctb handle input and output of Chitubox DLP/LCD printables
 Package ctb handle input and output of Chitubox DLP/LCD printables
Package cws handles input and output of NOVA32 CWS printables
 Package cws handles input and output of NOVA32 CWS printables
Package ctb handle input and output of Chitubox DLP/LCD printables
 Package ctb handle input and output of Chitubox DLP/LCD printables
Package pws handles input and output of Anycubic Photons 2.0 (.pws) printables
 Package pws handles input and output of Anycubic Photons 2.0 (.pws) printables
Package sl1 handles input and output of Prusa SL1 DLP/LCD printables
 Package sl1 handles input and output of Prusa SL1 DLP/LCD printables
Package uvj handles input and output of UV3DP 'generic' zip files (JSON slice description and images)
 Package uvj handles input and output of UV3DP 'generic' zip files (JSON slice description and images)
Package zcodex handles input and output of Prusa SL1 DLP/LCD printables
 Package zcodex handles input and output of Prusa SL1 DLP/LCD printables
Package 'kelant' handles Kelant S400 style .zip files
 Package 'kelant' handles Kelant S400 style .zip files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.