Enhanced Node.js module for interfacing with HyperX Cloud Flight Wireless headsets

This is a fork of srn/hyperx-cloud-flight-wireless with significant improvements to connection reliability and event handling.

This fork includes several critical improvements:

• 🔄 Robust reconnection handling - Properly reconnects after power cycles
• 🔌 Better device detection - More reliable device discovery after disconnection
• 🛡️ Error resilience - Improved error handling with automatic recovery
• 🧹 Proper resource cleanup - Prevents memory leaks and stale connections
• ⚡ Faster event handling - More responsive status updates
• 🔋 More reliable battery reporting - Consistent battery level updates

$ npm install hyperx-cloud-flight-wireless

const hyperxCloudFlight = require('hyperx-cloud-flight-wireless')()

// Event listeners
hyperxCloudFlight.on('power', state) // 'on' | 'off'
hyperxCloudFlight.on('muted', muted) // Boolean
hyperxCloudFlight.on('volume', direction) // 'up' | 'down'
hyperxCloudFlight.on('charging', charging) // Boolean
hyperxCloudFlight.on('battery', percentage) // 0-100 | null
hyperxCloudFlight.on('error', error) // instanceof Error

// Enhanced API methods
hyperxCloudFlight.clearListeners() // Remove all event listeners
hyperxCloudFlight.close() // Cleanly close connection and release resources

The module accepts a configuration object with the following options:

const hyperx = require('hyperx-cloud-flight-wireless')({
  debug: false, // Enable/disable debug logging
  updateDelay: 30000, // Update interval in milliseconds (default: 5min)
})

To work with Linux it is necessary to run as root, or define rules for udev:

echo 'KERNEL=="hidraw*", SUBSYSTEM=="hidraw", MODE="0664", GROUP="plugdev"' | sudo tee -a /etc/udev/rules.d/99-hidraw-permissions.rules && sudo udevadm control --reload-rules

Disconnect and reconnect the device after applying these rules.

The battery percentage is an estimate based on the device's status report. The implementation uses HID communications to interface with the headset's USB dongle.

MIT © Søren Brokær

Enhanced fork maintained by Alex Adiaconitei