-
Notifications
You must be signed in to change notification settings - Fork 105
/
SDLSubscribeVehicleDataResponse.h
360 lines (280 loc) · 13.9 KB
/
SDLSubscribeVehicleDataResponse.h
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
// SDLSubscribeVehicleDataResponse.h
//
#import "SDLRPCResponse.h"
@class SDLVehicleDataResult;
/**
Response to SDLSubscribeVehicleData
Since SmartDeviceLink 2.0
*/
NS_ASSUME_NONNULL_BEGIN
@interface SDLSubscribeVehicleDataResponse : SDLRPCResponse
/**
* Convenience init for setting all possible values on vehicle data items.
*
* @param gps - gps
* @param speed - speed
* @param rpm - rpm
* @param instantFuelConsumption - instantFuelConsumption
* @param fuelRange - fuelRange
* @param externalTemperature - externalTemperature
* @param turnSignal - turnSignal
* @param gearStatus - gearStatus
* @param tirePressure - tirePressure
* @param odometer - odometer
* @param beltStatus - beltStatus
* @param bodyInformation - bodyInformation
* @param deviceStatus - deviceStatus
* @param driverBraking - driverBraking
* @param wiperStatus - wiperStatus
* @param headLampStatus - headLampStatus
* @param engineTorque - engineTorque
* @param accPedalPosition - accPedalPosition
* @param steeringWheelAngle - steeringWheelAngle
* @param engineOilLife - engineOilLife
* @param electronicParkBrakeStatus - electronicParkBrakeStatus
* @param cloudAppVehicleID - cloudAppVehicleID
* @param stabilityControlsStatus - stabilityControlsStatus
* @param eCallInfo - eCallInfo
* @param airbagStatus - airbagStatus
* @param emergencyEvent - emergencyEvent
* @param clusterModes - clusterModes
* @param myKey - myKey
* @param handsOffSteering - handsOffSteering
* @param windowStatus - windowStatus
* @return A SDLSubscribeVehicleDataResponse object
*/
- (instancetype)initWithGps:(nullable SDLVehicleDataResult *)gps speed:(nullable SDLVehicleDataResult *)speed rpm:(nullable SDLVehicleDataResult *)rpm instantFuelConsumption:(nullable SDLVehicleDataResult *)instantFuelConsumption fuelRange:(nullable SDLVehicleDataResult *)fuelRange externalTemperature:(nullable SDLVehicleDataResult *)externalTemperature turnSignal:(nullable SDLVehicleDataResult *)turnSignal gearStatus:(nullable SDLVehicleDataResult *)gearStatus tirePressure:(nullable SDLVehicleDataResult *)tirePressure odometer:(nullable SDLVehicleDataResult *)odometer beltStatus:(nullable SDLVehicleDataResult *)beltStatus bodyInformation:(nullable SDLVehicleDataResult *)bodyInformation deviceStatus:(nullable SDLVehicleDataResult *)deviceStatus driverBraking:(nullable SDLVehicleDataResult *)driverBraking wiperStatus:(nullable SDLVehicleDataResult *)wiperStatus headLampStatus:(nullable SDLVehicleDataResult *)headLampStatus engineTorque:(nullable SDLVehicleDataResult *)engineTorque accPedalPosition:(nullable SDLVehicleDataResult *)accPedalPosition steeringWheelAngle:(nullable SDLVehicleDataResult *)steeringWheelAngle engineOilLife:(nullable SDLVehicleDataResult *)engineOilLife electronicParkBrakeStatus:(nullable SDLVehicleDataResult *)electronicParkBrakeStatus cloudAppVehicleID:(nullable SDLVehicleDataResult *)cloudAppVehicleID stabilityControlsStatus:(nullable SDLVehicleDataResult *)stabilityControlsStatus eCallInfo:(nullable SDLVehicleDataResult *)eCallInfo airbagStatus:(nullable SDLVehicleDataResult *)airbagStatus emergencyEvent:(nullable SDLVehicleDataResult *)emergencyEvent clusterModes:(nullable SDLVehicleDataResult *)clusterModes myKey:(nullable SDLVehicleDataResult *)myKey handsOffSteering:(nullable SDLVehicleDataResult *)handsOffSteering windowStatus:(nullable SDLVehicleDataResult *)windowStatus __deprecated_msg("Use initWithGps:speed:rpm:instantFuelConsumption:fuelRange:climateData:turnSignal:gearStatus:tirePressure:odometer:beltStatus:bodyInformation:deviceStatus:driverBraking:wiperStatus:headLampStatus:engineTorque:accPedalPosition:steeringWheelAngle:engineOilLife:electronicParkBrakeStatus:cloudAppVehicleID:stabilityControlsStatus:eCallInfo:airbagStatus:emergencyEvent:clusterModes:myKey:windowStatus:handsOffSteering:seatOccupancy: instead");
/**
* Convenience init for setting all possible values on vehicle data items.
*
* @param gps - gps
* @param speed - speed
* @param rpm - rpm
* @param instantFuelConsumption - instantFuelConsumption
* @param fuelRange - fuelRange
* @param climateData - climateData
* @param turnSignal - turnSignal
* @param gearStatus - gearStatus
* @param tirePressure - tirePressure
* @param odometer - odometer
* @param beltStatus - beltStatus
* @param bodyInformation - bodyInformation
* @param deviceStatus - deviceStatus
* @param driverBraking - driverBraking
* @param wiperStatus - wiperStatus
* @param headLampStatus - headLampStatus
* @param engineTorque - engineTorque
* @param accPedalPosition - accPedalPosition
* @param steeringWheelAngle - steeringWheelAngle
* @param engineOilLife - engineOilLife
* @param electronicParkBrakeStatus - electronicParkBrakeStatus
* @param cloudAppVehicleID - cloudAppVehicleID
* @param stabilityControlsStatus - stabilityControlsStatus
* @param eCallInfo - eCallInfo
* @param airbagStatus - airbagStatus
* @param emergencyEvent - emergencyEvent
* @param clusterModes - clusterModes
* @param myKey - myKey
* @param windowStatus - windowStatus
* @param handsOffSteering - handsOffSteering
* @param seatOccupancy - seatOccupancy
* @return A SDLSubscribeVehicleDataResponse object
*/
- (instancetype)initWithGps:(nullable SDLVehicleDataResult *)gps speed:(nullable SDLVehicleDataResult *)speed rpm:(nullable SDLVehicleDataResult *)rpm instantFuelConsumption:(nullable SDLVehicleDataResult *)instantFuelConsumption fuelRange:(nullable SDLVehicleDataResult *)fuelRange climateData:(nullable SDLVehicleDataResult *)climateData turnSignal:(nullable SDLVehicleDataResult *)turnSignal gearStatus:(nullable SDLVehicleDataResult *)gearStatus tirePressure:(nullable SDLVehicleDataResult *)tirePressure odometer:(nullable SDLVehicleDataResult *)odometer beltStatus:(nullable SDLVehicleDataResult *)beltStatus bodyInformation:(nullable SDLVehicleDataResult *)bodyInformation deviceStatus:(nullable SDLVehicleDataResult *)deviceStatus driverBraking:(nullable SDLVehicleDataResult *)driverBraking wiperStatus:(nullable SDLVehicleDataResult *)wiperStatus headLampStatus:(nullable SDLVehicleDataResult *)headLampStatus engineTorque:(nullable SDLVehicleDataResult *)engineTorque accPedalPosition:(nullable SDLVehicleDataResult *)accPedalPosition steeringWheelAngle:(nullable SDLVehicleDataResult *)steeringWheelAngle engineOilLife:(nullable SDLVehicleDataResult *)engineOilLife electronicParkBrakeStatus:(nullable SDLVehicleDataResult *)electronicParkBrakeStatus cloudAppVehicleID:(nullable SDLVehicleDataResult *)cloudAppVehicleID stabilityControlsStatus:(nullable SDLVehicleDataResult *)stabilityControlsStatus eCallInfo:(nullable SDLVehicleDataResult *)eCallInfo airbagStatus:(nullable SDLVehicleDataResult *)airbagStatus emergencyEvent:(nullable SDLVehicleDataResult *)emergencyEvent clusterModes:(nullable SDLVehicleDataResult *)clusterModes myKey:(nullable SDLVehicleDataResult *)myKey windowStatus:(nullable SDLVehicleDataResult *)windowStatus handsOffSteering:(nullable SDLVehicleDataResult *)handsOffSteering seatOccupancy:(nullable SDLVehicleDataResult *)seatOccupancy;
/**
* See GearStatus
*
* @since SDL 7.0
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *gearStatus;
/**
The result of requesting to subscribe to the GPSData.
Optional
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *gps;
/**
The result of requesting to subscribe to the vehicle speed in kilometers per hour.
Optional
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *speed;
/**
The result of requesting to subscribe to the number of revolutions per minute of the engine.
Optional
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *rpm;
/**
The result of requesting to subscribe to the fuel level in the tank (percentage)
Optional
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *fuelLevel __deprecated_msg("use fuelRange instead on 7.0+ RPC version connections");
/**
The result of requesting to subscribe to the fuel level state.
Optional
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *fuelLevel_State __deprecated_msg("use fuelRange instead on 7.0+ RPC version connections");
/**
The result of requesting to subscribe to the fuel range.
Optional
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *fuelRange;
/**
The result of requesting to subscribe to the instantaneous fuel consumption in microlitres.
Optional
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *instantFuelConsumption;
/**
* See ClimateData
*
* @added in SmartDeviceLink 7.1.0
*/
@property (nullable, strong, nonatomic) SDLVehicleDataResult *climateData;
/**
* The external temperature in degrees celsius. This parameter is deprecated starting RPC Spec 7.1, please see climateData.
*
* @deprecated in SmartDeviceLink 7.1.0
* @added in SmartDeviceLink 2.0.0
*/
@property (nullable, strong, nonatomic) SDLVehicleDataResult *externalTemperature __deprecated_msg("Use climateData instead on 7.1+ RPC version connections");
/**
* See PRNDL. This parameter is deprecated and it is now covered in `gearStatus`
*
* @deprecated
* @since SDL 7.0
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *prndl __deprecated_msg("use gearStatus instead on 7.0+ RPC version connections");
/**
The result of requesting to subscribe to the tireStatus.
Optional
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *tirePressure;
/**
The result of requesting to subscribe to the odometer in km.
Optional
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *odometer;
/**
The result of requesting to subscribe to the status of the seat belts.
Optional
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *beltStatus;
/**
The result of requesting to subscribe to the body information including power modes.
Optional
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *bodyInformation;
/**
The result of requesting to subscribe to the device status including signal and battery strength.
Optional
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *deviceStatus;
/**
The result of requesting to subscribe to the status of the brake pedal.
Optional
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *driverBraking;
/**
* See WindowStatus
*
* @since SDL 7.0
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *windowStatus;
/**
The result of requesting to subscribe to the status of the wipers.
Optional
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *wiperStatus;
/**
To indicate whether driver hands are off the steering wheel
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *handsOffSteering;
/**
The result of requesting to subscribe to the status of the head lamps.
Optional
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *headLampStatus;
/**
The result of requesting to subscribe to the estimated percentage of remaining oil life of the engine.
Optional
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *engineOilLife;
/**
The result of requesting to subscribe to the torque value for engine (in Nm) on non-diesel variants.
Optional
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *engineTorque;
/**
The result of requesting to subscribe to the accelerator pedal position (percentage depressed)
Optional
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *accPedalPosition;
/**
See StabilityControlsStatus
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *stabilityControlsStatus;
/**
The result of requesting to subscribe to the current angle of the steering wheel (in deg)
Optional
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *steeringWheelAngle;
/**
The result of requesting to subscribe to the emergency call info
Optional
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *eCallInfo;
/**
The result of requesting to subscribe to the airbag status
Optional
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *airbagStatus;
/**
The result of requesting to subscribe to the emergency event
Optional
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *emergencyEvent;
/**
The result of requesting to subscribe to the cluster modes
Optional
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *clusterModes;
/**
The result of requesting to subscribe to the myKey status
Optional
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *myKey;
/**
The result of requesting to subscribe to the electronic parking brake status
Optional
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *electronicParkBrakeStatus;
/**
The result of requesting to subscribe to the turn signal
Optional
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *turnSignal;
/**
The result of requesting to subscribe to the cloud app vehicle ID
Optional
*/
@property (strong, nonatomic, nullable) SDLVehicleDataResult *cloudAppVehicleID;
/**
Sets the OEM custom vehicle data state for any given OEM custom vehicle data name.
@param vehicleDataName The name of the OEM custom vehicle data item.
@param vehicleDataState SDLVehicleDataResult object containing custom data type and result code information.
Added SmartDeviceLink 6.0
*/
- (void)setOEMCustomVehicleData:(NSString *)vehicleDataName withVehicleDataState:(SDLVehicleDataResult *)vehicleDataState NS_SWIFT_NAME(setOEMCustomVehicleData(name:state:));
/**
Gets the OEM custom vehicle data state for any given OEM custom vehicle data name.
@param vehicleDataName The name of the OEM custom vehicle data item.
@return SDLVehicleDataResult An object containing custom data type and result code information.
Added SmartDeviceLink 6.0
*/
- (nullable SDLVehicleDataResult *)getOEMCustomVehicleData:(NSString *)vehicleDataName;
/**
* See SeatOccupancy
*
* @added in SmartDeviceLink 7.1.0
*/
@property (nullable, strong, nonatomic) SDLVehicleDataResult *seatOccupancy;
@end
NS_ASSUME_NONNULL_END