Passer directement au contenu principal

HTTP

Par défaut, le service HTTP est http://localhost:10001 pour le lancer.

Le numéro de port peut être modifiédans les paramètresdu service.

Résumé​

Cette section décrit les routes HTTP publiées par le service.

Toutes les routes suivantes utilisent l'URL de base par défaut http://localhost:10001 part du principe que…

Enveloppe de réponse standard​

Tous les points de terminaison renvoient l'un des deux types d'enveloppes suivants :

Réponse sans données(utilisée uniquement avec les points de terminaison de mise à jour) :

{ "ok": true }
{ "ok": false, "error": "reason string" }

Réponse avec données(utilisée non seulement pour les requêtes GET, mais aussi pour les requêtes POST/DELETE vers des points de terminaison de configuration renvoyant les valeurs appliquées) :

{ "ok": true, "data": { "..." : "..." } }
{ "ok": false, "error": "reason string" }

Syntaxe du sélecteur de périphérique​

La racine au niveau du périphérique est /{device_type}/{id_or_index}/... On utilise le modèle de.{device_type} et {id_or_index} Dans le segment de chemin, spécifiez le périphérique concerné.

Le segment de chemin en questionSignification
inverse3/0Le premier élément spécifié par l'index (à partir de 0) Inverse3
inverse3/A14ID de l'appareil A14 の Inverse3
inverse3/*Tous les appareils Inverse3 (caractère générique)
verse_grip/0Le premier Verse Grip spécifié dans l'index
wireless_verse_grip/*Tous les Wireless Verse Grip
*inverse/*Tous les appareils de la gamme Inverse (Inverse3, Inverse3x,Minverse)
*verse_grip/*Tous les appareils de la gamme Verse Grip (Verse Grip, Wireless VG)

Règles relatives aux caractères génériques :

  • GET refuse les sélecteurs ambigus ou contenant des caractères génériques (400 (renvoie).
  • POST et DELETE Accepte les caractères génériques. L'opération s'applique à tous les appareils correspondants.

Sélecteur de session​

Pour les points de terminaison de la portée de session (basis, mount, preset, transform, filters), afin d'identifier la session, ?session=<expr> Des paramètres de requête sont nécessaires.

FormuleSignification
(omission)Toutes les sessions (DELETE uniquement)
#123 ou bien 123Session n° 123
:-1Dernière session par index
:0Première session via l'index

Exemple : GET /inverse3/0/config/basis?session=:0


Version​

Méthode : GET
URL : http://localhost:10001/version

Exemple de réponse :

{
"build_time": "2024-08-07T16:01:53Z",
"git_branch": "main",
"git_describe": "3.5.0-2-gce34c39e",
"git_hash": "ce34c39e",
"git_tag": "3.5.0",
"project_name": "haply-inverse-service",
"project_version": "3.5.0"
}

Statut « Expert »​

Méthode : GET
URL : http://localhost:10001/expert/status

Renvoie des informations d'état détaillées, notamment sur la détection, les périphériques, les sessions et les paramètres globaux.


Appareil​

Méthode : GET
URL : http://localhost:10001/devices

config,state,status Renvoie la liste des appareils actuellement connectés, y compris celui-ci.

si nécessaire ?session=<expr> En spécifiant cette option, vous pouvez limiter l'instantané au point de vue d'une session spécifique (les valeurs de `basis`, `mount` et `transform` de cette session seront alors appliquées aux valeurs renvoyées).

Exemple de réponse :

{
"inverse3": [
{
"device_id": "04BA",
"config": { "...": "..." },
"state": { "...": "..." },
"status": { "...": "..." }
}
]
}

Session​

MéthodePasseExplication
OBTENIR/sessionsAfficher la liste de toutes les sessions v3.1 actives
OBTENIR/sessions/{session_id}Récupérer une session unique
OBTENIR/sessions/{session_id}/profileRécupérer le nom du profil de session
PUBLICATION/sessions/{session_id}/profileConfigurer le profil de session
SUPPRIMER/sessions/{session_id}/profileProfil "default" Réinitialiser

PUBLICATION /sessions/{session_id}/profile Corps :

{
"name": "my_profile"
}

Port​

Méthode : POST
URL : http://localhost:10001/ports/{port}/reset

Efface les ports série bloqués.{ "ok": true } renvoie.


Paramètres de l'appareil​

Tous les points de terminaison de configuration sont /{device_type}/{id_or_index}/config/{setting} On utilise le modèle de.

Au niveau des points de terminaison de la portée de session (basis, mount, preset), il est également possible de ?session=<expr> Des paramètres de requête sont nécessaires.

Main dominante (Inverse3 ) uniquement​

MéthodePasseCarrosserieRéponse
OBTENIR/{device_type}/{id}/config/handedness--"left" ou bien "right"
PUBLICATION/{device_type}/{id}/config/handedness"left" ou bien "right"Valeur renvoyée par l'écho
SUPPRIMER/{device_type}/{id}/config/handedness--"right"(par défaut)

Échelle Torx (Inverse3 uniquement)​

MéthodePasseCarrosserieRéponse
OBTENIR/{device_type}/{id}/config/torque_scaling--{ "enabled": bool }
PUBLICATION/{device_type}/{id}/config/torque_scaling{ "enabled": bool }Valeur renvoyée par l'écho
SUPPRIMER/{device_type}/{id}/config/torque_scaling--{ "enabled": false }

Compensation de la gravité (Inverse3 uniquement)​

MéthodePasseCarrosserieRéponse
OBTENIR/{device_type}/{id}/config/gravity_compensation--{ "enabled": bool, "scaling_factor": float }
PUBLICATION/{device_type}/{id}/config/gravity_compensation{ "enabled": bool, "scaling_factor": float }Valeur renvoyée par l'écho
SUPPRIMER/{device_type}/{id}/config/gravity_compensation--{ "enabled": true, "scaling_factor": 1.0 }

Base (tous les appareils, portée de session)​

MéthodePasseCarrosserieRéponse
OBTENIR/{device_type}/{id}/config/basis?session=--{ "permutation": "XYZ" }
PUBLICATION/{device_type}/{id}/config/basis?session={ "permutation": "ZXY" }Valeur renvoyée par l'écho
SUPPRIMER/{device_type}/{id}/config/basis?session=--{ "permutation": "XYZ" }

Mount (tous les périphériques, portée de session)​

MéthodePasseCarrosserieRéponse
OBTENIR/{device_type}/{id}/config/mount?session=--{ "transform": {...} }
PUBLICATION/{device_type}/{id}/config/mount?session={ "transform": {...} }Valeur renvoyée par l'écho
SUPPRIMER/{device_type}/{id}/config/mount?session=--Transformation identitaire (identity transform)

Structure de `Transform` (utilisée dans `mount` et `state/transform`) :

{
"transform": {
"position": { "x": 0, "y": 0, "z": 0 },
"rotation": { "x": 0, "y": 0, "z": 0, "w": 1 },
"scale": { "x": 1, "y": 1, "z": 1 }
}
}

Préréglages (pour tous les appareils, par session)​

MéthodePasseCarrosserieRéponse
OBTENIR/{device_type}/{id}/config/preset?session=--{ "preset": "arm_front_centered" }
PUBLICATION/{device_type}/{id}/config/preset?session={ "preset": "arm_front_centered" }Valeur renvoyée par l'écho
SUPPRIMER/{device_type}/{id}/config/preset?session=--{ "preset": "device_defaults" }

Valeurs disponibles : device_defaults, arm_front, arm_front_centered, led_front, led_front_centered, custom。


Filtre par appareil (Inverse3 uniquement, par session)​

Les points d'extrémité du filtre sont /{device_type}/{id}/config/filters/{filter}?session=<expr> On utilise.

dumping​

Il permet de contrôler à la fois l'amortissement uniforme et l'amortissement directionnel. Le corps du POST doit contenir au moins un champ.

MéthodePasseCarrosserieRéponse
OBTENIR/{device_type}/{id}/config/filters/damping?session=--{ "scalar": float, "vector": { "x": f, "y": f, "z": f } }
PUBLICATION/{device_type}/{id}/config/filters/damping?session={ "scalar": float } ou bien { "vector": {...} } ou les deuxValeur renvoyée par l'écho
SUPPRIMER/{device_type}/{id}/config/filters/damping?session=--Les deux sont remis à zéro

Force Gate​

MéthodePasseCarrosserieRéponse
OBTENIR/{device_type}/{id}/config/filters/force_gate?session=--{ "gain": float }
PUBLICATION/{device_type}/{id}/config/filters/force_gate?session={ "gain": float }Valeur renvoyée par l'écho
SUPPRIMER/{device_type}/{id}/config/filters/force_gate?session=--Valeur par défaut du gain dans les paramètres

État de l'appareil​

Transform (tous les appareils, par session)​

Conversion de l'espace de travail (conversion de l'espace de l'appareil vers l'espace de l'application).

MéthodePasseCarrosserieRéponse
OBTENIR/{device_type}/{id}/state/transform?session=--{ "transform": {...} }
PUBLICATION/{device_type}/{id}/state/transform?session={ "transform": {...} }Valeur renvoyée par l'écho
SUPPRIMER/{device_type}/{id}/state/transform?session=--Transformation identique

Enregistrer les paramètres​

Inverse3 Fonctionne uniquement sur cet appareil. Avertissement : évitez d'enregistrer trop souvent les paramètres. Le nombre d'enregistrements possibles sur n'importe quel appareil est limité (environ 10 000 écritures dans l'EEPROM).

Méthode : POST
URL : http://localhost:10001/save_configuration

Exemple de corps :

{
"device_id": "049D"
}

Exemple de réponse :

{
"ok": true
}

Paramètres​

Les points de terminaison de configuration sont générés automatiquement pour les éléments suivants :

  • Récupérer la liste de tous les paramètres (métadonnées comprises)
  • Lecture d'une valeur de paramètre unique
  • Application des paramètres (individuelle ou groupée)
  • Réinitialisation d'une clé à sa valeur par défaut

Vous trouverezicila liste des touches de configuration.

Route​

MéthodeRouteExplication
OBTENIR/settings/Récupère toutesles clés de configuration, toutesles valeurs et toutes les métadonnées.
PUBLICATION/settings/Applique plusieursparamètres en une seule fois.
OBTENIR/settings/{key}Récupèrela valeur actuelled'une clé de configuration spécifique.
PUBLICATION/settings/{key}Appliqueune nouvelle valeurà une clé spécifique.
SUPPRIMER/settings/{key}Réinitialise la clé àsa valeur par défaut.

Format de la réponse​

OBTENIR /settings/(Tous les paramètres)​

Renvoie un objet dont les clés sont des clés de configuration. Chaque entrée contient les éléments suivants :

  • value: Valeur actuelle
  • metadata: type + contrainte + état de verrouillage

Exemple d'entrée :

{
"devices/detection/timeout": {
"metadata": {
"constraint": {
"range": {
"max": 15,
"min": 1,
"step": 0
}
},
"locked": false,
"type_hint": "INT"
},
"value": 5
}
}

OBTENIR /settings/{key}(Paramètre unique)​

Renvoieuniquementlavaleurde la clé spécifiée (sans métadonnées).

Appliquer les paramètres​

PUBLICATION /settings/(Application globale)​

Applique plusieurs clés à la fois.

Format de corps recommandé : objet JSON représentant une correspondance entre des clés et des valeurs.

{
"devices/detection/timeout": 5,
"devices/detection/advanced/wvg_description_filter": ["Haply USB Transceiver", "Haply Handle"]
}

PUBLICATION /settings/{key}(Application unique)​

Applique une nouvelle valeur à une clé unique.

Format de corps recommandé : valeur JSON brute ou valeur encapsulée (pour plus de clarté, le format encapsulé est recommandé).

{
"value": 5
}

Réinitialisation des paramètres​

SUPPRIMER /settings/{key}​

Rétablit la valeur par défaut de la clé.

Cela revient à « réinitialiser aux valeurs par défaut ».

Conseils sur les types​

Les services sont type_hint est estimé automatiquement. Pour les types complexes, on utilise comme solution de secours GENERIC est utilisé.

Conseils pris en charge :

  • BOOL
  • INT
  • FLOAT
  • STRING
  • VEC2
  • VEC3
  • VEC4
  • TRANSFORM
  • ARR_INT
  • ARR_FLOAT
  • ARR_STRING
  • GENERIC

Points de terminaison hérités déconseillés​

quelques POST Les points de terminaison continueront d'être acceptés, mais un avertissement indiquant qu'ils sont obsolètes s'affichera. Il s'agit 4.0 devrait être supprimé. Pour consulter le tableau de correspondance complet entre les chemins obsolètes et les chemins de remplacement,3.5 Guide de migrationVeuillez consulter.