@kmamal/sdl/src/javascript/joystick/joystick-instance.js

SDL bindings for Node.js

const Globals = require('../globals')
const Bindings = require('../bindings')
const { EventsViaPoll } = require('../events/events-via-poll')

const validEvents = [
	'axisMotion',
	'ballMotion',
	'buttonDown',
	'buttonUp',
	'hatMotion',
	'powerUpdate',
	'close',
]

class JoystickInstance extends EventsViaPoll {
	constructor (device) {
		super(validEvents)

		if (!Globals.joystickDevices.includes(device)) { throw Object.assign(new Error("invalid device"), { device }) }

		const result = Bindings.joystick_open(device._index)

		this._firmwareVersion = result.firmwareVersion
		this._serialNumber = result.serialNumber
		this._hasLed = result.hasLed
		this._hasRumble = result.hasRumble
		this._hasRumbleTriggers = result.hasRumbleTriggers
		this._axes = result.axes
		this._balls = result.balls
		this._buttons = result.buttons
		this._hats = result.hats
		this._power = result.power

		this._device = device

		this._rumbleTimeout = null
		this._rumbleTriggersTimeout = null
		this._closed = false

		Globals.joystickInstances.all.add(this)
		let collection = Globals.joystickInstances.byId.get(this._device.id)
		if (!collection) {
			collection = new Set()
			Globals.joystickInstances.byId.set(this._device.id, collection)
		}
		collection.add(this)
	}

	get device () { return this._device }
	get firmwareVersion () { return this._firmwareVersion }
	get serialNumber () { return this._serialNumber }

	get axes () {
		Globals.events.poll()
		return this._axes
	}

	get balls () {
		Globals.events.poll()
		return this._balls
	}

	get buttons () {
		Globals.events.poll()
		return this._buttons
	}

	get hats () {
		Globals.events.poll()
		return this._hats
	}

	get power () { return this._power }

	setPlayer (player) {
		if (this._closed) { throw Object.assign(new Error("instance is closed"), { id: this._device.id }) }

		if (!Number.isInteger(player)) { throw Object.assign(new Error("player must be an integer"), { player }) }
		if (player < 0) { throw Object.assign(new Error("invalid player"), { player }) }

		Bindings.joystick_setPlayer(this._device.id, player)
	}

	resetPlayer () {
		if (this._closed) { throw Object.assign(new Error("instance is closed"), { id: this._device.id }) }

		Bindings.joystick_setPlayer(this._device.id, -1)
	}

	get hasLed () { return this._hasLed }
	setLed (red, green, blue) {
		if (this._closed) { throw Object.assign(new Error("instance is closed"), { id: this._device.id }) }

		if (!Number.isFinite(red)) { throw Object.assign(new Error("red must be a number"), { red }) }
		if (red < 0 || red > 1) { throw Object.assign(new Error("red must be between 0 and 1"), { red }) }
		if (!Number.isFinite(green)) { throw Object.assign(new Error("green must be a number"), { green }) }
		if (green < 0 || green > 1) { throw Object.assign(new Error("green must be between 0 and 1"), { green }) }
		if (!Number.isFinite(blue)) { throw Object.assign(new Error("blue must be a number"), { blue }) }
		if (blue < 0 || blue > 1) { throw Object.assign(new Error("blue must be between 0 and 1"), { blue }) }

		Bindings.joystick_setLed(this._device.id, red, green, blue)
	}

	get hasRumble () { return this._hasRumble }
	rumble (lowFreqRumble = 1, highFreqRumble = 1, duration = 1e3) {
		if (this._closed) { throw Object.assign(new Error("instance is closed"), { id: this._device.id }) }

		if (!Number.isFinite(lowFreqRumble)) { throw Object.assign(new Error("lowFreqRumble must be a number"), { lowFreqRumble }) }
		if (lowFreqRumble < 0 || lowFreqRumble > 1) { throw Object.assign(new Error("lowFreqRumble must be between 0 and 1"), { lowFreqRumble }) }
		if (!Number.isFinite(highFreqRumble)) { throw Object.assign(new Error("highFreqRumble must be a number"), { highFreqRumble }) }
		if (highFreqRumble < 0 || highFreqRumble > 1) { throw Object.assign(new Error("highFreqRumble must be between 0 and 1"), { highFreqRumble }) }
		if (!Number.isInteger(duration)) { throw Object.assign(new Error("duration must be an integer"), { duration }) }
		if (duration < 0) { throw Object.assign(new Error("invalid duration"), { duration }) }

		// Globals.events.poll() // Errors if it hasn't been called at least once
		Bindings.joystick_rumble(this._device.id, lowFreqRumble, highFreqRumble, duration)
		clearTimeout(this._rumbleTimeout)
		this._rumbleTimeout = setTimeout(() => { this.stopRumble() }, duration)
	}

	stopRumble () {
		clearTimeout(this._rumbleTimeout)
		this._rumbleTimeout = null
		Bindings.joystick_rumble(this._device.id, 0, 0, 0)
		Globals.events.poll()
	}

	get hasRumbleTriggers () { return this._hasRumbleTriggers }
	rumbleTriggers (leftRumble = 1, rightRumble = 1, duration = 1e3) {
		if (this._closed) { throw Object.assign(new Error("instance is closed"), { id: this._device.id }) }

		if (!Number.isFinite(leftRumble)) { throw Object.assign(new Error("leftRumble must be a number"), { leftRumble }) }
		if (leftRumble < 0 || leftRumble > 1) { throw Object.assign(new Error("leftRumble must be between 0 and 1"), { leftRumble }) }
		if (!Number.isFinite(rightRumble)) { throw Object.assign(new Error("rightRumble must be a number"), { rightRumble }) }
		if (rightRumble < 0 || rightRumble > 1) { throw Object.assign(new Error("rightRumble must be between 0 and 1"), { rightRumble }) }
		if (!Number.isInteger(duration)) { throw Object.assign(new Error("duration must be an integer"), { duration }) }
		if (duration < 0) { throw Object.assign(new Error("invalid duration"), { duration }) }

		// Globals.events.poll() // Errors if it hasn't been called at least once
		Bindings.joystick_rumbleTriggers(this._device.id, leftRumble, rightRumble, duration)
		clearTimeout(this._rumbleTriggersTimeout)
		this._rumbleTriggersTimeout = setTimeout(() => { this.stopRumble() }, duration)
	}

	stopRumbleTriggers () {
		clearTimeout(this._rumbleTriggersTimeout)
		this._rumbleTriggersTimeout = null
		Bindings.joystick_rumbleTriggers(this._device.id, 0, 0, 0)
		Globals.events.poll()
	}

	get closed () { return this._closed }
	close () {
		if (this._closed) { throw Object.assign(new Error("instance is closed"), { id: this._device.id }) }

		this.emit('close')
		this.removeAllListeners()
		this._closed = true

		Globals.joystickInstances.all.delete(this)
		const collection = Globals.joystickInstances.byId.get(this._device.id)
		collection.delete(this)
		if (collection.size === 0) {
			Bindings.joystick_close(this._device.id)
			Globals.joystickInstances.byId.delete(this._device.id)
		}
	}
}

module.exports = { JoystickInstance }