@deeptrekker/api-domain 1.0.22 → 1.0.23
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const API_VERSION = "1.0.
|
|
1
|
+
export declare const API_VERSION = "1.0.23";
|
|
@@ -78,17 +78,58 @@ export type X4Thruster = {
|
|
|
78
78
|
* Additionally, this value can be overridden by the user to set a custom location for the thruster.
|
|
79
79
|
*/
|
|
80
80
|
location?: string;
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
81
|
+
current?: number;
|
|
82
|
+
voltage?: number;
|
|
83
|
+
rpm?: number;
|
|
84
|
+
escTemperature?: number;
|
|
85
|
+
pcbTemperature?: number;
|
|
86
|
+
oilLevel?: number;
|
|
87
|
+
faults?: X4ThrusterFaults;
|
|
88
|
+
};
|
|
89
|
+
/**
|
|
90
|
+
* Fault structure that includes properties such as overcurrent, undervoltage, overvolt, not_enough_messages, compensator_fault, offline, overtemp.
|
|
91
|
+
* @internal
|
|
92
|
+
* @alpha
|
|
93
|
+
* @group X4
|
|
94
|
+
* @category Network
|
|
95
|
+
*/
|
|
96
|
+
export type X4ThrusterFaults = {
|
|
97
|
+
overcurrent?: boolean;
|
|
98
|
+
undervoltage?: boolean;
|
|
99
|
+
overvoltage?: boolean;
|
|
100
|
+
not_enough_messages?: boolean;
|
|
101
|
+
compensator: boolean;
|
|
102
|
+
offline?: boolean;
|
|
103
|
+
overtemp?: boolean;
|
|
104
|
+
};
|
|
105
|
+
export type X4Faults = {
|
|
106
|
+
light0NotEnoughMessages: boolean;
|
|
107
|
+
light0Overcurrent: boolean;
|
|
108
|
+
light0Overtemp: boolean;
|
|
109
|
+
light1NotEnoughMessages: boolean;
|
|
110
|
+
light1Overcurrent: boolean;
|
|
111
|
+
light1Overtemp: boolean;
|
|
112
|
+
pdmNotEnoughMessages: boolean;
|
|
113
|
+
pdmUndervoltage: boolean;
|
|
114
|
+
pdmOvervoltage: boolean;
|
|
115
|
+
pdmOvercurrent: boolean;
|
|
116
|
+
pdmOvertemp: boolean;
|
|
117
|
+
pdmOffline: boolean;
|
|
118
|
+
brushedMotorNotEnoughMessages: boolean;
|
|
119
|
+
brushedMotorOvervoltage: boolean;
|
|
120
|
+
brushedMotorUndervoltage: boolean;
|
|
121
|
+
brushedMotorOvercurrent: boolean;
|
|
122
|
+
brushedMotorOvertemp: boolean;
|
|
123
|
+
brushedMotorOvermag: boolean;
|
|
124
|
+
dvlOffline: boolean;
|
|
125
|
+
vehicleInterfaceOffline: boolean;
|
|
126
|
+
imuOffline: boolean;
|
|
127
|
+
imuNotEnoughMessages: boolean;
|
|
128
|
+
pressureNotEnoughMessages: boolean;
|
|
129
|
+
pressureTooDeep: boolean;
|
|
130
|
+
pressureHighPressure: boolean;
|
|
131
|
+
temperatureOvertemp: boolean;
|
|
132
|
+
temperatureNotEnoughMessages: boolean;
|
|
92
133
|
};
|
|
93
134
|
/**
|
|
94
135
|
* The X4 drive command type.
|
|
@@ -101,10 +142,6 @@ export type X4Thruster = {
|
|
|
101
142
|
* @category Controls
|
|
102
143
|
*/
|
|
103
144
|
export type X4DriveCommand = {
|
|
104
|
-
/**
|
|
105
|
-
* Flag dictating if rosbag recording should be active.
|
|
106
|
-
*/
|
|
107
|
-
rosbag?: boolean;
|
|
108
145
|
/**
|
|
109
146
|
* The reference frame for the drive command, which can be used to specify the coordinate system in which the command is issued.
|
|
110
147
|
* This allows the user to control the vehicle's movement in a specific frame of reference. The value must correspond to a valid reference frame in the system (mac address of a camera or camera head).
|
|
@@ -661,6 +698,10 @@ export type X4MediaSession = {
|
|
|
661
698
|
*/
|
|
662
699
|
export type X4 = {
|
|
663
700
|
rosbag?: boolean;
|
|
701
|
+
/**
|
|
702
|
+
* Contains all faults
|
|
703
|
+
*/
|
|
704
|
+
faults?: X4Faults;
|
|
664
705
|
/**
|
|
665
706
|
* A record of network devices associated with the X4 vehicle. They are identified by their unique MAC address.
|
|
666
707
|
* Each device contains properties such as model, IP address, software version, hardware version,
|
package/package.json
CHANGED