haply 1.3.0

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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
//! Device configs, states, statuses, messages, and service-level containers.

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

use super::base_types::*;
use super::enums::*;
use super::navigation::{NavigationConfigSnapshot, NavigationState, NavigationStatusInfo};
use super::sdf::{SdfSessionConfig, SdfSessionState, SdfSessionStatus};

/// Coordinate system permutation configuration
#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct CoordinateSystem {
    pub permutation: String,
}

/// Transform structure containing position, rotation, and scale.
/// All fields default to identity when absent (service omits identity-default fields).
#[derive(Copy, Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct Transform {
    #[serde(default)]
    pub position: Linear3D,
    #[serde(default)]
    pub rotation: Orientation4D,
    #[serde(default)]
    pub scale: Linear3D,
}

/// Deserializes an `Option<Transform>`, treating empty objects `{}` as `None`.
pub(crate) fn deserialize_optional_transform<'de, D>(deserializer: D) -> Result<Option<Transform>, D::Error>
where
    D: Deserializer<'de>,
{
    let v: serde_json::Value = Deserialize::deserialize(deserializer)?;
    match &v {
        serde_json::Value::Null => Ok(None),
        serde_json::Value::Object(map) if map.is_empty() => Ok(None),
        _ => serde_json::from_value::<Transform>(v).map(Some).map_err(de::Error::custom),
    }
}

// ============================================================
// Device info
// ============================================================

#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct DeviceInfo {
    pub id: String,
    pub major_version: u32,
    pub minor_version: u32,
    pub device_type: DeviceType,
    pub uuid: String,
}

#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct DevicesInfo {
    pub devices: Vec<DeviceInfo>,
}

impl From<Vec<DeviceInfo>> for DevicesInfo {
    fn from(devices: Vec<DeviceInfo>) -> Self {
        DevicesInfo { devices }
    }
}

// ============================================================
// Device configuration structs
// ============================================================

#[derive(Copy, Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct GravityCompensation {
    pub enabled: bool,
    pub scaling_factor: f32,
}

#[derive(Copy, Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct TorqueScaling {
    pub enabled: bool,
}

#[derive(Copy, Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct HomeReturn {
    pub enabled: bool,
}

#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct DeviceFilters {
    #[serde(default)]
    pub force_gate: Option<ForceGateFilter>,
    #[serde(default)]
    pub damping: Option<DampingFilter>,
}

#[derive(Copy, Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct ForceGateFilter {
    pub gain: f32,
}

#[derive(Copy, Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct DampingFilter {
    pub scalar: f32,
    #[serde(default)]
    pub vector: Option<Linear3D>,
}

/// Represents the full Inverse3 device configuration.
#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct DeviceConfig {
    #[serde(default)]
    pub id: String,
    #[serde(rename = "type")]
    pub type_: DeviceType,
    pub device_info: DeviceInfo,
    pub port: String,
    pub extended_device_id: String,
    pub extended_firmware_version: String,
    pub gravity_compensation: GravityCompensation,
    pub handedness: Handedness,
    pub torque_scaling: TorqueScaling,
    pub cursor_offset: Option<Linear3D>,
    pub coordinate_origin: Option<CoordinateOrigin>,
    #[serde(alias = "basis")]
    pub coordinate_system: Option<CoordinateSystem>,
    pub streaming_mode: Option<StreamingMode>,
    // 3.5 fields
    #[serde(default)]
    pub preset: Option<String>,
    #[serde(default)]
    pub filters: Option<DeviceFilters>,
    #[serde(default, deserialize_with = "deserialize_optional_transform")]
    pub mount: Option<Transform>,
    #[serde(default)]
    pub home_return: Option<HomeReturn>,
    #[serde(default)]
    pub navigation: Option<NavigationConfigSnapshot>,
}

