Aller directement au corps du texte

HTTP

Par défaut, le service HTTP est http://localhost:10001Cela commence par…

Vous pouvez modifier le port dans les paramètresdu service.

Présentation générale​

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

Toutes les routes ci-dessous utilisent l'URL de base par défaut, à savoir http://localhost:10001se base sur.

Enveloppe de réponse standard​

Chaque point de terminaison renvoie l'une des deux enveloppes suivantes :

Réponse sans données (utilisée avec les points de terminaison en mode « modification uniquement ») :

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

Réponse de données (utilisée dans les requêtes GET et les requêtes POST/DELETE vers un point de terminaison de configuration renvoyant les valeurs appliquées telles quelles) :

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

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

Les chemins au niveau du périphérique sont les suivants : /{device_type}/{id_or_index}/... On utilise des motifs. {device_type}et {id_or_index} Les segments de chemin identifient les appareils cibles.

Exemple de segment de parcoursSignification
inverse3/0Le premier élément désigné par l'index (qui commence à 0) Inverse3
inverse3/A14L'identifiant de l'appareil est A14in Inverse3
inverse3/*Tous les appareils Inverse3 (caractère générique)
verse_grip/0Premier Verse Grip désigné comme index
wireless_verse_grip/*Toutes les poignées Wireless Verse Grip
*inverse/*L'ensemble de la gamme Inverse (Inverse3, Inverse3x, Minverse)
*verse_grip/*L'ensemble des appareils de la gamme Verse Grip (Verse Grip, Wireless VG)

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

  • GETRejette les sélecteurs ambigus ou contenant des caractères génériques (400 (retour).
  • POSTWa DELETEautorise les caractères génériques -- l'opération s'applique à tous les appareils correspondants.

Sélecteur de session​

Les points de terminaison de la session (basis, mount, preset, transform, filters) servent à identifier la session ?session=<expr> Un paramètre de requête est requis.

expressionSignification
(omission)Toutes les sessions (réservées aux commandes DELETE)
#123 ou bien 123Session portant le numéro d'identification 123
:-1Dernière séance selon l'indice
:0Première session selon 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 d'expert​

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

Renvoie des informations détaillées sur l'état, notamment les paramètres de détection, de périphérique, de session et les paramètres globaux.


Appareil​

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

config, state, statusRenvoie la liste des appareils actuellement connectés, y compris [...].

de manière facultative ?session=<expr>Vous pouvez filtrer l'instantané en le plaçant dans la perspective d'une session spécifique (en appliquant les paramètres « basis », « mount » et « transform » de cette session aux valeurs renvoyées).

Exemple de réponse :

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

session​

méthodeChemin d'accèsDescription
OBTENIR/sessionsConsulter la liste complète des sessions actives v3.1
OBTENIR/sessions/{session_id}Consultation d'une seule session
OBTENIR/sessions/{session_id}/profileRecherche du nom du profil de session
PUBLICATION/sessions/{session_id}/profileConfiguration du profil de session
SUPPRIMER/sessions/{session_id}/profileProfil "default"Réinitialiser à

PUBLICATION /sessions/{session_id}/profile Corps du texte :

{
"name": "my_profile"
}

Port​

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

Débloque le port série bloqué. { "ok": true }renvoie.


Configuration de l'appareil​

Tous les points de terminaison de configuration (config) sont /{device_type}/{id_or_index}/config/{setting} On utilise des motifs.

Les points de terminaison de la session (basis, mount, preset) peuvent également ?session=<expr> Un paramètre de requête est requis.

Inverse3 ( uniquement)​

méthodeChemin d'accèsCorps du texteRéponse
OBTENIR/{device_type}/{id}/config/handedness--"left" ou bien "right"
PUBLICATION/{device_type}/{id}/config/handedness"left" ou bien "right"Renvoie la valeur saisie telle quelle
SUPPRIMER/{device_type}/{id}/config/handedness--"right" (valeur par défaut)

Mise à l'échelle du couple (réservé àInverse3 )​

méthodeChemin d'accèsCorps du texteRéponse
OBTENIR/{device_type}/{id}/config/torque_scaling--{ "enabled": bool }
PUBLICATION/{device_type}/{id}/config/torque_scaling{ "enabled": bool }Renvoie la valeur saisie telle quelle
SUPPRIMER/{device_type}/{id}/config/torque_scaling--{ "enabled": false }

Compensation de la gravité (réservé à «Inverse3 »)​

méthodeChemin d'accèsCorps du texteRé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 }Renvoie la valeur saisie telle quelle
SUPPRIMER/{device_type}/{id}/config/gravity_compensation--{ "enabled": true, "scaling_factor": 1.0 }

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

méthodeChemin d'accèsCorps du texteRéponse
OBTENIR/{device_type}/{id}/config/basis?session=--{ "permutation": "XYZ" }
PUBLICATION/{device_type}/{id}/config/basis?session={ "permutation": "ZXY" }Renvoie la valeur saisie telle quelle
SUPPRIMER/{device_type}/{id}/config/basis?session=--{ "permutation": "XYZ" }

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

méthodeChemin d'accèsCorps du texteRéponse
OBTENIR/{device_type}/{id}/config/mount?session=--{ "transform": {...} }
PUBLICATION/{device_type}/{id}/config/mount?session={ "transform": {...} }Renvoie la valeur saisie telle quelle
SUPPRIMER/{device_type}/{id}/config/mount?session=--Transformation identitaire (identity transform)

Structure « 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 (tous les appareils, portée de la session)​

méthodeChemin d'accèsCorps du texteRé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
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 de périphérique (réservé à «Inverse3 », portée de la session)​

Les points de terminaison de filtrage sont /{device_type}/{id}/config/filters/{filter}?session=<expr> Utilise le chemin d'accès.

amortissement​

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

méthodeChemin d'accèsCorps du texteRé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
SUPPRIMER/{device_type}/{id}/config/filters/damping?session=--Réinitialiser les deux à 0

Porte de force​

méthodeChemin d'accèsCorps du texteRé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
SUPPRIMER/{device_type}/{id}/config/filters/force_gate?session=--Valeur par défaut du gain dans les paramètres

État de l'appareil​

Conversion (tous les appareils, au niveau de la session)​

Conversion de l'espace de travail (de l'espace « appareil » à l'espace « application »).

méthodeChemin d'accèsCorps du texteRéponse
OBTENIR/{device_type}/{id}/state/transform?session=--{ "transform": {...} }
PUBLICATION/{device_type}/{id}/state/transform?session={ "transform": {...} }Valeur renvoyée
SUPPRIMER/{device_type}/{id}/state/transform?session=--Transformation identitaire

Enregistrer la configuration​

Inverse3 Fonctionne uniquement sur l'appareil. Avertissement : évitez d'enregistrer la configuration trop souvent, car le nombre d'enregistrements possibles sur un même appareil est limité (environ 10 000 écritures EEPROM).

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

Exemple de texte :

{
"device_id": "049D"
}

Exemple de réponse :

{
"ok": true
}

Paramètres​

Des points de terminaison de configuration sont créés automatiquement pour les éléments suivants :

  • Liste de tous les paramètres, métadonnées comprises
  • Lecture d'une valeur de paramètre unique
  • Appliquer les paramètres (individuellement ou en bloc)
  • Réinitialiser les touches à leurs valeurs par défaut

Vous trouverez icila liste complète des touches de configuration.

Route​

méthodeRouteDescription
OBTENIR/settings/Récupère toutes les clés, valeurs et métadonnées de configuration.
PUBLICATION/settings/Applique simultanément plusieurs paramètres.
OBTENIR/settings/{key}Récupère la valeur actuelled'une clé de configuration spécifique.
PUBLICATION/settings/{key}Applique une nouvelle valeurà une clé spécifique.
SUPPRIMER/settings/{key}Réinitialise la clé à sa valeur par défaut.

Format de réponse​

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

Renvoie un objet dont les clés sont des paramètres de configuration. Chaque élément contient les éléments suivants :

  • value: valeur actuelle
  • metadata: type + contraintes + état de verrouillage

Exemples d'éléments :

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

OBTENIR /settings/{key} (Configuration unique)​

Elle renvoie uniquement la valeur associée à la clé demandée (à l'exclusion des métadonnées).

Appliquer les paramètres​

PUBLICATION /settings/ (Application globale)​

Permet d'appliquer plusieurs touches en même temps.

Format recommandé pour le corps du message : objet JSON associant des clés à 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 recommandé pour le corps du message : une valeur JSON brute ou une valeur encapsulée (les valeurs encapsulées sont recommandées pour plus de clarté).

{
"value": 5
}

Réinitialiser les paramètres​

SUPPRIMER /settings/{key}​

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

Cela revient à « réinitialiser les paramètres par défaut ».

Indices de type​

Le service type_hintest déduit automatiquement. Pour les types complexes, la valeur par défaut est GENERICC'est ce qui 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 obsolètes​

Plusieurs POST Les points de terminaison sont toujours autorisés, mais un avertissement indiquant qu'ils sont en voie d'abandon est affiché, et 4.0est prévu de le supprimer. Pour plus de détails sur le parcours concerné par la suppression → le tableau des itinéraires de remplacement est disponible à l'adresse suivante : 3.5 Guide de migrationVeuillez vous reporter à.