dualsense-ts 2.0.13 → 2.1.30

package/docs/DualsenseParams.md

@@ -36,7 +36,7 @@
 
 #### Defined in
 
-[src/dualsense.ts:22](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/dualsense.ts#L22)
+[src/dualsense.ts:22](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/dualsense.ts#L22)
 
 ___
 
@@ -46,7 +46,7 @@ ___
 
 #### Defined in
 
-[src/dualsense.ts:20](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/dualsense.ts#L20)
+[src/dualsense.ts:20](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/dualsense.ts#L20)
 
 ___
 
@@ -56,7 +56,7 @@ ___
 
 #### Defined in
 
-[src/dualsense.ts:23](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/dualsense.ts#L23)
+[src/dualsense.ts:23](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/dualsense.ts#L23)
 
 ___
 
@@ -66,7 +66,7 @@ ___
 
 #### Defined in
 
-[src/dualsense.ts:25](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/dualsense.ts#L25)
+[src/dualsense.ts:25](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/dualsense.ts#L25)
 
 ___
 
@@ -76,7 +76,7 @@ ___
 
 #### Defined in
 
-[src/dualsense.ts:14](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/dualsense.ts#L14)
+[src/dualsense.ts:14](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/dualsense.ts#L14)
 
 ___
 
@@ -90,7 +90,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:6](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L6)
+[src/input.ts:6](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L6)
 
 ___
 
@@ -100,7 +100,7 @@ ___
 
 #### Defined in
 
-[src/dualsense.ts:26](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/dualsense.ts#L26)
+[src/dualsense.ts:26](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/dualsense.ts#L26)
 
 ___
 
@@ -110,7 +110,7 @@ ___
 
 #### Defined in
 
-[src/dualsense.ts:18](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/dualsense.ts#L18)
+[src/dualsense.ts:18](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/dualsense.ts#L18)
 
 ___
 
@@ -124,7 +124,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:5](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L5)
+[src/input.ts:5](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L5)
 
 ___
 
@@ -134,7 +134,7 @@ ___
 
 #### Defined in
 
-[src/dualsense.ts:19](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/dualsense.ts#L19)
+[src/dualsense.ts:19](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/dualsense.ts#L19)
 
 ___
 
@@ -148,7 +148,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:8](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L8)
+[src/input.ts:8](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L8)
 
 ___
 
@@ -158,7 +158,7 @@ ___
 
 #### Defined in
 
-[src/dualsense.ts:17](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/dualsense.ts#L17)
+[src/dualsense.ts:17](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/dualsense.ts#L17)
 
 ___
 
@@ -168,7 +168,7 @@ ___
 
 #### Defined in
 
-[src/dualsense.ts:27](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/dualsense.ts#L27)
+[src/dualsense.ts:27](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/dualsense.ts#L27)
 
 ___
 
@@ -178,7 +178,7 @@ ___
 
 #### Defined in
 
-[src/dualsense.ts:24](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/dualsense.ts#L24)
+[src/dualsense.ts:24](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/dualsense.ts#L24)
 
 ___
 
@@ -192,7 +192,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:7](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L7)
+[src/input.ts:7](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L7)
 
 ___
 
@@ -202,7 +202,7 @@ ___
 
 #### Defined in
 
-[src/dualsense.ts:28](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/dualsense.ts#L28)
+[src/dualsense.ts:28](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/dualsense.ts#L28)
 
 ___
 
@@ -212,4 +212,4 @@ ___
 
 #### Defined in
 
-[src/dualsense.ts:21](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/dualsense.ts#L21)
+[src/dualsense.ts:21](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/dualsense.ts#L21)

package/docs/Exports.md

@@ -23,11 +23,13 @@
 - [DualsenseHID](../wiki/DualsenseHID)
 - [Gyroscope](../wiki/Gyroscope)
 - [Haptic](../wiki/Haptic)
+- [Increment](../wiki/Increment)
 - [Indicator](../wiki/Indicator)
 - [Input](../wiki/Input)
 - [Momentary](../wiki/Momentary)
 - [Motion](../wiki/Motion)
 - [Mute](../wiki/Mute)
+- [Touch](../wiki/Touch)
 - [Touchpad](../wiki/Touchpad)
 - [Trigger](../wiki/Trigger)
 - [Unisense](../wiki/Unisense)
@@ -73,7 +75,7 @@ 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)
+[src/math.ts:9](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/math.ts#L9)
 
 ___
 
@@ -85,7 +87,7 @@ 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)
+[src/math.ts:19](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/math.ts#L19)
 
 ___
 
@@ -95,7 +97,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:34](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L34)
+[src/input.ts:34](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L34)
 
 ___
 
@@ -107,7 +109,7 @@ 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)
+[src/math.ts:24](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/math.ts#L24)
 
 ___
 
@@ -119,7 +121,7 @@ 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)
+[src/math.ts:14](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/math.ts#L14)
 
 ___
 
@@ -131,7 +133,7 @@ A numeric value between ±Math.PI.
 
 #### Defined in
 
-[src/math.ts:4](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/math.ts#L4)
+[src/math.ts:4](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/math.ts#L4)
 
 ## Variables
 
@@ -141,7 +143,7 @@ A numeric value between ±Math.PI.
 
 #### Defined in
 
-[src/input.ts:27](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L27)
+[src/input.ts:27](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L27)
 
 ___
 
@@ -151,7 +153,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:32](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L32)
+[src/input.ts:32](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L32)
 
 ___
 
@@ -161,7 +163,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:31](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L31)
+[src/input.ts:31](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L31)
 
 ___
 
@@ -171,19 +173,20 @@ ___
 
 #### Defined in
 
-[src/input.ts:30](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L30)
+[src/input.ts:30](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L30)
 
 ## Functions
 
 ### mapAxis
 
-▸ **mapAxis**(`value`): `number`
+▸ **mapAxis**(`value`, `max?`): `number`
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `value` | `number` |
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `value` | `number` | `undefined` |
+| `max` | `number` | `255` |
 
 #### Returns
 
@@ -191,7 +194,7 @@ ___
 
 #### Defined in
 
-[src/hid/dualsense_hid.ts:51](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/hid/dualsense_hid.ts#L51)
+[src/hid/dualsense_hid.ts:51](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/hid/dualsense_hid.ts#L51)
 
 ___
 
@@ -211,4 +214,4 @@ ___
 
 #### Defined in
 
-[src/hid/dualsense_hid.ts:56](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/hid/dualsense_hid.ts#L56)
+[src/hid/dualsense_hid.ts:56](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/hid/dualsense_hid.ts#L56)

package/docs/Haptic.md

@@ -24,4 +24,4 @@
 
 #### Defined in
 
-[src/haptics/haptic.ts:4](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/haptics/haptic.ts#L4)
+[src/haptics/haptic.ts:4](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/haptics/haptic.ts#L4)

package/docs/Home.md

@@ -1,6 +1,6 @@
 # dualsense-ts
 
-This module provides a natural interface for your DualSense controller, so you can focus on input and forget about the device.
+This module provides a natural interface for your DualSense controller.
 
 ## Getting started
 
@@ -15,7 +15,7 @@ Install it using your preferred package manager:
 
 ### Connecting
 
-By default, `dualsense-ts` will try to connect to the first Dualsense controller it finds.
+`dualsense-ts` will try to connect to the first Dualsense controller it finds.
 
 ```typescript
 import { Dualsense } from "dualsense-ts";
@@ -32,22 +32,25 @@ const controller = new Dualsense();
 
 ```typescript
 // Buttons
-controller.circle.active; // false
-controller.cross.active; // true
-controller.left.bumper.active; // true
+controller.circle.state;      // false
+controller.left.bumper.state; // 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)
+controller.right.trigger.active;   // true
+controller.right.trigger.pressure; // 0.72, 0 - 1
+
+// Analog Sticks - represented as a position on a unit circle
+controller.left.analog.x.active;  // true, when away from center
+controller.left.analog.x.state;   // 0.51, -1 to 1
+controller.left.analog.direction; // 4.32, radians
+controller.left.analog.magnitude; // 0.23, 0 to 1
+
+// Touchpad - each touch point works like an analog input
+controller.touchpad.right.contact.state; // false
++controller.touchpad.right.x;            // -0.44, -1 to 1
 ```
 
-- _Callbacks_: Each input is an EventEmitter that provides `input` or `change` events
+- _Callbacks_: Each input is an EventEmitter that provides `input`, `press`, `release`, and `change` events
 
 ```typescript
 // Change events are triggered only when an input's value changes
@@ -57,31 +60,30 @@ controller.triangle.on("change", (input) =>
 // ▲ 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
+// You'll get a reference to your original input, and whichever one changed
+controller.dpad.on("press", (dpad, input) =>
+  assert(dpad === controller.dpad)
+  console.log(`${input} pressed`)
 );
-// ↑ changed: true
-// → changed: true
-// ↑ changed: false
+// ↑ pressed
+// → pressed
+// ↑ pressed
 
 // `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
+// These events are not available for nested inputs, like 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();
+// Resolves next time `dpad up` is released
+const { active } = await controller.dpad.up.promise("release");
 
-// Wait for the next change to any dpad button's state
-const { left, up, down, right } = await controller.dpad.promise();
+// Wait for the next press of any dpad button
+const { left, up, down, right } = await controller.dpad.promise("pres");
 
 // Wait for any input at all
 await controller.promise();
@@ -90,8 +92,8 @@ 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}`);
+for await (const { pressure } of controller.left.trigger) {
+  console.log(`L2: ${Math.round(pressure*100)}%`);
 }
 ```