#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct VGConfig {
    #[serde(default)]
    pub id: String,
    pub port: String,
    #[serde(rename = "type")]
    pub type_: DeviceType,
    #[serde(default)]
    pub preset: Option<String>,
    #[serde(default, alias = "basis")]
    pub coordinate_system: Option<CoordinateSystem>,
    #[serde(default, deserialize_with = "deserialize_optional_transform")]
    pub mount: Option<Transform>,
}

#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct WVGConfig {
    #[serde(default)]
    pub id: String,
    pub port: String,
    #[serde(rename = "type")]
    pub type_: DeviceType,
    pub major_version: u32,
    pub minor_version: u32,
    pub hardware_version: u32,
    pub streaming_mode: Option<StreamingMode>,
    #[serde(default)]
    pub sub_type: Option<String>,
    #[serde(alias = "basis")]
    pub coordinate_system: Option<CoordinateSystem>,
    #[serde(default)]
    pub preset: Option<String>,
    #[serde(default, deserialize_with = "deserialize_optional_transform")]
    pub mount: Option<Transform>,
}

#[derive(Clone, Debug, PartialEq, Deserialize, Serialize, TS)]
pub enum Config {
    DeviceConfig(DeviceConfig),
    VGConfig(VGConfig),
    WVGConfig(WVGConfig),
}

impl Config {
    pub fn id(&self) -> &str {
        match self {
            Config::DeviceConfig(cfg) => &cfg.id,
            Config::VGConfig(cfg) => &cfg.id,
            Config::WVGConfig(cfg) => &cfg.id,
        }
    }
}

// Navigation types are in super::navigation, re-exported via mod.rs

// ============================================================
// Session-level types (incoming state)
// ============================================================

#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct SessionInfo {
    #[serde(default)]
    pub session_id: u64,
    #[serde(default)]
    pub config: Option<SessionInfoConfig>,
    #[serde(default)]
    pub state: Option<SessionInfoState>,
    #[serde(default)]
    pub status: Option<SessionInfoStatus>,
}

#[derive(Clone, Debug, PartialEq, Default, Serialize, TS)]
pub struct SessionInfoConfig {
    #[serde(default)]
    pub profile: Option<ProfileInfo>,
    #[serde(default)]
    pub profile_name: Option<String>,
    #[serde(default)]
    pub started_time: Option<String>,
    #[serde(default)]
    pub required_version: Option<String>,
    #[serde(default)]
    pub basis: Option<CoordinateSystem>,
    #[serde(default)]
    pub sdf: Option<SdfSessionConfig>,
}

#[derive(Clone, Debug, PartialEq, Default, Deserialize)]
struct SessionInfoConfigSerde {
    #[serde(default)]
    profile: Option<ProfileInfo>,
    #[serde(default)]
    profile_name: Option<String>,
    #[serde(default)]
    started_time: Option<String>,
    #[serde(default)]
    required_version: Option<String>,
    #[serde(default)]
    basis: Option<CoordinateSystem>,
    #[serde(default)]
    sdf: Option<SdfSessionConfig>,
}

impl<'de> Deserialize<'de> for SessionInfoConfig {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        let helper = SessionInfoConfigSerde::deserialize(deserializer)?;
        let mut profile = helper.profile;
        let mut profile_name = helper.profile_name;

        if profile_name.is_none() {
            if let Some(p) = profile.as_ref() {
                profile_name = Some(p.name.clone());
            }
        }

        if profile.is_none() {
            if let Some(name) = profile_name.clone() {
                profile = Some(ProfileInfo { name });
            }
        }

        Ok(SessionInfoConfig {
            profile,
            profile_name,
            started_time: helper.started_time,
            required_version: helper.required_version,
            basis: helper.basis,
            sdf: helper.sdf,
        })
    }
}

#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct SessionInfoState {
    #[serde(default)]
    pub sdf: Option<SdfSessionState>,
}

#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct SessionInfoStatus {
    #[serde(default)]
    pub sdf: Option<SdfSessionStatus>,
}

