rover_nexus_core 0.1.0

Wire-format message types (Cap'n Proto + JSON) for communication between robotic vehicles and a robot orchestration server: Rover Nexus
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
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
// Copyright 2026 Rottinghaus Dynamics
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// core_model.rs
use serde::{Deserialize, Serialize};
use uuid::Uuid;

// Command structure sent from the server to robot agent
// agent acks uuid, removes InternalCommand to forward to robot software
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct NexusCommand {
    pub id: Uuid,
    pub command: InternalCommand,
}

// Use DateTime, Utc whenever actually processing time in code
// i64 - unix time milliseconds is the time to use on the wire, IPC
// From fleet command to rover
// All passed through until I need to remotely manage the agent..
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum InternalCommand {
    SetMode(RobotMode), // set the robot to an operation mode, Auto, Teleop, etc
    GoTo {
        target: GeoPose, // Command the robot to go to a location
    },
    // Set the raw trajectory of the robot
    VelocityCmd {
        linear_mps: f32,
        angular_rps: f32,
    },
    Stop, // Pause, opposite of resume, intended to stop robot activity and pause the current mission
    Resume, // Opposite of Stop, resume the current activity or mission
    // Call a capability that the robot provides
    InvokeService {
        service_name: String,
        setting: Option<bool>,
    },
    // Set the status of a mission, mainly to resume or stop a mission, not overall motion
    SetMissionRunStatus {
        mission_id: String,
        run_id: String,
        status: MissionStatus,
    },
    // A complete mission command with a path, target, geometry, capabilities and settings
    MissionCommand(MissionCommand),
    // Inform the robot of a new feature in the world
    Feature(FeatureOp),
    // Inform the robot of a new spatial directive. The spatial directive is calculated by the agent by default
    SpatialDirective(SpatialDirectiveOp),
    // Inform the robot of an object in the world
    Object(ObjectOp),
    // Set a robot setting, must be one given in UiCapabilities or in the robot.toml settings
    SettingUpdate(Vec<SettingUpdate>),
    // Delete a mission from the robot so it can no longer be controlled or referenced
    DeleteMission {
        mission_id: String,
    },
    // Joystick command intended for teleop usage
    TeleopJoy(TeleopJoy),
}

// From rover to fleet command
#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum UplinkMsg {
    MissionRunStatus(MissionRunStatus),
    MotionTelemetry(MotionTelemetry),
    StatusTelemetry(StatusTelemetry),
    TelemetryExtras(TelemetryExtras),
    EventTelemetry(EventTelemetry), // Reliable
    UiCapabilities(UiCapabilities), // Re-sent by agent if needed
    Fault(Fault),                   // Reliable
    Shape(ReportedShapeOp),         // Reliable
    Object(ObjectOp),
    SystemHealth(SystemHealth),
    UsageTelemetry(UsageTelemetry),
    ConsumableStatus(ConsumableStatus), // Values of a consumable on the robot
    CurrentSettings(Vec<SettingUpdate>), // Snapshot of the robot's current settings. Re-sent.
    Message(Message), // Reliable, a message from the robot to appear in the Rover Nexus UI.
    AgentInfo(AgentInfo), // Re-sent by agent if needed, robot software does not send
    SpatialDirectiveStatus(SpatialDirectiveStatus), // Status of a spatial directive reported by the robot agent by default.
}

#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum MessageLevel {
    Info,
    Warn,
    Error,
}

// This is not log storage. Use your own logging infrastructure.
#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct Message {
    pub unix_time_ms: i64,
    pub level: MessageLevel,
    pub message: String,
}

#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct AgentInfo {
    pub agent_version: String,
    pub software_version: Option<String>,
    pub os_info: Option<String>, // "Ubuntu 22.04 aarch64" - debugging
    pub uptime_s: Option<u64>,   // how long since boot - detect frequent reboots
}

#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct TeleopJoy {
    pub source_id: String,  // "webrtc-ui", "local-gamepad", "api-client:abc"
    pub session_id: String, // unique per teleop takeover/session
    pub axes: Vec<f32>,
    pub buttons: Vec<bool>,
    pub timestamp_ms: i64,
}

