Skip to content

Commit

Permalink
chore: better print type descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
BigJk committed Sep 15, 2024
1 parent 7053981 commit c46d723
Show file tree
Hide file tree
Showing 7 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion printing/cups/cups.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ func (c *CUPS) Name() string {
}

func (c *CUPS) Description() string {
return "Print via CUPS attached printer. Use the Name of the printer (not the URI) as Endpoint."
return "Print via CUPS attached printer. Use the Name of the printer (not the URI) as endpoint. Check the S&D documentation for more information on how to set up CUPS."
}

var devicesRegex = regexp.MustCompile(`(?mU)device for (.+):`)
Expand Down
2 changes: 1 addition & 1 deletion printing/dump/dump.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ func (r *Dump) Name() string {
}

func (r *Dump) Description() string {
return "Dumps the raw commands content to file. Endpoint should be the path to the file that will be written."
return "Dumps the raw ESC/POS commands to file. Endpoint should be the path to the file that will be written. Can be used to debug the raw commands."
}

func (r *Dump) AvailableEndpoints() (map[string]string, error) {
Expand Down
2 changes: 1 addition & 1 deletion printing/preview/preview.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ func (r *Preview) Name() string {
}

func (r *Preview) Description() string {
return "Instead of printing show a window with the result."
return "Instead of printing show a window with the result. No endpoint needed."
}

func (r *Preview) AvailableEndpoints() (map[string]string, error) {
Expand Down
2 changes: 1 addition & 1 deletion printing/remote/remote.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ func (r *Remote) Name() string {
}

func (r *Remote) Description() string {
return "Print via a remote server."
return "Print via a remote server. The endpoint should be the URL of the server. The raw ESC/POS printer commands will be sent as http post request."
}

func (r *Remote) AvailableEndpoints() (map[string]string, error) {
Expand Down
2 changes: 1 addition & 1 deletion printing/serial/serial.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ func (s *Serial) Name() string {
}

func (s *Serial) Description() string {
return "Printing over Serial-Port (e.g. RS232). Endpoint is defined %PORT_NAME%:9600_N81_1. This specifies no parity, 8 data bits, 1 stop bit, a baudrate of 9600 and a 1 second delay between data chunks."
return "Printing over Serial-Port (e.g. RS232). Endpoint is defined %PORT_NAME%:9600_N81_1. This specifies a baudrate of 9600, no parity, 8 data bits, 1 stop bit, and a 1 second delay between data chunks. On Windows the port name is COM1, COM2, etc. On Linux/Unix it is most likely /dev/ttyUSB0, /dev/ttyUSB1, or similar."
}

func (s *Serial) AvailableEndpoints() (map[string]string, error) {
Expand Down
2 changes: 1 addition & 1 deletion printing/usb/usb.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ func (c *USB) Name() string {
}

func (c *USB) Description() string {
return "Print directly to a USB attached printer. Use {vendor_id}:{product_id}:{endpoint_address} like 0416:5011:03. To find out how to get these values please take a look at the S&D documentation."
return "Print directly to a USB attached printer. Use {vendor_id}:{product_id}:{endpoint_address} like 0416:5011:03 as endpoint. To find out how to get these values please take a look at the S&D documentation."
}

func (c *USB) AvailableEndpoints() (map[string]string, error) {
Expand Down
2 changes: 1 addition & 1 deletion printing/windows/direct.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ func (dp *Direct) Name() string {
}

func (dp *Direct) Description() string {
return "Directly print to a attached printer. Use the Name of the printer as Endpoint."
return "Directly print to a attached printer. Use the Name of the printer as endpoint."
}

func (dp *Direct) AvailableEndpoints() (map[string]string, error) {
Expand Down

0 comments on commit c46d723

Please sign in to comment.