Skip to content

Add a long touch event #1

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
idolize wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add a long touch event #1

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a3e975b
Add a long touch event
idolize Apr 22, 2019
d7f9122
Update CraftPlugin.ts
idolize Apr 22, 2019
70041b1
Improvements
idolize May 9, 2019
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
48 changes: 40 additions & 8 deletions src/CraftPlugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ const LOGITECH_OPTIONS_URL = 'ws://localhost:10134';

const stringify = (obj: any) => JSON.stringify(obj);

const sendRegister = (pluginGuid: string) => stringify({
const registerOutgoingMessage = (pluginGuid: string) => stringify({
PID: process.pid,
application_version: '1.0',
execName: process.title,
message_type: 'register',
plugin_guid: pluginGuid,
});

const sendToolChange = (sessionId: string, toolId: string) => stringify({
const toolChangeOutgoingMessage = (sessionId: string, toolId: string) => stringify({
message_type: 'tool_change',
reset_options: true,
session_id: sessionId,
Expand Down Expand Up @@ -74,35 +74,48 @@ export type CraftPluginEventType =
interface CraftPluginOptions {
pluginGuid: string;
reconnect?: boolean;
crownTurnCancelsRelease?: boolean;
}

// https://github.com/Logitech/logi_craft_sdk/blob/master/documentation/Craft_Crown_SDK.md
export default class CraftPlugin {
public static log: boolean = true;
private ws!: WebSocket;
private emitter: EventEmitter;
private sessionId: string | undefined;
private opts: CraftPluginOptions;
private touchTimer: any | undefined;
private touchingCrown: boolean = false;

constructor({ pluginGuid, reconnect = true }: CraftPluginOptions) {
this.opts = { pluginGuid, reconnect };
constructor({ pluginGuid, reconnect = true, crownTurnCancelsRelease = false }: CraftPluginOptions) {
this.opts = { pluginGuid, reconnect, crownTurnCancelsRelease };
this.emitter = new EventEmitter();
this.connectWithManager();
}

private static logToConsole(message: string) {
if (CraftPlugin.log) {
console.log(`[logitech-craft-plugin] ${message}`);
}
}

private connectWithManager() {
if (this.ws && this.ws.readyState !== this.ws.CONNECTING && this.ws.readyState !== this.ws.CLOSED) {
console.log('Already connected');
CraftPlugin.logToConsole('Already connected');
return;
}
if (this.ws) {
// We are reconnecting so clean up the old instance
this.ws.removeAllListeners();
clearTimeout(this.touchTimer);
this.touchTimer = undefined;
this.touchingCrown = false;
}
this.ws = new WebSocket(LOGITECH_OPTIONS_URL);
this.emitter.emit('connect:begin');
this.ws.once('open', () => {
this.sessionId = undefined;
this.ws.send(sendRegister(this.opts.pluginGuid));
this.ws.send(registerOutgoingMessage(this.opts.pluginGuid));
this.ws.on('message', (data: string) => {
// route the message
let message: ReceiveMessage;
Expand All @@ -127,7 +140,7 @@ export default class CraftPlugin {
});
this.ws.on('error', (err) => {
this.emitter.emit('connect:failed', err);
console.error('Failed to connect to Logitech Options', err.message);
CraftPlugin.logToConsole('Failed to connect to Logitech Options ' + err.message);
if (this.opts.reconnect) {
setTimeout(() => {
this.connectWithManager();
Expand All @@ -150,20 +163,36 @@ export default class CraftPlugin {
} else if (message.ratchet_delta < 0) {
this.emitter.emit('crown:turn:negative', message);
}
clearTimeout(this.touchTimer);
this.touchTimer = undefined;
if (this.opts.crownTurnCancelsRelease) {
this.touchingCrown = false;
}
}

private handleCrownTouch(message: CrownTouchMessage) {
this.emitter.emit('crown:touch', message);
if (message.touch_state === 0) {
this.emitter.emit('crown:touch:released', message);
clearTimeout(this.touchTimer);
this.touchTimer = undefined;
this.touchingCrown = false;
} else if (message.touch_state === 1) {
this.emitter.emit('crown:touch:touched', message);
this.touchTimer = setTimeout(() => {
this.emitter.emit('crown:touch:longTouch', message);
this.touchTimer = undefined;
}, 1000);
}
}

public get isTouchingCrown(): boolean {
return this.touchingCrown;
}

public changeTool(toolId: string) {
if (this.sessionId) {
this.ws.send(sendToolChange(this.sessionId, toolId));
this.ws.send(toolChangeOutgoingMessage(this.sessionId, toolId));
} else {
throw new Error('Not connected yet. Make sure to only send this once the "connect:done" event has occurred');
}
Expand All @@ -178,6 +207,9 @@ export default class CraftPlugin {
}

public close() {
clearTimeout(this.touchTimer);
this.touchTimer = undefined;
this.touchingCrown = false;
this.emitter.removeAllListeners();
this.ws.close();
}
Expand Down