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
|
package com.smartdevicelink.proxy.rpc;
import java.util.Hashtable;
import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.proxy.constants.Names;
import com.smartdevicelink.proxy.rpc.enums.DeviceLevelStatus;
import com.smartdevicelink.proxy.rpc.enums.PrimaryAudioSource;
import com.smartdevicelink.util.DebugTool;
/**
* Describes the status related to a connected mobile device or SMARTDEVICELINK and if or how it is represented in the vehicle.
* <p><b>Parameter List
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
* <th>Type</th>
* <th>Description</th>
* <th>SmartDeviceLink Ver. Available</th>
* </tr>
* <tr>
* <td>voiceRecOn</td>
* <td>Boolean</td>
* <td>Voice recognition is on
* </td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
* <td>btIconOn</td>
* <td>Boolean</td>
* <td>Bluetooth connection established
* </td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
* <td>callActive</td>
* <td>Boolean</td>
* <td>A call is being active
* </td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
* <td>phoneRoaming</td>
* <td>Boolean</td>
* <td>The phone is in roaming mode
* </td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
* <td>textMsgAvailable</td>
* <td>Boolean</td>
* <td>A textmessage is available
* </td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
* <td>battLevelStatus</td>
* <td>DeviceLevelStatus</td>
* <td>Battery level status
* </td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
* <td>stereoAudioOutputMuted</td>
* <td>Boolean</td>
* <td>Status of the stereo audio output channel
* </td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
* <td>monoAudioOutputMuted</td>
* <td>Boolean</td>
* <td>Status of the mono audio output channel
* </td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
* <td>signalLevelStatus</td>
* <td>DeviceLevelStatus</td>
* <td>Signal level status
* </td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
* <td>primaryAudioSource</td>
* <td>PrimaryAudioSource</td>
* <td>Reflects the current primary audio source of SMARTDEVICELINK (if selected).
* </td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
* <td>eCallEventActive</td>
* <td>Boolean</td>
* <td>Reflects, if an eCall event is active
* </td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* </table>
* @since SmartDeviceLink 2.0
*/
public class DeviceStatus extends RPCStruct {
/**
* Constructs a newly allocated DeviceStatus object
*/
public DeviceStatus() {}
/**
* Constructs a newly allocated DeviceStatus object indicated by the Hashtable parameter
* @param hash The Hashtable to use
*/
public DeviceStatus(Hashtable hash) {
super(hash);
}
/**
* set the voice recognition on or off
* @param voiceRecOn
*/
public void setVoiceRecOn(Boolean voiceRecOn) {
if (voiceRecOn != null) {
store.put(Names.voiceRecOn, voiceRecOn);
} else {
store.remove(Names.voiceRecOn);
}
}
/**
* get whether the voice recognition is on
* @return whether the voice recognition is on
*/
public Boolean getVoiceRecOn() {
return (Boolean) store.get(Names.voiceRecOn);
}
/**
* set the bluetooth connection established
* @param btIconOn the bluetooth connection established
*/
public void setBtIconOn(Boolean btIconOn) {
if (btIconOn != null) {
store.put(Names.btIconOn, btIconOn);
} else {
store.remove(Names.btIconOn);
}
}
/**
* get the bluetooth connection established
* @return the bluetooth connection established
*/
public Boolean getBtIconOn() {
return (Boolean) store.get(Names.btIconOn);
}
/**
* set a call is being active
* @param callActive a call is being active
*/
public void setCallActive(Boolean callActive) {
if (callActive != null) {
store.put(Names.callActive, callActive);
} else {
store.remove(Names.callActive);
}
}
/**
* get a call is being active
* @return a call is being active
*/
public Boolean getCallActive() {
return (Boolean) store.get(Names.callActive);
}
/**
* set the phone is in roaming mode
* @param phoneRoaming the phone is in roaming mode
*/
public void setPhoneRoaming(Boolean phoneRoaming) {
if (phoneRoaming != null) {
store.put(Names.phoneRoaming, phoneRoaming);
} else {
store.remove(Names.phoneRoaming);
}
}
/**
* get the phone is in roaming mode
* @return the phone is in roaming mode
*/
public Boolean getPhoneRoaming() {
return (Boolean) store.get(Names.phoneRoaming);
}
public void setTextMsgAvailable(Boolean textMsgAvailable) {
if (textMsgAvailable != null) {
store.put(Names.textMsgAvailable, textMsgAvailable);
} else {
store.remove(Names.textMsgAvailable);
}
}
/**
* get a textmessage is available
* @return a textmessage is available
*/
public Boolean getTextMsgAvailable() {
return (Boolean) store.get(Names.textMsgAvailable);
}
/**
* set battery level status
* @param battLevelStatus battery level status
*/
public void setBattLevelStatus(DeviceLevelStatus battLevelStatus) {
if (battLevelStatus != null) {
store.put(Names.battLevelStatus, battLevelStatus);
} else {
store.remove(Names.battLevelStatus);
}
}
/**
* get battery level status
* @return battery level status
*/
public DeviceLevelStatus getBattLevelStatus() {
Object obj = store.get(Names.battLevelStatus);
if (obj instanceof DeviceLevelStatus) {
return (DeviceLevelStatus) obj;
} else if (obj instanceof String) {
DeviceLevelStatus theCode = null;
try {
theCode = DeviceLevelStatus.valueForString((String) obj);
} catch (Exception e) {
DebugTool.logError("Failed to parse " + getClass().getSimpleName() + "." + Names.battLevelStatus, e);
}
return theCode;
}
return null;
}
/**
* set the status of the stereo audio output channel
* @param stereoAudioOutputMuted the status of the stereo audio output channel
*/
public void setStereoAudioOutputMuted(Boolean stereoAudioOutputMuted) {
if (stereoAudioOutputMuted != null) {
store.put(Names.stereoAudioOutputMuted, stereoAudioOutputMuted);
} else {
store.remove(Names.stereoAudioOutputMuted);
}
}
/**
* get the status of the stereo audio output channel
* @return the status of the stereo audio output channel
*/
public Boolean getStereoAudioOutputMuted() {
return (Boolean) store.get(Names.stereoAudioOutputMuted);
}
/**
* set the status of the mono audio output channel
* @param monoAudioOutputMuted the status of the mono audio output channel
*/
public void setMonoAudioOutputMuted(Boolean monoAudioOutputMuted) {
if (monoAudioOutputMuted != null) {
store.put(Names.monoAudioOutputMuted, monoAudioOutputMuted);
} else {
store.remove(Names.monoAudioOutputMuted);
}
}
/**
* get the status of the mono audio output channel
* @return the status of the mono audio output channel
*/
public Boolean getMonoAudioOutputMuted() {
return (Boolean) store.get(Names.monoAudioOutputMuted);
}
/**
* set signal level status
* @param signalLevelStatus signal level status
*/
public void setSignalLevelStatus(DeviceLevelStatus signalLevelStatus) {
if (signalLevelStatus != null) {
store.put(Names.signalLevelStatus, signalLevelStatus);
} else {
store.remove(Names.signalLevelStatus);
}
}
/**
* get signal level status
* @return signal level status
*/
public DeviceLevelStatus getSignalLevelStatus() {
Object obj = store.get(Names.signalLevelStatus);
if (obj instanceof DeviceLevelStatus) {
return (DeviceLevelStatus) obj;
} else if (obj instanceof String) {
DeviceLevelStatus theCode = null;
try {
theCode = DeviceLevelStatus.valueForString((String) obj);
} catch (Exception e) {
DebugTool.logError("Failed to parse " + getClass().getSimpleName() + "." + Names.signalLevelStatus, e);
}
return theCode;
}
return null;
}
/**
* set the current primary audio source of SMARTDEVICELINK (if selected).
* @param primaryAudioSource the current primary audio source of SMARTDEVICELINK (if selected).
*/
public void setPrimaryAudioSource(PrimaryAudioSource primaryAudioSource) {
if (primaryAudioSource != null) {
store.put(Names.primaryAudioSource, primaryAudioSource);
} else {
store.remove(Names.primaryAudioSource);
}
}
/**
* get the current primary audio source of SMARTDEVICELINK (if selected).
* @return the current primary audio source of SMARTDEVICELINK (if selected).
*/
public PrimaryAudioSource getPrimaryAudioSource() {
Object obj = store.get(Names.primaryAudioSource);
if (obj instanceof PrimaryAudioSource) {
return (PrimaryAudioSource) obj;
} else if (obj instanceof String) {
PrimaryAudioSource theCode = null;
try {
theCode = PrimaryAudioSource.valueForString((String) obj);
} catch (Exception e) {
DebugTool.logError("Failed to parse " + getClass().getSimpleName() + "." + Names.primaryAudioSource, e);
}
return theCode;
}
return null;
}
public void setECallEventActive(Boolean eCallEventActive) {
if (eCallEventActive != null) {
store.put(Names.eCallEventActive, eCallEventActive);
} else {
store.remove(Names.eCallEventActive);
}
}
public Boolean getECallEventActive() {
return (Boolean) store.get(Names.eCallEventActive);
}
}
|
