Documentation.

This commit is contained in:
Solomon Peachy 2016-01-31 09:27:21 -05:00
parent 15cfc5b2a9
commit 0ae2f9578a
2 changed files with 47 additions and 36 deletions

43
README
View file

@ -1,40 +1,11 @@
ABOUT
=====
This is a forked version of Wilmer van der Gaast's selphy_go.
This is a simple client implementation of the CPNP protocol used by the
Canon Selphy CP-900 printer, and possibly others. I'm not aware of any
protocol spec being available, but it was pretty simple to reverse-
engineer.
See the original README (README.ORIG) and this blog post for more details:
The protocol is fairly similar to the BJNP protocol used by normal Canon
printers. I've peeked at http://sourceforge.net/projects/cups-bjnp/ here
and there for hints and ideas.
https://wilmer.gaa.st/blog/archives/76-selphy.go-Linux-client-for-Canon-Selphy-CP-900-photo-printer.html
I hope this repo is short-lived, I intend push all changes to Wilmer,
and possibly rewrite it in pure C and merge that into my selphy_print
backend suite.
INSTALL & USAGE
===============
This should be pretty simple. Just build it, there are no special
dependencies other than a Go compiler, obviously.
See --help for available flags. You can use --printer_ip/_mac to specify the
printer to send your job to. By default, the tool will send a discovery
packet to 255.255.255.255 and send the job to whichever printer responds
first (and since regular non-photo printers speak a slightly different
protocol, that's often going to be just fine). If you're trying to send a
job to a printer not on your local network/broadcast domain, you can use
--printer_ip.
The program is pretty spammy at runtime, I haven't really tried cleaning
it up yet. Also, I haven't been able to use it much yet, so maybe it won't
work for you at all.
AUTHOR
======
Questions, complaints, suggestions and misc. fan-mail are welcome by
e-mail: wilmer@gaast.net .
I hope I'll manage to respond, but I'm not very good at e-mail these
days. :-(
- Solomon Peachy

40
README.ORIG Normal file
View file

@ -0,0 +1,40 @@
ABOUT
=====
This is a simple client implementation of the CPNP protocol used by the
Canon Selphy CP-900 printer, and possibly others. I'm not aware of any
protocol spec being available, but it was pretty simple to reverse-
engineer.
The protocol is fairly similar to the BJNP protocol used by normal Canon
printers. I've peeked at http://sourceforge.net/projects/cups-bjnp/ here
and there for hints and ideas.
INSTALL & USAGE
===============
This should be pretty simple. Just build it, there are no special
dependencies other than a Go compiler, obviously.
See --help for available flags. You can use --printer_ip/_mac to specify the
printer to send your job to. By default, the tool will send a discovery
packet to 255.255.255.255 and send the job to whichever printer responds
first (and since regular non-photo printers speak a slightly different
protocol, that's often going to be just fine). If you're trying to send a
job to a printer not on your local network/broadcast domain, you can use
--printer_ip.
The program is pretty spammy at runtime, I haven't really tried cleaning
it up yet. Also, I haven't been able to use it much yet, so maybe it won't
work for you at all.
AUTHOR
======
Questions, complaints, suggestions and misc. fan-mail are welcome by
e-mail: wilmer@gaast.net .
I hope I'll manage to respond, but I'm not very good at e-mail these
days. :-(