04. Bonjour Floor

Votre premier effet haptique : un sol virtuel horizontal qui offre une résistance lorsque le curseur s'y appuie. La force est simulée par un simple ressort de contrainte — stiffness × penetration_depth — appliqué le long de Z via set_cursor_force.

Ce que vous apprendrez :

• Utilisation de set_cursor_force pour appliquer une force de rappel
• Lecture cursor_position et la puissance de calcul en temps réel
• (Python) Définition d'un réglage prédéfini de l'espace de travail (arm_front_centered) de sorte que l'origine se trouve au centre de l'espace de travail
• (Python) Réglage interactif par le clavier de la hauteur et de la rigidité du plancher via le keyboard colis

Flux de travail

1. Ouvrir un WebSocket vers ws://localhost:10001 et attendre la première trame d'état.
2. À la première image : enregistrer le profil de session. La variante Python envoie en outre configure.preset: arm_front_centered ainsi, le point d'origine se trouve au centre de l'espace de travail ; les variantes C++ utilisent la configuration déjà active sur l'appareil.
3. À chaque image : lire cursor_position.z, calculer force_z = max(0, (floor_pos - z) * stiffness), puis le renvoyer sous forme de set_cursor_force commande.
4. Les requêtes suivantes n'envoient que la commande « force » : le profil de session ne nécessite qu'un seul échange initial.
5. (Python) À chaque itération, le programme interroge également les touches fléchées du clavier et met à jour floor_pos / stiffness en direct.

Paramètres

Nom	Par défaut	Objectif
floor_pos	0.10 m	Coordonnée Z du plan du sol virtuel
stiffness	1000 N/m	Constante de ressort (pénétration de 1 mm → 1 N)
PRINT_EVERY_MS	100–200	Manette de télémétrie
Nom du profil de session	co.haply.inverse.tutorials:hello-floor	Identifie cette simulation dans Haply

Interactif (Python uniquement)

La variante Python utilise le keyboard paquet (privilèges élevés requis sous Linux) :

• ↑ / ↓ — relever / abaisser le plancher
• ← / → — réduire / augmenter la rigidité
• R — rétablir les paramètres par défaut

Renforcer les effectifs

Les forces sont cumulées au niveau du tick du service : elles sont additionnées entre toutes les sources avant d'être envoyées à l'appareil. Un tutoriel comme celui-ci peut coexister avec d'autres générateurs de forces sans que l'un ou l'autre ne bloque l'autre.

Champs d'état lus

De data.inverse3[i].state:

• cursor_position.z — vec3, utilisé pour calculer la profondeur de pénétration
• current_cursor_force — transmis par télémétrie

Envoyer / recevoir

À chaque itération : lire la coordonnée Z du curseur, calculer force_z = max(0, (floor_pos - z) * stiffness), et envoyer un set_cursor_force. Le premier message sortant contient également le profil de session (toutes variantes) et, pour Python, configure.preset: arm_front_centered.

Python

Boucle asynchrone unique. La négociation lors de la première trame inclut le profil + configure.preset donc floor_pos = 0.1 s'aligne sur les coordonnées du centre de l'espace de travail.

async with websockets.connect(URI) as websocket:
    while True:
        msg  = await websocket.recv()
        data = json.loads(msg)

        if first_message:
            first_message = False
            device_id = data["inverse3"][0]["device_id"]
            # Handshake: profile + preset (one-shot)
            request_msg = {
                "session": {"configure": {"profile": {"name": "co.haply.inverse.tutorials:hello-floor"}}},
                "inverse3": [{
                    "device_id": device_id,
                    "configure": {"preset": {"preset": "arm_front_centered"}}
                }]
            }
        else:
            # Per tick: compute force along Z, send set_cursor_force
            z = data["inverse3"][0]["state"]["cursor_position"]["z"]
            force_z = 0.0 if z > floor_pos else (floor_pos - z) * stiffness
            request_msg = {
                "inverse3": [{
                    "device_id": device_id,
                    "commands": {"set_cursor_force":
                        {"vector": {"x": 0.0, "y": 0.0, "z": force_z}}}
                }]
            }

        await websocket.send(json.dumps(request_msg))

C++ (nlohmann)

Modèle de rappel libhv — la fonction `onmessage` s'exécute sur le thread d'E/S WebSocket ; le thread principal se bloque lors de l'entrée (ENTER). Les variantes C++ utilisent la procédure de négociation minimale (profil de session uniquement, sans préréglage).

ws.onmessage = [&](const std::string &msg) {
    const json data = json::parse(msg);

    // If no Inverse3 yet, ask the service to re-send the full state
    if (!data.contains("inverse3") || data["inverse3"].empty()) {
        ws.send(R"({"session":{"force_render_full_state":{}}})");
        return;
    }

    json request = {};
    if (first_message) {
        first_message = false;
        request["session"] = {{"configure", {{"profile",
            {{"name", "co.haply.inverse.tutorials:hello-floor"}}}}}};
    }

    request["inverse3"] = json::array();
    for (auto &el : data["inverse3"].items()) {
        const float z = el.value()["state"]["cursor_position"]["z"].get<float>();
        const float force_z = z > floor_pos ? 0.0f : (floor_pos - z) * stiffness;
        request["inverse3"].push_back({
            {"device_id", el.value()["device_id"]},
            {"commands", {{"set_cursor_force",
                {{"vector", {{"x", 0.0}, {"y", 0.0}, {"z", force_z}}}}}}},
        });
    }
    ws.send(request.dump());
};
ws.open("ws://localhost:10001");
while (std::cin.get() != '\n') {}  // block main thread

C++ (Glaze)

Même modèle de rappel que libhv — seul le corps change. Structures typées pour l'état et les commandes. std::optional<session_cmd> conserve le profil « one-shot » — Glaze l'omet du JSON sérialisé lorsqu'il n'est pas défini.

// Struct models
struct vec3 { float x{}, y{}, z{}; };
struct inverse_state { vec3 cursor_position{}, current_cursor_force{}; };
struct inverse_device { std::string device_id; inverse_state state; };
struct devices_message { std::vector<inverse_device> inverse3; };

struct set_cursor_force_cmd { vec3 vector; };
struct commands_message {
    std::optional<session_cmd> session;
    std::vector<device_commands> inverse3;
};

// Send / receive
ws.onmessage = [&](const std::string &msg) {
    devices_message data{};
    if (glz::read<glz_settings>(data, msg)) return;
    if (data.inverse3.empty()) {
        ws.send(R"({"session":{"force_render_full_state":{}}})");
        return;
    }

    commands_message out_cmds{};
    if (first_message) {
        first_message = false;
        out_cmds.session = session_cmd{ /* profile = hello-floor */ };
    }
    for (const auto &dev : data.inverse3) {
        const float z = dev.state.cursor_position.z;
        const float force_z = z > floor_pos ? 0.0f : (floor_pos - z) * stiffness;
        device_commands dc{ .device_id = dev.device_id };
        dc.commands.set_cursor_force = set_cursor_force_cmd{{0.0f, 0.0f, force_z}};
        out_cmds.inverse3.push_back(std::move(dc));
    }

    std::string out_json;
    (void)glz::write_json(out_cmds, out_json);
    ws.send(out_json);
};
ws.open("ws://localhost:10001");
while (std::cin.get() != '\n') {}  // block main thread

Source : Python · C++ · C++ Glaze

À lire également : Commandes de contrôle (set_cursor_force) · Montage et espace de travail (préréglages) · Types (vec3) · Séances · Tutoriel 07 (Base et support)