name: pavlok description: Send a Pavlok stimulus via the Pavlok API using scripts/pavlok.py. Use when you need to trigger vibe/beep/zap with a numeric value in this repo and print the API response.
Pavlok Stimulus
Use scripts/pavlok.py to send a stimulus to the Pavlok API.
Run
uv run scripts/pavlok.py zap 30 "reason for trigger"
Inputs
stimulusTypeis a string such asvibe,beep, orzap.stimulusValueis an integer.reasonis required by the CLI parser but is not currently sent to the API.
Notes
- Requires
PAVLOK_API_KEYin.envor the environment. - For
zap,LIMIT_DAY_PAVLOK_COUNTSandLIMIT_PAVLOK_ZAP_VALUEare required. If the daily zap limit is exceeded, the script returns a JSON object withskipped: trueandreason: "limit_reached". If the value is above the limit, it is clamped toLIMIT_PAVLOK_ZAP_VALUE.