Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/c9glax/cshocker
C#-Library to Interact with ESP-Remote Shockcollars
https://github.com/c9glax/cshocker
electrostim electrostimulation estim library openshock pishock shock shock-collars
Last synced: about 2 months ago
JSON representation
C#-Library to Interact with ESP-Remote Shockcollars
- Host: GitHub
- URL: https://github.com/c9glax/cshocker
- Owner: C9Glax
- License: gpl-3.0
- Created: 2024-01-17T03:13:12.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2024-11-03T00:15:31.000Z (about 2 months ago)
- Last Synced: 2024-11-03T01:17:31.836Z (about 2 months ago)
- Topics: electrostim, electrostimulation, estim, library, openshock, pishock, shock, shock-collars
- Language: C#
- Homepage:
- Size: 94.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Library to interact with Shock-Collars that are remotely controllable via ESP32-Boards.
[](https://github.com/C9Glax/CShocker)
[](https://www.nuget.org/packages/CShocker)
# Usage
```csharp
public static void Main(string[] args){
string apiKey = ":)";
OpenShockHttp openShockHttp = new (apiKey);
OpenShockShocker shocker1 = openShockHttp.GetShockers().First();
shocker1.Control(ControlAction.Vibrate, 20, 1000);
shocker1.Dispose();
List serialPorts = SerialHelper.GetSerialPorts();
int selectedPort = 1;
OpenShockSerial openShockSerial = new(serialPorts[selectedPort], apiKey);
OpenShockShocker shocker2 = openShockSerial.GetShockers().First();
shocker2.Control(ControlAction.Vibrate, 20, 1000);
shocker2.Dispose();
}
```
## `Shocker.Control`
```csharp
Control(ControlAction action, int intensity, int duration)
```
### ControlAction
From [here](https://github.com/C9Glax/CShocker/blob/master/CShocker/Devices/Additional/ControlActionEnum.cs)
## Variables
### ApiKey
- For OpenShock (HTTP) get token [here](https://shocklink.net/#/dashboard/tokens)
### Intensity Range
in percent
`0-100`
### Duration Range
in ms
- `0-30000` OpenShock
- `0-15000` PiShock
## Future
### ~~Username (PiShockHttp only)~~
~~For PiShock (HTTP) get information [here](https://apidocs.pishock.com/#header-authenticating)~~
### ~~Sharecode (PiShockHttp only)~~
~~For PiShock (HTTP) get information [here](https://apidocs.pishock.com/#header-authenticating)~~