haply 1.2.1

Haply Robotics Client Library for the Inverse Service
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

//! SDF Haptic Effects (HFX) module types — commands, objects, and session state.

use serde::{Deserialize, Serialize};
use ts_rs::TS;

use super::commands::TransformPatch;
use super::primitives::{EasingType, SdfPrimitive, SymmetryMode};

// ============================================================
// SDF HFX object (shared between commands and state)
// ============================================================

/// A single SDF haptic effect object.
/// All fields except `id` are `Option` to support partial updates.
#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct SdfHfxObject {
    pub id: String,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub shape: Option<SdfPrimitive>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub transform: Option<TransformPatch>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub force_scale: Option<f32>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub range: Option<f32>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub ease: Option<EasingType>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub reverse_easing: Option<bool>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub symmetry: Option<SymmetryMode>,
}

/// SDF HFX object with routing info — used in incoming session state and flat HTTP routes.
/// Extends `SdfHfxObject` with `session_id` and `devices`.
#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct SdfHfxData {
    #[serde(flatten)]
    pub object: SdfHfxObject,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub session_id: Option<u64>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub devices: Option<Vec<String>>,
}

// ============================================================
// Outgoing WS command
// ============================================================

/// SDF command mode — determines how `objects` are applied.
#[derive(Clone, Debug, PartialEq, Deserialize, Serialize, TS)]
#[serde(rename_all = "snake_case")]
pub enum SdfCommandMode {
    /// Atomic replace — clears all existing effects, inserts `objects`.
    Set,
    /// Partial patch — only provided fields are applied; `id` required.
    Update,
    /// Remove effects by `id`.
    Remove,
}

/// Outgoing SDF command sent in `inverse3[].commands.sdf`.
#[derive(Clone, Debug, PartialEq, Deserialize, Serialize, TS)]
pub struct SdfCommand {
    pub mode: SdfCommandMode,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub from_space: Option<String>,

    pub objects: Vec<SdfHfxObject>,
}

// ============================================================
// Outgoing WS configure
// ============================================================

/// SDF output configure — toggles streaming of SDF state in session frames.
/// Sent in `session.configure.sdf`.
#[derive(Copy, Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct SdfOutputConfigure {
    pub state_output: bool,
}

// ============================================================
// Incoming session state/status/config
// ============================================================

/// SDF session state — array of active effects, streamed in `session.state.sdf`.
#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct SdfSessionState {
    #[serde(default)]
    pub objects: Vec<SdfHfxData>,
}

/// SDF session status — effect count, streamed in `session.status.sdf`.
#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct SdfSessionStatus {
    pub count: u32,
}

/// SDF session config — whether state output is enabled, in `session.config.sdf`.
#[derive(Copy, Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct SdfSessionConfig {
    pub state_output: bool,
}

/// Wrapper for the SDF objects list used in flat HTTP route bodies.
#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct SdfObjectList {
    pub objects: Vec<SdfHfxData>,
}