@alexgyver/serial 1.0.2 → 1.0.4

package/README.md

@@ -13,6 +13,7 @@ constructor(params = {});
 config(params = {});
 // eol: /\r?\n/
 // baud: 115200
+// auto_open: false
 // reconnect: 1000
 
 onbin(b);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alexgyver/serial",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Web Serial API wrapper",
   "main": "./serial.js",
   "module": "./serial.js",
@@ -20,7 +20,7 @@
     "html-webpack-plugin": "^5.6.5"
   },
   "dependencies": {
-    "@alexgyver/utils": "^1.2.3"
+    "@alexgyver/utils": "^1.2.4"
   },
   "author": "AlexGyver <alex@alexgyver.ru>",
   "license": "MIT"

package/serial.js

@@ -1,12 +1,13 @@
 import { sleep, ShiftBuffer, StreamSplitter } from "@alexgyver/utils";
 
-const States = {
-    Open: 1,
-    Closing: 2,
-    Closed: 3,
-};
-
 export default class SerialJS {
+    static State = {
+        Closed: 'closed',
+        Opening: 'opening',
+        Open: 'open',
+        Closing: 'closing',
+    };
+
     //#region handlers
     onbin = null;
     ontext = null;
@@ -22,6 +23,7 @@ export default class SerialJS {
         const def = {
             eol: /\r?\n/,
             baud: 115200,
+            auto_open: false,
             reconnect: 1000,
         };
         this.cfg = { ...def, ...params };
@@ -31,18 +33,18 @@ export default class SerialJS {
         this.splitter.ontext = (t) => this.ontext(t);
     }
 
+    //#region methods
     config(params = {}) {
         this.cfg = { ...this.cfg, ...params };
         this.splitter.eol = this.cfg.eol;
     }
 
-    //#region methods
     static supported() {
         return 'serial' in navigator;
     }
 
     opened() {
-        return this._state == States.Open;
+        return this._state == SerialJS.State.Open;
     }
 
     selected() {
@@ -76,6 +78,7 @@ export default class SerialJS {
             this._error(e);
         }
         this.onselect(this.getName());
+        if (this.cfg.auto_open) this.open();
         return this.selected();
     }
 
@@ -85,6 +88,7 @@ export default class SerialJS {
     }
     async _open() {
         if (this.opened()) return;
+        this._change(SerialJS.State.Opening);
 
         try {
             await this._close();
@@ -93,10 +97,9 @@ export default class SerialJS {
             this.writer = this._port.writable.getWriter();
             this.reader = this._port.readable.getReader();
             this._buffer.clear();
-            this._state = States.Open;
-            this._change(true);
+            this._change(SerialJS.State.Open);
 
-            while (this._state == States.Open) {
+            while (this._state == SerialJS.State.Open) {
                 const { value, done } = await this.reader.read();
                 if (done) break;
                 if (value) {
@@ -106,6 +109,7 @@ export default class SerialJS {
             }
         } catch (e) {
             this._error(e);
+            this._change(SerialJS.State.Closed);
             if (this.retry) setTimeout(() => this._open(), this.cfg.reconnect);
         }
 
@@ -113,11 +117,10 @@ export default class SerialJS {
         if (this.writer) this.writer.releaseLock();
         this.reader = null;
         this.writer = null;
-        this._state = States.Closed;
 
         try {
             await this._port.close();
-            this._change(false);
+            this._change(SerialJS.State.Closed);
         } catch (e) { }
     }
 
@@ -127,19 +130,19 @@ export default class SerialJS {
     }
     async _close() {
         switch (this._state) {
-            case States.Closed: return;
-            case States.Open:
+            case SerialJS.State.Closed: return;
+            case SerialJS.State.Open:
                 if (this.reader) await this.reader.cancel();
-                this._state = States.Closing;
+                this._change(SerialJS.State.Closing);
                 break;
         }
 
         let i = 0;
-        while (this._state == States.Closing) {
+        while (this._state == SerialJS.State.Closing) {
             await sleep(10);
             if (++i > 200) {
                 this._error('Close timeout');
-                this._state = States.Closed;
+                this._change(SerialJS.State.Closed);
                 break;
             }
         }
@@ -157,17 +160,17 @@ export default class SerialJS {
 
     //#region private
     _port = null;
-    _state = States.Closed;
+    _state = SerialJS.State.Closed;
     _buffer = new ShiftBuffer();
     _decoder = new TextDecoder();
 
     async _send() {
         if (this._busy) return;
         this._busy = true;
-        while (this._buffer.length) {
+        while (this._buffer.length && this.writer) {
             let d = this._buffer.shiftAll();
             try {
-                if (this.writer) await this.writer.write(d);
+                await this.writer.write(d);
             } catch (e) { }
         }
         this._busy = false;
@@ -181,7 +184,11 @@ export default class SerialJS {
         this.onerror('[SerialJS] ' + e);
     }
     _change(s) {
+        this._state = s;
         this.onchange(s);
-        s ? this.onopen() : this.onclose();
+        switch (s) {
+            case SerialJS.State.Open: this.onopen(); break;
+            case SerialJS.State.Closed: this.onclose(); break;
+        }
     }
 }

package/serial.min.js

@@ -1 +1 @@
-const t=t=>new Promise(e=>setTimeout(e,t));class e{ontext=null;constructor(t=/\r?\n/,e=!1){this.eol=t,this.skip=e}reset(){this._buf=""}write(t){if(!this.ontext)return;if(!this.eol)return void this.ontext(t);this._buf+=t;let e=this._buf.split(this.eol);1!=e.length&&(e[e.length-1].length?this._buf=e.pop():(this._buf="",e.pop()),this.skip&&(e.shift(),this.skip=!1),e.forEach(t=>this.ontext(t)))}_buf=""}class s{constructor(){this.chunks=[],this.length=0}clear(){this.chunks=[]}push(t){return this.chunks.push(t),this.length+=t.length,!0}shift(t){t>this.length&&(t=this.length);const e=new Uint8Array(t);let s=0;for(;t>0;){const i=this.chunks[0];t>=i.length?(e.set(i,s),s+=i.length,t-=i.length,this.chunks.shift(),this.length-=i.length):(e.set(i.subarray(0,t),s),this.chunks[0]=i.subarray(t),this.length-=t,t=0)}return e}shiftAll(){return this.shift(this.length)}}class i{onbin=null;ontext=null;onopen(){}onclose(){}onchange(t){}onselect(t){}onerror(t){}constructor(t={}){this.cfg={eol:/\r?\n/,baud:115200,reconnect:1e3,...t},this._setLastPort().then(()=>this.onselect(this.getName())),this.splitter=new e(this.cfg.eol),this.splitter.ontext=t=>this.ontext(t)}config(t={}){this.cfg={...this.cfg,...t},this.splitter.eol=this.cfg.eol}static supported(){return"serial"in navigator}opened(){return 1==this._state}selected(){return!!this._port}getName(){if(!this._port)return null;switch(this._port.getInfo().usbProductId){case 21971:return"CH343";case 30084:return"CH340S";case 29986:case 29987:return"CH340";case 21778:case 21795:case 21892:return"CH341";case 1026:case 1027:case 1028:case 1029:case 24577:case 1538:case 24592:return"FT232";case 38144:case 258:case 1281:case 32937:case 6e4:case 60001:case 60003:return"CP210x"}return"Unknown"}async select(){try{await this.close(),this._port=null;let e=await navigator.serial.getPorts();for(let t of e)await t.forget();await t(50),await navigator.serial.requestPort(),await this._setLastPort()}catch(t){this._error(t)}return this.onselect(this.getName()),this.selected()}async open(){this.cfg.reconnect&&(this.retry=!0),await this._open()}async _open(){if(!this.opened()){try{for(await this._close(),await this._setLastPort(),await this._port.open({baudRate:this.cfg.baud}),this.writer=this._port.writable.getWriter(),this.reader=this._port.readable.getReader(),this._buffer.clear(),this._state=1,this._change(!0);1==this._state;){const{value:t,done:e}=await this.reader.read();if(e)break;t&&(this.onbin&&this.onbin(t),this.ontext&&this.splitter.write(this._decoder.decode(t,{stream:!0})))}}catch(t){this._error(t),this.retry&&setTimeout(()=>this._open(),this.cfg.reconnect)}this.reader&&this.reader.releaseLock(),this.writer&&this.writer.releaseLock(),this.reader=null,this.writer=null,this._state=3;try{await this._port.close(),this._change(!1)}catch(t){}}}async close(){this.retry=!1,await this._close()}async _close(){switch(this._state){case 3:return;case 1:this.reader&&await this.reader.cancel(),this._state=2}let e=0;for(;2==this._state;)if(await t(10),++e>200){this._error("Close timeout"),this._state=3;break}}async sendText(t){await this.sendBin((new TextEncoder).encode(t))}async sendBin(t){this._buffer.push(t),this._send()}_port=null;_state=3;_buffer=new s;_decoder=new TextDecoder;async _send(){if(!this._busy){for(this._busy=!0;this._buffer.length;){let t=this._buffer.shiftAll();try{this.writer&&await this.writer.write(t)}catch(t){}}this._busy=!1}}async _setLastPort(){let t=await navigator.serial.getPorts();this._port=t.length?t[0]:null}_error(t){this.onerror("[SerialJS] "+t)}_change(t){this.onchange(t),t?this.onopen():this.onclose()}}export{i as default};
+const t=t=>new Promise(e=>setTimeout(e,t));class e{ontext=null;constructor(t=/\r?\n/,e=!1){this.eol=t,this.skip=e}reset(){this._buf=""}write(t){if(!this.ontext)return;if(!this.eol)return void this.ontext(t);this._buf+=t;let e=this._buf.split(this.eol);1!=e.length&&(e[e.length-1].length?this._buf=e.pop():(this._buf="",e.pop()),this.skip&&(e.shift(),this.skip=!1),e.forEach(t=>this.ontext(t)))}_buf=""}class s{constructor(){this.chunks=[],this.length=0}clear(){this.chunks=[],this.length=0}push(t){return!(!t||0===t.length||(this.chunks.push(t),this.length+=t.length,0))}shift(t){if(!this.length||!t)return new Uint8Array(0);t>this.length&&(t=this.length);const e=new Uint8Array(t);let s=0;for(;s<t&&this.chunks.length>0;){const i=this.chunks[0];if(!i||0===i.length){this.chunks.shift();continue}const r=Math.min(i.length,t-s);e.set(i.subarray(0,r),s),s+=r,r===i.length?this.chunks.shift():this.chunks[0]=i.subarray(r),this.length-=r}return e}shiftAll(){return this.shift(this.length)}}class i{static State={Closed:"closed",Opening:"opening",Open:"open",Closing:"closing"};onbin=null;ontext=null;onopen(){}onclose(){}onchange(t){}onselect(t){}onerror(t){}constructor(t={}){this.cfg={eol:/\r?\n/,baud:115200,auto_open:!1,reconnect:1e3,...t},this._setLastPort().then(()=>this.onselect(this.getName())),this.splitter=new e(this.cfg.eol),this.splitter.ontext=t=>this.ontext(t)}config(t={}){this.cfg={...this.cfg,...t},this.splitter.eol=this.cfg.eol}static supported(){return"serial"in navigator}opened(){return this._state==i.State.Open}selected(){return!!this._port}getName(){if(!this._port)return null;switch(this._port.getInfo().usbProductId){case 21971:return"CH343";case 30084:return"CH340S";case 29986:case 29987:return"CH340";case 21778:case 21795:case 21892:return"CH341";case 1026:case 1027:case 1028:case 1029:case 24577:case 1538:case 24592:return"FT232";case 38144:case 258:case 1281:case 32937:case 6e4:case 60001:case 60003:return"CP210x"}return"Unknown"}async select(){try{await this.close(),this._port=null;let e=await navigator.serial.getPorts();for(let t of e)await t.forget();await t(50),await navigator.serial.requestPort(),await this._setLastPort()}catch(t){this._error(t)}return this.onselect(this.getName()),this.cfg.auto_open&&this.open(),this.selected()}async open(){this.cfg.reconnect&&(this.retry=!0),await this._open()}async _open(){if(!this.opened()){this._change(i.State.Opening);try{for(await this._close(),await this._setLastPort(),await this._port.open({baudRate:this.cfg.baud}),this.writer=this._port.writable.getWriter(),this.reader=this._port.readable.getReader(),this._buffer.clear(),this._change(i.State.Open);this._state==i.State.Open;){const{value:t,done:e}=await this.reader.read();if(e)break;t&&(this.onbin&&this.onbin(t),this.ontext&&this.splitter.write(this._decoder.decode(t,{stream:!0})))}}catch(t){this._error(t),this._change(i.State.Closed),this.retry&&setTimeout(()=>this._open(),this.cfg.reconnect)}this.reader&&this.reader.releaseLock(),this.writer&&this.writer.releaseLock(),this.reader=null,this.writer=null;try{await this._port.close(),this._change(i.State.Closed)}catch(t){}}}async close(){this.retry=!1,await this._close()}async _close(){switch(this._state){case i.State.Closed:return;case i.State.Open:this.reader&&await this.reader.cancel(),this._change(i.State.Closing)}let e=0;for(;this._state==i.State.Closing;)if(await t(10),++e>200){this._error("Close timeout"),this._change(i.State.Closed);break}}async sendText(t){await this.sendBin((new TextEncoder).encode(t))}async sendBin(t){this._buffer.push(t),this._send()}_port=null;_state=i.State.Closed;_buffer=new s;_decoder=new TextDecoder;async _send(){if(!this._busy){for(this._busy=!0;this._buffer.length&&this.writer;){let t=this._buffer.shiftAll();try{await this.writer.write(t)}catch(t){}}this._busy=!1}}async _setLastPort(){let t=await navigator.serial.getPorts();this._port=t.length?t[0]:null}_error(t){this.onerror("[SerialJS] "+t)}_change(t){switch(this._state=t,this.onchange(t),t){case i.State.Open:this.onopen();break;case i.State.Closed:this.onclose()}}}export{i as default};

package/test/script.js

@@ -12,18 +12,20 @@ send_b.onclick = () => ser.sendText('Hello ' + i++);
 // read
 // ser.onbin = b => console.log(b);
 ser.ontext = t => console.log(t);
-// ser.online = t => console.log(t);
 
 // state
-ser.onopen = () => {
-    console.log('Opened', ser.getName());
-}
-ser.onclose = () => {
-    console.log('Closed');
+// ser.onopen = () => {
+//     console.log('Opened', ser.getName());
+// }
+// ser.onclose = () => {
+//     console.log('Closed');
+// }
+ser.onchange = s => {
+    console.log(s);
 }
 ser.onerror = e => {
     console.log(e);
 }
 ser.onselect = (port) => {
-    console.log('port change', port);
+    console.log('select', port);
 }

package/test_dev/script.js

@@ -12,18 +12,20 @@ send_b.onclick = () => ser.sendText('Hello ' + i++);
 // read
 // ser.onbin = b => console.log(b);
 ser.ontext = t => console.log(t);
-// ser.online = t => console.log(t);
 
 // state
-ser.onopen = () => {
-    console.log('Opened', ser.getName());
-}
-ser.onclose = () => {
-    console.log('Closed');
+// ser.onopen = () => {
+//     console.log('Opened', ser.getName());
+// }
+// ser.onclose = () => {
+//     console.log('Closed');
+// }
+ser.onchange = s => {
+    console.log(s);
 }
 ser.onerror = e => {
     console.log(e);
 }
 ser.onselect = (port) => {
-    console.log('port change', port);
+    console.log('select', port);
 }