Skip to content
Handyverse documentation

Show interactive endpoint panels inside human guides. This preference is saved for future visits.

Choose an API
Shared guides · Developer resourcesView Markdown

Device and protocol compatibility

Use this reference with the Handy REST API v3 protocol guide. It covers online REST control.

Firmware requirements

Operation Firmware requirement
Device control through Handy REST v3 Firmware v4 or later, with support for the selected operation.
GET /connected and GET /info Available on older firmware too, for connection and compatibility checks.
Device SSE through GET /sse Firmware v3 or later; v3 devices provide connection/status events.
Anonymous GET /servertime No device or device firmware required.

Read the installed firmware and update status with GET /info. Apply the firmware-status policy, including the required-update block.

Protocol matrix

All device models support STREAM and HRPP, including every model in the hardware registry below. The firmware requirements above apply.

HRPP has two file types: audio and script. Oh supports both; Handy devices support script only. The HRPP column lists supported file types.

For HAMP, HDSP, HSP and HSSP, the table describes movement output for the listed Handy and Oh families. Slider means slider movement. Vibration means Oh translates movement commands into vibration on the device, including for STREAM.

Device family HAMP HDSP HSP HSSP STREAM HVP HRPP file types
Handy 1 (H01) Slider Slider Slider Slider Supported Not supported Script only
Handy 2 regular (H02) Slider Slider Slider Slider Supported Not supported Script only
Handy 2 Eco (H02_eco) Slider Slider Slider Slider Supported Not supported Script only
Handy 2 Pro (H02_pro) Slider Slider Slider Slider Supported Supported Script only
H02_1 regular Slider Slider Slider Slider Supported Not supported Script only
H02_1 Pro (H02_1_pro) Slider Slider Slider Slider Supported Supported Script only
H02_1 family, Eco variant Slider Slider Slider Slider Supported Not supported Script only
Oh (V01) Vibration Vibration Vibration Vibration Vibration Supported Audio and script

HAMP provides repeated movement, HDSP individual targets, HSP client-generated point streams, HSSP URL-based scripts, STREAM server-managed data delivery, HVP direct vibration parameters and HRPP on-device repeating patterns. The protocol chooser explains when to use each one.

The Handy rows describe slider movement. Oh's translated output is vibration rather than physical slider travel. Among these Handy slider models, HVP is supported only on Pro variants: H02_pro and H02_1_pro. H01 and the regular/Eco variants of H02 and H02_1 do not support it. Supported Pro HVP requests require amplitude, frequency and position; Oh requires amplitude and frequency.

Identify the hardware

GET /info can report hw_model_no, hw_model_name and hw_model_variant. Use those values with the exact fw_version to identify a device. The hardware ID/name list is:

hw_model_no hw_model_name
0 H01
1 V01
2 H01_2
3 H02
4 H02_pro
5 H02_eco
6 V02
7 S01
8 S02
9 H02_sm
10 H02_1
11 H02_1_pro

STREAM and HRPP support apply to every model listed here; HRPP file types depend on the device family as described above.

Use capabilities for physical features

GET /capabilities reports hardware such as physical sliders, motors and battery. It is not a protocol-support list. In particular, slider: 0 does not exclude Oh from translated slider protocols. Use hardware capabilities to adapt physical controls and the matrix/operation documentation for protocol applicability.

Physical-slider configuration (GET /settings/slider) requires a physical slider. Do not make that request a prerequisite for Oh movement; Oh's virtual stroke limits and translated protocols remain separate.

Protocol state queries can select a device mode. Read /mode before the matching state, and complete matching HSP/HSSP/STREAM setup before their other commands. Do not poll all state endpoints as a compatibility probe. See active-state inspection.