Shockers

Allows the operation of a PiShock Shocker from an API Key.

The ShockerId is specified as a path parameter, whereas the rest is in the body.
The parameter "AgentName" will be removed in a future version however is still present for now -- Expect this to be replaced by the name of the actioning API Key in future.

post/Shockers/{ShockerId}

Path parameters

ShockerIdstring required

Request body

AgentNamestring

[Deprecated]: Name of the actor on the device, this will reflect in the logs and be replaced with the name of the API Key at a later stage.

Operation0 | 1 | 2

Durationinteger

Maximum duration of the operation in miliseconds, will clamp to the share's maximum duration if lower.

Intensityinteger

Maximum intensity of the operation, will clamp to the share's maximum intensity if lower.

MinimumDurationinteger nullable

[Optional] To randomise duration, specify a minimum duration.

MinimumIntensityinteger nullable

[Optional] To randomise intensity, specify a minimum intensity.

IntensityAsPercentageboolean

Previously called "Scale", treats the incoming intensity as a % of the share's maximum.

Response

Command has been sent to the device.

Changes

No recorded changes to this endpoint across all 1 revision of this API.