vibe-check/README.md

23 lines
803 B
Markdown

# Bluetooth mod for the Doxy Massager
Connections: TBD
We're pretending to be a Sakuraneko Dokidoki:
* BTLE GATT Service `0000ffe0-0000-1000-8000-00805f9b34fb`
* BTLE GATT Characteristic `0000ffe1-0000-1000-8000-00805f9b34fb`
* [buttplug.io's implementation](https://github.com/buttplugio/buttplug/blob/master/buttplug/src/server/device/protocol/sakuraneko.rs)
The implementation is simply complete enough to satisfy buttplug.io; it almost certainly
doesn't work with Sakuraneko's app. We just picked this one to emulate because the protocol
was trivial.
## Build
```
$ env -C lib/pico-sdk/ git submodule update --init
$ env -C build/ cmake .. -G Ninja -DPICO_BOARD=pico_w
$ env -C build/ ninja
$ picotool load -f build/vibe-check.uf2
# (or your preferred way of loading things onto a Pico)
```