/// Server -> robot operation carrying a bare spatial primitive (Shape or Route).
/// Use `SpatialDirectiveOp` instead when the payload also carries timing,
/// parameters, or capabilities for application within a zone.
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum FeatureOp {
    Upsert(SpatialFeature),
    Delete { id: String },
}

/// Server -> robot operation carrying a `SpatialDirective` (a persistent zone
/// with timing, parameters, and capabilities to apply within it).
// `Upsert` is intentionally unboxed: it is the common variant, the wire format
// (Cap'n Proto / JSON) is identical whether or not it is boxed, and boxing would
// only add a public-API `Box::new` requirement plus a hot-path allocation.
#[allow(clippy::large_enum_variant)]
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum SpatialDirectiveOp {
    Upsert(SpatialDirective),
    Delete { id: String },
}

// Object reported from the robot to Rover Nexus, scope determines if it is forwarded to other robots in the fleet
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum ObjectOp {
    Upsert(Object),
    Delete { id: String },
}

// For the robot to report a shape, geographic feature to Rover Nexus
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum ReportedShapeOp {
    Upsert(ReportedShape),
    Delete { id: String },
}

#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct RobotState {
    pub motion_dirty: bool,
    pub status_dirty: bool,
    pub extras_dirty: bool,
    // Set dirty bools when new data is written to the state
    // Set to false when uplink reads it to send to server
    pub motion_telemetry: MotionTelemetry,
    pub status_telemetry: StatusTelemetry,
    pub extras: TelemetryExtras,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum FaultSeverity {
    Info,
    Minor,
    Major,
    Critical,
}

/// Fault report structure for robot system faults
/// Robot software must send active == false when the fault clears, otherwise it persists on Rover Nexus
#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct Fault {
    pub unix_time_ms: i64,
    pub fault_id: String, // stable code, e.g. "BATTERY_UNDERVOLT"
    pub source: String,   // node/sensor
    pub severity: FaultSeverity,
    pub active: bool,             // true on raise, false on clear
    pub category: String,         // power, comms, nav, safety, etc.
    pub description: String,      // short human text
    pub suggested_action: String, // optional remediation hint
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum MissionStatus {
    Unknown,
    Ready,
    Starting, // Don't stay in this state
    Running,
    Paused,
    Blocked,
    Aborted,
    Completed,
    Error,
}

impl MissionStatus {
    /// Whether this is a terminal mission state — the run has finished and will
    /// not progress further (`Completed`, `Aborted`, or `Error`). All other
    /// states (including `Paused`/`Blocked`) are non-terminal: the run can still
    /// advance from them.
    pub fn is_terminal(self) -> bool {
        matches!(
            self,
            MissionStatus::Completed | MissionStatus::Aborted | MissionStatus::Error
        )
    }
}

// Capability and UI related types
// =============================================

// Robot -> UI: frequent, minimal, just the data
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct SensorReading {
    pub key: String,
    pub value: Value,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub unix_time_ms: Option<i64>, // per reading timestamp
}

// Tells the UI how to display the data
// Not all items are implemented yet
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub enum DisplayHint {
    None,  // Likely text
    OnOff, // Says On or Off with a little style
    Gauge, // ?
    Text,
    Online,       // Green "light"
    WarningLight, // Amber "light"
    Temperature,  // ?
    Progress,     // Health bar filled from left to right
                  // etc.
}

#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct Range {
    pub min: f64,
    pub max: f64,
}

// Robot -> UI: once on connect or when config changes
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct SensorDescriptor {
    pub key: String,           // in code key for uniqueness
    pub label: String,         // label on the UI
    pub value_type: ValueType, // See ValueType
    #[serde(skip_serializing_if = "Option::is_none")]
    pub unit: Option<String>, // Unit appended to the value
    #[serde(skip_serializing_if = "Option::is_none")]
    pub range: Option<Range>, // for coloring and display range of gauges/visualization
    pub display_hint: DisplayHint, // How to show the reading, see DisplayHint
}

