PiShock.ts

Disclaimer

This package has not yet been thoroughly tested, it might not work as intented and i have yet to run some tests. Use at your own risk (but also feel free to test for me)

Tests have been done against a collar running v1 and a collar running v3

A simple and easy to use TypeScript wrapper for PiShock

Requires Node v18.17+

Connecting to a shocker:

const shocker = new PiShock("username", "apikey", "sharekey", "name");

The name is the name you want to give your script. If omitted, it will default to pishock.ts

Sending a shock:

shocker.shock({
    Intensity: 1-100,
    Duration: 1-15
})

This will return a promise with the response of the API. The API will 200 every request, regardless of succession, and will respond with a string. Operation Succeeded / Attempted means the shock was sent. If the API responds with anything over 200, an exception will be thrown. The only way i managed to get anything over 200 was with invalid login credentials. A full list of messages can be found in the api docs

Vibrating:

shocker.vibrate({
    Intensity: 1-100,
    Duration: 1-xxx
})

Beeping:

shocker.beep(duration)

Requesting shocker info :

shocker.getInfo()

This will respond with the info in a JSON format.

Disclaimer;

I do not own a pishock, but i just got the idea to use Discord's user apps to control other peoples shockers. I used a friends shocker to test this. This also is the first time i publish somnething to npm so bugs may be present