Skip to content

Add support for websocket binary messages mode #2

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

Open
fufler wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add support for websocket binary messages mode #2

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
4 changes: 3 additions & 1 deletion .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
VUE_APP_GUITARIX_HOST=127.0.0.1
VUE_APP_GUITARIX_PORT=5000

VUE_APP_WEBSOCKET_USE_BINARY_FORMAT=0

# comma seperated
VUE_APP_GUITARIX_IGNORE_FX=dubber,mbc,mbchor,mbclip,mbcs,mbd,mbdel,mbe,oscilloscope,seq

VUE_APP_DISABLE_LOGGER=0
VUE_APP_DISABLE_LOGGER=0
18 changes: 14 additions & 4 deletions src/plugins/guitarix.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,16 @@ const { logger } = utils

const GUITARIX_NAMESPACE = 'guitarix'

const { VUE_APP_GUITARIX_IGNORE_FX: FX_IGNORE_LIST } = process.env
const {
VUE_APP_GUITARIX_IGNORE_FX: FX_IGNORE_LIST,
VUE_APP_WEBSOCKET_USE_BINARY_FORMAT: WEBSOCKET_USE_BINARY_FORMAT
} = process.env

// clean up fx ids
const fxIgnoreList = FX_IGNORE_LIST.split(',').map(fx => fx.trim())

const useWebsocketBinaryFormat = ['1', 'true', true].includes(WEBSOCKET_USE_BINARY_FORMAT.trim())

const methodsRequiringIds = [
'banks',
'get',
Expand Down Expand Up @@ -92,9 +97,11 @@ class GuitarixSocket {
this._attemptReconnect()
}

_onMessage (response) {
async _onMessage (response) {
try {
var msg = JSON.parse(response.data)
const jsonString = useWebsocketBinaryFormat ? await response.data.text() : response.data

var msg = JSON.parse(jsonString)
logger('RX: ', msg)
} catch (e) {
logger('EX: ', e)
Expand Down Expand Up @@ -167,7 +174,10 @@ class GuitarixSocket {
if (this._connected) {
logger('TX: ', msg)

this._socket.send(JSON.stringify(msg))
const jsonString = JSON.stringify(msg)
const payload = useWebsocketBinaryFormat ? new Blob([jsonString + '\n']) : jsonString

this._socket.send(payload)
} else {
this._queue.unshift(msg)
}
Expand Down