#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct ProfileInfo {
    pub name: String,
}

/// Version information returned by the service.
#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct VersionResponse {
    pub build_time: String,
    pub git_branch: String,
    pub git_describe: String,
    pub git_hash: String,
    pub git_tag: String,
    pub project_name: String,
    pub project_version: String,
}

// ============================================================
// Device state/status/message types
// ============================================================

#[derive(Copy, Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct Buttons {
    #[serde(default)]
    pub a: bool,
    #[serde(default)]
    pub b: bool,
    #[serde(default)]
    pub c: bool,
    // Kingfisher-specific (absent on other devices, defaults to false)
    #[serde(default)]
    pub d: bool,
    #[serde(default)]
    pub e: bool,
    #[serde(default)]
    pub f: bool,
    // Ruko directional buttons
    #[serde(default)]
    pub down: bool,
    #[serde(default)]
    pub up: bool,
    #[serde(default)]
    pub right: bool,
    #[serde(default)]
    pub left: bool,
}

#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct Inverse3State {
    pub cursor_position: Option<Linear3D>,
    pub angular_position: Option<Angular3D>,
    pub angular_velocity: Option<Angular3D>,
    pub body_orientation: Option<Orientation4D>,
    pub cursor_velocity: Option<Linear3D>,
    pub mode: DeviceMode,
    pub control_domain: Option<ControlDomain>,
    pub control_mode: Option<ControlMode>,
    #[serde(default, deserialize_with = "deserialize_optional_transform")]
    pub transform: Option<Transform>,
    #[serde(default, deserialize_with = "deserialize_optional_transform")]
    pub transform_velocity: Option<Transform>,
    #[serde(default)]
    pub current_cursor_force: Option<Linear3D>,
    #[serde(default)]
    pub current_cursor_position: Option<Linear3D>,
    #[serde(default)]
    pub current_angular_torques: Option<Angular3D>,
    #[serde(default)]
    pub current_angular_position: Option<Angular3D>,
    #[serde(default)]
    pub navigation: Option<NavigationState>,
}

#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct Inverse3Status {
    pub calibrated: bool,
    pub in_use: bool,
    pub power_supply: bool,
    pub ready: bool,
    pub started: bool,
    #[serde(default)]
    pub navigation: Option<NavigationStatusInfo>,
}

#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct Inverse3Message {
    pub device_id: String,
    pub state: Inverse3State,
    pub status: Inverse3Status,
}

#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct Inverse3Device {
    pub device_id: String,
    pub config: Option<DeviceConfig>,
    pub state: Inverse3State,
    pub status: Inverse3Status,
}

#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct VerseGripState {
    pub button: Option<bool>,
    pub hall: Option<i32>,
    pub orientation: Option<Orientation4D>,
    #[serde(default, deserialize_with = "deserialize_optional_transform")]
    pub transform: Option<Transform>,
    #[serde(default, deserialize_with = "deserialize_optional_transform")]
    pub transform_velocity: Option<Transform>,
}

#[derive(Copy, Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct VerseGripStatus {
    pub error: Option<i32>,
    pub ready: Option<bool>,
}

#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct VerseGripMessage {
    pub device_id: String,
    pub state: VerseGripState,
    pub status: VerseGripStatus,
}

#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct VerseGripDevice {
    pub device_id: String,
    pub config: Option<VGConfig>,
    pub state: VerseGripState,
    pub status: VerseGripStatus,
}

#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct WirelessVerseGripState {
    pub battery_level: Option<f64>,
    pub battery_voltage: Option<f64>,
    pub buttons: Option<Buttons>,
    pub hall: Option<i32>,
    pub orientation: Option<Orientation4D>,
    // Ruko-specific fields (absent on standard wireless versegrips, defaults to None)
    #[serde(default)]
    pub trigger: Option<i32>,
    #[serde(default)]
    pub wheel: Option<i32>,
    #[serde(default, deserialize_with = "deserialize_optional_transform")]
    pub transform: Option<Transform>,
    #[serde(default, deserialize_with = "deserialize_optional_transform")]
    pub transform_velocity: Option<Transform>,
    #[serde(default)]
    pub extension_data: Option<Vec<i32>>,
}