// Custom sensor states and values reported by the robot software
// Rates & limits: let OEM push at their chosen rate, but expect the server to
// enforce rate caps, per-message size limits, and a maximum kv length.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct TelemetryExtras {
    pub unix_time_ms: i64,
    /// Arbitrary scalar/status values published by the robot/OEM.
    /// Example entries:
    ///   "deck_rpm" -> "3120"
    ///   "hydraulic_temp_c" -> "64.2"
    ///   "camera_front_ok" -> "true"
    ///   "tilt_deg" -> "18.5"
    pub kv: Vec<SensorReading>,
}

// UI <-> Robot: user changing a setting
// This is always a patch message
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct SettingUpdate {
    pub key: String,
    pub value: Value,
}

// Robot -> UI: what settings exist and their constraints
// Includes a default value which defines the expected type as well
// Validate at ingest: “default matches value_type”
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct SettingDescriptor {
    pub key: String,
    pub label: String,
    pub value_type: ValueType,
    pub default: serde_json::Value,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub range: Option<Range>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub step: Option<f64>,
}

// What role the user must be to use the service, otherwise greyed out
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub enum Role {
    Viewer,
    Operator,
    Admin,
    Owner,
}

// How to display and also what message is sent
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub enum CapabilityType {
    Trigger,     // Button one-shot
    SetBool,     // 2 linked buttons for on and off
    MissionType, // No button, expresses a mission type a robot can do
}

#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub enum DangerLevel {
    #[default]
    Normal, // regular styling
    Warning,  // yellow, requires confirmation
    Critical, // red, maybe requires typing "CONFIRM" or similar
}

// Defines what a robot can do, these become buttons and can also be tied to missions and areas
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ServiceCapability {
    pub name: String,                         // "start_mowing"
    pub description: String,                  // "Begin autonomous mowing routine"
    pub capability_type: CapabilityType,      // what args are needed (or empty)
    pub confirmation_message: Option<String>, // warn optionally with custom warning text
    pub state_key: Option<String>, // what sensor key is associated with this control, for displaying together
    pub requires_role: Role,       // e.g. "operator" or "admin", minimum role
    #[serde(default)]
    pub danger_level: DangerLevel, // Danger level, warning and critical require confirmation, default Normal
}

// Ui capabilities message that tells Rover Nexus what the robot can do and what settings it has
// The agent sends this on startup based on the robot.toml config. The robot software may optionally send it.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct UiCapabilities {
    pub services: Vec<ServiceCapability>, // These become buttons
    pub sensors: Vec<SensorDescriptor>,   // What values are available and how to display them
    pub settings: Vec<SettingDescriptor>, // these become editable boxes when clicked, then all are sent with a "Save Settings" button
}

#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub enum ValueType {
    String,                        // Text box
    Int,                           // Text box accepts numbers only
    Number,                        // Text box accepts numbers only
    Bool,                          // Toggle switch, as 2 buttons
    Enum { options: Vec<String> }, // Always becomes a dropdown
}

#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
#[serde(rename_all = "camelCase", tag = "type", content = "data")]
pub enum Value {
    String(String),
    Int(i32),
    Number(f64),
    Bool(bool),
    Enum(String),
}

// End of capability types
// =============================================

/// Operational mode of the robot. Estop is reported separately on
/// `StatusTelemetry.estop`; fault conditions are reported separately as
/// `UplinkMsg::Fault`. RobotMode covers only the active operating mode.
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum RobotMode {
    Manual,
    Auto,
    Teleop,
    Idle,
}

// Mission status sent back, should be periodically sent as a mission progresses.
// The robot software is responsible for reporting the final state of a mission in status
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct MissionRunStatus {
    pub unix_time_ms: i64,
    pub mission_id: String,
    pub run_id: String,
    pub status: MissionStatus,
    pub status_message: Option<String>,
    pub progress_x100: Option<u16>, // progress_x100 (0..=10000) = percent * 100
    pub current_path_id: Option<String>,
    pub current_target: Option<GeoPose>,
    pub current_step: Option<u32>, // Can be waypoints
    pub total_steps: Option<u32>,
    // When this mission actually started running on the robot.
    pub time_started_ms: Option<i64>,
    // The robot's current best guess of when it'll be done.
    // This can move as the situation changes.
    pub expected_end_time_ms: Option<i64>,
    // Set when mission reaches a terminal state (COMPLETE / CANCELED / ERROR).
    pub time_completed_ms: Option<i64>,
    pub name: Option<String>, // If the robot makes and unknown mission or wants to rename the current mission
                              // Add pub remaining_distance_m: Option<f64>,
}

