HTTP
Par défaut, le service HTTP démarre à l'adresse suivante :http://localhost:10001。
Le port peut être modifiédans la configurationdu service.
Présentation générale
Cette section répertorie les routes HTTP exposées par ce service.
Toutes les routes suivantes utilisent l'URL de base par défaut http://localhost:10001 en partant de ce principe.
Structure standard de réponse
Tous les points de terminaison renvoient l'une des deux structures suivantes :
Pas de réponse de données(pour les points de terminaison destinés uniquement à la modification des données) :
{ "ok": true }
{ "ok": false, "error": "reason string" }
Réponse de données(pour les requêtes GET, ainsi que pour les requêtes POST/DELETE sur les points de terminaison de configuration renvoyant les valeurs déjà appliquées) :
{ "ok": true, "data": { "..." : "..." } }
{ "ok": false, "error": "reason string" }
Syntaxe du sélecteur de périphériques
Utilisation du routage au niveau des équipements /{device_type}/{id_or_index}/... Format. Segment de chemin {device_type} et {id_or_index} Permet d'identifier l'appareil cible.
| Exemple de segment de chemin | Signification |
|---|---|
inverse3/0 | Le premier élément sélectionné selon l'index (en commençant par 0) Inverse3 |
inverse3/A14 | L'identifiant de l'appareil est A14 le Inverse3 |
inverse3/* | Tous les appareils Inverse3 (caractère générique) |
verse_grip/0 | Premier « Verse Grip » sélectionné dans l'index |
wireless_verse_grip/* | Tous les modè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 :
GETRejette les sélecteurs ambigus ou contenant des caractères génériques (renvoie400).POSTetDELETELes caractères génériques sont pris en charge ; l'opération s'appliquera à tous les appareils correspondants.
Sélecteur de session
Les points de terminaison au niveau de la session (basis, mount, preset, transform, filters) nécessitent l'utilisation de ?session=<expr> Utiliser des paramètres de requête pour identifier la session.
| expression | Signification |
|---|---|
| (omission) | Toutes les sessions (DELETE uniquement) |
#123 ou 123 | Session dont l'identifiant numérique est 123 |
:-1 | La dernière session sélectionnée dans l'index |
:0 | La première session sélectionnée dans 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
Affiche des informations détaillées sur l'état, notamment les détections, les appareils, les sessions et les paramètres généraux.
Équipements
Méthode : GET
URL : http://localhost:10001/devices
Afficher la liste des appareils actuels, comprenant config,state et status。
peut être fourni (facultatif) ?session=<expr> Paramètre permettant de filtrer l'instantané selon la perspective d'une session donnée (les paramètres `basis`, `mount` et `transform` de cette session seront appliqués à la valeur renvoyée).
Exemple de réponse :
{
"inverse3": [
{
"device_id": "04BA",
"config": { "...": "..." },
"state": { "...": "..." },
"status": { "...": "..." }
}
]
}
Conversation
| Méthode | Chemin d'accès | Explication |
|---|---|---|
| OBTENIR | /sessions | Lister toutes les sessions v3.1 en cours |
| OBTENIR | /sessions/{session_id} | Récupérer une session individuelle |
| OBTENIR | /sessions/{session_id}/profile | Récupérer le nom du profil de session |
| PUBLICATION | /sessions/{session_id}/profile | Configurer un profil de session |
| SUPPRIMER | /sessions/{session_id}/profile | Réinitialiser le fichier de configuration à "default" |
PUBLICATION /sessions/{session_id}/profile Corps de la requête :
{
"name": "my_profile"
}
Port
Méthode : POST
URL : http://localhost:10001/ports/{port}/reset
Débloquer le port série. Retour { "ok": true }。
Configuration du matériel
Tous les points de configuration utilisent /{device_type}/{id_or_index}/config/{setting} Format.
Les points de terminaison au niveau de la session (basis, mount, preset) nécessitent également ?session=<expr> Paramètres de requête.
Réglage de la main dominante ( Inverse3uniquement)
| Méthode | Chemin d'accès | Corps de la requête | Réponse |
|---|---|---|---|
| OBTENIR | /{device_type}/{id}/config/handedness | -- | "left" ou "right" |
| PUBLICATION | /{device_type}/{id}/config/handedness | "left" ou "right" | valeur d'écho |
| SUPPRIMER | /{device_type}/{id}/config/handedness | -- | "right"(par défaut) |
Mise à l'échelle du couple ( Inverse3uniquement)
| Méthode | Chemin d'accès | Corps de la requête | Réponse |
|---|---|---|---|
| OBTENIR | /{device_type}/{id}/config/torque_scaling | -- | { "enabled": bool } |
| PUBLICATION | /{device_type}/{id}/config/torque_scaling | { "enabled": bool } | valeur d'écho |
| SUPPRIMER | /{device_type}/{id}/config/torque_scaling | -- | { "enabled": false } |
Compensation de la gravité ( Inverse3uniquement)
| Méthode | Chemin d'accès | Corps de la requête | Ré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 d'écho |
| SUPPRIMER | /{device_type}/{id}/config/gravity_compensation | -- | { "enabled": true, "scaling_factor": 1.0 } |
Base (tous les appareils, au niveau de la session)
| Méthode | Chemin d'accès | Corps de la requête | Réponse |
|---|---|---|---|
| OBTENIR | /{device_type}/{id}/config/basis?session= | -- | { "permutation": "XYZ" } |
| PUBLICATION | /{device_type}/{id}/config/basis?session= | { "permutation": "ZXY" } | valeur d'écho |
| SUPPRIMER | /{device_type}/{id}/config/basis?session= | -- | { "permutation": "XYZ" } |
Montage (tous les périphériques, au niveau de la session)
| Méthode | Chemin d'accès | Corps de la requête | Réponse |
|---|---|---|---|
| OBTENIR | /{device_type}/{id}/config/mount?session= | -- | { "transform": {...} } |
| PUBLICATION | /{device_type}/{id}/config/mount?session= | { "transform": {...} } | valeur d'écho |
| SUPPRIMER | /{device_type}/{id}/config/mount?session= | -- | Transformation identitaire |
Structure « Transform» (utilisée pour « 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 }
}
}
Paramètres par défaut (tous les appareils, au niveau de la session)
| Méthode | Chemin d'accès | Corps de la requête | Réponse |
|---|---|---|---|
| OBTENIR | /{device_type}/{id}/config/preset?session= | -- | { "preset": "arm_front_centered" } |
| PUBLICATION | /{device_type}/{id}/config/preset?session= | { "preset": "arm_front_centered" } | valeur d'écho |
| SUPPRIMER | /{device_type}/{id}/config/preset?session= | -- | { "preset": "device_defaults" } |
Valeurs possibles :device_defaults,arm_front,arm_front_centered,led_front,led_front_centered,custom。
Filtre de périphériques (applicable uniquement à Inverse3, au niveau de la session)
Utilisation des points d'extrémité du filtre /{device_type}/{id}/config/filters/{filter}?session=<expr>。
Amortissement
Contrôler simultanément l'amortissement uniforme et l'amortissement directionnel. Le corps de la requête POST doit contenir au moins un champ.
| Méthode | Chemin d'accès | Corps de la requête | Ré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 { "vector": {...} }, ou les deux à la fois | valeur d'écho |
| SUPPRIMER | /{device_type}/{id}/config/filters/damping?session= | -- | Les deux sont remis à zéro |
Commande par force
| Méthode | Chemin d'accès | Corps de la requête | Réponse |
|---|---|---|---|
| OBTENIR | /{device_type}/{id}/config/filters/force_gate?session= | -- | { "gain": float } |
| PUBLICATION | /{device_type}/{id}/config/filters/force_gate?session= | { "gain": float } | valeur d'écho |
| SUPPRIMER | /{device_type}/{id}/config/filters/force_gate?session= | -- | Gain par défaut dans les paramètres |
État de l'équipement
Conversion (tous les appareils, au niveau de la session)
Transformation de l'espace de travail (de l'espace matériel à l'espace applicatif).
| Méthode | Chemin d'accès | Corps de la requête | Réponse |
|---|---|---|---|
| OBTENIR | /{device_type}/{id}/state/transform?session= | -- | { "transform": {...} } |
| PUBLICATION | /{device_type}/{id}/state/transform?session= | { "transform": {...} } | valeur d'écho |
| SUPPRIMER | /{device_type}/{id}/state/transform?session= | -- | Transformation identitaire |
Enregistrer la configuration
Valable uniquement pour les appareils Inverse3 . Avertissement : évitez d'enregistrer la configuration trop fréquemment, 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 corps de requête :
{
"device_id": "049D"
}
Exemple de réponse :
{
"ok": true
}
Paramètres
La configuration des points d'extrémité offre automatiquement les fonctionnalités suivantes :
- Afficher tous les paramètres (y compris les métadonnées)
- Lire la valeur d'un paramètre donné
- Paramètres de l'application (individuels ou groupés)
- Réinitialiser une clé à sa valeur par défaut
Vous pouvez consultericila description de toutes les touches de réglage.
Routage
| Méthode | Routage | Description |
|---|---|---|
| OBTENIR | /settings/ | Récupérerl'ensembledes clés, valeurs et métadonnées de configuration. |
| PUBLICATION | /settings/ | Appliquerplusieursparamètres en une seule fois. |
| OBTENIR | /settings/{key} | Récupèrela valeur actuellede la clé de configuration spécifiée. |
| PUBLICATION | /settings/{key} | Appliquerune nouvelle valeurà la clé spécifiée. |
| SUPPRIMER | /settings/{key} | Réinitialiser une clé à savaleur par défaut. |
Structure de réponse
OBTENIR /settings/(Tous les paramètres)
Renvoie un objet dont les clés sont les clés indiquées. Chaque entrée contient :
value: Valeur actuellemetadata: 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)
Renvoieuniquement la valeurde la clé demandée (sans les métadonnées).
Paramètres de l'application
PUBLICATION /settings/(Application groupée)
Appliquer plusieurs clés en une seule fois.
Format recommandé pour le corps de la requête : un objet JSON contenant des paires clé-valeur.
{
"devices/detection/timeout": 5,
"devices/detection/advanced/wvg_description_filter": ["Haply USB Transceiver", "Haply Handle"]
}
PUBLICATION /settings/{key}(Application unique)
Appliquer une nouvelle valeur à une clé spécifique.
Format recommandé pour le corps de la requête : valeur JSON brute ou valeur encapsulée (il est recommandé d'utiliser le format encapsulé pour plus de clarté).
{
"value": 5
}
Réinitialiser les paramètres
SUPPRIMER /settings/{key}
Réinitialisez cette clé à sa valeur par défaut.
Cela revient à « rétablir les valeurs par défaut ».
Suggestions de type
Le service le déduira automatiquement type_hint。Pour les types complexes, on reviendra à l'utilisation de GENERIC。
Conseils d'utilisation :
BOOLINTFLOATSTRINGVEC2VEC3VEC4TRANSFORMARR_INTARR_FLOATARR_STRINGGENERIC
Anciens points de terminaison obsolètes
Il en reste encore quelques-uns POST Le point de terminaison reste accessible, mais un avertissement indiquant qu'il est obsolète s'affiche,
et il sera 4.0 Supprimé. Veuillez consulter 3.5 Guide de migration,
Consultez le tableau complet de correspondance entre les chemins obsolètes et les chemins de remplacement.