#[derive(Copy, Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct WirelessVerseGripStatus {
    #[serde(default)]
    pub ready: bool,
    #[serde(default)]
    pub connected: bool,
    #[serde(default)]
    pub awake: bool,
}

#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct WirelessVerseGripMessage {
    pub device_id: String,
    pub state: WirelessVerseGripState,
    pub status: WirelessVerseGripStatus,
}

#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct WirelessVerseGripDevice {
    pub device_id: String,
    pub config: Option<WVGConfig>,
    pub state: WirelessVerseGripState,
    pub status: WirelessVerseGripStatus,
}

#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct CustomVerseGripState {
    pub battery_level: Option<f64>,
    pub battery_voltage: Option<f64>,
    pub buttons: Option<Buttons>,
    pub hall: Option<i32>,
    pub orientation: Option<Orientation4D>,
    #[serde(default, deserialize_with = "deserialize_optional_transform")]
    pub transform: Option<Transform>,
    #[serde(default, deserialize_with = "deserialize_optional_transform")]
    pub transform_velocity: Option<Transform>,
    pub extension_data: Option<Vec<i32>>,
}

#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct CustomVerseGripMessage {
    pub device_id: String,
    pub state: CustomVerseGripState,
    pub status: WirelessVerseGripStatus,
}

#[derive(Clone, Debug, PartialEq, Default, Deserialize, Serialize, TS)]
pub struct CustomVerseGripDevice {
    pub device_id: String,
    pub config: Option<WVGConfig>,
    pub state: CustomVerseGripState,
    pub status: WirelessVerseGripStatus,
}

// ============================================================
// Service-level containers
// ============================================================

#[derive(Clone, Debug, PartialEq, Deserialize, Serialize, TS)]
pub struct ServiceData {
    #[serde(default)]
    pub inverse3: Vec<Inverse3Device>,
    #[serde(default)]
    pub verse_grip: Vec<VerseGripDevice>,
    #[serde(default)]
    pub wireless_verse_grip: Vec<WirelessVerseGripDevice>,
    #[serde(default)]
    pub custom_verse_grip: Vec<CustomVerseGripDevice>,
    #[serde(default)]
    pub session_id: u64,
    #[serde(default)]
    pub session: Option<SessionInfo>,
}

#[derive(Clone, Debug, PartialEq)]
pub struct TimestampedServiceData {
    pub data: ServiceData,
    pub timestamp: std::time::Instant,
}

impl Default for ServiceData {
    fn default() -> Self {
        ServiceData {
            inverse3: Vec::new(),
            verse_grip: Vec::new(),
            wireless_verse_grip: Vec::new(),
            custom_verse_grip: Vec::new(),
            session_id: 0,
            session: None,
        }
    }
}

#[derive(Clone, Debug, PartialEq, Deserialize, Serialize, TS)]
pub struct ServiceState {
    #[serde(default)]
    pub inverse3: Vec<Inverse3Message>,
    #[serde(default)]
    pub verse_grip: Vec<VerseGripMessage>,
    #[serde(default)]
    pub wireless_verse_grip: Vec<WirelessVerseGripMessage>,
    #[serde(default)]
    pub custom_verse_grip: Vec<CustomVerseGripMessage>,
    #[serde(default)]
    pub session_id: u64,
    #[serde(default)]
    pub session: Option<SessionInfo>,
}

impl Default for ServiceState {
    fn default() -> Self {
        ServiceState {
            inverse3: Vec::new(),
            verse_grip: Vec::new(),
            wireless_verse_grip: Vec::new(),
            custom_verse_grip: Vec::new(),
            session_id: 0,
            session: None,
        }
    }
}