#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct AssetIdentity {
    pub id: String,   // persistent id of the shape or route
    pub name: String, // display/debug only,
    pub rev: u32,     // 0 => not provided // Rev of 0 means not provided and can be ignored
    pub hash: String, // "" => not provided // Hash of the payload file pathHash == "" means “not provided”
}

#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub enum SpatialFeature {
    Shape(Shape),
    Route(Route),
}

#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub enum CapabilityTiming {
    ImmediateTrigger, // fire once now at step start
    AtTargetTrigger,  // fire once after reaching target or starting path
    DuringStep,       // enable at start, disable at end. if bool
    DuringFeature,    // enable while traversing feature, disable at end if bool
    FinalTrigger,     // Fire at end of navigation
}

#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct MissionCapability {
    pub name: String,
    pub timing: CapabilityTiming,
    pub value: bool,
}

// ActionOnArrival {
//     arrival_radius_m: Option<f64>,
//     require_stopped: bool,
//     timeout_ms: Option<i64>,
// }

// #[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
// #[serde(rename_all = "camelCase")]
// pub enum PrimitiveAction {
//     Navigate { target: Path },
//     CallService { name: String, args: Json },
// }

// #[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
// #[serde(rename_all = "camelCase")]
// ZoneTrigger {
//     zone_id,
//     geometry,
//     on_enter: CallService(...),
//     on_exit: CallService(...),
//     debounce_ms,
//     min_inside_ms,
// }

/// A mission order from the fleet manager with one asset, one time use
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct MissionCommand {
    pub mission_id: String, // mission template UUID, given by fleet manager
    pub run_id: String,     // Given by scheduler on robot agent
    pub name: String,       // display name
    pub user_id: String,    // Who deployed the mission
    pub detail: String,     // Description for user's benefit
    // Times come from browser as ms in JSON, must be converted
    pub scheduled_start_ms: i64,                // milliseconds
    pub expected_end_time_ms: Option<i64>,      // Can be deadline, milliseconds
    pub mission_parameters: Vec<SettingUpdate>, // Settings to apply at the start of this mission step
    pub capabilities: Vec<MissionCapability>, // what features or services this mission should use or call
    pub feature: Option<SpatialFeature>,      // Path to follow, waypoints, or coverage area
}

/// SpatialDirective - a persistent zone (geometry + active rules) sent from
/// fleet to robot. Combines a `SpatialFeature` (Shape or Route) with timing,
/// zone parameters, and capabilities to invoke while in/at the zone.
///
/// This is distinct from a bare `SpatialFeature`, which is just geometry, and
/// from `MissionCommand`, which is a one-shot mission order.
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct SpatialDirective {
    pub directive_id: String,        // UUID, given by fleet manager
    pub name: String,                // display name
    pub start_time_ms: i64,          // when it should start being applied
    pub expire_time_ms: Option<i64>, // when it should expire
    pub zone_parameters: Vec<SettingUpdate>,
    pub capabilities: Vec<String>, // What services or features to apply in or on this zone
    pub spatial: SpatialFeature,
}

// Feedback about if a robot is in a zone and applying the directive specified by SpatialDirective
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct SpatialDirectiveStatus {
    pub directive_id: String,
    pub last_eval_time_ms: i64,
    pub active: bool,      // currently inside + within time window + applicable
    pub inside_zone: bool, // robot's local evaluation
    pub distance_to_zone_m: Option<f32>,
}

#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct Schedule {
    /// Who is responsible for scheduling triggers.
    /// - Server: server will enqueue MissionRuns.
    /// - Agent: rover-agent on robot will self-schedule when it receives this MissionCommand.
    /// - Robot: robot will self-schedule when it receives this MissionCommand.
    pub owner: TriggerSource,

    /// Interpreting cron requires a timezone; store it explicitly.
    /// Examples: "America/Phoenix", "UTC"
    pub timezone: String,

    /// Optional: don’t generate triggers before this time.
    pub start_time_ms: Option<i64>,

    /// Optional: stop generating triggers after this time.
    pub end_time_ms: Option<i64>,

    /// The actual schedule definition.
    pub kind: ScheduleKind,
}

