dualsense-ts 2.0.2 → 2.0.13

package/docs/Exports.md

@@ -0,0 +1,214 @@
+# dualsense-ts
+
+## Table of contents
+
+### Enumerations
+
+- [Brightness](../wiki/Brightness)
+- [CommandScopeA](../wiki/CommandScopeA)
+- [CommandScopeB](../wiki/CommandScopeB)
+- [InputId](../wiki/InputId)
+- [LedOptions](../wiki/LedOptions)
+- [PlayerID](../wiki/PlayerID)
+- [PulseOptions](../wiki/PulseOptions)
+- [TriggerMode](../wiki/TriggerMode)
+
+### Classes
+
+- [Accelerometer](../wiki/Accelerometer)
+- [Analog](../wiki/Analog)
+- [Axis](../wiki/Axis)
+- [Dpad](../wiki/Dpad)
+- [Dualsense](../wiki/Dualsense)
+- [DualsenseHID](../wiki/DualsenseHID)
+- [Gyroscope](../wiki/Gyroscope)
+- [Haptic](../wiki/Haptic)
+- [Indicator](../wiki/Indicator)
+- [Input](../wiki/Input)
+- [Momentary](../wiki/Momentary)
+- [Motion](../wiki/Motion)
+- [Mute](../wiki/Mute)
+- [Touchpad](../wiki/Touchpad)
+- [Trigger](../wiki/Trigger)
+- [Unisense](../wiki/Unisense)
+
+### Interfaces
+
+- [AnalogParams](../wiki/AnalogParams)
+- [DpadParams](../wiki/DpadParams)
+- [DualSenseCommand](../wiki/DualSenseCommand)
+- [DualsenseHIDState](../wiki/DualsenseHIDState)
+- [DualsenseParams](../wiki/DualsenseParams)
+- [InputParams](../wiki/InputParams)
+- [UnisenseParams](../wiki/UnisenseParams)
+
+### Type Aliases
+
+- [Degrees](../wiki/Exports#degrees)
+- [Force](../wiki/Exports#force)
+- [InputEvent](../wiki/Exports#inputevent)
+- [Intensity](../wiki/Exports#intensity)
+- [Magnitude](../wiki/Exports#magnitude)
+- [Radians](../wiki/Exports#radians)
+
+### Variables
+
+- [InputChanged](../wiki/Exports#inputchanged)
+- [InputIcon](../wiki/Exports#inputicon)
+- [InputName](../wiki/Exports#inputname)
+- [InputSet](../wiki/Exports#inputset)
+
+### Functions
+
+- [mapAxis](../wiki/Exports#mapaxis)
+- [mapTrigger](../wiki/Exports#maptrigger)
+
+## Type Aliases
+
+### Degrees
+
+Ƭ **Degrees**: `number`
+
+A numeric value between 0 and 360.
+
+#### Defined in
+
+[src/math.ts:9](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/math.ts#L9)
+
+___
+
+### Force
+
+Ƭ **Force**: `number`
+
+A numeric value between -1 and 1.
+
+#### Defined in
+
+[src/math.ts:19](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/math.ts#L19)
+
+___
+
+### InputEvent
+
+Ƭ **InputEvent**: ``"change"`` \| ``"input"`` \| ``"press"`` \| ``"release"``
+
+#### Defined in
+
+[src/input.ts:34](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L34)
+
+___
+
+### Intensity
+
+Ƭ **Intensity**: `number`
+
+A numeric value between 0 and 1.
+
+#### Defined in
+
+[src/math.ts:24](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/math.ts#L24)
+
+___
+
+### Magnitude
+
+Ƭ **Magnitude**: `number`
+
+A numeric value between 0 and 1.
+
+#### Defined in
+
+[src/math.ts:14](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/math.ts#L14)
+
+___
+
+### Radians
+
+Ƭ **Radians**: `number`
+
+A numeric value between ±Math.PI.
+
+#### Defined in
+
+[src/math.ts:4](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/math.ts#L4)
+
+## Variables
+
+### InputChanged
+
+• `Const` **InputChanged**: typeof [`InputChanged`](../wiki/Exports#inputchanged)
+
+#### Defined in
+
+[src/input.ts:27](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L27)
+
+___
+
+### InputIcon
+
+• `Const` **InputIcon**: typeof [`InputIcon`](../wiki/Exports#inputicon)
+
+#### Defined in
+
+[src/input.ts:32](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L32)
+
+___
+
+### InputName
+
+• `Const` **InputName**: typeof [`InputName`](../wiki/Exports#inputname)
+
+#### Defined in
+
+[src/input.ts:31](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L31)
+
+___
+
+### InputSet
+
+• `Const` **InputSet**: typeof [`InputSet`](../wiki/Exports#inputset)
+
+#### Defined in
+
+[src/input.ts:30](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L30)
+
+## Functions
+
+### mapAxis
+
+▸ **mapAxis**(`value`): `number`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `number` |
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+[src/hid/dualsense_hid.ts:51](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/hid/dualsense_hid.ts#L51)
+
+___
+
+### mapTrigger
+
+▸ **mapTrigger**(`value`): `number`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `number` |
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+[src/hid/dualsense_hid.ts:56](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/hid/dualsense_hid.ts#L56)

package/docs/Gyroscope.md

@@ -0,0 +1,13 @@
+# Class: Gyroscope
+
+## Table of contents
+
+### Constructors
+
+- [constructor](../wiki/Gyroscope#constructor)
+
+## Constructors
+
+### constructor
+
+• **new Gyroscope**()

package/docs/Haptic.md

@@ -0,0 +1,27 @@
+# Class: Haptic
+
+## Table of contents
+
+### Constructors
+
+- [constructor](../wiki/Haptic#constructor)
+
+### Properties
+
+- [vibration](../wiki/Haptic#vibration)
+
+## Constructors
+
+### constructor
+
+• **new Haptic**()
+
+## Properties
+
+### vibration
+
+• `Readonly` **vibration**: `number` = `0`
+
+#### Defined in
+
+[src/haptics/haptic.ts:4](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/haptics/haptic.ts#L4)

package/docs/Home.md

@@ -0,0 +1,105 @@
+# dualsense-ts
+
+This module provides a natural interface for your DualSense controller, so you can focus on input and forget about the device.
+
+## Getting started
+
+### Installation
+
+This package is distributed via npm: [dualsense-ts](https://npmjs.org/package.dualsense-ts)
+
+Install it using your preferred package manager:
+
+- `yarn add dualsense-ts`
+- `npm add dualsense-ts`
+
+### Connecting
+
+By default, `dualsense-ts` will try to connect to the first Dualsense controller it finds.
+
+```typescript
+import { Dualsense } from "dualsense-ts";
+
+// Grab a controller connected via USB or Bluetooth
+const controller = new Dualsense();
+```
+
+### Input
+
+`dualsense-ts` provides several interfaces for reading input:
+
+- _Synchronous_: It's safe to read the current input state at any time
+
+```typescript
+// Buttons
+controller.circle.active; // false
+controller.cross.active; // true
+controller.left.bumper.active; // true
+
+// Triggers
+controller.right.trigger.active; // true
+controller.right.trigger.pressure; // 0.72 (0 - 1)
+
+// Analog Sticks
+controller.left.analog.x.active; // true
+controller.left.analog.x.state; // 0.51 (0 - 1)
+controller.right.analog.y.active; // false
++controller.right.analog.y; // 0 (0 - 1)
+```
+
+- _Callbacks_: Each input is an EventEmitter that provides `input` or `change` events
+
+```typescript
+// Change events are triggered only when an input's value changes
+controller.triangle.on("change", (input) =>
+  console.log(`${input} changed: ${input.active}`)
+);
+// ▲ changed: true
+// ▲ changed: false
+
+controller.triangle.removeAllListeners();
+
+// The callback provides two arguments, so you can monitor nested inputs
+controller.dpad.on("change", (dpad, input) =>
+  assert(dpad === controller.dpad) // The input you subscribed to
+  console.log(`${input} changed: ${input.active}`) // The input that actually changed
+);
+// ↑ changed: true
+// → changed: true
+// ↑ changed: false
+
+// `input` events are triggered whenever there is new information from the controller
+// Your Dualsense may provide over 250 `input` events per second, so use this sparingly
+// These events are not available for nested inputs, like in the example above
+controller.left.analog.x.on("input", console.log)
+```
+
+- _Promises_: Wait for one-off inputs using `await`
+
+```typescript
+// Wait for up to be pressed or released
+const { active } = await controller.dpad.up.promise();
+
+// Wait for the next change to any dpad button's state
+const { left, up, down, right } = await controller.dpad.promise();
+
+// Wait for any input at all
+await controller.promise();
+```
+
+- _Async Iterators_: Each input is an async iterator that provides state changes
+
+```typescript
+for await (const { left, right, up, down } of controller.dpad) {
+  console.log(`dpad: ${left} ${up} ${down} ${right}`);
+}
+```
+
+## Other features
+
+Check out the [roadmap](./ROADMAP.md) for more info about upcoming features.
+
+## Credits
+
+- [CamTosh](https://github.com/CamTosh)'s [node-dualsense](https://github.com/CamTosh/node-dualsense)
+- [flok](https://github.com/flok)'s [pydualsense](https://github.com/flok/pydualsense)

package/docs/Indicator.md

@@ -0,0 +1,52 @@
+# Class: Indicator
+
+## Table of contents
+
+### Constructors
+
+- [constructor](../wiki/Indicator#constructor)
+
+### Properties
+
+- [brightness](../wiki/Indicator#brightness)
+
+### Methods
+
+- [setColor](../wiki/Indicator#setcolor)
+
+## Constructors
+
+### constructor
+
+• **new Indicator**()
+
+## Properties
+
+### brightness
+
+• `Readonly` **brightness**: `number` = `0`
+
+#### Defined in
+
+[src/indicators/indicator.ts:6](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/indicators/indicator.ts#L6)
+
+## Methods
+
+### setColor
+
+▸ **setColor**(`__namedParameters`, `controller`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `__namedParameters` | `Uint8Array` |
+| `controller` | `HID` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[src/indicators/indicator.ts:8](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/indicators/indicator.ts#L8)