Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feat: Implement Web Serial API for direct loading #70

Merged
merged 1 commit into from
Dec 17, 2023
Merged

Feat: Implement Web Serial API for direct loading #70

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions GameBoyPrinterDecoderJS/gameboy_printer_js_raw_decoder.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
.error {border: 2px solid red;}
#errormessage {display: none; background: #ffdddd;}
.error ~ #errormessage {display: block;}
#webserial {border: 1px solid #222; padding: 0 10px; background: #f7f7f7;}
</style>
</head>
<body>
Expand All @@ -31,8 +32,23 @@ <h1>Arduino Gameboy Printer Emulator Javascript Decoder</h1>
Below shows a sample data. Each line that is not a comment, but is encoded as 16 hex digits are a single gameboy tile. A stream of these 16 hex digits will build up a photo.
</p>

<div id="webserial">
<p>
<strong>Web Serial</strong>
</p>

<p>
As an alternative to copying the console data from the Arduino IDE, images can be created directly using the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Serial_API">Web Serial API</a>. Click "Request serial" to list available serial devices, select your GBP Printer Emulator and print direct to the browser.
</p>

<p>
<button id="selectSerial">Request serial</button>
</p>
</div>

<br>


<textarea id="data_text" name="data" cols="110" rows="20">
// GAMEBOY PRINTER EMULATION PROJECT (Packet Capture Mode)
// By Brian Khuu (2020)
Expand Down Expand Up @@ -160,5 +176,6 @@ <h1>Arduino Gameboy Printer Emulator Javascript Decoder</h1>

</div>
<a id="download"></a>
<script type="text/javascript" src="./webserial.js"></script>
</body>
</html>
224 changes: 224 additions & 0 deletions GameBoyPrinterDecoderJS/webserial.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,224 @@
/*
WebSerial wrapper
Simplifies WebSerial

created 15 May 2022
modified 16 May 2022
by Tom Igoe

https://github.com/tigoe/html-for-conndev/blob/ace1750022c08cc141a4f5bcd0396cb2a6531e9f/webSerial/webserial.js

Implemented for use with the GameBoyPrinterDecoderJS project:
created 16 December 2023
by Jim Valentine <github.com/f13dev>

MIT License

Copyright (c) 2020 tigoe

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.
*/

// need self = this for connect/disconnect functions
let self;

class WebSerialPort {
constructor() {
// if webserial doesn't exist, return false:
if (!navigator.serial) {
alert("WebSerial is not enabled in this browser");
return false;
}
// TODO: make this an option.
this.autoOpen = true;
// copy this to a global variable so that
// connect/disconnect can access it:
self = this;

// basic WebSerial properties:
this.port;
this.reader;
this.serialReadPromise;
// add an incoming data event:
// TODO: data should probably be an ArrayBuffer or Stream
this.incoming = {
data: null
}
// incoming serial data event:
this.dataEvent = new CustomEvent('data', {
detail: this.incoming,
bubbles: true
});

// TODO: bubble these up to calling script
// so that you can change button names on
// connect or disconnect:
navigator.serial.addEventListener("connect", this.serialConnect);
navigator.serial.addEventListener("disconnect", this.serialDisconnect);

// if the calling script passes in a message
// and handler, add them as event listeners:
this.on = (message, handler) => {
parent.addEventListener(message, handler);
};
}

async openPort(thisPort) {
try {
// if no port is passed to this function,
if (thisPort == null) {
// pop up window to select port:
this.port = await navigator.serial.requestPort();
} else {
// open the port that was passed:
this.port = thisPort;
}
// set port settings and open it:
// TODO: make port settings configurable
// from calling script:
await this.port.open({ baudRate: 115200 });
// start the listenForSerial function:
this.serialReadPromise = this.listenForSerial();

} catch (err) {
// if there's an error opening the port:
console.error("There was an error opening the serial port:", err);
}
}

async closePort() {
if (this.port) {
// stop the reader, so you can close the port:
this.reader.cancel();
// wait for the listenForSerial function to stop:
await this.serialReadPromise;
// close the serial port itself:
await this.port.close();
// clear the port variable:
this.port = null;
}
}

async sendSerial(data) {
// if there's no port open, skip this function:
if (!this.port) return;
// if the port's writable:
if (this.port.writable) {
// initialize the writer:
const writer = this.port.writable.getWriter();
// convert the data to be sent to an array:
// TODO: make it possible to send as binary:
var output = new TextEncoder().encode(data);
// send it, then release the writer:
writer.write(output).then(writer.releaseLock());
}
}

async listenForSerial() {
// if there's no serial port, return:
if (!this.port) return;
// while the port is open:
while (this.port.readable) {
// initialize the reader:
this.reader = this.port.readable.getReader();
try {
// read incoming serial buffer:
const { value, done } = await this.reader.read();
if (value) {
// convert the input to a text string:
// TODO: make it possible to receive as binary:
this.incoming.data = new TextDecoder().decode(value);

// fire the event:
parent.dispatchEvent(this.dataEvent);
}
if (done) {
break;
}
} catch (error) {
// if there's an error reading the port:
console.log(error);
} finally {
this.reader.releaseLock();
}
}
}

// this event occurs every time a new serial device
// connects via USB:
serialConnect(event) {
console.log(event.target);
// TODO: make autoOpen configurable
if (self.autoOpen) {
self.openPort(event.target);
}
}

// this event occurs every time a new serial device
// disconnects via USB:
serialDisconnect(event) {
console.log(event.target);
}
}

// GameBoyPrinterDecoderJS specific code:

let webserial;
let serialButton = document.getElementById("selectSerial");
let readContainer = document.getElementById('data_text');
let autoClear = true;

function setup() {
webserial = new WebSerialPort();
if (webserial) {
webserial.on('data', serialRead);
serialButton.addEventListener("click", openClosePort);
}
}

async function openClosePort() {
let buttonLabel = "Open port";
if (webserial.port) {
await webserial.closePort();
} else {
await webserial.openPort();
buttonLabel = "Close port";
}
serialButton.innerHTML = buttonLabel;
}

function serialRead(event) {
let new_data = event.detail.data;

if ((autoClear && !new_data.includes('650B')) || new_data.includes('GAMEBOY PRINTER')) {
readContainer.value = '';
autoClear = false;
}

readContainer.value += new_data;

readContainer.scrollTop = readContainer.scrollHeight;

if (new_data.includes('Completed')) {
document.getElementById('submit_button').click();
autoClear = true;
}
}

document.addEventListener('DOMContentLoaded', setup);
Loading