#[derive(Debug, Clone, Copy, Deserialize, Serialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub enum TriggerSource {
    Server,
    Agent,
    Robot,
}

#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
#[serde(rename_all = "camelCase", rename_all_fields = "camelCase")]
pub enum ScheduleKind {
    /// Classic cron string.
    /// Choose a convention and document it (5-field vs 6/7-field).
    Cron {
        /// e.g. "0 6 * * 1-5" (06:00 Mon–Fri) if using 5-field cron (min hour dom mon dow)
        expr: String,
    },

    /// Simple interval schedule (super easy for OEMs)
    Interval {
        every_seconds: u32,
    },
    Once, // Only fire once at the start time
}

// An event transition emitted from robot software
// not currently used.
#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct EventTelemetry {
    pub unix_time_ms: i64,
    pub kind: EventKind,
}

#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum EventKind {
    EstopEngaged,
    EstopReleased,
    ModeChanged {
        from: RobotMode,
        to: RobotMode,
    }, // {from, to}
    MissionStarted {
        mission_id: String,
    }, // {mission_id}
    MissionCompleted {
        mission_id: String,
    }, // {mission_id}
    FaultRaised {
        fault_code: String,
        description: String,
    }, // {fault_code, description}
    FaultCleared {
        fault_code: String, // {fault_code}
    },
}

/// Origin of the GPS fix reported on `MotionTelemetry`. Replaces two booleans
/// (`gps_simulated`, `gps_estimated`) that allowed nonsensical "both true"
/// states. The default for actual hardware fixes is `Real`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, Default)]
#[serde(rename_all = "camelCase")]
pub enum GpsSource {
    #[default]
    Real, // actual hardware fix
    Simulated, // running in a simulator, no real hardware
    Estimated, // hardware lost lock, using dead-reckoning / IMU
}

// High frequency motion data
// This bumps the last seen time on Rover Nexus and will tell the server that the robot is online
// Recommended publish rate: 1Hz when idle, Maximum 10Hz when in motion. Will be throttled above 10Hz,
// the latest value is always forwarded by the agent
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct MotionTelemetry {
    pub unix_time_ms: i64,
    pub pose: Option<GeoPose>,
    pub velocity: Option<VelTwist>,
    pub gps_fix: Option<GpsFixType>, // optional: include if you want map accuracy/confidence
    pub gps_source: GpsSource,
}

// General status of the robot, must be published by robot software,
// This bumps the last seen time on Rover Nexus and will tell the server that the robot is online
// Recommended publish rate: 1Hz.
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct StatusTelemetry {
    pub unix_time_ms: i64,
    pub battery: Option<BatteryStatus>,
    pub fuel: Option<FuelStatus>,
    pub range_remaining_m: Option<f64>,   // meters
    pub runtime_remaining_s: Option<f64>, // seconds
    pub mode: Option<RobotMode>,
    pub estop: EStop,
    pub faulted: bool,
    pub accepting_missions: bool, // was mission_active, which is now covered by the mission run status message, this is to indicate availability
    pub status: String,           // OEM-defined status string
}

// Robot usage statistics, source of truth must be the robot software that talks to the agent.
#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct UsageTelemetry {
    pub unix_time_ms: i64,
    // Distance metrics
    pub total_distance_m: f64,
    pub auto_distance_m: f64,
    pub manual_distance_m: f64,
    // Time metrics
    pub uptime_total_s: f64,
    pub drive_time_total_s: f64,
    pub auto_time_total_s: f64,
    // Counters
    pub mission_count_total: u32,
    pub charge_cycles_total: u32,
    pub reboot_count: u32,
    // Last reboot (epoch ms)
    pub last_reboot_unix_time_ms: i64,
}

// This message is filled and published by the robot agent once every 5 seconds,
// the robot software may optionally publish their own to override the agent
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct SystemHealth {
    pub unix_time_ms: i64,
    pub device_id: String, // if multiple computers or cpus on one robot, cpu1, gpu2, etc.
    pub cpu_pct: f32,
    pub mem_pct: f32,
    pub disk_pct: f32,
    pub cpu_temp: f32,
    pub signal_strength: f32, // RSSI
    pub signal_quality: f32,  // standard wifi link quality
}

