Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/debuss/common-printserver

Common-PrintServer is a mini server allowing you to print your documents directly on the printer via your internet browser.
https://github.com/debuss/common-printserver

Last synced: about 1 month ago
JSON representation

Common-PrintServer is a mini server allowing you to print your documents directly on the printer via your internet browser.

Host: GitHub
URL: https://github.com/debuss/common-printserver
Owner: debuss
License: mit
Created: 2019-08-23T09:34:21.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-06-12T17:46:34.000Z (over 1 year ago)
Last Synced: 2023-06-12T18:44:29.398Z (over 1 year ago)
Language: Java
Size: 2.45 MB
Stars: 1
Watchers: 2
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

# Common-PrintServer

Common-PrintServer is a mini server allowing you to print your documents directly on the printer via your internet browser.

## Usage

From the command-line :
```
cd out/artifacts/Common-PrintServer
java -jar Common-PrinterServer.jar
```

Else, you can just double-click on the Common-PrinterServer.jar file, most of operating system should be able to open it.

If your operating system supports Java SystemTray then you should see the icon on your task bar.

You can now go to : [http://localhost:4567/getPrinters](http://localhost:4567/getPrinters).
A list of your installed printers should be listed, example :
`{"response":"Canon MX340 series Printer|Canon MX340 series FAX|Datamax-O\u0027Neil E4204B-Mark-III","error":""}`

_Please not that the printer driver needs to be installed for the printer to be listed._

You can check logs and errors in the Log menu from the TrayIcon.

## Port

Common-PrintServer uses port **4567** for HTTP requests, make sure it is available.

## API

A simple REST API allows developers to interact with printers.
All response from the API are in JSON format, and contains 2 indexes :
* response
* error

_(See example in **Usage**)_

The **response** index contains the expected response from the API.
In case of an error, the **error** index is filled with the error message and **response** is empty.

### Base URL

All requests must be done on : `http::locahost:4567/`.
Therefore, to fetch a list of available printers you can call [http://localhost:4567/getPrinters](http://localhost:4567/getPrinters).

### `GET /getPrinters`

Returns a list of available printers, separated by a vertical bar | :
`{"response":"Canon MX340 series Printer|Canon MX340 series FAX|Datamax-O\u0027Neil E4204B-Mark-III","error":""}`

If no printers are found, returns :
`{"response":"","error":"No printer found..."}`

### `GET /getPrinter`

Returns the currently selected printer, or "N/A" if none selected yet.

### `GET /setPrinter/:name`

Set the selected printer to :name variable.

### `POST /printRaw`

Send the raw code to the printer to print. Simply send the raw code to print in the request body (`Content-Type: text/plain`).
Returns `{"response":"OK","error":""}` on success.

### `POST /printFileByURL`

Send the document to print from URL to the printer to print. Simply send the URL of document to print in the request body (`Content-Type: text/plain`).
Returns `{"response":"OK","error":""}` on success.

## HTTPS

If you need HTTPS, please check the [Spark Java documentation](https://sparkjava.com/documentation#how-do-i-enable-sslhttps).
You can modify the file `src/main/java/commonprintserver/CommonPrintServerServer.java`, in the `start` method you'll find
a commented section where you can implement SSL/HTTPS.

## Contributing

I do not have much time to focus on this anymore, it might not be that necessary anymore with Google Cloud Printer and stuff but who knows,
maybe it can help someone out there.

If you are interested in contributing to Common-PrintServer please fork the project and create a pull request.

Thank you :) !

## License

```
The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```