var { env } = require('process') env.UV_THREADPOOL_SIZE = 8 // Allow up to 8 panels

const { XKeysWatcher } = require('xkeys') // or 'xkeys-webhid' in a browser /* This example connects to any connected x-keys panels and logs whenever a button is pressed or analog thing is moved */ // Set up the watcher for xkeys: const watcher = new XKeysWatcher({ // automaticUnitIdMode: false // usePolling: false // pollingInterval= 1000 }) watcher.on('error', (e) => { console.log('Error in XKeysWatcher', e) }) watcher.on('connected', (xkeysPanel) => { console.log(`X-keys panel of type ${xkeysPanel.info.name} connected`) xkeysPanel.on('disconnected', () => { console.log(`X-keys panel of type ${xkeysPanel.info.name} was disconnected`) // Clean up stuff xkeysPanel.removeAllListeners() }) xkeysPanel.on('error', (...errs) => { console.log('X-keys error:', ...errs) }) // Listen to pressed buttons: xkeysPanel.on('down', (keyIndex, metadata) => { console.log('Button pressed ', keyIndex, metadata) // Light up a button when pressed: xkeysPanel.setBacklight(keyIndex, 'red') }) // Listen to released buttons: xkeysPanel.on('up', (keyIndex, metadata) => { console.log('Button released', keyIndex, metadata) // Turn off button light when released: xkeysPanel.setBacklight(keyIndex, false) }) // Listen to jog wheel changes: xkeysPanel.on('jog', (index, deltaPos, metadata) => { console.log(`Jog ${index} position has changed`, deltaPos, metadata) }) // Listen to shuttle changes: xkeysPanel.on('shuttle', (index, shuttlePos, metadata) => { console.log(`Shuttle ${index} position has changed`, shuttlePos, metadata) }) // Listen to joystick changes: xkeysPanel.on('joystick', (index, position, metadata) => { console.log(`Joystick ${index} position has changed`, position, metadata) // {x, y, z} }) // Listen to t-bar changes: xkeysPanel.on('tbar', (index, position, metadata) => { console.log(`T-bar ${index} position has changed`, position, metadata) }) }) // To stop watching, call // watcher.stop().catch(console.error)

const { setupXkeysPanel } = require('xkeys') /* This example shows how to use XKeys.setupXkeysPanel() directly, instead of going via XKeysWatcher() */ // Connect to an xkeys-panel: setupXkeysPanel() .then((xkeysPanel) => { xkeysPanel.on('disconnected', () => { console.log(`X-keys panel of type ${xkeysPanel.info.name} was disconnected`) // Clean up stuff xkeysPanel.removeAllListeners() }) xkeysPanel.on('error', (...errs) => { console.log('X-keys error:', ...errs) }) xkeysPanel.on('down', (keyIndex, metadata) => { console.log('Button pressed', keyIndex, metadata) }) // ... }) .catch(console.log) // Handle error

const { listAllConnectedPanels, setupXkeysPanel } = require('xkeys') // List and connect to all xkeys-panels: listAllConnectedPanels().forEach((connectedPanel) => { setupXkeysPanel(connectedPanel) .then((xkeysPanel) => { console.log(`Connected to ${xkeysPanel.info.name}`) // ... }) .catch(console.log) // Handle error

const { XKeysWatcher, requestXkeysPanels } = require('xkeys-webhid') const watcher = new XKeysWatcher({}) watcher.on('error', (e) => { console.log('Error in XKeysWatcher', e) }) watcher.on('connected', (xkeysPanel) => { // This will be triggered whenever a panel is connected, or permissions is granted. // >> See the example above for setting up the xkeysPanel << }) myHTMLButton.addEventListener('click', async () => { // Open the Request device permissions dialog: requestXkeysPanels().catch((error) => console.error(error)) // Notes: // When the user has granted permissions, the browser will remember this between sessions. // However, if the panel is disconnected and reconnected, the user will have to grant permissions again. })

const { XKeysWatcher } = require('xkeys') const watcher = new XKeysWatcher({ // automaticUnitIdMode: false // usePolling: false // pollingInterval= 1000 }) watcher.on('error', (e) => { console.log('Error in XKeysWatcher', e) }) watcher.on('connected', (xkeysPanel) => { // xkeysPanel connected... }) // Note: In a browser, user must first grant permissions to access the X-keys, using requestXkeysPanels().

// Example: xkeysPanel.on('down', (keyIndex, metadata) => { console.log('Button pressed', keyIndex, metadata) })

xkeysPanel.setBacklight(keyIndex, color) // Examples: // Set blue light xkeysPanel.setBacklight(keyIndex, '0000ff') // Set any available default light xkeysPanel.setBacklight(keyIndex, true) // Turn off light xkeysPanel.setBacklight(keyIndex, false) // Set flashing light xkeysPanel.setBacklight(keyIndex, 'red', true) // Set color (for RGB-supported devices) xkeysPanel.setBacklight(keyIndex, 'ff3300')

xkeysPanel.setIndicatorLED(ledIndex, on, flashing) // Examples: // Light up the green LED xkeysPanel.setIndicatorLED(1, true) // Flash the red LED xkeysPanel.setIndicatorLED(2, true, true)

xkeysPanel.setBacklightIntensity(intensity) // Example: // Set max intensity xkeysPanel.setBacklightIntensity(255)

xkeysPanel.setAllBacklights(color) // Example: // Light up all buttons xkeysPanel.setAllBacklights(true) // Light up all buttons in a nice color xkeysPanel.setAllBacklights('ff33ff') // Turn of all buttons xkeysPanel.setAllBacklights(false)

// The frequency can be set to 1-255, where 1 is fastest and 255 is the slowest. // 255 is approximately 4 seconds between flashes. xkeysPanel.setFrequency(frequency) // Example: // Set the frequency to a pretty fast flash xkeysPanel.setFrequency(8)

// Sets the UID (unit Id) value in the X-keys hardware // Note: This writes to the EEPROM, don't call this function too often, or you'll kill the EEPROM! (An EEPROM only support a few thousands of write operations.) xkeysPanel.setUnitId(unitId)

// Save the backlights (so they are restored to this after a power cycle). // Note: This writes to the EEPROM, don't call this function too often, or you'll kill the EEPROM! (An EEPROM only support a few thousands of write operations.) xkeysPanel.saveBackLights()

const watcher = new XKeysWatcher() await watcher.stop() // Now returns a promise