// signal that the robot has been E-stopped and cannot take commands
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct EStop {
    pub unix_time_ms: i64,
    pub active: bool,
    pub ids: Vec<String>,
}

// Determines how messages are propagated through the fleet,
// This says who the intended recipient is.
#[repr(u8)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum ScopeType {
    Robot = 0,
    Fleet = 1,
    World = 2,
    User = 3,
}

#[repr(u8)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum ObjectType {
    Unknown = 0,
    // Living things
    Person = 1,
    Animal = 2,
    // Vehicles / mobile equipment
    Vehicle = 3,
    Robot = 4,
    // Infrastructure / static man-made things
    Structure = 5,
    Equipment = 6,
    // Physical obstacles / terrain-relevant things
    Obstacle = 7,
    Debris = 8,
    // Safety / operationally important things
    Hazard = 9,
    Marker = 10,
    PointOfInterest = 11,
}

#[repr(u8)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum ReportedLayerRole {
    // --- State / System-generated ---
    Coverage = 0,    // Area the robot worked on, i.e. harvested field area
    Occupied = 1,    // Used by the reporting robot directly
    Reserved = 2,    // Robot is going to use this space, do not assign
    Consumed = 3,    // permanently or semi-permanently no longer available
    Hazard = 4,      // unsafe area
    Blocked = 5,     // impassible
    PlannedPath = 6, // where the robot will go, path and target
}

#[repr(u8)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum LayerRole {
    // --- Intent / User-defined ---
    AllowedArea = 0,   // Geofence, an area the robot must stay inside
    Preferred = 1,     // Preferred area to drive, for planning
    Keepout = 2,       // Do not go here
    SoftExclusion = 3, // prefer not to go here
    WorkArea = 4,      // an area the robot should do stuff in
    Target = 5,        // Goal the robot should go to
    Queue = 6,         // Staging, waiting, charging or queue area
    ControlZone = 7,   // Enforce a setting here
    TriggerZone = 8,   // Trigger something on entry / exit
    // --- State / System-generated ---
    Coverage = 10,    // Area the robot worked on, i.e. harvested field area
    Occupied = 11,    // Used by the reporting robot directly
    Reserved = 12,    // Robot is going to use this space, do not assign
    Consumed = 13,    // permanently or semi-permanently no longer available
    Hazard = 14,      // unsafe area
    Blocked = 15,     // impassible
    PlannedPath = 16, // where the robot will go, path and target
}

#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum ShapeData {
    Point(GeoPoint2),
    MultiPoint(Vec<GeoPoint2>),
    LineString(Vec<GeoPoint2>),
    MultiLineString(Vec<Vec<GeoPoint2>>),
    Polygon {
        exterior: Vec<GeoPoint2>,
        holes: Vec<Vec<GeoPoint2>>,
    },
    MultiPolygon(Vec<PolygonData>),
}

#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct PolygonData {
    pub exterior: Vec<GeoPoint2>,
    pub holes: Vec<Vec<GeoPoint2>>,
}

#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct Shape {
    pub identity: AssetIdentity,
    pub data: ShapeData,
    pub area_type: LayerRole,
    pub scope: ScopeType,
    // Height rules examples:
    // altitude_mode: Ignore | Absolute | RelativeToGround | Level
    // min_z_m/max_z_m (optional): treat area as an extruded prism for bridges/parking decks/ramps.
    pub min_z_m: f64,
    pub max_z_m: f64,
    pub level_id: i32, // level_id (optional): for multi-storey sites.
}

// Reported shape from robot to Rover Nexus, if the scope is world or fleet, it is forwarded to all robots in the fleet
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct ReportedShape {
    pub identity: AssetIdentity,
    pub data: ShapeData,
    pub area_type: ReportedLayerRole,
    pub scope: ScopeType,
    pub expire_time_ms: i64,
    // Height rules examples:
    // altitude_mode: Ignore | Absolute | RelativeToGround | Level
    // min_z_m/max_z_m (optional): treat area as an extruded prism for bridges/parking decks/ramps.
    pub min_z_m: f64,
    pub max_z_m: f64,
    pub level_id: i32, // level_id (optional): for multi-storey sites.
}

