@blueyerobotics/protocol-definitions 3.2.0-0f5b72ba
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.
- package/README.md +40 -0
- package/dist/aquatroll.d.ts +441 -0
- package/dist/aquatroll.js +3160 -0
- package/dist/control.d.ts +268 -0
- package/dist/control.js +2061 -0
- package/dist/google/protobuf/any.d.ts +138 -0
- package/dist/google/protobuf/any.js +121 -0
- package/dist/google/protobuf/duration.d.ts +98 -0
- package/dist/google/protobuf/duration.js +106 -0
- package/dist/google/protobuf/timestamp.d.ts +127 -0
- package/dist/google/protobuf/timestamp.js +106 -0
- package/dist/index.blueye.d.ts +1 -0
- package/dist/index.blueye.js +42 -0
- package/dist/index.blueye.protocol.d.ts +6 -0
- package/dist/index.blueye.protocol.js +27 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.google.d.ts +1 -0
- package/dist/index.google.js +42 -0
- package/dist/index.google.protobuf.d.ts +3 -0
- package/dist/index.google.protobuf.js +24 -0
- package/dist/index.js +43 -0
- package/dist/message_formats.d.ts +1852 -0
- package/dist/message_formats.js +12001 -0
- package/dist/mission_planning.d.ts +352 -0
- package/dist/mission_planning.js +2317 -0
- package/dist/req_rep.d.ts +268 -0
- package/dist/req_rep.js +1919 -0
- package/dist/telemetry.d.ts +359 -0
- package/dist/telemetry.js +2940 -0
- package/package.json +23 -0
package/README.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# @blueyerobotics/protocol-definitions
|
|
2
|
+
|
|
3
|
+
TypeScript protobuf definitions for Blueye Robotics protocols generated using [ts-proto](https://github.com/stephenh/ts-proto).
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @blueyerobotics/protocol-definitions
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```ts
|
|
14
|
+
import { blueye } from "@blueyerobotics/protocol-definitions";
|
|
15
|
+
|
|
16
|
+
// Create a new GetBatteryReq message
|
|
17
|
+
const request = blueye.protocol.GetBatteryReq.create();
|
|
18
|
+
|
|
19
|
+
// Serialize the message to a Uint8Array (binary)
|
|
20
|
+
const binary = blueye.protocol.GetBatteryReq.encode(request).finish();
|
|
21
|
+
|
|
22
|
+
// ...
|
|
23
|
+
|
|
24
|
+
// For demonstration, we will simulate a response from the device
|
|
25
|
+
const response = blueye.protocol.GetBatteryRep.create({
|
|
26
|
+
battery: {
|
|
27
|
+
level: 85,
|
|
28
|
+
voltage: 12.5,
|
|
29
|
+
temperature: 25,
|
|
30
|
+
},
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
const binaryResponse = blueye.protocol.GetBatteryRep.encode(response).finish();
|
|
34
|
+
|
|
35
|
+
// Decode a binary response back into a message
|
|
36
|
+
const decoded = blueye.protocol.GetBatteryRep.decode(binaryResponse);
|
|
37
|
+
|
|
38
|
+
// Access fields
|
|
39
|
+
console.log(decoded.battery?.level);
|
|
40
|
+
```
|
|
@@ -0,0 +1,441 @@
|
|
|
1
|
+
import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
|
|
2
|
+
/**
|
|
3
|
+
* Aquatroll
|
|
4
|
+
*
|
|
5
|
+
* These messages are emitted by the In-Situ AquaTroll series of probes.
|
|
6
|
+
*/
|
|
7
|
+
/** Type IDs */
|
|
8
|
+
export declare enum Type {
|
|
9
|
+
TYPE_UNSPECIFIED = 0,
|
|
10
|
+
TYPE_SHORT = 1,
|
|
11
|
+
TYPE_UNSIGNED_SHORT = 2,
|
|
12
|
+
TYPE_LONG = 3,
|
|
13
|
+
TYPE_UNSIGNED_LONG = 4,
|
|
14
|
+
TYPE_FLOAT = 5,
|
|
15
|
+
TYPE_DOUBLE = 6,
|
|
16
|
+
TYPE_CHARACTER = 7,
|
|
17
|
+
TYPE_STRING = 8,
|
|
18
|
+
TYPE_TIME = 9,
|
|
19
|
+
UNRECOGNIZED = -1
|
|
20
|
+
}
|
|
21
|
+
export declare function typeFromJSON(object: any): Type;
|
|
22
|
+
export declare function typeToJSON(object: Type): string;
|
|
23
|
+
/** Aqua Troll Device IDs. */
|
|
24
|
+
export declare enum AquaTrollDevice {
|
|
25
|
+
AQUA_TROLL_DEVICE_UNSPECIFIED = 0,
|
|
26
|
+
AQUA_TROLL_DEVICE_LEVEL_TROLL_500 = 1,
|
|
27
|
+
AQUA_TROLL_DEVICE_LEVEL_TROLL_700 = 2,
|
|
28
|
+
AQUA_TROLL_DEVICE_BAROTROLL_500 = 3,
|
|
29
|
+
AQUA_TROLL_DEVICE_LEVEL_TROLL_300 = 4,
|
|
30
|
+
AQUA_TROLL_DEVICE_AQUA_TROLL_200 = 5,
|
|
31
|
+
AQUA_TROLL_DEVICE_AQUA_TROLL_600 = 7,
|
|
32
|
+
AQUA_TROLL_DEVICE_AQUA_TROLL_100 = 10,
|
|
33
|
+
AQUA_TROLL_DEVICE_FLOW_TROLL_500 = 11,
|
|
34
|
+
AQUA_TROLL_DEVICE_RDO_PRO = 12,
|
|
35
|
+
AQUA_TROLL_DEVICE_RUGGED_TROLL_200 = 16,
|
|
36
|
+
AQUA_TROLL_DEVICE_RUGGED_BAROTROLL = 17,
|
|
37
|
+
AQUA_TROLL_DEVICE_AQUA_TROLL_400 = 18,
|
|
38
|
+
AQUA_TROLL_DEVICE_RDO_TITAN = 19,
|
|
39
|
+
AQUA_TROLL_DEVICE_SMARTROLL = 21,
|
|
40
|
+
AQUA_TROLL_DEVICE_AQUA_TROLL_600_VENTED = 26,
|
|
41
|
+
AQUA_TROLL_DEVICE_LEVEL_TROLL_400 = 30,
|
|
42
|
+
AQUA_TROLL_DEVICE_RDO_PRO_X = 31,
|
|
43
|
+
AQUA_TROLL_DEVICE_AQUA_TROLL_500 = 33,
|
|
44
|
+
AQUA_TROLL_DEVICE_AQUA_TROLL_500_VENTED = 34,
|
|
45
|
+
UNRECOGNIZED = -1
|
|
46
|
+
}
|
|
47
|
+
export declare function aquaTrollDeviceFromJSON(object: any): AquaTrollDevice;
|
|
48
|
+
export declare function aquaTrollDeviceToJSON(object: AquaTrollDevice): string;
|
|
49
|
+
/** Aqua Troll Quality IDs. */
|
|
50
|
+
export declare enum AquaTrollQuality {
|
|
51
|
+
/** AQUA_TROLL_QUALITY_NORMAL - protolint:disable:this ENUM_FIELD_NAMES_ZERO_VALUE_END_WITH */
|
|
52
|
+
AQUA_TROLL_QUALITY_NORMAL = 0,
|
|
53
|
+
AQUA_TROLL_QUALITY_USER_CAL_EXPIRED = 1,
|
|
54
|
+
AQUA_TROLL_QUALITY_FACTORY_CAL_EXPIRED = 2,
|
|
55
|
+
AQUA_TROLL_QUALITY_ERROR = 3,
|
|
56
|
+
AQUA_TROLL_QUALITY_WARM_UP = 4,
|
|
57
|
+
AQUA_TROLL_QUALITY_SENSOR_WARNING = 5,
|
|
58
|
+
AQUA_TROLL_QUALITY_CALIBRATING = 6,
|
|
59
|
+
AQUA_TROLL_QUALITY_OFF_LINE = 7,
|
|
60
|
+
UNRECOGNIZED = -1
|
|
61
|
+
}
|
|
62
|
+
export declare function aquaTrollQualityFromJSON(object: any): AquaTrollQuality;
|
|
63
|
+
export declare function aquaTrollQualityToJSON(object: AquaTrollQuality): string;
|
|
64
|
+
/** Aqua Troll Parameter IDs. */
|
|
65
|
+
export declare enum AquaTrollParameter {
|
|
66
|
+
AQUA_TROLL_PARAMETER_UNSPECIFIED = 0,
|
|
67
|
+
AQUA_TROLL_PARAMETER_TEMPERATURE = 1,
|
|
68
|
+
AQUA_TROLL_PARAMETER_PRESSURE = 2,
|
|
69
|
+
AQUA_TROLL_PARAMETER_DEPTH = 3,
|
|
70
|
+
AQUA_TROLL_PARAMETER_LEVEL_DEPTH_TO_WATER = 4,
|
|
71
|
+
AQUA_TROLL_PARAMETER_LEVEL_SURFACE_ELEVATION = 5,
|
|
72
|
+
AQUA_TROLL_PARAMETER_LATITUDE = 6,
|
|
73
|
+
AQUA_TROLL_PARAMETER_LONGITUDE = 7,
|
|
74
|
+
AQUA_TROLL_PARAMETER_ELEVATION = 8,
|
|
75
|
+
AQUA_TROLL_PARAMETER_ACTUAL_CONDUCTIVITY = 9,
|
|
76
|
+
AQUA_TROLL_PARAMETER_SPECIFIC_CONDUCTIVITY = 10,
|
|
77
|
+
AQUA_TROLL_PARAMETER_RESISTIVITY = 11,
|
|
78
|
+
AQUA_TROLL_PARAMETER_SALINITY = 12,
|
|
79
|
+
AQUA_TROLL_PARAMETER_TOTAL_DISSOLVED_SOLIDS = 13,
|
|
80
|
+
AQUA_TROLL_PARAMETER_DENSITY_OF_WATER = 14,
|
|
81
|
+
AQUA_TROLL_PARAMETER_SPECIFIC_GRAVITY = 15,
|
|
82
|
+
AQUA_TROLL_PARAMETER_BAROMETRIC_PRESSURE = 16,
|
|
83
|
+
AQUA_TROLL_PARAMETER_PH = 17,
|
|
84
|
+
AQUA_TROLL_PARAMETER_PH_MV = 18,
|
|
85
|
+
AQUA_TROLL_PARAMETER_ORP = 19,
|
|
86
|
+
AQUA_TROLL_PARAMETER_DISSOLVED_OXYGEN_CONCENTRATION = 20,
|
|
87
|
+
AQUA_TROLL_PARAMETER_DISSOLVED_OXYGEN_SATURATION = 21,
|
|
88
|
+
AQUA_TROLL_PARAMETER_NITRATE = 22,
|
|
89
|
+
AQUA_TROLL_PARAMETER_AMMONIUM = 23,
|
|
90
|
+
AQUA_TROLL_PARAMETER_CHLORIDE = 24,
|
|
91
|
+
AQUA_TROLL_PARAMETER_TURBIDITY = 25,
|
|
92
|
+
AQUA_TROLL_PARAMETER_BATTERY_VOLTAGE = 26,
|
|
93
|
+
AQUA_TROLL_PARAMETER_HEAD = 27,
|
|
94
|
+
AQUA_TROLL_PARAMETER_FLOW = 28,
|
|
95
|
+
AQUA_TROLL_PARAMETER_TOTAL_FLOW = 29,
|
|
96
|
+
AQUA_TROLL_PARAMETER_OXYGEN_PARTIAL_PRESSURE = 30,
|
|
97
|
+
AQUA_TROLL_PARAMETER_TOTAL_SUSPENDED_SOLIDS = 31,
|
|
98
|
+
AQUA_TROLL_PARAMETER_EXTERNAL_VOLTAGE = 32,
|
|
99
|
+
AQUA_TROLL_PARAMETER_BATTERY_CAPACITY_REMAINING = 33,
|
|
100
|
+
AQUA_TROLL_PARAMETER_RHODAMINE_WT_CONCENTRATION = 34,
|
|
101
|
+
AQUA_TROLL_PARAMETER_RHODAMINE_WT_FLUORESCENCE_INTENSITY = 35,
|
|
102
|
+
AQUA_TROLL_PARAMETER_CHLORIDE_CL_MV = 36,
|
|
103
|
+
AQUA_TROLL_PARAMETER_NITRATE_AS_NITROGEN_NO3_N_CONCENTRATION = 37,
|
|
104
|
+
AQUA_TROLL_PARAMETER_NITRATE_NO3_MV = 38,
|
|
105
|
+
AQUA_TROLL_PARAMETER_AMMONIUM_AS_NITROGEN_NH4_PLUS_N_CONCENTRATION = 39,
|
|
106
|
+
AQUA_TROLL_PARAMETER_AMMONIUM_NH4_MV = 40,
|
|
107
|
+
AQUA_TROLL_PARAMETER_AMMONIA_AS_NITROGEN_NH3_N_CONCENTRATION = 41,
|
|
108
|
+
AQUA_TROLL_PARAMETER_TOTAL_AMMONIA_AS_NITROGEN_NH3_N_CONCENTRATION = 42,
|
|
109
|
+
AQUA_TROLL_PARAMETER_EH = 48,
|
|
110
|
+
AQUA_TROLL_PARAMETER_VELOCITY = 49,
|
|
111
|
+
AQUA_TROLL_PARAMETER_CHLOROPHYLL_A_CONCENTRATION = 50,
|
|
112
|
+
AQUA_TROLL_PARAMETER_CHLOROPHYLL_A_FLUORESCENCE_INTENSITY = 51,
|
|
113
|
+
AQUA_TROLL_PARAMETER_BLUE_GREEN_ALGAE_PHYCOCYANIN_CONCENTRATION = 54,
|
|
114
|
+
AQUA_TROLL_PARAMETER_BLUE_GREEN_ALGAE_PHYCOCYANIN_FLUORESCENCE_INTENSITY = 55,
|
|
115
|
+
AQUA_TROLL_PARAMETER_BLUE_GREEN_ALGAE_PHYCOERYTHRIN_CONCENTRATION = 58,
|
|
116
|
+
AQUA_TROLL_PARAMETER_BLUE_GREEN_ALGAE_PHYCOERYTHRIN_FLUORESCENCE_INTENSITY = 59,
|
|
117
|
+
AQUA_TROLL_PARAMETER_FLUORESCEIN_WT_CONCENTRATION = 67,
|
|
118
|
+
AQUA_TROLL_PARAMETER_FLUORESCEIN_WT_FLUORESCENCE_INTENSITY = 68,
|
|
119
|
+
AQUA_TROLL_PARAMETER_FLUORESCENT_DISSOLVED_ORGANIC_MATTER_CONCENTRATION = 69,
|
|
120
|
+
AQUA_TROLL_PARAMETER_FLUORESCENT_DISSOLVED_ORGANIC_MATTER_FLUORESCENCE_INTENSITY = 70,
|
|
121
|
+
AQUA_TROLL_PARAMETER_CRUDE_OIL_CONCENTRATION = 80,
|
|
122
|
+
AQUA_TROLL_PARAMETER_CRUDE_OIL_FLUORESCENCE_INTENSITY = 81,
|
|
123
|
+
AQUA_TROLL_PARAMETER_COLORED_DISSOLVED_ORGANIC_MATTER_CONCENTRATION = 87,
|
|
124
|
+
UNRECOGNIZED = -1
|
|
125
|
+
}
|
|
126
|
+
export declare function aquaTrollParameterFromJSON(object: any): AquaTrollParameter;
|
|
127
|
+
export declare function aquaTrollParameterToJSON(object: AquaTrollParameter): string;
|
|
128
|
+
/** Aqua Troll Unit IDs. */
|
|
129
|
+
export declare enum AquaTrollUnit {
|
|
130
|
+
AQUA_TROLL_UNIT_UNSPECIFIED = 0,
|
|
131
|
+
AQUA_TROLL_UNIT_TEMP_CELSIUS = 1,
|
|
132
|
+
AQUA_TROLL_UNIT_TEMP_FARENHEIT = 2,
|
|
133
|
+
AQUA_TROLL_UNIT_TEMP_KELVIN = 3,
|
|
134
|
+
AQUA_TROLL_UNIT_POUNDS_PER_SQUARE_INCH = 17,
|
|
135
|
+
AQUA_TROLL_UNIT_PASCALS = 18,
|
|
136
|
+
AQUA_TROLL_UNIT_KILOPASCALS = 19,
|
|
137
|
+
AQUA_TROLL_UNIT_BARS = 20,
|
|
138
|
+
AQUA_TROLL_UNIT_MILLIBARS = 21,
|
|
139
|
+
AQUA_TROLL_UNIT_MILLIMETERS_OF_MERCURY = 22,
|
|
140
|
+
AQUA_TROLL_UNIT_INCHES_OF_MERCURY = 23,
|
|
141
|
+
AQUA_TROLL_UNIT_CENTIMETERS_OF_WATER = 24,
|
|
142
|
+
AQUA_TROLL_UNIT_INCHES_OF_WATER = 25,
|
|
143
|
+
AQUA_TROLL_UNIT_TORR = 26,
|
|
144
|
+
AQUA_TROLL_UNIT_STANDARD_ATMOSPHERE = 27,
|
|
145
|
+
AQUA_TROLL_UNIT_MILLIMETERS = 33,
|
|
146
|
+
AQUA_TROLL_UNIT_CENTIMETERS = 34,
|
|
147
|
+
AQUA_TROLL_UNIT_METERS = 35,
|
|
148
|
+
AQUA_TROLL_UNIT_KILOMETER = 36,
|
|
149
|
+
AQUA_TROLL_UNIT_INCHES = 37,
|
|
150
|
+
AQUA_TROLL_UNIT_FEET = 38,
|
|
151
|
+
AQUA_TROLL_UNIT_DEGREES = 49,
|
|
152
|
+
AQUA_TROLL_UNIT_MINUTES = 50,
|
|
153
|
+
AQUA_TROLL_UNIT_SECONDS = 51,
|
|
154
|
+
AQUA_TROLL_UNIT_MICROSIEMENS_PER_CENTIMETER = 65,
|
|
155
|
+
AQUA_TROLL_UNIT_MILLISIEMENS_PER_CENTIMETER = 66,
|
|
156
|
+
AQUA_TROLL_UNIT_OHM_CENTIMETERS = 81,
|
|
157
|
+
AQUA_TROLL_UNIT_PRACTICAL_SALINITY_UNITS = 97,
|
|
158
|
+
AQUA_TROLL_UNIT_PARTS_PER_THOUSAND_SALINITY = 98,
|
|
159
|
+
AQUA_TROLL_UNIT_PARTS_PER_MILLION = 113,
|
|
160
|
+
AQUA_TROLL_UNIT_PARTS_PER_THOUSAND = 114,
|
|
161
|
+
AQUA_TROLL_UNIT_PARTS_PER_MILLION_NITROGEN = 115,
|
|
162
|
+
AQUA_TROLL_UNIT_PARTS_PER_MILLION_CHLORIDE = 116,
|
|
163
|
+
AQUA_TROLL_UNIT_MILLIGRAMS_PER_LITER = 117,
|
|
164
|
+
AQUA_TROLL_UNIT_MICROGRAMS_PER_LITER = 118,
|
|
165
|
+
AQUA_TROLL_UNIT_MICROMOLES_PER_LITER_DEPRECATED = 119,
|
|
166
|
+
AQUA_TROLL_UNIT_GRAMS_PER_LITER = 120,
|
|
167
|
+
AQUA_TROLL_UNIT_PARTS_PER_BILLION = 121,
|
|
168
|
+
AQUA_TROLL_UNIT_GRAMS_PER_CUBIC_CENTIMETER = 129,
|
|
169
|
+
AQUA_TROLL_UNIT_PH = 145,
|
|
170
|
+
AQUA_TROLL_UNIT_MICRO_VOLTS = 161,
|
|
171
|
+
AQUA_TROLL_UNIT_MILLI_VOLTS = 162,
|
|
172
|
+
AQUA_TROLL_UNIT_VOLTS = 163,
|
|
173
|
+
AQUA_TROLL_UNIT_PERCENT_SATURATION = 177,
|
|
174
|
+
AQUA_TROLL_UNIT_FORMAZIN_NEPHELOMETRIC_UNITS = 193,
|
|
175
|
+
AQUA_TROLL_UNIT_NEPHELOMETRIC_TURBIDITY_UNITS = 194,
|
|
176
|
+
AQUA_TROLL_UNIT_FORMAZIN_TURBIDITY_UNITS = 195,
|
|
177
|
+
AQUA_TROLL_UNIT_CUBIC_FEET_PER_SECOND = 209,
|
|
178
|
+
AQUA_TROLL_UNIT_CUBIC_FEET_PER_MINUTE = 210,
|
|
179
|
+
AQUA_TROLL_UNIT_CUBIC_FEET_PER_HOUR = 211,
|
|
180
|
+
AQUA_TROLL_UNIT_CUBIC_FEET_PER_DAY = 212,
|
|
181
|
+
AQUA_TROLL_UNIT_GALLONS_PER_SECOND = 213,
|
|
182
|
+
AQUA_TROLL_UNIT_GALLONS_PER_MINUTE = 214,
|
|
183
|
+
AQUA_TROLL_UNIT_GALLONS_PER_HOUR = 215,
|
|
184
|
+
AQUA_TROLL_UNIT_MILLIONS_OF_GALLONS_PER_DAY = 216,
|
|
185
|
+
AQUA_TROLL_UNIT_CUBIC_METERS_PER_SECOND = 217,
|
|
186
|
+
AQUA_TROLL_UNIT_CUBIC_METERS_PER_MINUTE = 218,
|
|
187
|
+
AQUA_TROLL_UNIT_CUBIC_METERS_PER_HOUR = 219,
|
|
188
|
+
AQUA_TROLL_UNIT_CUBIC_METERS_PER_DAY = 220,
|
|
189
|
+
AQUA_TROLL_UNIT_LITERS_PER_SECOND = 221,
|
|
190
|
+
AQUA_TROLL_UNIT_MILLIONS_OF_LITERS_PER_DAY = 222,
|
|
191
|
+
AQUA_TROLL_UNIT_MILLILITERS_PER_MINUTE = 223,
|
|
192
|
+
AQUA_TROLL_UNIT_THOUSANDS_OF_LITERS_PER_DAY = 224,
|
|
193
|
+
AQUA_TROLL_UNIT_CUBIC_FEET = 225,
|
|
194
|
+
AQUA_TROLL_UNIT_GALLONS = 226,
|
|
195
|
+
AQUA_TROLL_UNIT_MILLIONS_OF_GALLONS = 227,
|
|
196
|
+
AQUA_TROLL_UNIT_CUBIC_METERS = 228,
|
|
197
|
+
AQUA_TROLL_UNIT_LITERS = 229,
|
|
198
|
+
AQUA_TROLL_UNIT_ACRE_FEET = 230,
|
|
199
|
+
AQUA_TROLL_UNIT_MILLILITERS = 231,
|
|
200
|
+
AQUA_TROLL_UNIT_MILLIONS_OF_LITERS = 232,
|
|
201
|
+
AQUA_TROLL_UNIT_THOUSANDS_OF_LITERS = 233,
|
|
202
|
+
AQUA_TROLL_UNIT_ACRE_INCHES = 234,
|
|
203
|
+
AQUA_TROLL_UNIT_PERCENT = 241,
|
|
204
|
+
AQUA_TROLL_UNIT_RELATIVE_FLUORESCENCE_UNITS = 257,
|
|
205
|
+
AQUA_TROLL_UNIT_MILLILITERS_PER_SECOND = 273,
|
|
206
|
+
AQUA_TROLL_UNIT_MILLILITERS_PER_HOUR = 274,
|
|
207
|
+
AQUA_TROLL_UNIT_LITERS_PER_MINUTE = 275,
|
|
208
|
+
AQUA_TROLL_UNIT_LITERS_PER_HOUR = 276,
|
|
209
|
+
AQUA_TROLL_UNIT_MICROAMPS = 289,
|
|
210
|
+
AQUA_TROLL_UNIT_MILLIAMPS = 290,
|
|
211
|
+
AQUA_TROLL_UNIT_AMPS = 291,
|
|
212
|
+
AQUA_TROLL_UNIT_FEET_PER_SECOND = 305,
|
|
213
|
+
AQUA_TROLL_UNIT_METERS_PER_SECOND = 306,
|
|
214
|
+
UNRECOGNIZED = -1
|
|
215
|
+
}
|
|
216
|
+
export declare function aquaTrollUnitFromJSON(object: any): AquaTrollUnit;
|
|
217
|
+
export declare function aquaTrollUnitToJSON(object: AquaTrollUnit): string;
|
|
218
|
+
/** Aqua Troll Sensor IDs. */
|
|
219
|
+
export declare enum AquaTrollSensor {
|
|
220
|
+
AQUA_TROLL_SENSOR_UNSPECIFIED = 0,
|
|
221
|
+
AQUA_TROLL_SENSOR_TEMPERATURE = 1,
|
|
222
|
+
AQUA_TROLL_SENSOR_S5_PSI_FULL_SCALE_GAUGE_PRESSURE_WITH_LEVEL_AND_TEMPERATURE = 2,
|
|
223
|
+
AQUA_TROLL_SENSOR_S15_PSI_FULL_SCALE_GAUGE_PRESSURE_WITH_LEVEL_AND_TEMPERATURE = 3,
|
|
224
|
+
AQUA_TROLL_SENSOR_S30_PSI_FULL_SCALE_GAUGE_PRESSURE_WITH_LEVEL_AND_TEMPERATURE = 4,
|
|
225
|
+
AQUA_TROLL_SENSOR_S100_PSI_FULL_SCALE_GAUGE_PRESSURE_WITH_LEVEL_AND_TEMPERATURE = 5,
|
|
226
|
+
AQUA_TROLL_SENSOR_S300_PSI_FULL_SCALE_GAUGE_PRESSURE_WITH_LEVEL_AND_TEMPERATURE = 6,
|
|
227
|
+
AQUA_TROLL_SENSOR_S500_PSI_FULL_SCALE_GAUGE_PRESSURE_WITH_LEVEL_AND_TEMPERATURE = 7,
|
|
228
|
+
AQUA_TROLL_SENSOR_S1000_PSI_FULL_SCALE_ABSOLUTE_PRESSURE_WITH_LEVEL_AND_TEMPERATURE = 8,
|
|
229
|
+
AQUA_TROLL_SENSOR_S30_PSI_FULL_SCALE_ABSOLUTE_PRESSURE_WITH_LEVEL_AND_TEMPERATURE = 9,
|
|
230
|
+
AQUA_TROLL_SENSOR_S100_PSI_FULL_SCALE_ABSOLUTE_PRESSURE_WITH_LEVEL_AND_TEMPERATURE = 10,
|
|
231
|
+
AQUA_TROLL_SENSOR_S300_PSI_FULL_SCALE_ABSOLUTE_PRESSURE_WITH_LEVEL_AND_TEMPERATURE = 11,
|
|
232
|
+
AQUA_TROLL_SENSOR_S500_PSI_FULL_SCALE_ABSOLUTE_PRESSURE_WITH_LEVEL_AND_TEMPERATURE = 12,
|
|
233
|
+
AQUA_TROLL_SENSOR_S30_PSI_FULL_SCALE_ABSOLUTE_PRESSURE_WITH_TEMPERATURE = 13,
|
|
234
|
+
AQUA_TROLL_SENSOR_S5_PSI_FULL_SCALE_GAUGE_PRESSURE_WITH_LEVEL_TEMPERATURE_AND_CONDUCTIVITY = 14,
|
|
235
|
+
AQUA_TROLL_SENSOR_S15_PSI_FULL_SCALE_GAUGE_PRESSURE_WITH_LEVEL_TEMPERATURE_AND_CONDUCTIVITY = 15,
|
|
236
|
+
AQUA_TROLL_SENSOR_S30_PSI_FULL_SCALE_GAUGE_PRESSURE_WITH_LEVEL_TEMPERATURE_AND_CONDUCTIVITY = 16,
|
|
237
|
+
AQUA_TROLL_SENSOR_S100_PSI_FULL_SCALE_GAUGE_PRESSURE_WITH_LEVEL_TEMPERATURE_AND_CONDUCTIVITY = 17,
|
|
238
|
+
AQUA_TROLL_SENSOR_S300_PSI_FULL_SCALE_GAUGE_PRESSURE_WITH_LEVEL_TEMPERATURE_AND_CONDUCTIVITY = 18,
|
|
239
|
+
AQUA_TROLL_SENSOR_S500_PSI_FULL_SCALE_GAUGE_PRESSURE_WITH_LEVEL_TEMPERATURE_AND_CONDUCTIVITY = 19,
|
|
240
|
+
AQUA_TROLL_SENSOR_NOT_USED = 20,
|
|
241
|
+
AQUA_TROLL_SENSOR_S30_PSI_FULL_SCALE_ABSOLUTE_PRESSURE_WITH_LEVEL_TEMPERATURE_AND_CONDUCTIVITY = 21,
|
|
242
|
+
AQUA_TROLL_SENSOR_S100_PSI_FULL_SCALE_ABSOLUTE_PRESSURE_WITH_LEVEL_TEMPERATURE_AND_CONDUCTIVITY = 22,
|
|
243
|
+
AQUA_TROLL_SENSOR_S300_PSI_FULL_SCALE_ABSOLUTE_PRESSURE_WITH_LEVEL_TEMPERATURE_AND_CONDUCTIVITY = 23,
|
|
244
|
+
AQUA_TROLL_SENSOR_S500_PSI_FULL_SCALE_ABSOLUTE_PRESSURE_WITH_LEVEL_TEMPERATURE_AND_CONDUCTIVITY = 24,
|
|
245
|
+
AQUA_TROLL_SENSOR_S165_PSI_FULL_SCALE_ABSOLUTE_PRESSURE = 25,
|
|
246
|
+
AQUA_TROLL_SENSOR_PH_ANALOG_SENSOR = 26,
|
|
247
|
+
AQUA_TROLL_SENSOR_PH_ORP_ANALOG_SENSOR = 27,
|
|
248
|
+
AQUA_TROLL_SENSOR_DISSOLVED_OXYGEN_CLARK_CELL_ANALOG_SENSOR = 28,
|
|
249
|
+
AQUA_TROLL_SENSOR_NITRATE_ANALOG_SENSOR = 29,
|
|
250
|
+
AQUA_TROLL_SENSOR_AMMONIUM_ANALOG_SENSOR = 30,
|
|
251
|
+
AQUA_TROLL_SENSOR_CHLORIDE_ANALOG_SENSOR = 31,
|
|
252
|
+
AQUA_TROLL_SENSOR_S100_FOOT_FULL_SCALE_LEVEL_WITH_ABSOLUTE_PRESSURE_AND_TEMPERATURE = 32,
|
|
253
|
+
AQUA_TROLL_SENSOR_S250_FOOT_FULL_SCALE_LEVEL_WITH_ABSOLUTE_PRESSURE_AND_TEMPERATURE = 33,
|
|
254
|
+
AQUA_TROLL_SENSOR_S30_FOOT_FULL_SCALE_LEVEL_WITH_ABSOLUTE_PRESSURE_AND_TEMPERATURE = 34,
|
|
255
|
+
AQUA_TROLL_SENSOR_CONDUCTIVITY_AND_TEMPERATURE = 35,
|
|
256
|
+
AQUA_TROLL_SENSOR_S5_PSI_FULL_SCALE_GAUGE_PRESSURE_WITH_TEMPERATURE_HEAD_AND_FLOW = 36,
|
|
257
|
+
AQUA_TROLL_SENSOR_S15_PSI_FULL_SCALE_GAUGE_PRESSURE_WITH_TEMPERATURE_HEAD_AND_FLOW = 37,
|
|
258
|
+
AQUA_TROLL_SENSOR_S30_PSI_FULL_SCALE_GAUGE_PRESSURE_WITH_TEMPERATURE_HEAD_AND_FLOW = 38,
|
|
259
|
+
AQUA_TROLL_SENSOR_S100_PSI_FULL_SCALE_GAUGE_PRESSURE_WITH_TEMPERATURE_HEAD_AND_FLOW = 39,
|
|
260
|
+
AQUA_TROLL_SENSOR_S300_PSI_FULL_SCALE_GAUGE_PRESSURE_WITH_TEMPERATURE_HEAD_AND_FLOW = 40,
|
|
261
|
+
AQUA_TROLL_SENSOR_S500_PSI_FULL_SCALE_GAUGE_PRESSURE_WITH_TEMPERATURE_HEAD_AND_FLOW = 41,
|
|
262
|
+
AQUA_TROLL_SENSOR_OPTICAL_DISSOLVED_OXYGEN_WITH_TEMPERATURE = 42,
|
|
263
|
+
AQUA_TROLL_SENSOR_S1_BAR = 43,
|
|
264
|
+
AQUA_TROLL_SENSOR_S2_BAR = 44,
|
|
265
|
+
AQUA_TROLL_SENSOR_S5_BAR = 45,
|
|
266
|
+
AQUA_TROLL_SENSOR_TURBIDITY_SENSOR = 50,
|
|
267
|
+
AQUA_TROLL_SENSOR_TEMPERATURE_SENSOR = 55,
|
|
268
|
+
AQUA_TROLL_SENSOR_CONDUCTIVITY_SENSOR = 56,
|
|
269
|
+
AQUA_TROLL_SENSOR_RDO_SENSOR = 57,
|
|
270
|
+
AQUA_TROLL_SENSOR_PH_ORP_SENSOR = 58,
|
|
271
|
+
AQUA_TROLL_SENSOR_RHODAMINE_WT_SENSOR = 60,
|
|
272
|
+
AQUA_TROLL_SENSOR_CHLOROPHYLL_A_SENSOR = 62,
|
|
273
|
+
AQUA_TROLL_SENSOR_BLUE_GREEN_ALGAE_PHYCOCYANIN_SENSOR = 64,
|
|
274
|
+
AQUA_TROLL_SENSOR_BLUE_GREEN_ALGAE_PHYCOERYTHRIN_SENSOR = 65,
|
|
275
|
+
AQUA_TROLL_SENSOR_CRUDE_OIL_SENSOR = 67,
|
|
276
|
+
AQUA_TROLL_SENSOR_NITRATE_ISE_SENSOR = 70,
|
|
277
|
+
AQUA_TROLL_SENSOR_AMMONIUM_ISE_SENSOR = 71,
|
|
278
|
+
AQUA_TROLL_SENSOR_CHLORIDE_ISE_SENSOR = 72,
|
|
279
|
+
AQUA_TROLL_SENSOR_PROBE_PARAMETERS = 79,
|
|
280
|
+
UNRECOGNIZED = -1
|
|
281
|
+
}
|
|
282
|
+
export declare function aquaTrollSensorFromJSON(object: any): AquaTrollSensor;
|
|
283
|
+
export declare function aquaTrollSensorToJSON(object: AquaTrollSensor): string;
|
|
284
|
+
/** Aqua Troll Sensor Status IDs */
|
|
285
|
+
export declare enum AquaTrollSensorStatus {
|
|
286
|
+
/** AQUA_TROLL_SENSOR_STATUS_SENSOR_HIGH_ALARM - protolint:disable:this ENUM_FIELD_NAMES_ZERO_VALUE_END_WITH */
|
|
287
|
+
AQUA_TROLL_SENSOR_STATUS_SENSOR_HIGH_ALARM = 0,
|
|
288
|
+
AQUA_TROLL_SENSOR_STATUS_SENSOR_HIGH_WARNING = 1,
|
|
289
|
+
AQUA_TROLL_SENSOR_STATUS_SENSOR_LOW_WARNING = 2,
|
|
290
|
+
AQUA_TROLL_SENSOR_STATUS_SENSOR_LOW_ALARM = 3,
|
|
291
|
+
AQUA_TROLL_SENSOR_STATUS_SENSOR_CALIBRATION_WARNING = 4,
|
|
292
|
+
AQUA_TROLL_SENSOR_STATUS_SENSOR_MALFUNCTION = 5,
|
|
293
|
+
AQUA_TROLL_SENSOR_STATUS_SENSOR_MODE_BIT_1 = 8,
|
|
294
|
+
AQUA_TROLL_SENSOR_STATUS_SENSOR_MODE_BIT_2 = 9,
|
|
295
|
+
UNRECOGNIZED = -1
|
|
296
|
+
}
|
|
297
|
+
export declare function aquaTrollSensorStatusFromJSON(object: any): AquaTrollSensorStatus;
|
|
298
|
+
export declare function aquaTrollSensorStatusToJSON(object: AquaTrollSensorStatus): string;
|
|
299
|
+
/** Aqua Troll Device Status IDs */
|
|
300
|
+
export declare enum AquaTrollDeviceStatus {
|
|
301
|
+
/** AQUA_TROLL_DEVICE_STATUS_SENSOR_HIGH_ALARM - protolint:disable:this ENUM_FIELD_NAMES_ZERO_VALUE_END_WITH */
|
|
302
|
+
AQUA_TROLL_DEVICE_STATUS_SENSOR_HIGH_ALARM = 0,
|
|
303
|
+
AQUA_TROLL_DEVICE_STATUS_SENSOR_HIGH_WARNING = 1,
|
|
304
|
+
AQUA_TROLL_DEVICE_STATUS_SENSOR_LOW_WARNING = 2,
|
|
305
|
+
AQUA_TROLL_DEVICE_STATUS_SENSOR_LOW_ALARM = 3,
|
|
306
|
+
AQUA_TROLL_DEVICE_STATUS_SENSOR_CALIBRATION_WARNING = 4,
|
|
307
|
+
AQUA_TROLL_DEVICE_STATUS_SENSOR_MALFUNCTION = 5,
|
|
308
|
+
AQUA_TROLL_DEVICE_STATUS_POWER_MANAGEMENT_DISABLED = 8,
|
|
309
|
+
AQUA_TROLL_DEVICE_STATUS_DEVICE_OFF_LINE = 9,
|
|
310
|
+
AQUA_TROLL_DEVICE_STATUS_DEVICE_HARDWARE_RESET_OCCURRED = 10,
|
|
311
|
+
AQUA_TROLL_DEVICE_STATUS_DEVICE_MALFUNCTION = 11,
|
|
312
|
+
AQUA_TROLL_DEVICE_STATUS_NO_EXTERNAL_POWER = 12,
|
|
313
|
+
AQUA_TROLL_DEVICE_STATUS_LOW_BATTERY = 13,
|
|
314
|
+
AQUA_TROLL_DEVICE_STATUS_LOW_MEMORY = 14,
|
|
315
|
+
UNRECOGNIZED = -1
|
|
316
|
+
}
|
|
317
|
+
export declare function aquaTrollDeviceStatusFromJSON(object: any): AquaTrollDeviceStatus;
|
|
318
|
+
export declare function aquaTrollDeviceStatusToJSON(object: AquaTrollDeviceStatus): string;
|
|
319
|
+
/**
|
|
320
|
+
* In-Situ Parameter Block.
|
|
321
|
+
*
|
|
322
|
+
* Up to NUMBER_OF_SENSOR_PARAMETERS blocks may be part of a sensor.
|
|
323
|
+
*/
|
|
324
|
+
export interface AquaTrollParameterBlock {
|
|
325
|
+
measuredValue: number;
|
|
326
|
+
parameterId: AquaTrollParameter;
|
|
327
|
+
unitsId: AquaTrollUnit;
|
|
328
|
+
dataQualityIds: AquaTrollQuality[];
|
|
329
|
+
offLineSentinelValue: number;
|
|
330
|
+
availableUnits: AquaTrollUnit[];
|
|
331
|
+
}
|
|
332
|
+
/**
|
|
333
|
+
* In-Situ AquaTroll 500 sensor metadata.
|
|
334
|
+
*
|
|
335
|
+
* (Mostly) static information about a connected sensor.
|
|
336
|
+
*
|
|
337
|
+
* Refer to Section 7 Sensor Common Registers in the In-Situ Modbus
|
|
338
|
+
* Communication Protocol.
|
|
339
|
+
*/
|
|
340
|
+
export interface AquaTrollSensorMetadata {
|
|
341
|
+
timestamp: Date | undefined;
|
|
342
|
+
sensorId: AquaTrollSensor;
|
|
343
|
+
sensorSerialNumber: number;
|
|
344
|
+
sensorStatusFlags: AquaTrollSensorStatus[];
|
|
345
|
+
lastFactoryCalibration: Date | undefined;
|
|
346
|
+
nextFactoryCalibration: Date | undefined;
|
|
347
|
+
lastUserCalibration: Date | undefined;
|
|
348
|
+
nextUserCalibration: Date | undefined;
|
|
349
|
+
warmUpTimeInMilliseconds: number;
|
|
350
|
+
fastSampleRateInMilliseconds: number;
|
|
351
|
+
numberOfSensorParameters: number;
|
|
352
|
+
alarmAndWarningParameterNumber: number;
|
|
353
|
+
alarmAndWarningEnableBits: number;
|
|
354
|
+
highAlarmSetValue: number;
|
|
355
|
+
highAlarmClearValue: number;
|
|
356
|
+
highWarningSetValue: number;
|
|
357
|
+
highWarningClearValue: number;
|
|
358
|
+
lowWarningClearValue: number;
|
|
359
|
+
lowWarningSetValue: number;
|
|
360
|
+
lowAlarmClearValue: number;
|
|
361
|
+
lowAlarmSetValue: number;
|
|
362
|
+
parameterBlocks: AquaTrollParameterBlock[];
|
|
363
|
+
}
|
|
364
|
+
export interface AquaTrollSensorMetadataArray {
|
|
365
|
+
timestamp: Date | undefined;
|
|
366
|
+
sensors: AquaTrollSensorMetadata[];
|
|
367
|
+
}
|
|
368
|
+
export interface AquaTrollProbeMetadata {
|
|
369
|
+
timestamp: Date | undefined;
|
|
370
|
+
status: boolean;
|
|
371
|
+
registerMapTemplateVersion: number;
|
|
372
|
+
deviceId: AquaTrollDevice;
|
|
373
|
+
deviceSerialNumber: number;
|
|
374
|
+
manufactureDate: Date | undefined;
|
|
375
|
+
firmwareVersion: number;
|
|
376
|
+
bootCodeVersion: number;
|
|
377
|
+
hardwareVersion: number;
|
|
378
|
+
maxDataLogs: number;
|
|
379
|
+
totalDataLogMemory: number;
|
|
380
|
+
totalBatteryTicks: number;
|
|
381
|
+
lastBatteryChange: Date | undefined;
|
|
382
|
+
deviceName: string;
|
|
383
|
+
siteName: string;
|
|
384
|
+
latitudeCoordinate: number;
|
|
385
|
+
longitudeCoordinate: number;
|
|
386
|
+
altitudeCoordinate: number;
|
|
387
|
+
currentTimeUtc: Date | undefined;
|
|
388
|
+
deviceStatusFlags: AquaTrollDeviceStatus[];
|
|
389
|
+
usedBatteryTicks: number;
|
|
390
|
+
usedDataLogMemory: number;
|
|
391
|
+
sensors: AquaTrollSensor[];
|
|
392
|
+
}
|
|
393
|
+
export interface AquaTrollSensorParameters {
|
|
394
|
+
sensorId: AquaTrollSensor;
|
|
395
|
+
parameterBlocks: AquaTrollParameterBlock[];
|
|
396
|
+
}
|
|
397
|
+
export interface AquaTrollSensorParametersArray {
|
|
398
|
+
timestamp: Date | undefined;
|
|
399
|
+
sensors: AquaTrollSensorParameters[];
|
|
400
|
+
}
|
|
401
|
+
/** Request to set an In-Situ Aqua Troll parameter unit. */
|
|
402
|
+
export interface SetAquaTrollParameterUnit {
|
|
403
|
+
/** Sensor id, f. ex. "SENSOR_CONDUCTIVITY_SENSOR". */
|
|
404
|
+
sensorId: AquaTrollSensor;
|
|
405
|
+
/** Parameter name, f. ex. "PARAMETER_TEMPERATURE". */
|
|
406
|
+
parameterId: AquaTrollParameter;
|
|
407
|
+
/** Unit, f. ex. "UNIT_TEMP_CELSIUS". */
|
|
408
|
+
unitId: AquaTrollUnit;
|
|
409
|
+
}
|
|
410
|
+
/** Request to change the In-Situ Aqua Troll connection status. */
|
|
411
|
+
export interface SetAquaTrollConnectionStatus {
|
|
412
|
+
/** True to connect, false to disconnect. */
|
|
413
|
+
connected: boolean;
|
|
414
|
+
}
|
|
415
|
+
export declare const AquaTrollParameterBlock: MessageFns<AquaTrollParameterBlock>;
|
|
416
|
+
export declare const AquaTrollSensorMetadata: MessageFns<AquaTrollSensorMetadata>;
|
|
417
|
+
export declare const AquaTrollSensorMetadataArray: MessageFns<AquaTrollSensorMetadataArray>;
|
|
418
|
+
export declare const AquaTrollProbeMetadata: MessageFns<AquaTrollProbeMetadata>;
|
|
419
|
+
export declare const AquaTrollSensorParameters: MessageFns<AquaTrollSensorParameters>;
|
|
420
|
+
export declare const AquaTrollSensorParametersArray: MessageFns<AquaTrollSensorParametersArray>;
|
|
421
|
+
export declare const SetAquaTrollParameterUnit: MessageFns<SetAquaTrollParameterUnit>;
|
|
422
|
+
export declare const SetAquaTrollConnectionStatus: MessageFns<SetAquaTrollConnectionStatus>;
|
|
423
|
+
type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
|
|
424
|
+
type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
|
|
425
|
+
[K in keyof T]?: DeepPartial<T[K]>;
|
|
426
|
+
} : Partial<T>;
|
|
427
|
+
type KeysOfUnion<T> = T extends T ? keyof T : never;
|
|
428
|
+
type Exact<P, I extends P> = P extends Builtin ? P : P & {
|
|
429
|
+
[K in keyof P]: Exact<P[K], I[K]>;
|
|
430
|
+
} & {
|
|
431
|
+
[K in Exclude<keyof I, KeysOfUnion<P>>]: never;
|
|
432
|
+
};
|
|
433
|
+
interface MessageFns<T> {
|
|
434
|
+
encode(message: T, writer?: BinaryWriter): BinaryWriter;
|
|
435
|
+
decode(input: BinaryReader | Uint8Array, length?: number): T;
|
|
436
|
+
fromJSON(object: any): T;
|
|
437
|
+
toJSON(message: T): unknown;
|
|
438
|
+
create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
|
|
439
|
+
fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
|
|
440
|
+
}
|
|
441
|
+
export {};
|