#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum RouteData {
    Waypoint(GeoPose),
    MultiWaypoint(Vec<GeoPose>),
    Path(Vec<GeoPose>),
    MultiPath(Vec<Vec<GeoPose>>),
}

#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct Route {
    pub identity: AssetIdentity,
    pub data: RouteData,
    pub area_type: LayerRole,
    pub scope: ScopeType,
    pub feature_type: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct Trajectory {
    pub speed_mps: f64,         // scalar, meters/second
    pub course_deg: f64,        // degrees, 0=North (direction of travel, not heading)
    pub vertical_rate_mps: f64, // m/s, positive = ascending (drones only)
}

#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct GeoPoint2 {
    pub lon: f64,
    pub lat: f64,
}

// Specifically for object tracking
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct Object {
    pub id: String,
    pub name: String,
    pub unix_time_ms: i64,
    pub expires_unix_time_ms: i64,
    pub scope: ScopeType, // Robot and user just send to fleet manager, Fleet and world send to all robots in fleet
    pub object_type: ObjectType,
    pub location: GeoPose,
    pub trajectory: Trajectory, // 3D velocity vector
    pub radius_m: f64,          // meters
}

// For ROS2
// # Navigation Satellite fix status for any Global Navigation Satellite System.
// # Whether to output an augmented fix is determined by both the fix
// # type and the last time differential corrections were received.  A
// # fix is valid when status >= STATUS_FIX.
// int8 STATUS_NO_FIX =  -1        # unable to fix position
// int8 STATUS_FIX =      0        # unaugmented fix
// int8 STATUS_SBAS_FIX = 1        # with satellite-based augmentation
// int8 STATUS_GBAS_FIX = 2        # with ground-based augmentation
// int8 status
#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum GpsFixType {
    Unknown,
    Invalid,
    #[serde(rename = "GPS")]
    GPS, // maps to unaugmented fix
    #[serde(rename = "DGPS")]
    DGPS, // Differential
    #[serde(rename = "SBAS")]
    SBAS,
    FloatRTK,
    FixedRTK,
    #[serde(rename = "PPS")]
    PPS,
    GBAS, // Ros2 reported ground-based augmentation
}

impl GpsFixType {
    /// Convert from i8 representation (for ROS compatibility)
    // int8 STATUS_NO_FIX=-1
    // int8 STATUS_FIX=0
    // int8 STATUS_SBAS_FIX=1
    // int8 STATUS_GBAS_FIX=2
    pub fn from_ros_status(value: i8) -> Self {
        match value {
            -1 => Self::Invalid,
            0 => Self::GPS,
            1 => Self::SBAS,
            2 => Self::FixedRTK,
            _ => Self::Unknown,
        }
    }

    pub fn from_u8(value: u8) -> Self {
        match value {
            0 => Self::Unknown,
            1 => Self::Invalid,
            2 => Self::GPS,
            3 => Self::DGPS,
            4 => Self::SBAS,
            5 => Self::FloatRTK,
            6 => Self::FixedRTK,
            7 => Self::PPS,
            _ => Self::Unknown,
        }
    }

    /// Convert to u8 representation (for ROS compatibility)
    pub fn to_u8(self) -> u8 {
        match self {
            Self::Unknown => 0,
            Self::Invalid => 1,
            Self::GPS => 2,
            Self::DGPS => 3,
            Self::SBAS => 4,
            Self::FloatRTK => 5,
            Self::FixedRTK => 6,
            Self::PPS => 7,
            Self::GBAS => 6,
        }
    }
}

#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct GeoPose {
    pub lon_deg: f64,     // Decimal degrees
    pub lat_deg: f64,     // Decimal degrees
    pub altitude_m: f64,  // HAE: Meters above ellipsoid, roughly sea level
    pub heading_deg: f64, // 0 degrees north, clockwise
}

#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct VelTwist {
    pub linear_mps: f32,
    pub angular_rps: f32,
}

/// Power supply status
#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum PowerSupplyStatus {
    Unknown,
    Charging,
    Discharging,
    NotCharging,
    Full,
}

impl PowerSupplyStatus {
    /// Convert from u8 representation (for ROS compatibility)
    pub fn from_u8(value: u8) -> Self {
        match value {
            1 => Self::Charging,
            2 => Self::Discharging,
            3 => Self::NotCharging,
            4 => Self::Full,
            _ => Self::Unknown,
        }
    }

    /// Convert to u8 representation (for ROS compatibility)
    pub fn to_u8(self) -> u8 {
        match self {
            Self::Unknown => 0,
            Self::Charging => 1,
            Self::Discharging => 2,
            Self::NotCharging => 3,
            Self::Full => 4,
        }
    }
}

/// Power supply health
#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum PowerSupplyHealth {
    Unknown,
    Good,
    Overheat,
    Dead,
    Overvoltage,
    UnspecifiedFailure,
    Cold,
    WatchdogTimerExpire,
    SafetyTimerExpire,
}

impl PowerSupplyHealth {
    /// Convert from u8 representation (for ROS compatibility)
    pub fn from_u8(value: u8) -> Self {
        match value {
            1 => Self::Good,
            2 => Self::Overheat,
            3 => Self::Dead,
            4 => Self::Overvoltage,
            5 => Self::UnspecifiedFailure,
            6 => Self::Cold,
            7 => Self::WatchdogTimerExpire,
            8 => Self::SafetyTimerExpire,
            _ => Self::Unknown,
        }
    }

    /// Convert to u8 representation (for ROS compatibility)
    pub fn to_u8(self) -> u8 {
        match self {
            Self::Unknown => 0,
            Self::Good => 1,
            Self::Overheat => 2,
            Self::Dead => 3,
            Self::Overvoltage => 4,
            Self::UnspecifiedFailure => 5,
            Self::Cold => 6,
            Self::WatchdogTimerExpire => 7,
            Self::SafetyTimerExpire => 8,
        }
    }
}

/// Power supply technology (battery chemistry)
#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum PowerSupplyTechnology {
    Unknown,
    NiMH,
    LiIon,
    LiPo,
    LiFe,
    NiCd,
    LiMn,
}

impl PowerSupplyTechnology {
    /// Convert from u8 representation (for ROS compatibility)
    pub fn from_u8(value: u8) -> Self {
        match value {
            1 => Self::NiMH,
            2 => Self::LiIon,
            3 => Self::LiPo,
            4 => Self::LiFe,
            5 => Self::NiCd,
            6 => Self::LiMn,
            _ => Self::Unknown,
        }
    }

    /// Convert to u8 representation (for ROS compatibility)
    pub fn to_u8(self) -> u8 {
        match self {
            Self::Unknown => 0,
            Self::NiMH => 1,
            Self::LiIon => 2,
            Self::LiPo => 3,
            Self::LiFe => 4,
            Self::NiCd => 5,
            Self::LiMn => 6,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct BatteryStatus {
    pub soc_pct: f32, // 0 to 100
    pub voltage_v: Option<f32>,
    pub current_a: Option<f32>,
    pub charge_ah: Option<f32>,
    pub capacity_ah: Option<f32>,
    pub design_capacity_ah: Option<f32>,
    pub temperature: Option<f32>,
    pub power_supply_status: PowerSupplyStatus,
    pub power_supply_health: PowerSupplyHealth,
    pub power_supply_technology: PowerSupplyTechnology,
}

#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct FuelStatus {
    pub level_pct: f32, // 0 to 100
    pub volume_remaining: Option<f32>,
    pub capacity: Option<f32>,           // how big is tank
    pub volume_unit: Option<String>,     // Liters or gallons or teaspoons if you like
    pub efficiency: Option<f32>,         // like miles per gallon
    pub efficiency_unit: Option<String>, // like miles per gallon
    pub is_refueling: bool,
}

#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct ConsumableStatus {
    pub unix_time_ms: i64,
    pub kind: String,          // herbicide, water, seed
    pub tank_id: String,       // "main", "left", "right", etc.
    pub level_pct: f32,        // 0–100
    pub amount_remaining: f32, // quantity scalar
    pub unit: String,          // Unit for amount_remaining
    pub is_critical: bool,     // precomputed by robot if it wants
}